feat: improve error handling

humanitec · Oct 3, 2024 · 1e3a97b · 1e3a97b
1 parent 7d3e6cd
commit 1e3a97b
Show file tree

Hide file tree

Showing 21 changed files with 243 additions and 137 deletions.
diff --git a/src/controllers/DisplayResourceDependencyGraphController.ts b/src/controllers/DisplayResourceDependencyGraphController.ts
@@ -1,15 +1,14 @@
 import * as vscode from 'vscode';
 import { IResourceDependencyGraphService } from '../services/ResourcesGraphService';
-import { isHumanitecExtensionError } from '../errors/IHumanitecExtensionError';
-import { ILoggerService } from '../services/LoggerService';
+import { IErrorHandlerService } from '../services/ErrorHandlerService';
 
 export class DisplayResourcesGraphController {
  private constructor() {}
 
  static register(
  context: vscode.ExtensionContext,
  resourcesGraphService: IResourceDependencyGraphService,
- logger: ILoggerService
+ errorHandler: IErrorHandlerService
  ) {
  const disposable = vscode.commands.registerCommand(
  'humanitec.display_resources_graph',
@@ -27,15 +26,7 @@ export class DisplayResourcesGraphController {
  );
  panel.webview.html = this.getWebviewContent(graph);
  } catch (error) {
- if (isHumanitecExtensionError(error)) {
- vscode.window.showErrorMessage(error.message());
- logger.error(error.details());
- } else {
- logger.error(JSON.stringify({ error }));
- vscode.window.showErrorMessage(
- 'Unexpected error occurred. Please contact the extension developer'
- );
- }
+ errorHandler.handle(error);
  }
  }
  );

diff --git a/src/controllers/HumanitecSidebarController.ts b/src/controllers/HumanitecSidebarController.ts
@@ -4,8 +4,6 @@ import {
  ResourceTypeTreeItem,
 } from '../providers/AvailableResourceTypesProvider';
 import { IResourceTypeRepository } from '../repos/ResourceTypeRepository';
-import { ILoggerService } from '../services/LoggerService';
-import { isHumanitecExtensionError } from '../errors/IHumanitecExtensionError';
 import {
  OrganizationStructureItem,
  OrganizationStructureProvider,
@@ -18,6 +16,7 @@ import { Organization } from '../domain/Organization';
 import { ConfigKey } from '../domain/ConfigKey';
 import { Application } from '../domain/Application';
 import { ControllerIsAlreadyRegisteredError } from '../errors/ControllerIsAlreadyRegisteredError';
+import { IErrorHandlerService } from '../services/ErrorHandlerService';
 
 export class HumanitecSidebarController {
  private static instance: HumanitecSidebarController;
@@ -34,7 +33,7 @@ export class HumanitecSidebarController {
  applicationRepository: IApplicationRepository,
  environmentRepository: IEnvironmentRepository,
  configurationRepository: IConfigurationRepository,
- logger: ILoggerService
+ errorHandler: IErrorHandlerService
  ) {
  if (this.instance !== undefined) {
  throw new ControllerIsAlreadyRegisteredError(
@@ -43,13 +42,15 @@ export class HumanitecSidebarController {
  }
 
  const availableResourceTypesProvider = new AvailableResourceTypesProvider(
- resourceTypeRepository
+ resourceTypeRepository,
+ errorHandler
  );
  const organizationStructureProvider = new OrganizationStructureProvider(
  organizationRepository,
  applicationRepository,
  environmentRepository,
- configurationRepository
+ configurationRepository,
+ errorHandler
  );
  this.instance = new HumanitecSidebarController(
  availableResourceTypesProvider,
@@ -72,15 +73,7 @@ export class HumanitecSidebarController {
  try {
  availableResourceTypesProvider.refresh();
  } catch (error) {
- if (isHumanitecExtensionError(error)) {
- logger.error(error.details());
- vscode.window.showErrorMessage(error.message());
- } else {
- logger.error(JSON.stringify({ error }));
- vscode.window.showErrorMessage(
- 'Unexpected error occurred. Please contact the extension developer'
- );
- }
+ errorHandler.handle(error);
  }
  }
  );
@@ -92,15 +85,7 @@ export class HumanitecSidebarController {
  try {
  organizationStructureProvider.refresh();
  } catch (error) {
- if (isHumanitecExtensionError(error)) {
- logger.error(error.details());
- vscode.window.showErrorMessage(error.message());
- } else {
- logger.error(JSON.stringify({ error }));
- vscode.window.showErrorMessage(
- 'Unexpected error occurred. Please contact the extension developer'
- );
- }
+ errorHandler.handle(error);
  }
  }
  );
@@ -121,10 +106,7 @@ export class HumanitecSidebarController {
  }
  vscode.env.openExternal(url);
  } catch (error) {
- logger.error(JSON.stringify({ error }));
- vscode.window.showErrorMessage(
- 'Unexpected error occurred. Please contact the extension developer'
- );
+ errorHandler.handle(error);
  }
  }
  );
@@ -179,10 +161,7 @@ export class HumanitecSidebarController {
  await availableResourceTypesProvider.refresh();
  await organizationStructureProvider.refresh();
  } catch (error) {
- logger.error(JSON.stringify({ error }));
- vscode.window.showErrorMessage(
- 'Unexpected error occurred. Please contact the extension developer'
- );
+ errorHandler.handle(error);
  }
  }
  );

