feat: add controller

novuhq · scopsy · Dec 4, 2024 · Dec 4, 2024 · Dec 4, 2024 · Dec 4, 2024
commit 3b4e5a9c50826f1c1650b7946fa58ba9f520ed68
diff --git a/apps/api/src/app/insights/insights.controller.ts b/apps/api/src/app/insights/insights.controller.ts
@@ -0,0 +1,27 @@
+import { Controller, Get, Query } from '@nestjs/common';
+import { ApiOperation, ApiQuery } from '@nestjs/swagger';
+import { UsageInsights } from './usecases/usage-insights/usage-insights.usecase';
+import { UsageInsightsCommand } from './usecases/usage-insights/usage-insights.command';
+
+@Controller({
+  path: 'insights',
+})
+export class InsightsController {
+  constructor(private usageInsights: UsageInsights) {}
+
+  @Get('/execute')
+  @ApiOperation({
+    summary: 'Execute insights for a specific organization',
+  })
+  @ApiQuery({
+    name: 'organizationId',
+    type: String,
+    required: true,
+    description: 'The ID of the organization to execute insights for',
+  })
+  async executeInsights(@Query('organizationId') organizationId: string) {
+    const command = new UsageInsightsCommand({ organizationId });
+
+    return this.usageInsights.execute(command);
+  }
+}
diff --git a/apps/api/src/app/insights/insights.module.ts b/apps/api/src/app/insights/insights.module.ts
@@ -12,6 +12,7 @@ import { InsightsInitializerService } from './services/insights-initializer.serv
 import { MixpanelService } from './services/mixpanel.service';
 import { MetricsCalculatorService } from './services/metrics-calculator.service';
 import { OrganizationNotificationService } from './services/organization-notification.service';
+import { InsightsController } from './insights.controller';
 
 @Module({
   imports: [SharedModule],
@@ -27,6 +28,7 @@ import { OrganizationNotificationService } from './services/organization-notific
     MetricsCalculatorService,
     OrganizationNotificationService,
   ],
+  controllers: [InsightsController],
   exports: [...USE_CASES],
 })
 export class InsightsModule {}
diff --git a/apps/api/src/app/insights/services/insights-initializer.service.ts b/apps/api/src/app/insights/services/insights-initializer.service.ts
@@ -1,6 +1,5 @@
 import { Injectable, OnApplicationBootstrap, Logger } from '@nestjs/common';
 import { UsageInsights } from '../usecases/usage-insights/usage-insights.usecase';
