refactor: switch to NPM workspaces

The `lerna bootstrap` command is deprecated[1] and resulted in a very weird CI failure (dequelabs#685). This commit switches the repository to instead use NPM workspaces.[2] [1]: lerna/lerna#3410 [2]: https://docs.npmjs.com/cli/v7/using-npm/workspaces
not-my-profile · Mar 17, 2023 · 29064dc · 29064dc
1 parent 7e43ea0
commit 29064dc
Show file tree

Hide file tree

Showing 25 changed files with 35,105 additions and 94,017 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -30,33 +30,6 @@ jobs:
       - restore_cache:
           keys:
             - v2-root-npm-{{ checksum "package-lock.json" }}
-      - restore_cache:
-          keys:
-            - v2-cli-npm-{{ checksum "packages/cli/package-lock.json" }}
-      - restore_cache:
-          keys:
-            - v2-playwright-npm-{{ checksum "packages/playwright/package-lock.json" }}
-      - restore_cache:
-          keys:
-            - v2-puppeteer-npm-{{ checksum "packages/puppeteer/package-lock.json" }}
-      - restore_cache:
-          keys:
-            - v2-webdriverjs-npm-{{ checksum "packages/webdriverjs/package-lock.json" }}
-      - restore_cache:
-          keys:
-            - v2-webdriverjs-npm-example-{{ checksum "packages/webdriverjs/tests/example/package-lock.json" }}
-      - restore_cache:
-          keys:
-            - v2-webdriverio-npm-{{ checksum "packages/webdriverio/package-lock.json" }}
-      - restore_cache:
-          keys:
-            - v2-reporter-earl-npm-{{ checksum "packages/reporter-earl/package-lock.json" }}
-      - restore_cache:
-          keys:
-            - v2-react-npm-{{ checksum "packages/react/package-lock.json" }}
-      - restore_cache:
-          keys:
-            - v2-axe-core-test-npm-{{ checksum "axe_core_test/package-lock.json" }}
       # Install and cache each package's dependencies.
       - run:
           name: Install top-level dependencies
@@ -65,42 +38,14 @@ jobs:
           key: v2-root-npm-{{ checksum "package-lock.json" }}
           paths:
             - node_modules
-      - run: npm run bootstrap -- --ci
-      - save_cache:
-          key: v2-cli-npm-{{ checksum "packages/cli/package-lock.json" }}
-          paths:
             - packages/cli/node_modules
-      - save_cache:
-          key: v2-playwright-npm-{{ checksum "packages/playwright/package-lock.json" }}
-          paths:
             - packages/playwright/node_modules
-      - save_cache:
-          key: v2-puppeteer-npm-{{ checksum "packages/puppeteer/package-lock.json" }}
-          paths:
             - packages/puppeteer/node_modules
-      - save_cache:
-          key: v2-webdriverjs-npm-{{ checksum "packages/webdriverjs/package-lock.json" }}
-          paths:
             - packages/webdriverjs/node_modules
-      - save_cache:
-          key: v2-webdriverjs-npm-example-{{ checksum "packages/webdriverjs/tests/example/package-lock.json" }}
-          paths:
             - packages/webdriverjs/tests/example/node_modules
-      - save_cache:
-          key: v2-webdriverio-npm-{{ checksum "packages/webdriverio/package-lock.json" }}
-          paths:
             - packages/webdriverio/node_modules
-      - save_cache:
-          key: v2-reporter-earl-npm-{{ checksum "packages/reporter-earl/package-lock.json" }}
-          paths:
             - packages/reporter-earl/node_modules
-      - save_cache:
-          key: v2-react-npm-{{ checksum "packages/react/package-lock.json" }}
-          paths:
             - packages/react/node_modules
-      - save_cache:
-          key: v2-axe-core-test-npm-{{ checksum "axe_core_test/package-lock.json" }}
-          paths:
             - axe_core_test/node_modules
       - save_cache:
           key: v3-npm-cache-{{ .Environment.CIRCLE_SHA1 }}
@@ -130,13 +75,9 @@ jobs:
     steps:
       - checkout
       - restore_dependency_cache
-      # Re-build packages, ensuring packages/webdriverjs/dist exists.
-      - run: npx lerna run prepare
       # required for browser-driver-manager
       - run: sudo apt-get update -y
       - run: cd packages/cli && npx browser-driver-manager@1.0.4 install chrome chromedriver --verbose
-      # lerna link after installing the latest version of chromedriver, as we depend on webdriverJS
-      - run: cd packages/cli && npx lerna link
       - run: npm run coverage --prefix=packages/cli
 
   puppeteer:
@@ -188,7 +129,10 @@ jobs:
       - browser-tools/install-chrome
       - browser-tools/install-chromedriver
       - run:
-          command: npm run coverage --prefix=packages/webdriverio
+          command: |
+            # Node 14 comes with npm 6.14, which doesn't yet support NPM workspaces, so we modify the PATH.
+            PATH=$PATH:../../node_modules/.bin
+            npm run coverage --prefix=packages/webdriverio
           environment:
             CHROMEDRIVER_PATH: /usr/local/bin/chromedriver
 
@@ -218,8 +162,7 @@ jobs:
       - run: npm install -g node@14 --force
       - checkout
       - restore_dependency_cache
-      - run: npm install
-      - run: npm run bootstrap -- --ci
+      - run: npm ci
       - run: npm run build --prefix=packages/playwright
       - run: npm run coverage --prefix=packages/playwright