Skip to content

Commit

Permalink
Deprecate Node.js 14.x and 16.x with warning (#9976)
Browse files Browse the repository at this point in the history
Node.js 14 and 16 are being deprecated. This PR will cause a warning when they are used today and an error after August 15.
  • Loading branch information
EndangeredMassa committed May 18, 2023
1 parent 91b7f6d commit 71b9f3a
Show file tree
Hide file tree
Showing 5 changed files with 65 additions and 24 deletions.
5 changes: 5 additions & 0 deletions .changeset/shaggy-chefs-invent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@vercel/build-utils": patch
---

Deprecate Node.js 14.x and 16.x with warning
14 changes: 12 additions & 2 deletions packages/build-utils/src/fs/node-version.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,18 @@ import debug from '../debug';
function getOptions() {
const options = [
{ major: 18, range: '18.x', runtime: 'nodejs18.x' },
{ major: 16, range: '16.x', runtime: 'nodejs16.x' },
{ major: 14, range: '14.x', runtime: 'nodejs14.x' },
{
major: 16,
range: '16.x',
runtime: 'nodejs16.x',
discontinueDate: new Date('2023-08-15'),
},
{
major: 14,
range: '14.x',
runtime: 'nodejs14.x',
discontinueDate: new Date('2023-08-15'),
},
{
major: 12,
range: '12.x',
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"private": true,
"engines": {
"node": "16.14.0"
"node": "18.2.0"
}
}
2 changes: 1 addition & 1 deletion packages/build-utils/test/pkg-engine-node/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"private": true,
"engines": {
"node": "14.x"
"node": "18.x"
}
}
66 changes: 46 additions & 20 deletions packages/build-utils/test/unit.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -140,20 +140,20 @@ it('should ignore node version in vercel dev getNodeVersion()', async () => {

it('should select project setting from config when no package.json is found and fallback undefined', async () => {
expect(
await getNodeVersion('/tmp', undefined, { nodeVersion: '16.x' }, {})
).toHaveProperty('range', '16.x');
await getNodeVersion('/tmp', undefined, { nodeVersion: '18.x' }, {})
).toHaveProperty('range', '18.x');
expect(warningMessages).toStrictEqual([]);
});

it('should select project setting from config when no package.json is found and fallback is null', async () => {
expect(
await getNodeVersion('/tmp', null as any, { nodeVersion: '16.x' }, {})
).toHaveProperty('range', '16.x');
await getNodeVersion('/tmp', null as any, { nodeVersion: '18.x' }, {})
).toHaveProperty('range', '18.x');
expect(warningMessages).toStrictEqual([]);
});

it('should select project setting from fallback when no package.json is found', async () => {
expect(await getNodeVersion('/tmp', '16.x')).toHaveProperty('range', '16.x');
expect(await getNodeVersion('/tmp', '18.x')).toHaveProperty('range', '18.x');
expect(warningMessages).toStrictEqual([]);
});

Expand All @@ -165,9 +165,9 @@ it('should prefer package.json engines over project setting from config and warn
{ nodeVersion: '12.x' },
{}
)
).toHaveProperty('range', '14.x');
).toHaveProperty('range', '18.x');
expect(warningMessages).toStrictEqual([
'Warning: Due to "engines": { "node": "14.x" } in your `package.json` file, the Node.js Version defined in your Project Settings ("12.x") will not apply. Learn More: http://vercel.link/node-version',
'Warning: Due to "engines": { "node": "18.x" } in your `package.json` file, the Node.js Version defined in your Project Settings ("12.x") will not apply. Learn More: http://vercel.link/node-version',
]);
});

Expand All @@ -179,9 +179,9 @@ it('should warn when package.json engines is exact version', async () => {
{},
{}
)
).toHaveProperty('range', '16.x');
).toHaveProperty('range', '18.x');
expect(warningMessages).toStrictEqual([
'Warning: Detected "engines": { "node": "16.14.0" } in your `package.json` with major.minor.patch, but only major Node.js Version can be selected. Learn More: http://vercel.link/node-version',
'Warning: Detected "engines": { "node": "18.2.0" } in your `package.json` with major.minor.patch, but only major Node.js Version can be selected. Learn More: http://vercel.link/node-version',
]);
});

Expand All @@ -204,30 +204,30 @@ it('should not warn when package.json engines matches project setting from confi
await getNodeVersion(
path.join(__dirname, 'pkg-engine-node'),
undefined,
{ nodeVersion: '14' },
{ nodeVersion: '18' },
{}
)
).toHaveProperty('range', '14.x');
).toHaveProperty('range', '18.x');
expect(warningMessages).toStrictEqual([]);

