Bump NodeJS supported versions to ^16.16 || ^18.13 and add engines to package.json #8201

alex-page · 2023-01-29T23:16:28Z

WHY are these changes introduced?

NodeJS 14 is EOL and we are removing support in v11.

We currently set engines on the root package.json. The problem with this is that consumers of the library do not get this information and they can use the libraries without any warning of what version of NodeJS it supports.

WHAT is this pull request doing?

Increasing the supported versions of NodeJS
Add the engines field for NodeJS to package.json files

I would like to get NodeJS to version 16.19 before we launch version 11. However there is an issue with babel/rollup/browserslist not finding the latest version of NodeJS:

(plugin babel) BrowserslistError: Unknown version 16.19 of Node.js

How to 🎩

CI completes successfully

github-actions · 2023-01-29T23:30:33Z

size-limit report 📦

Path	Size
polaris-react-cjs	212.06 KB (0%)
polaris-react-esm	136.31 KB (0%)
polaris-react-esnext	189.85 KB (0%)
polaris-react-css	40.63 KB (0%)

### WHY are these changes introduced? We currently set `engines` on the root `package.json`. The problem with this is that consumers of the library do not get this information and they can use the libraries without any warning of what version of NodeJS it supports. This change adds the engines field to each package to ensure our consumers are using supported versions of NodeJS. ### WHAT is this pull request doing? Adding the engines field to package.json files

… bump-nodejs

alex-page · 2023-01-30T00:10:08Z

polaris-react/rollup.config.mjs

