Dependency Updates and Node 20 Support (Node 14 deprecation)

[dgrebb]

@garris happy Monday!

Here is the (drafted) PR for Node 20 support, and Node 14 deprecation. Test results and CI/CD can be seen here.

Please let me know if you'd like to discuss this week, would like any changes, and have any feedback in general :)

Passing Tests

I set up a collection of GitHub Actions workflows, to make testing awareness and communication more streamlined for the project. More on that in a soon-to be separate PR :)

The above results are from a testing-only branch, which is rebased from my develop to include the GitHub testing workflows. This branch doesn't have actions merged in, so it can't be tested without polluting the PR.

Happy to explain more, but perhaps an image will suffice!

Backstop Tests

• 
• 
• 
• 

Docker Tests

• 
• 
• 
• 

The Node 20 Docker image is available here, and can be tested locally via:

cd test/configs/ && docker pull ghcr.io/dgrebb/backstopjs:chore-downstream-pr_feature-34-node-20 && docker run --platform linux/arm64 --rm -it --mount type=bind,source="$(pwd)",target=/src ghcr.io/dgrebb/backstopjs:chore-downstream-pr_feature-34-node-20 test --config=backstop_features_pw

This assumes --platform linux/arm64. Please update to test on non-arm architecture!

Also, one may need to change the --mount source value back to cwd — I wasn't sure why that is used in the README example for running against a custom image.

Note

The above docker image and test results are in a develop rebased branch for testing only.

The Dockerfile in this branch is set to use dgrebb/BackstopJS#feature/34-node-20 as the installation source for backstopjs. This was needed to demonstrate passing tests with the latest changes, inside GitHub Actions (coming soon in another PR).

This closes #34.

---

Details

Change Summary

This comes with many dependency updates, formatting adjustments, a README refactor, Dockerfile updates, and general bugfixes, removals, and enhancements. Here's the tl;dr:

• updates dependencies to latest possible versions
• adjusts formatting based on eslint rules
• adds eslint-disable where needed
• drops support for Node 14 and specifies engines in package.json
• updates Dockerfile
  • node:20-bullseye
  • includes npx playwright install --with-deps in Dockerfile
• fixes npm script: integration-test
• adds friendly pass/fail/caution message to the end of smoke, integration, and sanity tests
• adds load-docker npm script for local testing of built docker images
• major updates to formatting and README TOC
  • adds note about load-docker
• removes obsolete genConfig npm script
  • legacy from casper/slimer days (became makeConfig, aka backstop init)

I can squash the 14 commits down into one with a longer description attached to the squash-commit. Let me know and it shall be done!

Next Steps

• Change base branch of this PR to upstream
• Approve PR
• Cut a pre-release?
• Community Testing?
• Publish next version to npm
• Publish new Docker image to registry
• Review / merge / publish new ember-backstop version
• Done!

README.md Updates

While updating the README, I thought it could use a refresh. Happy to revert this if needed.

I'm using a handy VSCode Markdwon plugin for TOC generation, which automatically creates and updates based on comments and .vscode/settings.json configuration. Happy to share details if curious!

HTML Report Development

Added a warning here that currently builds are broken and updates are in progress to fix webpack, update React, etc.

Docker

Added a note about load-docker npm script to build/run Dockerfile changes locally without publishing.

General Spacing/Indentation/Enhancements

Removed some legacy, commented-out sections from the README, which I think are OK to keep in git history for now?

Removed $ in command examples that users will likely want to copy/paste.

Converted scenario properties section to a markdown table.

Converted onBeforeScript/onReadyScript variable list to a markdown table.

Added some fancy GitHub-flavored markdown blockquote highlights. Great for "warnings", "tips", and other callouts.

Notes

Critical Vulnerability in mockery

• https://nvd.nist.gov/vuln/detail/CVE-2022-37614
• CVE-2022-37614/Prototype pollution found in mockery.js mfncooper/mockery#77

The maintainer of mockery has not addressed this yet, but a patch is open. Please let me know if you're interested in adding patch-package and a patches directory to address this. Happy to set that up!

Questions

• there are two docker buildx executions with different tags in npm run build-docker — is this needed for the Docker registry?

[garris]

Wow @dgrebb this is great! I am traveling today and tomorrow. Will give this a look later in the week and set up a time to sync on next steps. Cheers!

[garris]

@dgrebb thanks for your patience -- this PR is really beautiful. I love all the GH test flows and thoughtfulness you put into the readme file also.

There is so much going on in this PR -- and a lot of downstream dependencies. Would it be possible to book some time to do a merge session? I think we might need an hour. Next Friday would be easiest for me (otherwise my head might explode). Would that work?

[dgrebb]

Sounds good @garris — no rush! Big updates deserve time and care. Thank you for the kind words :)

I'll get back to you with some times. Are you back in PT? End-of day your time better?

Also, if it makes things easier, we could split it up:

Quick Merge: General Fixes and Enhancements (no dependency changes)

• update/remove legacy npm scripts
• add playwright smoke tests (really just passing the _pw config to the same script with a different name)
• add load-docker npm script

Quick Merge: Test Enhancements

• enhance npm tests with outcome messages (pass, fail, caution)

Code Review: Dependency/Node Update (dependency changes)

• update package.json (dev)dependency
• package verion updates and Node 14 support drop
• Dockerfile update to Node 20
• README updates

[garris]

Yes, chunking it up like this makes sense. I can easily do 2p & later (WC time) if that works for you. Thanks!