fix: bug 27332508: disable auto install dependencies for manifest-only office add-in

packages/fx-core/src/common/projectSettingsHelper.ts

@@ -80,6 +80,12 @@ export function isValidOfficeAddInProject(workspacePath?: string): boolean {
   }
 }
 
+export function isManifestOnlyOfficeAddinProject(workspacePath?: string): boolean {
+  if (!workspacePath) return false;
+  const srcPath = path.join(workspacePath, "src");
+  return !fs.existsSync(srcPath);
+}
+
 export function fetchManifestList(
   workspacePath?: string,
   officeManifestType?: OfficeManifestType

packages/fx-core/tests/common/officeAddInProjectSetting.test.ts

@@ -152,4 +152,11 @@ describe("fetchManifestList", () => {
       )
       .to.deep.equal(["manifest.json"]);
   });
+
+  it("should return true when no src folder exists", () => {
+    mockFs({
+      "/test/manifest.xml": "",
+    });
+    chai.expect(projectSettingsHelper.isManifestOnlyOfficeAddinProject("/test")).to.be.true;
+  });
 });

packages/vscode-extension/package.json

@@ -751,7 +751,7 @@
       {
         "command": "fx-extension.localdebug",
         "title": "%teamstoolkit.commands.localDebug.title%",
-        "enablement": "!fx-extension.commandLocked",
+        "enablement": "!fx-extension.commandLocked && !fx-extension.isManifestOnlyOfficeAddIn",
         "category": "Teams"
       },
       {
@@ -888,6 +888,11 @@
         "title": "%teamstoolkit.commands.feedbackLink.title%",
         "icon": "$(info)"
       },
