chore: cleanup config usage (#103)

kevcodez · web-flow · commit 03fef425ba6c · 2024-01-19T15:23:12.000+08:00
diff --git a/.env.sample b/.env.sample
@@ -1,8 +1,15 @@
-NODE_ENV=production
 DATABASE_URL=postgres://postgres:postgres@host:5432/postgres?sslmode=disable&search_path=stripe
-STRIPE_SECRET_KEY=sk_test_
 STRIPE_WEBHOOK_SECRET=whsec_
+API_KEY=api_key_test
+
+# optional
 SCHEMA=stripe
+
+# optional, only needed when you want to actively sync data and call the Stripe API, not needed for webhook processing
+STRIPE_SECRET_KEY=sk_test_
+
+# optional
 PORT=8080
-API_KEY=api_key_test
+
+# optional
 STRIPE_API_VERSION="2020-08-27"
diff --git a/docker/compose.yml b/docker/compose.yml
@@ -3,7 +3,7 @@ version: '3.8'
 services:
   db:
     container_name: stripe-db
-    image: supabase/postgres:15.1.0.125
+    image: supabase/postgres:15.1.1.4
     command: postgres -c config_file=/etc/postgresql/postgresql.conf
     restart: unless-stopped
     ports:
diff --git a/src/lib/charges.ts b/src/lib/charges.ts
@@ -20,9 +20,7 @@ export const upsertCharges = async (
     ])
   }
 
-  return upsertMany(charges, () =>
-    constructUpsertSql(config.SCHEMA || 'stripe', 'charges', chargeSchema)
-  )
+  return upsertMany(charges, () => constructUpsertSql(config.SCHEMA, 'charges', chargeSchema))
 }
 
 export const backfillCharges = async (chargeIds: string[]) => {
diff --git a/src/lib/customers.ts b/src/lib/customers.ts
@@ -14,9 +14,9 @@ export const upsertCustomers = async (
   return upsertMany(customers, (customer) => {
     // handle deleted customer
     if (customer.deleted) {
-      return constructUpsertSql(config.SCHEMA || 'stripe', 'customers', customerDeletedSchema)
+      return constructUpsertSql(config.SCHEMA, 'customers', customerDeletedSchema)
     } else {
-      return constructUpsertSql(config.SCHEMA || 'stripe', 'customers', customerSchema)
+      return constructUpsertSql(config.SCHEMA, 'customers', customerSchema)
     }
   })
 }
diff --git a/src/lib/disputes.ts b/src/lib/disputes.ts
@@ -15,7 +15,5 @@ export const upsertDisputes = async (
     await backfillCharges(getUniqueIds(disputes, 'charge'))
   }
 
-  return upsertMany(disputes, () =>
-    constructUpsertSql(config.SCHEMA || 'stripe', 'disputes', disputeSchema)
-  )
+  return upsertMany(disputes, () => constructUpsertSql(config.SCHEMA, 'disputes', disputeSchema))
 }
diff --git a/src/lib/invoices.ts b/src/lib/invoices.ts
@@ -21,9 +21,7 @@ export const upsertInvoices = async (
     ])
   }
 
-  return upsertMany(invoices, () =>
-    constructUpsertSql(config.SCHEMA || 'stripe', 'invoices', invoiceSchema)
-  )
+  return upsertMany(invoices, () => constructUpsertSql(config.SCHEMA, 'invoices', invoiceSchema))
 }
 
 export const backfillInvoices = async (invoiceIds: string[]) => {
diff --git a/src/lib/payment_intents.ts b/src/lib/payment_intents.ts
@@ -20,6 +20,6 @@ export const upsertPaymentIntents = async (
   }
 
   return upsertMany(paymentIntents, () =>
-    constructUpsertSql(config.SCHEMA || 'stripe', 'payment_intents', paymentIntentSchema)
+    constructUpsertSql(config.SCHEMA, 'payment_intents', paymentIntentSchema)
   )
 }
diff --git a/src/lib/payment_methods.ts b/src/lib/payment_methods.ts
@@ -16,6 +16,6 @@ export const upsertPaymentMethods = async (
   }
 
   return upsertMany(paymentMethods, () =>
-    constructUpsertSql(config.SCHEMA || 'stripe', 'payment_methods', paymentMethodsSchema)
+    constructUpsertSql(config.SCHEMA, 'payment_methods', paymentMethodsSchema)
   )
 }
