Merge pull request microsoft#1819 from microsoft/sachinjoseph/normalizeChmodInTarHeader

iclanton · web-flow · commit 0584b2100d61 · 2020-04-07T22:36:10.000-07:00
Normalize chmod field in Tar header
diff --git a/apps/rush-lib/assets/rush-init/common/config/rush/experiments.json b/apps/rush-lib/assets/rush-init/common/config/rush/experiments.json
@@ -12,5 +12,11 @@
     * to temporarily restore the old behavior where everything must be rebuilt whenever pnpm-lock.json
     * is modified.
     */
-  /*[LINE "HYPOTHETICAL"]*/ "legacyIncrementalBuildDependencyDetection": true
+  /*[LINE "HYPOTHETICAL"]*/ "legacyIncrementalBuildDependencyDetection": true,
+
+  /**
+    * If true, the chmod field in temporary project tar headers will not be normalized.
+    * This normalization can help ensure consistent tarball integrity across platforms.
+    */
+  /*[LINE "HYPOTHETICAL"]*/ "noChmodFieldInTarHeaderNormalization": true
 }
diff --git a/apps/rush-lib/src/api/ExperimentsConfiguration.ts b/apps/rush-lib/src/api/ExperimentsConfiguration.ts
@@ -19,6 +19,12 @@ export interface IExperimentsJson {
    * instead of project-specific tracking.
    */
   legacyIncrementalBuildDependencyDetection?: boolean;
+
+  /**
+   * If true, the chmod field in temporary project tar headers will not be normalized.
+   * This normalization can help ensure consistent tarball integrity across platforms.
+   */
+  noChmodFieldInTarHeaderNormalization?: boolean;
 }
 
 /**
diff --git a/apps/rush-lib/src/logic/InstallManager.ts b/apps/rush-lib/src/logic/InstallManager.ts
@@ -744,11 +744,22 @@ export class InstallManager {
             noMtime: true,
             noPax: true,
             sync: true,
-            prefix: npmPackageFolder
+            prefix: npmPackageFolder,
+            filter: (path: string, stat: tar.FileStat): boolean => {
+              if (!this._rushConfiguration.experimentsConfiguration.configuration
+                .noChmodFieldInTarHeaderNormalization) {
+
+                stat.mode = (stat.mode & ~0x1FF) | PosixModeBits.AllRead | PosixModeBits.UserWrite
+                  | PosixModeBits.AllExecute;
+              }
+
+              return true;
+            }
           } as CreateOptions, [FileConstants.PackageJson]);
 
           console.log(`Updating ${tarballFile}`);
         } catch (error) {
+          console.log(colors.yellow(error));
           // delete everything in case of any error
           FileSystem.deleteFile(tarballFile);
           FileSystem.deleteFile(tempPackageJsonFilename);
@@ -1288,6 +1299,7 @@ export class InstallManager {
 
       // Ensure that Rush's tarball dependencies get synchronized properly with the pnpm-lock.yaml file.
       // See this GitHub issue: https://github.com/pnpm/pnpm/issues/1342
+
       if (semver.gte(this._rushConfiguration.packageManagerToolVersion, '3.0.0')) {
         args.push('--no-prefer-frozen-lockfile');
       } else {
diff --git a/apps/rush-lib/src/schemas/experiments.schema.json b/apps/rush-lib/src/schemas/experiments.schema.json
@@ -13,6 +13,11 @@
     "legacyIncrementalBuildDependencyDetection": {
       "description": "Rush 5.14.0 improved incremental builds to ignore spurious changes in the pnpm-lock.json file. This optimization is enabled by default. If you encounter a problem where \"rush build\" is neglecting to build some projects, please open a GitHub issue. As a workaround you can uncomment this line to temporarily restore the old behavior where everything must be rebuilt whenever pnpm-lock.json is modified.",
       "type": "boolean"
+    },
+
+    "noChmodFieldInTarHeaderNormalization": {
+      "description": "If true, the chmod field in temporary project tar headers will not be normalized. This normalization can help ensure consistent tarball integrity across platforms.",
+      "type": "boolean"
     }
   },
   "additionalProperties": false
diff --git a/common/changes/@microsoft/rush/sachinjoseph-normalizeChmodInTarHeader_2020-04-07-18-34.json b/common/changes/@microsoft/rush/sachinjoseph-normalizeChmodInTarHeader_2020-04-07-18-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Fix an issue where the common/temp/*.tgz files resulted in different shrinkwrap files on different operating systems",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush",
+  "email": "sachinjoseph@users.noreply.github.com"
+}
diff --git a/common/reviews/api/rush-lib.api.md b/common/reviews/api/rush-lib.api.md
@@ -134,6 +134,7 @@ export interface IConfigurationEnvironmentVariable {
 // @beta
 export interface IExperimentsJson {
     legacyIncrementalBuildDependencyDetection?: boolean;
+    noChmodFieldInTarHeaderNormalization?: boolean;
 }
 
 // @public

Original file line number	Diff line number	Diff line change
`@@ -134,6 +134,7 @@ export interface IConfigurationEnvironmentVariable {`
`134`	`134`	`// @beta`
`135`	`135`	`export interface IExperimentsJson {`
`136`	`136`	`legacyIncrementalBuildDependencyDetection?: boolean;`
	`137`	`+ noChmodFieldInTarHeaderNormalization?: boolean;`
`137`	`138`	`}`
`138`	`139`
`139`	`140`	`// @public`