Allow root level canary scripts files for Puppeteer versions 11 and greater

Author: Nithin Venkatesh

packages/aws-cdk-lib/aws-synthetics/README.md

@@ -267,7 +267,7 @@ new synthetics.Canary(this, 'Bucket Canary', {
 ```
 
 > **Note:** Synthetics have a specified folder structure for canaries.
-> For Node with puppeteer scripts supplied via `code.fromAsset()` or `code.fromBucket()`, the canary resource requires the following folder structure:
+> For Node with puppeteer scripts supplied via `code.fromAsset()` or `code.fromBucket()`, the canary resource requires the following folder structure for runtime versions lesser than `syn-nodejs-puppeteer-11.0`:
 >
 > ```plaintext
 > canary/
@@ -276,6 +276,22 @@ new synthetics.Canary(this, 'Bucket Canary', {
 >         ├── <filename>.js
 > ```
 >
+> For puppeteer based runtime versions greater than or equal to `syn-nodejs-puppeteer-11.0`, `nodjs/node_modules` is not necessary but supported. 
+>
+> Both
+> ```plaintext
+> canary/
+> ├── nodejs/
+>    ├── node_modules/
+>         ├── <filename>.js
+> ```
+> And 
+> ```plaintext
+> canary/
+>  ├── <filename>.js
+> ```
+> are supported.
+>
 > For Node with playwright scripts supplied via `code.fromAsset()` or `code.fromBucket()`, the canary resource requires the following folder structure:
 >
 > ```plaintext

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

@@ -150,9 +150,21 @@ export class AssetCode extends Code {
       if (runtimeName && !Token.isUnresolved(runtimeName)) {
         const playwrightValidExtensions = ['.cjs', '.mjs', '.js'];
         const hasValidExtension = playwrightValidExtensions.some(ext => fs.existsSync(path.join(assetPath, `${filename}${ext}`)));
-        // Requires asset directory to have the structure 'nodejs/node_modules' for puppeteer runtime.
-        if (family === RuntimeFamily.NODEJS && runtimeName.includes('puppeteer') && !fs.existsSync(path.join(assetPath, 'nodejs', 'node_modules', nodeFilename))) {
-          throw new ValidationError(`The canary resource requires that the handler is present at "nodejs/node_modules/${nodeFilename}" but not found at ${this.assetPath} (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Nodejs.html)`, scope);
+        // Requires asset directory to have the structure 'nodejs/node_modules' for puppeteer runtime < version 11.0.
+        if (family === RuntimeFamily.NODEJS && runtimeName.includes('puppeteer')) {
+          const versionMatch = runtimeName.match(/syn-nodejs-puppeteer-(\d+\.\d+)/);
+          const version = versionMatch ? parseFloat(versionMatch[1]) : 0;
+          if (version >= 11.0) {
+            // For versions > 11.0, allow JS files in root path
+            if (!fs.existsSync(path.join(assetPath, nodeFilename)) && !fs.existsSync(path.join(assetPath, 'nodejs', 'node_modules', nodeFilename))) {
+              throw new ValidationError(`The canary resource requires that the handler is present at "${nodeFilename}" or "nodejs/node_modules/${nodeFilename}" but not found at ${this.assetPath} (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Nodejs.html)`, scope);
+            }
+          } else {
+            // For versions < 11.0, require nodejs/node_modules structure
+            if (!fs.existsSync(path.join(assetPath, 'nodejs', 'node_modules', nodeFilename))) {
+              throw new ValidationError(`The canary resource requires that the handler is present at "nodejs/node_modules/${nodeFilename}" but not found at ${this.assetPath} (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Nodejs.html)`, scope);
+            }
+          }
         }
         // Requires the canary handler file to have the extension '.js', '.mjs', or '.cjs' for the playwright runtime.
         if (family === RuntimeFamily.NODEJS && runtimeName.includes('playwright') && !hasValidExtension) {

packages/aws-cdk-lib/aws-synthetics/test/canaries/puppeteer/canary.js

@@ -0,0 +1,52 @@
+var synthetics = require('Synthetics');
+const log = require('SyntheticsLogger');
+const https = require('https');
+const http = require('http');
+
+const apiCanaryBlueprint = async function () {
+    const postData = "";
+
+    const verifyRequest = async function (requestOption) {
+      return new Promise((resolve, reject) => {
+        log.info("Making request with options: " + JSON.stringify(requestOption));
+        let req
+        if (requestOption.protocol === 'https:') {
+          req = https.request(requestOption);
+        } else {
+          req = http.request(requestOption);
+        }
+        req.on('response', (res) => {
+          log.info(`Status Code: ${res.statusCode}`)
+          log.info(`Response Headers: ${JSON.stringify(res.headers)}`)
+          if (res.statusCode !== 200) {
+              reject("Failed: " + requestOption.pathname);
+          }
+          res.on('data', (d) => {
+            log.info("Response: " + d);
+          });
+          res.on('end', () => {
+            resolve();
+          })
+        });
+
+        req.on('error', (error) => {
+          reject(error);
+        });
+
+        if (postData) {
+          req.write(postData);
+        }
+        req.end();
+      });
+    }
+
+    const headers = {}
+    headers['User-Agent'] = [synthetics.getCanaryUserAgentString(), headers['User-Agent']].join(' ');
+    const requestOptions = new URL(process.env.URL);
+    requestOptions['headers'] = headers;
+    await verifyRequest(requestOptions);
+};
+
+exports.functionName = async () => {
+    return await apiCanaryBlueprint();
+};

packages/aws-cdk-lib/aws-synthetics/test/code.test.ts

@@ -227,6 +227,46 @@ describe(synthetics.Code.fromAsset, () => {
       .toThrow(`The canary resource requires that the handler is present at "nodejs/node_modules/incorrect.js" but not found at ${assetPath} (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Nodejs.html)`);
   });
 
+  test('puppeteer runtime >= 11.0 allows JS files in root path', () => {
+    // GIVEN
+    const stack = new Stack(new App(), 'canaries');
+    const assetPath = path.join(__dirname, 'canaries', 'puppeteer');
+
+    // WHEN/THEN - should not throw for puppeteer 11.0+
+    expect(() => synthetics.Code.fromAsset(assetPath).bind(stack, 'canary.handler', synthetics.RuntimeFamily.NODEJS, synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_11_0.name))
+      .not.toThrow();
+  });
+
+  test('puppeteer runtime >= 11.0 also allows nodejs/node_modules structure', () => {
+    // GIVEN
+    const stack = new Stack(new App(), 'canaries');
+    const assetPath = path.join(__dirname, 'canaries');
+
+    // WHEN/THEN - should not throw for puppeteer 11.0+ with nodejs structure (has both root canary.js and nodejs/node_modules/canary.js)
+    expect(() => synthetics.Code.fromAsset(assetPath).bind(stack, 'canary.handler', synthetics.RuntimeFamily.NODEJS, synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_11_0.name))
+      .not.toThrow();
+  });
+
+  test('puppeteer runtime < 11.0 requires nodejs/node_modules structure', () => {
+    // GIVEN
+    const stack = new Stack(new App(), 'canaries');
+    const assetPath = path.join(__dirname, 'canaries');
+
+    // WHEN/THEN - should not throw for puppeteer < 11.0 since nodejs/node_modules/canary.js exists
+    expect(() => synthetics.Code.fromAsset(assetPath).bind(stack, 'canary.handler', synthetics.RuntimeFamily.NODEJS, synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_10_0.name))
+      .not.toThrow();
+  });
+
+  test('puppeteer runtime < 11.0 fails without nodejs/node_modules structure', () => {
+    // GIVEN
+    const stack = new Stack(new App(), 'canaries');
+    const assetPath = path.join(__dirname, 'canaries', 'puppeteer'); // Only has root-level files
+
+    // WHEN/THEN - should throw for puppeteer < 11.0 without nodejs/node_modules structure
+    expect(() => synthetics.Code.fromAsset(assetPath).bind(stack, 'canary.handler', synthetics.RuntimeFamily.NODEJS, synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_10_0.name))
+      .toThrow(`The canary resource requires that the handler is present at "nodejs/node_modules/canary.js" but not found at ${assetPath}`);
+  });
+
   test('passes if bundling is specified', () => {
     // GIVEN
     const stack = new Stack(new App(), 'canaries');
@@ -253,6 +293,28 @@ describe(synthetics.Code.fromAsset, () => {
       .not.toThrow();
   });
 
+  test('puppeteer 11.0+ with bundling allows root-level JS files', () => {
+    // GIVEN
+    const stack = new Stack(new App(), 'canaries');
+    const assetPath = path.join(__dirname, 'canaries', 'nodejs', 'node_modules');
+    const code = synthetics.Code.fromAsset(assetPath, {
+      bundling: {
+        image: DockerImage.fromRegistry('dummy'),
+        local: {
+          tryBundle(outputDir) {
+            // Create JS file in root for puppeteer 11.0+
+            fs.copyFileSync(path.join(assetPath, 'canary.js'), path.join(outputDir, 'canary.js'));
+            return true;
+          },
+        },
+      },
+    });
+
+    // THEN - should not throw for puppeteer 11.0+ with root-level file
+    expect(() => code.bind(stack, 'canary.handler', synthetics.RuntimeFamily.NODEJS, synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_11_0.name))
+      .not.toThrow();
+  });
+
   test('fails if bundling is specified but folder structure is wrong', () => {
     // GIVEN
     const stack = new Stack(new App(), 'canaries');
@@ -275,6 +337,7 @@ describe(synthetics.Code.fromAsset, () => {
     expect(() => code.bind(stack, 'canary.handler', synthetics.RuntimeFamily.NODEJS, synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_9_1.name))
       .toThrow(`The canary resource requires that the handler is present at "nodejs/node_modules/canary.js" but not found at ${assetPath} (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Nodejs.html)`);
   });
+
 });
 
 describe(synthetics.Code.fromBucket, () => {