Send email once integration setup is done

backend/.env.dist.local

@@ -85,6 +85,7 @@ CROWD_SENDGRID_TEMPLATE_EMAIL_ADDRESS_VERIFICATION=
 CROWD_SENDGRID_TEMPLATE_INVITATION=
 CROWD_SENDGRID_TEMPLATE_PASSWORD_RESET=
 CROWD_SENDGRID_TEMPLATE_WEEKLY_ANALYTICS=
+CROWD_SENDGRID_TEMPLATE_INTEGRATION_DONE=
 CROWD_SENDGRID_WEEKLY_ANALYTICS_UNSUBSCRIBE_GROUP_ID=
 
 # Stripe settings

backend/config/custom-environment-variables.json

@@ -92,6 +92,7 @@
     "templateInvitation": "CROWD_SENDGRID_TEMPLATE_INVITATION",
     "templatePasswordReset": "CROWD_SENDGRID_TEMPLATE_PASSWORD_RESET",
     "templateWeeklyAnalytics": "CROWD_SENDGRID_TEMPLATE_WEEKLY_ANALYTICS",
+    "templateIntegrationDone": "CROWD_SENDGRID_TEMPLATE_INTEGRATION_DONE",
     "weeklyAnalyticsUnsubscribeGroupId": "CROWD_SENDGRID_WEEKLY_ANALYTICS_UNSUBSCRIBE_GROUP_ID"
   },
   "plans": {

backend/src/config/configTypes.ts

@@ -154,6 +154,7 @@ export interface SendgridConfiguration {
   templateInvitation: string
   templatePasswordReset: string
   templateWeeklyAnalytics: string
+  templateIntegrationDone: string
   weeklyAnalyticsUnsubscribeGroupId: string
 }
 

backend/src/config/index.ts

@@ -199,6 +199,7 @@ export const SENDGRID_CONFIG: SendgridConfiguration = KUBE_MODE
       templateInvitation: process.env.SENDGRID_TEMPLATE_INVITATION,
       templatePasswordReset: process.env.SENDGRID_TEMPLATE_PASSWORD_RESET,
       templateWeeklyAnalytics: process.env.SENDGRID_TEMPLATE_WEEKLY_ANALYTICS,
+      templateIntegrationDone: process.env.SENDGRID_TEMPLATE_INTEGRATION_DONE,
     }
 
 export const NETLIFY_CONFIG: NetlifyConfiguration = KUBE_MODE

backend/src/database/migrations/U1670422647__addEmailSentAtToIntegrations.sql

@@ -0,0 +1 @@
+ALTER TABLE public.integrations DROP COLUMN "emailSentAt";

backend/src/database/migrations/V1670422647__addEmailSentAtToIntegrations.sql

@@ -0,0 +1 @@
+ALTER TABLE public.integrations ADD "emailSentAt" TIMESTAMP NULL;

backend/src/database/models/integration.ts

@@ -41,6 +41,9 @@ export default (sequelize) => {
           len: [0, 255],
         },
       },
+      emailSentAt: {
+        type: DataTypes.DATE,
+      },
     },
     {
       indexes: [

backend/src/database/repositories/integrationRepository.ts

@@ -31,6 +31,7 @@ class IntegrationRepository {
           'settings',
           'integrationIdentifier',
           'importHash',
+          'emailSentAt',
         ]),
 
         tenantId: tenant.id,
@@ -78,6 +79,7 @@ class IntegrationRepository {
           'settings',
           'integrationIdentifier',
           'importHash',
+          'emailSentAt',
         ]),
 
         updatedById: currentUser.id,

backend/src/i18n/en.ts

@@ -156,6 +156,19 @@ const en = {
         unique: {},
       },
     },
