refactor: update global variables and resolve dependency cycle issues

packages/vscode-extension/src/codeLensProvider.ts

@@ -21,7 +21,7 @@ import isUUID from "validator/lib/isUUID";
 import * as vscode from "vscode";
 import { environmentVariableRegex } from "./constants";
 import { commandIsRunning } from "./globalVariables";
-import { getSystemInputs } from "./handlers";
+import { getSystemInputs } from "./utils/environmentUtils";
 import { TelemetryTriggerFrom } from "./telemetry/extTelemetryEvents";
 import { localize } from "./utils/localizeUtils";
 import * as _ from "lodash";

packages/vscode-extension/src/commonlib/azureLogin.ts

@@ -29,7 +29,7 @@ import {
   AccountType,
   TelemetryErrorType,
 } from "../telemetry/extTelemetryEvents";
-import { VS_CODE_UI } from "../extension";
+import { VS_CODE_UI } from "../qm/vsc_ui";
 import { AzureScopes, globalStateGet, globalStateUpdate } from "@microsoft/teamsfx-core";
 import { getDefaultString, localize } from "../utils/localizeUtils";
 import {

packages/vscode-extension/src/commonlib/telemetry.ts

@@ -1,23 +1,18 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 import * as vscode from "vscode";
+import * as os from "os";
+import * as path from "path";
 // eslint-disable-next-line import/default
 import Reporter from "@vscode/extension-telemetry";
 import { TelemetryReporter, ConfigFolderName } from "@microsoft/teamsfx-api";
-import {
-  getAllFeatureFlags,
-  getPackageVersion,
-  isFeatureFlagEnabled,
-  FeatureFlags,
-  anonymizeFilePaths,
-} from "../utils/commonUtils";
+import { anonymizeFilePaths } from "../utils/fileSystemUtils";
+import { isFeatureFlagEnabled, FeatureFlags, getAllFeatureFlags } from "../featureFlags";
+import { getPackageVersion } from "../utils/telemetryUtils";
 import { TelemetryProperty } from "../telemetry/extTelemetryEvents";
-import { getProjectMetadata } from "@microsoft/teamsfx-core";
-import { Correlator } from "@microsoft/teamsfx-core";
+import { Correlator, getProjectMetadata } from "@microsoft/teamsfx-core";
 import { configure, getLogger, Logger } from "log4js";
-import * as os from "os";
-import * as path from "path";
-import * as globalVariables from "../globalVariables";
+import { workspaceUri } from "../globalVariables";
 
 const TelemetryTestLoggerFile = "telemetryTest.log";
 
@@ -176,7 +171,7 @@ export class VSCodeTelemetryReporter extends vscode.Disposable implements Teleme
 
   private checkAndOverwriteSharedProperty(properties: { [p: string]: string }) {
     if (!properties[TelemetryProperty.ProjectId]) {
-      const fixedProjectSettings = getProjectMetadata(globalVariables.workspaceUri?.fsPath);
+      const fixedProjectSettings = getProjectMetadata(workspaceUri?.fsPath);
 
       if (fixedProjectSettings?.projectId) {
         properties[TelemetryProperty.ProjectId] = fixedProjectSettings?.projectId;

packages/vscode-extension/src/debug/commonUtils.ts

@@ -13,16 +13,11 @@ import {
 import * as fs from "fs-extra";
 import * as path from "path";
 import * as uuid from "uuid";
-import * as vscode from "vscode";
 import VsCodeLogInstance from "../commonlib/log";
-
-import * as globalVariables from "../globalVariables";
-import { core, getSystemInputs } from "../handlers";
+import { workspaceUri } from "../globalVariables";
 import { ExtTelemetry } from "../telemetry/extTelemetry";
 import { allRunningDebugSessions } from "./teamsfxTaskHandler";
-
 import { ExtensionErrors, ExtensionSource } from "../error";
-import { VS_CODE_UI } from "../extension";
 
 export async function getProjectRoot(
   folderPath: string,
@@ -40,10 +35,10 @@ export async function getNpmInstallLogInfo(): Promise<any> {
 
 export async function getTestToolLogInfo(): Promise<string | undefined> {
   const localEnvManager = new LocalEnvManager(VsCodeLogInstance, ExtTelemetry.reporter);
-  if (!globalVariables.workspaceUri?.fsPath) {
+  if (!workspaceUri?.fsPath) {
     return undefined;
   }
-  return await localEnvManager.getTestToolLogInfo(globalVariables.workspaceUri?.fsPath);
+  return await localEnvManager.getTestToolLogInfo(workspaceUri?.fsPath);
 }
 
 export class LocalDebugSession {
@@ -137,7 +132,7 @@ export async function getV3TeamsAppId(projectPath: string, env: string): Promise
 }
 
 export async function getTeamsAppKeyName(env?: string): Promise<string | undefined> {
-  const templatePath = pathUtils.getYmlFilePath(globalVariables.workspaceUri!.fsPath, env);
+  const templatePath = pathUtils.getYmlFilePath(workspaceUri!.fsPath, env);
   const maybeProjectModel = await metadataUtil.parse(templatePath, env);
   if (maybeProjectModel.isErr()) {
     return undefined;
@@ -153,18 +148,6 @@ export async function getTeamsAppKeyName(env?: string): Promise<string | undefin
   return undefined;
 }
 
-export async function triggerV3Migration(): Promise<void> {
-  const inputs = getSystemInputs();
-  inputs.stage = Stage.debug;
-  const result = await core.phantomMigrationV3(inputs);
-  if (result.isErr()) {
-    await vscode.debug.stopDebugging();
-    throw result.error;
-  }
-  // reload window to terminate debugging
-  await VS_CODE_UI.reload();
-}
-
 // Only work in ts/js project
 export function isTestToolEnabledProject(workspacePath: string): boolean {
   const testToolYmlPath = path.join(workspacePath, MetadataV3.testToolConfigFile);

packages/vscode-extension/src/debug/launch.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { VS_CODE_UI } from "../extension";
+import { VS_CODE_UI } from "../qm/vsc_ui";
 import * as constants from "./constants";
 import VsCodeLogInstance from "../commonlib/log";
 import { Hub } from "@microsoft/teamsfx-core";

packages/vscode-extension/src/debug/prerequisitesHandler.ts

@@ -41,9 +41,9 @@ import { signedOut } from "../commonlib/common/constant";
 import VsCodeLogInstance from "../commonlib/log";
 import M365TokenInstance from "../commonlib/m365Login";
 import { ExtensionErrors, ExtensionSource } from "../error";
-import { VS_CODE_UI } from "../extension";
-import * as globalVariables from "../globalVariables";
-import { checkCopilotCallback, openAccountHelpHandler, tools } from "../handlers";
+import { VS_CODE_UI } from "../qm/vsc_ui";
+import { tools, workspaceUri } from "../globalVariables";
+import { checkCopilotCallback, openAccountHelpHandler } from "../handlers";
 import { ProgressHandler } from "../progressHandler";
 import { ExtTelemetry } from "../telemetry/extTelemetry";
 import { TelemetryEvent, TelemetryProperty } from "../telemetry/extTelemetryEvents";
@@ -621,7 +621,7 @@ async function checkNode(
       try {
         VsCodeLogInstance.outputChannel.appendLine(`${prefix} ${ProgressMessage[nodeDep]} ...`);
         const nodeStatus = await depsManager.ensureDependency(nodeDep, true, {
-          projectPath: globalVariables.workspaceUri?.fsPath,
+          projectPath: workspaceUri?.fsPath,
         });
         return {
           checker: nodeStatus.name,
@@ -790,7 +790,7 @@ async function checkFailure(
 }
 
 function getOrderedCheckersForGetStarted(): PrerequisiteOrderedChecker[] {
-  const workspacePath = globalVariables.workspaceUri?.fsPath;
+  const workspacePath = workspaceUri?.fsPath;
   return [
     {
       info: { checker: workspacePath ? DepsType.ProjectNode : DepsType.LtsNode },

packages/vscode-extension/src/debug/taskTerminal/devTunnelTaskTerminal.ts

@@ -19,15 +19,15 @@ import { TaskDefaultValue, TunnelType } from "@microsoft/teamsfx-core";
 
 import VsCodeLogInstance from "../../commonlib/log";
 import { ExtensionErrors } from "../../error";
-import { VS_CODE_UI } from "../../extension";
-import { tools } from "../../handlers";
+import { VS_CODE_UI } from "../../qm/vsc_ui";
+import { tools } from "../../globalVariables";
 import { ExtTelemetry } from "../../telemetry/extTelemetry";
 import {
   TelemetryEvent,
   TelemetryProperty,
   TelemetrySuccess,
 } from "../../telemetry/extTelemetryEvents";
-import { FeatureFlags, isFeatureFlagEnabled } from "../../utils/commonUtils";
+import { FeatureFlags, isFeatureFlagEnabled } from "../../featureFlags";
 import { devTunnelDisplayMessages } from "../constants";
 import { maskValue } from "../localTelemetryReporter";
 import { BaseTaskTerminal } from "./baseTaskTerminal";

packages/vscode-extension/src/debug/taskTerminal/launchDesktopClientTerminal.ts

@@ -13,7 +13,8 @@ import { TelemetryEvent, TelemetryProperty } from "../../telemetry/extTelemetryE
 import { ExtensionErrors, ExtensionSource } from "../../error";
 import { getDefaultString, localize } from "../../utils/localizeUtils";
 import { openTerminalDisplayMessage, openTerminalMessage } from "../constants";
-import { core, getSystemInputs } from "../../handlers";
+import { getSystemInputs } from "../../utils/environmentUtils";
+import { core } from "../../globalVariables";
 import * as path from "path";
 
 interface LaunchDesktopClientArgs {

packages/vscode-extension/src/debug/taskTerminal/launchTeamsClientTerminal.ts

@@ -13,8 +13,8 @@ import * as util from "util";
 import * as vscode from "vscode";
 import VsCodeLogInstance from "../../commonlib/log";
 import { ExtensionErrors, ExtensionSource } from "../../error";
-import * as globalVariables from "../../globalVariables";
-import { core, getSystemInputs } from "../../handlers";
+import { core, workspaceUri } from "../../globalVariables";
+import { getSystemInputs } from "../../utils/environmentUtils";
 import { TelemetryEvent, TelemetryProperty } from "../../telemetry/extTelemetryEvents";
 import { getDefaultString, localize } from "../../utils/localizeUtils";
 import { getLocalDebugSession } from "../commonUtils";
@@ -89,7 +89,7 @@ export class LaunchTeamsClientTerminal extends BaseTaskTerminal {
   private openUrl(url: string): Promise<Result<Void, FxError>> {
     return new Promise<Result<Void, FxError>>((resolve) => {
       const options: cp.SpawnOptions = {
-        cwd: globalVariables.workspaceUri?.fsPath ?? "",
+        cwd: workspaceUri?.fsPath ?? "",
         shell: false,
         detached: false,
       };

packages/vscode-extension/src/debug/taskTerminal/lifecycleTaskTerminal.ts

@@ -1,21 +1,20 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
 /**
  * @author Xiaofu Huang <[email protected]>
  */
 import * as path from "path";
 import * as vscode from "vscode";
 import { err, FxError, ok, Result, Stage, Void } from "@microsoft/teamsfx-api";
-import { TaskDefaultValue } from "@microsoft/teamsfx-core";
-import { Correlator } from "@microsoft/teamsfx-core";
-import * as globalVariables from "../../globalVariables";
-import { getSystemInputs, runCommand } from "../../handlers";
+import { Correlator, TaskDefaultValue } from "@microsoft/teamsfx-core";
+import { workspaceUri } from "../../globalVariables";
+import { runCommand } from "../../handlers";
 import { TelemetryEvent, TelemetryProperty } from "../../telemetry/extTelemetryEvents";
-import * as commonUtils from "../commonUtils";
+import { getLocalDebugSession } from "../commonUtils";
 import { localTelemetryReporter, maskValue } from "../localTelemetryReporter";
 import { BaseTaskTerminal } from "./baseTaskTerminal";
+import { getSystemInputs } from "../../utils/environmentUtils";
 
 interface LifecycleArgs {
   template?: string;
@@ -43,7 +42,7 @@ export class LifecycleTaskTerminal extends BaseTaskTerminal {
       [TelemetryProperty.DebugLifecycle]: this.stage,
     };
 
-    return Correlator.runWithId(commonUtils.getLocalDebugSession().id, () =>
+    return Correlator.runWithId(getLocalDebugSession().id, () =>
       localTelemetryReporter.runWithTelemetryProperties(
         TelemetryEvent.DebugLifecycleTask,
         telemetryProperties,
@@ -66,7 +65,7 @@ export class LifecycleTaskTerminal extends BaseTaskTerminal {
     inputs.isLocalDebug = true;
     if (this.args.template) {
       inputs.workflowFilePath = path.resolve(
-        globalVariables.workspaceUri?.fsPath ?? "",
+        workspaceUri?.fsPath ?? "",
         BaseTaskTerminal.resolveTeamsFxVariables(this.args.template)
       );
     }

packages/vscode-extension/src/debug/taskTerminal/migrateTaskTerminal.ts

@@ -1,21 +1,19 @@
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
 
 import * as vscode from "vscode";
 
 import { FxError, ok, Result, Void } from "@microsoft/teamsfx-api";
-import * as commonUtils from "../commonUtils";
 import { BaseTaskTerminal } from "./baseTaskTerminal";
+import { triggerV3Migration } from "../../utils/migrationUtils";
 
 export class MigrateTaskTerminal extends BaseTaskTerminal {
   constructor(taskDefinition: vscode.TaskDefinition) {
     super(taskDefinition);
   }
 
   async do(): Promise<Result<Void, FxError>> {
-    await commonUtils.triggerV3Migration();
+    await triggerV3Migration();
     return ok(Void);
   }
 }

packages/vscode-extension/src/debug/taskTerminal/utils/devTunnelStateManager.ts

@@ -9,8 +9,8 @@ import { Mutex, withTimeout } from "async-mutex";
 import * as fs from "fs-extra";
 import * as path from "path";
 import { isFeatureFlagEnabled } from "@microsoft/teamsfx-core";
-import * as globalVariables from "../../../globalVariables";
-import { FeatureFlags } from "../../../utils/commonUtils";
+import { context, workspaceUri } from "../../../globalVariables";
+import { FeatureFlags } from "../../../featureFlags";
 
 interface IDevTunnelState {
   tunnelId?: string;
@@ -91,25 +91,23 @@ interface IStateService {
 class VSCodeStateService implements IStateService {
   get<T>(key: string): Promise<T | undefined> {
     return new Promise((resolve) => {
-      resolve(globalVariables.context.workspaceState.get<T>(key));
+      resolve(context.workspaceState.get<T>(key));
     });
   }
 
   async update(key: string, value: any): Promise<void> {
-    await globalVariables.context.workspaceState.update(key, value);
+    await context.workspaceState.update(key, value);
   }
 }
 
 class FileStateService implements IStateService {
   private readonly stateFileName = "devtunnel.state.json";
   async get<T>(key: string): Promise<T | undefined> {
     try {
-      if (!globalVariables.workspaceUri?.fsPath) {
+      if (!workspaceUri?.fsPath) {
         return undefined;
       }
-      const data = await fs.readJson(
-        path.resolve(globalVariables.workspaceUri.fsPath, this.stateFileName)
-      );
+      const data = await fs.readJson(path.resolve(workspaceUri.fsPath, this.stateFileName));
 
       return data?.[key] as T;
     } catch {
@@ -119,10 +117,10 @@ class FileStateService implements IStateService {
 
   async update(key: string, value: any): Promise<void> {
     try {
-      if (!globalVariables.workspaceUri?.fsPath) {
+      if (!workspaceUri?.fsPath) {
         return;
       }
-      const stateFilePath = path.resolve(globalVariables.workspaceUri.fsPath, this.stateFileName);
+      const stateFilePath = path.resolve(workspaceUri.fsPath, this.stateFileName);
       let data: { [key: string]: any } = {};
       try {
         data = await fs.readJson(stateFilePath);

packages/vscode-extension/src/debug/teamsfxDebugProvider.ts

@@ -18,12 +18,15 @@ import {
 import VsCodeLogInstance from "../commonlib/log";
 import M365TokenInstance from "../commonlib/m365Login";
 import { ExtensionSource } from "../error";
-import { core, getSystemInputs, showError } from "../handlers";
+import { showError } from "../handlers";
+import { core } from "../globalVariables";
 import { TelemetryEvent, TelemetryProperty } from "../telemetry/extTelemetryEvents";
-import * as commonUtils from "./commonUtils";
+import { getLocalDebugSessionId, endLocalDebugSession } from "./commonUtils";
 import { accountHintPlaceholder, Host, sideloadingDisplayMessages } from "./constants";
 import { localTelemetryReporter, sendDebugAllEvent } from "./localTelemetryReporter";
 import { terminateAllRunningTeamsfxTasks } from "./teamsfxTaskHandler";
+import { triggerV3Migration } from "../utils/migrationUtils";
+import { getSystemInputs } from "../utils/environmentUtils";
 
 export interface TeamsfxDebugConfiguration extends vscode.DebugConfiguration {
   teamsfxIsRemote?: boolean;
@@ -40,7 +43,7 @@ export class TeamsfxDebugProvider implements vscode.DebugConfigurationProvider {
     token?: vscode.CancellationToken
   ): Promise<vscode.DebugConfiguration | undefined> {
     return await Correlator.runWithId(
-      commonUtils.getLocalDebugSessionId(),
+      getLocalDebugSessionId(),
       this._resolveDebugConfiguration,
       folder,
       debugConfiguration,
@@ -69,7 +72,7 @@ export class TeamsfxDebugProvider implements vscode.DebugConfigurationProvider {
 
       // migrate to v3
       if (!isValidProjectV3(folder.uri.fsPath)) {
-        await commonUtils.triggerV3Migration();
+        await triggerV3Migration();
         return debugConfiguration;
       }
 
@@ -121,7 +124,7 @@ export class TeamsfxDebugProvider implements vscode.DebugConfigurationProvider {
 
       // Attach correlation-id to DebugConfiguration so concurrent debug sessions are correctly handled in this stage.
       // For backend and bot debug sessions, debugConfiguration.url is undefined so we need to set correlation id early.
-      debugConfiguration.teamsfxCorrelationId = commonUtils.getLocalDebugSessionId();
+      debugConfiguration.teamsfxCorrelationId = getLocalDebugSessionId();
 
       const result = await localTelemetryReporter.runWithTelemetryExceptionProperties(
         TelemetryEvent.DebugProviderResolveDebugConfiguration,
@@ -197,7 +200,7 @@ export class TeamsfxDebugProvider implements vscode.DebugConfigurationProvider {
       if (telemetryIsRemote === false) {
         await sendDebugAllEvent(error);
       }
-      commonUtils.endLocalDebugSession();
+      endLocalDebugSession();
     }
     return debugConfiguration;
   }

packages/vscode-extension/src/debug/teamsfxTaskHandler.ts

@@ -17,7 +17,7 @@ import {
 
 import VsCodeLogInstance from "../commonlib/log";
 import { ExtensionErrors, ExtensionSource } from "../error";
-import { VS_CODE_UI } from "../extension";
+import { VS_CODE_UI } from "../qm/vsc_ui";
 import * as globalVariables from "../globalVariables";
 import {
   TelemetryEvent,