diff --git a/src/lib/plans.ts b/src/lib/plans.ts
@@ -17,7 +17,7 @@ export const upsertPlans = async (
     await backfillProducts(getUniqueIds(plans, 'product'))
   }
 
-  return upsertMany(plans, () => constructUpsertSql(config.SCHEMA || 'stripe', 'plans', planSchema))
+  return upsertMany(plans, () => constructUpsertSql(config.SCHEMA, 'plans', planSchema))
 }
 
 export const deletePlan = async (id: string): Promise<boolean> => {
diff --git a/src/lib/prices.ts b/src/lib/prices.ts
@@ -17,9 +17,7 @@ export const upsertPrices = async (
     await backfillProducts(getUniqueIds(prices, 'product'))
   }
 
-  return upsertMany(prices, () =>
-    constructUpsertSql(config.SCHEMA || 'stripe', 'prices', priceSchema)
-  )
+  return upsertMany(prices, () => constructUpsertSql(config.SCHEMA, 'prices', priceSchema))
 }
 
 export const deletePrice = async (id: string): Promise<boolean> => {
diff --git a/src/lib/products.ts b/src/lib/products.ts
@@ -11,9 +11,7 @@ import Stripe from 'stripe'
 const config = getConfig()
 
 export const upsertProducts = async (products: Product.Product[]): Promise<Product.Product[]> => {
-  return upsertMany(products, () =>
-    constructUpsertSql(config.SCHEMA || 'stripe', 'products', productSchema)
-  )
+  return upsertMany(products, () => constructUpsertSql(config.SCHEMA, 'products', productSchema))
 }
 
 export const deleteProduct = async (id: string): Promise<boolean> => {
diff --git a/src/lib/setup_intents.ts b/src/lib/setup_intents.ts
@@ -16,6 +16,6 @@ export const upsertSetupIntents = async (
   }
 
   return upsertMany(setupIntents, () =>
-    constructUpsertSql(config.SCHEMA || 'stripe', 'setup_intents', setupIntentsSchema)
+    constructUpsertSql(config.SCHEMA, 'setup_intents', setupIntentsSchema)
   )
 }
diff --git a/src/lib/subscription_items.ts b/src/lib/subscription_items.ts
@@ -27,7 +27,7 @@ export const upsertSubscriptionItems = async (
   })
 
   await upsertMany(modifiedSubscriptionItems, () =>
-    constructUpsertSql(config.SCHEMA || 'stripe', 'subscription_items', subscriptionItemSchema)
+    constructUpsertSql(config.SCHEMA, 'subscription_items', subscriptionItemSchema)
   )
 }
 
