Quickstart v2 (#1832)

Author: gaspergrom

backend/src/api/tenant/index.ts

@@ -22,4 +22,9 @@ export default (app) => {
   )
   app.post(`/tenant/:tenantId/sampleData`, safeWrap(require('./tenantGenerateSampleData').default))
   app.delete(`/tenant/:tenantId/sampleData`, safeWrap(require('./tenantDeleteSampleData').default))
+  app.post(
+    `/tenant/:tenantId/viewOrganizations`,
+    safeWrap(require('./tenantViewOrganizations').default),
+  )
+  app.post(`/tenant/:tenantId/viewContacts`, safeWrap(require('./tenantViewContacts').default))
 }

backend/src/api/tenant/tenantViewContacts.ts

@@ -0,0 +1,7 @@
+import TenantService from '../../services/tenantService'
+
+export default async (req, res) => {
+  const payload = await new TenantService(req).viewContacts()
+
+  await req.responseHandler.success(req, res, payload)
+}

backend/src/api/tenant/tenantViewOrganizations.ts

@@ -0,0 +1,7 @@
+import TenantService from '../../services/tenantService'
+
+export default async (req, res) => {
+  const payload = await new TenantService(req).viewOrganizations()
+
+  await req.responseHandler.success(req, res, payload)
+}

backend/src/database/migrations/U1699505061__organizationsViewed.sql

@@ -0,0 +1 @@
+ALTER TABLE public."settings" DROP COLUMN "organizationsViewed";

backend/src/database/migrations/U1699934020__contactsViewed.sql

@@ -0,0 +1 @@
+ALTER TABLE public."settings" DROP COLUMN "contactsViewed";

backend/src/database/migrations/V1699505061__organizationsViewed.sql

@@ -0,0 +1 @@
+ALTER TABLE public."settings" ADD COLUMN "organizationsViewed" bool;

backend/src/database/migrations/V1699934020__contactsViewed.sql

@@ -0,0 +1 @@
+ALTER TABLE public."settings" ADD COLUMN "contactsViewed" bool;

backend/src/database/models/settings.ts

