blsmedia/bot
2
0
Fork 0
Code Activity

🛂 (billing) Add isPastDue field in workspace (#1046)

Browse Source 
Closes #1039

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
  - Workspaces now include additional status indicator: `isPastDue`.
- New pages for handling workspaces that are past due. Meaning, an
invoice is unpaid.

- **Bug Fixes**
- Fixed issues with workspace status checks and redirections for
suspended workspaces.

- **Refactor**
- Refactored workspace-related API functions to accommodate new status
fields.
- Improved permission checks for reading and writing typebots based on
workspace status.

- **Chores**
  - Database schema updated to include `isPastDue` field for workspaces.
- Implemented new webhook event handling for subscription and invoice
updates.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
Baptiste Arnaud
2023-11-23 08:16:23 +01:00
committed by GitHub
parent 94886ca58e
commit ca79934ef5
27 changed files with 450 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
apps/builder/src/features/blocks/logic/typebotLink/api/getLinkedTypebots.ts
View File

@ -56,7 +56,17 @@ export const getLinkedTypebots = authenticatedProcedure
variables: true,
name: true,
createdAt: true,
workspaceId: true,
workspace: {
select: {
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
},
},
},
},
collaborators: {
select: {
type: true,
@ -97,7 +107,17 @@ export const getLinkedTypebots = authenticatedProcedure
variables: true,
name: true,
createdAt: true,
workspaceId: true,
workspace: {
select: {
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
},
},
},
},
collaborators: {
select: {
type: true,

11
apps/builder/src/features/collaboration/api/getCollaborators.ts
View File

@ -32,6 +32,17 @@ export const getCollaborators = authenticatedProcedure
},
include: {
collaborators: true,
workspace: {
select: {
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
},
},
},
},
},
})
if (

13
apps/builder/src/features/results/api/deleteResults.ts
View File

@ -36,8 +36,19 @@ export const deleteResults = authenticatedProcedure
id: typebotId,
},
select: {
workspaceId: true,
groups: true,
workspace: {
select: {
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
role: true,
},
},
},
},
collaborators: {
select: {
userId: true,

12
apps/builder/src/features/results/api/getResult.ts
View File

@ -33,8 +33,18 @@ export const getResult = authenticatedProcedure
},
select: {
id: true,
workspaceId: true,
groups: true,
workspace: {
select: {
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
},
},
},
},
collaborators: {
select: {
userId: true,

12
apps/builder/src/features/results/api/getResultLogs.ts
View File

@ -28,8 +28,18 @@ export const getResultLogs = authenticatedProcedure
},
select: {
id: true,
workspaceId: true,
groups: true,
workspace: {
select: {
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
},
},
},
},
collaborators: {
select: {
userId: true,

12
apps/builder/src/features/results/api/getResults.ts
View File

@ -44,7 +44,6 @@ export const getResults = authenticatedProcedure
},
select: {
id: true,
workspaceId: true,
groups: true,
collaborators: {
select: {
@ -52,6 +51,17 @@ export const getResults = authenticatedProcedure
type: true,
},
},
workspace: {
select: {
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
},
},
},
},
},
})
if (!typebot || (await isReadTypebotForbidden(typebot, user)))

2
apps/builder/src/features/telemetry/api/processTelemetryEvent.ts
View File

@ -81,7 +81,7 @@ export const processTelemetryEvent = authenticatedProcedure
client.capture({
distinctId: event.userId,
event: event.name,
properties: event.data,
properties: 'data' in event ? event.data : undefined,
groups,
})
})

13
apps/builder/src/features/typebot/api/deleteTypebot.ts
View File

@ -33,8 +33,19 @@ export const deleteTypebot = authenticatedProcedure
},
select: {
id: true,
workspaceId: true,
groups: true,
workspace: {
select: {
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
role: true,
},
},
},
},
collaborators: {
select: {
userId: true,

11
apps/builder/src/features/typebot/api/getPublishedTypebot.ts
View File

@ -52,6 +52,17 @@ export const getPublishedTypebot = authenticatedProcedure
include: {
collaborators: true,
publishedTypebot: true,
workspace: {
select: {
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
},
},
},
},
},
})
if (

11
apps/builder/src/features/typebot/api/getTypebot.ts
View File

@ -41,6 +41,17 @@ export const getTypebot = authenticatedProcedure
},
include: {
collaborators: true,
workspace: {
select: {
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
},
},
},
},
},
})
if (

8
apps/builder/src/features/typebot/api/publishTypebot.ts
View File

@ -46,6 +46,14 @@ export const publishTypebot = authenticatedProcedure
workspace: {
select: {
plan: true,
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
role: true,
},
},
},
},
},

