Merge branch 'main' into pr/AddLinux2

Author: dannyvv

change/change-7324aa9b-6d75-44b9-8c59-50d17a8fc0ba.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "type": "minor",
+      "comment": "Make file writes only when required",
+      "packageName": "ado-npm-auth",
+      "email": "dannyvv@microsoft.com",
+      "dependentChangeType": "patch"
+    }
+  ]
+}

packages/ado-npm-auth/src/npmrc/npmrcFileProvider.ts

@@ -11,6 +11,7 @@ import { getOrganizationFromFeedUrl } from "../utils/get-organization-from-feed-
 import { getFeedWithoutProtocol } from "../utils/get-feed-without-protocol.js";
 import { fromBase64, toBase64 } from "../utils/encoding.js";
 import path from "node:path";
+import { writeFileLazy } from "../utils/fileUtils.js";
 
 export class NpmrcFileProvider extends FileProvider {
   constructor(configFile?: string) {
@@ -26,10 +27,10 @@ export class NpmrcFileProvider extends FileProvider {
         .split(EOL)
         .filter((line) => !line.includes("registry="))
         .join(EOL);
-      await fs.writeFile(this.userFilePath, updatedNpmrcContent);
+      await writeFileLazy(this.userFilePath, updatedNpmrcContent);
     } catch (error) {
       // user npmrc does not exist so make an empty one
-      await fs.writeFile(this.userFilePath, "");
+      await writeFileLazy(this.userFilePath, "");
     }
   }
 

packages/ado-npm-auth/src/utils/fileUtils.ts

@@ -0,0 +1,17 @@
+import fs from "node:fs/promises";
+
+export async function writeFileLazy(
+  path: string,
+  content: string,
+): Promise<void> {
+  try {
+    const existingContent = await fs.readFile(path, { encoding: "utf-8" });
+    if (existingContent === content) {
+      // File already up to date, no need to write out content
+      return;
+    }
+  } catch (e) {}
+
+  await fs.writeFile(path, content, { encoding: "utf-8" });
+  return;
+}

packages/ado-npm-auth/src/yarnrc/yarnrcFileProvider.ts

@@ -4,6 +4,7 @@ import fs from "node:fs/promises";
 import { fromBase64, toBase64 } from "../utils/encoding.js";
 import { getOrganizationFromFeedUrl } from "../utils/get-organization-from-feed-url.js";
 import { getFeedWithoutProtocol } from "../utils/get-feed-without-protocol.js";
+import { writeFileLazy } from "../utils/fileUtils.js";
 
 export class YarnRcFileProvider extends FileProvider {
   constructor(configFile?: string) {
@@ -21,7 +22,7 @@ export class YarnRcFileProvider extends FileProvider {
       }
     } catch (error) {
       // user .yarnrc file does not exist so make an empty one
-      await fs.writeFile(this.userFilePath, "");
+      await writeFileLazy(this.userFilePath, "");
     }
   }
 
@@ -102,7 +103,7 @@ export class YarnRcFileProvider extends FileProvider {
 
   async writeYarnRc(filePath: string, yarnrc: YarnRc) {
     const yarnrcContent = yaml.dump(yarnrc);
-    await fs.writeFile(filePath, yarnrcContent, "utf8");
+    await writeFileLazy(filePath, yarnrcContent);
   }
 
   async paseYarnRc(filePath: string): Promise<YarnRc> {