feat: update per API change for importing ruleset

src/azure/ApiCenter/ApiCenterRestAPIs.ts

@@ -7,18 +7,18 @@ export const APICenterRestAPIs = {
     GetAPIVersions: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, apiName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/apis/${apiName}/versions?api-version=${restApiVersion}`,
     GetAPIDeployments: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, apiName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/apis/${apiName}/deployments?api-version=${restApiVersion}`,
     GetAPIDefinition: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, apiName: string, apiVersion: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/apis/${apiName}/versions/${apiVersion}/definitions?api-version=${restApiVersion}`,
-    GetRulesetConfig: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/staticAnalyzers/spectral?api-version=${restApiVersion}`,
+    GetRulesetConfig: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/analyzerConfigs/spectral-openapi?api-version=${restApiVersion}`,
 
     CreateAPI: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, apiName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/apis/${apiName}?api-version=${restApiVersion}`,
     CreateAPIVersion: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, apiName: string, apiVersion: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/apis/${apiName}/versions/${apiVersion}?api-version=${restApiVersion}`,
     CreateAPIDeployment: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, apiName: string, deploymentName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/apis/${apiName}/deployments/${deploymentName}?api-version=${restApiVersion}`,
     CreateAPIDefinition: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, apiName: string, apiVersion: string, definationName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/apis/${apiName}/versions/${apiVersion}/definitions/${definationName}?api-version=${restApiVersion}`,
-    CreateRulesetConfig: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/staticAnalyzers/spectral?api-version=${restApiVersion}`,
+    CreateRulesetConfig: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/analyzerConfigs/spectral-openapi?api-version=${restApiVersion}`,
 
 
     ImportAPISpecification: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, apiName: string, apiVersion: string, definationName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/apis/${apiName}/versions/${apiVersion}/definitions/${definationName}/importSpecification?api-version=${restApiVersion}`,
     ExportApiSpecification: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, apiName: string, apiVersion: string, definationName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/apis/${apiName}/versions/${apiVersion}/definitions/${definationName}/exportSpecification?api-version=${restApiVersion}`,
 
-    ImportRuleset: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/staticAnalyzers/spectral/importRuleset?api-version=${restApiVersion}`,
-    ExportRuleset: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/staticAnalyzers/spectral/exportRuleset?api-version=${restApiVersion}`,
+    ImportRuleset: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/analyzerConfigs/spectral-openapi/importRuleset?api-version=${restApiVersion}`,
+    ExportRuleset: (subscriptionId: string, resourceGroupName: string, apiCenterName: string, restApiVersion: string) => `https://management.azure.com/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.ApiCenter/services/${apiCenterName}/workspaces/default/analyzerConfigs/spectral-openapi/exportRuleset?api-version=${restApiVersion}`,
 };

src/azure/ApiCenter/ApiCenterService.ts

@@ -4,14 +4,14 @@
 import { ISubscriptionContext } from "@microsoft/vscode-azext-utils";
 import { getCredentialForToken } from "../../utils/credentialUtil";
 import { APICenterRestAPIs } from "./ApiCenterRestAPIs";
