[build] Re-enable package lock (nasa#7584)

* include package lock
* migrate to npm ci
* remove cache busting doc and replace with npm run clean

---------

Co-authored-by: Jesse Mazzella <[email protected]>
Co-authored-by: Andrew Henry <[email protected]>

Author: 3 people

.circleci/config.yml

@@ -1,4 +1,7 @@
 version: 2.1
+orbs:
+  node: circleci/[email protected]
+  browser-tools: circleci/[email protected]
 executors:
   pw-focal-development:
     docker:
@@ -11,47 +14,17 @@ executors:
     machine:
       image: ubuntu-2204:current
       docker_layer_caching: true
-parameters:
-  BUST_CACHE:
-    description: "Set this with the CircleCI UI Trigger Workflow button (boolean = true) to bust the cache!"
-    default: false
-    type: boolean
 commands:
   build_and_install:
-    description: "All steps used to build and install. Will use cache if found"
+    description: "All steps used to build and install."
     parameters:
       node-version:
         type: string
     steps:
       - checkout
-      - restore_cache_cmd:
-          node-version: << parameters.node-version >>
       - node/install:
           node-version: << parameters.node-version >>
-      - run: npm install --no-audit --progress=false
-  restore_cache_cmd:
-    description: "Custom command for restoring cache with the ability to bust cache. When BUST_CACHE is set to true, jobs will not restore cache"
-    parameters:
-      node-version:
-        type: string
-    steps:
-      - when:
-          condition:
-            equal: [false, << pipeline.parameters.BUST_CACHE >>]
-          steps:
-            - restore_cache:
-                key: deps--{{ arch }}--{{ .Branch }}--<< parameters.node-version >>--{{ checksum "package.json" }}-{{ checksum ".circleci/config.yml" }}
-  save_cache_cmd:
-    description: "Custom command for saving cache."
-    parameters:
-      node-version:
-        type: string
-    steps:
-      - save_cache:
-          key: deps--{{ arch }}--{{ .Branch }}--<< parameters.node-version >>--{{ checksum "package.json" }}-{{ checksum ".circleci/config.yml" }}
-          paths:
-            - ~/.npm
-            - node_modules
+      - node/install-packages
   generate_and_store_version_and_filesystem_artifacts:
     description: "Track important packages and files"
     steps:
@@ -71,9 +44,6 @@ commands:
     steps:
       - run: npm run cov:e2e:report || true
       - run: npm run cov:e2e:<<parameters.suite>>:publish
-orbs:
-  node: circleci/[email protected]
-  browser-tools: circleci/[email protected]
 jobs:
   npm-audit:
     parameters:
@@ -111,8 +81,6 @@ jobs:
             TESTFILES=$(circleci tests glob "src/**/*Spec.js")
             echo "$TESTFILES" | circleci tests run --command="xargs npm run test" --verbose
       - run: npm run cov:unit:publish
-      - save_cache_cmd:
-          node-version: <<parameters.node-version>>
       - store_test_results:
           path: dist/reports/tests/
       - store_artifacts:

.github/PULL_REQUEST_TEMPLATE.md

@@ -17,7 +17,6 @@ Closes <!--- Insert Issue Number(s) this PR addresses. Start by typing # will op
 * [ ] Has this been smoke tested?
 * [ ] Have you associated this PR with a `type:` label? Note: this is not necessarily the same as the original issue.
 * [ ] Have you associated a milestone with this PR? Note: leave blank if unsure.
-* [ ] Is this a breaking change to be called out in the release notes?
 * [ ] Testing instructions included in associated issue OR is this a dependency/testcase change?
 
 ### Reviewer Checklist

.github/workflows/e2e-couchdb.yml

@@ -28,7 +28,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node-
 
-      - run: npm install --cache ~/.npm --no-audit --progress=false
+      - run: npm ci --no-audit --progress=false
 
       - name: Login to DockerHub
         uses: docker/login-action@v3

.github/workflows/e2e-flakefinder.yml

@@ -31,7 +31,7 @@ jobs:
             ${{ runner.os }}-node-
 
       - run: npx [email protected] install
-      - run: npm install --cache ~/.npm --no-audit --progress=false
+      - run: npm ci --no-audit --progress=false
 
       - name: Run E2E Tests (Repeated 10 Times)
         run: npm run test:e2e:stable -- --retries=0 --repeat-each=10 --max-failures=50

.github/workflows/e2e-perf.yml

@@ -29,7 +29,7 @@ jobs:
             ${{ runner.os }}-node-
 
       - run: npx [email protected] install
-      - run: npm install --cache ~/.npm --no-audit --progress=false
+      - run: npm ci --no-audit --progress=false
       - run: npm run test:perf:localhost
       - run: npm run test:perf:contract
       - run: npm run test:perf:memory

.github/workflows/e2e-pr.yml

@@ -35,7 +35,7 @@ jobs:
 
       - run: npx [email protected] install
       - run: npx playwright install chrome-beta
-      - run: npm install --cache ~/.npm --no-audit --progress=false
+      - run: npm ci --no-audit --progress=false
       - run: npm run test:e2e:full -- --max-failures=40
       - run: npm run cov:e2e:report || true
       - shell: bash

.github/workflows/npm-prerelease.yml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: lts/hydrogen
-      - run: npm install
+      - run: npm ci
       - run: |
           echo "//registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN" >> ~/.npmrc
           npm whoami
@@ -31,7 +31,7 @@ jobs:
         with:
           node-version: lts/hydrogen
           registry-url: https://registry.npmjs.org/
-      - run: npm install
+      - run: npm ci
       - run: npm publish --access=public --tag unstable
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/pr-platform.yml

@@ -45,7 +45,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-${{ matrix.node_version }}-
 
-      - run: npm install --cache ~/.npm --no-audit --progress=false
+      - run: npm ci --no-audit --progress=false
 
       - run: npm test
 

.gitignore

@@ -47,6 +47,3 @@ index.html.bak
 .nyc_output
 coverage
 codecov
-
-# :(
-package-lock.json

.npmrc

@@ -2,6 +2,3 @@ loglevel=warn
 
 #Prevent folks from ignoring an important error when building from source
 engine-strict=true
-
-# Dont include lockfile
-package-lock=false

TESTING.md

@@ -91,12 +91,14 @@ There are a few reasons that your GitHub PR could be failing beyond simple faile
 ### Local=Pass and CI=Fail
 Although rare, it is possible that your test can pass locally but fail in CI.
 
-#### Busting Cache
-In certain circumstances, the CircleCI cache can become stale. In order to bust the cache, we've implemented a runtime boolean parameter in Circle CI creatively name BUST_CACHE. To execute:
-1. Navigate to the branch in Circle CI believed to have stale cache.
-1. Click on the 'Trigger Pipeline' button.
-1. Add Parameter -> Parameter Type = boolean , Name = BUST_CACHE ,Value = true
-1. Click 'Trigger Pipeline'
+### Reset your workspace
+It's possible that you're running with dependencies or a local environment which is out of sync with the branch you're working on. Make sure to execute the following:
+
+```sh
+nvm use
+npm run clean
+npm install
+```
 
 #### Run tests in the same container as CI