feat: expose simulation type field for dialog and simulation command …

…to facilitate Dynamic Routing cr https://code.amazon.com/reviews/CR-21723955
alexa · Jul 19, 2021 · 5cac3cf · 5cac3cf
1 parent 13c0634
commit 5cac3cf
Show file tree

Hide file tree

Showing 8 changed files with 60 additions and 16 deletions.
diff --git a/lib/clients/smapi-client/resources/test.js b/lib/clients/smapi-client/resources/test.js
@@ -23,14 +23,17 @@ module.exports = (smapiHandle) => {
         );
     }
 
-    function simulateSkill(skillId, stage, input, newSession, locale, callback) {
+    function simulateSkill(skillId, stage, input, newSession, locale, simulationType, callback) {
         const url = `skills/${skillId}/stages/${stage}/simulations`;
         const payload = {
             input: {
                 content: input
             },
             device: {
                 locale
+            },
+            simulation: {
+                type: simulationType
             }
         };
         if (newSession) {

diff --git a/lib/commands/dialog/index.js b/lib/commands/dialog/index.js
@@ -32,7 +32,7 @@ class DialogCommand extends AbstractCommand {
     }
 
     optionalOptions() {
-        return ['skill-id', 'locale', 'stage', 'replay', 'save-skill-io', 'profile', 'debug'];
+        return ['skill-id', 'locale', 'stage', 'replay', 'save-skill-io', 'simulation-type', 'profile', 'debug'];
     }
 
     handle(cmd, cb) {
@@ -125,7 +125,8 @@ class DialogCommand extends AbstractCommand {
                 Messenger.getInstance().info(`Defaulting locale to the first value from the skill manifest: ${firstLocaleFromManifest}`);
             }
             locale = locale || process.env.ASK_DEFAULT_DEVICE_LOCALE || firstLocaleFromManifest;
-            callback(null, { skillId, locale, stage, profile, debug, replay: cmd.replay, saveSkillIo, smapiClient, userInputs });
+            const simulationType = !stringUtils.isNonBlankString(cmd.simulationType) ? 'DEFAULT' : cmd.simulationType;
+            callback(null, { skillId, locale, stage, profile, debug, replay: cmd.replay, saveSkillIo, smapiClient, userInputs, simulationType });
         });
     }
 

diff --git a/lib/commands/option-model.json b/lib/commands/option-model.json
@@ -35,6 +35,16 @@
     "alias": null,
     "stringInput": "NONE"
   },
