Support permission_denied__can_apply_for_trial error code (#1426)

packages/ansible-language-server/src/errors.ts

@@ -215,6 +215,13 @@ ERRORS.addError(
     "You don't have access to IBM watsonx Code Assistant. Please contact your administrator.",
   ),
 );
+ERRORS.addError(
+  403,
+  new Error(
+    "permission_denied__can_apply_for_trial",
+    "Access denied but user can apply for a trial period.",
+  ),
+);
 ERRORS.addError(
   403,
   new Error(

src/features/lightspeed/api.ts

@@ -22,7 +22,10 @@ import { IError } from "@ansible/ansible-language-server/src/interfaces/lightspe
 import { lightSpeedManager } from "../../extension";
 import { LightspeedUser } from "./lightspeedUser";
 import { inlineSuggestionHideHandler } from "./inlineSuggestions";
-import { showTrialInfoPopup } from "./utils/oneClickTrial";
+import {
+  getOneClickTrialProvider,
+  OneClickTrialProvider,
+} from "./utils/oneClickTrial";
 
 const UNKNOWN_ERROR: string = "An unknown error occurred.";
 
@@ -48,6 +51,7 @@ export class LightSpeedAPI {
   private lightspeedAuthenticatedUser: LightspeedUser;
   private _suggestionFeedbacks: string[];
   private _extensionVersion: string;
+  private _oneClickTrialProvider: OneClickTrialProvider;
 
   constructor(
     settingsManager: SettingsManager,
@@ -58,6 +62,7 @@ export class LightSpeedAPI {
     this.lightspeedAuthenticatedUser = lightspeedAuthenticatedUser;
     this._suggestionFeedbacks = [];
     this._extensionVersion = context.extension.packageJSON.version;
+    this._oneClickTrialProvider = getOneClickTrialProvider();
   }
 
   private async getApiInstance(): Promise<AxiosInstance | undefined> {
@@ -147,8 +152,10 @@ export class LightSpeedAPI {
     } catch (error) {
       isCompletionSuccess = false;
       const err = error as AxiosError;
-      const mappedError: IError = await mapError(err);
-      if (!(await showTrialInfoPopup(mappedError))) {
+      const mappedError: IError = this._oneClickTrialProvider.mapError(
+        await mapError(err),
+      );
+      if (!(await this._oneClickTrialProvider.showPopup(mappedError))) {
         vscode.window.showErrorMessage(mappedError.message ?? UNKNOWN_ERROR);
       }
       return {} as CompletionResponseParams;

src/features/lightspeed/playbookExplanation.ts

@@ -10,7 +10,7 @@ import { LightspeedUser } from "./lightspeedUser";
 import { ExplanationResponse } from "@ansible/ansible-language-server/src/interfaces/lightspeedApi";
 import { v4 as uuidv4 } from "uuid";
 import * as yaml from "yaml";
-import { showTrialInfoPopup } from "./utils/oneClickTrial";
+import { getOneClickTrialProvider } from "./utils/oneClickTrial";
 
 function getObjectKeys(content: string): string[] {
   try {
@@ -105,7 +105,9 @@ export const playbookExplanation = async (
       settingsManager,
     ).then(async (response: ExplanationResponse) => {
       if (isError(response)) {
-        if (!(await showTrialInfoPopup(response))) {
+        const oneClickTrialProvider = getOneClickTrialProvider();
+        response = oneClickTrialProvider.mapError(response);
+        if (!(await oneClickTrialProvider.showPopup(response))) {
           vscode.window.showErrorMessage(response.message ?? UNKNOWN_ERROR);
           currentPanel.setContent(
             `<p><span class="codicon codicon-error"></span>The operation has failed:<p>${response.message}</p></p>`,

src/features/lightspeed/playbookGeneration.ts

@@ -13,7 +13,7 @@ import {
   PlaybookGenerationActionType,
 } from "../../definitions/lightspeed";
 import { isError, UNKNOWN_ERROR } from "./utils/errors";
-import { showTrialInfoPopup } from "./utils/oneClickTrial";
+import { getOneClickTrialProvider } from "./utils/oneClickTrial";
 
 let currentPanel: WebviewPanel | undefined;
 let wizardId: string | undefined;
@@ -166,7 +166,9 @@ export async function showPlaybookGenerationPage(
               panel,
             ).then(async (response: GenerationResponse) => {
               if (isError(response)) {
-                if (!(await showTrialInfoPopup(response))) {
+                const oneClickTrialProvider = getOneClickTrialProvider();
+                response = oneClickTrialProvider.mapError(response);
+                if (!(await oneClickTrialProvider.showPopup(response))) {
                   vscode.window.showErrorMessage(
                     response.message ?? UNKNOWN_ERROR,
                   );

src/features/lightspeed/utils/oneClickTrial.ts

@@ -3,23 +3,43 @@ import { IError } from "@ansible/ansible-language-server/src/interfaces/lightspe
 import { lightSpeedManager } from "../../../extension";
 import { LightSpeedCommands } from "../../../definitions/lightspeed";
 
-export async function showTrialInfoPopup(error?: IError): Promise<boolean> {
-  if (
-    lightSpeedManager.lightspeedExplorerProvider
-      .lightspeedExperimentalEnabled &&
-    error?.code === "permission_denied__user_has_no_subscription"
-  ) {
-    const buttonLabel = "Start my Trial period, It's free!";
-    const selection = await vscode.window.showInformationMessage(
-      "Oh! You don't have an active Lightspeed Subscription",
-      buttonLabel,
-    );
-    if (selection === buttonLabel) {
-      vscode.commands.executeCommand(
-        LightSpeedCommands.LIGHTSPEED_OPEN_TRIAL_PAGE,
+export class OneClickTrialProvider {
+  public mapError(mappedError: IError): IError {
+    // Don't show "Apply for Trial" message if experimental features are not enabled
+    if (
+      mappedError?.code === "permission_denied__can_apply_for_trial" &&
+      !lightSpeedManager.lightspeedExplorerProvider
+        .lightspeedExperimentalEnabled
+    ) {
+      return {
+        code: "permission_denied__user_has_no_subscription",
+        message:
+          "Your organization does not have a subscription. Please contact your administrator.",
+      };
+    }
+    return mappedError;
+  }
+
+  public async showPopup(error?: IError): Promise<boolean> {
+    if (error?.code === "permission_denied__can_apply_for_trial") {
+      const buttonLabel = "Start my Trial period, It's free!";
+      const selection = await vscode.window.showInformationMessage(
+        "Oh! You don't have an active Lightspeed Subscription",
+        buttonLabel,
       );
+      if (selection === buttonLabel) {
+        vscode.commands.executeCommand(
+          LightSpeedCommands.LIGHTSPEED_OPEN_TRIAL_PAGE,
+        );
+      }
+      return true; // This suppresses to show the standard error message.
     }
-    return true; // This suppresses to show the standard error message.
+    return false;
   }
-  return false;
+}
+
+const oneClickTrialProvider = new OneClickTrialProvider();
+
+export function getOneClickTrialProvider(): OneClickTrialProvider {
+  return oneClickTrialProvider;
 }

test/mockLightspeedServer/completion.ts

@@ -1,5 +1,5 @@
 import { v4 as uuidv4 } from "uuid";
-import { options, permissionDeniedUserHasNoSubscription } from "./server";
+import { options, permissionDeniedCanApplyForTrial } from "./server";
 
 // Default model ID
 const DEFAULT_MODEL_ID = "ABCD-1234-5678";
@@ -79,7 +79,7 @@ export function completions(
   }
 
   if (options.oneClick) {
-    return res.status(403).json(permissionDeniedUserHasNoSubscription());
+    return res.status(403).json(permissionDeniedCanApplyForTrial());
   }
 
   const model = req.body.model ? req.body.model : DEFAULT_MODEL_ID;

test/mockLightspeedServer/explanations.ts

@@ -1,6 +1,6 @@
 import { v4 as uuidv4 } from "uuid";
 import { logger } from "./server";
-import { options, permissionDeniedUserHasNoSubscription } from "./server";
+import { options, permissionDeniedCanApplyForTrial } from "./server";
 
 export function explanations(
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -16,7 +16,7 @@ export function explanations(
   logger.info(`content: ${playbook}`);
 
   if (options.oneClick) {
-    return res.status(403).json(permissionDeniedUserHasNoSubscription());
+    return res.status(403).json(permissionDeniedCanApplyForTrial());
   }
 
   // Special case to replicate the feature being unavailable

test/mockLightspeedServer/feedback.ts

@@ -1,6 +1,5 @@
 import { logger } from "./server";
 import { Request, Response } from "express";
-import { options, permissionDeniedUserHasNoSubscription } from "./server";
 
 let feedbacks: object[] = [];
 
@@ -9,10 +8,6 @@ export function feedback(req: Request, res: Response): Response {
   logger.info(JSON.stringify(body, null, 2));
   feedbacks.push(body);
 
-  if (options.oneClick) {
-    return res.status(403).json(permissionDeniedUserHasNoSubscription());
-  }
-
   // If a sentimentFeedback is received and it's feedback starts with
   // "permission_denied__" respond with a 403 error with the specified code.
   if (body?.sentimentFeedback?.feedback.startsWith("permission_denied__")) {

test/mockLightspeedServer/generations.ts

@@ -1,9 +1,5 @@
 import { v4 as uuidv4 } from "uuid";
-import {
-  logger,
-  options,
-  permissionDeniedUserHasNoSubscription,
-} from "./server";
+import { logger, options, permissionDeniedCanApplyForTrial } from "./server";
 
 export function generations(
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -20,7 +16,7 @@ export function generations(
   logger.info(`wizardId: ${wizardId}`);
 
   if (options.oneClick) {
-    return res.status(403).json(permissionDeniedUserHasNoSubscription());
+    return res.status(403).json(permissionDeniedCanApplyForTrial());
   }
 
   // Special case to replicate the feature being unavailable

test/mockLightspeedServer/server.ts

@@ -52,14 +52,13 @@ if (process.platform !== "darwin" && process.env.TEST_LIGHTSPEED_URL) {
   url = new URL(process.env.TEST_LIGHTSPEED_URL);
 }
 
-export function permissionDeniedUserHasNoSubscription(): {
+export function permissionDeniedCanApplyForTrial(): {
   code: string;
   message: string;
 } {
   return {
-    code: "permission_denied__user_has_no_subscription",
-    message:
-      "Your organization does not have a subscription. Please contact your administrator.",
+    code: "permission_denied__can_apply_for_trial",
+    message: "Access denied but user can apply for a trial period.",
   };
 }