+    integration: {
+      name: {
+        github: 'GitHub',
+        linkedin: 'LinkedIn',
+        twitter: 'Twitter',
+        devto: 'DEV',
+        stackoverflow: 'Stack Overflow',
+        reddit: 'Reddit',
+        discord: 'Discord',
+        slack: 'Slack',
+        hackernews: 'Hacker News',
+      },
+    },
     automation: {
       errors: {
         planLimitExceeded: 'You have exceeded # of automations you can have in your plan.',

backend/src/serverless/integrations/services/integrationProcessor.ts

@@ -26,6 +26,10 @@ import { TwitterReachIntegrationService } from './integrations/twitterReachInteg
 import { SlackIntegrationService } from './integrations/slackIntegrationService'
 import { GithubIntegrationService } from './integrations/githubIntegrationService'
 import { LoggingBase } from '../../../services/loggingBase'
+import { API_CONFIG } from '../../../config'
+import EmailSender from '../../../services/emailSender'
+import UserRepository from '../../../database/repositories/userRepository'
+import { i18n } from '../../../i18n'
 
 const MAX_STREAM_RETRIES = 5
 
@@ -452,10 +456,22 @@ export class IntegrationProcessor extends LoggingBase {
       logger.error(err, 'Error while processing integration!')
       setError = req.onboarding
     } finally {
+      let emailSentAt
+      if (!setError && !integration.emailSentAt) {
+        const tenantUsers = await UserRepository.findAllUsersOfTenant(integration.tenantId)
+        emailSentAt = new Date()
+        for (const user of tenantUsers) {
+          await new EmailSender(EmailSender.TEMPLATES.INTEGRATION_DONE, {
+            integrationName: i18n('en', `entities.integration.name.${integration.platform}`),
+            link: API_CONFIG.frontendUrl,
+          }).sendTo(user.email)
+        }
+      }
       await IntegrationRepository.update(
         integration.id,
         {
           status: setError ? 'error' : 'done',
+          emailSentAt,
           settings: stepContext.integration.settings,
           refreshToken: stepContext.integration.refreshToken,
           token: stepContext.integration.token,

backend/src/services/emailSender.ts

@@ -28,6 +28,7 @@ export default class EmailSender extends LoggingBase {
       INVITATION: SENDGRID_CONFIG.templateInvitation,
       PASSWORD_RESET: SENDGRID_CONFIG.templatePasswordReset,
       WEEKLY_ANALYTICS: SENDGRID_CONFIG.templateWeeklyAnalytics,
+      INTEGRATION_DONE: SENDGRID_CONFIG.templateIntegrationDone,
     }
   }
 

frontend/src/modules/layout/components/layout.vue

@@ -23,7 +23,7 @@
             </div>
           </banner>
           <banner
-            v-if="shouldShowIntegrationsAlert"
+            v-if="shouldShowIntegrationsErrorAlert"
             variant="alert"
           >
             <div
@@ -39,6 +39,33 @@
               </router-link>
             </div>
           </banner>
+
+          <banner
+            v-if="shouldShowIntegrationsInProgressAlert"
+            variant="info"
+          >
+            <div
+              class="flex items-center justify-center grow text-sm"
+            >
+              <div
+                v-loading="true"
+                class="w-4 h-4 mr-2"
+              ></div>
+              <span class="font-semibold mr-1"
+                >{{
+                  integrationsInProgressToString
+                }}
+                integration{{
+                  integrationsInProgress.length > 1
+                    ? 's are'
+                    : ' is'
+                }}
+                getting set up.</span
+              >
+              Sit back and relax. We will send you an email
+              when it’s done.
+            </div>
+          </banner>
           <banner
             v-if="shouldShowTenantCreatingAlert"
             variant="info"
@@ -50,9 +77,11 @@
                 v-loading="true"
                 class="w-4 h-4 mr-2"
               ></div>
-              Finishing your workspace setup. The data might
-              take a few minutes until it is completely
-              loaded.
+              <span class="font-semibold"
+                >Finishing your workspace setup.</span
+              >
+              The data might take a few minutes until it is
+              completely loaded.
             </div>
           </banner>
           <banner
@@ -133,7 +162,26 @@ export default {
       integrationsInProgress: 'integration/inProgress',
       integrationsWithErrors: 'integration/withErrors'
     }),
-    shouldShowIntegrationsAlert() {
+    integrationsInProgressToString() {
+      const arr = this.integrationsInProgress.map(
+        (i) => i.name
+      )
+      if (arr.length === 1) {
+        return arr[0]
+      } else if (arr.length === 2) {
+        return `${arr[0]} and ${arr[1]}`
+      } else {
+        return (
+          arr.slice(0, arr.length - 1).join(', ') +
+          ', and ' +
+          arr.slice(-1)
+        )
+      }
+    },
+    shouldShowIntegrationsInProgressAlert() {
+      return this.integrationsInProgress.length > 0
+    },
+    shouldShowIntegrationsErrorAlert() {
       return (
         this.integrationsWithErrors.length > 0 &&
         this.$route.name !== 'integration'
@@ -154,14 +202,15 @@ export default {
         moment().diff(
           moment(this.currentTenant.createdAt),
           'minutes'
-        ) <= 10
+        ) <= 2
       )
     },
     computedBannerWrapperClass() {
       return {
         'pt-16':
           this.shouldShowSampleDataAlert ||
-          this.shouldShowIntegrationsAlert ||
+          this.shouldShowIntegrationsErrorAlert ||
+          this.shouldShowIntegrationsInProgressAlert ||
           this.shouldShowTenantCreatingAlert ||
           this.shouldShowPMFSurveyAlert
       }