port: remove lang from set speak middleware

Fixes #3507

Author: Josh Gummersall

libraries/botbuilder-dialogs-adaptive-runtime/src/index.ts

@@ -69,18 +69,13 @@ function addFeatures(services: ServiceCollection, configuration: Configuration):
                 ['setSpeak'],
                 t.Record({
                     voiceFontName: t.String.Or(t.Undefined),
-                    lang: t.String,
                     fallbackToTextForSpeechIfEmpty: t.Boolean,
                 })
             );
 
             if (setSpeak) {
                 middlewareSet.use(
-                    new SetSpeakMiddleware(
-                        setSpeak.voiceFontName ?? null,
-                        setSpeak.lang,
-                        setSpeak.fallbackToTextForSpeechIfEmpty
-                    )
+                    new SetSpeakMiddleware(setSpeak.voiceFontName ?? null, setSpeak.fallbackToTextForSpeechIfEmpty)
                 );
             }
 

libraries/botbuilder/src/setSpeakMiddleware.ts

@@ -35,16 +35,9 @@ export class SetSpeakMiddleware implements Middleware {
      * Initializes a new instance of the SetSpeakMiddleware class.
      *
      * @param voiceName The SSML voice name attribute value.
-     * @param lang The xml:lang value.
      * @param fallbackToTextForSpeak true if an empty Activity.Speak is populated with Activity.Text.
      */
-    constructor(
-        private readonly voiceName: string | null,
-        private readonly lang: string,
-        private readonly fallbackToTextForSpeak: boolean
-    ) {
-        if (!lang) throw new TypeError('`lang` must be a non-empty string');
-    }
+    constructor(private readonly voiceName: string | null, private readonly fallbackToTextForSpeak: boolean) {}
 
     /**
      * Processes an incoming activity.
@@ -75,7 +68,9 @@ export class SetSpeakMiddleware implements Middleware {
                                 activity.speak = `<voice name='${this.voiceName}'>${activity.speak}</voice>`;
                             }
 
-                            activity.speak = `<speak version='1.0' xmlns='http://www.w3.org/2001/10/synthesis' xml:lang='${this.lang}'>${activity.speak}</speak>`;
+                            activity.speak = `<speak version='1.0' xmlns='http://www.w3.org/2001/10/synthesis' xml:lang='${
+                                activity.locale ?? 'en-US'
+                            }'>${activity.speak}</speak>`;
                         }
                     }
                 })

libraries/botbuilder/tests/setSpeakMiddleware.test.js

@@ -8,11 +8,7 @@ const { MessageFactory, TestAdapter } = require('botbuilder-core');
 describe('SetSpeakMiddleware', function () {
     describe('constructor', function () {
         it('works', function () {
-            new SetSpeakMiddleware('voiceName', 'lang', false);
-        });
-
-        it('throws for falsy lang param', function () {
-            assert.throws(() => new SetSpeakMiddleware('voiceName', '', false));
+            new SetSpeakMiddleware('voiceName', false);
         });
     });
 
@@ -25,7 +21,7 @@ describe('SetSpeakMiddleware', function () {
             },
             voice = 'male',
         } = {}) {
-            return new TestAdapter(logic, { channelId }).use(new SetSpeakMiddleware(voice, 'en-us', fallback));
+            return new TestAdapter(logic, { channelId }).use(new SetSpeakMiddleware(voice, fallback));
         }
 
         it('no fallback does nothing to speak', async function () {