@@ -54,7 +54,7 @@ function generateConfig({output, targets, stylesConfig}) {
 /** @type {import('rollup').RollupOptions} */
 export default [
  generateConfig({
-    targets: 'extends @shopify/browserslist-config, node 12.20',


This scared me but nothing seems to be bad since changing the version...

alex-page · 2023-01-30T00:33:43Z

.eslintrc.js

-        // We could omit this if we set `engines` fields properly
-        // As we don't set them then eslint thinks we're using node 8
-        'node/no-unsupported-features/node-builtins': [
-          'error',
-          {version: '>=16.0.0'},
-        ],


We set the engines field now so this is no longer needed.

sam-b-rose

Looks good! I did see that the @types/node in the polaris-for-vscode/package.json is on ^14. I think it might be good to update that as well to 16 or even 18.

BPScott

The versions chosen seem suprising to me

Using "^16.16.0 || ^18.13.0" for the per-package engines shall block installation on node 19 (and 20 when it comes out in April). Currently supported and future node versions seems like a bad idea.
Node 14 is still supported till April. I'm ok with preemptively dropping support if you feel like this shall help improve something.
The first LTS version of v16 was 16.13, and the first LTS version of 18 was 18.12. Is there a reason why we're choosing to claim minimum polaris versions are 16.16 and 18.13?

BPScott · 2023-01-30T19:13:29Z

polaris-for-vscode/package.json

@@ -20,7 +20,7 @@
    "shopify"
  ],
  "engines": {
-    "vscode": "^1.64.0"
+    "node": "^16.16.0 || ^18.13.0"


This seems incorrect

BPScott · 2023-01-30T19:22:06Z

polaris-cli/package.json

@@ -31,7 +31,7 @@
  },
  "engine-strict": true,
  "engines": {
-    "node": ">=14.13.1"
+    "node": "^16.16.0 || ^18.13.0"


By setting the engines on the specific node packages, they shall refuse to install if the node version does not match these versions. This is great for blocking installation on older unsupported versions, however the configuration of "^16.16.0 || ^18.13.0" means "Only node 16 or 18" - you're currently also blocking the installation of these packages on the currently supported node 19 (and the lts node 20 when it comes out in April).

For these per-package engine fields I strongly think we should allow current and future versions for the sake of forwards compatibility - ^16.16.0 || >=18.13.0.

## @shopify/polaris v11.0.0 ### Dependencies - [x] #8200 ### NodeJS - [x] #8201 ### TypeScript - [x] #8203 ### Components - [x] #7349 - [x] #7397 - [x] #7962 - [x] #8187 - [x] #8184 - [x] #8206 - [x] #7990 - [x] #8468 - [x] #8577 - [x] #8631 - [x] #8962 ## @shopify/polaris-tokens v7.0.0 ### Tokens - [x] #6920 - [x] #8245 - [x] #4826 - [x] #8405 ## @shopify/stylelint-polaris v7.0.0 - [x] #7622 - [x] #8419 # Post @shopify/polaris v11 shipping - [ ] #8420 ## Low priority or not ready breaking changes - [x] Remove deprecated layout components - [x] Release Layout primitive components --------- Co-authored-by: Tim Layton <[email protected]> Co-authored-by: Ryan Musgrave <[email protected]> Co-authored-by: Ryan Musgrave <[email protected]> Co-authored-by: aveline <[email protected]> Co-authored-by: Kyle Durand <[email protected]> Co-authored-by: Matt Gregg <[email protected]> Co-authored-by: Alex Page <[email protected]> Co-authored-by: Lo Kim <[email protected]> Co-authored-by: Ben Scott <[email protected]> Co-authored-by: Aaron Casanova <[email protected]> Co-authored-by: Sam Rose <[email protected]> Co-authored-by: Sam Rose <[email protected]> Co-authored-by: Marc Thomas <[email protected]> Co-authored-by: Alex Page <[email protected]> Co-authored-by: Chloe Rice <[email protected]> Co-authored-by: Chloe Rice <[email protected]> Co-authored-by: Joe Thomas <[email protected]> Co-authored-by: Yuraima Estevez <[email protected]> Co-authored-by: shopify-github-actions-access[bot] <109624739+shopify-github-actions-access[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

## @shopify/polaris v11.0.0 ### Dependencies - [x] Shopify#8200 ### NodeJS - [x] Shopify#8201 ### TypeScript - [x] Shopify#8203 ### Components - [x] Shopify#7349 - [x] Shopify#7397 - [x] Shopify#7962 - [x] Shopify#8187 - [x] Shopify#8184 - [x] Shopify#8206 - [x] Shopify#7990 - [x] Shopify#8468 - [x] Shopify#8577 - [x] Shopify#8631 - [x] Shopify#8962 ## @shopify/polaris-tokens v7.0.0 ### Tokens - [x] Shopify#6920 - [x] Shopify#8245 - [x] Shopify#4826 - [x] Shopify#8405 ## @shopify/stylelint-polaris v7.0.0 - [x] Shopify#7622 - [x] Shopify#8419 # Post @shopify/polaris v11 shipping - [ ] Shopify#8420 ## Low priority or not ready breaking changes - [x] Remove deprecated layout components - [x] Release Layout primitive components --------- Co-authored-by: Tim Layton <[email protected]> Co-authored-by: Ryan Musgrave <[email protected]> Co-authored-by: Ryan Musgrave <[email protected]> Co-authored-by: aveline <[email protected]> Co-authored-by: Kyle Durand <[email protected]> Co-authored-by: Matt Gregg <[email protected]> Co-authored-by: Alex Page <[email protected]> Co-authored-by: Lo Kim <[email protected]> Co-authored-by: Ben Scott <[email protected]> Co-authored-by: Aaron Casanova <[email protected]> Co-authored-by: Sam Rose <[email protected]> Co-authored-by: Sam Rose <[email protected]> Co-authored-by: Marc Thomas <[email protected]> Co-authored-by: Alex Page <[email protected]> Co-authored-by: Chloe Rice <[email protected]> Co-authored-by: Chloe Rice <[email protected]> Co-authored-by: Joe Thomas <[email protected]> Co-authored-by: Yuraima Estevez <[email protected]> Co-authored-by: shopify-github-actions-access[bot] <109624739+shopify-github-actions-access[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

alex-page added 5 commits January 30, 2023 08:59

Bump build dependencies

7ff43f4

Merge branch 'v11-major' into bump-build-deps

53b178d

Bump nodejs

e2ab1fb

Merge branch 'v11-major' into bump-build-deps

c890078

Merge branch 'bump-build-deps' into bump-nodejs

10b3223

alex-page changed the base branch from main to bump-build-deps January 29, 2023 23:17

alex-page added 🤖Skip Changelog Causes CI to ignore changelog update check. and removed 🤖Skip Changelog Causes CI to ignore changelog update check. labels Jan 29, 2023

Update migrating-from-v10-to-v11.md

2d05096

alex-page marked this pull request as ready for review January 29, 2023 23:24

alex-page added 3 commits January 30, 2023 10:31

Remove unnecessary linting comments

7935ed5

Merge branch 'bump-nodejs' of https://github.com/Shopify/polaris into…

1d02ef0

… bump-nodejs

alex-page commented Jan 30, 2023

View reviewed changes

Base automatically changed from bump-build-deps to v11-major January 30, 2023 00:11

alex-page requested review from sam-b-rose and kyledurand January 30, 2023 00:11

Add complete version to rollup so it can be replaced easily

8779cba

alex-page commented Jan 30, 2023

View reviewed changes

alex-page requested review from BPScott and aaronccasanova January 30, 2023 00:35

sam-b-rose approved these changes Jan 30, 2023

View reviewed changes

alex-page added 5 commits January 30, 2023 11:56

Bump NodeJS types

08622a8

Update Nodejs support.md

7eabd34

Merge branch 'v11-major' into bump-nodejs

cda3ff4

Update documentation/guides/migrating-from-v10-to-v11.md

3cd33ac

Update documentation/Nodejs support.md

8e91155

alex-page changed the title ~~2/x Bump NodeJS supported versions to 16.16 | 18.13~~ 2/x Bump NodeJS supported versions to ^16.16 || ^18.13 Jan 30, 2023

alex-page merged commit 89c8ae4 into v11-major Jan 30, 2023

alex-page deleted the bump-nodejs branch January 30, 2023 01:27

alex-page changed the title ~~2/x Bump NodeJS supported versions to ^16.16 || ^18.13~~ Bump NodeJS supported versions to ^16.16 || ^18.13 and add engines to package.json Jan 30, 2023

alex-page mentioned this pull request Jan 30, 2023

@shopify/polaris v11.0.0 major release #7597

Merged

23 tasks

BPScott reviewed Jan 30, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bump NodeJS supported versions to ^16.16 || ^18.13 and add engines to package.json #8201

Bump NodeJS supported versions to ^16.16 || ^18.13 and add engines to package.json #8201

alex-page commented Jan 29, 2023 •

edited

Loading

github-actions bot commented Jan 29, 2023 •

edited

Loading

alex-page Jan 30, 2023

alex-page Jan 30, 2023

sam-b-rose left a comment

BPScott left a comment

BPScott Jan 30, 2023

BPScott Jan 30, 2023

Bump NodeJS supported versions to ^16.16 || ^18.13 and add engines to package.json #8201

Bump NodeJS supported versions to ^16.16 || ^18.13 and add engines to package.json #8201

Conversation

alex-page commented Jan 29, 2023 • edited Loading

WHY are these changes introduced?

WHAT is this pull request doing?

How to 🎩

github-actions bot commented Jan 29, 2023 • edited Loading

size-limit report 📦

alex-page Jan 30, 2023

Choose a reason for hiding this comment

alex-page Jan 30, 2023

Choose a reason for hiding this comment

sam-b-rose left a comment

Choose a reason for hiding this comment

BPScott left a comment

Choose a reason for hiding this comment

BPScott Jan 30, 2023

Choose a reason for hiding this comment

BPScott Jan 30, 2023

Choose a reason for hiding this comment

alex-page commented Jan 29, 2023 •

edited

Loading

github-actions bot commented Jan 29, 2023 •

edited

Loading