fix(synthetics): updated handler validation

packages/@aws-cdk/aws-synthetics-alpha/lib/canary.ts

@@ -22,25 +22,9 @@ export class Test {
    * @param options The configuration options
    */
   public static custom(options: CustomTestOptions): Test {
-    Test.validateHandler(options.handler);
     return new Test(options.code, options.handler);
   }
 
-  /**
-   * Verifies that the given handler ends in '.handler'. Returns the handler if successful and
-   * throws an error if not.
-   *
-   * @param handler - the handler given by the user
-   */
-  private static validateHandler(handler: string) {
-    if (!handler.endsWith('.handler')) {
-      throw new Error(`Canary Handler must end in '.handler' (${handler})`);
-    }
-    if (handler.length > 21) {
-      throw new Error(`Canary Handler must be less than 21 characters (${handler})`);
-    }
-  }
-
   /**
    * Construct a Test property
    *
@@ -422,6 +406,7 @@ export class Canary extends cdk.Resource implements ec2.IConnectable {
    * Returns the code object taken in by the canary resource.
    */
   private createCode(props: CanaryProps): CfnCanary.CodeProperty {
+    this.validateHandler(props.test.handler, props.runtime);
     const codeConfig = {
       handler: props.test.handler,
       ...props.test.code.bind(this, props.test.handler, props.runtime.family),
@@ -435,6 +420,31 @@ export class Canary extends cdk.Resource implements ec2.IConnectable {
     };
   }
 
+  private validateHandler(handler: string, runtime: Runtime) {
+    if (
+      runtime === Runtime.SYNTHETICS_PYTHON_SELENIUM_1_0 ||
+      runtime === Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_0 ||
+      runtime === Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_1 ||
+      runtime === Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_2 ||
+      runtime === Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_3
+    ) {
+      if (!handler.match(/^[0-9A-Za-z_\\-]+\.handler*$/)) {
+        throw new Error(`Canary Handler must be specified as \'fileName.handler\' for legacy runtimes, received ${handler}`);
+      }
+    } else if (runtime === Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_4) {
+      if (!handler.match(/^[0-9A-Za-z_\\-]+\.[A-Za-z_][A-Za-z0-9_]*$/)) {
+        throw new Error(`Canary Handler must be specified either as \'fileName.handler\' or \'fileName.functionName\' for the \'syn-nodejs-puppeteer-3.4'\ runtime, received ${handler}`);
+      }
+    } else {
+      if (!handler.match(/^([0-9a-zA-Z_-]+\/)*[0-9A-Za-z_\\-]+\.[A-Za-z_][A-Za-z0-9_]*$/)) {
+        throw new Error(`Canary Handler must be specified either as \'fileName.handler\', \'fileName.functionName\', or \'folder/fileName.functionName\', received ${handler}`);
+      }
+    }
+    if (handler.length < 1 || handler.length > 128) {
+      throw new Error(`Canary Handler length must be between 1 and 128, received ${handler.length}`);
+    }
+  }
+
   private createRunConfig(props: CanaryProps): CfnCanary.RunConfigProperty | undefined {
     if (!props.environmentVariables) {
       return undefined;

packages/@aws-cdk/aws-synthetics-alpha/lib/code.ts

@@ -164,12 +164,7 @@ export class InlineCode extends Code {
     }
   }
 
-  public bind(_scope: Construct, handler: string, _family: RuntimeFamily): CodeConfig {
-
-    if (handler !== 'index.handler') {
-      throw new Error(`The handler for inline code must be "index.handler" (got "${handler}")`);
-    }
-
+  public bind(_scope: Construct, _handler: string, _family: RuntimeFamily): CodeConfig {
     return {
       inlineCode: this.code,
     };

packages/@aws-cdk/aws-synthetics-alpha/test/canary.test.ts

@@ -703,3 +703,81 @@ testDeprecated('Role policy generated as expected', () => {
     }],
   });
 });
+
+testDeprecated('Should create handler with path for recent runtimes', () => {
+  // GIVEN
+  const stack = new Stack();
+
+  // WHEN
+  new synthetics.Canary(stack, 'Canary', {
+    canaryName: 'mycanary',
+    test: synthetics.Test.custom({
+      handler: 'folder/fileName.functionName',
+      code: synthetics.Code.fromInline('/* Synthetics handler code */'),
+    }),
+    runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_8,
+  });
+
+  // THEN
+  Template.fromStack(stack).hasResourceProperties('AWS::Synthetics::Canary', {
+    Name: 'mycanary',
+    Code: {
+      Handler: 'folder/fileName.functionName',
+    },
+    RuntimeVersion: 'syn-nodejs-puppeteer-3.8',
+  });
+});
+
+describe('handler validation', () => {
+  testDeprecated('legacy runtimes', () => {
+    const stack = new Stack();
+    expect(() => {
+      new synthetics.Canary(stack, 'Canary', {
+        test: synthetics.Test.custom({
+          handler: 'index.functionName',
+          code: synthetics.Code.fromInline('/* Synthetics handler code'),
+        }),
+        runtime: synthetics.Runtime.SYNTHETICS_PYTHON_SELENIUM_1_0,
+      });
+    }).toThrow(/Canary Handler must be specified as 'fileName.handler' for legacy runtimes/);
+  });
+
+  testDeprecated('syn-nodejs-puppeteer-3.4', () => {
+    const stack = new Stack();
+    expect(() => {
+      new synthetics.Canary(stack, 'Canary', {
+        test: synthetics.Test.custom({
+          handler: 'folder/fileName.functionName',
+          code: synthetics.Code.fromInline('/* Synthetics handler code'),
+        }),
+        runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_4,
+      });
+    }).toThrow(/Canary Handler must be specified either as 'fileName.handler' or 'fileName.functionName' for the 'syn-nodejs-puppeteer-3.4' runtime/);
+  });
+
+  testDeprecated('recent runtimes', () => {
+    const stack = new Stack();
+    expect(() => {
+      new synthetics.Canary(stack, 'Canary', {
+        test: synthetics.Test.custom({
+          handler: 'invalidHandler',
+          code: synthetics.Code.fromInline('/* Synthetics handler code'),
+        }),
+        runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_9,
+      });
+    }).toThrow(/Canary Handler must be specified either as 'fileName.handler', 'fileName.functionName', or 'folder\/fileName.functionName'/);
+  });
+
+  testDeprecated('handler length', () => {
+    const stack = new Stack();
+    expect(() => {
+      new synthetics.Canary(stack, 'Canary1', {
+        test: synthetics.Test.custom({
+          handler: 'longHandlerName'.repeat(10) + '.handler',
+          code: synthetics.Code.fromInline('/* Synthetics handler code'),
+        }),
+        runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_9,
+      });
+    }).toThrow(/Canary Handler length must be between 1 and 128/);
+  });
+});

packages/@aws-cdk/aws-synthetics-alpha/test/code.test.ts

@@ -30,15 +30,6 @@ describe(synthetics.Code.fromInline, () => {
     expect(() => synthetics.Code.fromInline(''))
       .toThrowError('Canary inline code cannot be empty');
   });
-
-  test('fails if handler is not "index.handler"', () => {
-    // GIVEN
-    const stack = new Stack(new App(), 'canaries');
-
-    // THEN
-    expect(() => synthetics.Code.fromInline('code').bind(stack, 'canary.handler', RuntimeFamily.NODEJS))
-      .toThrowError('The handler for inline code must be "index.handler" (got "canary.handler")');
-  });
 });
 
 describe(synthetics.Code.fromAsset, () => {