NOT READY - Switching to GitHub Actions npm Cache and Automating package-lock.json

.github/workflows/prep-release.yml

@@ -23,15 +23,27 @@ jobs:
           architecture: "x64" # optional x64 or x86. Defaults to x64 if not specified
       - name: Setup dependencies using pip
         run: pip install -r requirements.txt
-      - name: 📋 Get Commits since last Release
-        id: changes
-        uses: simbo/[email protected]
+      - name: Remove old package-lock.json
+        uses: JesseTG/[email protected]
         with:
-          line-prefix: "* "
-          include-hashes: false
-      - name: Generate new release version
-        id: newversion
-        run: python default.py --prepare-release "${{ steps.changes.outputs.last-tag }}"
+          path: package-lock.json
+      - name: Setup Node.js (v4 version 20.x)
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+      - name: Create new package-lock.json
+        run: npm install --omit=dev --omit=optional
+      - name: Remove fsevents package
+        run: python default.py --update-package-lock
+      # - name: 📋 Get Commits since last Release
+      #   id: changes
+      #   uses: simbo/[email protected]
+      #   with:
+      #     line-prefix: "* "
+      #     include-hashes: false
+      # - name: Generate new release version
+      #   id: newversion
+      #   run: python default.py --prepare-release "${{ steps.changes.outputs.last-tag }}"
       - name: Create pull request
         uses: peter-evans/create-pull-request@v7
         with:
@@ -48,3 +60,4 @@ jobs:
           labels: ignore-for-release
           add-paths: |
             package.json
+            package-lock.json

.github/workflows/regression-test-404.yml

@@ -61,7 +61,7 @@ jobs:
         sudo apt-get --only-upgrade install google-chrome-stable
         google-chrome --version
     - name: Setup npm packages
-      run: npm install
+      run: npm ci --only=production
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX
       run: |

.github/workflows/regression-test-css.yml

@@ -56,6 +56,8 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
+        cache: 'npm'
+        cache-dependency-path: 'package-lock.json'
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       shell: bash
       name: Setup Google Chrome browser (ONLY used for Sitespeed)
@@ -66,7 +68,7 @@ jobs:
         sudo apt-get --only-upgrade install google-chrome-stable
         google-chrome --version
     - name: Setup npm packages
-      run: npm install --omit=dev
+      run: npm ci --only=production
       timeout-minutes: 30
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX

.github/workflows/regression-test-google-lighthouse-based.yml

@@ -48,8 +48,10 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
+        cache: 'npm'
+        cache-dependency-path: 'package-lock.json'
     - name: Setup npm packages
-      run: npm install --omit=dev
+      run: npm ci --only=production
       timeout-minutes: 30
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX

.github/workflows/regression-test-html.yml

@@ -56,6 +56,8 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
+        cache: 'npm'
+        cache-dependency-path: 'package-lock.json'
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       shell: bash
       name: Setup Google Chrome browser (ONLY used for Sitespeed)
@@ -66,7 +68,7 @@ jobs:
         sudo apt-get --only-upgrade install google-chrome-stable
         google-chrome --version
     - name: Setup npm packages
-      run: npm install --omit=dev
+      run: npm ci --only=production
       timeout-minutes: 30
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX

.github/workflows/regression-test-http.yml

@@ -54,6 +54,8 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
+        cache: 'npm'
+        cache-dependency-path: 'package-lock.json'
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       shell: bash
       name: Setup Google Chrome browser (ONLY used for Sitespeed)
@@ -64,7 +66,7 @@ jobs:
         sudo apt-get --only-upgrade install google-chrome-stable
         google-chrome --version
     - name: Setup npm packages
-      run: npm install --omit=dev
+      run: npm ci --only=production
       timeout-minutes: 30
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX

.github/workflows/regression-test-lint-css.yml

@@ -56,6 +56,8 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
+        cache: 'npm'
+        cache-dependency-path: 'package-lock.json'
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       shell: bash
       name: Setup Google Chrome browser (ONLY used for Sitespeed)
