feat(stripe): extend webhook config for test mode secrets (#732)

add two configuration entries in the webhook config for accountTest and connectTest webhook secrets allowing you to register test mode webhooks to the same endpoint. re #731 Co-authored-by: Dennis von der Bey <fermentfan@users.noreply.github.com>
golevelup · May 3, 2024 · d7bba4b · d7bba4b
1 parent d6593e9
commit d7bba4b
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 6 deletions.
diff --git a/packages/stripe/README.md b/packages/stripe/README.md
@@ -42,7 +42,9 @@ Import and add `StripeModule` to the `imports` section of the consuming module (
 Stripe secrets you can get from your Dashboard’s [Webhooks settings](https://dashboard.stripe.com/webhooks). Select an endpoint that you want to obtain the secret for, then click the Click to reveal button.
 
 `account` - The webhook secret registered in the Stripe Dashboard for events on your accounts 
+`account_test` - The webhook secret registered in the Stripe Dashboard for events on your accounts in test mode 
 `connect` - The webhook secret registered in the Stripe Dashboard for events on Connected accounts
+`connect_test` - The webhook secret registered in the Stripe Dashboard for events on Connected accounts in test mode
 
 ```typescript
 import { StripeModule } from '@golevelup/nestjs-stripe';
@@ -54,7 +56,9 @@ import { StripeModule } from '@golevelup/nestjs-stripe';
  webhookConfig: {
  stripeSecrets: {
  account: 'abc',
- connect: 'cba',
+ accountTest: 'cba',
+ connect: 'foo',
+ connectTest: 'bar',
  },
  },
  }),

diff --git a/packages/stripe/src/stripe.interfaces.ts b/packages/stripe/src/stripe.interfaces.ts
@@ -13,11 +13,18 @@ interface StripeSecrets {
  * The webhook secret registered in the Stripe Dashboard for events on your accounts
  */
  account?: string;
-
+ /**
+ * The webhook secret registered in the Stripe Dashboard for events on your accounts in test mode
+ */
+ accountTest?: string;
  /**
  * The webhook secret registered in the Stripe Dashboard for events on Connected accounts
  */
  connect?: string;
+ /**
+ * The webhook secret registered in the Stripe Dashboard for events on Connected accounts in test mode
+ */
+ connectTest?: string;
 }
 
 export interface StripeModuleConfig extends Partial<Stripe.StripeConfig> {

diff --git a/packages/stripe/src/stripe.module.ts b/packages/stripe/src/stripe.module.ts
@@ -89,7 +89,9 @@ export class StripeModule
  const noOneSecretProvided =
  this.stripeModuleConfig.webhookConfig &&
  !this.stripeModuleConfig.webhookConfig?.stripeSecrets.account &&
- !this.stripeModuleConfig.webhookConfig?.stripeSecrets.connect;
+ !this.stripeModuleConfig.webhookConfig?.stripeSecrets.accountTest &&
+ !this.stripeModuleConfig.webhookConfig?.stripeSecrets.connect &&
+ !this.stripeModuleConfig.webhookConfig?.stripeSecrets.connectTest;
 
  if (noOneSecretProvided) {
  const errorMessage =

diff --git a/packages/stripe/src/stripe.payload.service.ts b/packages/stripe/src/stripe.payload.service.ts
@@ -10,7 +10,9 @@ import { StripeModuleConfig } from './stripe.interfaces';
 @Injectable()
 export class StripePayloadService {
  private readonly stripeWebhookSecret: string;
+ private readonly stripeWebhookTestSecret: string;
  private readonly stripeConnectWebhookSecret: string;
+ private readonly stripeConnectWebhookTestSecret: string;
 
  constructor(
  @InjectStripeModuleConfig()
@@ -20,20 +22,37 @@ export class StripePayloadService {
  ) {
  this.stripeWebhookSecret =
  this.config.webhookConfig?.stripeSecrets.account || '';
+ this.stripeWebhookTestSecret =
+ this.config.webhookConfig?.stripeSecrets.accountTest || '';
  this.stripeConnectWebhookSecret =
  this.config.webhookConfig?.stripeSecrets.connect || '';
+ this.stripeConnectWebhookTestSecret =
+ this.config.webhookConfig?.stripeSecrets.connectTest || '';
  }
  tryHydratePayload(signature: string, payload: Buffer): { type: string } {
  const decodedPayload = JSON.parse(
  Buffer.isBuffer(payload) ? payload.toString('utf8') : payload
  );
 
+ let secretToUse: string;
+ if (!decodedPayload.account && decodedPayload.livemode) {
+ secretToUse = this.stripeWebhookSecret;
+ } else if (!decodedPayload.account && !decodedPayload.livemode) {
+ secretToUse = this.stripeWebhookTestSecret;
+ } else if (decodedPayload.account && decodedPayload.livemode) {
+ secretToUse = this.stripeConnectWebhookSecret;
+ } else if (decodedPayload.account && !decodedPayload.livemode) {
+ secretToUse = this.stripeConnectWebhookTestSecret;
+ } else {
+ throw new Error(
+ 'Could not determine which secret to use for this webhook call!'
+ );
+ }
+
  return this.stripeClient.webhooks.constructEvent(
  payload,
  signature,
- decodedPayload.account
- ? this.stripeConnectWebhookSecret
- : this.stripeWebhookSecret
+ secretToUse
  );
  }
 }