cherrypick: runtypes lock and set speak middleware fixes (#3511)

* fix: lock runtypes to 5.1.x version range (#3509) * port: remove lang from set speak middleware (#3510) Fixes #3507 Co-authored-by: Steven Gum <14935595+stevengum@users.noreply.github.com> Co-authored-by: Steven Gum <14935595+stevengum@users.noreply.github.com>
microsoft · Apr 1, 2021 · f97b675 · f97b675
1 parent 756b85f
commit f97b675
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 29 deletions.
diff --git a/libraries/botbuilder-dialogs-adaptive-runtime-core/package.json b/libraries/botbuilder-dialogs-adaptive-runtime-core/package.json
@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "dependency-graph": "^0.10.0",
-    "runtypes": "^5.0.1"
+    "runtypes": "~5.1.0"
   },
   "devDependencies": {
     "mocha": "^8.2.1",

diff --git a/libraries/botbuilder-dialogs-adaptive-runtime-integration-express/package.json b/libraries/botbuilder-dialogs-adaptive-runtime-integration-express/package.json
@@ -31,6 +31,6 @@
     "botbuilder-dialogs-adaptive-runtime": "4.1.6",
     "botbuilder-dialogs-adaptive-runtime-core": "4.1.6",
     "express": "^4.17.1",
-    "runtypes": "^5.0.1"
+    "runtypes": "~5.1.0"
   }
 }
diff --git a/libraries/botbuilder-dialogs-adaptive-runtime-integration-restify/package.json b/libraries/botbuilder-dialogs-adaptive-runtime-integration-restify/package.json
@@ -25,7 +25,7 @@
     "botbuilder-dialogs-adaptive-runtime": "4.1.6",
     "botbuilder-dialogs-adaptive-runtime-core": "4.1.6",
     "restify": "^8.5.1",
-    "runtypes": "^5.0.1"
+    "runtypes": "~5.1.0"
   },
   "scripts": {
     "build": "tsc -b",

diff --git a/libraries/botbuilder-dialogs-adaptive-runtime/package.json b/libraries/botbuilder-dialogs-adaptive-runtime/package.json
@@ -40,7 +40,7 @@
     "botframework-connector": "4.1.6",
     "dependency-graph": "^0.10.0",
     "nconf": "^0.11.2",
-    "runtypes": "^5.0.1",
+    "runtypes": "~5.1.0",
     "yargs-parser": "^20.2.7"
   },
   "devDependencies": {

diff --git a/libraries/botbuilder-dialogs-adaptive-runtime/src/index.ts b/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)
                 );
             }
 

diff --git a/libraries/botbuilder/src/setSpeakMiddleware.ts b/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>`;
                         }
                     }
                 })

diff --git a/libraries/botbuilder/tests/setSpeakMiddleware.test.js b/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 () {

diff --git a/yarn.lock b/yarn.lock
@@ -10812,10 +10812,10 @@ run-queue@^1.0.0, run-queue@^1.0.3:
   dependencies:
     aproba "^1.1.1"
 
-runtypes@^5.0.1:
-  version "5.0.1"
-  resolved "https://registry.yarnpkg.com/runtypes/-/runtypes-5.0.1.tgz#406d140410266f6ece17c3501a37234f91faa346"
-  integrity sha512-+TWVlCmFsgrG4Nd2u+ambpNFO8Yp4heAflGQi9oNj6GRkxZo8aSDBxO1Y0vlKIQCWKKFxato+8Hn67XeAqKhRA==
+runtypes@~5.1.0:
+  version "5.1.0"
+  resolved "https://registry.yarnpkg.com/runtypes/-/runtypes-5.1.0.tgz#a1f2501b5ca8fda47d51ea15b6ccca45e924a8c3"
+  integrity sha512-OMHkz6dxysXj4E8Fj/HCGjtdJUhapQUN7puvqzuzvjaX28pd52PZmEMqQlkIzCfKdhXdM0ghx8PpvELprEnOLQ==
 
 safe-buffer@5.1.2, safe-buffer@~5.1.0, safe-buffer@~5.1.1:
   version "5.1.2"