@@ -66,7 +68,7 @@ jobs:
         sudo apt-get --only-upgrade install google-chrome-stable
         google-chrome --version
     - name: Setup npm packages
-      run: npm install --omit=dev
+      run: npm ci --only=production
       timeout-minutes: 30
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX (no-errors)

.github/workflows/regression-test-pa11y.yml

@@ -49,8 +49,10 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
+        cache: 'npm'
+        cache-dependency-path: 'package-lock.json'
     - name: Setup npm packages
-      run: npm install --omit=dev
+      run: npm ci --only=production
       timeout-minutes: 30
     # Havn't yet been able to start Google Chrome in headless mode in pa11y since move to Chrome in Pa11y 5
     - if: ${{ matrix.os == 'windows-latest' }}

.github/workflows/regression-test-sitespeed.yml

@@ -50,6 +50,8 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
+        cache: 'npm'
+        cache-dependency-path: 'package-lock.json'
     - if: ${{ matrix.os == 'ubuntu-latest'  }}
       name: Setup SpeedIndex dependencies (ONLY used for Sitespeed) - Linux
       run: |
@@ -80,7 +82,7 @@ jobs:
         sudo apt-get --only-upgrade install google-chrome-stable
         google-chrome --version
     - name: Setup npm packages
-      run: npm install --omit=dev
+      run: npm ci --only=production
       timeout-minutes: 30
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX

.github/workflows/regression-test-software.yml

@@ -51,6 +51,8 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
+        cache: 'npm'
+        cache-dependency-path: 'package-lock.json'
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       shell: bash
       name: Setup Google Chrome browser (ONLY used for Sitespeed)
@@ -61,7 +63,7 @@ jobs:
         sudo apt-get --only-upgrade install google-chrome-stable
         google-chrome --version
     - name: Setup npm packages
-      run: npm install --omit=dev
+      run: npm ci --only=production
       timeout-minutes: 30
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX

.github/workflows/regression-test-tracking.yml

@@ -110,6 +110,8 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
+        cache: 'npm'
+        cache-dependency-path: 'package-lock.json'
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       shell: bash
       name: Setup Google Chrome browser (ONLY used for Sitespeed)
@@ -120,7 +122,7 @@ jobs:
         sudo apt-get --only-upgrade install google-chrome-stable
         google-chrome --version
     - name: Setup npm packages
-      run: npm install --omit=dev
+      run: npm ci --only=production
       timeout-minutes: 30
     - if: ${{ matrix.os == 'ubuntu-latest' }}
       name: RUNNING TEST - LINUX

.github/workflows/regression-test-ylt.yml

@@ -49,11 +49,13 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
+        cache: 'npm'
+        cache-dependency-path: 'package-lock.json'
     - name: Setup node dependencies (ONLY used for Yellow Lab Tools)
       run: npm install -g node-gyp
       timeout-minutes: 30
     - name: Setup npm packages
-      run: npm install --omit=dev
+      run: npm ci --only=production
       timeout-minutes: 30
     - if: ${{ matrix.os == 'windows-latest' }}
       name: RUNNING TEST - WINDOWS

.github/workflows/update-software.yml

@@ -26,6 +26,8 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
+        cache: 'npm'
+        cache-dependency-path: 'package-lock.json'
     - name: Setup SpeedIndex dependencies (ONLY used for Sitespeed) - Linux
       run: |
         sudo apt-get update -y
@@ -42,7 +44,7 @@ jobs:
         sudo apt-get --only-upgrade install google-chrome-stable
         google-chrome --version
     - name: Setup npm packages
-      run: npm install --omit=dev
+      run: npm ci --only=production
       timeout-minutes: 30
     - name: Update USER_AGENT
       run: python default.py --update-browser

.gitignore

@@ -118,7 +118,7 @@ geckodriver.exe
 node_modules
 data
 sitespeed-result
-package-lock.json
+# package-lock.json
 # package.json
 sitespeed-rules.json
 vnu.jar

Dockerfile

