Add billing tables #8772

anamarn · 2024-11-27T09:41:57Z

Beforehand, the name of the branch is not representative of the work that has been done in this PR

TLDR:

Solves https://github.com/twentyhq/private-issues/issues/192
Add 3 tables BillingCustomer, BillingProduct and BillingPrice to core, inspired by the Stripe implementation.

In order to test:

Run the command:
npx nx typeorm -- migration:run -d src/database/typeorm/core/core.datasource.ts

Considerations:

I only put the information we should use right now in the Billing module, for instance columns like meter or agreggation formula where omitted in the creation of the tables.
These columns and other ones who fall on the same spectrum will be added as we need them.

If you want to add more information to the table, I'll leave some utility links down bellow:

BillingPrices: https://docs.stripe.com/api/prices/object
BillingCustomer: https://docs.stripe.com/api/customers/object
BillingProduct: https://docs.stripe.com/api/products/object

Next Steps

Use the Stripe Webhook in order to update the tables accordingly

greptile-apps

PR Summary

This PR adds core billing tables and entities inspired by Stripe's data model, establishing the foundation for a comprehensive billing system with customer, product, and price management.

Added migration 1732640291160-addBillingTables.ts creating three new tables (billingCustomer, billingProduct, billingPrice) with proper constraints and relationships
Introduced BillingAvailablePlanKey enum with 'base-plan' and 'pro-plan' options for subscription tier management
Added billing-related environment variables and validation in environment-variables.ts for Stripe integration configuration
Potential data consistency risk in billing-subscription.entity.ts having both stripeCustomerId field and billingCustomer relationship
Added unique constraint IndexOnWorkspaceIdAndStripeCustomerIdUnique in billingCustomer table to prevent duplicate customer records

_{💡 (3/5) Reply to the bot's comments like "Can you suggest a fix for this @greptileai?" or ask follow-up questions!}

_{12 file(s) reviewed, 13 comment(s)}
_{Edit PR Review Bot Settings | Greptile}

packages/twenty-server/src/engine/core-modules/billing/entities/billing-customer.entity.ts

packages/twenty-server/src/engine/core-modules/billing/entities/billing-entitlement.entity.ts

packages/twenty-server/src/engine/core-modules/billing/entities/billing-price.entity.ts

packages/twenty-server/src/engine/core-modules/billing/entities/billing-product.entity.ts

packages/twenty-server/src/engine/core-modules/billing/entities/billing-subscription.entity.ts

packages/twenty-server/src/engine/core-modules/billing/enums/billing-available-plan-key.enum.ts

FelixMalfait · 2024-11-27T12:54:00Z

This looks great! I'm starting to think that this will really cluter self-hosted instances with tables they don't need. Could you please make is so that the app works without those tables if IS_BILLING_ENABLED is false? I pushed a small commit to help your get in that direction (now depending on the environment variable value it will run a different set of migrations).
Thanks!

packages/twenty-server/src/engine/core-modules/billing/entities/billing-price.entity.ts

FelixMalfait · 2024-11-27T13:07:20Z

Could you please look at the Greptile comments and delete them if not relevant (or address them if they are!)? Thanks!

FelixMalfait · 2024-11-27T13:10:15Z

packages/twenty-server/src/engine/core-modules/billing/entities/billing-product.entity.ts

+    enum: Object.values(BillingAvailablePlanKey),
+    nullable: false,
+  })
+  planKey: BillingAvailablePlanKey;


Maybe you've discussed that with @charlesBochet but I guess this comes from metadata column? I would be tempted to use a jsonb metadata column and then cast at the code level to really stick to Stripe as much as we can

agree, let's align on stripe api

charlesBochet · 2024-11-29T11:38:09Z

...twenty-server/src/database/typeorm/core/migrations/billing/1732640291160-addBillingTables.ts

