Merge pull request #14276 from OfficeDev/qinzhouxu/link

fix: symbol link creation issue for test tool install

Author: wh-alice

.github/workflows/env-checker-ci-pr.yml

@@ -33,7 +33,7 @@ jobs:
       ## Details about this issue: https://github.com/npm/cli/wiki/%22cb()-never-called%3F--I'm-having-the-same-problem!%22
       ### tl;dr: This error is not one thing, but a category of errors. It means "something broke and we didn't have a way to catch it". We will always need a lot of detail to reproduce an error like this, or we cannot ever fix it. Every instance is unique, and your cb() never called is nothing like any other.
       matrix:
-        os: [windows-latest, macos-11, ubuntu-latest]
+        os: [windows-latest, macos-latest, ubuntu-latest]
         node-version: [18]
         func-version: [none]
         dotnet-version: [none]

.github/workflows/env-checker-ci-schedule.yml

@@ -19,7 +19,7 @@ jobs:
       ### tl;dr: This error is not one thing, but a category of errors. It means "something broke and we didn't have a way to catch it". We will always need a lot of detail to reproduce an error like this, or we cannot ever fix it. Every instance is unique, and your cb() never called is nothing like any other.
       # macos-latest is 10.15. We need to test 11 as well.
       matrix:
-        os: [windows-latest, macos-latest, macos-11, ubuntu-latest]
+        os: [windows-latest, macos-latest, ubuntu-latest]
         node-version: [16, 18, 20]
         func-version: [none, "3", "4", "4.0.4670", "~4.0.5174"]
       max-parallel: 30

packages/fx-core/src/component/deps-checker/internal/testToolChecker.ts

@@ -81,7 +81,7 @@ export class TestToolChecker implements DepsChecker {
       } else {
         this.telemetryProperties[TelemetryProperties.SymlinkTestToolVersionError] =
           versionRes.error.message;
-        await unlinkSymlink(symlinkDir);
+        await unlinkSymlink(symlinkDir, true);
       }
     }
 
@@ -97,7 +97,7 @@ export class TestToolChecker implements DepsChecker {
       );
       this.telemetryProperties[TelemetryProperties.SelectedPortableTestToolVersion] = version;
       if (symlinkDir) {
-        await createSymlink(portablePath, symlinkDir);
+        await createSymlink(portablePath, symlinkDir, true);
         return await this.getSuccessDepsInfo(version, symlinkDir);
       } else {
         return await this.getSuccessDepsInfo(version, portablePath);
@@ -200,7 +200,7 @@ export class TestToolChecker implements DepsChecker {
     await rename(tmpPath, portablePath);
 
     if (symlinkDir) {
-      await createSymlink(portablePath, symlinkDir);
+      await createSymlink(portablePath, symlinkDir, true);
     }
 
     await this.writeInstallInfoFile(projectPath);

packages/fx-core/src/component/deps-checker/util/fileHelper.ts

@@ -9,11 +9,16 @@ import { v3DefaultHelpLink } from "../constant/helpLink";
 import { Messages } from "../constant/message";
 import { DepsCheckerError } from "../../../error/depCheck";
 
-export async function unlinkSymlink(linkFilePath: string): Promise<void> {
+export async function unlinkSymlink(linkFilePath: string, forceUpdate = false): Promise<void> {
   try {
     const stat = await fs.lstat(linkFilePath);
     if (stat.isSymbolicLink()) {
       await fs.unlink(linkFilePath);
+    } else {
+      if (forceUpdate) {
+        // For regular file or directory, remove it
+        await fs.remove(linkFilePath);
+      }
     }
   } catch (error: unknown) {
     const statError = error as { code?: string };
@@ -23,8 +28,12 @@ export async function unlinkSymlink(linkFilePath: string): Promise<void> {
   }
 }
 
-export async function createSymlink(target: string, linkFilePath: string): Promise<void> {
-  await unlinkSymlink(linkFilePath);
+export async function createSymlink(
+  target: string,
+  linkFilePath: string,
+  forceUpdate = false
+): Promise<void> {
+  await unlinkSymlink(linkFilePath, forceUpdate);
   // check if destination already exists
   if (await fs.pathExists(linkFilePath)) {
     throw new DepsCheckerError(Messages.symlinkDirAlreadyExist(linkFilePath), v3DefaultHelpLink);