chore(release): publish new version

- @standardnotes/analytics@2.16.0

packages/analytics/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.16.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@2.15.1...@standardnotes/analytics@2.16.0) (2022-12-20)
+
+### Features
+
+* **analytics:** add active users stats to report ([6e16620](https://github.com/standardnotes/server/commit/6e1662038c3340fb60939464616789bab7639160))
+
+## [2.15.1](https://github.com/standardnotes/server/compare/@standardnotes/analytics@2.15.0...@standardnotes/analytics@2.15.1) (2022-12-20)
+
+### Bug Fixes
+
+* **auth:** add persisting statistics for all subscription plans ([addedb3](https://github.com/standardnotes/server/commit/addedb3091ddae81618d56663e18f2ae76a43c4e))
+
+# [2.15.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@2.14.0...@standardnotes/analytics@2.15.0) (2022-12-19)
+
+### Features
+
+* **auth:** add requesting persisting statistics ([a35271f](https://github.com/standardnotes/server/commit/a35271fbb399b68a3ac7021395d8063707fba222))
+
 # [2.14.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@2.13.0...@standardnotes/analytics@2.14.0) (2022-12-19)
 
 ### Features

packages/analytics/bin/report.ts

@@ -121,6 +121,10 @@ const requestReport = async (
     StatisticMeasureName.NAMES.FiveYearPlansMRR,
     StatisticMeasureName.NAMES.PlusPlansMRR,
     StatisticMeasureName.NAMES.ProPlansMRR,
+    StatisticMeasureName.NAMES.ActiveUsers,
+    StatisticMeasureName.NAMES.ActiveFreeUsers,
+    StatisticMeasureName.NAMES.ActivePlusUsers,
+    StatisticMeasureName.NAMES.ActiveProUsers,
   ]
   for (const statisticName of thirtyDaysStatisticsNames) {
     statisticsOverTime.push({

packages/analytics/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/analytics",
-  "version": "2.14.0",
+  "version": "2.16.0",
   "engines": {
     "node": ">=18.0.0 <19.0.0"
   },

packages/analytics/src/Domain/Statistics/StatisticMeasureName.ts

@@ -26,6 +26,10 @@ export class StatisticMeasureName extends ValueObject<StatisticMeasureNameProps>
     FiveYearPlansMRR: 'five-year-plans-mrr',
     ProPlansMRR: 'pro-plans-mrr',
     PlusPlansMRR: 'plus-plans-mrr',
+    ActiveUsers: 'active-users',
+    ActiveProUsers: 'active-pro-users',
+    ActivePlusUsers: 'active-plus-users',
+    ActiveFreeUsers: 'active-free-users',
   }
 
   get value(): string {

packages/auth/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.70.3](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.70.2...@standardnotes/auth-server@1.70.3) (2022-12-20)
+
+### Bug Fixes
+
+* **auth:** add persisting statistics for all subscription plans ([addedb3](https://github.com/standardnotes/server/commit/addedb3091ddae81618d56663e18f2ae76a43c4e))
+
+## [1.70.2](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.70.1...@standardnotes/auth-server@1.70.2) (2022-12-20)
+
+### Bug Fixes
+
+* **auth:** docker command ([85d2f42](https://github.com/standardnotes/server/commit/85d2f42f473110e8dfca975bfecc7a56823bdef4))
+
+## [1.70.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.70.0...@standardnotes/auth-server@1.70.1) (2022-12-20)
+
+### Bug Fixes
+
+* **auth:** saving subscription plan name in session traces ([3064d03](https://github.com/standardnotes/server/commit/3064d03aa9a2ac9ca3acfff30480ea8629faeb14))
+
+# [1.70.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.69.1...@standardnotes/auth-server@1.70.0) (2022-12-19)
+
+### Features
+
+* **auth:** add requesting persisting statistics ([a35271f](https://github.com/standardnotes/server/commit/a35271fbb399b68a3ac7021395d8063707fba222))
+
 ## [1.69.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.69.0...@standardnotes/auth-server@1.69.1) (2022-12-19)
 
 **Note:** Version bump only for package @standardnotes/auth-server

packages/auth/bin/stats.ts

@@ -0,0 +1,40 @@
+import 'reflect-metadata'
+
+import 'newrelic'
+
+import { Logger } from 'winston'
+import { TimerInterface } from '@standardnotes/time'
+
+import { ContainerConfigLoader } from '../src/Bootstrap/Container'
+import TYPES from '../src/Bootstrap/Types'
+import { Env } from '../src/Bootstrap/Env'
+import { PersistStatistics } from '../src/Domain/UseCase/PersistStatistics/PersistStatistics'
+
+const container = new ContainerConfigLoader()
+void container.load().then((container) => {
+  const env: Env = new Env()
+  env.load()
+
+  const logger: Logger = container.get(TYPES.Logger)
+
+  logger.info('Starting session traces cleanup')
+
+  const persistStats: PersistStatistics = container.get(TYPES.PersistStatistics)
+  const timer: TimerInterface = container.get(TYPES.Timer)
+
+  Promise.resolve(
+    persistStats.execute({
+      sessionsInADay: timer.getUTCDateNDaysAgo(1),
+    }),
+  )
+    .then(() => {
+      logger.info('Stats persisted.')
+
+      process.exit(0)
+    })
+    .catch((error) => {
+      logger.error(`Could not persist stats: ${error.message}`)
+
+      process.exit(1)
+    })
+})

packages/auth/docker/entrypoint.sh

@@ -24,6 +24,11 @@ case "$COMMAND" in
     yarn workspace @standardnotes/auth-server cleanup
     ;;
 
+  'stats' )
+    echo "[Docker] Starting Persisting Stats..."
+    yarn workspace @standardnotes/auth-server stats
+    ;;
+
   'email-daily-backup' )
     echo "[Docker] Starting Email Daily Backup..."
     yarn workspace @standardnotes/auth-server daily-backup:email

packages/auth/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/auth-server",
-  "version": "1.69.1",
+  "version": "1.70.3",
   "engines": {
     "node": ">=18.0.0 <19.0.0"
   },
@@ -20,6 +20,7 @@
     "start": "yarn node dist/bin/server.js",
     "worker": "yarn node dist/bin/worker.js",
     "cleanup": "yarn node dist/bin/cleanup.js",
+    "stats": "yarn node dist/bin/stats.js",
     "daily-backup:email": "yarn node dist/bin/backup.js email daily",
     "user-email-backup": "yarn node dist/bin/user_email_backup.js",
     "daily-backup:dropbox": "yarn node dist/bin/backup.js dropbox daily",

packages/auth/src/Bootstrap/Container.ts

@@ -202,6 +202,7 @@ import { SessionTrace } from '../Domain/Session/SessionTrace'
 import { TypeORMSessionTrace } from '../Infra/TypeORM/TypeORMSessionTrace'
 import { TraceSession } from '../Domain/UseCase/TraceSession/TraceSession'
 import { CleanupSessionTraces } from '../Domain/UseCase/CleanupSessionTraces/CleanupSessionTraces'
+import { PersistStatistics } from '../Domain/UseCase/PersistStatistics/PersistStatistics'
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const newrelicFormatter = require('@newrelic/winston-enricher')
@@ -500,6 +501,15 @@ export class ContainerConfigLoader {
           container.get(TYPES.SESSION_TRACE_DAYS_TTL),
         ),
       )
+    container
+      .bind<PersistStatistics>(TYPES.PersistStatistics)
+      .toConstantValue(
+        new PersistStatistics(
+          container.get(TYPES.SessionTraceRepository),
+          container.get(TYPES.DomainEventPublisher),
+          container.get(TYPES.DomainEventFactory),
+        ),
+      )
 
     container
       .bind<CleanupSessionTraces>(TYPES.CleanupSessionTraces)

packages/auth/src/Bootstrap/Types.ts

@@ -126,6 +126,7 @@ const TYPES = {
   ProcessUserRequest: Symbol.for('ProcessUserRequest'),
   TraceSession: Symbol.for('TraceSession'),
   CleanupSessionTraces: Symbol.for('CleanupSessionTraces'),
+  PersistStatistics: Symbol.for('PersistStatistics'),
   // Handlers
   UserRegisteredEventHandler: Symbol.for('UserRegisteredEventHandler'),
   AccountDeletionRequestedEventHandler: Symbol.for('AccountDeletionRequestedEventHandler'),

packages/auth/src/Domain/Event/DomainEventFactory.ts

@@ -19,6 +19,7 @@ import {
   UserContentSizeRecalculationRequestedEvent,
   MuteEmailsSettingChangedEvent,
   EmailRequestedEvent,
+  StatisticPersistenceRequestedEvent,
 } from '@standardnotes/domain-events'
 import { Predicate, PredicateVerificationResult } from '@standardnotes/predicates'
 import { TimerInterface } from '@standardnotes/time'
@@ -31,6 +32,25 @@ import { DomainEventFactoryInterface } from './DomainEventFactoryInterface'
 export class DomainEventFactory implements DomainEventFactoryInterface {
   constructor(@inject(TYPES.Timer) private timer: TimerInterface) {}
 
+  createStatisticPersistenceRequestedEvent(dto: {
+    statisticMeasureName: string
+    value: number
+    date: Date
+  }): StatisticPersistenceRequestedEvent {
+    return {
+      type: 'STATISTIC_PERSISTENCE_REQUESTED',
+      createdAt: this.timer.getUTCDate(),
+      meta: {
+        correlation: {
+          userIdentifier: '-',
+          userIdentifierType: 'email',
+        },
+        origin: DomainEventService.Auth,
+      },
+      payload: dto,
+    }
+  }
+
   createMuteEmailsSettingChangedEvent(dto: {
     username: string
     mute: boolean

packages/auth/src/Domain/Event/DomainEventFactoryInterface.ts

@@ -17,6 +17,7 @@ import {
   UserContentSizeRecalculationRequestedEvent,
   MuteEmailsSettingChangedEvent,
   EmailRequestedEvent,
+  StatisticPersistenceRequestedEvent,
 } from '@standardnotes/domain-events'
 import { InviteeIdentifierType } from '../SharedSubscription/InviteeIdentifierType'
 
@@ -88,4 +89,9 @@ export interface DomainEventFactoryInterface {
     mute: boolean
     emailSubscriptionRejectionLevel: string
   }): MuteEmailsSettingChangedEvent
+  createStatisticPersistenceRequestedEvent(dto: {
+    statisticMeasureName: string
+    value: number
+    date: Date
+  }): StatisticPersistenceRequestedEvent
 }

packages/auth/src/Domain/Role/RoleToSubscriptionMap.spec.ts

@@ -41,4 +41,23 @@ describe('RoleToSubscriptionMap', () => {
       },
     ])
   })
+
+  it('should filter our subscription roles from an array of roles', () => {
+    const roles = [
+      {
+        name: RoleName.CoreUser,
+      } as jest.Mocked<Role>,
+      {
+        name: RoleName.FilesBetaUser,
+      } as jest.Mocked<Role>,
+      {
+        name: RoleName.PlusUser,
+      } as jest.Mocked<Role>,
+    ]
+    expect(createMap().filterSubscriptionRoles(roles)).toEqual([
+      {
+        name: RoleName.PlusUser,
+      },
+    ])
+  })
 })

packages/auth/src/Domain/Role/RoleToSubscriptionMap.ts

@@ -17,6 +17,10 @@ export class RoleToSubscriptionMap implements RoleToSubscriptionMapInterface {
     return roles.filter((role) => this.nonSubscriptionRoles.includes(role.name as RoleName))
   }
 
+  filterSubscriptionRoles(roles: Role[]): Array<Role> {
+    return roles.filter((role) => !this.nonSubscriptionRoles.includes(role.name as RoleName))
+  }
+
   getSubscriptionNameForRoleName(roleName: RoleName): SubscriptionName | undefined {
     return this.roleNameToSubscriptionNameMap.get(roleName)
   }

packages/auth/src/Domain/Role/RoleToSubscriptionMapInterface.ts

@@ -3,6 +3,7 @@ import { Role } from './Role'
 
 export interface RoleToSubscriptionMapInterface {
   filterNonSubscriptionRoles(roles: Role[]): Array<Role>
+  filterSubscriptionRoles(roles: Role[]): Array<Role>
   getSubscriptionNameForRoleName(roleName: RoleName): SubscriptionName | undefined
   getRoleNameForSubscriptionName(subscriptionName: SubscriptionName): RoleName | undefined
 }

packages/auth/src/Domain/Session/SessionTraceRepositoryInterface.ts

@@ -1,4 +1,4 @@
-import { Uuid } from '@standardnotes/domain-core'
+import { SubscriptionPlanName, Uuid } from '@standardnotes/domain-core'
 
 import { SessionTrace } from './SessionTrace'
 
@@ -6,4 +6,6 @@ export interface SessionTraceRepositoryInterface {
   save(sessionTrace: SessionTrace): Promise<void>
   removeExpiredBefore(date: Date): Promise<void>
   findOneByUserUuidAndDate(userUuid: Uuid, date: Date): Promise<SessionTrace | null>
+  countByDate(date: Date): Promise<number>
+  countByDateAndSubscriptionPlanName(date: Date, subscriptionPlanName: SubscriptionPlanName): Promise<number>
 }

packages/auth/src/Domain/UseCase/CreateCrossServiceToken/CreateCrossServiceToken.spec.ts

@@ -67,7 +67,7 @@ describe('CreateCrossServiceToken', () => {
     userRepository.findOneByUuid = jest.fn().mockReturnValue(user)
 
     roleToSubscriptionMap = {} as jest.Mocked<RoleToSubscriptionMapInterface>
-    roleToSubscriptionMap.filterNonSubscriptionRoles = jest.fn().mockReturnValue([RoleName.NAMES.PlusUser])
+    roleToSubscriptionMap.filterSubscriptionRoles = jest.fn().mockReturnValue([RoleName.NAMES.PlusUser])
     roleToSubscriptionMap.getSubscriptionNameForRoleName = jest
       .fn()
       .mockReturnValue(SubscriptionPlanName.NAMES.PlusPlan)
@@ -170,7 +170,7 @@ describe('CreateCrossServiceToken', () => {
   })
 
   it('should trace session without a subscription role', async () => {
-    roleToSubscriptionMap.filterNonSubscriptionRoles = jest.fn().mockReturnValue([])
+    roleToSubscriptionMap.filterSubscriptionRoles = jest.fn().mockReturnValue([])
 
     await createUseCase().execute({
       user,

packages/auth/src/Domain/UseCase/CreateCrossServiceToken/CreateCrossServiceToken.ts

@@ -102,7 +102,7 @@ export class CreateCrossServiceToken implements UseCaseInterface {
   }
 
   private getSubscriptionNameFromRoles(roles: Array<Role>): string | null {
-    const nonSubscriptionRoles = this.roleToSubscriptionMap.filterNonSubscriptionRoles(roles)
+    const nonSubscriptionRoles = this.roleToSubscriptionMap.filterSubscriptionRoles(roles)
     if (nonSubscriptionRoles.length === 0) {
       return null
     }

packages/auth/src/Domain/UseCase/PersistStatistics/PersistStatistics.spec.ts

@@ -0,0 +1,33 @@
+import { DomainEventPublisherInterface, StatisticPersistenceRequestedEvent } from '@standardnotes/domain-events'
+
+import { DomainEventFactoryInterface } from '../../Event/DomainEventFactoryInterface'
+import { SessionTraceRepositoryInterface } from '../../Session/SessionTraceRepositoryInterface'
+
+import { PersistStatistics } from './PersistStatistics'
+
+describe('PersistStatistics', () => {
+  let sessionTracesRepository: SessionTraceRepositoryInterface
+  let domainEventPublisher: DomainEventPublisherInterface
+  let domainEventFactory: DomainEventFactoryInterface
+  const createUseCase = () => new PersistStatistics(sessionTracesRepository, domainEventPublisher, domainEventFactory)
+
+  beforeEach(() => {
+    sessionTracesRepository = {} as jest.Mocked<SessionTraceRepositoryInterface>
+    sessionTracesRepository.countByDate = jest.fn().mockReturnValue(1)
+    sessionTracesRepository.countByDateAndSubscriptionPlanName = jest.fn().mockReturnValue(2)
+
+    domainEventFactory = {} as jest.Mocked<DomainEventFactoryInterface>
+    domainEventFactory.createStatisticPersistenceRequestedEvent = jest
+      .fn()
+      .mockReturnValue({} as jest.Mocked<StatisticPersistenceRequestedEvent>)
+
+    domainEventPublisher = {} as jest.Mocked<DomainEventPublisherInterface>
+    domainEventPublisher.publish = jest.fn()
+  })
+
+  it('should request statistic persistence', async () => {
+    await createUseCase().execute({ sessionsInADay: new Date() })
+
+    expect(domainEventPublisher.publish).toHaveBeenCalledTimes(4)
+  })
+})

packages/auth/src/Domain/UseCase/PersistStatistics/PersistStatistics.ts

@@ -0,0 +1,61 @@
+import { Result, SubscriptionPlanName, UseCaseInterface } from '@standardnotes/domain-core'
+import { DomainEventPublisherInterface } from '@standardnotes/domain-events'
+import { DomainEventFactoryInterface } from '../../Event/DomainEventFactoryInterface'
+import { SessionTraceRepositoryInterface } from '../../Session/SessionTraceRepositoryInterface'
+import { PersistStatisticsDTO } from './PersistStatisticsDTO'
+
+export class PersistStatistics implements UseCaseInterface<string> {
+  constructor(
+    private sessionTracesRepository: SessionTraceRepositoryInterface,
+    private domainEventPublisher: DomainEventPublisherInterface,
+    private domainEventFactory: DomainEventFactoryInterface,
+  ) {}
+
+  async execute(dto: PersistStatisticsDTO): Promise<Result<string>> {
+    const countSessionsInADay = await this.sessionTracesRepository.countByDate(dto.sessionsInADay)
+    await this.domainEventPublisher.publish(
+      this.domainEventFactory.createStatisticPersistenceRequestedEvent({
+        statisticMeasureName: 'active-users',
+        value: countSessionsInADay,
+        date: dto.sessionsInADay,
+      }),
+    )
+
+    const proSubscriptionPlanName = SubscriptionPlanName.create(SubscriptionPlanName.NAMES.ProPlan).getValue()
+    const countProSessionsInADay = await this.sessionTracesRepository.countByDateAndSubscriptionPlanName(
+      dto.sessionsInADay,
+      proSubscriptionPlanName,
+    )
+    await this.domainEventPublisher.publish(
+      this.domainEventFactory.createStatisticPersistenceRequestedEvent({
+        statisticMeasureName: 'active-pro-users',
+        value: countProSessionsInADay,
+        date: dto.sessionsInADay,
+      }),
+    )
+
+    const plusSubscriptionPlanName = SubscriptionPlanName.create(SubscriptionPlanName.NAMES.PlusPlan).getValue()
+    const countPlusSessionsInADay = await this.sessionTracesRepository.countByDateAndSubscriptionPlanName(
+      dto.sessionsInADay,
+      plusSubscriptionPlanName,
+    )
+    await this.domainEventPublisher.publish(
+      this.domainEventFactory.createStatisticPersistenceRequestedEvent({
+        statisticMeasureName: 'active-plus-users',
+        value: countPlusSessionsInADay,
+        date: dto.sessionsInADay,
+      }),
+    )
+
+    const countFreeSessionsInADay = countSessionsInADay - countProSessionsInADay - countPlusSessionsInADay
+    await this.domainEventPublisher.publish(
+      this.domainEventFactory.createStatisticPersistenceRequestedEvent({
+        statisticMeasureName: 'active-free-users',
+        value: countFreeSessionsInADay,
+        date: dto.sessionsInADay,
+      }),
+    )
+
+    return Result.ok('Statistics persisted.')
+  }
+}

packages/auth/src/Domain/UseCase/PersistStatistics/PersistStatisticsDTO.ts

@@ -0,0 +1,3 @@
+export interface PersistStatisticsDTO {
+  sessionsInADay: Date
+}

packages/auth/src/Infra/MySQL/MySQLSessionTraceRepository.ts

@@ -1,4 +1,4 @@
-import { MapperInterface, Uuid } from '@standardnotes/domain-core'
+import { MapperInterface, SubscriptionPlanName, Uuid } from '@standardnotes/domain-core'
 import { Repository } from 'typeorm'
 import { SessionTrace } from '../../Domain/Session/SessionTrace'
 import { SessionTraceRepositoryInterface } from '../../Domain/Session/SessionTraceRepositoryInterface'
@@ -10,6 +10,27 @@ export class MySQLSessionTraceRepository implements SessionTraceRepositoryInterf
     private mapper: MapperInterface<SessionTrace, TypeORMSessionTrace>,
   ) {}
 
+  async countByDateAndSubscriptionPlanName(date: Date, subscriptionPlanName: SubscriptionPlanName): Promise<number> {
+    return this.ormRepository
+      .createQueryBuilder('trace')
+      .where('trace.creation_date = :creationDate', {
+        creationDate: new Date(date.getFullYear(), date.getMonth(), date.getDate()),
+      })
+      .andWhere('trace.subscription_plan_name = :subscriptionPlanName', {
+        subscriptionPlanName: subscriptionPlanName.value,
+      })
+      .getCount()
+  }
+
+  async countByDate(date: Date): Promise<number> {
+    return this.ormRepository
+      .createQueryBuilder('trace')
+      .where('trace.creation_date = :creationDate', {
+        creationDate: new Date(date.getFullYear(), date.getMonth(), date.getDate()),
+      })
+      .getCount()
+  }
+
   async removeExpiredBefore(date: Date): Promise<void> {
     await this.ormRepository
       .createQueryBuilder()