Polar integration #461
+1,799
−91
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,9 @@ import type { MiddlewareConfigFn } from 'wasp/server'; | |
| import { PrismaClient } from '@prisma/client'; | ||
| import { stripePaymentProcessor } from './stripe/paymentProcessor'; | ||
| import { lemonSqueezyPaymentProcessor } from './lemonSqueezy/paymentProcessor'; | ||
| import { polarPaymentProcessor } from './polar/paymentProcessor'; | ||
| import { PaymentProcessorId, PaymentProcessors } from './types'; | ||
| import { getActivePaymentProcessor } from './validation'; | ||
|
|
||
| export interface CreateCheckoutSessionArgs { | ||
| userId: string; | ||
|
|
@@ -16,17 +19,91 @@ export interface FetchCustomerPortalUrlArgs { | |
| prismaUserDelegate: PrismaClient['user']; | ||
| }; | ||
|
|
||
| /** | ||
| * Standard interface for all payment processors | ||
| * Provides a consistent API for payment operations across different providers | ||
| */ | ||
| export interface PaymentProcessor { | ||
| id: PaymentProcessorId; | ||
| /** | ||
| * Creates a checkout session for payment processing | ||
| * Handles both subscription and one-time payment flows based on the payment plan configuration | ||
| * @param args Checkout session creation arguments | ||
| * @param args.userId Internal user ID for tracking and database updates | ||
| * @param args.userEmail Customer email address for payment processor customer creation/lookup | ||
| * @param args.paymentPlan Payment plan configuration containing pricing and payment type information | ||
| * @param args.prismaUserDelegate Prisma user delegate for database operations | ||
| * @returns Promise resolving to checkout session with session ID and redirect URL | ||
| * @throws {Error} When payment processor API calls fail or required configuration is missing | ||
| * @example | ||
| * ```typescript | ||
| * const { session } = await paymentProcessor.createCheckoutSession({ | ||
| * userId: 'user_123', | ||
| * userEmail: 'customer@example.com', | ||
| * paymentPlan: hobbyPlan, | ||
| * prismaUserDelegate: context.entities.User | ||
| * }); | ||
| * // Redirect user to session.url for payment | ||
| * ``` | ||
| */ | ||
|
There was a problem hiding this comment. This is too verbose. Jsdocs are useful when using the function is tricky and we want to show examples on how to use it properly. This is also again out of scope for this PR. |
||
| createCheckoutSession: (args: CreateCheckoutSessionArgs) => Promise<{ session: { id: string; url: string }; }>; | ||
| /** | ||
| * Retrieves the customer portal URL for subscription and billing management | ||
| * Allows customers to view billing history, update payment methods, and manage subscriptions | ||
| * @param args Customer portal URL retrieval arguments | ||
| * @param args.userId Internal user ID to lookup customer information | ||
| * @param args.prismaUserDelegate Prisma user delegate for database operations | ||
| * @returns Promise resolving to customer portal URL or null if not available | ||
| * @throws {Error} When user lookup fails or payment processor API calls fail | ||
| * @example | ||
| * ```typescript | ||
| * const portalUrl = await paymentProcessor.fetchCustomerPortalUrl({ | ||
| * userId: 'user_123', | ||
| * prismaUserDelegate: context.entities.User | ||
| * }); | ||
| * if (portalUrl) { | ||
| * // Redirect user to portal for billing management | ||
| * return { redirectUrl: portalUrl }; | ||
| * } | ||
| * ``` | ||
| */ | ||
| fetchCustomerPortalUrl: (args: FetchCustomerPortalUrlArgs) => Promise<string | null>; | ||
| /** | ||
| * Calculates the total revenue from this payment processor | ||
| * @returns Promise resolving to total revenue in dollars | ||
| */ | ||
| getTotalRevenue: () => Promise<number>; | ||
| webhook: PaymentsWebhook; | ||
| webhookMiddlewareConfigFn: MiddlewareConfigFn; | ||
| } | ||
|
|
||
| /** | ||
| * All available payment processors | ||
| */ | ||
| const paymentProcessorMap: Record<PaymentProcessors, PaymentProcessor> = { | ||
|
There was a problem hiding this comment. Related: Comment on We don't want to tie in the payment processors together. |
||
| [PaymentProcessors.Stripe]: stripePaymentProcessor, | ||
| [PaymentProcessors.LemonSqueezy]: lemonSqueezyPaymentProcessor, | ||
| [PaymentProcessors.Polar]: polarPaymentProcessor, | ||
| }; | ||
|
|
||
| /** | ||
| * Get the payment processor instance based on environment configuration or override | ||
| * @param override Optional processor override for testing scenarios | ||
| * @returns The configured payment processor instance | ||
| * @throws {Error} When the specified processor is not found in the processor map | ||
| */ | ||
| export function getPaymentProcessor(override?: PaymentProcessorId): PaymentProcessor { | ||
| const processorId = getActivePaymentProcessor(override); | ||
| const processor = paymentProcessorMap[processorId]; | ||
|
|
||
| if (!processor) { | ||
| throw new Error(`Payment processor '${processorId}' not found. Available processors: ${Object.keys(paymentProcessorMap).join(', ')}`); | ||
| } | ||
|
|
||
| return processor; | ||
| } | ||
|
|
||
| /** | ||
| * The currently configured payment processor. | ||
| */ | ||
| export const paymentProcessor: PaymentProcessor = getPaymentProcessor(); | ||
Genyus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey, it's great to see that you're trying to improve
open-saasfurther above the Polar integration, but I wouldn't do this as part of this PR.Paddle integration PR had the same problem here:
https://github.com/wasp-lang/open-saas/pull/486/files#r2266908329
Doing in this PR will distract us from the main point (Polar), and will prolong the process to get the feature we want.
I've explained in the Paddle PR (linked above) why we don't believe this approach is right for us.
I would kindly ask you to remove non-Polar parts of the PR.
Thanks for the effort.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@FranjoMindek Thanks for the feedback. Happy to proceed, but one of the main reasons I adopted this approach was because I wanted to add e2e tests for Polar and the current architecture makes it impossible to run tests for more than one provider without modifying the source. Do you have any suggestions for how that limitation could be addressed?