Fix nested packages in node_modules not using workspaces

Author: xg-wang

.github/workflows/ci.yml

@@ -109,16 +109,10 @@ jobs:
         uses: volta-cli/action@v1
         with:
           node-version: ${{ matrix.node-version }}
-
-      # Remove test-packages folder so that we don't leak node_modules between apps
-      - name: Remove test-packages
-        run: |
-          rm -rf test-packages
       - name: Yarn Install
-        working-directory: ./packages/ember-cli-fastboot
         run: |
           yarn install --ignore-engines --frozen-lockfile
       - name: Run Mocha Tests
         run: |
-          npm --version
+          node scripts/fix-node-modules.mjs
           yarn workspace ember-cli-fastboot test:mocha

jsconfig.json

@@ -1 +1,16 @@
-{"compilerOptions":{"target":"es6","experimentalDecorators":true},"exclude":["node_modules","bower_components","tmp","vendor",".git","dist"]}
+{
+  "compilerOptions": {
+    "target": "es6",
+    "experimentalDecorators": true
+  },
+  "exclude": [
+    "node_modules",
+    "packages/**/node_modules",
+    "test-packages/**/node_modules",
+    "bower_components",
+    "tmp",
+    "vendor",
+    ".git",
+    "dist"
+  ]
+}

package.json

@@ -10,6 +10,7 @@
     "test-packages/*"
   ],
   "scripts": {
+    "pretest": "node scripts/fix-node-modules.mjs",
     "test": "npm-run-all test:*",
     "test:ember-cli-fastboot": "yarn workspace ember-cli-fastboot test:ember",
     "test:fastboot": "yarn workspace fastboot test",
@@ -19,6 +20,9 @@
     "test:extra": "yarn workspace basic-app test:mocha && yarn workspace custom-fastboot-app test:mocha"
   },
   "devDependencies": {
+    "chalk": "^4.1.2",
+    "execa": "^5.1.1",
+    "fs-extra": "^10.0.0",
     "npm-run-all": "^4.1.5",
     "release-it": "^14.2.2",
     "release-it-lerna-changelog": "^3.1.0",

scripts/fix-node-modules.mjs

@@ -0,0 +1,39 @@
+/**
+ * Fix nested packages not using workspace version
+ *
+ * For example, these will download from npm registry rather than using local workspaces,
+ * the changes won't be reflected during tests if not symlink to worksapces.
+ * node_modules/ember-cli-fastboot-testing/node_modules/fastboot
+ * packages/ember-cli-fastboot/node_modules/fastboot-express-middleware
+ * packages/ember-cli-fastboot/node_modules/fastboot
+ */
+
+import path from 'path';
+import fs from 'fs-extra';
+import { fileURLToPath } from 'url';
+import execa from 'execa';
+import chalk from 'chalk';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+const projectRoot = path.resolve(__dirname, '..');
+const packagesDir = path.resolve(projectRoot, 'packages');
+const packages = fs.readdirSync(packagesDir);
+const extraDirs = [
+  path.resolve(projectRoot, 'node_modules/ember-cli-fastboot-testing'),
+  path.resolve(projectRoot, 'node_modules/ember-fetch'),
+];
+
+[...packages, ...extraDirs].forEach(packageName => {
+  const packageNodeModules = path.resolve(packagesDir, packageName, 'node_modules');
+  console.log(chalk.grey(`Inspecting ${packageNodeModules} ...`));
+  packages.forEach(packageNameToLink => {
+    const nodeModulesPackageDir = path.join(packageNodeModules, packageNameToLink);
+    const workspacesPackageDir = path.resolve(packagesDir, packageNameToLink);
+    if (fs.existsSync(nodeModulesPackageDir)) {
+      console.log(chalk.green(`symlink ${nodeModulesPackageDir} -> ${workspacesPackageDir}`));
+      fs.removeSync(nodeModulesPackageDir);
+      fs.symlinkSync(workspacesPackageDir, nodeModulesPackageDir, 'dir');
+    }
+  });
+});
+

yarn.lock

@@ -6372,6 +6372,14 @@ chalk@^4.1.1:
     ansi-styles "^4.1.0"
     supports-color "^7.1.0"
 
+chalk@^4.1.2:
+  version "4.1.2"
+  resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01"
+  integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==
+  dependencies:
+    ansi-styles "^4.1.0"
+    supports-color "^7.1.0"
+
 changelog-filename-regex@^1.1.0:
   version "1.1.2"
   resolved "https://registry.yarnpkg.com/changelog-filename-regex/-/changelog-filename-regex-1.1.2.tgz#19e98e38248cff0c1cf3ae3bf51bfb22c48592d6"
@@ -9642,7 +9650,7 @@ execa@^4.0.2, execa@^4.0.3:
     signal-exit "^3.0.2"
     strip-final-newline "^2.0.0"
 
-execa@^5.0.0:
+execa@^5.0.0, execa@^5.1.1:
   version "5.1.1"
   resolved "https://registry.yarnpkg.com/execa/-/execa-5.1.1.tgz#f80ad9cbf4298f7bd1d4c9555c21e93741c411dd"
   integrity sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==
@@ -10335,6 +10343,15 @@ fs-extra@^0.30.0:
     path-is-absolute "^1.0.0"
     rimraf "^2.2.8"
 
+fs-extra@^10.0.0:
+  version "10.0.0"
+  resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-10.0.0.tgz#9ff61b655dde53fb34a82df84bb214ce802e17c1"
+  integrity sha512-C5owb14u9eJwizKGdchcDUQeFtlSHHthBk8pbX9Vc1PFZrLombudjDnNns88aYslCyF6IY5SUw3Roz6xShcEIQ==
+  dependencies:
+    graceful-fs "^4.2.0"
+    jsonfile "^6.0.1"
+    universalify "^2.0.0"
+
 fs-extra@^4.0.2, fs-extra@^4.0.3:
   version "4.0.3"
   resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-4.0.3.tgz#0d852122e5bc5beb453fb028e9c0c9bf36340c94"