gergo/web 1968 add features list

.circleci/config.yml

@@ -19,6 +19,7 @@ workflows:
       - test-server:
           context:
             - speckle-server-licensing
+            - stripe-integration
           filters: &filters-allow-all
             tags:
               # run tests for any commit on any branch, including any tags
@@ -464,6 +465,7 @@ jobs:
       REDIS_URL: 'redis://127.0.0.1:6379'
       S3_REGION: '' # optional, defaults to 'us-east-1'
       AUTOMATE_ENCRYPTION_KEYS_PATH: 'test/assets/automate/encryptionKeys.json'
+      FF_BILLING_INTEGRATION_ENABLED: 'true'
     steps:
       - checkout
       - restore_cache:
@@ -550,6 +552,8 @@ jobs:
       FF_WORKSPACES_SSO_ENABLED: 'false'
       FF_MULTIPLE_EMAILS_MODULE_ENABLED: 'false'
       FF_GENDOAI_MODULE_ENABLED: 'false'
+      FF_GATEKEEPER_MODULE_ENABLED: 'false'
+      FF_BILLING_INTEGRATION_ENABLED: 'false'
 
   test-frontend-2:
     docker: &docker-node-browsers-image

packages/frontend-2/components/settings/workspaces/Billing.vue

@@ -57,6 +57,25 @@
           </FormButton>
         </div>
       </div>
+
+      <div v-if="isBillingIntegrationEnabled" class="flex flex-col space-y-10">
+        <SettingsSectionHeader title="Start payment" class="pt-10" subheading />
+        <div class="flex items-center">
+          <div class="flex-1 flex-col pr-6 gap-y-1">
+            <p class="text-body-xs font-medium text-foreground">Billing cycle</p>
+            <p class="text-body-xs text-foreground-2 leading-5 max-w-md">
+              Choose an annual billing cycle for 20% off
+            </p>
+          </div>
+          <FormSwitch v-model="isYearlyPlan" :show-label="true" name="annual billing" />
+        </div>
+        <div class="text-lg">Add the pricing table here</div>
+        <div class="flex justify-between">
+          <FormButton @click="teamCheckout">Team plan</FormButton>
+          <FormButton @click="proCheckout">Pro plan</FormButton>
+          <FormButton @click="businessCheckout">Business plan</FormButton>
+        </div>
+      </div>
     </div>
   </section>
 </template>
@@ -65,6 +84,7 @@
 import { graphql } from '~/lib/common/generated/gql'
 import { useQuery } from '@vue/apollo-composable'
 import { settingsWorkspaceBillingQuery } from '~/lib/settings/graphql/queries'
