Add an API entry-point to the deployWorkspaceProject command

.vscode/settings.json

@@ -1,7 +1,7 @@
 {
     "editor.codeActionsOnSave": {
-        "source.fixAll.eslint": true,
-        "source.organizeImports": true
+        "source.fixAll.eslint": "explicit",
+        "source.organizeImports": "explicit"
     },
     "editor.formatOnSave": true,
     "editor.insertSpaces": true,

package.json

@@ -95,6 +95,11 @@
                 "title": "%containerApps.deployWorkspaceProject%",
                 "category": "Azure Container Apps"
             },
+            {
+                "command": "containerApps.deployWorkspaceProjectApi",
+                "title": "%containerApps.deployWorkspaceProjectApi%",
+                "category": "Azure Container Apps"
+            },
             {
                 "command": "containerApps.deployWorkspaceProjectToContainerApp",
                 "title": "%containerApps.deployWorkspaceProjectToContainerApp%",
@@ -503,6 +508,10 @@
                     "command": "containerApps.deployWorkspaceProjectToContainerApp",
                     "when": "never"
                 },
+                {
+                    "command": "containerApps.deployWorkspaceProjectApi",
+                    "when": "never"
+                },
                 {
                     "command": "containerApps.deployImageApi",
                     "when": "never"
@@ -615,7 +624,7 @@
         "@azure/container-registry": "1.0.0-beta.5",
         "@azure/core-rest-pipeline": "1.10.3",
         "@azure/storage-blob": "^12.4.1",
-        "@microsoft/vscode-azext-azureutils": "^2.0.0",
+        "@microsoft/vscode-azext-azureutils": "^2.0.3",
         "@microsoft/vscode-azext-github": "^1.0.0",
         "@microsoft/vscode-azext-utils": "^2.1.5",
         "@microsoft/vscode-azureresources-api": "^2.0.2",

package.nls.json

@@ -12,6 +12,7 @@
     "containerApps.updateImage": "Update Container Image...",
     "containerApps.deployImageApi": "Deploy Image to Container App (API)...",
     "containerApps.deployWorkspaceProject": "Deploy Project from Workspace...",
+    "containerApps.deployWorkspaceProjectApi": "Deploy Project from Workspace (API)...",
     "containerApps.deployWorkspaceProjectToContainerApp": "Deploy Workspace to Container App...",
     "containerApps.deleteContainerApp": "Delete Container App...",
     "containerApps.disableIngress": "Disable Ingress for Container App",

src/commands/api/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+
+## 0.0.1
+
+* Initial release
+
+### Added
+
+* Added an API entry-point to the `deployWorkspaceProject` command [#578](https://github.com/microsoft/vscode-azurecontainerapps/pull/578)

src/commands/api/deployWorkspaceProjectApi.ts

@@ -0,0 +1,81 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.md in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import { type RegistryPassword } from "@azure/arm-containerregistry";
+import { type ResourceGroup } from "@azure/arm-resources";
+import { ResourceGroupListStep, parseAzureResourceGroupId } from "@microsoft/vscode-azext-azureutils";
+import { createSubscriptionContext, subscriptionExperience, type IActionContext, type ISubscriptionActionContext, type ISubscriptionContext } from "@microsoft/vscode-azext-utils";
+import { type AzureSubscription } from "@microsoft/vscode-azureresources-api";
+import { Uri, type WorkspaceFolder } from "vscode";
+import { ext } from "../../extensionVariables";
+import { getWorkspaceFolderFromPath } from "../../utils/workspaceUtils";
+import { deployWorkspaceProjectInternal, type DeployWorkspaceProjectInternalContext } from "../deployWorkspaceProject/deployWorkspaceProjectInternal";
+import { listCredentialsFromRegistry } from "../image/imageSource/containerRegistry/acr/listCredentialsFromRegistry";
+import type * as api from "./vscode-azurecontainerapps.api";
+
+export async function deployWorkspaceProjectApi(context: IActionContext, deployWorkspaceProjectOptions: api.DeployWorkspaceProjectOptionsContract): Promise<api.DeployWorkspaceProjectResults> {
+    const { resourceGroupId, rootPath, dockerfilePath, srcPath, suppressConfirmation, suppressContainerAppCreation, ignoreExistingDeploySettings, shouldSaveDeploySettings } = deployWorkspaceProjectOptions;
+
+    const subscription: AzureSubscription = await subscriptionExperience(context, ext.rgApiV2.resources.azureResourceTreeDataProvider, {
+        selectBySubscriptionId: getSubscriptionIdFromOptions(deployWorkspaceProjectOptions),
+        showLoadingPrompt: false
+    });
+    const subscriptionContext: ISubscriptionContext = createSubscriptionContext(subscription);
+
+    const rootFolder: WorkspaceFolder | undefined = rootPath ? getWorkspaceFolderFromPath(rootPath) : undefined;
+    const resourceGroup: ResourceGroup | undefined = resourceGroupId ? await getResourceGroupFromId({ ...context, ...subscriptionContext }, resourceGroupId) : undefined;
+
+    const deployWorkspaceProjectInternalContext: DeployWorkspaceProjectInternalContext = Object.assign(context, {
+        ...subscriptionContext,
+        subscription,
+        resourceGroup,
+        rootFolder,
+        srcPath: srcPath ? Uri.file(srcPath).fsPath : undefined,
+        dockerfilePath: dockerfilePath ? Uri.file(dockerfilePath).fsPath : undefined,
+        suppressConfirmation,
+        ignoreExistingDeploySettings,
+        shouldSaveDeploySettings: !!shouldSaveDeploySettings,
+    });
+
+    const deployWorkspaceProjectResultContext = await deployWorkspaceProjectInternal(deployWorkspaceProjectInternalContext, undefined, {
+        // Don't show activity log updates in ACA when another client extension calls into this API.
+        // Let each client decide how it wants to show its own activity log updates.
+        suppressActivity: true,
+        suppressConfirmation,
+        suppressContainerAppCreation,
+        suppressProgress: true,
+        suppressWizardTitle: true,
+    });
+
+    const registryCredentials: { username: string, password: RegistryPassword } | undefined = deployWorkspaceProjectResultContext.registry ?
+        await listCredentialsFromRegistry(deployWorkspaceProjectResultContext, deployWorkspaceProjectResultContext.registry) : undefined;
+
+    return {
+        resourceGroupId: deployWorkspaceProjectResultContext.resourceGroup?.id,
+        logAnalyticsWorkspaceId: deployWorkspaceProjectResultContext.logAnalyticsWorkspace?.id,
+        managedEnvironmentId: deployWorkspaceProjectResultContext.managedEnvironment?.id,
+        containerAppId: deployWorkspaceProjectResultContext.containerApp?.id,
+        registryId: deployWorkspaceProjectResultContext.registry?.id,
+        registryLoginServer: deployWorkspaceProjectResultContext.registry?.loginServer,
+        registryUsername: registryCredentials?.username,
+        registryPassword: registryCredentials?.password.value,
+        imageName: deployWorkspaceProjectResultContext.imageName
+    };
+}
+
+function getSubscriptionIdFromOptions(deployWorkspaceProjectOptions: api.DeployWorkspaceProjectOptionsContract): string | undefined {
+    if (deployWorkspaceProjectOptions.subscriptionId) {
+        return deployWorkspaceProjectOptions.subscriptionId;
+    } else if (deployWorkspaceProjectOptions.resourceGroupId) {
+        return parseAzureResourceGroupId(deployWorkspaceProjectOptions.resourceGroupId).subscriptionId as string;
+    } else {
+        return undefined;
+    }
+}
+
+async function getResourceGroupFromId(context: ISubscriptionActionContext, resourceGroupId: string): Promise<ResourceGroup | undefined> {
+    const resourceGroups: ResourceGroup[] = await ResourceGroupListStep.getResourceGroups(context);
+    return resourceGroups.find(rg => rg.id === resourceGroupId);
+}

src/commands/api/getAzureContainerAppsApiProvider.ts

@@ -0,0 +1,18 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.md in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import { callWithTelemetryAndErrorHandling, createApiProvider, type IActionContext, type apiUtils } from "@microsoft/vscode-azext-utils";
+import { deployWorkspaceProjectApi } from "./deployWorkspaceProjectApi";
+import type * as api from "./vscode-azurecontainerapps.api";
+
+export function getAzureContainerAppsApiProvider(): apiUtils.AzureExtensionApiProvider {
+    return createApiProvider([<api.AzureContainerAppsExtensionApi>{
+        apiVersion: '0.0.1',
+
+        deployWorkspaceProject: async (options: api.DeployWorkspaceProjectOptionsContract) => await callWithTelemetryAndErrorHandling('containerApps.api.deployWorkspaceProject', async (context: IActionContext) => {
+            return await deployWorkspaceProjectApi(context, options);
+        })
+    }]);
+}

src/commands/api/vscode-azurecontainerapps.api.d.ts

@@ -0,0 +1,41 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+export interface AzureContainerAppsExtensionApi {
+    apiVersion: string;
+
+    deployWorkspaceProject(options: DeployWorkspaceProjectOptionsContract): Promise<DeployWorkspaceProjectResults>;
+}
+
+export interface DeployWorkspaceProjectOptionsContract {
+    // Existing resources
+    subscriptionId?: string;
+    resourceGroupId?: string;
+
+    // Workspace deployment paths (absolute fs path)
+    rootPath?: string;
+    srcPath?: string;
+    dockerfilePath?: string;
+
+    // Options
+    suppressConfirmation?: boolean;  // Suppress any [resource] confirmation prompts
+    suppressContainerAppCreation?: boolean;
+    ignoreExistingDeploySettings?: boolean;
+    shouldSaveDeploySettings?: boolean;
+}
+
+export interface DeployWorkspaceProjectResults {
+    resourceGroupId?: string;
+    logAnalyticsWorkspaceId?: string;
+    managedEnvironmentId?: string;
+    containerAppId?: string;
+
+    // ACR
+    registryId?: string;
+    registryLoginServer?: string;
+    registryUsername?: string;
+    registryPassword?: string;
+    imageName?: string;
+}

src/commands/deployWorkspaceProject/DeployWorkspaceProjectConfirmStep.ts

@@ -7,9 +7,13 @@ import { nonNullValue } from "@microsoft/vscode-azext-utils";
 import { ext } from "../../extensionVariables";
 import { localize } from "../../utils/localize";
 import { OverwriteConfirmStepBase } from "../OverwriteConfirmStepBase";
-import  { type DeployWorkspaceProjectContext } from "./DeployWorkspaceProjectContext";
+import { type DeployWorkspaceProjectContext } from "./DeployWorkspaceProjectContext";
 
 export class DeployWorkspaceProjectConfirmStep extends OverwriteConfirmStepBase<DeployWorkspaceProjectContext> {
+    constructor(private readonly suppressConfirmation: boolean) {
+        super();
+    }
+
     protected async promptCore(context: DeployWorkspaceProjectContext): Promise<void> {
         const resourcesToCreate: string[] = [];
         if (!context.resourceGroup) {
@@ -59,6 +63,6 @@ export class DeployWorkspaceProjectConfirmStep extends OverwriteConfirmStepBase<
     }
 
     public shouldPrompt(): boolean {
-        return true;
+        return !this.suppressConfirmation;
     }
 }

src/commands/deployWorkspaceProject/DeployWorkspaceProjectContext.ts

@@ -3,17 +3,27 @@
 *  Licensed under the MIT License. See License.md in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
 
-import  { type ExecuteActivityContext } from "@microsoft/vscode-azext-utils";
-import  { type SetTelemetryProps } from "../../telemetry/SetTelemetryProps";
-import  { type DeployWorkspaceProjectTelemetryProps as TelemetryProps } from "../../telemetry/commandTelemetryProps";
-import  { type CreateContainerAppBaseContext } from "../createContainerApp/CreateContainerAppContext";
-import  { type IManagedEnvironmentContext } from "../createManagedEnvironment/IManagedEnvironmentContext";
-import  { type BuildImageInAzureImageSourceBaseContext } from "../image/imageSource/buildImageInAzure/BuildImageInAzureImageSourceContext";
-import  { type CreateAcrContext } from "../image/imageSource/containerRegistry/acr/createAcr/CreateAcrContext";
+import { type ExecuteActivityContext } from "@microsoft/vscode-azext-utils";
+import { type SetTelemetryProps } from "../../telemetry/SetTelemetryProps";
+import { type DeployWorkspaceProjectTelemetryProps as TelemetryProps } from "../../telemetry/commandTelemetryProps";
+import { type IContainerAppContext } from "../IContainerAppContext";
+import { type CreateContainerAppBaseContext } from "../createContainerApp/CreateContainerAppContext";
+import { type IManagedEnvironmentContext } from "../createManagedEnvironment/IManagedEnvironmentContext";
+import { type BuildImageInAzureImageSourceBaseContext } from "../image/imageSource/buildImageInAzure/BuildImageInAzureImageSourceContext";
+import { type CreateAcrContext } from "../image/imageSource/containerRegistry/acr/createAcr/CreateAcrContext";
 
 // Use intersection typing instead of an interface here to bypass some minor (relatively trivial) type mismatch issues introduced by having to use the 'Partial' utility
-export type DeployWorkspaceProjectContext = IManagedEnvironmentContext & CreateContainerAppBaseContext & CreateAcrContext & Partial<BuildImageInAzureImageSourceBaseContext> & ExecuteActivityContext & DeployWorkspaceProjectTelemetryProps & {
-    shouldSaveDeploySettings?: boolean;
-};
+export type DeployWorkspaceProjectContext =
+    IContainerAppContext &
+    Partial<IManagedEnvironmentContext> &
+    Partial<CreateContainerAppBaseContext> &
+    Partial<CreateAcrContext> &
+    Partial<BuildImageInAzureImageSourceBaseContext> &
+    Partial<ExecuteActivityContext> &
+    DeployWorkspaceProjectTelemetryProps &
+    {
+        ignoreExistingDeploySettings?: boolean;
+        shouldSaveDeploySettings?: boolean;
+    };
 
 type DeployWorkspaceProjectTelemetryProps = SetTelemetryProps<TelemetryProps>;