12
apps/builder/src/features/typebot/api/unpublishTypebot.ts
View File

@ -32,6 +32,18 @@ export const unpublishTypebot = authenticatedProcedure
include: {
collaborators: true,
publishedTypebot: true,
workspace: {
select: {
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
role: true,
},
},
},
},
},
})
if (!existingTypebot?.publishedTypebot)

12
apps/builder/src/features/typebot/api/updateTypebot.ts
View File

@ -79,7 +79,6 @@ export const updateTypebot = authenticatedProcedure
id: true,
customDomain: true,
publicId: true,
workspaceId: true,
collaborators: {
select: {
userId: true,
@ -88,7 +87,16 @@ export const updateTypebot = authenticatedProcedure
},
workspace: {
select: {
id: true,
plan: true,
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
role: true,
},
},
},
},
updatedAt: true,
@ -160,7 +168,7 @@ export const updateTypebot = authenticatedProcedure
selectedThemeTemplateId: typebot.selectedThemeTemplateId,
events: typebot.events ?? undefined,
groups: typebot.groups
? await sanitizeGroups(existingTypebot.workspaceId)(typebot.groups)
? await sanitizeGroups(existingTypebot.workspace.id)(typebot.groups)
: undefined,
theme: typebot.theme ? typebot.theme : undefined,
settings: typebot.settings

37
apps/builder/src/features/typebot/helpers/isReadTypebotForbidden.ts
View File

@ -1,26 +1,25 @@
import prisma from '@typebot.io/lib/prisma'
import { env } from '@typebot.io/env'
import { CollaboratorsOnTypebots, User } from '@typebot.io/prisma'
import { Typebot } from '@typebot.io/schemas'
import {
CollaboratorsOnTypebots,
User,
Workspace,
MemberInWorkspace,
} from '@typebot.io/prisma'
export const isReadTypebotForbidden = async (
typebot: Pick<Typebot, 'workspaceId'> & {
typebot: {
collaborators: Pick<CollaboratorsOnTypebots, 'userId'>[]
} & {
workspace: Pick<Workspace, 'isQuarantined' | 'isPastDue'> & {
members: Pick<MemberInWorkspace, 'userId'>[]
}
},
user: Pick<User, 'email' | 'id'>
) => {
if (
env.ADMIN_EMAIL === user.email ||
typebot.collaborators.find(
) =>
typebot.workspace.isQuarantined ||
typebot.workspace.isPastDue ||
(env.ADMIN_EMAIL !== user.email &&
!typebot.collaborators.some(
(collaborator) => collaborator.userId === user.id
)
)
return false
const memberInWorkspace = await prisma.memberInWorkspace.findFirst({
where: {
workspaceId: typebot.workspaceId,
userId: user.id,
},
})
return memberInWorkspace === null
}
) &&
!typebot.workspace.members.some((member) => member.userId === user.id))

34
apps/builder/src/features/typebot/helpers/isWriteTypebotForbidden.ts
View File