@@ -57,7 +57,7 @@ RUN python3 -m pip install -r requirements.txt --break-system-packages && \
 # Run everything after as non-privileged user.
 USER sitespeedio
 
-RUN npm install --omit=dev
+RUN npm ci --only=production
 
 RUN python3 default.py --setting tests.sitespeed.xvfb=true --save-setting settings.json
 

default.py

@@ -21,7 +21,7 @@
 from helpers.credits_helper import get_credits, update_credits_markdown
 from helpers.dependency_helper import dependency
 from helpers.mdn_helper import update_mdn_rules
-from helpers.release_helper import set_new_release_version_in_env, update_release_version
+from helpers.release_helper import set_new_release_version_in_env, update_package_lock_json, update_release_version
 from helpers.setting_helper import config_mapping, get_config, set_config,\
     set_config_from_cmd, set_runtime_config_only
 from helpers.test_helper import TEST_ALL,\
@@ -146,6 +146,12 @@ def update_mdn(self, _):
         update_mdn_rules()
         sys.exit(0)
 
+    def update_package_lock(self, _):
+        if update_package_lock_json():
+            sys.exit(0)
+        else:
+            sys.exit(2)
+
     def update_software_definitions(self, arg):
         set_runtime_config_only("github.api.key", arg)
         update_licenses()
@@ -484,6 +490,7 @@ def handle_option(self, opt, arg):
             ("-b", "--update-browser"): self.update_browser,
             ("--usr", "--update-stylelint-rules"): self.update_stylelint,
             ("-d", "--update-definitions"): self.update_software_definitions,
+            ("--upl", "--update-package-lock"): self.update_package_lock,
             ("--ums", "--update-mdn-sources"): self.update_mdn,
             ("--ucr", "--update-carbon"): self.update_carbon_rating,
             ("--ut", "--update-translations"): self.update_translations,
@@ -538,6 +545,7 @@ def main(argv):
                                    "uc" ,"update-credits",
                                    "ums", "update-mdn-sources",
                                    "update-browser", "update-definitions=",
+                                   "update-package-lock",
                                    "usr", "update-stylelint-rules",
                                    "update-translations",
                                    "pr=", "prepare-release=",

docs/getting-started-local.md

@@ -13,7 +13,7 @@ it is also best/fastest when wanting to contribute with new tests, translations
 - Download and install Node.js (version 20.x)
 - Download and install Google Chrome browser
 * Download and install Mozilla Firefox
