Replace --frozen-lockfile with custom diffing

Author: octogonz

build-tests/install-test-workspace/.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "pwa-node",
+      "request": "launch",
+      "name": "build.js",
+      "program": "${workspaceFolder}/build.js",
+      "args": ["--skip-pack"]
+    },
+    {
+      "type": "pwa-node",
+      "request": "launch",
+      "name": "pnpm install",
+      "program": "${workspaceFolder}/../../common/temp/pnpm-local/node_modules/pnpm/bin/pnpm.cjs",
+      "args": ["install"],
+      "cwd": "${workspaceFolder}/workspace"
+    }
+  ]
+}

build-tests/install-test-workspace/build.js

@@ -115,14 +115,31 @@ if (FileSystem.exists(dotPnpmFolderPath)) {
   }
 }
 
+const pnpmLockBeforePath = path.join(__dirname, 'workspace/pnpm-lock-git.yaml');
+const pnpmLockAfterPath = path.join(__dirname, 'workspace/pnpm-lock.yaml');
+let pnpmLockBeforeContent = '';
+
+if (FileSystem.exists(pnpmLockBeforePath)) {
+  pnpmLockBeforeContent = FileSystem.readFile(pnpmLockBeforePath).toString().replace(/\s+/g, ' ').trim();
+  FileSystem.copyFile({
+    sourcePath: pnpmLockBeforePath,
+    destinationPath: pnpmLockAfterPath,
+    alreadyExistsBehavior: 'overwrite'
+  });
+} else {
+  pnpmLockBeforeContent = '';
+  FileSystem.deleteFile(pnpmLockAfterPath);
+}
+
 const pnpmInstallArgs = [
   'install',
   '--store',
   rushConfiguration.pnpmOptions.pnpmStorePath,
   '--strict-peer-dependencies',
   '--recursive',
   '--link-workspace-packages=false',
-  '--frozen-lockfile=false' // productionMode ? 'true' : 'false'
+  // PNPM gets confused by the rewriting performed by our .pnpmfile.cjs afterAllResolved hook
+  '--frozen-lockfile=false'
 ];
 
 console.log('\nInstalling:');
@@ -136,6 +153,32 @@ checkSpawnResult(
   'pnpm install'
 );
 
+// Now compare the before/after
+const pnpmLockAfterContent = FileSystem.readFile(pnpmLockAfterPath).toString().replace(/\s+/g, ' ').trim();
+
+let shrinkwrapUpdatedNotice = false;
+
+if (pnpmLockBeforeContent !== pnpmLockAfterContent) {
+  if (productionMode) {
+    console.error('The shrinkwrap file is not up to date:');
+    console.error('  Git copy:     ' + pnpmLockBeforePath);
+    console.error('  Current copy: ' + pnpmLockAfterPath);
+    console.error('\nPlease commit the updated copy to Git\n');
+    process.exitCode = 1;
+    return;
+  } else {
+    // Automatically update the copy
+    FileSystem.copyFile({
+      sourcePath: pnpmLockAfterPath,
+      destinationPath: pnpmLockBeforePath,
+      alreadyExistsBehavior: 'overwrite'
+    });
+
+    // Show the notice at the very end
+    shrinkwrapUpdatedNotice = true;
+  }
+}
+
 console.log('\n\nInstallation completed successfully.');
 
 console.log('\nBuilding projects...\n');
@@ -148,6 +191,11 @@ checkSpawnResult(
   'pnpm run'
 );
 
+if (shrinkwrapUpdatedNotice) {
+  console.error('\n==> The shrinkwrap file has been updated.  Please commit the changes to Git:');
+  console.error(`  ${pnpmLockBeforePath}`);
+}
+
 console.log('\n\nFinished build.js');
 
 process.exitCode = 0;