zaid.marzguioui/myeasycms-v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor API code and simplify billing display

Browse Source 
The code in the webhook API has been refactored to move the DatabaseWebhookHandlerService instance out of the POST function scope. Furthermore, the display of renewal plan details on the billing page has been simplified and certain parts deemed superfluous have been removed. Numerous types and interfaces in the database.types.ts file have also been corrected and formatted for consistency and improved readability.
This commit is contained in:
giancarlo
2024-03-31 15:13:44 +08:00
parent 2c0c616a2d
commit aa12ecd5a2
10 changed files with 1133 additions and 1026 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
apps/web/.env.development
View File

@@ -20,7 +20,7 @@ NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzd
NEXT_PUBLIC_REQUIRE_EMAIL_CONFIRMATION=true
## THIS IS FOR DEVELOPMENT ONLY - DO NOT USE IN PRODUCTION
SUPABASE_WEBHOOK_SECRET=WEBHOOKSECRET
SUPABASE_DB_WEBHOOK_SECRET=WEBHOOKSECRET
EMAIL_SENDER=test@makerkit.dev
EMAIL_PORT=54325

4
apps/web/app/api/database/webhook/route.ts
View File

@@ -9,9 +9,9 @@ const webhooksSecret = z
.min(1)
.parse(process.env.SUPABASE_DB_WEBHOOK_SECRET);
export async function POST(request: Request) {
const service = new DatabaseWebhookHandlerService();
const service = new DatabaseWebhookHandlerService();
export async function POST(request: Request) {
await service.handleWebhook(request, webhooksSecret);
return new Response(null, {

13
packages/billing-gateway/src/components/current-plan-card.tsx
View File

@@ -34,8 +34,7 @@ export function CurrentPlanCard({
subscription: Database['public']['Tables']['subscriptions']['Row'];
config: BillingConfig;
}>) {
const { plan, product } = getProductPlanPair(config, subscription.variant_id);
const baseLineItem = getBaseLineItem(config, plan.id);
const { plan, product } = getProductPlanPair(config, subscription);
return (
<Card>
@@ -61,16 +60,6 @@ export function CurrentPlanCard({
<span>{product.name}</span>
<CurrentPlanBadge status={subscription.status} />
</div>
<div className={'text-muted-foreground'}>
<Trans
i18nKey="billing:planRenewal"
values={{
interval: subscription.interval,
price: formatCurrency(product.currency, baseLineItem.cost),
}}
/>
</div>
</div>
<div>

26
packages/billing-gateway/src/server/services/billing-event-handler/billing-event-handler.service.ts
View File

@@ -53,19 +53,21 @@ export class BillingEventHandlerService {
const ctx = {
namespace: 'billing',
subscriptionId: subscription.id,
subscriptionId: subscription.subscription_id,
provider: subscription.billing_provider,
accountId: subscription.account_id,
customerId: subscription.customer_id,
};
Logger.info(ctx, 'Processing subscription updated event');
// Handle the subscription updated event
// here we update the subscription in the database
const { error } = await client
.from('subscriptions')
.update(subscription)
.match({ id: subscription.id });
const { error } = await client.rpc('upsert_subscription', {
...subscription,
customer_id: subscription.customer_id,
account_id: subscription.account_id,
});
if (error) {
Logger.error(
@@ -88,24 +90,16 @@ export class BillingEventHandlerService {
const ctx = {
namespace: 'billing',
subscriptionId: subscription.id,
subscriptionId: subscription.subscription_id,
provider: subscription.billing_provider,
accountId: subscription.account_id,
};
Logger.info(ctx, 'Processing checkout session completed event...');
const { id: _, ...data } = subscription;
const { error } = await client.rpc('add_subscription', {
...data,
subscription_id: subscription.id,
const { error } = await client.rpc('upsert_subscription', {
...subscription,
customer_id: customerId,
price_amount: subscription.price_amount ?? 0,
period_starts_at: subscription.period_starts_at!,
period_ends_at: subscription.period_ends_at!,
trial_starts_at: subscription.trial_starts_at!,
trial_ends_at: subscription.trial_ends_at!,
});
if (error) {

10
packages/billing/src/services/billing-webhook-handler.service.ts
View File

@@ -1,8 +1,7 @@
import { Database } from '@kit/supabase/database';
type SubscriptionObject = Database['public']['Tables']['subscriptions'];
type SubscriptionUpdateParams = SubscriptionObject['Update'];
type UpsertSubscriptionParams =
Database['public']['Functions']['upsert_subscription']['Args'];
/**
* Represents an abstract class for handling billing webhook events.
@@ -14,12 +13,13 @@ export abstract class BillingWebhookHandlerService {
event: unknown,
params: {
onCheckoutSessionCompleted: (
subscription: SubscriptionObject['Row'],
subscription: UpsertSubscriptionParams,
customerId: string,
) => Promise<unknown>;
onSubscriptionUpdated: (
subscription: SubscriptionUpdateParams,
subscription: UpsertSubscriptionParams,
customerId: string,
) => Promise<unknown>;
onSubscriptionDeleted: (subscriptionId: string) => Promise<unknown>;

27
packages/database-webhooks/src/server/services/database-webhook-handler.service.ts
View File

@@ -10,9 +10,14 @@ export class DatabaseWebhookHandlerService {
private readonly namespace = 'database-webhook-handler';
async handleWebhook(request: Request, webhooksSecret: string) {
const json = await request.clone().json();
const { table, type } = json as RecordChange<keyof Tables>;
Logger.info(
{
name: this.namespace,
table,
type,
},
'Received webhook from DB. Processing...',
);
@@ -21,11 +26,17 @@ export class DatabaseWebhookHandlerService {
this.assertSignatureIsAuthentic(request, webhooksSecret);
// all good, handle the webhook
const json = await request.json();
await this.handleWebhookBody(json);
// create a client with admin access since we are handling webhooks
// and no user is authenticated
const client = getSupabaseRouteHandlerClient({
admin: true,
});
const { table, type } = json as RecordChange<keyof Tables>;
// handle the webhook
const service = new DatabaseWebhookRouterService(client);
await service.handleWebhook(json);
Logger.info(
{
@@ -37,16 +48,6 @@ export class DatabaseWebhookHandlerService {
);
}
private handleWebhookBody(body: RecordChange<keyof Tables>) {
const client = getSupabaseRouteHandlerClient({
admin: true,
});
const service = new DatabaseWebhookRouterService(client);
return service.handleWebhook(body);
}
private assertSignatureIsAuthentic(request: Request, webhooksSecret: string) {
const header = request.headers.get('X-Supabase-Event-Signature');

98
packages/stripe/src/services/stripe-webhook-handler.service.ts
View File

@@ -7,12 +7,8 @@ import { Database } from '@kit/supabase/database';
import { StripeServerEnvSchema } from '../schema/stripe-server-env.schema';
import { createStripeClient } from './stripe-sdk';
type Subscription = Database['public']['Tables']['subscriptions'];
type InsertSubscriptionParams = Omit<
Subscription['Insert'],
'billing_customer_id'
>;
type UpsertSubscriptionParams =
Database['public']['Functions']['upsert_subscription']['Args'];
export class StripeWebhookHandlerService
implements BillingWebhookHandlerService
@@ -64,11 +60,12 @@ export class StripeWebhookHandlerService
event: Stripe.Event,
params: {
onCheckoutSessionCompleted: (
data: InsertSubscriptionParams,
customerId: string,
data: UpsertSubscriptionParams,
) => Promise<unknown>;
onSubscriptionUpdated: (data: Subscription['Update']) => Promise<unknown>;
onSubscriptionUpdated: (
data: UpsertSubscriptionParams,
) => Promise<unknown>;
onSubscriptionDeleted: (subscriptionId: string) => Promise<unknown>;
},
) {
@@ -111,8 +108,7 @@ export class StripeWebhookHandlerService
private async handleCheckoutSessionCompleted(
event: Stripe.CheckoutSessionCompletedEvent,
onCheckoutCompletedCallback: (
data: Omit<Subscription['Insert'], 'billing_customer_id'>,
customerId: string,
data: UpsertSubscriptionParams,
) => Promise<unknown>,
) {
const stripe = await this.loadStripe();
@@ -134,20 +130,23 @@ export class StripeWebhookHandlerService
const payload = this.buildSubscriptionPayload({
subscription,
accountId,
amount,
}) as InsertSubscriptionParams;
accountId,
customerId,
});
return onCheckoutCompletedCallback(payload, customerId);
return onCheckoutCompletedCallback(payload);
}
private async handleSubscriptionUpdatedEvent(
event: Stripe.CustomerSubscriptionUpdatedEvent,
onSubscriptionUpdatedCallback: (
data: Subscription['Update'],
data: UpsertSubscriptionParams,
) => Promise<unknown>,
) {
const subscription = event.data.object;
const accountId = subscription.metadata.account_id as string;
const customerId = subscription.customer as string;
const amount = subscription.items.data.reduce((acc, item) => {
return (acc + (item.plan.amount ?? 0)) * (item.quantity ?? 1);
@@ -156,6 +155,8 @@ export class StripeWebhookHandlerService
const payload = this.buildSubscriptionPayload({
subscription,
amount,
accountId,
customerId,
});
return onSubscriptionUpdatedCallback(payload);
@@ -173,52 +174,53 @@ export class StripeWebhookHandlerService
private buildSubscriptionPayload(params: {
subscription: Stripe.Subscription;
amount: number;
// we only need the account id if we
// are creating a subscription for an account
accountId?: string;
}) {
accountId: string;
customerId: string;
}): UpsertSubscriptionParams {
const { subscription } = params;
const lineItem = subscription.items.data[0];
const price = lineItem?.price;
const priceId = price?.id as string;
const interval = price?.recurring?.interval ?? null;
const currency = subscription.currency;
const active =
subscription.status === 'active' || subscription.status === 'trialing';
const data = {
billing_provider: this.provider,
id: subscription.id,
status: subscription.status,
active,
price_amount: params.amount,
cancel_at_period_end: subscription.cancel_at_period_end ?? false,
interval: interval as string,
currency: (price as Stripe.Price).currency,
product_id: (price as Stripe.Price).product as string,
variant_id: priceId,
interval_count: price?.recurring?.interval_count ?? 1,
period_starts_at: getISOString(subscription.current_period_start),
period_ends_at: getISOString(subscription.current_period_end),
trial_starts_at: getISOString(subscription.trial_start),
trial_ends_at: getISOString(subscription.trial_end),
} satisfies Omit<InsertSubscriptionParams, 'account_id'>;
const lineItems = subscription.items.data.map((item) => {
const quantity = item.quantity ?? 1;
// when we are creating a subscription for an account
// we need to include the account id
if (params.accountId !== undefined) {
return {
...data,
account_id: params.accountId,
id: item.id,
subscription_id: subscription.id,
product_id: item.price.product as string,
variant_id: item.price.id,
price_amount: item.price.unit_amount,
quantity,
interval: item.price.recurring?.interval as string,
interval_count: item.price.recurring?.interval_count as number,
};
}
});
// otherwise we are updating a subscription
// and we only need to return the update payload
return data;
return {
line_items: lineItems,
billing_provider: this.provider,
subscription_id: subscription.id,
status: subscription.status,
total_amount: params.amount,
active,
currency,
cancel_at_period_end: subscription.cancel_at_period_end ?? false,
period_starts_at: getISOString(
subscription.current_period_start,
) as string,
period_ends_at: getISOString(subscription.current_period_end) as string,
trial_starts_at: getISOString(subscription.trial_start),
trial_ends_at: getISOString(subscription.trial_end),
account_id: params.accountId,
customer_id: params.customerId,
};
}
}
function getISOString(date: number | null) {
return date ? new Date(date * 1000).toISOString() : null;
return date ? new Date(date * 1000).toISOString() : undefined;
}

1665
packages/supabase/src/database.types.ts
View File

File diff suppressed because it is too large Load Diff

292
supabase/migrations/20221215192558_schema.sql
View File

@@ -118,6 +118,16 @@ create type public.subscription_status as ENUM(
'paused'
);
/* Subscription Type
- We create the subscription type for the Supabase MakerKit. These types are used to manage the type of the subscriptions
- The types are 'ONE_OFF' and 'RECURRING'.
- You can add more types as needed.
*/
create type public.subscription_type as enum (
'one-off',
'recurring'
);
/*
* Billing Provider
- We create the billing provider for the Supabase MakerKit. These providers are used to manage the billing provider for the accounts and organizations
@@ -944,28 +954,24 @@ select
* -------------------------------------------------------
*/
-- Subscriptions table
create table if not exists
public.subscriptions (
account_id uuid references public.accounts (id) on delete cascade not null,
billing_customer_id int references public.billing_customers on delete cascade not null,
id text not null primary key,
status public.subscription_status not null,
active bool not null,
billing_provider public.billing_provider not null,
product_id varchar(255) not null,
variant_id varchar(255) not null,
price_amount numeric,
cancel_at_period_end bool not null,
currency varchar(3) not null,
interval varchar(255) not null,
interval_count integer not null check (interval_count > 0),
created_at timestamptz not null default current_timestamp,
updated_at timestamptz not null default current_timestamp,
period_starts_at timestamptz,
period_ends_at timestamptz,
trial_starts_at timestamptz,
trial_ends_at timestamptz
);
create table if not exists public.subscriptions (
id text not null primary key,
account_id uuid references public.accounts (id) on delete cascade not null,
billing_customer_id int references public.billing_customers on delete cascade not null,
status public.subscription_status not null,
type public.subscription_type not null default 'recurring',
total_amount numeric not null,
active bool not null,
billing_provider public.billing_provider not null,
cancel_at_period_end bool not null,
currency varchar(3) not null,
created_at timestamptz not null default current_timestamp,
updated_at timestamptz not null default current_timestamp,
period_starts_at timestamptz not null,
period_ends_at timestamptz not null,
trial_starts_at timestamptz,
trial_ends_at timestamptz
);
comment on table public.subscriptions is 'The subscriptions for an account';
@@ -973,22 +979,16 @@ comment on column public.subscriptions.account_id is 'The account the subscripti
comment on column public.subscriptions.billing_provider is 'The provider of the subscription';
comment on column public.subscriptions.product_id is 'The product ID for the subscription';
comment on column public.subscriptions.variant_id is 'The variant ID for the subscription';
comment on column public.subscriptions.price_amount is 'The price amount for the subscription';
comment on column public.subscriptions.total_amount is 'The total price amount for the subscription';
comment on column public.subscriptions.cancel_at_period_end is 'Whether the subscription will be canceled at the end of the period';
comment on column public.subscriptions.currency is 'The currency for the subscription';
comment on column public.subscriptions.interval is 'The interval for the subscription';
comment on column public.subscriptions.interval_count is 'The interval count for the subscription';
comment on column public.subscriptions.status is 'The status of the subscription';
comment on column public.subscriptions.type is 'The type of the subscription, either one-off or recurring';
comment on column public.subscriptions.period_starts_at is 'The start of the current period for the subscription';
comment on column public.subscriptions.period_ends_at is 'The end of the current period for the subscription';
@@ -1017,103 +1017,177 @@ select
to authenticated using (has_role_on_account (account_id) or account_id = auth.uid ());
-- Functions
create or replace function public.add_subscription (
create or replace function public.upsert_subscription (
account_id uuid,
subscription_id text,
active bool,
total_amount numeric,
status public.subscription_status,
billing_provider public.billing_provider,
product_id varchar(255),
variant_id varchar(255),
price_amount numeric,
cancel_at_period_end bool,
currency varchar(3),
"interval" varchar(255),
interval_count integer,
period_starts_at timestamptz,
period_ends_at timestamptz,
trial_starts_at timestamptz,
trial_ends_at timestamptz,
customer_id varchar(255)
customer_id varchar(255),
line_items jsonb,
trial_starts_at timestamptz default null,
trial_ends_at timestamptz default null,
type public.subscription_type default 'recurring'
) returns public.subscriptions as $$
declare
new_subscription public.subscriptions;
new_billing_customer_id int;
begin
insert into public.billing_customers(
account_id,
provider,
customer_id)
values (
account_id,
billing_provider,
customer_id)
returning
id into new_billing_customer_id;
insert into public.billing_customers(account_id, provider, customer_id)
values (account_id, billing_provider, customer_id)
on conflict (account_id, provider, customer_id) do update
set provider = excluded.provider
returning id into new_billing_customer_id;
insert into public.subscriptions(
account_id,
billing_customer_id,
id,
active,
status,
billing_provider,
product_id,
variant_id,
price_amount,
cancel_at_period_end,
currency,
interval,
interval_count,
period_starts_at,
period_ends_at,
trial_starts_at,
trial_ends_at)
values (
account_id,
new_billing_customer_id,
subscription_id,
active,
status,
billing_provider,
product_id,
variant_id,
price_amount,
cancel_at_period_end,
currency,
interval,
interval_count,
period_starts_at,
period_ends_at,
trial_starts_at,
trial_ends_at)
returning
* into new_subscription;
return new_subscription;
end;
insert into public.subscriptions(
account_id,
billing_customer_id,
id,
active,
total_amount,
status,
type,
billing_provider,
cancel_at_period_end,
currency,
period_starts_at,
period_ends_at,
trial_starts_at,
trial_ends_at)
values (
account_id,
new_billing_customer_id,
subscription_id,
active,
total_amount,
status,
type,
billing_provider,
cancel_at_period_end,
currency,
period_starts_at,
period_ends_at,
trial_starts_at,
trial_ends_at)
on conflict (id) do update
set active = excluded.active,
status = excluded.status,
cancel_at_period_end = excluded.cancel_at_period_end,
currency = excluded.currency,
period_starts_at = excluded.period_starts_at,
period_ends_at = excluded.period_ends_at,
trial_starts_at = excluded.trial_starts_at,
trial_ends_at = excluded.trial_ends_at
returning * into new_subscription;
-- Upsert subscription items
with item_data as (
select
(line_item ->> 'product_id')::varchar as prod_id,
(line_item ->> 'variant_id')::varchar as var_id,
(line_item ->> 'price_amount')::numeric as price_amt,
(line_item ->> 'quantity')::integer as qty,
(line_item ->> 'interval')::varchar as intv,
(line_item ->> 'interval_count')::integer as intv_count
from jsonb_array_elements(line_items) as line_item
)
insert into public.subscription_items(
subscription_id,
product_id,
variant_id,
price_amount,
quantity,
interval,
interval_count)
select
subscription_id,
prod_id,
var_id,
price_amt,
qty,
intv,
intv_count
from item_data
on conflict (subscription_id, product_id, variant_id) do update
set price_amount = excluded.price_amount,
quantity = excluded.quantity,
interval = excluded.interval,
interval_count = excluded.interval_count;
return new_subscription;
end;
$$ language plpgsql;
grant execute on function public.add_subscription (
uuid,
text,
boolean,
public.subscription_status,
public.billing_provider,
varchar,
varchar,
numeric,
boolean,
varchar,
varchar,
integer,
timestamptz,
timestamptz,
timestamptz,
timestamptz,
varchar
grant execute on function public.upsert_subscription (
uuid,
text,
bool,
numeric,
public.subscription_status,
public.billing_provider,
bool,
varchar,
timestamptz,
timestamptz,
varchar,
jsonb,
timestamptz,
timestamptz,
public.subscription_type
) to service_role;
/* -------------------------------------------------------
* Section: Subscription Items
* We create the schema for the subscription items. Subscription items are the items in a subscription.
* For example, a subscription might have a subscription item with the product ID 'prod_123' and the variant ID 'var_123'.
* -------------------------------------------------------
*/
create table if not exists public.subscription_items (
id text not null primary key,
subscription_id text references public.subscriptions (id) on delete cascade not null,
product_id varchar(255) not null,
variant_id varchar(255) not null,
price_amount numeric,
quantity integer not null default 1,
interval varchar(255) not null,
interval_count integer not null check (interval_count > 0),
created_at timestamptz not null default current_timestamp,
updated_at timestamptz not null default current_timestamp
);
comment on table public.subscription_items is 'The items in a subscription';
comment on column public.subscription_items.subscription_id is 'The subscription the item is for';
comment on column public.subscription_items.product_id is 'The product ID for the item';
comment on column public.subscription_items.variant_id is 'The variant ID for the item';
comment on column public.subscription_items.price_amount is 'The price amount for the item';
comment on column public.subscription_items.quantity is 'The quantity of the item';
comment on column public.subscription_items.interval is 'The interval for the item';
comment on column public.subscription_items.interval_count is 'The interval count for the item';
comment on column public.subscription_items.created_at is 'The creation date of the item';
comment on column public.subscription_items.updated_at is 'The last update date of the item';
-- Open up access to subscription_items table for authenticated users and service_role
grant select on table public.subscription_items to authenticated, service_role;
grant insert, update, delete on table public.subscription_items to service_role;
-- RLS
alter table public.subscription_items enable row level security;
-- SELECT: Users can read subscription items on a subscription they are a member of
create policy subscription_items_read_self on public.subscription_items for
select
to authenticated using (
exists (
select 1 from public.subscriptions where id = subscription_id and (account_id = auth.uid () or has_role_on_account (account_id))
)
);
/*
* -------------------------------------------------------
* Section: Functions

22
supabase/seed.sql
View File

@@ -6,18 +6,18 @@
create trigger "accounts_memberships_insert" after insert
on "public"."accounts_memberships" for each row
execute function "supabase_functions"."http_request"(
'http://localhost:3000/api/database/webhook',
'http://host.docker.internal:3000/api/database/webhook',
'POST',
'{"Content-Type":"application/json", "X-Supabase-Event-Signature":"WEBHOOKSECRET"}',
'{}',
'1000'
);
-- this webhook will be triggered after every insert on the accounts_memberships table
create trigger "account_membership_delete" after insert
-- this webhook will be triggered after every delete on the accounts_memberships table
create trigger "account_membership_delete" after delete
on "public"."accounts_memberships" for each row
execute function "supabase_functions"."http_request"(
'http://localhost:3000/api/database/webhook',
'http://host.docker.internal:3000/api/database/webhook',
'POST',
'{"Content-Type":"application/json", "X-Supabase-Event-Signature":"WEBHOOKSECRET"}',
'{}',
@@ -29,7 +29,19 @@ execute function "supabase_functions"."http_request"(
create trigger "account_delete" after delete
on "public"."subscriptions" for each row
execute function "supabase_functions"."http_request"(
'http://localhost:3000/api/database/webhook',
'http://host.docker.internal:3000/api/database/webhook',
'POST',
'{"Content-Type":"application/json", "X-Supabase-Event-Signature":"WEBHOOKSECRET"}',
'{}',
'1000'
);
-- this webhook will be triggered after every insert on the invitations table
-- which should happen when a user invites someone to their account
create trigger "invitations_insert" after insert
on "public"."invitations" for each row
execute function "supabase_functions"."http_request"(
'http://host.docker.internal:3000/api/database/webhook',
'POST',
'{"Content-Type":"application/json", "X-Supabase-Event-Signature":"WEBHOOKSECRET"}',
'{}',