-import { UsageInsightsCommand } from '../usecases/usage-insights/usage-insights.command';
 
 @Injectable()
 export class InsightsInitializerService implements OnApplicationBootstrap {
@@ -9,11 +8,7 @@ export class InsightsInitializerService implements OnApplicationBootstrap {
   async onApplicationBootstrap() {
     try {
       Logger.log('Initializing usage insights...');
-      const command = new UsageInsightsCommand();
 
-      setTimeout(() => {
-        this.usageInsights.execute(command);
-      }, 10000);
       Logger.log('Usage insights initialization completed');
     } catch (error) {
       Logger.error('Failed to initialize insights:', error);

diff --git a/apps/api/src/app/insights/usecases/usage-insights/usage-insights.command.ts b/apps/api/src/app/insights/usecases/usage-insights/usage-insights.command.ts
@@ -1 +1,7 @@
-export class UsageInsightsCommand {}
+export class UsageInsightsCommand {
+  organizationId?: string;
+
+  constructor(data: { organizationId?: string } = {}) {
+    this.organizationId = data.organizationId;
+  }
+}
diff --git a/apps/api/src/app/insights/usecases/usage-insights/usage-insights.usecase.ts b/apps/api/src/app/insights/usecases/usage-insights/usage-insights.usecase.ts
@@ -3,6 +3,8 @@ import { InstrumentUsecase } from '@novu/application-generic';
 
 import {
   IChannelData,
+  IMixpanelInboxResponse,
+  IMixpanelTriggerResponse,
   IOrganizationMetrics,
   MixpanelInboxSeriesNameEnum,
   MixpanelTriggerEventNameEnum,
@@ -46,12 +48,38 @@ export class UsageInsights {
       this.mixpanelService.fetchInboxInsights(),
     ]);
 
-    if (!mixpanelData?.series) {
+    if (!mixpanelData?.series || !inboxData?.series) {
       Logger.error('Mixpanel data unavailable or invalid');
 
       return;
     }
 
+    Logger.debug('Processing organization data');
+
+    if (command.organizationId) {
+      await this.processOrganization(command.organizationId, mixpanelData, inboxData);
+    } else {
+      let counter = 0;
+      for (const [orgId, orgData] of Object.entries(
+        mixpanelData.series[MixpanelTriggerEventNameEnum.NOTIFICATION_SUBSCRIBER_EVENT]
+      )) {
+        if (orgId === '$overall') continue;
+
+        counter += 1;
+        if (counter > 5) break;
+
+        await this.processOrganization(orgId, mixpanelData, inboxData);
+      }
+    }
+
+    Logger.debug('Usage Insights execution completed successfully');
+  }
+
+  private async processOrganization(
+    orgId: string,
+    mixpanelData: IMixpanelTriggerResponse,
+    inboxData: IMixpanelInboxResponse
+  ) {
     Logger.debug('Processing Mixpanel and Inbox data');
     // Trigger Workflow data
     const triggerEventSeries = mixpanelData.series[MixpanelTriggerEventNameEnum.NOTIFICATION_SUBSCRIBER_EVENT];
@@ -88,70 +116,58 @@ export class UsageInsights {
       return;
     }
 
-    let counter = 0;
-    Logger.debug('Processing organization data');
-    for (const [orgId, orgData] of Object.entries(processWorkflowSeries)) {
-      if (orgId === '$overall') continue;
-
-      counter += 1;
-
-      if (counter > 5) break;
-
-      const organizationData: IOrganizationData = {
-        workflowTrigger: {
-          current: triggerEventSeries[orgId],
-          previous: triggerEventPreviousSeries[orgId],
+    const organizationData: IOrganizationData = {
+      workflowTrigger: {
+        current: triggerEventSeries[orgId],
+        previous: triggerEventPreviousSeries[orgId],
+      },
+      stepProcessing: {
+        current: processWorkflowSeries[orgId],
+        previous: previousProcessWorkflowSeries[orgId],
+      },
+      inbox: {
+        current: {
+          [MixpanelInboxSeriesNameEnum.INBOX_SESSION_INITIALIZED]: inboxSessionInitializedSeries[orgId],
+          [MixpanelInboxSeriesNameEnum.INBOX_UPDATE_PREFERENCES]: inboxUpdatePreferencesSeries[orgId],
+          [MixpanelInboxSeriesNameEnum.INBOX_MARK_NOTIFICATION]: inboxMarkNotificationSeries[orgId],
+          [MixpanelInboxSeriesNameEnum.INBOX_UPDATE_ACTION]: inboxUpdateActionSeries[orgId],
         },
-        stepProcessing: {
-          current: processWorkflowSeries[orgId],
-          previous: previousProcessWorkflowSeries[orgId],
+        previous: {
+          [MixpanelInboxSeriesNameEnum.INBOX_SESSION_INITIALIZED]: previousInboxSessionInitializedSeries[orgId],
+          [MixpanelInboxSeriesNameEnum.INBOX_UPDATE_PREFERENCES]: previousInboxUpdatePreferencesSeries[orgId],
+          [MixpanelInboxSeriesNameEnum.INBOX_MARK_NOTIFICATION]: previousInboxMarkNotificationSeries[orgId],
+          [MixpanelInboxSeriesNameEnum.INBOX_UPDATE_ACTION]: previousInboxUpdateActionSeries[orgId],
         },
-        inbox: {
-          current: {
-            [MixpanelInboxSeriesNameEnum.INBOX_SESSION_INITIALIZED]: inboxSessionInitializedSeries[orgId],
-            [MixpanelInboxSeriesNameEnum.INBOX_UPDATE_PREFERENCES]: inboxUpdatePreferencesSeries[orgId],
-            [MixpanelInboxSeriesNameEnum.INBOX_MARK_NOTIFICATION]: inboxMarkNotificationSeries[orgId],
-            [MixpanelInboxSeriesNameEnum.INBOX_UPDATE_ACTION]: inboxUpdateActionSeries[orgId],
-          },
-          previous: {
-            [MixpanelInboxSeriesNameEnum.INBOX_SESSION_INITIALIZED]: previousInboxSessionInitializedSeries[orgId],
-            [MixpanelInboxSeriesNameEnum.INBOX_UPDATE_PREFERENCES]: previousInboxUpdatePreferencesSeries[orgId],
-            [MixpanelInboxSeriesNameEnum.INBOX_MARK_NOTIFICATION]: previousInboxMarkNotificationSeries[orgId],
-            [MixpanelInboxSeriesNameEnum.INBOX_UPDATE_ACTION]: previousInboxUpdateActionSeries[orgId],
-          },
-        },
-      };
-
-      const metrics: IOrganizationMetrics = {
-        eventTriggers: this.metricsCalculator.calculateEventTriggersMetrics(
-          organizationData.workflowTrigger.current,
-          organizationData.workflowTrigger.previous
-        ),
-        channelBreakdown: this.metricsCalculator.calculateChannelBreakdown(
-          organizationData.stepProcessing.current,
-          organizationData.stepProcessing.previous
-        ),
-        workflowStats: this.metricsCalculator.calculateWorkflowStats(
-          organizationData.workflowTrigger.current,
-          organizationData.workflowTrigger.previous
-        ),
-        inboxMetrics: this.metricsCalculator.calculateInboxMetrics(
-          organizationData.inbox?.current,
-          organizationData.inbox?.previous,
-          orgId,
-          {
-            from_date: inboxData!.time_comparison.date_range.from_date,
-            to_date: inboxData!.date_range.from_date,
-          }
-        ),
-      };
-
-      await this.organizationNotification.sendOrganizationNotification(orgId, metrics, {
-        from_date: mixpanelData.time_comparison.date_range.from_date,
-        to_date: mixpanelData.date_range.to_date,
-      });
-    }
-
-    Logger.debug('Usage Insights execution completed successfully');
+      },
+    };
+
+    const metrics: IOrganizationMetrics = {
+      eventTriggers: this.metricsCalculator.calculateEventTriggersMetrics(
+        organizationData.workflowTrigger.current,
+        organizationData.workflowTrigger.previous
+      ),
+      channelBreakdown: this.metricsCalculator.calculateChannelBreakdown(
+        organizationData.stepProcessing.current,
+        organizationData.stepProcessing.previous
+      ),
+      workflowStats: this.metricsCalculator.calculateWorkflowStats(
+        organizationData.workflowTrigger.current,
+        organizationData.workflowTrigger.previous
+      ),
+      inboxMetrics: this.metricsCalculator.calculateInboxMetrics(
+        organizationData.inbox?.current,
+        organizationData.inbox?.previous,
+        orgId,
+        {
+          from_date: inboxData!.time_comparison.date_range.from_date,
+          to_date: inboxData!.date_range.from_date,
+        }
+      ),
+    };
+
+    await this.organizationNotification.sendOrganizationNotification(orgId, metrics, {
+      from_date: mixpanelData!.time_comparison.date_range.from_date,
+      to_date: mixpanelData!.date_range.to_date,
+    });
   }
 }
diff --git a/libs/notifications/src/workflows/usage-insights/email.tsx b/libs/notifications/src/workflows/usage-insights/email.tsx
@@ -256,13 +256,13 @@ export default function UsageInsightsEmail(props: IUsageEmailData & { marketingC
         📊 Usage Insights for {props.organizationName} - {formatDate(props.period.current)}
       </Preview>
       <Tailwind>
-        <Body className="bg-gray-50 pt-10 font-sans">
+        <Body className="bg-gray-50 font-sans">
           <Img
             src={`https://dashboard.novu.co/static/images/novu-colored-text.png`}
             width="119"
             height="37"
             alt="Novu Logo"
-            className="mx-auto"
+            className="mx-auto mb-10 mt-10"
           />
           <Container className="mx-auto w-full max-w-[700px]">
             <Section className="rounded-t-lg bg-gray-900 px-6 py-8">