+      `CREATE TYPE "core"."billingProduct_plankey_enum" AS ENUM('base-plan', 'pro-plan')`,
+    );
+    await queryRunner.query(
+      `CREATE TABLE "core"."billingProduct" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "deletedAt" TIMESTAMP WITH TIME ZONE, "createdAt" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), "updatedAt" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), "active" boolean NOT NULL, "stripeProductId" character varying NOT NULL, "defaultPriceId" character varying NOT NULL, "defaultStripePriceId" character varying NOT NULL, "planKey" "core"."billingProduct_plankey_enum" NOT NULL, CONSTRAINT "PK_8bb3c7be66db8e05476808b0ca7" PRIMARY KEY ("id"))`,


missing constraints?

charlesBochet · 2024-11-29T11:38:43Z

...twenty-server/src/database/typeorm/core/migrations/billing/1732640291160-addBillingTables.ts

+      `CREATE TABLE "core"."billingCustomer" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "deletedAt" TIMESTAMP WITH TIME ZONE, "createdAt" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), "updatedAt" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), "stripeCustomerId" character varying NOT NULL, "workspaceId" character varying NOT NULL, CONSTRAINT "IndexOnWorkspaceIdAndStripeCustomerIdUnique" UNIQUE ("workspaceId", "stripeCustomerId"), CONSTRAINT "PK_5fffcd69bf722c297a3d5c3f3bc" PRIMARY KEY ("id"))`,
+    );
+    await queryRunner.query(
+      `CREATE TYPE "core"."billingProduct_plankey_enum" AS ENUM('base-plan', 'pro-plan')`,


planKey (case) but not important

charlesBochet · 2024-11-29T11:39:31Z

...twenty-server/src/database/typeorm/core/migrations/billing/1732640291160-addBillingTables.ts

+      `CREATE TYPE "core"."billingPrice_interval_enum" AS ENUM('day', 'month', 'week', 'year')`,
+    );
+    await queryRunner.query(
+      `CREATE TABLE "core"."billingPrice" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "deletedAt" TIMESTAMP WITH TIME ZONE, "createdAt" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), "updatedAt" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), "stripePriceId" character varying NOT NULL, "active" boolean NOT NULL, "usageType" "core"."billingPrice_usagetype_enum" NOT NULL, "interval" "core"."billingPrice_interval_enum", "productId" character varying NOT NULL, "stripeProductId" character varying NOT NULL, "billingProductId" uuid, CONSTRAINT "IndexOnProductIdAndStripePriceIdUnique" UNIQUE ("productId", "stripePriceId"), CONSTRAINT "PK_13927aef8d4e68e176a61c33d89" PRIMARY KEY ("id"))`,


I think that these stripeIds are actually unique so unicity constraints do not have to be composed, it won't help

charlesBochet · 2024-11-29T11:41:28Z

.../src/database/typeorm/core/migrations/billing/1732710668000-billingTableMigrationTransfer.ts

+        `ALTER TABLE "core"."billingSubscription" ALTER COLUMN "interval" TYPE text`,
+      );
+    } catch (error) {
+      // Column may have already been altered in UseEnumForSubscriptionStatusInterval1719327438923


I don't get these comments ?

I don't see a better way (we could check table existence before but this looks a bit painful to do)

charlesBochet · 2024-11-29T11:43:11Z

packages/twenty-server/src/database/typeorm/core/core.datasource.ts

-  ],
+  migrations:
+    process.env.IS_BILLING_ENABLED === 'true'
+      ? [


I think this works but I'm not sure how it will behave between migrate up and down in case we change IS_BILLING_ENABLED value. Let's say it is not meant to be changed :p

charlesBochet · 2024-11-29T11:49:08Z

...wenty-server/src/database/typeorm/core/migrations/billing/1732725228911-modifBillingTable.ts

+      `ALTER TABLE "core"."billingPrice" DROP CONSTRAINT "IndexOnProductIdAndStripePriceIdUnique"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "core"."billingProduct" DROP COLUMN "defaultPriceId"`,


let's fix the initial migration instead!

same for all updates on product, price here

charlesBochet · 2024-11-29T11:51:46Z

packages/twenty-server/src/engine/core-modules/billing/enums/billing-available-plan-key.enum.ts

@@ -0,0 +1,4 @@
+export enum BillingAvailablePlanKey {


BillingPlanKey (not sure what available means here)

charlesBochet · 2024-11-29T11:52:23Z

packages/twenty-server/src/engine/core-modules/billing/services/billing.service.ts

@@ -22,7 +22,10 @@ export class BillingService {
    return this.environmentService.get('IS_BILLING_ENABLED');
  }

-  async hasWorkspaceActiveSubscriptionOrFreeAccess(workspaceId: string) {
+  async hasWorkspaceActiveSubscriptionOrFreeAccess(


function name does not look right anymore

charlesBochet

Good one, left a few comments.
Let's make 100% this does not break existing workspace:

checkout main, reset database with IS_BILLING_ENABLED false
checkout feat/add-billing-meter, migrate

Same with IS_BILLING_ENABLED true

charlesBochet · 2024-11-29T12:00:50Z

packages/twenty-server/src/engine/core-modules/billing/types/billing-product-metadata.type.ts

+import { BillingAvailablePlanKey } from 'src/engine/core-modules/billing/enums/billing-available-plan-key.enum';
+
+export type BillingProductMetadata = {
+  planKey: BillingAvailablePlanKey;


don't we also need to identify if a product is the PlanBaseProduct too (the one bearing the base price)

BillingProductMetadata = {
planKey: BillingAvailablePlanKey;
isBasePlan?: boolean;
}

what do you think @FelixMalfait @anamarn ?

Yes, you are right this will simplify the queries when accessing the billing tables, the structure looks good to me, i'll implement this in my next commit

anamarn added 2 commits November 26, 2024 18:31

add billing tables

a7c8977

add relation one to many in customer and entitlement

2338fbf

anamarn requested a review from charlesBochet November 27, 2024 09:42

greptile-apps bot reviewed Nov 27, 2024

View reviewed changes

anamarn added the -PR: awaiting review label Nov 27, 2024

Attempt to split migrations in 2 based on env variable

cabc877

FelixMalfait reviewed Nov 27, 2024

View reviewed changes

packages/twenty-server/src/engine/core-modules/billing/entities/billing-price.entity.ts Outdated Show resolved Hide resolved

FelixMalfait reviewed Nov 27, 2024

View reviewed changes

twentyhq deleted a comment from greptile-apps bot Nov 27, 2024

anamarn added 3 commits November 27, 2024 18:35

modified tables and fix workspace entity

8c9ae81

fix loging testing if other things are down

4234cd6

merged two billing service methods into one

7ffa188

charlesBochet assigned Weiko and charlesBochet Nov 29, 2024

charlesBochet reviewed Nov 29, 2024

View reviewed changes

add tables with foreign key on stripes ids

1f3500b

anamarn added 4 commits December 2, 2024 12:56

add dark magic time travel migration

9a29115

Merge branch 'main' into feat/add-billing-meter

b33ab96

add comment about foreign key in entitlement table

4d4e856

fix update subscription and add todos

2094ea2

anamarn requested a review from charlesBochet December 2, 2024 16:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add billing tables #8772

Add billing tables #8772

anamarn commented Nov 27, 2024

greptile-apps bot left a comment

FelixMalfait commented Nov 27, 2024

FelixMalfait commented Nov 27, 2024

FelixMalfait Nov 27, 2024

charlesBochet Nov 29, 2024 •

edited

Loading

charlesBochet Nov 29, 2024

charlesBochet Nov 29, 2024

charlesBochet Nov 29, 2024

charlesBochet Nov 29, 2024

charlesBochet Nov 29, 2024

charlesBochet Nov 29, 2024

charlesBochet Nov 29, 2024

charlesBochet Nov 29, 2024

charlesBochet Nov 29, 2024

charlesBochet Nov 29, 2024

charlesBochet Nov 29, 2024

charlesBochet left a comment

charlesBochet Nov 29, 2024

anamarn Nov 29, 2024

Add billing tables #8772

Are you sure you want to change the base?

Add billing tables #8772

Conversation

anamarn commented Nov 27, 2024

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

FelixMalfait commented Nov 27, 2024

FelixMalfait commented Nov 27, 2024

Choose a reason for hiding this comment

charlesBochet Nov 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

charlesBochet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

charlesBochet Nov 29, 2024 •

edited

Loading