fix(codebuild): module fails to load with error "Cannot use import statement outside a module"

skinny85 · skinny85 · commit b1ffd335b6c4 · 2021-03-25T15:07:05.000-07:00
The bundling done in #13699 is somehow only putting the TypeScript files in the resulting NPM bundle, and thus causing the above error (from Node trying to execute TypeScript). This reverts commit 41a2b2e from PR #13699.
diff --git a/package.json b/package.json
@@ -51,9 +51,6 @@
     "nohoist": [
       "**/jszip",
       "**/jszip/**",
-      "@aws-cdk/aws-codebuild/@aws-cdk/yaml-cfn",
-      "@aws-cdk/aws-codebuild/@aws-cdk/yaml-cfn/yaml",
-      "@aws-cdk/aws-codebuild/@aws-cdk/yaml-cfn/yaml/**",
       "@aws-cdk/aws-codepipeline-actions/case",
       "@aws-cdk/aws-codepipeline-actions/case/**",
       "@aws-cdk/aws-cognito/punycode",
@@ -66,9 +63,6 @@
       "@aws-cdk/cloud-assembly-schema/jsonschema/**",
       "@aws-cdk/cloud-assembly-schema/semver",
       "@aws-cdk/cloud-assembly-schema/semver/**",
-      "@aws-cdk/cloudformation-include/@aws-cdk/yaml-cfn",
-      "@aws-cdk/cloudformation-include/@aws-cdk/yaml-cfn/yaml",
-      "@aws-cdk/cloudformation-include/@aws-cdk/yaml-cfn/yaml/**",
       "@aws-cdk/core/@balena/dockerignore",
       "@aws-cdk/core/@balena/dockerignore/**",
       "@aws-cdk/core/fs-extra",
@@ -81,9 +75,6 @@
       "@aws-cdk/cx-api/semver/**",
       "@aws-cdk/yaml-cfn/yaml",
       "@aws-cdk/yaml-cfn/yaml/**",
-      "aws-cdk-lib/@aws-cdk/yaml-cfn",
-      "aws-cdk-lib/@aws-cdk/yaml-cfn/yaml",
-      "aws-cdk-lib/@aws-cdk/yaml-cfn/yaml/**",
       "aws-cdk-lib/@balena/dockerignore",
       "aws-cdk-lib/@balena/dockerignore/**",
       "aws-cdk-lib/case",
@@ -102,9 +93,6 @@
       "aws-cdk-lib/semver/**",
       "aws-cdk-lib/yaml",
       "aws-cdk-lib/yaml/**",
-      "monocdk/@aws-cdk/yaml-cfn",
-      "monocdk/@aws-cdk/yaml-cfn/yaml",
-      "monocdk/@aws-cdk/yaml-cfn/yaml/**",
       "monocdk/@balena/dockerignore",
       "monocdk/@balena/dockerignore/**",
       "monocdk/case",
diff --git a/packages/@aws-cdk/aws-codebuild/package.json b/packages/@aws-cdk/aws-codebuild/package.json
@@ -103,9 +103,6 @@
     "@aws-cdk/yaml-cfn": "0.0.0",
     "constructs": "^3.3.69"
   },
-  "bundledDependencies": [
-    "@aws-cdk/yaml-cfn"
-  ],
   "homepage": "https://github.com/aws/aws-cdk",
   "peerDependencies": {
     "@aws-cdk/aws-cloudwatch": "0.0.0",
@@ -122,6 +119,7 @@
     "@aws-cdk/aws-secretsmanager": "0.0.0",
     "@aws-cdk/core": "0.0.0",
     "@aws-cdk/region-info": "0.0.0",
+    "@aws-cdk/yaml-cfn": "0.0.0",
     "constructs": "^3.3.69"
   },
   "engines": {
diff --git a/packages/@aws-cdk/cloudformation-include/package.json b/packages/@aws-cdk/cloudformation-include/package.json
@@ -363,6 +363,7 @@
     "@aws-cdk/aws-wafv2": "0.0.0",
     "@aws-cdk/aws-workspaces": "0.0.0",
     "@aws-cdk/core": "0.0.0",
+    "@aws-cdk/yaml-cfn": "0.0.0",
     "constructs": "^3.3.69"
   },
   "devDependencies": {
@@ -374,9 +375,6 @@
     "pkglint": "0.0.0",
     "ts-jest": "^26.5.4"
   },