@ -1,29 +1,31 @@
import prisma from '@typebot.io/lib/prisma'
import {
CollaborationType,
CollaboratorsOnTypebots,
MemberInWorkspace,
User,
Workspace,
} from '@typebot.io/prisma'
import { Typebot } from '@typebot.io/schemas'
import { isNotDefined } from '@typebot.io/lib'
export const isWriteTypebotForbidden = async (
typebot: Pick<Typebot, 'workspaceId'> & {
typebot: {
collaborators: Pick<CollaboratorsOnTypebots, 'userId' | 'type'>[]
} & {
workspace: Pick<Workspace, 'isQuarantined' | 'isPastDue'> & {
members: Pick<MemberInWorkspace, 'userId' | 'role'>[]
}
},
user: Pick<User, 'id'>
) => {
if (
typebot.collaborators.find(
(collaborator) => collaborator.userId === user.id
)?.type === CollaborationType.WRITE
return (
typebot.workspace.isQuarantined ||
typebot.workspace.isPastDue ||
!(
typebot.collaborators.find(
(collaborator) => collaborator.userId === user.id
)?.type === CollaborationType.WRITE &&
typebot.workspace.members.some(
(m) => m.userId === user.id && m.role !== 'GUEST'
)
)
)
return false
const memberInWorkspace = await prisma.memberInWorkspace.findFirst({
where: {
workspaceId: typebot.workspaceId,
userId: user.id,
},
})
return isNotDefined(memberInWorkspace) || memberInWorkspace.role === 'GUEST'
}

14
apps/builder/src/features/upload/api/generateUploadUrl.ts
View File

@ -147,7 +147,19 @@ const parseFilePath = async ({
id: input.typebotId,
},
select: {
workspaceId: true,
workspace: {
select: {
plan: true,
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
role: true,
},
},
},
},
collaborators: {
select: {
userId: true,

12
apps/builder/src/features/whatsapp/startWhatsAppPreview.ts
View File

@ -57,7 +57,17 @@ export const startWhatsAppPreview = authenticatedProcedure
},
select: {
id: true,
workspaceId: true,
workspace: {
select: {
isQuarantined: true,
isPastDue: true,
members: {
select: {
userId: true,
},
},
},
},
collaborators: {
select: {
userId: true,

20
apps/builder/src/features/workspace/WorkspaceProvider.tsx
View File

@ -6,7 +6,7 @@ import {
useMemo,
useState,
} from 'react'
import { byId, isNotDefined } from '@typebot.io/lib'
import { byId } from '@typebot.io/lib'
import { WorkspaceRole } from '@typebot.io/prisma'
import { useRouter } from 'next/router'
import { trpc } from '@/lib/trpc'
@ -136,16 +136,20 @@ export const WorkspaceProvider = ({
])
useEffect(() => {
if (isNotDefined(workspace?.isSuspended)) return
if (workspace?.isSuspended && pathname !== '/suspended') push('/suspended')
}, [pathname, push, workspace?.isSuspended])
if (workspace?.isSuspended) {
if (pathname === '/suspended') return
push('/suspended')
return
}
if (workspace?.isPastDue) {
if (pathname === '/past-due') return
push('/past-due')
return
}
}, [pathname, push, workspace?.isPastDue, workspace?.isSuspended])
const switchWorkspace = (workspaceId: string) => {
setWorkspaceIdInLocalStorage(workspaceId)
if (pathname === '/suspended') {
window.location.href = '/typebots'
return
}
setWorkspaceId(workspaceId)
}

120
apps/builder/src/pages/api/stripe/webhook.ts
View File

@ -66,7 +66,7 @@ const webhookHandler = async (req: NextApiRequest, res: NextApiResponse) => {
},
include: {
members: {
select: { user: { select: { id: true } } },
select: { userId: true },
where: {
role: WorkspaceRole.ADMIN,
},
@ -74,19 +74,16 @@ const webhookHandler = async (req: NextApiRequest, res: NextApiResponse) => {
},
})
for (const user of workspace.members.map((member) => member.user)) {
if (!user?.id) continue
await sendTelemetryEvents([
{
name: 'Subscription updated',
workspaceId,
userId: user.id,
data: {
plan,
},
await sendTelemetryEvents(
workspace.members.map((m) => ({
name: 'Subscription updated',
workspaceId,
userId: m.userId,
data: {
plan,
},
])
}
}))
)
} else {
const { claimableCustomPlanId, userId } = metadata
if (!claimableCustomPlanId)
@ -124,6 +121,80 @@ const webhookHandler = async (req: NextApiRequest, res: NextApiResponse) => {
return res.status(200).send({ message: 'workspace upgraded in DB' })
}
case 'customer.subscription.updated': {
const subscription = event.data.object as Stripe.Subscription
if (subscription.status !== 'past_due')
return res.send({ message: 'Not past_due, skipping.' })
const workspace = await prisma.workspace.update({
where: {
stripeId: subscription.customer as string,
},
data: {
isPastDue: true,
},
select: {
id: true,
members: {
select: { userId: true, role: true },
where: { role: WorkspaceRole.ADMIN },
},
},
})
await sendTelemetryEvents(
workspace.members.map((m) => ({
name: 'Workspace past due',
workspaceId: workspace.id,
userId: m.userId,
}))
)
return res.send({ message: 'Workspace set to past due.' })
}
case 'invoices.paid': {
const invoice = event.data.object as Stripe.Invoice
const workspace = await prisma.workspace.findFirst({
where: {
stripeId: invoice.customer as string,
},
select: {
isPastDue: true,
},
})
if (!workspace?.isPastDue)
return res.send({ message: 'Workspace not past_due, skipping.' })
const outstandingInvoices = await stripe.invoices.list({
customer: invoice.customer as string,
status: 'open',
})
if (outstandingInvoices.data.length > 0)
return res.send({
message: 'Workspace has outstanding invoices, skipping.',
})
const updatedWorkspace = await prisma.workspace.update({
where: {
stripeId: invoice.customer as string,
},
data: {
isPastDue: false,
},
select: {
id: true,
members: {
select: { userId: true },
where: {
role: WorkspaceRole.ADMIN,
},
},
},
})
await sendTelemetryEvents(
updatedWorkspace.members.map((m) => ({
name: 'Workspace past due status removed',
workspaceId: updatedWorkspace.id,
userId: m.userId,
}))
)
return res.send({ message: 'Workspace was regulated' })
}
case 'customer.subscription.deleted': {
const subscription = event.data.object as Stripe.Subscription
const { data } = await stripe.subscriptions.list({
@ -151,7 +222,7 @@ const webhookHandler = async (req: NextApiRequest, res: NextApiResponse) => {
},
include: {
members: {
select: { user: { select: { id: true } } },
select: { userId: true },
where: {
role: WorkspaceRole.ADMIN,
},
@ -159,19 +230,16 @@ const webhookHandler = async (req: NextApiRequest, res: NextApiResponse) => {
},
})
for (const user of workspace.members.map((member) => member.user)) {
if (!user?.id) continue
await sendTelemetryEvents([
{
name: 'Subscription updated',
workspaceId: workspace.id,
userId: user.id,
data: {
plan: Plan.FREE,
},
await sendTelemetryEvents(
workspace.members.map((m) => ({
name: 'Subscription updated',
workspaceId: workspace.id,
userId: m.userId,
data: {
plan: Plan.FREE,
},
])
}
}))
)
const typebots = await prisma.typebot.findMany({
where: {

36
apps/builder/src/pages/past-due.tsx Normal file
View File

@ -0,0 +1,36 @@
import { AlertIcon } from '@/components/icons'
import { BillingPortalButton } from '@/features/billing/components/BillingPortalButton'
import { DashboardHeader } from '@/features/dashboard/components/DashboardHeader'
import { useWorkspace } from '@/features/workspace/WorkspaceProvider'
import { Heading, VStack, Text } from '@chakra-ui/react'
import { useRouter } from 'next/router'
import { useEffect } from 'react'
export default function Page() {
const { replace } = useRouter()
const { workspace } = useWorkspace()
useEffect(() => {
if (!workspace || workspace.isPastDue) return
replace('/typebots')
}, [replace, workspace])
return (
<>
<DashboardHeader />
<VStack
w="full"
h="calc(100vh - 64px)"
justifyContent="center"
spacing={4}
>
<AlertIcon fontSize="4xl" />
<Heading fontSize="2xl">Your workspace has unpaid invoice(s).</Heading>
<Text>Head over to the billing portal to pay it.</Text>
{workspace?.id && (
<BillingPortalButton workspaceId={workspace?.id} colorScheme="blue" />
)}
</VStack>
</>
)
}

32
apps/builder/src/pages/suspended.tsx
View File

@ -1,13 +1,28 @@
import { TextLink } from '@/components/TextLink'
import { DashboardHeader } from '@/features/dashboard/components/DashboardHeader'
import { WorkspaceProvider } from '@/features/workspace/WorkspaceProvider'
import { Heading, Link, Text, VStack } from '@chakra-ui/react'
import { useWorkspace } from '@/features/workspace/WorkspaceProvider'
import { Heading, Text, VStack } from '@chakra-ui/react'
import { useRouter } from 'next/router'
import { useEffect } from 'react'
export default function Page() {
const { replace } = useRouter()
const { workspace } = useWorkspace()
useEffect(() => {
if (!workspace || workspace.isSuspended) return
replace('/typebots')
}, [replace, workspace])
return (
<WorkspaceProvider>
<>
<DashboardHeader />
<VStack w="full" h="calc(100vh - 64px)" justifyContent="center">
<VStack
w="full"
h="calc(100vh - 64px)"
justifyContent="center"
spacing={4}
>
<Heading>Your workspace has been suspended.</Heading>
<Text>
We detected that one of your typebots does not comply with our{' '}
@ -18,14 +33,7 @@ export default function Page() {
terms of service
</TextLink>
</Text>
<Text>
If you think it&apos;s a mistake, feel free to{' '}
<Link href="mailto:support@typebot.io" textDecor="underline">
reach out
</Link>
.
</Text>
</VStack>
</WorkspaceProvider>
</>
)
}

70
apps/docs/openapi/builder/_spec_.json
View File

@ -415,6 +415,52 @@
"data"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"name": {
"type": "string",
"enum": [
"Workspace past due"
]
}
},
"required": [
"userId",
"workspaceId",
"name"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"name": {
"type": "string",
"enum": [
"Workspace past due status removed"
]
}
},
"required": [
"userId",
"workspaceId",
"name"
],
"additionalProperties": false
}
]
}
@ -7487,6 +7533,9 @@
},
"isSuspended": {
"type": "boolean"
},
"isPastDue": {
"type": "boolean"
}
},
"required": [
@ -7507,7 +7556,8 @@
"customStorageLimit",
"customSeatsLimit",
"isQuarantined",
"isSuspended"
"isSuspended",
"isPastDue"
],
"additionalProperties": false
}
@ -7636,6 +7686,9 @@
},
"isSuspended": {
"type": "boolean"
},
"isPastDue": {
"type": "boolean"
}
},
"required": [
@ -7656,7 +7709,8 @@
"customStorageLimit",
"customSeatsLimit",
"isQuarantined",
"isSuspended"
"isSuspended",
"isPastDue"
],
"additionalProperties": false
}
@ -7802,6 +7856,9 @@
},
"isSuspended": {
"type": "boolean"
},
"isPastDue": {
"type": "boolean"
}
},
"required": [
@ -7822,7 +7879,8 @@
"customStorageLimit",
"customSeatsLimit",
"isQuarantined",
"isSuspended"
"isSuspended",
"isPastDue"
],
"additionalProperties": false
}
@ -54515,6 +54573,9 @@
},
"isSuspended": {
"type": "boolean"
},
"isPastDue": {
"type": "boolean"
}
},
"required": [
@ -54535,7 +54596,8 @@
"customStorageLimit",
"customSeatsLimit",
"isQuarantined",
"isSuspended"
"isSuspended",
"isPastDue"
],
"additionalProperties": false,
"nullable": true

