Tenant plans and feature flagging

backend/.env.dist.local

@@ -68,6 +68,9 @@ CROWD_COMPREHEND_AWS_REGION=
 # Segment settings
 CROWD_SEGMENT_WRITE_KEY=TdX3BLaZuHpHyzN2lcDiNiRHDSH9Piyl
 
+# Posthog settings
+CROWD_POSTHOG_API_KEY=
+
 SUPERFACE_SDK_TOKEN=sfs_29f8c03402d48b583f9b35bbb5fbb423cf638e73bde38a7cce6a5fb7bb352720193471189882b6d82494203bc998be47a52ab9d4250f90b16d2bd86b4c7ace2b_1d8a819b
 
 # Netlify settings

backend/config/custom-environment-variables.json

@@ -66,6 +66,9 @@
   "segment": {
     "writeKey": "CROWD_SEGMENT_WRITE_KEY"
   },
+  "posthog": {
+    "apiKey": "CROWD_POSTHOG_API_KEY"
+  },
   "comprehend": {
     "aws": {
       "accountId": "CROWD_COMPREHEND_AWS_ACCOUNT_ID",

backend/config/default.json

@@ -13,6 +13,7 @@
   "cubejs": {},
   "searchEngine": {},
   "segment": {},
+  "posthog": {},
   "comprehend": {
     "aws": {}
   },

backend/package.json

@@ -26,7 +26,8 @@
     "stripe:start": "stripe listen --forward-to localhost:8080/api/plan/stripe/webhook",
     "lint": "npx eslint .",
     "format": "npx prettier --write .",
-    "script:process-integration": "SERVICE=script ts-node ./src/bin/scripts/process-integration.ts"
+    "script:process-integration": "SERVICE=script ts-node ./src/bin/scripts/process-integration.ts",
+    "script:change-tenant-plan": "SERVICE=script ts-node ./src/bin/scripts/change-tenant-plan.ts"
   },
   "dependencies": {
     "@aws-sdk/client-comprehend": "^3.159.0",
@@ -80,6 +81,7 @@
     "passport-slack": "0.0.7",
     "pg": "^8.7.3",
     "pm2": "^5.2.0",
+    "posthog-node": "^2.2.3",
     "redis": "^4.5.0",
     "sanitize-html": "^2.7.1",
     "sequelize": "6.21.2",

backend/src/api/automation/automationCreate.ts

@@ -2,6 +2,10 @@ import PermissionChecker from '../../services/user/permissionChecker'
 import Permissions from '../../security/permissions'
 import AutomationService from '../../services/automationService'
 import track from '../../segment/track'
+import identifyTenant from '../../segment/identifyTenant'
+import { FeatureFlag } from '../../types/common'
+import ensureFlagUpdated from '../../feature-flags/ensureFlagUpdated'
+import AutomationRepository from '../../database/repositories/automationRepository'
 
 /**
  * POST /tenant/{tenantId}/automation
@@ -19,9 +23,18 @@ import track from '../../segment/track'
  */
 export default async (req, res) => {
   new PermissionChecker(req).validateHas(Permissions.values.automationCreate)
+
   const payload = await new AutomationService(req).create(req.body.data)
 
   track('Automation Created', { ...payload }, { ...req })
 
+  identifyTenant(req)
+
+  const automationCount = await AutomationRepository.countAll(req.database, req.currentTenant.id)
+  await ensureFlagUpdated(FeatureFlag.AUTOMATIONS, req.currentTenant.id, req.posthog, {
+    plan: req.currentTenant.plan,
+    automationCount,
+  })
+
   await req.responseHandler.success(req, res, payload)
 }

backend/src/api/automation/automationDestroy.ts

@@ -2,6 +2,10 @@ import PermissionChecker from '../../services/user/permissionChecker'
 import Permissions from '../../security/permissions'
 import AutomationService from '../../services/automationService'
 import track from '../../segment/track'
+import identifyTenant from '../../segment/identifyTenant'
+import ensureFlagUpdated from '../../feature-flags/ensureFlagUpdated'
+import { FeatureFlag } from '../../types/common'
+import AutomationRepository from '../../database/repositories/automationRepository'
 
 /**
  * DELETE /tenant/{tenantId}/automation/{automationId}
@@ -19,7 +23,16 @@ export default async (req, res) => {
   new PermissionChecker(req).validateHas(Permissions.values.automationDestroy)
   await new AutomationService(req).destroy(req.params.automationId)
 
+  await req.posthog.reloadFeatureFlags()
+
   track('Automation Destroyed', { id: req.params.automationId }, { ...req })
+  identifyTenant(req)
+
+  const automationCount = await AutomationRepository.countAll(req.database, req.currentTenant.id)
+  await ensureFlagUpdated(FeatureFlag.AUTOMATIONS, req.currentTenant.id, req.posthog, {
+    plan: req.currentTenant.plan,
+    automationCount,
+  })
 
   await req.responseHandler.success(req, res, true, 204)
 }

backend/src/api/automation/index.ts

@@ -1,7 +1,13 @@
 import { safeWrap } from '../../middlewares/errorMiddleware'
+import { featureFlagMiddleware } from '../../middlewares/featureFlagMiddleware'
+import { FeatureFlag } from '../../types/common'
 
 export default (app) => {
-  app.post('/tenant/:tenantId/automation', safeWrap(require('./automationCreate').default))
+  app.post(
+    '/tenant/:tenantId/automation',
+    featureFlagMiddleware(FeatureFlag.AUTOMATIONS, 'entities.automation.errors.planLimitExceeded'),
+    safeWrap(require('./automationCreate').default),
+  )
   app.put(
     '/tenant/:tenantId/automation/:automationId',
     safeWrap(require('./automationUpdate').default),

backend/src/api/conversation/conversationSettingsUpdate.ts

@@ -1,10 +1,33 @@
+import Error403 from '../../errors/Error403'
+import isFeatureEnabled from '../../feature-flags/isFeatureEnabled'
 import Permissions from '../../security/permissions'
 import ConversationService from '../../services/conversationService'
 import PermissionChecker from '../../services/user/permissionChecker'
+import { FeatureFlag } from '../../types/common'
 
 export default async (req, res) => {
   new PermissionChecker(req).validateHas(Permissions.values.conversationEdit)
 
+  if (
+    req.body.customUrl &&
+    !(await isFeatureEnabled(
+      FeatureFlag.COMMUNITY_HELP_CENTER_PRO,
+      req.currentTenant.id,
+      req.posthog,
+    ))
+  ) {
+    await req.responseHandler.error(
+      req,
+      res,
+      new Error403(
+        req.language,
+        'communityHelpCenter.errors.planNotSupportingCustomUrls',
+        req.currentTenant.plan,
+      ),
+    )
+    return
+  }
+
   const payload = await new ConversationService(req).updateSettings(req.body)
 
   await req.responseHandler.success(req, res, payload)

backend/src/api/index.ts

@@ -2,6 +2,7 @@ import express from 'express'
 import cors from 'cors'
 import helmet from 'helmet'
 import bunyanMiddleware from 'bunyan-middleware'
+import { PostHog } from 'posthog-node'
 import { authMiddleware } from '../middlewares/authMiddleware'
 import { tenantMiddleware } from '../middlewares/tenantMiddleware'
 import { databaseMiddleware } from '../middlewares/databaseMiddleware'
@@ -16,6 +17,7 @@ import { errorMiddleware } from '../middlewares/errorMiddleware'
 import { passportStrategyMiddleware } from '../middlewares/passportStrategyMiddleware'
 import { redisMiddleware } from '../middlewares/redisMiddleware'
 import { createRedisClient } from '../utils/redis'
+import { POSTHOG_CONFIG } from '../config'
 
 const serviceLogger = createServiceLogger()
 
@@ -24,6 +26,12 @@ const app = express()
 setImmediate(async () => {
   const redis = await createRedisClient(true)
 
+  let posthog = null
+
+  if (POSTHOG_CONFIG.apiKey) {
+    posthog = new PostHog(POSTHOG_CONFIG.apiKey)
+  }
+
   // Enables CORS
   app.use(cors({ origin: true }))
 
@@ -47,6 +55,12 @@ setImmediate(async () => {
   // Bind redis to request
   app.use(redisMiddleware(redis))
 
+  // Bind posthog to request
+  app.use((req: any, res, next) => {
+    req.posthog = posthog
+    next()
+  })
+
   // initialize passport strategies
   app.use(passportStrategyMiddleware)
 

backend/src/api/integration/__tests__/integrationProtectedFields.test.ts

@@ -19,7 +19,7 @@ describe('Integration protected fields tests', () => {
 
   describe('Integration create protected fields', () => {
     it('Should create an integratio without protected variables', async () => {
-      const plan = Plans.values.free
+      const plan = Plans.values.essential
       const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
       const tenantId = mockIServiceOptions.currentTenant.get({ plain: true }).id
       const token = SequelizeTestUtils.getUserToken(mockIServiceOptions)
@@ -37,7 +37,7 @@ describe('Integration protected fields tests', () => {
         })
     })
     it('Should throw an error when limitCount is passed for a free plan', async () => {
-      const plan = Plans.values.free
+      const plan = Plans.values.essential
       const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
       const tenantId = mockIServiceOptions.currentTenant.get({ plain: true }).id
       const token = SequelizeTestUtils.getUserToken(mockIServiceOptions)
@@ -59,7 +59,7 @@ describe('Integration protected fields tests', () => {
 
   describe('Integration update protected fields', () => {
     it('Should update an integratiom without protected variables', async () => {
-      const plan = Plans.values.free
+      const plan = Plans.values.essential
       const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
       const integrationId = (
         await new IntegrationService(mockIServiceOptions).create({
@@ -83,7 +83,7 @@ describe('Integration protected fields tests', () => {
         })
     })
     it('Should throw an error when limitCount is passed', async () => {
-      const plan = Plans.values.free
+      const plan = Plans.values.essential
       const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
       const integrationId = (
         await new IntegrationService(mockIServiceOptions).create({

backend/src/api/microservice/__tests__/microserviceProtectedFields.test.ts

@@ -18,7 +18,7 @@ describe('Microservice protected fields tests', () => {
 
   describe('Microservice create protected fields', () => {
     it('Should return 200 with free variant', async () => {
-      const plan = Plans.values.free
+      const plan = Plans.values.essential
       const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
       const tenantId = mockIServiceOptions.currentTenant.get({ plain: true }).id
       const token = SequelizeTestUtils.getUserToken(mockIServiceOptions)
@@ -38,7 +38,7 @@ describe('Microservice protected fields tests', () => {
     })
 
     it('Should return 403 with a premium microservice in a free tenant', async () => {
-      const plan = Plans.values.free
+      const plan = Plans.values.essential
       const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
       const tenantId = mockIServiceOptions.currentTenant.get({ plain: true }).id
       const token = SequelizeTestUtils.getUserToken(mockIServiceOptions)
@@ -58,27 +58,7 @@ describe('Microservice protected fields tests', () => {
     })
 
     it('Should return 200 with a premium microservice in a premium tenant', async () => {
-      const plan = Plans.values.premium
-      const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
-      const tenantId = mockIServiceOptions.currentTenant.get({ plain: true }).id
-      const token = SequelizeTestUtils.getUserToken(mockIServiceOptions)
-      const data = {
-        type: 'check_merge',
-        variant: 'premium',
-      }
-      return request(app)
-        .post(`/tenant/${tenantId}/microservice`)
-        .set({
-          Authorization: `Bearer ${token}`,
-        })
-        .send({ ...data })
-        .then((response) => {
-          expect(response.statusCode).toBe(200)
-        })
-    })
-
-    it('Should return 200 with a premium microservice in a beta tenant', async () => {
-      const plan = Plans.values.beta
+      const plan = Plans.values.growth
       const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
       const tenantId = mockIServiceOptions.currentTenant.get({ plain: true }).id
       const token = SequelizeTestUtils.getUserToken(mockIServiceOptions)
@@ -100,7 +80,7 @@ describe('Microservice protected fields tests', () => {
 
   describe('Microservice update protected fields', () => {
     it('Should return 200 without protected variables', async () => {
-      const plan = Plans.values.free
+      const plan = Plans.values.essential
       const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
       const microServiceId = (
         await new MicroserviceService(mockIServiceOptions).create({
@@ -126,7 +106,7 @@ describe('Microservice protected fields tests', () => {
     })
 
     it('Should return 200 when updating with default variant', async () => {
-      const plan = Plans.values.free
+      const plan = Plans.values.essential
       const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
       const microServiceId = (
         await new MicroserviceService(mockIServiceOptions).create({
@@ -153,7 +133,7 @@ describe('Microservice protected fields tests', () => {
     })
 
     it('Should return 403 when updating with to premium variant in free tenant', async () => {
-      const plan = Plans.values.free
+      const plan = Plans.values.essential
       const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
       const microServiceId = (
         await new MicroserviceService(mockIServiceOptions).create({
@@ -179,7 +159,7 @@ describe('Microservice protected fields tests', () => {
     })
 
     it('Should return 200 when updating with premium variant in premium tenant', async () => {
-      const plan = Plans.values.premium
+      const plan = Plans.values.growth
       const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
       const microServiceId = (
         await new MicroserviceService(mockIServiceOptions).create({
@@ -205,34 +185,8 @@ describe('Microservice protected fields tests', () => {
         })
     })
 
-    it('Should return 200 when updating with premium variant in beta tenant', async () => {
-      const plan = Plans.values.beta
-      const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
-      const microServiceId = (
-        await new MicroserviceService(mockIServiceOptions).create({
-          type: 'check_merge',
-          running: false,
-          variant: 'default',
-        })
-      ).id
-      const tenantId = mockIServiceOptions.currentTenant.get({ plain: true }).id
-      const token = SequelizeTestUtils.getUserToken(mockIServiceOptions)
-      const data = {
-        running: true,
-        variant: 'premium',
-      }
-      return request(app)
-        .put(`/tenant/${tenantId}/microservice/${microServiceId}`)
-        .set({
-          Authorization: `Bearer ${token}`,
-        })
-        .send({ ...data })
-        .then((response) => {
-          expect(response.statusCode).toBe(200)
-        })
-    })
     it('Should return 200 when updating from premium to default in premium tenant', async () => {
-      const plan = Plans.values.premium
+      const plan = Plans.values.growth
       const mockIServiceOptions = await SequelizeTestUtils.getTestIServiceOptions(db, plan)
       const microServiceId = (
         await new MicroserviceService(mockIServiceOptions).create({

backend/src/api/plan/stripe/checkout.ts

@@ -20,7 +20,7 @@ export default async (req, res) => {
   }
 
   if (
-    currentTenant.plan !== Plans.values.free &&
+    currentTenant.plan !== Plans.values.essential &&
     currentTenant.planStatus !== 'cancel_at_period_end' &&
     currentTenant.planUserId !== currentUser.id
   ) {