Add an API entry-point to the deployWorkspaceProject command (#578)

Author: MicroFish91

package-lock.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"
@@ -621,7 +630,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.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",

package.nls.json

@@ -0,0 +1,8 @@
+# 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/CHANGELOG.md

@@ -0,0 +1,66 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.md in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import { type ResourceGroup } from "@azure/arm-resources";
+import { ResourceGroupListStep, parseAzureResourceGroupId } from "@microsoft/vscode-azext-azureutils";
+import { callWithTelemetryAndErrorHandling, 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 { getDeployWorkspaceProjectResults, type DeployWorkspaceProjectResults } from "../deployWorkspaceProject/getDeployWorkspaceProjectResults";
+import type * as api from "./vscode-azurecontainerapps.api";
+
+export async function deployWorkspaceProjectApi(deployWorkspaceProjectOptions: api.DeployWorkspaceProjectOptionsContract): Promise<DeployWorkspaceProjectResults> {
+    return await callWithTelemetryAndErrorHandling('containerApps.api.deployWorkspaceProject', async (context: IActionContext): Promise<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,
+            ignoreExistingDeploySettings,
+            shouldSaveDeploySettings: !!shouldSaveDeploySettings,
+        });
+
+        const deployWorkspaceProjectResultContext = await deployWorkspaceProjectInternal(deployWorkspaceProjectInternalContext, undefined, {
+            suppressActivity: true,
+            suppressConfirmation,
+            suppressContainerAppCreation,
+            suppressProgress: true,
+            suppressWizardTitle: true,
+        });
+
+        return await getDeployWorkspaceProjectResults(deployWorkspaceProjectResultContext);
+    }) ?? {};
+}
+
+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/deployWorkspaceProjectApi.ts

@@ -0,0 +1,15 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.md in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import { createApiProvider, 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: deployWorkspaceProjectApi
+    }]);
+}

src/commands/api/getAzureContainerAppsApiProvider.ts

@@ -0,0 +1,40 @@
+/*---------------------------------------------------------------------------------------------
+ *  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/api/vscode-azurecontainerapps.api.d.ts

@@ -12,11 +12,13 @@ import { type DeployWorkspaceProjectNotificationTelemetryProps as NotificationTe
 import { ContainerAppItem, isIngressEnabled, type ContainerAppModel } from "../../tree/ContainerAppItem";
 import { ManagedEnvironmentItem } from "../../tree/ManagedEnvironmentItem";
 import { localize } from "../../utils/localize";
+import { type DeployWorkspaceProjectResults } from "../api/vscode-azurecontainerapps.api";
 import { browseContainerApp } from "../browseContainerApp";
 import { type DeployWorkspaceProjectContext } from "./DeployWorkspaceProjectContext";
 import { deployWorkspaceProjectInternal, type DeployWorkspaceProjectInternalContext } from "./deployWorkspaceProjectInternal";
+import { getDeployWorkspaceProjectResults } from "./getDeployWorkspaceProjectResults";
 
-export async function deployWorkspaceProject(context: IActionContext & Partial<DeployWorkspaceProjectContext>, item?: ContainerAppItem | ManagedEnvironmentItem): Promise<void> {
+export async function deployWorkspaceProject(context: IActionContext & Partial<DeployWorkspaceProjectContext>, item?: ContainerAppItem | ManagedEnvironmentItem): Promise<DeployWorkspaceProjectResults> {
     // If an incompatible tree item is passed, treat it as if no item was passed
     if (item && !ContainerAppItem.isContainerAppItem(item) && !ManagedEnvironmentItem.isManagedEnvironmentItem(item)) {
         item = undefined;
@@ -39,6 +41,7 @@ export async function deployWorkspaceProject(context: IActionContext & Partial<D
     });
 
     displayNotification(deployWorkspaceProjectResultContext);
+    return await getDeployWorkspaceProjectResults(deployWorkspaceProjectResultContext);
 }
 
 function displayNotification(context: DeployWorkspaceProjectContext): void {

src/commands/deployWorkspaceProject/deployWorkspaceProject.ts

@@ -135,11 +135,11 @@ export class DefaultResourcesNameStep extends AzureWizardPromptStep<DeployWorksp
             isAvailable['resourceGroup'] = true;
         }
 
-        if (context.managedEnvironment || await ManagedEnvironmentNameStep.isNameAvailable(context, workspaceName, workspaceName)) {
+        if (context.managedEnvironment || await ManagedEnvironmentNameStep.isNameAvailable(context, context.resourceGroup?.name ?? workspaceName, workspaceName)) {
             isAvailable['managedEnvironment'] = true;
         }
 
-        if (context.containerApp || await ContainerAppNameStep.isNameAvailable(context, workspaceName, workspaceName)) {
+        if (context.containerApp || await ContainerAppNameStep.isNameAvailable(context, context.resourceGroup?.name ?? workspaceName, workspaceName)) {
             isAvailable['containerApp'] = true;
         }
 

src/commands/deployWorkspaceProject/getDefaultValues/DefaultResourcesNameStep.ts

@@ -6,10 +6,9 @@
 import { type ManagedEnvironment } from "@azure/arm-appcontainers";
 import { type ResourceGroup } from "@azure/arm-resources";
 import { type ISubscriptionActionContext } from "@microsoft/vscode-azext-utils";
-import { type SetTelemetryProps } from "../../../../telemetry/SetTelemetryProps";
-import { type DeployWorkspaceProjectTelemetryProps as TelemetryProps } from "../../../../telemetry/commandTelemetryProps";
 import { type ContainerAppItem, type ContainerAppModel } from "../../../../tree/ContainerAppItem";
 import { type ManagedEnvironmentItem } from "../../../../tree/ManagedEnvironmentItem";
+import { type DeployWorkspaceProjectContext } from "../../DeployWorkspaceProjectContext";
 import { type DeployWorkspaceProjectSettings } from "../../deployWorkspaceProjectSettings";
 import { getContainerAppResourcesFromItem, getContainerAppResourcesFromSettings } from "./getDefaultResourcesFrom";
 import { promptForEnvironmentResources } from "./promptForEnvironmentResources";
@@ -21,7 +20,7 @@ export interface DefaultContainerAppsResources {
 }
 
 export async function getDefaultContainerAppsResources(
-    context: ISubscriptionActionContext & SetTelemetryProps<TelemetryProps>,
+    context: ISubscriptionActionContext & Partial<DeployWorkspaceProjectContext>,
     settings: DeployWorkspaceProjectSettings,
     item?: ContainerAppItem | ManagedEnvironmentItem
 ): Promise<DefaultContainerAppsResources> {
@@ -33,9 +32,11 @@ export async function getDefaultContainerAppsResources(
     }
 
     // Otherwise try to obtain container app resources using any saved workspace settings
-    const { resourceGroup, managedEnvironment, containerApp } = await getContainerAppResourcesFromSettings(context, settings);
-    if (resourceGroup && managedEnvironment && containerApp) {
-        return { resourceGroup, managedEnvironment, containerApp };
+    if (!context.ignoreExistingDeploySettings) {
+        const { resourceGroup, managedEnvironment, containerApp } = await getContainerAppResourcesFromSettings(context, settings);
+        if (resourceGroup && managedEnvironment && containerApp) {
+            return { resourceGroup, managedEnvironment, containerApp };
+        }
     }
 
     // Otherwise prompt the user for managed environment resources to use