+  "simulation-type": {
+    "name": "simulation-type",
+    "description": "run skill in the specified simulation mode (currently supports DEFAULT / NFI_ISOLATED_SIMULATION)",
+    "alias": null,
+    "stringInput": "REQUIRED",
+    "rule": [{
+      "type": "ENUM",
+      "values": ["DEFAULT", "NFI_ISOLATED_SIMULATION"]
+    }]
+  },
   "skill-id": {
     "name": "skill-id",
     "description": "Skill id",

diff --git a/lib/controllers/skill-simulation-controller/index.js b/lib/controllers/skill-simulation-controller/index.js
@@ -15,13 +15,14 @@ module.exports = class SkillSimulationController {
         if (configuration === undefined) {
             throw 'Cannot have an undefined configuration.';
         }
-        const { skillId, locale, stage, profile, saveSkillIo, debug, smapiClient } = configuration;
+        const { skillId, locale, stage, profile, saveSkillIo, debug, smapiClient, simulationType } = configuration;
         this.profile = profile;
         this.doDebug = debug;
         this.smapiClient = smapiClient || new SmapiClient({ profile: this.profile, doDebug: this.doDebug });
         this.skillId = skillId;
         this.locale = locale;
         this.stage = stage;
+        this.simulationtype = simulationType;
         this.skillIOInstance = new DialogSaveSkillIoFile(saveSkillIo);
     }
 
@@ -33,7 +34,7 @@ module.exports = class SkillSimulationController {
      */
     startSkillSimulation(utterance, newSession, callback) {
         this.skillIOInstance.startInvocation({ utterance, newSession });
-        this.smapiClient.skill.test.simulateSkill(this.skillId, this.stage, utterance, newSession, this.locale, (err, res) => {
+        this.smapiClient.skill.test.simulateSkill(this.skillId, this.stage, utterance, newSession, this.locale, this.simulationtype, (err, res) => {
             if (err) {
                 return callback(err);
             }

diff --git a/test/unit/clients/smapi-client-test/resources/test.js b/test/unit/clients/smapi-client-test/resources/test.js
@@ -18,6 +18,7 @@ module.exports = (smapiClient) => {
         const TEST_SKILL_ID = 'skillId';
         const TEST_INPUT = 'input';
         const TEST_LOCALE = ' locale1  , locale2  ';
+        const TEST_SIMULATION_TYPE = 'DEFAULT';
         const TEST_SIMULATION_ID = 'simulationId';
         const TEST_ENDPOINT_REGION = 'endpointRegion';
         const TEST_INVOKE_PAYLOAD = 'invokePayload';
@@ -28,7 +29,7 @@ module.exports = (smapiClient) => {
             {
                 testCase: 'simulate-skill without force new session',
                 apiFunc: smapiClient.skill.test.simulateSkill,
-                parameters: [TEST_SKILL_ID, CONSTANTS.SKILL.STAGE.DEVELOPMENT, TEST_INPUT, false, TEST_LOCALE, noop],
+                parameters: [TEST_SKILL_ID, CONSTANTS.SKILL.STAGE.DEVELOPMENT, TEST_INPUT, false, TEST_LOCALE, TEST_SIMULATION_TYPE, noop],
                 expectedOptions: {
                     url: `${CONSTANTS.SMAPI.ENDPOINT}/${CONSTANTS.SMAPI.VERSION.V2}/skills/${TEST_SKILL_ID}`
                         + `/stages/${CONSTANTS.SKILL.STAGE.DEVELOPMENT}/simulations`,
@@ -38,15 +39,18 @@ module.exports = (smapiClient) => {
                     },
                     body: {
                         input: { content: TEST_INPUT },
-                        device: { locale: TEST_LOCALE }
+                        device: { locale: TEST_LOCALE },
+                        simulation: {
+                            type: TEST_SIMULATION_TYPE
+                        }
                     },
                     json: true
                 }
             },
             {
                 testCase: 'simulate-skill with force new session',
                 apiFunc: smapiClient.skill.test.simulateSkill,
-                parameters: [TEST_SKILL_ID, CONSTANTS.SKILL.STAGE.DEVELOPMENT, TEST_INPUT, true, TEST_LOCALE, noop],
+                parameters: [TEST_SKILL_ID, CONSTANTS.SKILL.STAGE.DEVELOPMENT, TEST_INPUT, true, TEST_LOCALE, TEST_SIMULATION_TYPE, noop],
                 expectedOptions: {
                     url: `${CONSTANTS.SMAPI.ENDPOINT}/${CONSTANTS.SMAPI.VERSION.V2}/skills/${TEST_SKILL_ID}`
                         + `/stages/${CONSTANTS.SKILL.STAGE.DEVELOPMENT}/simulations`,
@@ -57,7 +61,10 @@ module.exports = (smapiClient) => {
                     body: {
                         input: { content: TEST_INPUT },
                         device: { locale: TEST_LOCALE },
-                        session: { mode: FORCE_NEW_SESSION }
+                        session: { mode: FORCE_NEW_SESSION },
+                        simulation: {
+                            type: TEST_SIMULATION_TYPE
+                        }
                     },
                     json: true
                 }

diff --git a/test/unit/commands/dialog/index-test.js b/test/unit/commands/dialog/index-test.js
@@ -52,7 +52,7 @@ describe('Commands Dialog test - command class test', () => {
         expect(instance.name()).eq('dialog');
         expect(instance.description()).eq('simulate your skill via an interactive dialog with Alexa');
         expect(instance.requiredOptions()).deep.eq([]);
-        expect(instance.optionalOptions()).deep.eq(['skill-id', 'locale', 'stage', 'replay', 'save-skill-io', 'profile', 'debug']);
+        expect(instance.optionalOptions()).deep.eq(['skill-id', 'locale', 'stage', 'replay', 'save-skill-io', 'simulation-type', 'profile', 'debug']);
     });
 
     describe('# validate command handle', () => {
@@ -203,7 +203,8 @@ describe('Commands Dialog test - command class test', () => {
                 // setup
                 const TEST_CMD_WITH_VALUES = {
                     stage: '',
-                    replay: DIALOG_REPLAY_FILE_JSON_PATH
+                    replay: DIALOG_REPLAY_FILE_JSON_PATH,
+                    simulationType: 'NFI_ISOLATED_SIMULATION'
                 };
                 sinon.stub(profileHelper, 'runtimeProfile').returns(TEST_PROFILE);
                 sinon.stub(httpClient, 'request').yields(null, { statusCode: 200, body: { manifest } });
@@ -216,11 +217,32 @@ describe('Commands Dialog test - command class test', () => {
                     expect(config.replay).equal(DIALOG_REPLAY_FILE_JSON_PATH);
                     expect(config.skillId).equal('amzn1.ask.skill.1234567890');
                     expect(config.stage).equal('development');
+                    expect(config.simulationType).equal('NFI_ISOLATED_SIMULATION');
                     expect(config.userInputs).deep.equal(['hello', 'world']);
                     done();
                 });
             });
 
+            it('| returns valid config with default simulation type', () => {
+                // setup
+                const TEST_CMD_WITH_VALUES = {
+                    stage: '',
+                    replay: DIALOG_REPLAY_FILE_JSON_PATH,
+                };
+                sinon.stub(profileHelper, 'runtimeProfile').returns(TEST_PROFILE);
+                // call
+                const config = instance._getDialogConfig(TEST_CMD_WITH_VALUES);
+                // verify
+                expect(config.debug).equal(false);
+                expect(config.locale).equal('en-US');
+                expect(config.profile).equal('default');
+                expect(config.replay).equal(DIALOG_REPLAY_FILE_JSON_PATH);
+                expect(config.skillId).equal('amzn1.ask.skill.1234567890');
+                expect(config.stage).equal('development');
+                expect(config.simulationType).equal('DEFAULT');
+                expect(config.userInputs).deep.equal(['hello', 'world']);
+            });
+
             it('| returns error when initialization of DialogReplayFile fails', (done) => {
                 // setup
                 const TEST_CMD_WITH_VALUES = {

diff --git a/test/unit/controller/dialog-controller/index-test.js b/test/unit/controller/dialog-controller/index-test.js
@@ -63,7 +63,7 @@ describe('Controller test - dialog controller test', () => {
 
         it('| test utterance input and response is stored into appropriate caches', (done) => {
             // setup
-            simulateSkillStub.callsArgWith(5, null, { msg: TEST_MSG });
+            simulateSkillStub.callsArgWith(6, null, { msg: TEST_MSG });
             // call
             dialogController.startSkillSimulation(TEST_MSG, (err, response) => {
                 // verify
@@ -76,7 +76,7 @@ describe('Controller test - dialog controller test', () => {
 
         it('| test an error in request does not effect caches', (done) => {
             // setup
-            simulateSkillStub.callsArgWith(5, TEST_MSG, null);
+            simulateSkillStub.callsArgWith(6, TEST_MSG, null);
             // call
             dialogController.startSkillSimulation(TEST_MSG, (err, response) => {
                 // verify

diff --git a/test/unit/controller/skill-simulation-controller-test.js b/test/unit/controller/skill-simulation-controller-test.js
@@ -63,7 +63,7 @@ describe('Controller test - skill simulation controller test', () => {
                     result: null
                 }
             };
-            simulateSkillStub.callsArgWith(5, null, TEST_RES);
+            simulateSkillStub.callsArgWith(6, null, TEST_RES);
             // call
             simulationController.startSkillSimulation(TEST_MSG, true, (err, response) => {
                 // verify
@@ -82,7 +82,7 @@ describe('Controller test - skill simulation controller test', () => {
                     message: TEST_MSG
                 }
             };
-            simulateSkillStub.callsArgWith(5, null, TEST_RES);
+            simulateSkillStub.callsArgWith(6, null, TEST_RES);
             // call
             simulationController.startSkillSimulation(TEST_MSG, true, (err, response) => {
                 // verify
@@ -94,7 +94,7 @@ describe('Controller test - skill simulation controller test', () => {
 
         it('| test for SMAPI.test.simulateSkill gives correct error', (done) => {
             // setup
-            simulateSkillStub.callsArgWith(5, TEST_MSG, null);
+            simulateSkillStub.callsArgWith(6, TEST_MSG, null);
             // call
             simulationController.startSkillSimulation(TEST_MSG, true, (err, response) => {
                 // verify