feat: Introduced restrictive logging of sensitive data and configurat…

…ion of logging output feat: Introduced new prop on ControlHandler and ControlManager : `services` to customize and override default service implementations on the framework `services` can be extended to include and customize logging, i18 resources etc
alexa · Jun 3, 2021 · 56f78cf · 56f78cf
1 parent b194c39
commit 56f78cf
Show file tree

Hide file tree

Showing 39 changed files with 516 additions and 151 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,4 @@ node_modules
 .DS_Store
 .nycrc
 .nyc_output
-coverage/
+coverage/
diff --git a/demo/ComponentModeAPL/src/buildInteractionModel.ts b/demo/ComponentModeAPL/src/buildInteractionModel.ts
@@ -12,10 +12,12 @@
  */
 
 import { ComponentModeDemo } from '.';
+import { ControlServices } from '../../../src/controls/ControlServices';
 import { ControlInteractionModelGenerator } from '../../../src/interactionModelGeneration/ControlInteractionModelGenerator';
-import { Logger } from '../../../src/logging/Logger';
 
-const log = new Logger('ComponentModeDemo:InteractionModel');
+const MODULE_NAME = 'ComponentModeDemo:InteractionModel';
+const services = ControlServices.getDefaults();
+const log = services.logger.getLogger(MODULE_NAME);
 
 export namespace ComponentModeDemoIM {
     export const imGen = new ControlInteractionModelGenerator()

diff --git a/demo/ListControl/YesNoMaybe/src/buildInteractionModel.ts b/demo/ListControl/YesNoMaybe/src/buildInteractionModel.ts
@@ -11,17 +11,14 @@
  * permissions and limitations under the License.
  */
 
-import { v1 } from 'ask-smapi-model';
 import { ListDemo1 } from '.';
+import { ControlServices } from '../../../../src/controls/ControlServices';
 import { ControlInteractionModelGenerator } from '../../../../src/interactionModelGeneration/ControlInteractionModelGenerator';
-import { Logger } from '../../../../src/logging/Logger';
 import { filteredYesNoMaybeSlotType, yesNoMaybeSlotType } from './interactionModelTypes';
 
-import SlotType = v1.skill.interactionModel.SlotType;
-import TypeValue = v1.skill.interactionModel.TypeValue;
-import Intent = v1.skill.interactionModel.Intent;
-
-const log = new Logger('HelloWorld:InteractionModel');
+const MODULE_NAME = 'HelloWorld:InteractionModel';
+const services = ControlServices.getDefaults();
+const log = services.logger.getLogger(MODULE_NAME);
 
 export namespace ListDemo1IM {
     export const imGen = new ControlInteractionModelGenerator()
@@ -49,5 +46,5 @@ export namespace ListDemo1IM {
 if (require.main === module) {
     // Build and write
     ListDemo1IM.imGen.buildAndWrite('en-US-generated.json');
-    console.log('Wrote ./en-US-generated.json');
+    log.info('Wrote ./en-US-generated.json');
 }
diff --git a/demo/MultiValueListControl/src/buildInteractionModel.ts b/demo/MultiValueListControl/src/buildInteractionModel.ts
@@ -12,13 +12,16 @@
  */
 
 import { MultiValueListDemo } from '.';
-import { Logger, ControlInteractionModelGenerator } from '../../../src';
+import { ControlInteractionModelGenerator } from '../../../src';
+import { ControlServices } from '../../../src/controls/ControlServices';
 import {
-    yesNoMaybeSlotType,
     filteredYesNoMaybeSlotType,
+    yesNoMaybeSlotType,
 } from '../../ListControl/YesNoMaybe/src/interactionModelTypes';
 
-const log = new Logger('MultiValueListDemo:InteractionModel');
+const MODULE_NAME = 'MultiValueListDemo:InteractionModel';
+const services = ControlServices.getDefaults();
+const log = services.logger.getLogger(MODULE_NAME);
 
 export namespace MultiValueListDemoIM {
     export const imGen = new ControlInteractionModelGenerator()
@@ -80,5 +83,5 @@ export namespace MultiValueListDemoIM {
 if (require.main === module) {
     // Build and write
     MultiValueListDemoIM.imGen.buildAndWrite('en-US-generated.json');
-    console.log('Wrote ./en-US-generated.json');
+    log.info('Wrote ./en-US-generated.json');
 }
diff --git a/demo/NumberControl/NumberDemo/src/buildInteractionModel.ts b/demo/NumberControl/NumberDemo/src/buildInteractionModel.ts
@@ -12,10 +12,12 @@
  */
 
 import { BasicNumberDemo } from '.';
+import { ControlServices } from '../../../../src/controls/ControlServices';
 import { ControlInteractionModelGenerator } from '../../../../src/interactionModelGeneration/ControlInteractionModelGenerator';
-import { Logger } from '../../../../src/logging/Logger';
 
-const log = new Logger('NumberControlDemo:InteractionModel');
+const MODULE_NAME = 'NumberControlDemo:InteractionModel';
+const services = ControlServices.getDefaults();
+const log = services.logger.getLogger(MODULE_NAME);
 
 export namespace BasicNumberDemoIM {
     export const imGen = new ControlInteractionModelGenerator()
@@ -35,5 +37,5 @@ export namespace BasicNumberDemoIM {
 if (require.main === module) {
     // Build and write
     BasicNumberDemoIM.imGen.buildAndWrite('en-US-generated.json');
-    console.log('Wrote ./en-US-generated.json');
+    log.info('Wrote ./en-US-generated.json');
 }
diff --git a/demo/NumberControl/NumberDemo/src/index.ts b/demo/NumberControl/NumberDemo/src/index.ts
@@ -1,10 +1,38 @@
 import { SkillBuilders } from 'ask-sdk-core';
+import Debug from 'debug';
+import { DefaultLogger } from '../../../../src';
 import { NumberControl } from '../../../../src/commonControls/numberControl/NumberControl';
 import { Control } from '../../../../src/controls/Control';
 import { ControlManager } from '../../../../src/controls/ControlManager';
+import { ControlServices } from '../../../../src/controls/ControlServices';
+import { ILogger } from '../../../../src/controls/interfaces/ILogger';
+import { ILoggerFactory } from '../../../../src/controls/interfaces/ILoggerFactory';
 import { ControlHandler } from '../../../../src/runtime/ControlHandler';
 import { DemoRootControl } from '../../../Common/src/DemoRootControl';
 
+export class CustomLoggerFactory implements ILoggerFactory {
+    getLogger(namespace: string): ILogger {
+        return new CustomLogger(namespace);
+    }
+}
+
+export class CustomLogger extends DefaultLogger {
+    info(message: string): void {
+        Debug(`info:Redfox:${this.moduleName}`)(message);
+    }
+
+    sanitize(message: any): string {
+        if (
+            process.env.ASK_SDK_RESTRICTIVE_LOGGING !== undefined &&
+            process.env.ASK_SDK_RESTRICTIVE_LOGGING === 'true'
+        ) {
+            return '###################';
+        } else {
+            return message;
+        }
+    }
+}
+
 /**
  * Simple demonstration of a number control.
  *
@@ -33,6 +61,9 @@ export namespace BasicNumberDemo {
     }
 }
 
+const services = { logger: new CustomLoggerFactory() };
+ControlServices.setDefaults(services);
+
 export const handler = SkillBuilders.custom()
     .addRequestHandlers(new ControlHandler(new BasicNumberDemo.DemoControlManager()))
     .lambda();
diff --git a/demo/QuestionnaireControl/src/buildInteractionModel.ts b/demo/QuestionnaireControl/src/buildInteractionModel.ts
@@ -11,16 +11,13 @@
  * permissions and limitations under the License.
  */
 
-import { v1 } from 'ask-smapi-model';
 import { MultipleLists } from '.';
+import { ControlServices } from '../../../src/controls/ControlServices';
 import { ControlInteractionModelGenerator } from '../../../src/interactionModelGeneration/ControlInteractionModelGenerator';
-import { Logger } from '../../../src/logging/Logger';
 
-import SlotType = v1.skill.interactionModel.SlotType;
-import TypeValue = v1.skill.interactionModel.TypeValue;
-import Intent = v1.skill.interactionModel.Intent;
-
-const log = new Logger('QuestionnaireControlDemo:InteractionModel');
+const MODULE_NAME = 'QuestionnaireControlDemo:InteractionModel';
+const services = ControlServices.getDefaults();
+const log = services.logger.getLogger(MODULE_NAME);
 
 export namespace TwoListsIM {
     export const imGen = new ControlInteractionModelGenerator()
@@ -191,5 +188,5 @@ export namespace TwoListsIM {
 if (require.main === module) {
     // Build and write
     TwoListsIM.imGen.buildAndWrite('en-US-generated.json');
-    console.log('Wrote ./en-US-generated.json');
+    log.info('Wrote ./en-US-generated.json');
 }
diff --git a/demo/TwoLists/src/buildInteractionModel.ts b/demo/TwoLists/src/buildInteractionModel.ts
@@ -11,16 +11,13 @@
  * permissions and limitations under the License.
  */
 
-import { v1 } from 'ask-smapi-model';
 import { MultipleLists } from '.';
+import { ControlServices } from '../../../src/controls/ControlServices';
 import { ControlInteractionModelGenerator } from '../../../src/interactionModelGeneration/ControlInteractionModelGenerator';
-import { Logger } from '../../../src/logging/Logger';
 
-import SlotType = v1.skill.interactionModel.SlotType;
-import TypeValue = v1.skill.interactionModel.TypeValue;
-import Intent = v1.skill.interactionModel.Intent;
-
-const log = new Logger('HelloWorld:InteractionModel');
+const MODULE_NAME = 'HelloWorld:InteractionModel';
+const services = ControlServices.getDefaults();
+const log = services.logger.getLogger(MODULE_NAME);
 
 export namespace TwoListsIM {
     export const imGen = new ControlInteractionModelGenerator()
@@ -134,5 +131,5 @@ export namespace TwoListsIM {
 if (require.main === module) {
     // Build and write
     TwoListsIM.imGen.buildAndWrite('en-US-generated.json');
-    console.log('Wrote ./en-US-generated.json');
+    log.info('Wrote ./en-US-generated.json');
 }
diff --git a/ide/vscode/launch.json b/ide/vscode/launch.json
@@ -33,13 +33,14 @@
             "env": {
                 // "DEBUG": "error:*, warn:*, info:*"  // uncomment for logs
                 // "ASK_SDK_CONTROLS_LOG_RESPONSE_FILEPATH": <file_path> // uncomment to write out response for debugging
+                //"ASK_SDK_RESTRICTIVE_LOGGING": "true" // uncomment to restrict sensitive information from logging such as slot values
             },
             // "smartStep": true,
             "skipFiles": [
                 "node_modules/**",
                 "<node_internals>/**"
             ],
-            "console": "integratedTerminal",
+            "console": "integratedTerminal"
 
         }
     ]

diff --git a/src/commonControls/DateControl.ts b/src/commonControls/DateControl.ts
@@ -23,14 +23,15 @@ import {
 } from '../controls/Control';
 import { ControlInput } from '../controls/ControlInput';
 import { ControlResultBuilder } from '../controls/ControlResult';
+import { ControlServices, ControlServicesProps } from '../controls/ControlServices';
+import { ILogger } from '../controls/interfaces/ILogger';
 import { InteractionModelContributor } from '../controls/mixins/InteractionModelContributor';
 import { evaluateValidationProp, StateValidationFunction, ValidationFailure } from '../controls/Validation';
 import { AmazonBuiltInSlotType } from '../intents/AmazonBuiltInSlotType';
 import { GeneralControlIntent, unpackGeneralControlIntent } from '../intents/GeneralControlIntent';
 import { unpackValueControlIntent, ValueControlIntent } from '../intents/ValueControlIntent';
 import { ControlInteractionModelGenerator } from '../interactionModelGeneration/ControlInteractionModelGenerator';
 import { ModelData } from '../interactionModelGeneration/ModelTypes';
-import { Logger } from '../logging/Logger';
 import { ControlResponseBuilder } from '../responseGeneration/ControlResponseBuilder';
 import {
     InvalidValueAct,
@@ -48,7 +49,7 @@ import { InputUtil } from '../utils/InputUtil';
 import { falseIfGuardFailed, okIf } from '../utils/Predicates';
 import { getEndDateOfRange, getStartDateOfRange, getUTCDate } from './dateRangeControl/DateHelper';
 
-const log = new Logger('AskSdkControls:DateControl');
+const MODULE_NAME = 'AskSdkControls:DateControl';
 
 /**
  * Props for a DateControl.
@@ -124,6 +125,11 @@ export interface DateControlProps extends ControlProps {
      * Default: returns the value unchanged.
      */
     valueRenderer?: (value: string, input: ControlInput) => string;
+
+    /**
+     * Props to customize services used by the control.
+     */
+    services?: ControlServicesProps;
 }
 
 /**
@@ -354,12 +360,14 @@ export class DateControl extends Control implements InteractionModelContributor
         input: ControlInput,
         resultBuilder: ControlResultBuilder,
     ) => void | Promise<void>;
+    private log: ILogger;
 
     constructor(props: DateControlProps) {
         super(props.id);
         this.rawProps = props;
         this.props = DateControl.mergeWithDefaultProps(props);
         this.state.lastInitiative = {};
+        this.log = this.props.services.logger.getLogger(MODULE_NAME);
     }
 
     /**
@@ -432,6 +440,7 @@ export class DateControl extends Control implements InteractionModelContributor
             validation: [],
             confirmationRequired: false,
             required: true,
+            services: props.services ?? ControlServices.getDefaults(),
         };
 
         return _.merge(defaults, props);
@@ -667,7 +676,7 @@ export class DateControl extends Control implements InteractionModelContributor
 
     // tsDoc - see Control
     async handle(input: ControlInput, resultBuilder: ControlResultBuilder): Promise<void> {
-        log.debug(`DateControl[${this.id}]: handle(). Entering`);
+        this.log.debug(`DateControl[${this.id}]: handle(). Entering`);
 
         if (this.handleFunc === undefined) {
             const intent: Intent = (input.request as IntentRequest).intent;
@@ -694,7 +703,7 @@ export class DateControl extends Control implements InteractionModelContributor
         if (this.initiativeFunc === undefined) {
             const errorMsg =
                 'DateControl: takeInitiative called but this.initiativeFunc is not set. canTakeInitiative() should be called first to set this.initiativeFunc.';
-            log.error(errorMsg);
+            this.log.error(errorMsg);
             throw new Error(errorMsg);
         }
         await this.initiativeFunc(input, resultBuilder);

diff --git a/src/commonControls/LanguageStrings.ts b/src/commonControls/LanguageStrings.ts
@@ -1,9 +1,11 @@
 import { Resource } from 'i18next';
 import { Strings as $ } from '../constants/Strings';
+import { ControlServices } from '../controls/ControlServices';
 import { SharedSlotType } from '../interactionModelGeneration/ModelTypes';
-import { Logger } from '../logging/Logger';
 
-const log = new Logger('AskSdkControls:i18n');
+const MODULE_NAME = 'AskSdkControls:i18n';
+const services = ControlServices.getDefaults();
+const log = services.logger.getLogger(MODULE_NAME);
 
 //todo: move this somewhere more appropriate. consider splitting prompts/intents
 

diff --git a/src/commonControls/ValueControl.ts b/src/commonControls/ValueControl.ts
@@ -24,6 +24,8 @@ import {
 } from '../controls/Control';
 import { ControlInput } from '../controls/ControlInput';
 import { ControlResultBuilder } from '../controls/ControlResult';
+import { ControlServices, ControlServicesProps } from '../controls/ControlServices';
+import { ILogger } from '../controls/interfaces/ILogger';
 import { ControlStateDiagramming } from '../controls/mixins/ControlStateDiagramming';
 import { InteractionModelContributor } from '../controls/mixins/InteractionModelContributor';
 import { evaluateValidationProp, StateValidationFunction, ValidationFailure } from '../controls/Validation';
@@ -32,7 +34,6 @@ import { GeneralControlIntent, unpackGeneralControlIntent } from '../intents/Gen
 import { unpackValueControlIntent, ValueControlIntent } from '../intents/ValueControlIntent';
 import { ControlInteractionModelGenerator } from '../interactionModelGeneration/ControlInteractionModelGenerator';
 import { ModelData } from '../interactionModelGeneration/ModelTypes';
-import { Logger } from '../logging/Logger';
 import { ControlResponseBuilder } from '../responseGeneration/ControlResponseBuilder';
 import {
     InvalidValueAct,
@@ -49,7 +50,7 @@ import { DeepRequired } from '../utils/DeepRequired';
 import { InputUtil } from '../utils/InputUtil';
 import { falseIfGuardFailed, okIf } from '../utils/Predicates';
 
-const log = new Logger('AskSdkControls:ValueControl');
+const MODULE_NAME = 'AskSdkControls:ValueControl';
 
 /**
  * Props for a ValueControl.
@@ -132,6 +133,11 @@ export interface ValueControlProps extends ControlProps {
      * Default: returns the value unchanged.
      */
     valueRenderer?: (value: string, input: ControlInput) => string;
+
+    /**
+     * Props to customize services used by the control.
+     */
+    services?: ControlServicesProps;
 }
 
 /**
@@ -307,6 +313,7 @@ export class ValueControl extends Control implements InteractionModelContributor
         input: ControlInput,
         resultBuilder: ControlResultBuilder,
     ) => void | Promise<void>;
+    private log: ILogger;
 
     constructor(props: ValueControlProps) {
         super(props.id);
@@ -322,6 +329,7 @@ export class ValueControl extends Control implements InteractionModelContributor
         this.rawProps = props;
         this.props = ValueControl.mergeWithDefaultProps(props);
         this.state.lastInitiative = {};
+        this.log = this.props.services.logger.getLogger(MODULE_NAME);
     }
 
     /**
@@ -403,6 +411,7 @@ export class ValueControl extends Control implements InteractionModelContributor
                 customHandlingFuncs: [],
             },
             valueRenderer: (value: string, input) => value,
+            services: props.services ?? ControlServices.getDefaults(),
         };
 
         return _.merge(defaults, props);
@@ -453,7 +462,7 @@ export class ValueControl extends Control implements InteractionModelContributor
     // tsDoc - see Control
     async handle(input: ControlInput, resultBuilder: ControlResultBuilder): Promise<void> {
         if (this.handleFunc === undefined) {
-            log.error(
+            this.log.error(
                 'ValueControl: handle called but this.handleFunc is not set. canHandle() should be called first to set this.handleFunc.',
             );
             const intent: Intent = (input.request as IntentRequest).intent;
@@ -778,7 +787,7 @@ export class ValueControl extends Control implements InteractionModelContributor
         if (this.initiativeFunc === undefined) {
             const errorMsg =
                 'ValueControl: takeInitiative called but this.initiativeFunc is not set. canTakeInitiative() should be called first to set this.initiativeFunc.';
-            log.error(errorMsg);
+            this.log.error(errorMsg);
             throw new Error(errorMsg);
         }
         await this.initiativeFunc(input, resultBuilder);