+import { useIsBillingIntegrationEnabled } from '~/composables/globals'
 
 graphql(`
   fragment SettingsWorkspacesBilling_Workspace on Workspace {
@@ -86,6 +106,24 @@ const props = defineProps<{
   workspaceId: string
 }>()
 
+const isBillingIntegrationEnabled = useIsBillingIntegrationEnabled()
+const isYearlyPlan = ref(false)
+
+const checkoutUrl = (plan: string) =>
+  `/api/v1/billing/workspaces/${
+    props.workspaceId
+  }/checkout-session/${plan}/${billingCycle()}`
+const billingCycle = () => (isYearlyPlan.value ? 'yearly' : 'monthly')
+const teamCheckout = () => {
+  window.location.href = checkoutUrl('team')
+}
+const proCheckout = () => {
+  window.location.href = checkoutUrl('pro')
+}
+const businessCheckout = () => {
+  window.location.href = checkoutUrl('business')
+}
+
 const { result } = useQuery(settingsWorkspaceBillingQuery, () => ({
   workspaceId: props.workspaceId
 }))

packages/frontend-2/composables/globals.ts

@@ -41,4 +41,11 @@ export const useIsGendoModuleEnabled = () => {
   return ref(FF_GENDOAI_MODULE_ENABLED)
 }
 
+export const useIsBillingIntegrationEnabled = () => {
+  const {
+    public: { FF_BILLING_INTEGRATION_ENABLED }
+  } = useRuntimeConfig()
+  return ref(FF_BILLING_INTEGRATION_ENABLED)
+}
+
 export { useGlobalToast, useActiveUser, usePageQueryStandardFetchPolicy }

packages/frontend-2/lib/common/generated/gql/graphql.ts

@@ -2501,6 +2501,7 @@ export type Query = {
    * Either token or workspaceId must be specified, or both
    */
   workspaceInvite?: Maybe<PendingWorkspaceCollaborator>;
+  workspacePricingPlans: Scalars['JSONObject']['output'];
 };
 
 
@@ -6936,6 +6937,7 @@ export type QueryFieldArgs = {
   workspace: QueryWorkspaceArgs,
   workspaceBySlug: QueryWorkspaceBySlugArgs,
   workspaceInvite: QueryWorkspaceInviteArgs,
+  workspacePricingPlans: {},
 }
 export type ResourceIdentifierFieldArgs = {
   resourceId: {},

packages/server/app.ts

@@ -365,7 +365,15 @@ export async function init() {
   }
 
   app.use(corsMiddleware())
-  app.use(express.json({ limit: '100mb' }))
+  // there are some paths, that need the raw body
+  app.use((req, res, next) => {
+    const rawPaths = ['/api/v1/billing/webhooks']
+    if (rawPaths.includes(req.path)) {
+      express.raw({ type: 'application/json' })(req, res, next)
+    } else {
+      express.json({ limit: '100mb' })(req, res, next)
+    }
+  })
   app.use(express.urlencoded({ limit: `${getFileSizeLimitMB()}mb`, extended: false }))
 
   // Trust X-Forwarded-* headers (for https protocol detection)

packages/server/assets/gatekeeper/typedefs/gatekeeper.graphql

@@ -0,0 +1,3 @@
+extend type Query {
+  workspacePricingPlans: JSONObject!
+}

packages/server/modules/core/graph/generated/graphql.ts

@@ -2520,6 +2520,7 @@ export type Query = {
    * Either token or workspaceId must be specified, or both
    */
   workspaceInvite?: Maybe<PendingWorkspaceCollaborator>;
+  workspacePricingPlans: Scalars['JSONObject']['output'];
 };
 
 
@@ -5702,6 +5703,7 @@ export type QueryResolvers<ContextType = GraphQLContext, ParentType extends Reso
   workspace?: Resolver<ResolversTypes['Workspace'], ParentType, ContextType, RequireFields<QueryWorkspaceArgs, 'id'>>;
   workspaceBySlug?: Resolver<ResolversTypes['Workspace'], ParentType, ContextType, RequireFields<QueryWorkspaceBySlugArgs, 'slug'>>;
   workspaceInvite?: Resolver<Maybe<ResolversTypes['PendingWorkspaceCollaborator']>, ParentType, ContextType, Partial<QueryWorkspaceInviteArgs>>;
+  workspacePricingPlans?: Resolver<ResolversTypes['JSONObject'], ParentType, ContextType>;
 };
 
 export type ResourceIdentifierResolvers<ContextType = GraphQLContext, ParentType extends ResolversParentTypes['ResourceIdentifier'] = ResolversParentTypes['ResourceIdentifier']> = {

packages/server/modules/cross-server-sync/graph/generated/graphql.ts

@@ -2504,6 +2504,7 @@ export type Query = {
    * Either token or workspaceId must be specified, or both
    */
   workspaceInvite?: Maybe<PendingWorkspaceCollaborator>;
+  workspacePricingPlans: Scalars['JSONObject']['output'];
 };
 
 

packages/server/modules/gatekeeper/clients/stripe.ts

@@ -0,0 +1,150 @@
+/* eslint-disable camelcase */
+import {
+  CreateCheckoutSession,
+  GetSubscriptionData,
+  WorkspaceSubscription
+} from '@/modules/gatekeeper/domain/billing'
+import {
+  WorkspacePlanBillingIntervals,
+  WorkspacePricingPlans
+} from '@/modules/gatekeeper/domain/workspacePricing'
+import { Stripe } from 'stripe'
+
+type GetWorkspacePlanPrice = (args: {
+  workspacePlan: WorkspacePricingPlans
+  billingInterval: WorkspacePlanBillingIntervals
+}) => string
+
+export const createCheckoutSessionFactory =
+  ({
+    stripe,
+    frontendOrigin,
+    getWorkspacePlanPrice
+  }: {
+    stripe: Stripe
+    frontendOrigin: string
+    getWorkspacePlanPrice: GetWorkspacePlanPrice
+  }): CreateCheckoutSession =>
+  async ({
+    seatCount,
+    guestCount,
+    workspacePlan,
+    billingInterval,
+    workspaceSlug,
+    workspaceId
+  }) => {
+    //?settings=workspace/security&
+    const resultUrl = new URL(
+      `${frontendOrigin}/workspaces/${workspaceSlug}?workspace=${workspaceId}&settings=workspace/billing`
+    )
+
+    const price = getWorkspacePlanPrice({ billingInterval, workspacePlan })
+    const costLineItems: Stripe.Checkout.SessionCreateParams.LineItem[] = [
+      { price, quantity: seatCount }
+    ]
+    if (guestCount > 0)
+      costLineItems.push({
+        price: getWorkspacePlanPrice({
+          workspacePlan: 'guest',
+          billingInterval
+        }),
+        quantity: guestCount
+      })
+
+    const session = await stripe.checkout.sessions.create({
+      mode: 'subscription',
+
+      line_items: costLineItems,
+
+      success_url: `${resultUrl.toString()}&payment_status=success&session_id={CHECKOUT_SESSION_ID}`,
+
+      cancel_url: `${resultUrl.toString()}&payment_status=cancelled&session_id={CHECKOUT_SESSION_ID}`
+    })
+
+    if (!session.url) throw new Error('Failed to create an active checkout session')
+    return {
+      id: session.id,
+      url: session.url,
+      billingInterval,
+      workspacePlan,
+      workspaceId,
+      createdAt: new Date(),
+      updatedAt: new Date(),
+      paymentStatus: 'unpaid'
+    }
+  }
+
+export const getSubscriptionDataFactory =
+  ({
+    stripe
+  }: // getWorkspacePlanPrice
+  {
+    stripe: Stripe
+    // getWorkspacePlanPrice: GetWorkspacePlanPrice
+  }): GetSubscriptionData =>
+  async ({ subscriptionId }) => {
+    const stripeSubscription = await stripe.subscriptions.retrieve(subscriptionId)
+
+    return {
+      customerId:
+        typeof stripeSubscription.customer === 'string'
+          ? stripeSubscription.customer
+          : stripeSubscription.customer.id,
+      subscriptionId,
+      products: stripeSubscription.items.data.map((subscriptionItem) => {
+        const productId =
+          typeof subscriptionItem.price.product === 'string'
+            ? subscriptionItem.price.product
+            : subscriptionItem.price.product.id
+        const quantity = subscriptionItem.quantity
+        if (!quantity)
+          throw new Error(
+            'invalid subscription, we do not support products without quantities'
+          )
+        return {
+          priceId: subscriptionItem.price.id,
+          productId,
+          quantity,
+          subscriptionItemId: subscriptionItem.id
+        }
+      })
+    }
+  }
+
+// this should be a reconcile subscriptions, we keep an accurate state in the DB
+// on each change, we're reconciling that state to stripe
+export const reconcileWorkspaceSubscriptionFactory =
+  ({ stripe }: { stripe: Stripe }) =>
+  async ({
+    workspaceSubscription,
+    applyProrotation
+  }: {
+    workspaceSubscription: WorkspaceSubscription
+    applyProrotation: boolean
+  }) => {
+    const existingSubscriptionState = await getSubscriptionDataFactory({ stripe })({
+      subscriptionId: workspaceSubscription.subscriptionData.subscriptionId
+    })
+    const items: Stripe.SubscriptionUpdateParams.Item[] = []
+    for (const product of workspaceSubscription.subscriptionData.products) {
+      const existingProduct = existingSubscriptionState.products.find(
+        (p) => p.productId === product.productId
+      )
+      // we're adding a new product to the sub
+      if (!existingProduct) {
+        items.push({ quantity: product.quantity, price: product.priceId })
+        // we're moving a product to a new price for ie upgrading to a yearly plan
+      } else if (existingProduct.priceId !== product.priceId) {
+        items.push({ quantity: product.quantity, price: product.priceId })
+        items.push({ id: product.subscriptionItemId, deleted: true })
+      } else {
+        items.push({ quantity: product.quantity, id: product.subscriptionItemId })
+      }
+    }
+    // workspaceSubscription.subscriptionData.products.
+    // const item = workspaceSubscription.subscriptionData.products.find(p => p.)
+    await stripe.subscriptions.update(
+      workspaceSubscription.subscriptionData.subscriptionId,
+      { items, proration_behavior: applyProrotation ? 'create_prorations' : 'none' }
+    )
+  }