Add backward compatibility to API in support of the new managed identity features (#816)

Author: MicroFish91

src/commands/api/CHANGELOG.md

@@ -1,14 +1,17 @@
 # Change Log
 
-### 0.0.2
+### 0.0.3
 
 ### Changed
+* [[816]](https://github.com/microsoft/vscode-azurecontainerapps/pull/816) Added backward compatibility to ensure existing functionality remains unaffected by new managed identity features.
+
+### 0.0.2
 
+### Changed
 * [[615]](https://github.com/microsoft/vscode-azurecontainerapps/pull/615) Removed ability to set option `ignoreExistingDeploySettings`. This will now happen automatically by default.
 
 ## 0.0.1
 * Initial release
 
 ### Added
-
 * [[578]](https://github.com/microsoft/vscode-azurecontainerapps/pull/578) Added an API entry-point to the `deployWorkspaceProject` command

src/commands/api/deployWorkspaceProjectApi.ts

@@ -15,11 +15,21 @@ import { type DeployWorkspaceProjectContext } from "../deployWorkspaceProject/De
 import { getDeployWorkspaceProjectResults, type DeployWorkspaceProjectResults } from "../deployWorkspaceProject/getDeployWorkspaceProjectResults";
 import { type DeployWorkspaceProjectInternalContext } from "../deployWorkspaceProject/internal/DeployWorkspaceProjectInternalContext";
 import { deployWorkspaceProjectInternal } from "../deployWorkspaceProject/internal/deployWorkspaceProjectInternal";
+import { RegistryCredentialType } from "../registryCredentials/RegistryCredentialsAddConfigurationListStep";
 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, shouldSaveDeploySettings } = deployWorkspaceProjectOptions;
+        const {
+            resourceGroupId,
+            rootPath,
+            dockerfilePath,
+            srcPath,
+            suppressRegistryPrompt,
+            suppressConfirmation,
+            suppressContainerAppCreation,
+            shouldSaveDeploySettings
+        } = deployWorkspaceProjectOptions;
 
         const subscription: AzureSubscription = await subscriptionExperience(context, ext.rgApiV2.resources.azureResourceTreeDataProvider, {
             selectBySubscriptionId: getSubscriptionIdFromOptions(deployWorkspaceProjectOptions),
@@ -38,12 +48,14 @@ export async function deployWorkspaceProjectApi(deployWorkspaceProjectOptions: a
             rootFolder,
             srcPath: srcPath ? Uri.file(srcPath).fsPath : undefined,
             dockerfilePath: dockerfilePath ? Uri.file(dockerfilePath).fsPath : undefined,
+            newRegistryCredentialType: RegistryCredentialType.DockerLogin,
             shouldSaveDeploySettings: !!shouldSaveDeploySettings,
         });
 
         const deployWorkspaceProjectContext: DeployWorkspaceProjectContext = await deployWorkspaceProjectInternal(deployWorkspaceProjectInternalContext, {
             suppressActivity: true,
             suppressConfirmation,
+            suppressRegistryPrompt: suppressRegistryPrompt ?? true,
             suppressContainerAppCreation,
             suppressProgress: true,
             suppressWizardTitle: true,

src/commands/api/getAzureContainerAppsApiProvider.ts

@@ -9,7 +9,7 @@ import type * as api from "./vscode-azurecontainerapps.api";
 
 export function getAzureContainerAppsApiProvider(): apiUtils.AzureExtensionApiProvider {
     return createApiProvider([<api.AzureContainerAppsExtensionApi>{
-        // Todo: Change this to 0.0.2 later.  0.0.2 is backwards compatible anyway so this change should be fine either way.
+        // Todo: Change this to 0.0.3 later.  0.0.3 is backwards compatible anyway so this change should be fine either way.
         // For some reason it's causing a block on Function side, so just keep it at 0.0.1 until we figure out why
         apiVersion: '0.0.1',
         deployWorkspaceProject: deployWorkspaceProjectApi

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

@@ -19,6 +19,7 @@ export interface DeployWorkspaceProjectOptionsContract {
     dockerfilePath?: string;
 
     // Options
+    suppressRegistryPrompt?: boolean;
     suppressConfirmation?: boolean;  // Suppress any [resource] confirmation prompts
     suppressContainerAppCreation?: boolean;
     shouldSaveDeploySettings?: boolean;

src/commands/deployWorkspaceProject/internal/deployWorkspaceProjectInternal.ts

@@ -34,6 +34,10 @@ export interface DeployWorkspaceProjectInternalOptions {
      * Suppress showing the wizard execution through the activity log
      */
     suppressActivity?: boolean;
+    /**
+     * Suppress registry selection prompt
+     */
+    suppressRegistryPrompt?: boolean;
     /**
      * Suppress any [resource] confirmation prompts
      */
@@ -78,7 +82,7 @@ export async function deployWorkspaceProjectInternal(
             undefined :
             localize('loadingWorkspaceTitle', 'Loading workspace project starting configurations...')
     }, async () => {
-        startingConfiguration = await getStartingConfiguration({ ...context });
+        startingConfiguration = await getStartingConfiguration({ ...context }, options);
     });
 
     if (startingConfiguration?.containerApp?.revisionsMode === KnownActiveRevisionsMode.Multiple) {

src/commands/deployWorkspaceProject/internal/startingConfiguration/getStartingConfiguration.ts

@@ -11,20 +11,26 @@ import { DockerfileItemStep } from "../../../image/imageSource/buildImageInAzure
 import { AcrBuildSupportedOS } from "../../../image/imageSource/buildImageInAzure/OSPickStep";
 import { RootFolderStep } from "../../../image/imageSource/buildImageInAzure/RootFolderStep";
 import { type DeployWorkspaceProjectInternalContext } from "../DeployWorkspaceProjectInternalContext";
+import { type DeployWorkspaceProjectInternalOptions } from "../deployWorkspaceProjectInternal";
 import { DwpAcrListStep } from "./DwpAcrListStep";
 import { DwpManagedEnvironmentListStep } from "./DwpManagedEnvironmentListStep";
 import { getResourcesFromContainerAppHelper, getResourcesFromManagedEnvironmentHelper } from "./containerAppsResourceHelpers";
 
-export async function getStartingConfiguration(context: DeployWorkspaceProjectInternalContext): Promise<Partial<DeployWorkspaceProjectInternalContext>> {
+export async function getStartingConfiguration(context: DeployWorkspaceProjectInternalContext, options: DeployWorkspaceProjectInternalOptions): Promise<Partial<DeployWorkspaceProjectInternalContext>> {
     await tryAddMissingAzureResourcesToContext(context);
 
+    const promptSteps = [
+        new RootFolderStep(),
+        new DockerfileItemStep(),
+        new DwpManagedEnvironmentListStep(),
+    ];
+
+    if (!options.suppressRegistryPrompt) {
+        promptSteps.push(new DwpAcrListStep());
+    }
+
     const wizard: AzureWizard<DeployWorkspaceProjectInternalContext> = new AzureWizard(context, {
-        promptSteps: [
-            new RootFolderStep(),
-            new DockerfileItemStep(),
-            new DwpManagedEnvironmentListStep(),
-            new DwpAcrListStep(),
-        ],
+        promptSteps,
     });
 
     await wizard.prompt();
@@ -38,6 +44,7 @@ export async function getStartingConfiguration(context: DeployWorkspaceProjectIn
         containerApp: context.containerApp,
         registry: context.registry,
         newRegistrySku: KnownSkuName.Basic,
+        suppressEnableAdminUserPrompt: options.suppressConfirmation,
         imageSource: ImageSource.RemoteAcrBuild,
         os: AcrBuildSupportedOS.Linux,
         envPath: context.envPath,

src/commands/registryCredentials/dockerLogin/AcrEnableAdminUserConfirmStep.ts

@@ -16,6 +16,6 @@ export class AcrEnableAdminUserConfirmStep extends AzureWizardPromptStep<DockerL
     }
 
     public shouldPrompt(context: DockerLoginRegistryCredentialsContext): boolean {
-        return getRegistryDomainFromContext(context) === acrDomain && !context.registry?.adminUserEnabled;
+        return !context.suppressEnableAdminUserPrompt && getRegistryDomainFromContext(context) === acrDomain && !context.registry?.adminUserEnabled;
     }
 }

src/commands/registryCredentials/dockerLogin/DockerLoginRegistryCredentialsContext.ts

@@ -17,4 +17,6 @@ export interface DockerLoginRegistryCredentialsContext extends CreateAcrContext,
 
     newRegistrySecret?: Secret;
     newRegistryCredential?: RegistryCredentials;
+
+    suppressEnableAdminUserPrompt?: boolean;
 }