Add entitlement table and sso stripe feature #8608
Open
+285
−119
Conversation
This file contains 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
packages/twenty-server/src/engine/core-modules/billing/billing.controller.ts
Show resolved
Hide resolved
| event.data, | ||
| ); | ||
| } catch (error) { | ||
| res.status(500).end(); |
There was a problem hiding this comment.
catch (BillingCustomerNotFoundException) { 404)
catch(error) { 500 }
There was a problem hiding this comment.
No need for catch(error) { 500 } just catch (BillingCustomerNotFoundException) { 404)
| } catch (error) { | ||
| res.status(500).end(); | ||
|
|
||
| return; |
charlesBochet
approved these changes
Nov 20, 2024
| @@ -3,7 +3,7 @@ import { ArgsType, Field } from '@nestjs/graphql'; | |||
| import { IsNotEmpty, IsOptional, IsString } from 'class-validator'; | |||
| import Stripe from 'stripe'; | |||
|
|
|||
| import { SubscriptionInterval } from 'src/engine/core-modules/billing/entities/billing-subscription.entity'; | |||
| import { SubscriptionInterval } from 'src/engine/core-modules/billing/enums/subcription-interval.enum'; | |||
There was a problem hiding this comment.
prefix with billing
billing-subscription-interval.enum
| @@ -2,7 +2,7 @@ import { ArgsType, Field } from '@nestjs/graphql'; | |||
|
|
|||
| import { IsNotEmpty, IsString } from 'class-validator'; | |||
|
|
|||
| import { AvailableProduct } from 'src/engine/core-modules/billing/interfaces/available-product.interface'; | |||
| import { AvailableProduct } from 'src/engine/core-modules/billing/enums/available-product.enum'; | |||
| CUSTOMER_SUBSCRIPTION_UPDATED = 'customer.subscription.updated', | ||
| CUSTOMER_SUBSCRIPTION_DELETED = 'customer.subscription.deleted', | ||
| SETUP_INTENT_SUCCEEDED = 'setup_intent.succeeded', | ||
| CUSTOMER_ACTIVE_ENTITLEMENT = 'entitlements.active_entitlement_summary.updated', |
There was a problem hiding this comment.
CUSTOMER_ACTIVE_ENTITLEMENT_UDPATED
| @@ -148,6 +97,23 @@ export class BillingSubscriptionService { | |||
| } | |||
| } | |||
|
|
|||
| async getWorkspaceEntitlementByKey( | |||
| workspaceId: string, | |||
| lookupKey: FeatureStripeLookupKey, | |||
There was a problem hiding this comment.
key: BillingEntitlementKey
| value: true, | ||
| }); | ||
|
|
||
| if (!entitlement?.value) { |
There was a problem hiding this comment.
split to be fully explicit
if (entitlement === undefined) { return false; }
return entitlement.value
| @@ -0,0 +1,3 @@ | |||
| export enum FeatureStripeLookupKey { | |||
packages/twenty-server/src/engine/core-modules/billing/services/billing-webhook.service.ts
Show resolved
Hide resolved
| const workspaceId = billingSubscription.workspaceId; | ||
| const stripeCustomerId = data.object.customer; | ||
|
|
||
| const currentEntitlements = data.object.entitlements.data.map( |
There was a problem hiding this comment.
currentEntitlement ==> activeEntitlement everywhere
currentEntitlements => activeEntitlementKeys
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
TLDR
Added Billing Entitlement table, based on stripe customer.ActiveEntitlements webhook event. In this table it has a key value pair with each key being the stripe feature lookup key and the value a boolean. We use this table in order to see if SSO or other feaures are enabled by workspace.
In order to test: twenty-server
Billing:
Auth:
Stripe Webhook:
Migration:
In order to test: twenty site
Considerations
The data from the Entitlement table is updated based on the stripe webhook responses, and we use the customerActiveEntitlemet response to update the info on the table, however this event doesnt have the metadata containing the workspaceId. Because we cannot control at wich order the webhook send events, we force a server error if the entitlements are updated before the BillingSubscription. Stripe resends the event based on a exponential backoff (for more info see https://docs.stripe.com/webhooks#retries ) because we are in test mode Stripe retries three times over a few hours. So if the BillingEntitlement is not updated it is completely normal and it will be updated when stripe resends the event.