diff --git a/src/controllers/InitializeScoreFileController.ts b/src/controllers/InitializeScoreFileController.ts
@@ -1,7 +1,6 @@
 import * as vscode from 'vscode';
 import { IScoreInitializationService } from '../services/ScoreInitializationService';
-import { ILoggerService } from '../services/LoggerService';
-import { isHumanitecExtensionError } from '../errors/IHumanitecExtensionError';
+import { IErrorHandlerService } from '../services/ErrorHandlerService';
 
 export class InitializeScoreFileController {
  private constructor() {}
@@ -10,7 +9,7 @@ export class InitializeScoreFileController {
  context: vscode.ExtensionContext,
  initializationService: IScoreInitializationService,
  enable: boolean,
- logger: ILoggerService
+ errorHandler: IErrorHandlerService
  ) {
  const disposable = vscode.commands.registerCommand(
  'humanitec.score.init',
@@ -43,15 +42,7 @@ export class InitializeScoreFileController {
  vscode.window.showInformationMessage('No workspace is opened');
  }
  } catch (error) {
- if (isHumanitecExtensionError(error)) {
- logger.error(error.details());
- vscode.window.showErrorMessage(error.message());
- } else {
- logger.error(JSON.stringify({ error }));
- vscode.window.showErrorMessage(
- 'Unexpected error occurred. Please contact the extension developer'
- );
- }
+ errorHandler.handle(error);
  }
  }
  );

diff --git a/src/controllers/LoginController.ts b/src/controllers/LoginController.ts
@@ -1,9 +1,8 @@
 import * as vscode from 'vscode';
 import { ISecretRepository } from '../repos/SecretRepository';
 import { SecretKey } from '../domain/SecretKey';
-import { ILoggerService } from '../services/LoggerService';
 import { ILoginService } from '../services/LoginService';
-import { isHumanitecExtensionError } from '../errors/IHumanitecExtensionError';
+import { IErrorHandlerService } from '../services/ErrorHandlerService';
 
 export class LoginController {
  private constructor() {}
@@ -12,7 +11,7 @@ export class LoginController {
  context: vscode.ExtensionContext,
  loginService: ILoginService,
  secrets: ISecretRepository,
- logger: ILoggerService
+ errorHandler: IErrorHandlerService
  ) {
  const disposable = vscode.commands.registerCommand(
  'humanitec.login',
@@ -51,15 +50,7 @@ export class LoginController {
  'Humanitec extension successfully configured!'
  );
  } catch (error) {
- if (isHumanitecExtensionError(error)) {
- vscode.window.showErrorMessage(error.message());
- logger.error(error.details());
- } else {
- vscode.window.showErrorMessage(
- 'Unexpected error occurred. Please contact the extension developer'
- );
- logger.error(JSON.stringify({ error }));
- }
+ errorHandler.handle(error);
  }
  }
  );

diff --git a/src/controllers/OpenConfiguredTerminalController.ts b/src/controllers/OpenConfiguredTerminalController.ts
@@ -3,8 +3,7 @@ import { IConfigurationRepository } from '../repos/ConfigurationRepository';
 import { ISecretRepository } from '../repos/SecretRepository';
 import { SecretKey } from '../domain/SecretKey';
 import { ConfigKey } from '../domain/ConfigKey';
