feat: add api error handling in new portal generation code

Author: saeedjamshaid

src/actions/portal/generatePortalAction.ts

@@ -28,18 +28,18 @@ export class GeneratePortalAction {
     zipPortal: boolean
   ): Promise<ActionResult> => {
     if (buildDirectory.isEqual(portalDirectory)) {
-      return ActionResult.error("build directory and portal directory cannot be the same")
+      return ActionResult.error("build directory and portal directory cannot be the same.");
     }
 
     if (!(await this.validateBuild(buildDirectory))) {
-      return ActionResult.error("build directory is empty or not valid")
+      return ActionResult.error("build directory is empty or not valid");
     }
 
     if (!(await this.validatePortal(portalDirectory, force))) {
-      return ActionResult.error("portal directory is empty or not valid")
+      return ActionResult.error("portal directory is empty or not valid");
     }
 
-    await withDir(
+    return await withDir(
       async (tempDirResult) => {
         this.prompts.displayPortalGenerationMessage();
 
@@ -48,11 +48,17 @@ export class GeneratePortalAction {
         const buildZipPath = new FilePath(tempDirectory, new FileName("build.zip"));
         await this.zipArchiver.archive(buildDirectory, buildZipPath);
 
-        const buildStream = await this.portalService.generatePortal(buildZipPath, this.configDir, this.authKey);
+        const response = await this.portalService.generatePortal(buildZipPath, this.configDir, this.authKey);
+
+        if (!response.isSuccess()) {
+          this.prompts.displayPortalGenerationErrorMessage();
+          return ActionResult.error(await this.parseError(response.error!, portalDirectory, tempDirectory));
+        }
+
         this.prompts.displayPortalGenerationSuccessMessage();
 
         const tempPortalFilePath = new FilePath(tempDirectory, new FileName("portal.zip"));
-        await this.fileService.writeFile(tempPortalFilePath, <NodeJS.ReadableStream>buildStream);
+        await this.fileService.writeFile(tempPortalFilePath, <NodeJS.ReadableStream>response.value);
 
         await this.fileService.cleanDirectory(portalDirectory);
         if (zipPortal) {
@@ -61,15 +67,12 @@ export class GeneratePortalAction {
         } else {
           await this.zipArchiver.unArchive(tempPortalFilePath, portalDirectory);
         }
+        return ActionResult.success();
       },
       { unsafeCleanup: true }
     );
-
-    return ActionResult.success();
   }
 
-
-
   private async validateBuild(buildDirectory: DirectoryPath) {
     // TODO: add more checks here
     return await this.fileService.directoryExists(buildDirectory);
@@ -80,4 +83,20 @@ export class GeneratePortalAction {
     if (isEmptyOrNotExists) return true;
     return forceCleanup || (await this.prompts.overwritePortal(portalDirectory));
   }
+
+  private async parseError(error: string | NodeJS.ReadableStream, portalDirectory: DirectoryPath, tempDirectory: DirectoryPath): Promise<string> {
+    if (typeof error === 'string') {
+      return error;
+    }
+    
+    const tempErrorFilePath = new FilePath(tempDirectory, new FileName("error.zip"));
+    await this.fileService.writeFile(tempErrorFilePath, <NodeJS.ReadableStream>error);
+
+    await this.fileService.cleanDirectory(portalDirectory);
+    await this.zipArchiver.unArchive(tempErrorFilePath, portalDirectory);
+
+    const errorReportPath = portalDirectory.join("apimatic-debug");
+    return "An error occurred during portal generation due to an issue with the input. An error report has been written at the destination path: " +
+      errorReportPath;
+  }
 }

src/commands/portal/generate.ts

@@ -1,6 +1,7 @@
-import { Command, Flags } from "@oclif/core";
+import { Command, Config, Flags } from "@oclif/core";
 import { DirectoryPath } from "../../types/file/directoryPath.js";
 import { GeneratePortalAction } from "../../actions/portal/generatePortalAction.js";
+import { PortalGeneratePrompts } from "../../prompts/portal/generate.js";
 
 const DEFAULT_WORKING_DIRECTORY = "./";
 
@@ -35,6 +36,13 @@ Your portal has been generated at D:/
 `
   ];
 
+  private readonly prompts: PortalGeneratePrompts;
+
+  constructor(argv: string[], config: Config) {
+    super(argv, config);
+    this.prompts = new PortalGeneratePrompts();
+  }
+
   async run(): Promise<void> {
     const {
       flags: {
@@ -52,7 +60,7 @@ Your portal has been generated at D:/
 
     const action = new GeneratePortalAction(this.getConfigDir(), authKey);
     const result = await action.execute(buildDirectory, portalDirectory, force, zipPortal);
-    result.map((message) =>  this.error(message));
+    result.map((message) => this.prompts.logError(message));
   }
 
   private getConfigDir = () => {

src/infrastructure/services/portal-service.ts

@@ -32,47 +32,24 @@ export class PortalService {
   private readonly fileService = new FileService();
 
 
-  async generatePortal(buildPath: FilePath, configDir: DirectoryPath, authKey: string | null): Promise<NodeJS.ReadableStream> {
+  async generatePortal(buildPath: FilePath, configDir: DirectoryPath, authKey: string | null): Promise<Result<NodeJS.ReadableStream, string | NodeJS.ReadableStream>> {
     const buildFileStream = await this.fileService.getStream(buildPath);
     const file = new FileWrapper(buildFileStream);
-    const client = await this.getApiClient(configDir, authKey);
-    const docsPortalManagementController = new DocsPortalManagementController(client);
-    const response = await docsPortalManagementController.generateOnPremPortalViaBuildInput(this.CONTENT_TYPE, file);
-    return response.result as NodeJS.ReadableStream;
-  }
 
-  private async getApiClient(configDir: DirectoryPath, authKey: string | null): Promise<Client> {
     const authInfo: AuthInfo | null = await getAuthInfo(configDir.toString());
-    // TODO: Add auth key
-    const authorizationHeader = this.createAuthorizationHeader(authInfo, authKey);
-    return this.createApiClient(authorizationHeader);
-  }
-
-  public async generateOnPremPortal(
-    params: GeneratePortalParams,
-    configDir: string
-  ): Promise<Result<NodeJS.ReadableStream, string>> {
-    if (!(await fsExtra.pathExists(params.sourceBuildInputZipFilePath))) {
-      return Result.failure("Build file doesn't exist");
+    if (authInfo === null && !authKey) {
+      return Result.failure("You are not logged in, please login using `auth:login` first.");
     }
 
-    const authInfo: AuthInfo | null = await getAuthInfo(configDir);
-    if (authInfo === null && !params.overrideAuthKey) {
-      return Result.failure("You are not logged in, please login using `apimatic auth:login` first.");
-    }
-
-    const authorizationHeader = this.createAuthorizationHeader(authInfo, params.overrideAuthKey);
+    const authorizationHeader = this.createAuthorizationHeader(authInfo, authKey);
     const client = this.createApiClient(authorizationHeader);
     const docsPortalManagementController = new DocsPortalManagementController(client);
 
     try {
-      const stream = await this.generatePortalFromSyncEndpoint(
-        docsPortalManagementController,
-        params.sourceBuildInputZipFilePath
-      );
-      return Result.success(stream);
+      const response = await docsPortalManagementController.generateOnPremPortalViaBuildInput(this.CONTENT_TYPE, file);
+      return Result.success(response.result as NodeJS.ReadableStream);
     } catch (error) {
-      return Result.failure(await this.handlePortalGenerationErrors(error, params));
+      return Result.failure(await this.handlePortalGenerationErrors(error));
     }
   }
 
@@ -120,13 +97,13 @@ export class PortalService {
   };
 
   private getUserAgent(): string {
-      const osInfo = `${os.platform()} ${os.release()}`;
-      const engine = "Node.js";
-      const engineVersion = process.version;
-      
-      return `APIMATIC CLI - [OS: ${osInfo}, Engine: ${engine}/${engineVersion}]`;
-    }
-    
+    const osInfo = `${os.platform()} ${os.release()}`;
+    const engine = "Node.js";
+    const engineVersion = process.version;
+
+    return `APIMATIC CLI - [OS: ${osInfo}, Engine: ${engine}/${engineVersion}]`;
+  }
+
   private createApiClient = (authorizationHeader: string): Client => {
     return new Client({
       customHeaderAuthenticationCredentials: {
@@ -137,18 +114,7 @@ export class PortalService {
     });
   };
 
-  private generatePortalFromSyncEndpoint = async (
-    docsPortalManagementController: DocsPortalManagementController,
-    zippedBuildFilePath: string
-  ): Promise<NodeJS.ReadableStream> => {
-    const file = new FileWrapper(fs.createReadStream(zippedBuildFilePath));
-    const response: ApiResponse<NodeJS.ReadableStream | Blob> =
-      await docsPortalManagementController.generateOnPremPortalViaBuildInput(this.CONTENT_TYPE, file);
-
-    return response.result as NodeJS.ReadableStream;
-  };
-
-  private handlePortalGenerationErrors = async (error: unknown, params: GeneratePortalParams): Promise<string> => {
+  private handlePortalGenerationErrors = async (error: unknown): Promise<string | NodeJS.ReadableStream> => {
     if (error instanceof UnauthorizedResponseError) {
       //401
       const body = await this.parseErrorResponse(error);
@@ -160,7 +126,7 @@ export class PortalService {
       return getMessageInRedColor(body.title + "\n- " + message);
     } else if (error instanceof ApiError && error.statusCode === 422) {
       //422
-      return await this.saveAndExtractErrorZipFile(error, params);
+      return error.body as NodeJS.ReadableStream;
     } else if (error instanceof InternalServerErrorResponseError) {
       //500
       const body = await this.parseErrorResponse(error);
@@ -197,7 +163,7 @@ export class PortalService {
           resolve(
             getMessageInRedColor(
               "An error occurred during portal generation due to an issue with the input. An error report has been written at the destination path: " +
-                path.join(params.generatedPortalArtifactsFolderPath, "apimatic-debug")
+              path.join(params.generatedPortalArtifactsFolderPath, "apimatic-debug")
             )
           );
         })