Analytics Config CRUD Methods (#215)

Co-authored-by: Yerti <36551149+UZ9@users.noreply.github.com>

Author: Duckierstone42

.github/workflows/e2e-tests.yml

@@ -83,3 +83,12 @@ jobs:
       - uses: pnpm/action-setup@v4
       - name: Test
         run: pnpm test:e2e:logging-service
+  analytics-service:
+    name: Analytics Service E2E Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v4
+      - name: Test
+        run: pnpm test:e2e:analytics-service

docker-compose-dev.yml

@@ -96,14 +96,14 @@ services:
       - 5000
     entrypoint: pnpm --filter analytics-service ${ANALYTICS_COMMAND-start:dev}
     environment:
+      NODE_OPTIONS: --experimental-vm-modules
       AUTH_SERVICE_ADDR: auth-service:5000
       DB_SERVICE_ADDR: db-service:5000
       EMAIL_SERVICE_ADDR: email-service:5000
       ANALYTICS_SERVICE_ADDR: analytics-service:5000
       LOGGING_SERVICE_ADDR: logging-service:5000
       FILE_SERVICE_ADDR: file-service:5000
       NODE_ENV: test
-      SENDGRID_API_KEY: test-key
       SENTRY_DSN: 'https://01e85b2d3c5222b4a54d0796db847b55@o4506876382609408.ingest.us.sentry.io/4510019961749504'
     networks:
       - bog-api-net

packages/analytics-service/package.json

@@ -17,7 +17,7 @@
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json --runInBand",
+    "test:e2e": "NODE_OPTIONS=--experimental-vm-modules jest --config ./test/jest-e2e.json --runInBand",
     "test:e2e:watch": "jest --config ./test/jest-e2e.json --runInBand --watchAll",
     "tsc": "tsc",
     "sentry:sourcemaps": "sentry-cli sourcemaps inject --org bits-of-good-development --project juno-analytics-service ./dist && sentry-cli sourcemaps upload --org bits-of-good-development --project juno-analytics-service ./dist"

packages/analytics-service/src/app.module.ts

@@ -4,9 +4,15 @@ import { AppService } from './app.service';
 import { SentryModule } from '@sentry/nestjs/setup';
 import { HealthModule } from './modules/health/health.module';
 import { AnalyticsModule } from './modules/analytics/analytics.module';
+import { AnalyticsConfigModule } from './modules/analytics_config/analytics_config.module';
 
 @Module({
-  imports: [SentryModule.forRoot(), HealthModule, AnalyticsModule],
+  imports: [
+    SentryModule.forRoot(),
+    HealthModule,
+    AnalyticsModule,
+    AnalyticsConfigModule,
+  ],
   controllers: [AppController],
   providers: [AppService],
 })

packages/analytics-service/src/main.ts

@@ -5,7 +5,14 @@ import { MicroserviceOptions, Transport } from '@nestjs/microservices';
 import { join } from 'path';
 import { ConfigModule } from '@nestjs/config';
 import { SentryFilter } from './sentry.filter';
-import { HealthProto, HealthProtoFile } from 'juno-proto';
+import {
+  AnalyticsProto,
+  HealthProto,
+  HealthProtoFile,
+  AnalyticsConfigProto,
+  AnalyticsConfigProtoFile,
+  AnalyticsProtoFile,
+} from 'juno-proto';
 
 async function bootstrap() {
   ConfigModule.forRoot({
@@ -16,8 +23,16 @@ async function bootstrap() {
     {
       transport: Transport.GRPC,
       options: {
-        package: [HealthProto.GRPC_HEALTH_V1_PACKAGE_NAME],
-        protoPath: [HealthProtoFile],
+        package: [
+          HealthProto.GRPC_HEALTH_V1_PACKAGE_NAME,
+          AnalyticsProto.JUNO_ANALYTICS_SERVICE_ANALYTICS_PACKAGE_NAME,
+          AnalyticsConfigProto.JUNO_ANALYTICS_SERVICE_ANALYTICS_CONFIG_PACKAGE_NAME,
+        ],
+        protoPath: [
+          HealthProtoFile,
+          AnalyticsProtoFile,
+          AnalyticsConfigProtoFile,
+        ],
         url: process.env.ANALYTICS_SERVICE_ADDR,
       },
     },

packages/analytics-service/src/modules/analytics/analytics.module.ts

@@ -1,10 +1,9 @@
 import { Module } from '@nestjs/common';
 import { ClientsModule, Transport } from '@nestjs/microservices';
 import { AnalyticsProto, AnalyticsProtoFile } from 'juno-proto';
-import { BogAnalyticsService } from 'src/bog-analytics.service';
 import { AnalyticsController } from './analytics.controller';
 import { AnalyticsService } from './analytics.service';
-import { EventEnvironment } from 'bog-analytics';
+import { AnalyticsConfigModule } from '../analytics_config/analytics_config.module';
 
 const {
   ANALYTICS_SERVICE_NAME,
@@ -23,15 +22,22 @@ const {
         },
       },
     ]),
+    AnalyticsConfigModule,
   ],
   controllers: [AnalyticsController],
   providers: [
     AnalyticsService,
     {
-      provide: BogAnalyticsService,
-      useFactory: () => {
-        return new BogAnalyticsService({
-          environment: EventEnvironment.DEVELOPMENT, // TODO: we'll have to switch this later
+      provide: 'BOG_ANALYTICS',
+      useFactory: async () => {
+        // bog-analytics is absolutely cursed and outdated, have to do some shenanigans
+        // to get around ESM import
+        const loadModule = eval('(specifier) => import(specifier)');
+        const { AnalyticsLogger, EventEnvironment } =
+          await loadModule('bog-analytics');
+
+        return new AnalyticsLogger({
+          environment: EventEnvironment.DEVELOPMENT,
         });
       },
     },

packages/analytics-service/src/modules/analytics/analytics.service.ts

@@ -1,28 +1,38 @@
 import { status } from '@grpc/grpc-js';
-import { Injectable } from '@nestjs/common';
+import { Inject, Injectable } from '@nestjs/common';
 import { RpcException } from '@nestjs/microservices';
 import { AnalyticsProto } from 'juno-proto';
-import { BogAnalyticsService } from 'src/bog-analytics.service';
+import { AnalyticsConfigService } from '../analytics_config/analytics_config.service';
 
 @Injectable()
 export class AnalyticsService {
-  constructor(private readonly bogAnalytics: BogAnalyticsService) {}
+  constructor(
+    @Inject('BOG_ANALYTICS') private readonly bogAnalytics: any,
+    private readonly analyticsConfigService: AnalyticsConfigService,
+  ) {}
 
-  authenticateAnalytics(key: string) {
+  async authenticateAnalytics(projectId: number, environment: string) {
     try {
+      const key = await this.analyticsConfigService.getAnalyticsKey(
+        projectId,
+        environment,
+      );
       this.bogAnalytics.authenticate(key);
     } catch (e) {
       throw new RpcException({
         code: status.UNAUTHENTICATED,
-        message: 'Invalid API key',
+        message: 'Invalid API key or analytics config not found',
       });
     }
   }
 
   async logClickEvent(
     event: AnalyticsProto.ClickEventRequest,
   ): Promise<AnalyticsProto.ClickEventResponse> {
-    this.authenticateAnalytics(event.apiKey);
+    await this.authenticateAnalytics(
+      Number(event.projectId),
+      event.environment,
+    );
 
     if (
       !event ||
@@ -62,7 +72,10 @@ export class AnalyticsService {
   async logInputEvent(
     event: AnalyticsProto.InputEventRequest,
   ): Promise<AnalyticsProto.InputEventResponse> {
-    this.authenticateAnalytics(event.apiKey);
+    await this.authenticateAnalytics(
+      Number(event.projectId),
+      event.environment,
+    );
 
     if (
       !event ||
@@ -106,7 +119,10 @@ export class AnalyticsService {
   async logVisitEvent(
     event: AnalyticsProto.VisitEventRequest,
   ): Promise<AnalyticsProto.VisitEventResponse> {
-    this.authenticateAnalytics(event.apiKey);
+    await this.authenticateAnalytics(
+      Number(event.projectId),
+      event.environment,
+    );
 
     if (
       !event ||
@@ -146,7 +162,10 @@ export class AnalyticsService {
   async logCustomEvent(
     event: AnalyticsProto.CustomEventRequest,
   ): Promise<AnalyticsProto.CustomEventResponse> {
-    this.authenticateAnalytics(event.apiKey);
+    await this.authenticateAnalytics(
+      Number(event.projectId),
+      event.environment,
+    );
 
     if (
       !event ||

packages/analytics-service/src/modules/analytics_config/analytics_config.module.ts

@@ -0,0 +1,28 @@
+import { Module } from '@nestjs/common';
+import { ClientsModule, Transport } from '@nestjs/microservices';
+import { AnalyticsConfigProto, AnalyticsConfigProtoFile } from 'juno-proto';
+import { AnalyticsConfigService } from './analytics_config.service';
+
+const {
+  ANALYTICS_CONFIG_DB_SERVICE_NAME,
+  JUNO_ANALYTICS_SERVICE_ANALYTICS_CONFIG_PACKAGE_NAME,
+} = AnalyticsConfigProto;
+
+@Module({
+  imports: [
+    ClientsModule.register([
+      {
+        name: ANALYTICS_CONFIG_DB_SERVICE_NAME,
+        transport: Transport.GRPC,
+        options: {
+          url: process.env.DB_SERVICE_ADDR,
+          package: JUNO_ANALYTICS_SERVICE_ANALYTICS_CONFIG_PACKAGE_NAME,
+          protoPath: AnalyticsConfigProtoFile,
+        },
+      },
+    ]),
+  ],
+  providers: [AnalyticsConfigService],
+  exports: [AnalyticsConfigService],
+})
+export class AnalyticsConfigModule {}

packages/analytics-service/src/modules/analytics_config/analytics_config.service.ts

@@ -0,0 +1,36 @@
+import { Injectable, Inject, OnModuleInit } from '@nestjs/common';
+import { ClientGrpc } from '@nestjs/microservices';
+import { AnalyticsConfigProto } from 'juno-proto';
+import { lastValueFrom } from 'rxjs';
+
+const { ANALYTICS_CONFIG_DB_SERVICE_NAME } = AnalyticsConfigProto;
+
+@Injectable()
+export class AnalyticsConfigService implements OnModuleInit {
+  private analyticsConfigDbService: AnalyticsConfigProto.AnalyticsConfigDbServiceClient;
+
+  constructor(
+    @Inject(ANALYTICS_CONFIG_DB_SERVICE_NAME)
+    private analyticsConfigDbClient: ClientGrpc,
+  ) {}
+
+  onModuleInit() {
+    this.analyticsConfigDbService =
+      this.analyticsConfigDbClient.getService<AnalyticsConfigProto.AnalyticsConfigDbServiceClient>(
+        ANALYTICS_CONFIG_DB_SERVICE_NAME,
+      );
+  }
+
+  async getAnalyticsKey(
+    projectId: number,
+    environment: string,
+  ): Promise<string> {
+    const config = await lastValueFrom(
+      this.analyticsConfigDbService.readAnalyticsConfig({
+        id: projectId,
+        environment,
+      }),
+    );
+    return config.analyticsKey;
+  }
+}