Merge pull request #1574 from stripe/anniel-webhooks-error

Split StripeSignatureVerificationError detail field into header and payload
stripe · Oct 11, 2022 · 38b2909 · 38b2909
2 parents deb7bb5 + f9bc027
commit 38b2909
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 50 deletions.
diff --git a/lib/Error.js b/lib/Error.js
diff --git a/lib/Webhooks.js b/lib/Webhooks.js
diff --git a/src/Error.ts b/src/Error.ts
@@ -157,7 +157,16 @@ class StripeConnectionError extends StripeError {}
  * SignatureVerificationError is raised when the signature verification for a
  * webhook fails
  */
-class StripeSignatureVerificationError extends StripeError {}
+class StripeSignatureVerificationError extends StripeError {
+  header: string;
+  payload: string;
+
+  constructor(header: string, payload: string, raw: StripeRawError = {}) {
+    super(raw);
+    this.header = header;
+    this.payload = payload;
+  }
+}
 
 /**
  * IdempotencyError is raised in cases where an idempotency key was used

diff --git a/src/Webhooks.ts b/src/Webhooks.ts
@@ -167,24 +167,14 @@ function parseEventDetails(encodedPayload, encodedHeader, expectedScheme) {
   const details = parseHeader(decodedHeader, expectedScheme);
 
   if (!details || details.timestamp === -1) {
-    throw new StripeSignatureVerificationError({
+    throw new StripeSignatureVerificationError(decodedHeader, decodedPayload, {
       message: 'Unable to extract timestamp and signatures from header',
-      // @ts-expect-error Type '{ decodedHeader: any; decodedPayload: any; }' is not assignable to type 'string'.
-      detail: {
-        decodedHeader,
-        decodedPayload,
-      },
     });
   }
 
   if (!details.signatures.length) {
-    throw new StripeSignatureVerificationError({
+    throw new StripeSignatureVerificationError(decodedHeader, decodedPayload, {
       message: 'No signatures found with expected scheme',
-      // @ts-expect-error Type '{ decodedHeader: any; decodedPayload: any; }' is not assignable to type 'string'.
-      detail: {
-        decodedHeader,
-        decodedPayload,
-      },
     });
   }
 
@@ -207,29 +197,19 @@ function validateComputedSignature(
   ).length;
 
   if (!signatureFound) {
-    throw new StripeSignatureVerificationError({
+    throw new StripeSignatureVerificationError(header, payload, {
       message:
         'No signatures found matching the expected signature for payload.' +
         ' Are you passing the raw request body you received from Stripe?' +
         ' https://github.com/stripe/stripe-node#webhook-signing',
-      // @ts-expect-error Type '{ header: any; payload: any; }' is not assignable to type 'string'.
-      detail: {
-        header,
-        payload,
-      },
     });
   }
 
   const timestampAge = Math.floor(Date.now() / 1000) - details.timestamp;
 
   if (tolerance > 0 && timestampAge > tolerance) {
-    throw new StripeSignatureVerificationError({
+    throw new StripeSignatureVerificationError(header, payload, {
       message: 'Timestamp outside the tolerance zone',
-      // @ts-expect-error Type '{ header: any; payload: any; }' is not assignable to type 'string'.
-      detail: {
-        header,
-        payload,
-      },
     });
   }