-  "bundledDependencies": [
-    "@aws-cdk/yaml-cfn"
-  ],
   "keywords": [
     "aws",
     "cdk",
diff --git a/packages/@aws-cdk/yaml-cfn/.gitignore b/packages/@aws-cdk/yaml-cfn/.gitignore
@@ -3,6 +3,7 @@
 *.d.ts
 node_modules
 dist
+tsconfig.json
 .jsii
 
 .LAST_BUILD
@@ -14,4 +15,4 @@ nyc.config.js
 !.eslintrc.js
 !jest.config.js
 
-junit.xml
+junit.xml
diff --git a/packages/@aws-cdk/yaml-cfn/package.json b/packages/@aws-cdk/yaml-cfn/package.json
@@ -23,6 +23,32 @@
     "cloudformation",
     "yaml"
   ],
+  "jsii": {
+    "outdir": "dist",
+    "targets": {
+      "java": {
+        "package": "software.amazon.awscdk.yaml.cfn",
+        "maven": {
+          "groupId": "software.amazon.awscdk",
+          "artifactId": "cdk-yaml-cfn"
+        }
+      },
+      "dotnet": {
+        "namespace": "Amazon.CDK.Yaml.Cfn",
+        "packageId": "Amazon.CDK.Yaml.Cfn",
+        "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"
+      },
+      "python": {
+        "distName": "aws-cdk.yaml-cfn",
+        "module": "aws_cdk.yaml_cfn",
+        "classifiers": [
+          "Framework :: AWS CDK",
+          "Framework :: AWS CDK :: 1"
+        ]
+      }
+    },
+    "projectReferences": true
+  },
   "scripts": {
     "build": "cdk-build",
     "watch": "cdk-watch",
diff --git a/packages/@aws-cdk/yaml-cfn/tsconfig.json b/packages/@aws-cdk/yaml-cfn/tsconfig.json
diff --git a/packages/aws-cdk-lib/package.json b/packages/aws-cdk-lib/package.json
@@ -81,7 +81,6 @@
   },
   "license": "Apache-2.0",
   "bundledDependencies": [
-    "@aws-cdk/yaml-cfn",
     "@balena/dockerignore",
     "case",
     "fs-extra",
@@ -93,7 +92,6 @@
     "yaml"
   ],
   "dependencies": {
-    "@aws-cdk/yaml-cfn": "0.0.0",
     "@balena/dockerignore": "^1.0.2",
     "case": "1.6.3",
     "fs-extra": "^9.1.0",
diff --git a/packages/decdk/test/schema.test.ts b/packages/decdk/test/schema.test.ts
@@ -79,7 +79,7 @@ test('schemaForInterface: interface with primitives', async () => {
  * are propagated outwards.
  */
 function spawn(command: string, options: SpawnOptions | undefined) {
-  return new Promise<void>((resolve, reject) => {
+  return new Promise((resolve, reject) => {
     const cp = spawnAsync(command, [], { stdio: 'inherit', ...options });
 
     cp.on('error', reject);
diff --git a/packages/monocdk/package.json b/packages/monocdk/package.json
@@ -87,7 +87,6 @@
   },
   "license": "Apache-2.0",
   "bundledDependencies": [
-    "@aws-cdk/yaml-cfn",
     "@balena/dockerignore",
     "case",
     "fs-extra",
@@ -99,7 +98,6 @@
     "yaml"
   ],
   "dependencies": {
-    "@aws-cdk/yaml-cfn": "0.0.0",
     "@balena/dockerignore": "^1.0.2",
     "case": "1.6.3",
     "fs-extra": "^9.1.0",
diff --git a/tools/nodeunit-shim/index.ts b/tools/nodeunit-shim/index.ts
@@ -81,7 +81,7 @@ export function nodeunitShim(exports: Record<string, any>) {
       });
     } else {
       // It's a test
-      test(testName, () => new Promise<void>(ok => {
+      test(testName, () => new Promise(ok => {
         testObj(new Test(ok));
       }));
     }
diff --git a/tools/pkglint/bin/pkglint.ts b/tools/pkglint/bin/pkglint.ts
@@ -24,16 +24,8 @@ async function main(): Promise<void> {
 
   const pkgs = findPackageJsons(argv.directory as string);
 
-  for (const rule of rules) {
-    for (const pkg of pkgs.filter(pkg => pkg.shouldApply(rule))) {
-      rule.prepare(pkg);
-    }
-  }
-  for (const rule of rules) {
-    for (const pkg of pkgs.filter(pkg => pkg.shouldApply(rule))) {
-      await rule.validate(pkg);
-    }
-  }
+  rules.forEach(rule => pkgs.filter(pkg => pkg.shouldApply(rule)).forEach(pkg => rule.prepare(pkg)));
+  rules.forEach(rule => pkgs.filter(pkg => pkg.shouldApply(rule)).forEach(pkg => rule.validate(pkg)));
 
   if (argv.fix) {
     pkgs.forEach(pkg => pkg.applyFixes());
diff --git a/tools/pkglint/lib/packagejson.ts b/tools/pkglint/lib/packagejson.ts
@@ -361,5 +361,5 @@ export abstract class ValidationRule {
   /**
    * Will be executed for every package definition once, should mutate the package object
    */
-  public abstract validate(pkg: PackageJson): void | Promise<void>;
+  public abstract validate(pkg: PackageJson): void;
 }
diff --git a/tools/pkglint/lib/rules.ts b/tools/pkglint/lib/rules.ts
@@ -1,7 +1,6 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import * as caseUtils from 'case';
-import * as fse from 'fs-extra';
 import * as glob from 'glob';
 import * as semver from 'semver';
 import { LICENSE, NOTICE } from './licensing';
@@ -12,7 +11,6 @@ import {
   fileShouldBe, fileShouldBeginWith, fileShouldContain,
   fileShouldNotContain,
   findInnerPackages,
-  findPackageDir,
   monoRepoRoot,
 } from './util';
 
@@ -1373,42 +1371,25 @@ export class FastFailingBuildScripts extends ValidationRule {
   }
 }
 
-/**
- * For every bundled dependency, we need to make sure that package and all of its transitive dependencies are nohoisted
- *
- * Bundling literally works by including `<package>/node_modules/<dep>` into
- * the tarball when `npm pack` is run, and if that directory does not exist at
- * that exact location (because it has been hoisted) then NPM shrugs its
- * shoulders and the dependency will be missing from the distribution.
- *
- * --
- *
- * We also must not forget to nohoist transitive dependencies. Strictly
- * speaking, we need to only hoist transitive *runtime* dependencies (`dependencies`, not
- * `devDependencies`).
- *
- * For 3rd party deps, there is no difference and we short-circuit by adding a
- * catch-all glob (`<package>/node_modules/<dep>/**`), but for in-repo bundled
- * dependencies, we DO need the `devDependencies` installed as per normal and
- * only the transitive runtime dependencies nohoisted (recursively).
- */
 export class YarnNohoistBundledDependencies extends ValidationRule {
   public readonly name = 'yarn/nohoist-bundled-dependencies';
 
-  public async validate(pkg: PackageJson) {
+  public validate(pkg: PackageJson) {
     const bundled: string[] = pkg.json.bundleDependencies || pkg.json.bundledDependencies || [];
+    if (bundled.length === 0) { return; }
 
     const repoPackageJson = path.resolve(__dirname, '../../../package.json');
-    const nohoist = new Set<string>(require(repoPackageJson).workspaces.nohoist); // eslint-disable-line @typescript-eslint/no-require-imports
 
-    const expectedNoHoistEntries = new Array<string>();
+    const nohoist: string[] = require(repoPackageJson).workspaces.nohoist; // eslint-disable-line @typescript-eslint/no-require-imports
 
+    const missing = new Array<string>();
     for (const dep of bundled) {
-      await noHoistDependency(pkg.packageName, dep, pkg.packageRoot);
+      for (const entry of [`${pkg.packageName}/${dep}`, `${pkg.packageName}/${dep}/**`]) {
+        if (nohoist.indexOf(entry) >= 0) { continue; }
+        missing.push(entry);
+      }
     }
 
-    const missing = expectedNoHoistEntries.filter(entry => !nohoist.has(entry));
-
     if (missing.length > 0) {
       pkg.report({
         ruleName: this.name,
@@ -1420,23 +1401,6 @@ export class YarnNohoistBundledDependencies extends ValidationRule {
         },
       });
     }
-
-    async function noHoistDependency(parentPackageHierarchy: string, depName: string, parentPackageDir: string) {
-      expectedNoHoistEntries.push(`${parentPackageHierarchy}/${depName}`);
-
-      const dependencyDir = await findPackageDir(depName, parentPackageDir);
-      if (!isMonoRepoPackageDir(dependencyDir)) {
-        // Not one of ours, so we can just ignore everything underneath as well
-        expectedNoHoistEntries.push(`${parentPackageHierarchy}/${depName}/**`);
-        return;
-      }
-
-      // A monorepo package, recurse into dependencies (but not devDependencies)
-      const packageJson = await fse.readJson(path.join(dependencyDir, 'package.json'));
-      for (const dep of Object.keys(packageJson.dependencies ?? {})) {
-        await noHoistDependency(`${parentPackageHierarchy}/${depName}`, dep, dependencyDir);
-      }
-    }
   }
 }
 
diff --git a/tools/pkglint/lib/util.ts b/tools/pkglint/lib/util.ts
@@ -190,39 +190,3 @@ export function* findInnerPackages(dir: string): IterableIterator<string> {
     yield* findInnerPackages(path.join(dir, fname));
   }
 }
-
-/**
- * Find package directory
- *
- * Do this by walking upwards in the directory tree until we find
- * `<dir>/node_modules/<package>/package.json`.
- *
- * -------
- *
- * Things that we tried but don't work:
- *
- * 1.    require.resolve(`${depName}/package.json`, { paths: [rootDir] });
- *
- * Breaks with ES Modules if `package.json` has not been exported, which is
- * being enforced starting Node12.
- *
- * 2.    findPackageJsonUpwardFrom(require.resolve(depName, { paths: [rootDir] }))
- *
- * Breaks if a built-in NodeJS package name conflicts with an NPM package name
- * (in Node15 `string_decoder` is introduced...)
- */
-export async function findPackageDir(depName: string, rootDir: string) {
-  let prevDir;
-  let dir = rootDir;
-  while (dir !== prevDir) {
-    const candidateDir = path.join(dir, 'node_modules', depName);
-    if (await new Promise(ok => fs.exists(path.join(candidateDir, 'package.json'), ok))) {
-      return new Promise<string>((ok, ko) => fs.realpath(candidateDir, (err, result) => err ? ko(err) : ok(result)));
-    }
-
-    prevDir = dir;
-    dir = path.dirname(dir); // dirname('/') -> '/', dirname('c:\\') -> 'c:\\'
-  }
-
-  throw new Error(`Did not find '${depName}' upwards of '${rootDir}'`);
-}

Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ export function nodeunitShim(exports: Record<string, any>) {`
`81`	`81`	`});`
`82`	`82`	`} else {`
`83`	`83`	`// It's a test`
`84`		`- test(testName, () => new Promise<void>(ok => {`
	`84`	`+ test(testName, () => new Promise(ok => {`
`85`	`85`	`testObj(new Test(ok));`
`86`	`86`	`}));`
`87`	`87`	`}`