-- Install required npm packages by typing following and hit Enter: `npm install --omit=dev`
+- Install required npm packages by typing following and hit Enter: `npm install --omit=dev --omit=optional`
 - Validate that core functionality is working by typing following and hit Enter `python default.py -h`
 - If the output looks something like example in [options and arguments](getting-started.md#options-and-arguments) you have successfully setup the general parts of webperf-core.
 - Please look at/return to the [specific test](tests/README.md) you want to run to make sure it doesn't require more steps.

docs/tests/css.md

@@ -53,7 +53,7 @@ Read more on the [general page for github actions](../getting-started-github-act
 
 * Download and install Node.js (version 20.x)
 * Download and install Google Chrome browser
-* Install NPM packages ( `npm install --omit=dev` )
+* Install NPM packages ( `npm install --omit=dev --omit=optional` )
 * Set [tests.sitespeed.docker.use](../settings-json.md) to `false` in your `settings.json`
 
 ##### Windows Specific

docs/tests/google-lighthouse-based.md

@@ -35,7 +35,7 @@ Follow the instructions below depending on what you choose.
 Benefit of this option is that you can use it to test pre production urls like your AcceptanceTest environment.
 
 * Download and install Node.js (version 20.x)
-* Install NPM packages ( `npm install --omit=dev` )
+* Install NPM packages ( `npm install --omit=dev --omit=optional` )
 
 ## Read more
 

docs/tests/html.md

@@ -43,7 +43,7 @@ Read more on the [general page for github actions](../getting-started-github-act
 
 * Download and install Node.js (version 20.x)
 * Download and install Google Chrome browser
-* Install NPM packages ( `npm install --omit=dev` )
+* Install NPM packages ( `npm install --omit=dev --omit=optional` )
 * Set `sitespeed_use_docker = False` in your `config.py`
 
 ##### Windows Specific

docs/tests/http.md

@@ -71,7 +71,7 @@ Read more on the [general page for github actions](../getting-started-github-act
 * Download and install Node.js (version 20.x)
 * Download and install Google Chrome browser
 * Download and install Mozilla Firefox browser
-* Install NPM packages ( `npm install --omit=dev` )
+* Install NPM packages ( `npm install --omit=dev --omit=optional` )
 * Set `sitespeed_use_docker = False` in your `config.py`
 
 ##### Windows Specific

docs/tests/pa11y.md

@@ -44,7 +44,7 @@ Read more on the [general page for github actions](../getting-started-github-act
 * Follow [general local setup steps for this repository](../getting-started-local.md)
 * Download and install Node.js (version 20.x)
 * Download and install Google Chrome browser
-* Install NPM packages ( `npm install --omit=dev` )
+* Install NPM packages ( `npm install --omit=dev --omit=optional` )
 
 ## FAQ
 

docs/tests/sitespeed.md

@@ -73,7 +73,7 @@ Read more on the [general page for github actions](../getting-started-github-act
 * Install ffmpeg `sudo apt install ffmpeg`
 * Download and install Node.js (version 20.x)
 * Download and install Google Chrome browser
-* Install NPM packages ( `npm install --omit=dev` )
+* Install NPM packages ( `npm install --omit=dev --omit=optional` )
 * Set `sitespeed_use_docker = False` in your `config.py`
 
 (You can always see [GitHub Actions SiteSpeed](../../.github/workflows/regression-test-sitespeed.yml) for all steps required line by line)
@@ -86,7 +86,7 @@ Read more on the [general page for github actions](../getting-started-github-act
 * Download and Install ffmpeg `https://ffmpeg.org/download.html#build-windows`
 * Download and install Node.js (version 20.x)
 * Download and install Google Chrome browser
-* Install NPM packages ( `npm install --omit=dev` )
+* Install NPM packages ( `npm install --omit=dev --omit=optional` )
 * Set `sitespeed_use_docker = False` in your `config.py`
 
 #### Using Docker image

docs/tests/software.md

@@ -140,7 +140,7 @@ TODO: Add links to blogs and articles showing how to remove info regarding what
 
 * Download and install Node.js (version 20.x)
 * Download and install Google Chrome browser
-* Install NPM packages ( `npm install --omit=dev` )
+* Install NPM packages ( `npm install --omit=dev --omit=optional` )
 * Set `sitespeed_use_docker = False` in your `config.py`
 
 ##### Windows Specific

docs/tests/tracking.md

@@ -143,7 +143,7 @@ This section has not been written yet.
 * Download and install Node.js (version 20.x)
 * Download and install Google Chrome browser
 * Download and install Mozilla Firefox
-* Install NPM packages ( `npm install --omit=dev` )
+* Install NPM packages ( `npm install --omit=dev --omit=optional` )
 * Set `sitespeed_use_docker = False` in your `config.py`
 
 ##### Windows Specific

docs/tests/yellowlab.md

@@ -32,11 +32,11 @@ Read more on the [general page for github actions](../getting-started-github-act
 * Download and install Node.js (version 20.x)
 * Download and install node-gyp `npm install -g node-gyp`
 * Setup libjpeg and fontconfig `sudo apt-get install libjpeg-dev libfontconfig`
-* Install NPM packages ( `npm install --omit=dev` )
+* Install NPM packages ( `npm install --omit=dev --omit=optional` )
 
 ##### On Windows:
 * Download and install Node.js (version 20.x)
-* Install NPM packages ( `npm install --omit=dev` )
+* Install NPM packages ( `npm install --omit=dev --omit=optional` )
 
 ## FAQ