@W-15248536@ - [v2] Google Search Console fix createCodeVerifier (#1765)

* Add entropy to nanoid createCodeVerifier

* cleanup

* bump main.js file size

* Debug GA Windows builds

* Set shell: true with spawnSync

* Set shell: true with spawnSync on generator

* lint

* Update CHANGELOG.md

* Add docs

* Update CHANGELOG.md

* Update CHANGELOG.md

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

@@ -124,7 +124,7 @@ const runGenerator = () => {
 
     const extension = process.platform === 'win32' ? '.cmd' : ''
     const npm = `npm${extension}`
-    const foundNpm = cp.spawnSync(npm, ['-v']).stdout.toString().trim()
+    const foundNpm = cp.spawnSync(npm, ['-v'], {shell: true}).stdout.toString().trim()
     const flags = semver.satisfies(foundNpm, '>=7') ? '-y' : ''
 
     const pathToNpxCache = p.join(sh.exec('npm config get cache', {silent: true}).trim(), '_npx')

packages/template-retail-react-app/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v2.8.4 (May 2, 2024)
+
+- Fixed createCodeVerifier adding entropy to be successfully indexed by Google Search Console. [#1765](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/1765)
+- Fixed Node.js on Windows blocking spawSync .cmd unless { shell: true } is used with trusted code. [#1765](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/1765)
+
 ## v2.8.3 (Apr 9, 2024)
 
 - Storefront Preview: avoid stale cached Commerce API responses, whenever the Shopper Context is set [#1740](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/1740)

packages/template-retail-react-app/app/commerce-api/pkce.js

@@ -4,22 +4,32 @@
  * SPDX-License-Identifier: BSD-3-Clause
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import {nanoid} from 'nanoid'
+import {customRandom, urlAlphabet} from 'nanoid'
 import {encode as base64encode} from 'base64-arraybuffer'
+import seedrandom from 'seedrandom'
 
 // Server Side
 const randomstring = require('randomstring')
 
 // Globals
 const isServer = typeof window === 'undefined'
 
+/**
+ * Adds entropy to nanoid() using seedrandom to ensure that the code_challenge sent to SCAPI by Google's crawler browser is unique.
+ * Solves the issue with Google's crawler getting the same result from nanoid() in two different runs, which results in the same PKCE code_challenge being used twice.
+ */
+const nanoid = () => {
+    const rng = seedrandom(+new Date(), {entropy: true})
+    return customRandom(urlAlphabet, 128, (size) => new Uint8Array(size).map(() => 256 * rng()))()
+}
+
 /**
  * Creates Code Verifier use for PKCE auth flow.
  *
  * @returns {String} The 128 character length code verifier.
  */
 export const createCodeVerifier = () => {
-    return isServer ? randomstring.generate(128) : nanoid(128)
+    return isServer ? randomstring.generate(128) : nanoid()
 }
 
 /**

packages/template-retail-react-app/app/commerce-api/pkce.test.js

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2024, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: BSD-3-Clause
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import {createCodeVerifier, generateCodeChallenge} from './pkce'
+import seedrandom from 'seedrandom'
+
+describe('PKCE Utility Functions', () => {
+    describe('createCodeVerifier', () => {
+        test('should generate unique code verifiers', () => {
+            const verifiers = new Set()
+            const numVerifiers = 100
+
+            for (let i = 0; i < numVerifiers; i++) {
+                const verifier = createCodeVerifier()
+                verifiers.add(verifier)
+            }
+            expect(verifiers.size).toBe(numVerifiers)
+        })
+
+        test('should provide sufficient entropy', () => {
+            const seed1 = 123456789
+            const seed2 = 987654321
+            seedrandom(seed1, {global: true})
+            const verifier1 = createCodeVerifier()
+            seedrandom(seed2, {global: true})
+            const verifier2 = createCodeVerifier()
+            // the generated verifiers should be different because we're using different seeds
+            expect(verifier1).not.toBe(verifier2)
+        })
+    })
+
+    describe('generateCodeChallenge', () => {
+        test('should generate a code challenge based on the provided code verifier', async () => {
+            const codeVerifier = createCodeVerifier()
+            const codeChallenge = await generateCodeChallenge(codeVerifier)
+
+            expect(codeChallenge).toBeDefined()
+        })
+    })
+})

packages/template-retail-react-app/package.json

@@ -52,7 +52,8 @@
         "react-helmet": "^6.1.0",
         "react-hook-form": "^6.15.8",
         "react-intl": "^5.25.1",
-        "react-router-dom": "^5.3.4"
+        "react-router-dom": "^5.3.4",
+        "seedrandom": "^3.0.5"
     },
     "peerDependencies": {
         "@chakra-ui/system": "^1.12.1"
@@ -80,7 +81,7 @@
     "bundlesize": [
         {
             "path": "build/main.js",
-            "maxSize": "55 kB"
+            "maxSize": "56 kB"
         },
         {
             "path": "build/vendor.js",

scripts/check-version.js

@@ -13,9 +13,10 @@ const extension = isWin ? '.cmd' : ''
 const npm = `npm${extension}`
 
 const spawnSync = (...args) => {
-    const proc = childProc.spawnSync(...args)
+    const proc = childProc.spawnSync(...args, { shell: true })
     if (proc.status !== 0) {
-        throw proc.stderr.toString()
+        console.error(proc)
+        throw proc.stderr ? proc.stderr.toString() : 'Unknown error'
     }
     return proc
 }