Support Node 16

.github/workflows/test.yml

@@ -30,14 +30,13 @@ jobs:
   pwa-kit:
     strategy:
       matrix:
-        node: [14]
+        node: [14, 16]
         npm: [6, 7, 8]
     runs-on: ubuntu-latest
     env:
-      # The "default" npm is the one that ships with a given version of node
-      # node v14 uses npm@6, latest node v16 uses npm@8
+      # The "default" npm is the one that ships with a given version of node.
       # For more: https://nodejs.org/en/download/releases/
-      IS_DEFAULT_NPM: ${{ matrix.npm == 6 }}
+      IS_DEFAULT_NPM: ${{ matrix.node == 14 && matrix.npm == 6 || matrix.node == 16 && matrix.npm == 8 }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -118,11 +117,13 @@ jobs:
           SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
   pwa-kit-windows:
     strategy:
-        # TODO: We don't *need* a matrix with single values,
-        # but is it worth keeping for supporting multiple versions in the future?
-        matrix:
-          node: [14]
-          npm: [6]
+      matrix:
+        node: [14, 16]
+        npm: [6, 7, 8]
+    env:
+      # The "default" npm is the one that ships with a given version of node.
+      # For more: https://nodejs.org/en/download/releases/
+      IS_DEFAULT_NPM: ${{ matrix.node == 14 && matrix.npm == 6 || matrix.node == 16 && matrix.npm == 8 }}
     runs-on: windows-latest
     steps:
         - name: Checkout
@@ -134,6 +135,11 @@ jobs:
             node-version: ${{ matrix.node }}
             cache: npm
 
+        - name: Update NPM version
+          if: env.IS_DEFAULT_NPM == 'false'
+          run: |-
+            npm install -g npm@${{ matrix.npm }}
+
         - name: Setup Windows Machine
           uses: "./.github/actions/setup_windows"
 
@@ -157,7 +163,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 16
 
       - name: Setup Ubuntu Machine
         uses: "./.github/actions/setup_ubuntu"
@@ -247,7 +253,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 16
 
       - name: Setup Windows Machine
         uses: "./.github/actions/setup_windows"

package.json

@@ -2,7 +2,7 @@
   "name": "pwa-kit",
   "version": "2.7.0-dev",
   "engines": {
-    "node": "^14.0.0",
+    "node": "^14.0.0 || ^16.0.0",
     "npm": "^6.14.4 || ^7.0.0 || ^8.0.0"
   },
   "devDependencies": {

packages/commerce-sdk-react/package.json

@@ -5,7 +5,7 @@
   "author": "[email protected]",
   "license": "See license in LICENSE",
   "engines": {
-    "node": "^14.0.0",
+    "node": "^14.0.0 || ^16.0.0",
     "npm": "^6.14.4 || ^7.0.0 || ^8.0.0"
   },
   "files": [

packages/internal-lib-build/package.json

@@ -2,7 +2,7 @@
   "name": "internal-lib-build",
   "version": "2.7.0-dev",
   "engines": {
-    "node": "^14.0.0",
+    "node": "^14.0.0 || ^16.0.0",
     "npm": "^6.14.4 || ^7.0.0 || ^8.0.0"
   },
   "private": true,

packages/pwa-kit-create-app/assets/pwa/default.js

@@ -65,7 +65,7 @@ module.exports = {
     ],
     // Additional parameters that configure Express app behavior.
     ssrParameters: {
-        ssrFunctionNodeVersion: '14.x',
+        ssrFunctionNodeVersion: '16.x',
         proxyConfigs: [
             {
                 host: '${commerceApi.shortCode}.api.commercecloud.salesforce.com',

packages/pwa-kit-create-app/package.json

@@ -26,7 +26,7 @@
     "test": "internal-lib-build test"
   },
   "engines": {
-    "node": "^14.0.0",
+    "node": "^14.0.0 || ^16.0.0",
     "npm": "^6.14.4 || ^7.0.0 || ^8.0.0"
   },
   "dependencies": {

packages/pwa-kit-create-app/scripts/create-mobify-app-dev.js

@@ -45,6 +45,7 @@ const p = require('path')
 const sh = require('shelljs')
 const fs = require('fs')
 const cp = require('child_process')
+const semver = require('semver')
 
 sh.set('-e')
 
@@ -147,7 +148,12 @@ const runGenerator = () => {
     // Shelljs can't run interactive programs, so we have to switch to child_process.
     // See https://github.com/shelljs/shelljs/wiki/FAQ#running-interactive-programs-with-exec
 
-    cp.execSync(`npx pwa-kit-create-app ${process.argv.slice(2).join(' ')}`, {
+    const extension = process.platform === 'win32' ? '.cmd' : ''
+    const npm = `npm${extension}`
+    const foundNpm = cp.spawnSync(npm, ['-v']).stdout.toString().trim()
+    const flags = semver.satisfies(foundNpm, '>=7') ? '-y' : ''
+
+    cp.execSync(`npx ${flags} pwa-kit-create-app@latest ${process.argv.slice(2).join(' ')}`, {
         stdio: 'inherit'
     })
 }

packages/pwa-kit-dev/CHANGELOG.md

@@ -1,4 +1,6 @@
 ## v2.7.0-dev (Jan 25, 2023)
+- Add explicit `ws` dependency [#865](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/865)
+
 ## v2.6.0 (Jan 25, 2023)
 - Upgrade prettier to v2 [#926](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/926)
 - Security package updates

packages/pwa-kit-dev/package.json

@@ -104,7 +104,8 @@
     "webpack-dev-middleware": "^5.2.2",
     "webpack-hot-middleware": "^2.25.1",
     "webpack-hot-server-middleware": "^0.6.1",
-    "webpack-notifier": "^1.12.0"
+    "webpack-notifier": "^1.12.0",
+    "ws": "^8.12.0"
   },
   "devDependencies": {
     "@loadable/component": "^5.15.0",
@@ -117,7 +118,7 @@
     "@loadable/component": "^5.15.0"
   },
   "engines": {
-    "node": "^14.0.0",
+    "node": "^14.0.0 || ^16.0.0",
     "npm": "^6.14.4 || ^7.0.0 || ^8.0.0"
   },
   "publishConfig": {

packages/pwa-kit-dev/src/utils/script-utils.ts

@@ -119,6 +119,11 @@ export class CloudAPIClient {
             error = {} // Cloud doesn't always return JSON
         }
 
+        if (res.status === 403) {
+            error.docs_url =
+                'https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/mrt-overview.html#users,-abilities,-and-roles'
+        }
+
         throw new Error(
             [
                 `HTTP ${res.status}`,

packages/pwa-kit-react-sdk/package.json

@@ -3,7 +3,7 @@
   "version": "2.7.0-dev",
   "description": "A library that supports the isomorphic React rendering pipeline for Commerce Cloud Managed Runtime apps",
   "engines": {
-    "node": "^14.0.0",
+    "node": "^14.0.0 || ^16.0.0",
     "npm": "^6.14.4 || ^7.0.0 || ^8.0.0"
   },
   "files": [

packages/pwa-kit-react-sdk/setup-jest.js

@@ -31,7 +31,7 @@ jest.mock('pwa-kit-runtime/utils/ssr-config', () => {
                 '**/*.json'
             ],
             ssrParameters: {
-                ssrFunctionNodeVersion: '14.x',
+                ssrFunctionNodeVersion: '16.x',
                 proxyConfigs: [
                     {
                         host: 'kv7kzm78.api.commercecloud.salesforce.com',

packages/pwa-kit-runtime/CHANGELOG.md

@@ -1,4 +1,6 @@
 ## v2.7.0-dev (Jan 25, 2023)
+- Support Node 16 [#965](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/965)
+
 ## v2.6.0 (Jan 25, 2023)
 - Security package updates
 

packages/pwa-kit-runtime/package.json

@@ -70,7 +70,7 @@
     }
   },
   "engines": {
-    "node": "^14.0.0",
+    "node": "^14.0.0 || ^16.0.0",
     "npm": "^6.14.4 || ^7.0.0 || ^8.0.0"
   },
   "publishConfig": {

packages/pwa-kit-runtime/src/ssr/server/build-remote-server.js

@@ -19,7 +19,6 @@ import {
     isRemote,
     MetricsSender,
     outgoingRequestHook,
-    PerformanceTimer,
     processLambdaResponse,
     responseSend,
     configureProxyConfigs,
@@ -495,15 +494,11 @@ export const RemoteServerFactory = {
             locals.afterResponseCalled = false
             locals.responseCaching = {}
 
-            locals.timer = new PerformanceTimer(`req${locals.requestId}`)
             locals.originalUrl = req.originalUrl
 
             // Track this response
             req.app._requestMonitor._responseStarted(res)
 
-            // Start timing
-            locals.timer.start('express-overall')
-
             // If the path is /, we enforce that the only methods
             // allowed are GET, HEAD or OPTIONS. This is a restriction
             // imposed by API Gateway: we enforce it here so that the
@@ -519,8 +514,6 @@ export const RemoteServerFactory = {
             const afterResponse = () => {
                 /* istanbul ignore else */
                 if (!locals.afterResponseCalled) {
-                    locals.timer.end('express-overall')
-                    locals.timingResponse && locals.timer.end('express-response')
                     locals.afterResponseCalled = true
                     // Emit timing unless the request is for a proxy
                     // or bundle path. We don't want to emit metrics
@@ -547,9 +540,6 @@ export const RemoteServerFactory = {
                         }
                         req.app.sendMetric(metricName)
                     }
-                    locals.timer.finish()
-                    // Release reference to timer
-                    locals.timer = null
                 }
             }
 
@@ -969,16 +959,12 @@ const prepNonProxyRequest = (req, res, next) => {
  * @private
  */
 const ssrMiddleware = (req, res, next) => {
-    const timer = res.locals.timer
-    timer.start('ssr-overall')
-
     setDefaultHeaders(req, res)
     const renderStartTime = Date.now()
 
     const done = () => {
         const elapsedRenderTime = Date.now() - renderStartTime
         req.app.sendMetric('RenderTime', elapsedRenderTime, 'Milliseconds')
-        timer.end('ssr-overall')
     }
 
     res.on('finish', done)

packages/pwa-kit-runtime/src/ssr/server/express.js

@@ -306,14 +306,10 @@ export const cacheResponseWhenDone = ({
         // We know that all the data has been written, so we
         // can now store the response in the cache and call
         // end() on it.
-        const timer = res.locals.timer
         req.app.applicationCache._cacheDeletePromise
             .then(() => {
                 localDevLog(`Req ${locals.requestId}: caching response for ${req.url}`)
-                timer.start('cache-response')
-                return storeResponseInCache(req, res).then(() => {
-                    timer.end('cache-response')
-                })
+                return storeResponseInCache(req, res)
             })
             .finally(() => {
                 originalEnd.call(res, callback)
@@ -390,11 +386,7 @@ export const getResponseFromCache = ({req, res, namespace, key}) => {
     locals.responseCaching.cacheKey = workingKey
 
     // Return a Promise that handles the asynchronous cache lookup
-    const timer = res.locals.timer
-    timer.start('check-response-cache')
     return req.app.applicationCache.get({key: workingKey, namespace}).then((entry) => {
-        timer.end('check-response-cache')
-
         localDevLog(
             `Req ${locals.requestId}: ${
                 entry.found ? 'Found' : 'Did not find'

packages/pwa-kit-runtime/src/utils/ssr-server.js

@@ -16,7 +16,6 @@ export * from './ssr-server/detect-device-type'
 export * from './ssr-server/metrics-sender'
 export * from './ssr-server/outgoing-request-hook'
 export * from './ssr-server/parse-end-parameters'
-export * from './ssr-server/performance-timer'
 export * from './ssr-server/process-express-response'
 export * from './ssr-server/process-lambda-response'
 export * from './ssr-server/update-global-agent-options'

packages/pwa-kit-runtime/src/utils/ssr-server.test.js

@@ -21,7 +21,6 @@ import {
     outgoingRequestHook,
     parseCacheControl,
     parseEndParameters,
-    PerformanceTimer,
     processExpressResponse,
     processLambdaResponse,
     updateGlobalAgentOptions,
@@ -960,41 +959,6 @@ describe('updateGlobalAgentOptions', () => {
     })
 })
 
-describe('PerformanceTimer tests', () => {
-    let timer
-    beforeEach(() => (timer = new PerformanceTimer('')))
-    afterEach(() => timer?._observer.disconnect())
-
-    test('time() function', () => {
-        const func = sinon.stub()
-        timer.time('test1', func, 1)
-        expect(func.callCount).toBe(1)
-        expect(func.calledWith(1)).toBe(true)
-
-        func.reset()
-        func.throws('Error', 'intentional error')
-        expect(() => timer.time('test2', func, 1)).toThrow('intentional error')
-        expect(func.callCount).toBe(1)
-    })
-
-    test('start() and end()', async () => {
-        timer.start('test3')
-        await new Promise((resolve) => setTimeout(resolve, 10))
-        timer.end('test3')
-        const summary = timer.summary
-        expect(summary.length).toBe(1)
-        const entry = summary[0]
-        expect(entry.name).toEqual('test3')
-        expect(entry.duration).toBeGreaterThanOrEqual(5)
-        expect(entry.duration).toBeLessThanOrEqual(30)
-    })
-
-    test('accessing operationId auto-increments the counter', () => {
-        expect(timer.operationId).toBe(1)
-        expect(timer.operationId).toBe(2)
-    })
-})
-
 describe('parseCacheControl', () => {
     test('accepts undefined', () => {
         const result = parseCacheControl()