expect(
await getNodeVersion(
path.join(__dirname, 'pkg-engine-node'),
undefined,
{ nodeVersion: '14.x' },
{ nodeVersion: '18.x' },
{}
)
).toHaveProperty('range', '14.x');
).toHaveProperty('range', '18.x');
expect(warningMessages).toStrictEqual([]);

expect(
await getNodeVersion(
path.join(__dirname, 'pkg-engine-node'),
undefined,
{ nodeVersion: '<15' },
{ nodeVersion: '<19' },
{}
)
).toHaveProperty('range', '14.x');
).toHaveProperty('range', '18.x');
expect(warningMessages).toStrictEqual([]);
});

Expand All @@ -238,20 +238,26 @@ it('should get latest node version', async () => {
it('should throw for discontinued versions', async () => {
// Mock a future date so that Node 8 and 10 become discontinued
const realDateNow = Date.now.bind(global.Date);
global.Date.now = () => new Date('2022-10-15').getTime();
global.Date.now = () => new Date('2023-10-01').getTime();

expect(getSupportedNodeVersion('8.10.x', false)).rejects.toThrow();
expect(getSupportedNodeVersion('8.10.x', true)).rejects.toThrow();
expect(getSupportedNodeVersion('10.x', false)).rejects.toThrow();
expect(getSupportedNodeVersion('10.x', true)).rejects.toThrow();
expect(getSupportedNodeVersion('12.x', false)).rejects.toThrow();
expect(getSupportedNodeVersion('12.x', true)).rejects.toThrow();
expect(getSupportedNodeVersion('14.x', false)).rejects.toThrow();
expect(getSupportedNodeVersion('14.x', true)).rejects.toThrow();
expect(getSupportedNodeVersion('16.x', false)).rejects.toThrow();
expect(getSupportedNodeVersion('16.x', true)).rejects.toThrow();

const discontinued = getDiscontinuedNodeVersions();
expect(discontinued.length).toBe(3);
expect(discontinued[0]).toHaveProperty('range', '12.x');
expect(discontinued[1]).toHaveProperty('range', '10.x');
expect(discontinued[2]).toHaveProperty('range', '8.10.x');
expect(discontinued.length).toBe(5);
expect(discontinued[0]).toHaveProperty('range', '16.x');
expect(discontinued[1]).toHaveProperty('range', '14.x');
expect(discontinued[2]).toHaveProperty('range', '12.x');
expect(discontinued[3]).toHaveProperty('range', '10.x');
expect(discontinued[4]).toHaveProperty('range', '8.10.x');

global.Date.now = realDateNow;
});
Expand All @@ -277,11 +283,31 @@ it('should warn for deprecated versions, soon to be discontinued', async () => {
'major',
12
);
expect(await getSupportedNodeVersion('14.x', false)).toHaveProperty(
'major',
14
);
expect(await getSupportedNodeVersion('14.x', true)).toHaveProperty(
'major',
14
);
expect(await getSupportedNodeVersion('16.x', false)).toHaveProperty(
'major',
16
);
expect(await getSupportedNodeVersion('16.x', true)).toHaveProperty(
'major',
16
);
expect(warningMessages).toStrictEqual([
'Error: Node.js version 10.x has reached End-of-Life. Deployments created on or after 2021-04-20 will fail to build. Please set "engines": { "node": "18.x" } in your `package.json` file to use Node.js 18.',
'Error: Node.js version 10.x has reached End-of-Life. Deployments created on or after 2021-04-20 will fail to build. Please set Node.js Version to 18.x in your Project Settings to use Node.js 18.',
'Error: Node.js version 12.x has reached End-of-Life. Deployments created on or after 2022-10-03 will fail to build. Please set "engines": { "node": "18.x" } in your `package.json` file to use Node.js 18.',
'Error: Node.js version 12.x has reached End-of-Life. Deployments created on or after 2022-10-03 will fail to build. Please set Node.js Version to 18.x in your Project Settings to use Node.js 18.',
'Error: Node.js version 14.x has reached End-of-Life. Deployments created on or after 2023-08-15 will fail to build. Please set "engines": { "node": "18.x" } in your `package.json` file to use Node.js 18.',
'Error: Node.js version 14.x has reached End-of-Life. Deployments created on or after 2023-08-15 will fail to build. Please set Node.js Version to 18.x in your Project Settings to use Node.js 18.',
'Error: Node.js version 16.x has reached End-of-Life. Deployments created on or after 2023-08-15 will fail to build. Please set "engines": { "node": "18.x" } in your `package.json` file to use Node.js 18.',
'Error: Node.js version 16.x has reached End-of-Life. Deployments created on or after 2023-08-15 will fail to build. Please set Node.js Version to 18.x in your Project Settings to use Node.js 18.',
]);

global.Date.now = realDateNow;
Expand Down

0 comments on commit 71b9f3a

Please sign in to comment.