refactor: improve InvalidBlockHashError message format to be concise

re #1994
ecadlabs · May 10, 2023 · 38ec5e2 · 38ec5e2
1 parent 3224083
commit 38ec5e2
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/packages/taquito-core/src/errors.ts b/packages/taquito-core/src/errors.ts
@@ -64,10 +64,11 @@ export class InvalidAddressError extends ParameterValidationError {
  *  @description Error indicates an invalid block hash being passed or used
  */
 export class InvalidBlockHashError extends ParameterValidationError {
-  constructor(public blockHash: string) {
+  constructor(public blockHash: string, errorDetail?: string) {
     super();
     this.name = 'InvalidBlockHashError';
-    this.message = `Block hash "${blockHash}" is invalid.`;
+    this.message = `Invalid block hash "${blockHash}"`;
+    errorDetail ? (this.message += `${errorDetail}`) : null;
   }
 }
 

diff --git a/packages/taquito-core/test/errors.spec.ts b/packages/taquito-core/test/errors.spec.ts
@@ -103,7 +103,7 @@ describe('common error classes', () => {
     } catch (error) {
       expect(error).toBeInstanceOf(ParameterValidationError);
       expect(error).toBeInstanceOf(InvalidBlockHashError);
-      expect(error.message).toEqual(`Block hash "foo" is invalid.`);
+      expect(error.message).toEqual(`Invalid block hash "foo"`);
     }
   });
 

diff --git a/packages/taquito-local-forging/src/taquito-local-forging.ts b/packages/taquito-local-forging/src/taquito-local-forging.ts
@@ -8,7 +8,7 @@ import { CODEC } from './constants';
 import { decoders } from './decoder';
 import { encoders } from './encoder';
 import { Uint8ArrayConsumer } from './uint8array-consumer';
-import { validateBlock } from '@taquito/utils';
+import { invalidErrorDetail, validateBlock } from '@taquito/utils';
 import { InvalidOperationSchemaError } from './error';
 import { validateMissingProperty, validateOperationKind } from './validator';
 import { ProtocolsHash } from './protocols';
@@ -40,8 +40,9 @@ export class LocalForger implements Forger {
   private codec = getCodec(CODEC.MANAGER, this.protocolHash);
 
   forge(params: ForgeParams): Promise<string> {
-    if (validateBlock(params.branch) !== ValidationResult.VALID) {
-      throw new InvalidBlockHashError(params.branch);
+    const branchValidation = validateBlock(params.branch);
+    if (branchValidation !== ValidationResult.VALID) {
+      throw new InvalidBlockHashError(params.branch, invalidErrorDetail(branchValidation));
     }
 
     for (const content of params.contents) {

diff --git a/packages/taquito-local-forging/test/taquito-local-forging.spec.ts b/packages/taquito-local-forging/test/taquito-local-forging.spec.ts
@@ -116,7 +116,7 @@ describe('Forge and parse operations default protocol', () => {
         localForger.forge(operation);
       }).toThrow(
         expect.objectContaining({
-          message: expect.stringContaining(`Block hash "Invalid_Block_Hash" is invalid`),
+          message: expect.stringContaining(`Invalid block hash "Invalid_Block_Hash"`),
         })
       );
       expect(() => {