1
packages/prisma/mysql/schema.prisma
View File

@ -97,6 +97,7 @@ model Workspace {
customSeatsLimit Int?
isQuarantined Boolean @default(false)
isSuspended Boolean @default(false)
isPastDue Boolean @default(false)
themeTemplates ThemeTemplate[]
}

2
packages/prisma/postgresql/migrations/20231121154057_add_is_past_due_field/migration.sql Normal file
View File

@ -0,0 +1,2 @@
-- AlterTable
ALTER TABLE "Workspace" ADD COLUMN "isPastDue" BOOLEAN NOT NULL DEFAULT false;

1
packages/prisma/postgresql/schema.prisma
View File

@ -91,6 +91,7 @@ model Workspace {
customSeatsLimit Int?
isQuarantined Boolean @default(false)
isSuspended Boolean @default(false)
isPastDue Boolean @default(false)
themeTemplates ThemeTemplate[]
}

14
packages/schemas/features/telemetry.ts
View File

@ -105,6 +105,18 @@ const workspaceAutoQuarantinedEventSchema = workspaceEvent.merge(
})
)
export const workspacePastDueEventSchema = workspaceEvent.merge(
z.object({
name: z.literal('Workspace past due'),
})
)
export const workspaceNotPastDueEventSchema = workspaceEvent.merge(
z.object({
name: z.literal('Workspace past due status removed'),
})
)
export const eventSchema = z.discriminatedUnion('name', [
workspaceCreatedEventSchema,
userCreatedEventSchema,
@ -115,6 +127,8 @@ export const eventSchema = z.discriminatedUnion('name', [
workspaceLimitReachedEventSchema,
workspaceAutoQuarantinedEventSchema,
subscriptionAutoUpdatedEventSchema,
workspacePastDueEventSchema,
workspaceNotPastDueEventSchema,
])
export type TelemetryEvent = z.infer<typeof eventSchema>

1
packages/schemas/features/workspace.ts
View File

@ -50,6 +50,7 @@ export const workspaceSchema = z.object({
customSeatsLimit: z.number().nullable(),
isQuarantined: z.boolean(),
isSuspended: z.boolean(),
isPastDue: z.boolean(),
}) satisfies z.ZodType<WorkspacePrisma>
export type Workspace = z.infer<typeof workspaceSchema>