feat(analytics): add retrieving user analytics id

packages/analytics/src/Bootstrap/Container.ts

@@ -32,6 +32,7 @@ import { AnalyticsEntityRepositoryInterface } from '../Domain/Entity/AnalyticsEn
 import { MySQLAnalyticsEntityRepository } from '../Infra/MySQL/MySQLAnalyticsEntityRepository'
 import { Repository } from 'typeorm'
 import { AnalyticsEntity } from '../Domain/Entity/AnalyticsEntity'
+import { GetUserAnalyticsId } from '../Domain/UseCase/GetUserAnalyticsId/GetUserAnalyticsId'
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const newrelicFormatter = require('@newrelic/winston-enricher')
@@ -111,6 +112,7 @@ export class ContainerConfigLoader {
       .toConstantValue(AppDataSource.getRepository(AnalyticsEntity))
 
     // Use Case
+    container.bind<GetUserAnalyticsId>(TYPES.GetUserAnalyticsId).to(GetUserAnalyticsId)
 
     // Hanlders
 

packages/analytics/src/Bootstrap/Types.ts

@@ -16,6 +16,7 @@ const TYPES = {
   // ORM
   ORMAnalyticsEntityRepository: Symbol.for('ORMAnalyticsEntityRepository'),
   // Use Case
+  GetUserAnalyticsId: Symbol.for('GetUserAnalyticsId'),
   // Handlers
   // Services
   DomainEventPublisher: Symbol.for('DomainEventPublisher'),

packages/analytics/src/Domain/UseCase/GetUserAnalyticsId/GetUserAnalyticsId.spec.ts

@@ -0,0 +1,37 @@
+import 'reflect-metadata'
+
+import { AnalyticsEntity } from '../../Entity/AnalyticsEntity'
+import { AnalyticsEntityRepositoryInterface } from '../../Entity/AnalyticsEntityRepositoryInterface'
+
+import { GetUserAnalyticsId } from './GetUserAnalyticsId'
+
+describe('GetUserAnalyticsId', () => {
+  let analyticsEntityRepository: AnalyticsEntityRepositoryInterface
+  let analyticsEntity: AnalyticsEntity
+
+  const createUseCase = () => new GetUserAnalyticsId(analyticsEntityRepository)
+
+  beforeEach(() => {
+    analyticsEntity = { id: 123 } as jest.Mocked<AnalyticsEntity>
+
+    analyticsEntityRepository = {} as jest.Mocked<AnalyticsEntityRepositoryInterface>
+    analyticsEntityRepository.findOneByUserUuid = jest.fn().mockReturnValue(analyticsEntity)
+  })
+
+  it('should return analytics id for a user', async () => {
+    expect(await createUseCase().execute({ userUuid: '1-2-3' })).toEqual({ analyticsId: 123 })
+  })
+
+  it('should throw error if user is missing analytics entity', async () => {
+    analyticsEntityRepository.findOneByUserUuid = jest.fn().mockReturnValue(null)
+    let error = null
+
+    try {
+      await createUseCase().execute({ userUuid: '1-2-3' })
+    } catch (caughtError) {
+      error = caughtError
+    }
+
+    expect(error).not.toBeNull()
+  })
+})

packages/analytics/src/Domain/UseCase/GetUserAnalyticsId/GetUserAnalyticsId.ts

@@ -0,0 +1,25 @@
+import { inject, injectable } from 'inversify'
+import TYPES from '../../../Bootstrap/Types'
+import { AnalyticsEntityRepositoryInterface } from '../../Entity/AnalyticsEntityRepositoryInterface'
+import { UseCaseInterface } from '../UseCaseInterface'
+import { GetUserAnalyticsIdDTO } from './GetUserAnalyticsIdDTO'
+import { GetUserAnalyticsIdResponse } from './GetUserAnalyticsIdResponse'
+
+@injectable()
+export class GetUserAnalyticsId implements UseCaseInterface {
+  constructor(
+    @inject(TYPES.AnalyticsEntityRepository) private analyticsEntityRepository: AnalyticsEntityRepositoryInterface,
+  ) {}
+
+  async execute(dto: GetUserAnalyticsIdDTO): Promise<GetUserAnalyticsIdResponse> {
+    const analyticsEntity = await this.analyticsEntityRepository.findOneByUserUuid(dto.userUuid)
+
+    if (analyticsEntity === null) {
+      throw new Error(`Could not find analytics entity for user ${dto.userUuid}`)
+    }
+
+    return {
+      analyticsId: analyticsEntity.id,
+    }
+  }
+}

packages/analytics/src/Domain/UseCase/GetUserAnalyticsId/GetUserAnalyticsIdDTO.ts

@@ -0,0 +1,5 @@
+import { Uuid } from '@standardnotes/common'
+
+export type GetUserAnalyticsIdDTO = {
+  userUuid: Uuid
+}

packages/analytics/src/Domain/UseCase/GetUserAnalyticsId/GetUserAnalyticsIdResponse.ts

@@ -0,0 +1,3 @@
+export type GetUserAnalyticsIdResponse = {
+  analyticsId: number
+}

packages/analytics/src/Domain/UseCase/UseCaseInterface.ts

@@ -0,0 +1,3 @@
+export interface UseCaseInterface {
+  execute(...args: any[]): Promise<Record<string, unknown>>
+}