diff --git a/src/lib/subscription_schedules.ts b/src/lib/subscription_schedules.ts
@@ -21,11 +21,7 @@ export const upsertSubscriptionSchedules = async (
 
   // Run it
   const rows = await upsertMany(subscriptionSchedules, () =>
-    constructUpsertSql(
-      config.SCHEMA || 'stripe',
-      'subscription_schedules',
-      subscriptionScheduleSchema
-    )
+    constructUpsertSql(config.SCHEMA, 'subscription_schedules', subscriptionScheduleSchema)
   )
 
   return rows
diff --git a/src/lib/subscriptions.ts b/src/lib/subscriptions.ts
@@ -22,7 +22,7 @@ export const upsertSubscriptions = async (
 
   // Run it
   const rows = await upsertMany(subscriptions, () =>
-    constructUpsertSql(config.SCHEMA || 'stripe', 'subscriptions', subscriptionSchema)
+    constructUpsertSql(config.SCHEMA, 'subscriptions', subscriptionSchema)
   )
 
   // Upsert subscription items into a separate table
diff --git a/src/server.ts b/src/server.ts
@@ -20,12 +20,12 @@ const logger = pino({
 const main = async () => {
   const app: FastifyInstance<Server, IncomingMessage, ServerResponse> = await createServer({
     logger,
-    exposeDocs: process.env.NODE_ENV !== 'production',
+    exposeDocs: getConfig().NODE_ENV !== 'production',
     requestIdHeader: 'Request-Id',
   })
 
   // Init config
-  const port = process.env.PORT || 8080
+  const port = getConfig().PORT
 
   // Init DB
   const dbConfig = {
diff --git a/src/utils/StripeClientManager.ts b/src/utils/StripeClientManager.ts
@@ -1,10 +1,11 @@
 import Stripe from 'stripe'
+import { getConfig } from './config'
 
-export const stripe = new Stripe(process.env.STRIPE_SECRET_KEY || '', {
+export const stripe = new Stripe(getConfig().STRIPE_SECRET_KEY, {
   // https://github.com/stripe/stripe-node#configuration
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
-  apiVersion: process.env.STRIPE_API_VERSION || '2020-08-27',
+  apiVersion: getConfig().STRIPE_API_VERSION,
   appInfo: {
     name: 'Stripe Postgres Sync',
   },
diff --git a/src/utils/config.ts b/src/utils/config.ts
@@ -1,31 +1,49 @@
 import dotenv from 'dotenv'
 
 type configType = {
+  /** Postgres database URL including authentication */
   DATABASE_URL: string
+
   NODE_ENV: string
+
+  /** Database schema name. */
   SCHEMA: string
+
+  /** Stripe secret key used to authenticate requests to the Stripe API. Defaults to empty string */
   STRIPE_SECRET_KEY: string
+
+  /** Webhook secret from Stripe to verify the signature of webhook events. */
   STRIPE_WEBHOOK_SECRET: string
+
+  /** API_KEY is used to authenticate requests to the sync-engine. */
   API_KEY: string
+
+  /** Stripe API version for the webhooks, defaults to 2020-08-27 */
+  STRIPE_API_VERSION: string
+
+  /** Port number the API is running on, defaults to 8080 */
+  PORT: number
 }
 
-function getConfigFromEnv(key: string): string {
+function getConfigFromEnv(key: string, defaultValue?: string): string {
   const value = process.env[key]
-  if (!value) {
+  if (!value && defaultValue === undefined) {
     throw new Error(`${key} is undefined`)
   }
-  return value
+  return value || defaultValue!
 }
 
 export function getConfig(): configType {
   dotenv.config()
 
   return {
     DATABASE_URL: getConfigFromEnv('DATABASE_URL'),
-    SCHEMA: getConfigFromEnv('SCHEMA'),
+    SCHEMA: getConfigFromEnv('SCHEMA', 'stripe'),
     NODE_ENV: getConfigFromEnv('NODE_ENV'),
-    STRIPE_SECRET_KEY: getConfigFromEnv('STRIPE_SECRET_KEY'),
+    STRIPE_SECRET_KEY: getConfigFromEnv('STRIPE_SECRET_KEY', ''),
     STRIPE_WEBHOOK_SECRET: getConfigFromEnv('STRIPE_WEBHOOK_SECRET'),
-    API_KEY: getConfigFromEnv('API_KEY'),
+    API_KEY: getConfigFromEnv('API_KEY', 'false'),
+    STRIPE_API_VERSION: getConfigFromEnv('STRIPE_API_VERSION', '2020-08-27'),
+    PORT: Number(getConfigFromEnv('PORT', '8080')),
   }
 }
diff --git a/test/helpers/stripe.ts b/test/helpers/stripe.ts
@@ -1,10 +1,11 @@
 import Stripe from 'stripe'
+import { getConfig } from '../../src/utils/config'
 
-const stripe = new Stripe(process.env.STRIPE_SECRET_KEY || '', {
+const stripe = new Stripe(getConfig().STRIPE_SECRET_KEY, {
   // https://github.com/stripe/stripe-node#configuration
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
-  apiVersion: process.env.STRIPE_API_VERSION || '2020-08-27',
+  apiVersion: getConfig().STRIPE_API_VERSION,
   appInfo: {
     name: 'Stripe Postgres Sync',
   },
diff --git a/test/webhooks.test.ts b/test/webhooks.test.ts
@@ -2,6 +2,7 @@
 import { FastifyInstance } from 'fastify'
 import { createHmac } from 'node:crypto'
 import { createServer } from '../src/app'
+import { getConfig } from '../src/utils/config'
 import stripeMock from './helpers/stripe'
 import 'dotenv/config'
 
@@ -10,7 +11,7 @@ jest.doMock('stripe', () => {
 })
 
 const unixtime = Math.floor(new Date().getTime() / 1000)
-const stripeWebhookSecret = process.env.STRIPE_WEBHOOK_SECRET || ''
+const stripeWebhookSecret = getConfig().STRIPE_WEBHOOK_SECRET
 
 describe('/webhooks', () => {
   let server: FastifyInstance

Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,7 @@ export const upsertCharges = async (`
`20`	`20`	`])`
`21`	`21`	`}`
`22`	`22`
`23`		`- return upsertMany(charges, () =>`
`24`		`- constructUpsertSql(config.SCHEMA \|\| 'stripe', 'charges', chargeSchema)`
`25`		`- )`
	`23`	`+ return upsertMany(charges, () => constructUpsertSql(config.SCHEMA, 'charges', chargeSchema))`
`26`	`24`	`}`
`27`	`25`
`28`	`26`	`export const backfillCharges = async (chargeIds: string[]) => {`
Original file line number	Diff line number	Diff line change
`@@ -14,9 +14,9 @@ export const upsertCustomers = async (`
`14`	`14`	`return upsertMany(customers, (customer) => {`
`15`	`15`	`// handle deleted customer`
`16`	`16`	`if (customer.deleted) {`
`17`		`- return constructUpsertSql(config.SCHEMA \|\| 'stripe', 'customers', customerDeletedSchema)`
	`17`	`+ return constructUpsertSql(config.SCHEMA, 'customers', customerDeletedSchema)`
`18`	`18`	`} else {`
`19`		`- return constructUpsertSql(config.SCHEMA \|\| 'stripe', 'customers', customerSchema)`
	`19`	`+ return constructUpsertSql(config.SCHEMA, 'customers', customerSchema)`
`20`	`20`	`}`
`21`	`21`	`})`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,5 @@ export const upsertDisputes = async (`
`15`	`15`	`await backfillCharges(getUniqueIds(disputes, 'charge'))`
`16`	`16`	`}`
`17`	`17`
`18`		`- return upsertMany(disputes, () =>`
`19`		`- constructUpsertSql(config.SCHEMA \|\| 'stripe', 'disputes', disputeSchema)`
`20`		`- )`
	`18`	`+ return upsertMany(disputes, () => constructUpsertSql(config.SCHEMA, 'disputes', disputeSchema))`
`21`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,7 @@ export const upsertInvoices = async (`
`21`	`21`	`])`
`22`	`22`	`}`
`23`	`23`
`24`		`- return upsertMany(invoices, () =>`
`25`		`- constructUpsertSql(config.SCHEMA \|\| 'stripe', 'invoices', invoiceSchema)`
`26`		`- )`
	`24`	`+ return upsertMany(invoices, () => constructUpsertSql(config.SCHEMA, 'invoices', invoiceSchema))`
`27`	`25`	`}`
`28`	`26`
`29`	`27`	`export const backfillInvoices = async (invoiceIds: string[]) => {`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,6 @@ export const upsertPaymentIntents = async (`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`return upsertMany(paymentIntents, () =>`
`23`		`- constructUpsertSql(config.SCHEMA \|\| 'stripe', 'payment_intents', paymentIntentSchema)`
	`23`	`+ constructUpsertSql(config.SCHEMA, 'payment_intents', paymentIntentSchema)`
`24`	`24`	`)`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,6 @@ export const upsertPaymentMethods = async (`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`return upsertMany(paymentMethods, () =>`
`19`		`- constructUpsertSql(config.SCHEMA \|\| 'stripe', 'payment_methods', paymentMethodsSchema)`
	`19`	`+ constructUpsertSql(config.SCHEMA, 'payment_methods', paymentMethodsSchema)`
`20`	`20`	`)`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ export const upsertPlans = async (`
`17`	`17`	`await backfillProducts(getUniqueIds(plans, 'product'))`
`18`	`18`	`}`
`19`	`19`
`20`		`- return upsertMany(plans, () => constructUpsertSql(config.SCHEMA \|\| 'stripe', 'plans', planSchema))`
	`20`	`+ return upsertMany(plans, () => constructUpsertSql(config.SCHEMA, 'plans', planSchema))`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`export const deletePlan = async (id: string): Promise<boolean> => {`
Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,7 @@ export const upsertPrices = async (`
`17`	`17`	`await backfillProducts(getUniqueIds(prices, 'product'))`
`18`	`18`	`}`
`19`	`19`
`20`		`- return upsertMany(prices, () =>`
`21`		`- constructUpsertSql(config.SCHEMA \|\| 'stripe', 'prices', priceSchema)`
`22`		`- )`
	`20`	`+ return upsertMany(prices, () => constructUpsertSql(config.SCHEMA, 'prices', priceSchema))`
`23`	`21`	`}`
`24`	`22`
`25`	`23`	`export const deletePrice = async (id: string): Promise<boolean> => {`