refactor: improve InvalidMessageError message format

re #1994
ecadlabs · May 10, 2023 · c1987f3 · c1987f3
1 parent 7f42f9e
commit c1987f3
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 11 deletions.
diff --git a/packages/taquito-core/src/errors.ts b/packages/taquito-core/src/errors.ts
@@ -106,8 +106,8 @@ export class InvalidMessageError extends ParameterValidationError {
   constructor(public msg: string, errorDetail?: string) {
     super();
     this.name = 'InvalidMessageError';
-    this.message = `Message "${msg}" is invalid.`;
-    errorDetail ? (this.message += ` ${errorDetail}`) : null;
+    this.message = `Invalid message "${msg}"`;
+    errorDetail ? (this.message += `${errorDetail}`) : null;
   }
 }
 

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

diff --git a/packages/taquito-michel-codec/src/base58.ts b/packages/taquito-michel-codec/src/base58.ts
@@ -96,7 +96,7 @@ function sha256(msg: number[] | Uint8Array): number[] {
   const pad = r === 0 ? 0 : 64 - r;
 
   if (msg.length > 268435455) {
-    throw new InvalidMessageError('', `SHA-256 -- message length is too big: ${msg.length}`);
+    throw new InvalidMessageError('', `: Invalid length ${msg.length} is too big -- SHA-256.`);
   }
 
   const l = msg.length << 3;

diff --git a/packages/taquito-utils/src/verify-signature.ts b/packages/taquito-utils/src/verify-signature.ts
@@ -65,10 +65,7 @@ export function verifySignature(
 
 function validateMessageNotEmpty(message: string) {
   if (message === '') {
-    throw new InvalidMessageError(
-      message,
-      'The message provided for verifying signature cannot be empty.'
-    );
+    throw new InvalidMessageError(message, ': Cannot be empty.');
   }
   return message;
 }

diff --git a/packages/taquito-utils/test/verify-signature.spec.ts b/packages/taquito-utils/test/verify-signature.spec.ts
@@ -262,9 +262,7 @@ describe('utils signature validation tests', () => {
         'spsig1cdLkp1RLgUHAp13aRFkZ6MQDPp7xCnjAExGL3MBSdMDmT6JgQSX8cufyDgJRM3sinFtiCzLbsyP6d365EHoNevxhT47nx';
 
       expect(() => verifySignature(message, pk, sig)).toThrowError(InvalidMessageError);
-      expect(() => verifySignature(message, pk, sig)).toThrowError(
-        /message provided for verifying signature cannot be empty/
-      );
+      expect(() => verifySignature(message, pk, sig)).toThrowError(/: Cannot be empty./);
     });
 
     it('Should throw InvalidPublicKeyError if the public key is an empty string', () => {