feat(channel-web): allow to disable notification sound (#4535)

* feat(channel-web): allow to disable notification sound * allow setting the variable globally in channel config * remove default value * test comment * use equals instead of lodash
botpress · Feb 24, 2021 · c759dc3 · c759dc3
1 parent 9a53f86
commit c759dc3
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 2 deletions.
diff --git a/modules/channel-web/src/backend/api.ts b/modules/channel-web/src/backend/api.ts
@@ -153,6 +153,7 @@ export default async (bp: typeof sdk, db: Database) => {
         details: botInfo.details,
         languages: botInfo.languages,
         extraStylesheet: config.extraStylesheet,
+        disableNotificationSound: config.disableNotificationSound,
         security,
         lazySocket: config.lazySocket
       })

diff --git a/modules/channel-web/src/config.ts b/modules/channel-web/src/config.ts
@@ -82,4 +82,10 @@ export interface Config {
    * @default false
    */
   lazySocket: boolean
+
+  /**
+   * If true, chat will no longer play the notification sound for new messages.
+   * @default false
+   */
+  disableNotificationSound: boolean
 }
diff --git a/modules/channel-web/src/views/lite/main.tsx b/modules/channel-web/src/views/lite/main.tsx
@@ -259,7 +259,13 @@ class Web extends React.Component<MainProps> {
   }
 
   async playSound() {
-    if (this.state.played) {
+    // Preference for config object
+    const disableNotificationSound =
+      this.config.disableNotificationSound === undefined
+        ? this.props.config.disableNotificationSound
+        : this.config.disableNotificationSound
+
+    if (this.state.played || disableNotificationSound) {
       return
     }
 

diff --git a/modules/channel-web/src/views/lite/store/index.ts b/modules/channel-web/src/views/lite/store/index.ts
@@ -208,7 +208,10 @@ class RootStore {
     runInAction('-> setBotInfo', () => {
       this.botInfo = botInfo
     })
-    this.mergeConfig({ extraStylesheet: botInfo.extraStylesheet })
+    this.mergeConfig({
+      extraStylesheet: botInfo.extraStylesheet,
+      disableNotificationSound: botInfo.disableNotificationSound
+    })
   }
 
   @action.bound

diff --git a/modules/channel-web/src/views/lite/typings.d.ts b/modules/channel-web/src/views/lite/typings.d.ts
@@ -180,6 +180,8 @@ export interface Config {
   reference: string
   /** If true, Websocket is created when the Webchat is opened. Bot cannot be proactive. */
   lazySocket?: boolean
+  /** If true, chat will no longer play the notification sound for new messages. */
+  disableNotificationSound?: boolean
   /** Refers to a specific webchat reference in parent window. Useful when using multiple chat window */
   chatId?: string
   /** CSS class to be applied to iframe */

diff --git a/src/e2e/modules/webchat.test.ts b/src/e2e/modules/webchat.test.ts
@@ -64,4 +64,7 @@ describe('Module - Channel Web', () => {
     await clickOn('#btn-convo-add')
     await expect(await getMessageCount(page)).toBe(0)
   })
+
+  // puppetter doesn`t have a way of testing sound playback from javascript objects
+  // it('Test disable sound notification', async () => {})
 })