-import { isHumanitecExtensionError } from '../errors/IHumanitecExtensionError';
-import { ILoggerService } from '../services/LoggerService';
+import { IErrorHandlerService } from '../services/ErrorHandlerService';
 
 export class OpenConfiguredTerminalController {
  private constructor() {}
@@ -13,7 +12,7 @@ export class OpenConfiguredTerminalController {
  context: vscode.ExtensionContext,
  configs: IConfigurationRepository,
  secrets: ISecretRepository,
- logger: ILoggerService
+ errorHandler: IErrorHandlerService
  ) {
  const disposable = vscode.commands.registerCommand(
  'humanitec.open_configured_terminal',
@@ -38,15 +37,7 @@ export class OpenConfiguredTerminalController {
 
  terminal.show();
  } catch (error) {
- if (isHumanitecExtensionError(error)) {
- logger.error(error.details());
- vscode.window.showErrorMessage(error.message());
- } else {
- logger.error(JSON.stringify({ error }));
- vscode.window.showErrorMessage(
- 'Unexpected error occurred. Please contact the extension developer'
- );
- }
+ errorHandler.handle(error);
  }
  }
  );

diff --git a/src/controllers/SetTokenController.ts b/src/controllers/SetTokenController.ts
@@ -1,15 +1,15 @@
 import * as vscode from 'vscode';
 import { ISecretRepository } from '../repos/SecretRepository';
 import { SecretKey } from '../domain/SecretKey';
-import { ILoggerService } from '../services/LoggerService';
+import { IErrorHandlerService } from '../services/ErrorHandlerService';
 
 export class SetTokenController {
  private constructor() {}
 
  static register(
  context: vscode.ExtensionContext,
  secrets: ISecretRepository,
- logger: ILoggerService
+ errorHandler: IErrorHandlerService
  ) {
  const disposable = vscode.commands.registerCommand(
  'humanitec.set_token',
@@ -35,10 +35,7 @@ export class SetTokenController {
  );
  }
  } catch (error) {
- logger.error(JSON.stringify({ error }));
- vscode.window.showErrorMessage(
- 'Unexpected error occurred. Please contact the extension developer'
- );
+ errorHandler.handle(error);
  }
  }
  );

diff --git a/src/controllers/ValidateScoreFileController.ts b/src/controllers/ValidateScoreFileController.ts
@@ -8,10 +8,9 @@ import {
  Range,
  TextDocument,
 } from 'vscode';
-import { isHumanitecExtensionError } from '../errors/IHumanitecExtensionError';
-import { ILoggerService } from '../services/LoggerService';
 import { IConfigurationRepository } from '../repos/ConfigurationRepository';
 import { ConfigKey } from '../domain/ConfigKey';
+import { IErrorHandlerService } from '../services/ErrorHandlerService';
 
 export class ValidateScoreFileController {
  private static instance: ValidateScoreFileController;
@@ -29,7 +28,7 @@ export class ValidateScoreFileController {
  context: vscode.ExtensionContext,
  validationService: IScoreValidationService,
  config: IConfigurationRepository,
- logger: ILoggerService
+ errorHandler: IErrorHandlerService
  ) {
  if (this.instance === undefined) {
  this.instance = new ValidateScoreFileController(
@@ -61,15 +60,7 @@ export class ValidateScoreFileController {
  );
  }
  } catch (error) {
- if (isHumanitecExtensionError(error)) {
- vscode.window.showErrorMessage(error.message());
- logger.error(error.details());
- } else {
- vscode.window.showErrorMessage(
- 'Unexpected error occurred. Please contact the extension developer'
- );
- logger.error(JSON.stringify({ error }));
- }
+ errorHandler.handle(error);
  }
  });
  }
@@ -95,7 +86,7 @@ export class ValidateScoreFileController {
  );
  }
  } catch (error) {
- logger.error(JSON.stringify({ error }));
+ errorHandler.handle(error);
  }
  });
  });
@@ -125,7 +116,7 @@ export class ValidateScoreFileController {
  );
  }
  } catch (error) {
- logger.error(JSON.stringify({ error }));
+ errorHandler.handle(error);
  }
  });
  context.subscriptions.push(disposable);

diff --git a/src/errors/HumctlError.ts b/src/errors/HumctlError.ts
@@ -0,0 +1,21 @@
+import { IHumanitecExtensionError } from './IHumanitecExtensionError';
+
+export class HumctlError implements IHumanitecExtensionError {
+ constructor(
+ private readonly command: string,
+ private readonly output: string,
+ private readonly exitCode: number
+ ) {}
+
+ message(): string {
+ return 'Command: ' + this.command + ' returned an unexpected error';
+ }
+
+ details(): string {
+ return JSON.stringify({
+ command: this.command,
+ output: this.output,
+ exitCode: this.exitCode,
+ });
+ }
+}
diff --git a/src/errors/IHumanitecExtensionError.ts b/src/errors/IHumanitecExtensionError.ts
@@ -2,15 +2,3 @@ export interface IHumanitecExtensionError {
  message(): string;
  details(): string;
 }
-
-export function isHumanitecExtensionError(
- error: unknown
-): error is IHumanitecExtensionError {
- const isObject = error !== null && typeof error === 'object';
- if (isObject) {
- const hasMessage = 'message' in error;
- const hasDetails = 'details' in error;
- return hasMessage && hasDetails;
- }
- return false;
-}