-import { ApiCenter, ApiCenterApi, ApiCenterApiDeployment, ApiCenterApiVersion, ApiCenterApiVersionDefinition, ApiCenterApiVersionDefinitionExport, ApiCenterApiVersionDefinitionImport, ApiCenterEnvironment, ApiCenterRulesetConfig, ApiCenterRulesetExport, ApiCenterRulesetImport } from "./contracts";
+import { ApiCenter, ApiCenterApi, ApiCenterApiDeployment, ApiCenterApiVersion, ApiCenterApiVersionDefinition, ApiCenterApiVersionDefinitionExport, ApiCenterApiVersionDefinitionImport, ApiCenterEnvironment, ApiCenterRulesetConfig, ApiCenterRulesetExport, ApiCenterRulesetImport, ApiCenterRulesetImportResult, ApiCenterRulesetImportStatus, ArmAsyncOperationStatus } from "./contracts";
 
 export class ApiCenterService {
   private susbcriptionContext: ISubscriptionContext;
   private resourceGroupName: string;
   private apiCenterName: string;
   private apiVersion: string = "2023-07-01-preview";
-  private apiVersionPreview: string = "2024-03-15-preview";
+  private apiVersionNew: string = "2024-03-01";
   constructor(susbcriptionContext: ISubscriptionContext, resourceGroupName: string, apiCenterName: string) {
     this.susbcriptionContext = susbcriptionContext;
     this.apiCenterName = apiCenterName;
@@ -93,7 +93,7 @@
     const client = new ServiceClient(creds);
     const options: RequestPrepareOptions = {
       method: "GET",
-      url: APICenterRestAPIs.GetRulesetConfig(this.susbcriptionContext.subscriptionId, this.resourceGroupName, this.apiCenterName, this.apiVersionPreview)
+      url: APICenterRestAPIs.GetRulesetConfig(this.susbcriptionContext.subscriptionId, this.resourceGroupName, this.apiCenterName, this.apiVersionNew)
     };
     const response = await client.sendRequest(options);
     return response;
@@ -170,7 +170,7 @@
     const client = new ServiceClient(creds);
     const options: RequestPrepareOptions = {
       method: "PUT",
-      url: APICenterRestAPIs.CreateRulesetConfig(this.susbcriptionContext.subscriptionId, this.resourceGroupName, this.apiCenterName, this.apiVersionPreview),
+      url: APICenterRestAPIs.CreateRulesetConfig(this.susbcriptionContext.subscriptionId, this.resourceGroupName, this.apiCenterName, this.apiVersionNew),
       body: {
         properties: apiCenterRulesetConfig.properties
       }
@@ -226,24 +226,52 @@
     return response.parsedBody;
   }
 
-  public async importRuleset(importPayload: ApiCenterRulesetImport): Promise<HttpOperationResponse> {
+  public async importRuleset(importPayload: ApiCenterRulesetImport): Promise<ApiCenterRulesetImportResult> {
     const creds = getCredentialForToken(await this.susbcriptionContext.credentials.getToken());
     const client = new ServiceClient(creds);
-    const options: RequestPrepareOptions = {
+    let options: RequestPrepareOptions = {
       method: "POST",
-      url: APICenterRestAPIs.ImportRuleset(this.susbcriptionContext.subscriptionId, this.resourceGroupName, this.apiCenterName, this.apiVersionPreview),
+      url: APICenterRestAPIs.ImportRuleset(this.susbcriptionContext.subscriptionId, this.resourceGroupName, this.apiCenterName, this.apiVersionNew),
       body: importPayload
     };
-    const response = await client.sendRequest(options);
-    return response;
+    let response = await client.sendRequest(options);
+
+    if (response.status === 202) {
+      const location = response.headers.get("Location");
+
+      if (!location) {
+        return { isSuccessful: false };
+      }
+
+      options = {
+        method: "GET",
+        url: location,
+      };
+
+      const timeout = 60000; // 1 minute in milliseconds
+      let startTime = Date.now();
+      do {
+        response = await client.sendRequest(options);
+        const responseBody: ApiCenterRulesetImportStatus = response.parsedBody;
+        if (responseBody?.status === ArmAsyncOperationStatus.Succeeded) {
+          return { isSuccessful: true };
+        }
+        if (responseBody?.status === ArmAsyncOperationStatus.Failed) {
+          return { isSuccessful: false, message: responseBody.properties?.comment };
+        }
+      } while (Date.now() - startTime < timeout);
+      return { isSuccessful: false };
+    } else {
+      return { isSuccessful: false, message: response.bodyAsText };
+    }
   }
 
   public async exportRuleset(): Promise<ApiCenterRulesetExport> {
     const creds = getCredentialForToken(await this.susbcriptionContext.credentials.getToken());
     const client = new ServiceClient(creds);
     const options: RequestPrepareOptions = {
       method: "POST",
-      url: APICenterRestAPIs.ExportRuleset(this.susbcriptionContext.subscriptionId, this.resourceGroupName, this.apiCenterName, this.apiVersionPreview)
+      url: APICenterRestAPIs.ExportRuleset(this.susbcriptionContext.subscriptionId, this.resourceGroupName, this.apiCenterName, this.apiVersionNew)
     };
     const response = await client.sendRequest(options);
     return response.parsedBody;

src/azure/ApiCenter/contracts.ts

@@ -96,6 +96,20 @@ export type ApiCenterRulesetImport = {
     value: string;
 };
 
+export type ApiCenterRulesetImportStatus = {
+    id: string;
+    name: string;
+    status: ArmAsyncOperationStatus;
+    properties: {
+        comment?: string;
+    };
+};
+
+export type ApiCenterRulesetImportResult = {
+    isSuccessful: boolean;
+    message?: string | null;
+};
+
 export type ApiCenterRulesetExport = {
     format: string;
     value: string;
@@ -135,3 +149,15 @@ export enum ApiSpecExportResultFormat {
     inline = 'inline',
     link = 'link',
 };
+
+export enum ArmAsyncOperationStatus {
+    NotStarted = 'NotStarted',
+    InProgress = 'InProgress',
+    Succeeded = 'Succeeded',
+    Failed = 'Failed',
+    Canceled = 'Canceled',
+}
+
+export enum ApiCenterRulesetImportFormat {
+    InlineZip = 'inline-zip',
+};

src/commands/rules/deployRules.ts

@@ -4,7 +4,7 @@
 import { IActionContext } from "@microsoft/vscode-azext-utils";
 import * as vscode from 'vscode';
 import { ApiCenterService } from "../../azure/ApiCenter/ApiCenterService";
-import { ApiCenterRulesetImport } from "../../azure/ApiCenter/contracts";
+import { ApiCenterRulesetImport, ApiCenterRulesetImportFormat } from "../../azure/ApiCenter/contracts";
 import { RulesTreeItem } from "../../tree/rules/RulesTreeItem";
 import { UiStrings } from "../../uiStrings";
 import { hasFiles } from "../../utils/fsUtil";
@@ -18,20 +18,25 @@
         return;
     }
 
-    const content = (await zipFolderToBuffer(rulesFolderPath)).toString('base64');
+    await vscode.window.withProgress({
+        location: vscode.ProgressLocation.Notification,
+        title: UiStrings.DeployRules
+    }, async (progress, token) => {
+        const content = (await zipFolderToBuffer(rulesFolderPath)).toString('base64');
 
-    const resourceGroupName = getResourceGroupFromId(node.apiCenter.id);
-    const apiCenterService = new ApiCenterService(node.parent?.subscription!, resourceGroupName, node.apiCenter.name);
+        const resourceGroupName = getResourceGroupFromId(node.apiCenter.id);
+        const apiCenterService = new ApiCenterService(node.parent?.subscription!, resourceGroupName, node.apiCenter.name);
 
-    const importPayload: ApiCenterRulesetImport = {
-        value: content,
-        format: "InlineZip",
-    };
-    const response = await apiCenterService.importRuleset(importPayload);
+        const importPayload: ApiCenterRulesetImport = {
+            value: content,
+            format: ApiCenterRulesetImportFormat.InlineZip,
+        };
+        const response = await apiCenterService.importRuleset(importPayload);
 
-    if (response.status === 200) {
-        vscode.window.showInformationMessage(vscode.l10n.t(UiStrings.RulesDeployed, node.apiCenter.name));
-    } else {
-        vscode.window.showErrorMessage(vscode.l10n.t(UiStrings.FailedToDeployRules, response.bodyAsText ?? `status code ${response.status}`));
-    }
+        if (response.isSuccessful) {
+            vscode.window.showInformationMessage(vscode.l10n.t(UiStrings.RulesDeployed, node.apiCenter.name));
+        } else {
+            throw new Error(vscode.l10n.t(UiStrings.FailedToDeployRules, response.message ? `Error: ${response.message}` : ""));
+        }
+    });
 }

src/commands/rules/enableRules.ts

@@ -5,50 +5,50 @@ import { IActionContext } from "@microsoft/vscode-azext-utils";
 import * as path from 'path';
 import * as vscode from 'vscode';
 import { ApiCenterService } from "../../azure/ApiCenter/ApiCenterService";
-import { ApiCenterRulesetConfig, ApiCenterRulesetImport } from "../../azure/ApiCenter/contracts";
+import { ApiCenterRulesetConfig, ApiCenterRulesetImport, ApiCenterRulesetImportFormat } from "../../azure/ApiCenter/contracts";
 import { ext } from "../../extensionVariables";
 import { RulesTreeItem } from "../../tree/rules/RulesTreeItem";
 import { UiStrings } from "../../uiStrings";
 import { zipFolderToBuffer } from "../../utils/zipUtils";
 
 const apiCenterRulesetConfig: ApiCenterRulesetConfig = {
     properties: {
-        analyzerVersion: "1.0.0",
-        apiType: "rest",
-        lifecycleStage: "testing",
+        analyzerType: "spectral"
     }
 };
 
 export async function enableRules(context: IActionContext, node: RulesTreeItem) {
-    const resourceGroupName = getResourceGroupFromId(node.apiCenter.id);
-    const apiCenterService = new ApiCenterService(node.parent?.subscription!, resourceGroupName, node.apiCenter.name);
-
-    let response = await apiCenterService.createOrUpdateApiCenterRulesetConfig(apiCenterRulesetConfig);
-
-    if (response.status === 200) {
-        vscode.window.showInformationMessage((vscode.l10n.t(UiStrings.RulesEnabled, node.apiCenter.name)));
-    } else {
-        vscode.window.showErrorMessage(vscode.l10n.t(UiStrings.FailedToEnableRules, response.bodyAsText ?? `status code ${response.status}`));
-        return;
-    }
-
-    // Temporary workaround to deploy default rules after enabling rules
-    // In future, default rules need to be generated in control plane
-    const defaultRulesFolderPath = path.join(ext.context.extensionPath, 'templates', 'rules', 'default-ruleset');
-
-    const content = (await zipFolderToBuffer(defaultRulesFolderPath)).toString('base64');
-
-    const importPayload: ApiCenterRulesetImport = {
-        value: content,
-        format: "InlineZip",
-    };
-    response = await apiCenterService.importRuleset(importPayload);
-
-    if (response.status === 200) {
-        vscode.window.showInformationMessage(vscode.l10n.t(UiStrings.RulesDeployed, node.apiCenter.name));
-        node.updateStatusToEnable();
-        await node.refresh(context);
-    } else {
-        vscode.window.showErrorMessage(vscode.l10n.t(UiStrings.FailedToDeployRules, response.bodyAsText ?? `status code ${response.status}`));
-    }
+    await vscode.window.withProgress({
+        location: vscode.ProgressLocation.Notification,
+        title: UiStrings.EnableRules
+    }, async (progress, token) => {
+        const resourceGroupName = getResourceGroupFromId(node.apiCenter.id);
+        const apiCenterService = new ApiCenterService(node.parent?.subscription!, resourceGroupName, node.apiCenter.name);
+
+        const response = await apiCenterService.createOrUpdateApiCenterRulesetConfig(apiCenterRulesetConfig);
+
+        if (response.status !== 200) {
+            throw new Error(vscode.l10n.t(UiStrings.FailedToEnableRules, response.bodyAsText ? `Error: ${response.bodyAsText}` : `Status Code: ${response.status}`));
+        }
+
+        // Temporary workaround to deploy default rules after enabling rules
+        // In future, default rules need to be generated in control plane
+        const defaultRulesFolderPath = path.join(ext.context.extensionPath, 'templates', 'rules', 'default-ruleset');
+
+        const content = (await zipFolderToBuffer(defaultRulesFolderPath)).toString('base64');
+
+        const importPayload: ApiCenterRulesetImport = {
+            value: content,
+            format: ApiCenterRulesetImportFormat.InlineZip,
+        };
+        const importRulesetResponse = await apiCenterService.importRuleset(importPayload);
+
+        if (importRulesetResponse.isSuccessful) {
+            vscode.window.showInformationMessage(vscode.l10n.t(UiStrings.RulesEnabled, node.apiCenter.name));
+            node.updateStatusToEnable();
+            await node.refresh(context);
+        } else {
+            throw new Error(vscode.l10n.t(UiStrings.FailedToEnableRules, importRulesetResponse.message ? `Error: ${importRulesetResponse.message}` : ""));
+        }
+    });
 }