Merge pull request #10013 from OfficeDev/aochengwang/fix-auto-update

fix: corner cases for npm view command
OfficeDev · Nov 3, 2023 · 8dfdd50 · 8dfdd50
2 parents ac51cf0 + d6ac5e8
commit 8dfdd50
Show file tree

Hide file tree

Showing 2 changed files with 95 additions and 1 deletion.
diff --git a/packages/fx-core/src/common/deps-checker/internal/testToolChecker.ts b/packages/fx-core/src/common/deps-checker/internal/testToolChecker.ts
@@ -172,8 +172,14 @@ export class TestToolChecker implements DepsChecker {
         "version",
         "--json"
       );
-      const versionList: string[] = JSON.parse(result);
+      // when there are one result, it will return string
+      // when there are multiple results, it will return array of strings
+      let versionList: string[] | string = JSON.parse(result);
+      if (typeof versionList === "string") {
+        versionList = [versionList];
+      }
       if (!Array.isArray(versionList)) {
+        // do update if npm returned invalid result
         return true;
       }
       return versionList.filter((v) => semver.gt(v, latestInstalledVersion)).length > 0;

diff --git a/packages/fx-core/tests/common/deps-checker/testToolChecker.test.ts b/packages/fx-core/tests/common/deps-checker/testToolChecker.test.ts
@@ -44,6 +44,7 @@ interface EnvironmentInfo {
   testToolVersionBeforeInstall?: string;
   testToolVersionAfterInstall?: string;
   installSuccess?: boolean;
+  npmViewResult?: string;
 }
 
 // output
@@ -99,6 +100,11 @@ function mockEnvironment(sandbox: sinon.SinonSandbox, info: EnvironmentInfo): En
         } else {
           throw new Error("failed to npm install");
         }
+      } else if (command === "npm" && args.includes("view")) {
+        if (info.npmViewResult === undefined) {
+          throw new Error("fail to npm view");
+        }
+        return info.npmViewResult;
       }
       throw new Error("Command not mocked");
     });
@@ -579,6 +585,88 @@ describe("Test Tool Checker Test", () => {
       expect(npmInstalled).to.be.true;
       expect(checkedUpdate).to.be.true;
     });
+    it("Already installed, symlink created, needs to check update but has multiple recent versions, should use latest", async () => {
+      const checker = new TestToolChecker();
+      const symlinkDir = "symlinkDir";
+      const versionRange = "~1.2.3";
+      let npmInstalled = false;
+      let checkedUpdate = false;
+      const homePortableDir = path.join(homePortablesDir, "1.2.3");
+      const homePortableExec = path.join(homePortableDir, "node_modules", ".bin", "teamsapptester");
+      sandbox.stub(fileHelper, "rename").resolves();
+      sandbox.stub(fileHelper, "createSymlink").resolves();
+      mockfs({
+        [path.join(projectPath, "devTools", ".testTool.installInfo.json")]: "",
+        [homePortableExec]: "",
+      });
+      let installedVersion = "1.2.3";
+      sandbox
+        .stub(cpUtils, "executeCommand")
+        .callsFake(async (_cwd, _logger, _options, command, ...args) => {
+          if (args.includes("--version")) {
+            if (command === "node") return "v18.16.1";
+            if (command === "npm") return "9.7.0";
+            return installedVersion;
+          } else if (args.includes("install")) {
+            installedVersion = "1.2.4";
+            npmInstalled = true;
+          } else if (args.includes("view")) {
+            checkedUpdate = true;
+            return '"1.2.3"';
+          }
+          return "";
+        });
+      // Act
+      const status = await checker.resolve({ projectPath, symlinkDir, versionRange });
+      // Assert
+      expect(status.isInstalled).to.be.true;
+      expect(status.details.binFolders).not.empty;
+      expect(status.error).to.be.undefined;
+      expect(status.details.installVersion).to.eq("1.2.3");
+      expect(npmInstalled).to.be.false;
+      expect(checkedUpdate).to.be.true;
+    });
+    it("Already installed, symlink created, needs to check update but has multiple recent versions, should use latest", async () => {
+      const checker = new TestToolChecker();
+      const symlinkDir = "symlinkDir";
+      const versionRange = "~1.2.3";
+      let npmInstalled = false;
+      let checkedUpdate = false;
+      const homePortableDir = path.join(homePortablesDir, "1.2.3");
+      const homePortableExec = path.join(homePortableDir, "node_modules", ".bin", "teamsapptester");
+      sandbox.stub(fileHelper, "rename").resolves();
+      sandbox.stub(fileHelper, "createSymlink").resolves();
+      mockfs({
+        [path.join(projectPath, "devTools", ".testTool.installInfo.json")]: "",
+        [homePortableExec]: "",
+      });
+      let installedVersion = "1.2.3";
+      sandbox
+        .stub(cpUtils, "executeCommand")
+        .callsFake(async (_cwd, _logger, _options, command, ...args) => {
+          if (args.includes("--version")) {
+            if (command === "node") return "v18.16.1";
+            if (command === "npm") return "9.7.0";
+            return installedVersion;
+          } else if (args.includes("install")) {
+            installedVersion = "1.2.5";
+            npmInstalled = true;
+          } else if (args.includes("view")) {
+            checkedUpdate = true;
+            return '["1.2.4", "1.2.5"]';
+          }
+          return "";
+        });
+      // Act
+      const status = await checker.resolve({ projectPath, symlinkDir, versionRange });
+      // Assert
+      expect(status.isInstalled).to.be.true;
+      expect(status.details.binFolders).not.empty;
+      expect(status.error).to.be.undefined;
+      expect(status.details.installVersion).to.eq("1.2.5");
+      expect(npmInstalled).to.be.true;
+      expect(checkedUpdate).to.be.true;
+    });
     it("Already installed, symlink created, needs to check update but update failed", async () => {
       const checker = new TestToolChecker();
       const symlinkDir = "symlinkDir";