+      {
+        "command": "fx-extension.stopDebugging",
+        "title": "%teamstoolkit.commandsTreeViewProvider.officeAddIn.stopDebugTitle%",
+        "enablement": "fx-extension.isOfficeAddIn && !fx-extension.isManifestOnlyOfficeAddIn"
+      },
       {
         "command": "fx-extension.invokeChat",
         "title": "%teamstoolkit.commandsTreeViewProvider.getCopilotHelpTitle%",

packages/vscode-extension/src/extension.ts

@@ -66,6 +66,7 @@ import {
   isOfficeAddInProject,
   isSPFxProject,
   isTeamsFxProject,
+  isOfficeManifestOnlyProject,
   setUriEventHandler,
   unsetIsTeamsFxProject,
   workspaceUri,
@@ -147,6 +148,12 @@ export async function activate(context: vscode.ExtensionContext) {
     isOfficeAddInProject
   );
 
+  await vscode.commands.executeCommand(
+    "setContext",
+    "fx-extension.isManifestOnlyOfficeAddIn",
+    isOfficeManifestOnlyProject
+  );
+
   void VsCodeLogInstance.info("Teams Toolkit extension is now active!");
 
   // Don't wait this async method to let it run in background.

packages/vscode-extension/src/globalVariables.ts

@@ -6,7 +6,11 @@ import * as path from "path";
 import * as vscode from "vscode";
 import { UserState } from "./constants";
 import { UriHandler } from "./uriHandler";
-import { isValidProject, isValidOfficeAddInProject } from "@microsoft/teamsfx-core";
+import {
+  isValidProject,
+  isValidOfficeAddInProject,
+  isManifestOnlyOfficeAddinProject,
+} from "@microsoft/teamsfx-core";
 
 /**
  * Common variables used throughout the extension. They must be initialized in the activate() method of extension.ts
@@ -15,6 +19,7 @@ export let context: vscode.ExtensionContext;
 export let workspaceUri: vscode.Uri | undefined;
 export let isTeamsFxProject = false;
 export let isOfficeAddInProject = false;
+export let isOfficeManifestOnlyProject = false;
 export let isSPFxProject = false;
 export let isExistingUser = "no";
 export let uriEventHandler: UriHandler;
@@ -32,6 +37,9 @@ export function initializeGlobalVariables(ctx: vscode.ExtensionContext): void {
   isExistingUser = context.globalState.get<string>(UserState.IsExisting) || "no";
   isTeamsFxProject = isValidProject(workspaceUri?.fsPath);
   isOfficeAddInProject = isValidOfficeAddInProject(workspaceUri?.fsPath);
+  if (isOfficeAddInProject) {
+    isOfficeManifestOnlyProject = isManifestOnlyOfficeAddinProject(workspaceUri?.fsPath);
+  }
   // Default Extension log path
   // e.g. C:/Users/xx/AppData/Roaming/Code/logs/20230221T095340/window7/exthost/TeamsDevApp.ms-teams-vscode-extension
   defaultExtensionLogPath = ctx.logUri.fsPath;

packages/vscode-extension/src/officeDevHandlers.ts

@@ -7,7 +7,11 @@
 "use strict";
 
 import { FxError, Result, Warning, ok } from "@microsoft/teamsfx-api";
-import { globalStateGet, globalStateUpdate } from "@microsoft/teamsfx-core";
+import {
+  globalStateGet,
+  globalStateUpdate,
+  isManifestOnlyOfficeAddinProject,
+} from "@microsoft/teamsfx-core";
 import * as fs from "fs-extra";
 import * as path from "path";
 import * as vscode from "vscode";
@@ -248,12 +252,14 @@ export async function autoOpenOfficeDevProjectHandler(): Promise<void> {
     await globalStateUpdate(GlobalKey.OpenSampleReadMe, false);
   }
   if (autoInstallDependency) {
-    void popupOfficeAddInDependenciesMessage();
+    if (!isManifestOnlyOfficeAddinProject(globalVariables.workspaceUri?.fsPath ?? ""))
+      void popupOfficeAddInDependenciesMessage();
     await globalStateUpdate(GlobalKey.AutoInstallDependency, false);
   }
   if (
     globalVariables.isOfficeAddInProject &&
-    !checkOfficeAddInInstalled(globalVariables.workspaceUri?.fsPath ?? "")
+    !checkOfficeAddInInstalled(globalVariables.workspaceUri?.fsPath ?? "") &&
+    !isManifestOnlyOfficeAddinProject(globalVariables.workspaceUri?.fsPath ?? "")
   ) {
     void popupOfficeAddInDependenciesMessage();
   }

packages/vscode-extension/test/extension/officeDevHandler.test.ts

@@ -15,6 +15,8 @@ import { generateManifestGUID, stopOfficeAddInDebug } from "../../src/officeDevH
 import { VsCodeUI } from "../../src/qm/vsc_ui";
 import { ExtTelemetry } from "../../src/telemetry/extTelemetry";
 import * as localizeUtils from "../../src/utils/localizeUtils";
+import * as teamsfxCore from "@microsoft/teamsfx-core";
+import * as projectSettingsHelper from "@microsoft/teamsfx-core/build/common/projectSettingsHelper";
 
 describe("officeDevHandler", () => {
   const sandbox = sinon.createSandbox();
@@ -227,6 +229,9 @@ describe("autoOpenOfficeDevProjectHandler", () => {
         return Promise.resolve("No" as any);
       });
     const globalStateUpdateStub = sandbox.stub(globalState, "globalStateUpdate");
+    const isManifestOnlyOfficeAddinProjectStub = sandbox
+      .stub(projectSettingsHelper, "isManifestOnlyOfficeAddinProject")
+      .returns(false);
 
     await officeDevHandlers.autoOpenOfficeDevProjectHandler();
 
@@ -248,6 +253,10 @@ describe("autoOpenOfficeDevProjectHandler", () => {
         return Promise.resolve(option);
       });
 
+    const isManifestOnlyOfficeAddinProjectStub = sandbox
+      .stub(projectSettingsHelper, "isManifestOnlyOfficeAddinProject")
+      .returns(false);
+
     await officeDevHandlers.autoOpenOfficeDevProjectHandler();
 
     chai.assert(autoInstallDependencyHandlerStub.calledOnce);