@@ -21,6 +21,12 @@ export default (sequelize, DataTypes) => {
       slackWebHook: {
         type: DataTypes.STRING(1024),
       },
+      organizationsViewed: {
+        type: DataTypes.BOOLEAN(),
+      },
+      contactsViewed: {
+        type: DataTypes.BOOLEAN(),
+      },
       attributeSettings: {
         type: DataTypes.JSONB,
         allowNull: false,

backend/src/services/quickstartGuideService.ts

@@ -6,6 +6,7 @@ import { IServiceOptions } from './IServiceOptions'
 import isFeatureEnabled from '../feature-flags/isFeatureEnabled'
 import {
   DEFAULT_GUIDES,
+  DEFAULT_GUIDES_V2,
   QuickstartGuideMap,
   QuickstartGuideSettings,
   QuickstartGuideType,
@@ -14,6 +15,8 @@ import IntegrationRepository from '../database/repositories/integrationRepositor
 import MemberService from './memberService'
 import TenantUserRepository from '../database/repositories/tenantUserRepository'
 import ReportRepository from '../database/repositories/reportRepository'
+import AutomationRepository from '../database/repositories/automationRepository'
+import SettingsRepository from '@/database/repositories/settingsRepository'
 
 export default class QuickstartGuideService extends LoggerBase {
   options: IServiceOptions
@@ -39,7 +42,10 @@ export default class QuickstartGuideService extends LoggerBase {
   }
 
   async find(): Promise<QuickstartGuideMap> {
-    const guides: QuickstartGuideMap = JSON.parse(JSON.stringify(DEFAULT_GUIDES))
+    const isGuidesV2Enabled = await isFeatureEnabled(FeatureFlag.QUICKSTART_V2, this.options)
+    const guides: QuickstartGuideMap = JSON.parse(
+      JSON.stringify(isGuidesV2Enabled ? DEFAULT_GUIDES_V2 : DEFAULT_GUIDES),
+    )
 
     const integrationCount: number = await IntegrationRepository.count({}, this.options)
 
@@ -66,21 +72,58 @@ export default class QuickstartGuideService extends LoggerBase {
       this.options,
     )
 
-    guides[QuickstartGuideType.CONNECT_INTEGRATION].completed = integrationCount > 1
-    guides[QuickstartGuideType.ENRICH_MEMBER].completed = enrichedMembers.count > 0
-    guides[QuickstartGuideType.VIEW_REPORT].completed = viewedReports.count > 0
-    guides[QuickstartGuideType.INVITE_COLLEAGUES].completed = allTenantUsers.some(
-      (tu) => tu.invitedById === this.options.currentUser.id,
+    const automations = await new AutomationRepository(this.options).findAndCountAll({})
+    const tenantSettings = await SettingsRepository.getTenantSettings(
+      this.options.currentTenant.id,
+      this.options,
     )
 
-    if (await isFeatureEnabled(FeatureFlag.EAGLE_EYE, this.options)) {
+    if (QuickstartGuideType.CONNECT_INTEGRATION in guides) {
+      guides[QuickstartGuideType.CONNECT_INTEGRATION].completed = integrationCount > 1
+    }
+    if (QuickstartGuideType.ENRICH_MEMBER in guides) {
+      guides[QuickstartGuideType.ENRICH_MEMBER].completed = enrichedMembers.count > 0
+    }
+    if (QuickstartGuideType.VIEW_REPORT in guides) {
+      guides[QuickstartGuideType.VIEW_REPORT].completed = viewedReports.count > 0
+    }
+    if (QuickstartGuideType.INVITE_COLLEAGUES in guides) {
+      guides[QuickstartGuideType.INVITE_COLLEAGUES].completed = allTenantUsers.some(
+        (tu) => tu.invitedById === this.options.currentUser.id,
+      )
+    }
+
+    if (QuickstartGuideType.CONNECT_FIRST_INTEGRATION in guides) {
+      guides[QuickstartGuideType.CONNECT_FIRST_INTEGRATION].completed = integrationCount > 0
+    }
+
+    if (QuickstartGuideType.CREATE_AUTOMATIONS in guides) {
+      guides[QuickstartGuideType.CREATE_AUTOMATIONS].completed = automations.count > 0
+    }
+
+    if (QuickstartGuideType.EXPLORE_ORGANIZATIONS in guides) {
+      guides[QuickstartGuideType.EXPLORE_ORGANIZATIONS].completed =
+        tenantSettings.organizationsViewed
+    }
+
+    if (QuickstartGuideType.EXPLORE_CONTACTS in guides) {
+      guides[QuickstartGuideType.EXPLORE_CONTACTS].completed = tenantSettings.contactsViewed
+    }
+
+    if (
+      QuickstartGuideType.SET_EAGLE_EYE in guides &&
+      (await isFeatureEnabled(FeatureFlag.EAGLE_EYE, this.options))
+    ) {
       guides[QuickstartGuideType.SET_EAGLE_EYE].completed = tenantUser.settings.eagleEye.onboarded
     } else {
       delete guides[QuickstartGuideType.SET_EAGLE_EYE]
     }
 
     // try to find an enrichable member for button CTA of enrich member guide
-    if (!guides[QuickstartGuideType.ENRICH_MEMBER].completed) {
+    if (
+      QuickstartGuideType.ENRICH_MEMBER in guides &&
+      !guides[QuickstartGuideType.ENRICH_MEMBER].completed
+    ) {
       const enrichableMembers = await ms.findAndCountAll({
         advancedFilter: {
           and: [

backend/src/services/tenantService.ts

@@ -362,6 +362,14 @@ export default class TenantService {
     }
   }
 
+  async viewOrganizations() {
+    return SettingsService.save({ organizationsViewed: true }, this.options)
+  }
+
+  async viewContacts() {
+    return SettingsService.save({ contactsViewed: true }, this.options)
+  }
+
   async updatePlanUser(id, planStripeCustomerId, planUserId) {
     const transaction = await SequelizeRepository.createTransaction(this.options)