chore(release): publish new version

- @standardnotes/analytics@2.11.5
 - @standardnotes/api-gateway@1.38.8
 - @standardnotes/auth-server@1.60.3
 - @standardnotes/domain-events-infra@1.9.30
 - @standardnotes/domain-events@2.90.0
 - @standardnotes/event-store@1.6.25
 - @standardnotes/files-server@1.8.25
 - @standardnotes/revisions-server@1.1.3
 - @standardnotes/scheduler-server@1.13.26
 - @standardnotes/syncing-server@1.15.0
 - @standardnotes/websockets-server@1.4.27
 - @standardnotes/workspace-server@1.17.25

.github/workflows/revisions.yml

@@ -0,0 +1,46 @@
+name: Revisions Server
+
+concurrency:
+  group: revisions_server
+  cancel-in-progress: true
+
+on:
+  push:
+    tags:
+      - '*standardnotes/revisions-server*'
+  workflow_dispatch:
+
+jobs:
+  call_server_application_workflow:
+    name: Server Application
+    uses: standardnotes/server/.github/workflows/common-server-application.yml@main
+    with:
+      service_name: revisions
+      workspace_name: "@standardnotes/revisions-server"
+      e2e_tag_parameter_name: revisions_image_tag
+      package_path: packages/revisions
+    secrets: inherit
+
+  newrelic:
+    needs: call_server_application_workflow
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create New Relic deployment marker for Web
+        uses: newrelic/deployment-marker-action@v1
+        with:
+          accountId: ${{ secrets.NEW_RELIC_ACCOUNT_ID }}
+          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
+          applicationId: ${{ secrets.NEW_RELIC_APPLICATION_ID_REVISIONS_WEB_PROD }}
+          revision: "${{ github.sha }}"
+          description: "Automated Deployment via Github Actions"
+          user: "${{ github.actor }}"
+      - name: Create New Relic deployment marker for Worker
+        uses: newrelic/deployment-marker-action@v1
+        with:
+          accountId: ${{ secrets.NEW_RELIC_ACCOUNT_ID }}
+          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
+          applicationId: ${{ secrets.NEW_RELIC_APPLICATION_ID_REVISIONS_WORKER_PROD }}
+          revision: "${{ github.sha }}"
+          description: "Automated Deployment via Github Actions"
+          user: "${{ github.actor }}"

.pnp.cjs

@@ -53,6 +53,10 @@ const RAW_RUNTIME_STATE =
       "name": "@standardnotes/predicates",\
       "reference": "workspace:packages/predicates"\
     },\
+    {\
+      "name": "@standardnotes/revisions-server",\
+      "reference": "workspace:packages/revisions"\
+    },\
     {\
       "name": "@standardnotes/scheduler-server",\
       "reference": "workspace:packages/scheduler"\
@@ -99,6 +103,7 @@ const RAW_RUNTIME_STATE =
     ["@standardnotes/event-store", ["workspace:packages/event-store"]],\
     ["@standardnotes/files-server", ["workspace:packages/files"]],\
     ["@standardnotes/predicates", ["workspace:packages/predicates"]],\
+    ["@standardnotes/revisions-server", ["workspace:packages/revisions"]],\
     ["@standardnotes/scheduler-server", ["workspace:packages/scheduler"]],\
     ["@standardnotes/security", ["workspace:packages/security"]],\
     ["@standardnotes/server-monorepo", ["workspace:."]],\
@@ -3004,6 +3009,52 @@ const RAW_RUNTIME_STATE =
         "linkType": "HARD"\
       }]\
     ]],\
+    ["@standardnotes/revisions-server", [\
+      ["workspace:packages/revisions", {\
+        "packageLocation": "./packages/revisions/",\
+        "packageDependencies": [\
+          ["@standardnotes/revisions-server", "workspace:packages/revisions"],\
+          ["@newrelic/native-metrics", "npm:9.0.0"],\
+          ["@newrelic/winston-enricher", "virtual:c66bf20e88479ada0172094776519a9f51acc4731d22079b60a295bcec7ea42d5545cbce58a77a50d932bf953298799135e99707486e343da6d99ba1d167bdbd#npm:4.0.0"],\
+          ["@sentry/node", "npm:7.19.0"],\
+          ["@standardnotes/api", "npm:1.19.0"],\
+          ["@standardnotes/common", "workspace:packages/common"],\
+          ["@standardnotes/domain-core", "workspace:packages/domain-core"],\
+          ["@standardnotes/domain-events", "workspace:packages/domain-events"],\
+          ["@standardnotes/domain-events-infra", "workspace:packages/domain-events-infra"],\
+          ["@standardnotes/security", "workspace:packages/security"],\
+          ["@standardnotes/time", "workspace:packages/time"],\
+          ["@types/cors", "npm:2.8.12"],\
+          ["@types/dotenv", "npm:8.2.0"],\
+          ["@types/express", "npm:4.17.14"],\
+          ["@types/inversify-express-utils", "npm:2.0.0"],\
+          ["@types/ioredis", "npm:5.0.0"],\
+          ["@types/jest", "npm:29.1.1"],\
+          ["@types/newrelic", "npm:7.0.4"],\
+          ["@typescript-eslint/eslint-plugin", "virtual:04783e12400851b8a3d76e71495851cc94959db6e62f04cb0a31190080629440b182d8c8eb4d7f2b04e281912f2783a5fd4d2c3c6ab68d38b7097246c93f4c19#npm:5.40.1"],\
+          ["aws-sdk", "npm:2.1253.0"],\
+          ["cors", "npm:2.8.5"],\
+          ["dotenv", "npm:16.0.1"],\
+          ["eslint", "npm:8.25.0"],\
+          ["eslint-plugin-prettier", "virtual:c66bf20e88479ada0172094776519a9f51acc4731d22079b60a295bcec7ea42d5545cbce58a77a50d932bf953298799135e99707486e343da6d99ba1d167bdbd#npm:4.2.1"],\
+          ["express", "npm:4.18.2"],\
+          ["helmet", "npm:6.0.0"],\
+          ["inversify", "npm:6.0.1"],\
+          ["inversify-express-utils", "npm:6.4.3"],\
+          ["ioredis", "npm:5.2.4"],\
+          ["jest", "virtual:fd909b174d079e30b336c4ce72c38a88c1e447767b1a8dd7655e07719a1e31b97807f0931368724fc78897ff15e6a6d00b83316c0f76d11f85111f342e08bb79#npm:29.1.2"],\
+          ["mysql2", "npm:2.3.3"],\
+          ["newrelic", "npm:9.6.0"],\
+          ["npm-check-updates", "npm:16.0.1"],\
+          ["reflect-metadata", "npm:0.1.13"],\
+          ["ts-jest", "virtual:fd909b174d079e30b336c4ce72c38a88c1e447767b1a8dd7655e07719a1e31b97807f0931368724fc78897ff15e6a6d00b83316c0f76d11f85111f342e08bb79#npm:29.0.3"],\
+          ["typeorm", "virtual:c66bf20e88479ada0172094776519a9f51acc4731d22079b60a295bcec7ea42d5545cbce58a77a50d932bf953298799135e99707486e343da6d99ba1d167bdbd#npm:0.3.10"],\
+          ["typescript", "patch:typescript@npm%3A4.8.4#optional!builtin<compat/typescript>::version=4.8.4&hash=701156"],\
+          ["winston", "npm:3.8.2"]\
+        ],\
+        "linkType": "SOFT"\
+      }]\
+    ]],\
     ["@standardnotes/scheduler-server", [\
       ["workspace:packages/scheduler", {\
         "packageLocation": "./packages/scheduler/",\

package.json

@@ -21,6 +21,7 @@
     "lint:websockets": "yarn workspace @standardnotes/websockets-server lint",
     "lint:workspace": "yarn workspace @standardnotes/workspace-server lint",
     "lint:analytics": "yarn workspace @standardnotes/analytics lint",
+    "lint:revisions": "yarn workspace @standardnotes/revisions-server lint",
     "clean": "yarn workspaces foreach -p --verbose run clean",
     "setup:env": "cp .env.sample .env && yarn workspaces foreach -p --verbose run setup:env",
     "start:auth": "yarn workspace @standardnotes/auth-server start",
@@ -34,6 +35,7 @@
     "start:websockets": "yarn workspace @standardnotes/websockets-server start",
     "start:workspace": "yarn workspace @standardnotes/workspace-server start",
     "start:analytics": "yarn workspace @standardnotes/analytics worker",
+    "start:revisions": "yarn workspace @standardnotes/revisions-server start",
     "release": "lerna version --conventional-graduate --conventional-commits --yes -m \"chore(release): publish new version\"",
     "publish": "lerna publish from-git --yes --no-verify-access --loglevel verbose",
     "postversion": "./scripts/push-tags-one-by-one.sh",

packages/analytics/CHANGELOG.md

@@ -3,6 +3,42 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.11.5](https://github.com/standardnotes/server/compare/@standardnotes/analytics@2.11.4...@standardnotes/analytics@2.11.5) (2022-11-21)
+
+**Note:** Version bump only for package @standardnotes/analytics
+
+## [2.11.4](https://github.com/standardnotes/server/compare/@standardnotes/analytics@2.11.3...@standardnotes/analytics@2.11.4) (2022-11-21)
+
+**Note:** Version bump only for package @standardnotes/analytics
+
+## [2.11.3](https://github.com/standardnotes/server/compare/@standardnotes/analytics@2.11.2...@standardnotes/analytics@2.11.3) (2022-11-18)
+
+**Note:** Version bump only for package @standardnotes/analytics
+
+## [2.11.2](https://github.com/standardnotes/server/compare/@standardnotes/analytics@2.11.1...@standardnotes/analytics@2.11.2) (2022-11-18)
+
+### Bug Fixes
+
+* **analytics:** specs ([507d43b](https://github.com/standardnotes/server/commit/507d43b3289d1e178644df6d3e15d1d55e56c7bb))
+
+## [2.11.1](https://github.com/standardnotes/server/compare/@standardnotes/analytics@2.11.0...@standardnotes/analytics@2.11.1) (2022-11-18)
+
+### Bug Fixes
+
+* mapper interface imports ([1ec0723](https://github.com/standardnotes/server/commit/1ec072373d640c4e2f24b9bb12fec0c678b48032))
+
+# [2.11.0](https://github.com/standardnotes/server/compare/@standardnotes/analytics@2.10.3...@standardnotes/analytics@2.11.0) (2022-11-16)
+
+### Features
+
+* **analytics:** add publishing churn calculation values in the report ([6c43a33](https://github.com/standardnotes/server/commit/6c43a331d09c2dcf1300742509da6a1d8ef2f5b7))
+
+## [2.10.3](https://github.com/standardnotes/server/compare/@standardnotes/analytics@2.10.2...@standardnotes/analytics@2.10.3) (2022-11-16)
+
+### Bug Fixes
+
+* **analytics:** exclude five year plans from mrr stats ([fe1b2a0](https://github.com/standardnotes/server/commit/fe1b2a0e0744417e592f3f61f42610765b416ce6))
+
 ## [2.10.2](https://github.com/standardnotes/server/compare/@standardnotes/analytics@2.10.1...@standardnotes/analytics@2.10.2) (2022-11-14)
 
 ### Bug Fixes

packages/analytics/bin/report.ts

@@ -175,6 +175,9 @@ const requestReport = async (
   const churnRates: Array<{
     rate: number
     periodKey: string
+    averageCustomersCount: number
+    existingCustomersChurn: number
+    newCustomersChurn: number
   }> = []
   for (const monthPeriodKey of monthlyPeriodKeys) {
     const monthPeriod = periodKeyGenerator.convertPeriodKeyToPeriod(monthPeriodKey)
@@ -204,6 +207,9 @@ const requestReport = async (
     churnRates.push({
       periodKey: monthPeriodKey,
       rate: averageCustomersCount ? (totalChurn / averageCustomersCount) * 100 : 0,
+      averageCustomersCount,
+      existingCustomersChurn,
+      newCustomersChurn,
     })
   }
 

packages/analytics/package.json

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

packages/analytics/src/Bootstrap/Container.ts

@@ -7,7 +7,7 @@ import {
   DomainEventMessageHandlerInterface,
   DomainEventSubscriberFactoryInterface,
 } from '@standardnotes/domain-events'
-import { MapInterface } from '@standardnotes/domain-core'
+import { MapperInterface } from '@standardnotes/domain-core'
 
 import { Env } from './Env'
 import TYPES from './Types'
@@ -172,7 +172,7 @@ export class ContainerConfigLoader {
 
     // Maps
     container
-      .bind<MapInterface<RevenueModification, TypeORMRevenueModification>>(TYPES.RevenueModificationMap)
+      .bind<MapperInterface<RevenueModification, TypeORMRevenueModification>>(TYPES.RevenueModificationMap)
       .to(RevenueModificationMap)
 
     // Services

packages/analytics/src/Domain/Event/DomainEventFactory.spec.ts

@@ -1,140 +0,0 @@
-import 'reflect-metadata'
-
-import { TimerInterface } from '@standardnotes/time'
-
-import { AnalyticsActivity } from '../Analytics/AnalyticsActivity'
-import { StatisticsMeasure } from '../Statistics/StatisticsMeasure'
-import { Period } from '../Time/Period'
-
-import { DomainEventFactory } from './DomainEventFactory'
-
-describe('DomainEventFactory', () => {
-  let timer: TimerInterface
-
-  const createFactory = () => new DomainEventFactory(timer)
-
-  beforeEach(() => {
-    timer = {} as jest.Mocked<TimerInterface>
-    timer.getTimestampInMicroseconds = jest.fn().mockReturnValue(1)
-    timer.getUTCDate = jest.fn().mockReturnValue(new Date(1))
-  })
-
-  it('should create a DAILY_ANALYTICS_REPORT_GENERATED event', () => {
-    expect(
-      createFactory().createDailyAnalyticsReportGeneratedEvent({
-        activityStatistics: [
-          {
-            name: AnalyticsActivity.Register,
-            retention: 24,
-            totalCount: 45,
-          },
-        ],
-        statisticMeasures: [
-          {
-            name: StatisticsMeasure.Income,
-            totalValue: 43,
-            average: 23,
-            increments: 5,
-            period: Period.Today,
-          },
-        ],
-        activityStatisticsOverTime: [
-          {
-            name: AnalyticsActivity.Register,
-            period: Period.Last30Days,
-            counts: [
-              {
-                periodKey: '2022-10-9',
-                totalCount: 3,
-              },
-            ],
-            totalCount: 123,
-          },
-        ],
-        statisticsOverTime: [
-          {
-            name: StatisticsMeasure.MRR,
-            period: Period.Last30Days,
-            counts: [
-              {
-                periodKey: '2022-10-9',
-                totalCount: 3,
-              },
-            ],
-          },
-        ],
-        churn: {
-          periodKeys: ['2022-10-9'],
-          values: [
-            {
-              rate: 12,
-              periodKey: '2022-10-9',
-            },
-          ],
-        },
-      }),
-    ).toEqual({
-      createdAt: expect.any(Date),
-      meta: {
-        correlation: {
-          userIdentifier: '',
-          userIdentifierType: 'uuid',
-        },
-        origin: 'analytics',
-      },
-      payload: {
-        activityStatistics: [
-          {
-            name: 'register',
-            retention: 24,
-            totalCount: 45,
-          },
-        ],
-        activityStatisticsOverTime: [
-          {
-            counts: [
-              {
-                periodKey: '2022-10-9',
-                totalCount: 3,
-              },
-            ],
-            name: 'register',
-            period: 9,
-            totalCount: 123,
-          },
-        ],
-        statisticsOverTime: [
-          {
-            counts: [
-              {
-                periodKey: '2022-10-9',
-                totalCount: 3,
-              },
-            ],
-            name: 'mrr',
-            period: 9,
-          },
-        ],
-        churn: {
-          periodKeys: ['2022-10-9'],
-          values: [
-            {
-              periodKey: '2022-10-9',
-              rate: 12,
-            },
-          ],
-        },
-        statisticMeasures: [
-          {
-            average: 23,
-            increments: 5,
-            name: 'income',
-            period: 0,
-            totalValue: 43,
-          },
-        ],
-      },
-      type: 'DAILY_ANALYTICS_REPORT_GENERATED',
-    })
-  })
-})

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

@@ -1,3 +1,5 @@
+/* istanbul ignore file */
+
 import { DomainEventService, DailyAnalyticsReportGeneratedEvent } from '@standardnotes/domain-events'
 import { TimerInterface } from '@standardnotes/time'
 import { inject, injectable } from 'inversify'
@@ -43,6 +45,9 @@ export class DomainEventFactory implements DomainEventFactoryInterface {
       values: Array<{
         rate: number
         periodKey: string
+        averageCustomersCount: number
+        existingCustomersChurn: number
+        newCustomersChurn: number
       }>
     }
   }): DailyAnalyticsReportGeneratedEvent {

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

@@ -36,6 +36,9 @@ export interface DomainEventFactoryInterface {
       values: Array<{
         rate: number
         periodKey: string
+        averageCustomersCount: number
+        existingCustomersChurn: number
+        newCustomersChurn: number
       }>
     }
   }): DailyAnalyticsReportGeneratedEvent

packages/analytics/src/Domain/Map/RevenueModificationMap.ts

@@ -1,5 +1,5 @@
 import { injectable } from 'inversify'
-import { Email, MapInterface, UniqueEntityId } from '@standardnotes/domain-core'
+import { Email, MapperInterface, UniqueEntityId } from '@standardnotes/domain-core'
 
 import { TypeORMRevenueModification } from '../../Infra/TypeORM/TypeORMRevenueModification'
 import { MonthlyRevenue } from '../Revenue/MonthlyRevenue'
@@ -10,7 +10,7 @@ import { SubscriptionPlanName } from '../Subscription/SubscriptionPlanName'
 import { SubscriptionEventType } from '../Subscription/SubscriptionEventType'
 
 @injectable()
-export class RevenueModificationMap implements MapInterface<RevenueModification, TypeORMRevenueModification> {
+export class RevenueModificationMap implements MapperInterface<RevenueModification, TypeORMRevenueModification> {
   toDomain(persistence: TypeORMRevenueModification): RevenueModification {
     const userOrError = User.create(
       {

packages/analytics/src/Domain/Revenue/RevenueModificationRepositoryInterface.ts

@@ -4,6 +4,6 @@ import { RevenueModification } from './RevenueModification'
 
 export interface RevenueModificationRepositoryInterface {
   findLastByUserUuid(userUuid: Uuid): Promise<RevenueModification | null>
-  sumMRRDiff(dto: { planName?: string; billingFrequency?: number }): Promise<number>
+  sumMRRDiff(dto: { billingFrequencies: number[]; planNames?: string[] }): Promise<number>
   save(revenueModification: RevenueModification): Promise<RevenueModification>
 }

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

@@ -20,7 +20,9 @@ export class CalculateMonthlyRecurringRevenue implements DomainUseCaseInterface<
   ) {}
 
   async execute(_dto: CalculateMonthlyRecurringRevenueDTO): Promise<Result<MonthlyRevenue>> {
-    const mrrDiff = await this.revenueModificationRepository.sumMRRDiff({})
+    const mrrDiff = await this.revenueModificationRepository.sumMRRDiff({
+      billingFrequencies: [SubscriptionBillingFrequency.Annual, SubscriptionBillingFrequency.Monthly],
+    })
 
     await this.statisticsStore.setMeasure(StatisticsMeasure.MRR, mrrDiff, [
       Period.Today,
@@ -29,7 +31,7 @@ export class CalculateMonthlyRecurringRevenue implements DomainUseCaseInterface<
     ])
 
     const monthlyPlansMrrDiff = await this.revenueModificationRepository.sumMRRDiff({
-      billingFrequency: SubscriptionBillingFrequency.Monthly,
+      billingFrequencies: [SubscriptionBillingFrequency.Monthly],
     })
 
     await this.statisticsStore.setMeasure(StatisticsMeasure.MonthlyPlansMRR, monthlyPlansMrrDiff, [
@@ -39,7 +41,7 @@ export class CalculateMonthlyRecurringRevenue implements DomainUseCaseInterface<
     ])
 
     const annualPlansMrrDiff = await this.revenueModificationRepository.sumMRRDiff({
-      billingFrequency: SubscriptionBillingFrequency.Annual,
+      billingFrequencies: [SubscriptionBillingFrequency.Annual],
     })
 
     await this.statisticsStore.setMeasure(StatisticsMeasure.AnnualPlansMRR, annualPlansMrrDiff, [
@@ -49,7 +51,7 @@ export class CalculateMonthlyRecurringRevenue implements DomainUseCaseInterface<
     ])
 
     const fiveYearPlansMrrDiff = await this.revenueModificationRepository.sumMRRDiff({
-      billingFrequency: SubscriptionBillingFrequency.FiveYear,
+      billingFrequencies: [SubscriptionBillingFrequency.FiveYear],
     })
 
     await this.statisticsStore.setMeasure(StatisticsMeasure.FiveYearPlansMRR, fiveYearPlansMrrDiff, [
@@ -59,7 +61,8 @@ export class CalculateMonthlyRecurringRevenue implements DomainUseCaseInterface<
     ])
 
     const proPlansMrrDiff = await this.revenueModificationRepository.sumMRRDiff({
-      planName: SubscriptionName.ProPlan,
+      planNames: [SubscriptionName.ProPlan],
+      billingFrequencies: [SubscriptionBillingFrequency.Annual, SubscriptionBillingFrequency.Monthly],
     })
 
     await this.statisticsStore.setMeasure(StatisticsMeasure.ProPlansMRR, proPlansMrrDiff, [
@@ -69,7 +72,8 @@ export class CalculateMonthlyRecurringRevenue implements DomainUseCaseInterface<
     ])
 
     const plusPlansMrrDiff = await this.revenueModificationRepository.sumMRRDiff({
-      planName: SubscriptionName.PlusPlan,
+      planNames: [SubscriptionName.PlusPlan],
+      billingFrequencies: [SubscriptionBillingFrequency.Annual, SubscriptionBillingFrequency.Monthly],
     })
 
     await this.statisticsStore.setMeasure(StatisticsMeasure.PlusPlansMRR, plusPlansMrrDiff, [

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

@@ -14,7 +14,7 @@ describe('GetUserAnalyticsId', () => {
   beforeEach(() => {
     analyticsEntity = {
       id: 123,
-      userUuid: '1-2-3',
+      userUuid: '84c0f8e8-544a-4c7e-9adf-26209303bc1d',
       userEmail: 'test@test.te',
     } as jest.Mocked<AnalyticsEntity>
 
@@ -24,11 +24,11 @@ describe('GetUserAnalyticsId', () => {
   })
 
   it('should return analytics id for a user by uuid', async () => {
-    expect(await (await createUseCase().execute({ userUuid: '1-2-3' })).analyticsId).toEqual(123)
+    expect((await createUseCase().execute({ userUuid: '1-2-3' })).analyticsId).toEqual(123)
   })
 
   it('should return analytics id for a user by email', async () => {
-    expect(await (await createUseCase().execute({ userEmail: 'test@test.te' })).analyticsId).toEqual(123)
+    expect((await createUseCase().execute({ userEmail: 'test@test.te' })).analyticsId).toEqual(123)
   })
 
   it('should throw error if user is missing analytics entity', async () => {

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

@@ -46,7 +46,7 @@ describe('SaveRevenueModification', () => {
       planName: SubscriptionPlanName.create('PRO_PLAN').getValue(),
       subscriptionId: 1234,
       userEmail: Email.create('test@test.te').getValue(),
-      userUuid: Uuid.create('1-2-3').getValue(),
+      userUuid: Uuid.create('84c0f8e8-544a-4c7e-9adf-26209303bc1d').getValue(),
     })
 
     expect(revenueOrError.isFailed()).toBeFalsy()
@@ -64,7 +64,7 @@ describe('SaveRevenueModification', () => {
       planName: SubscriptionPlanName.create('PRO_PLAN').getValue(),
       subscriptionId: 1234,
       userEmail: Email.create('test@test.te').getValue(),
-      userUuid: Uuid.create('1-2-3').getValue(),
+      userUuid: Uuid.create('84c0f8e8-544a-4c7e-9adf-26209303bc1d').getValue(),
     })
 
     expect(revenueOrError.isFailed()).toBeFalsy()
@@ -82,7 +82,7 @@ describe('SaveRevenueModification', () => {
       planName: SubscriptionPlanName.create('PRO_PLAN').getValue(),
       subscriptionId: 1234,
       userEmail: Email.create('test@test.te').getValue(),
-      userUuid: Uuid.create('1-2-3').getValue(),
+      userUuid: Uuid.create('84c0f8e8-544a-4c7e-9adf-26209303bc1d').getValue(),
     })
 
     expect(revenueOrError.isFailed()).toBeFalsy()
@@ -102,7 +102,7 @@ describe('SaveRevenueModification', () => {
       planName: SubscriptionPlanName.create('PRO_PLAN').getValue(),
       subscriptionId: 1234,
       userEmail: Email.create('test@test.te').getValue(),
-      userUuid: Uuid.create('1-2-3').getValue(),
+      userUuid: Uuid.create('84c0f8e8-544a-4c7e-9adf-26209303bc1d').getValue(),
     })
 
     expect(revenueOrError.isFailed()).toBeFalsy()
@@ -123,7 +123,7 @@ describe('SaveRevenueModification', () => {
       planName: SubscriptionPlanName.create('PRO_PLAN').getValue(),
       subscriptionId: 1234,
       userEmail: Email.create('test@test.te').getValue(),
-      userUuid: Uuid.create('1-2-3').getValue(),
+      userUuid: Uuid.create('84c0f8e8-544a-4c7e-9adf-26209303bc1d').getValue(),
     })
 
     expect(revenueOrError.isFailed()).toBeTruthy()
@@ -143,7 +143,7 @@ describe('SaveRevenueModification', () => {
       planName: SubscriptionPlanName.create('PRO_PLAN').getValue(),
       subscriptionId: 1234,
       userEmail: Email.create('test@test.te').getValue(),
-      userUuid: Uuid.create('1-2-3').getValue(),
+      userUuid: Uuid.create('84c0f8e8-544a-4c7e-9adf-26209303bc1d').getValue(),
     })
 
     expect(revenueOrError.isFailed()).toBeTruthy()
@@ -163,7 +163,7 @@ describe('SaveRevenueModification', () => {
       planName: SubscriptionPlanName.create('PRO_PLAN').getValue(),
       subscriptionId: 1234,
       userEmail: Email.create('test@test.te').getValue(),
-      userUuid: Uuid.create('1-2-3').getValue(),
+      userUuid: Uuid.create('84c0f8e8-544a-4c7e-9adf-26209303bc1d').getValue(),
     })
 
     expect(revenueOrError.isFailed()).toBeTruthy()
@@ -183,7 +183,7 @@ describe('SaveRevenueModification', () => {
       planName: SubscriptionPlanName.create('PRO_PLAN').getValue(),
       subscriptionId: 1234,
       userEmail: Email.create('test@test.te').getValue(),
-      userUuid: Uuid.create('1-2-3').getValue(),
+      userUuid: Uuid.create('84c0f8e8-544a-4c7e-9adf-26209303bc1d').getValue(),
     })
 
     expect(revenueOrError.isFailed()).toBeTruthy()
@@ -203,7 +203,7 @@ describe('SaveRevenueModification', () => {
       planName: SubscriptionPlanName.create('PRO_PLAN').getValue(),
       subscriptionId: 1234,
       userEmail: Email.create('test@test.te').getValue(),
-      userUuid: Uuid.create('1-2-3').getValue(),
+      userUuid: Uuid.create('84c0f8e8-544a-4c7e-9adf-26209303bc1d').getValue(),
     })
 
     expect(revenueOrError.isFailed()).toBeTruthy()

packages/analytics/src/Infra/MySQL/MySQLRevenueModificationRepository.ts

@@ -1,6 +1,6 @@
 import { inject, injectable } from 'inversify'
 import { Repository } from 'typeorm'
-import { MapInterface, Uuid } from '@standardnotes/domain-core'
+import { MapperInterface, Uuid } from '@standardnotes/domain-core'
 
 import TYPES from '../../Bootstrap/Types'
 import { RevenueModification } from '../../Domain/Revenue/RevenueModification'
@@ -13,17 +13,17 @@ export class MySQLRevenueModificationRepository implements RevenueModificationRe
     @inject(TYPES.ORMRevenueModificationRepository)
     private ormRepository: Repository<TypeORMRevenueModification>,
     @inject(TYPES.RevenueModificationMap)
-    private revenueModificationMap: MapInterface<RevenueModification, TypeORMRevenueModification>,
+    private revenueModificationMap: MapperInterface<RevenueModification, TypeORMRevenueModification>,
   ) {}
 
-  async sumMRRDiff(dto: { planName?: string; billingFrequency?: number }): Promise<number> {
+  async sumMRRDiff(dto: { billingFrequencies: number[]; planNames?: string[] }): Promise<number> {
     const query = this.ormRepository.createQueryBuilder().select('sum(new_mrr - previous_mrr)', 'mrrDiff')
 
-    if (dto.planName !== undefined) {
-      query.where('subscription_plan = :planName', { planName: dto.planName })
+    if (dto.billingFrequencies.length > 0) {
+      query.where('billing_frequency IN (:...billingFrequencies)', { billingFrequencies: dto.billingFrequencies })
     }
-    if (dto.billingFrequency !== undefined) {
-      query.where('billing_frequency = :billingFrequency', { billingFrequency: dto.billingFrequency })
+    if (dto.planNames && dto.planNames.length > 0) {
+      query.andWhere('subscription_plan IN (:...planNames)', { planNames: dto.planNames })
     }
 
     const result = await query.getRawOne()

packages/api-gateway/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.38.8](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.38.7...@standardnotes/api-gateway@1.38.8) (2022-11-21)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.38.7](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.38.6...@standardnotes/api-gateway@1.38.7) (2022-11-18)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
+## [1.38.6](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.38.5...@standardnotes/api-gateway@1.38.6) (2022-11-16)
+
+**Note:** Version bump only for package @standardnotes/api-gateway
+
 ## [1.38.5](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.38.4...@standardnotes/api-gateway@1.38.5) (2022-11-14)
 
 **Note:** Version bump only for package @standardnotes/api-gateway

packages/api-gateway/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/api-gateway",
-  "version": "1.38.5",
+  "version": "1.38.8",
   "engines": {
     "node": ">=18.0.0 <19.0.0"
   },

packages/auth/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.60.3](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.60.2...@standardnotes/auth-server@1.60.3) (2022-11-21)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.60.2](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.60.1...@standardnotes/auth-server@1.60.2) (2022-11-18)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
+## [1.60.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.60.0...@standardnotes/auth-server@1.60.1) (2022-11-16)
+
+**Note:** Version bump only for package @standardnotes/auth-server
+
 # [1.60.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.59.11...@standardnotes/auth-server@1.60.0) (2022-11-14)
 
 ### Features

packages/auth/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/auth-server",
-  "version": "1.60.0",
+  "version": "1.60.3",
   "engines": {
     "node": ">=18.0.0 <19.0.0"
   },

packages/domain-core/CHANGELOG.md

@@ -3,6 +3,19 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.1](https://github.com/standardnotes/server/compare/@standardnotes/domain-core@1.2.0...@standardnotes/domain-core@1.2.1) (2022-11-21)
+
+### Bug Fixes
+
+* **domain-core:** remove revisions related models to revisions microservice ([a6542dd](https://github.com/standardnotes/server/commit/a6542dd63870a8ada5fd8143d8e2133a570d9329))
+
+# [1.2.0](https://github.com/standardnotes/server/compare/@standardnotes/domain-core@1.1.1...@standardnotes/domain-core@1.2.0) (2022-11-18)
+
+### Features
+
+* **domain-core:** add revision definition to domain core ([c8f3a0c](https://github.com/standardnotes/server/commit/c8f3a0ce7b589a6fbc47941fc5d1a44b6cf04fe3))
+* **revisions:** add revisions microservice ([d5c06bf](https://github.com/standardnotes/server/commit/d5c06bfa58a987685fbd8fbab0d22df3fcff3377))
+
 ## [1.1.1](https://github.com/standardnotes/server/compare/@standardnotes/domain-core@1.1.0...@standardnotes/domain-core@1.1.1) (2022-11-14)
 
 ### Bug Fixes

packages/domain-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/domain-core",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "engines": {
     "node": ">=18.0.0 <19.0.0"
   },

packages/domain-core/src/Domain/Common/Timestamps.spec.ts

@@ -0,0 +1,21 @@
+import { Timestamps } from './Timestamps'
+
+describe('Timestamps', () => {
+  it('should create a value object', () => {
+    const valueOrError = Timestamps.create(new Date(1), new Date(2))
+
+    expect(valueOrError.isFailed()).toBeFalsy()
+    expect(valueOrError.getValue().createdAt).toEqual(new Date(1))
+    expect(valueOrError.getValue().updatedAt).toEqual(new Date(2))
+  })
+
+  it('should not create an invalid value object', () => {
+    let valueOrError = Timestamps.create(null as unknown as Date, '2' as unknown as Date)
+
+    expect(valueOrError.isFailed()).toBeTruthy()
+
+    valueOrError = Timestamps.create(new Date(2), '2' as unknown as Date)
+
+    expect(valueOrError.isFailed()).toBeTruthy()
+  })
+})

packages/domain-core/src/Domain/Common/Timestamps.ts

@@ -0,0 +1,32 @@
+import { Result } from '../Core/Result'
+import { ValueObject } from '../Core/ValueObject'
+import { TimestampsProps } from './TimestampsProps'
+
+export class Timestamps extends ValueObject<TimestampsProps> {
+  get createdAt(): Date {
+    return this.props.createdAt
+  }
+
+  get updatedAt(): Date {
+    return this.props.updatedAt
+  }
+
+  private constructor(props: TimestampsProps) {
+    super(props)
+  }
+
+  static create(createdAt: Date, updatedAt: Date): Result<Timestamps> {
+    if (!(createdAt instanceof Date)) {
+      return Result.fail<Timestamps>(
+        `Could not create Timestamps. Creation date should be a date object, given: ${createdAt}`,
+      )
+    }
+    if (!(updatedAt instanceof Date)) {
+      return Result.fail<Timestamps>(
+        `Could not create Timestamps. Update date should be a date object, given: ${createdAt}`,
+      )
+    }
+
+    return Result.ok<Timestamps>(new Timestamps({ createdAt, updatedAt }))
+  }
+}

packages/domain-core/src/Domain/Common/TimestampsProps.ts

@@ -0,0 +1,4 @@
+export interface TimestampsProps {
+  createdAt: Date
+  updatedAt: Date
+}

packages/domain-core/src/Domain/Common/Uuid.spec.ts

@@ -2,14 +2,14 @@ import { Uuid } from './Uuid'
 
 describe('Uuid', () => {
   it('should create a value object', () => {
-    const valueOrError = Uuid.create('1-2-3')
+    const valueOrError = Uuid.create('84c0f8e8-544a-4c7e-9adf-26209303bc1d')
 
     expect(valueOrError.isFailed()).toBeFalsy()
-    expect(valueOrError.getValue().value).toEqual('1-2-3')
+    expect(valueOrError.getValue().value).toEqual('84c0f8e8-544a-4c7e-9adf-26209303bc1d')
   })
 
   it('should not create an invalid value object', () => {
-    const valueOrError = Uuid.create('')
+    const valueOrError = Uuid.create('1-2-3')
 
     expect(valueOrError.isFailed()).toBeTruthy()
   })

packages/domain-core/src/Domain/Common/Uuid.ts

@@ -1,6 +1,7 @@
 import { ValueObject } from '../Core/ValueObject'
 import { Result } from '../Core/Result'
 import { UuidProps } from './UuidProps'
+import { Validator } from '../Core/Validator'
 
 export class Uuid extends ValueObject<UuidProps> {
   get value(): string {
@@ -12,8 +13,9 @@ export class Uuid extends ValueObject<UuidProps> {
   }
 
   static create(uuid: string): Result<Uuid> {
-    if (!!uuid === false || uuid.length === 0) {
-      return Result.fail<Uuid>('Uuid cannot be empty')
+    const validUuidOrError = Validator.isValidUuid(uuid)
+    if (validUuidOrError.isFailed()) {
+      return Result.fail<Uuid>(validUuidOrError.getError())
     } else {
       return Result.ok<Uuid>(new Uuid({ value: uuid }))
     }

packages/domain-core/src/Domain/Core/Validator.spec.ts

@@ -0,0 +1,32 @@
+import { Validator } from './Validator'
+
+describe('Validator', () => {
+  const validUuids = [
+    '2221101c-1da9-4d2b-9b32-b8be2a8d1c82',
+    'c08f2f29-a74b-42b4-aefd-98af9832391c',
+    'b453fa64-1493-443b-b5bb-bca7b9c696c7',
+  ]
+
+  const invalidUuids = [
+    123,
+    'someone@127.0.0.1',
+    '',
+    null,
+    'b453fa64-1493-443b-b5bb-ca7b9c696c7',
+    'c08f*f29-a74b-42b4-aefd-98af9832391c',
+    'c08f*f29-a74b-42b4-aefd-98af9832391c',
+    '../../escaped.sh',
+  ]
+
+  it('should validate proper uuids', () => {
+    for (const validUuid of validUuids) {
+      expect(Validator.isValidUuid(validUuid).isFailed()).toBeFalsy()
+    }
+  })
+
+  it('should not validate invalid uuids', () => {
+    for (const invalidUuid of invalidUuids) {
+      expect(Validator.isValidUuid(invalidUuid as string).isFailed()).toBeTruthy()
+    }
+  })
+})

packages/domain-core/src/Domain/Core/Validator.ts

@@ -0,0 +1,14 @@
+import { Result } from './Result'
+
+export class Validator {
+  private static readonly UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i
+
+  static isValidUuid(value: string): Result<string> {
+    const matchesUuidRegex = String(value).toLowerCase().match(Validator.UUID_REGEX) !== null
+    if (matchesUuidRegex) {
+      return Result.ok()
+    }
+
+    return Result.fail(`Given value is not a valid uuid: ${value}`)
+  }
+}

packages/domain-core/src/Domain/Map/MapInterface.ts

@@ -1,4 +0,0 @@
-export interface MapInterface<T, U> {
-  toDomain(persistence: U): T
-  toProjection(domain: T): U
-}

packages/domain-core/src/Domain/Mapping/MapperInterface.ts

@@ -0,0 +1,4 @@
+export interface MapperInterface<T, U> {
+  toDomain(projection: U): T
+  toProjection(domain: T): U
+}

packages/domain-core/src/Domain/UseCase/UseCaseInterface.ts

@@ -0,0 +1,5 @@
+import { Result } from '../Core/Result'
+
+export interface UseCaseInterface<T> {
+  execute(...args: any[]): Promise<Result<T>>
+}

packages/domain-core/src/Domain/index.ts

@@ -1,5 +1,7 @@
 export * from './Common/Email'
 export * from './Common/EmailProps'
+export * from './Common/Timestamps'
+export * from './Common/TimestampsProps'
 export * from './Common/Uuid'
 export * from './Common/UuidProps'
 
@@ -8,7 +10,10 @@ export * from './Core/Entity'
 export * from './Core/Id'
 export * from './Core/Result'
 export * from './Core/UniqueEntityId'
+export * from './Core/Validator'
 export * from './Core/ValueObject'
 export * from './Core/ValueObjectProps'
 
-export * from './Map/MapInterface'
+export * from './Mapping/MapperInterface'
+
+export * from './UseCase/UseCaseInterface'

packages/domain-events-infra/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.9.30](https://github.com/standardnotes/server/compare/@standardnotes/domain-events-infra@1.9.29...@standardnotes/domain-events-infra@1.9.30) (2022-11-21)
+
+**Note:** Version bump only for package @standardnotes/domain-events-infra
+
+## [1.9.29](https://github.com/standardnotes/server/compare/@standardnotes/domain-events-infra@1.9.28...@standardnotes/domain-events-infra@1.9.29) (2022-11-18)
+
+**Note:** Version bump only for package @standardnotes/domain-events-infra
+
+## [1.9.28](https://github.com/standardnotes/server/compare/@standardnotes/domain-events-infra@1.9.27...@standardnotes/domain-events-infra@1.9.28) (2022-11-16)
+
+**Note:** Version bump only for package @standardnotes/domain-events-infra
+
 ## [1.9.27](https://github.com/standardnotes/server/compare/@standardnotes/domain-events-infra@1.9.26...@standardnotes/domain-events-infra@1.9.27) (2022-11-14)
 
 **Note:** Version bump only for package @standardnotes/domain-events-infra

packages/domain-events-infra/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/domain-events-infra",
-  "version": "1.9.27",
+  "version": "1.9.30",
   "engines": {
     "node": ">=18.0.0 <19.0.0"
   },

packages/domain-events/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.90.0](https://github.com/standardnotes/server/compare/@standardnotes/domain-events@2.89.0...@standardnotes/domain-events@2.90.0) (2022-11-21)
+
+### Features
+
+* **syncing-server:** add creating item dumps for revision service ([8d152dd](https://github.com/standardnotes/server/commit/8d152ddfcb3c88cbbf9df04e3ed6e2c02571d821))
+
+# [2.89.0](https://github.com/standardnotes/server/compare/@standardnotes/domain-events@2.88.0...@standardnotes/domain-events@2.89.0) (2022-11-18)
+
+### Features
+
+* add item revision creation requested event ([5c9dff3](https://github.com/standardnotes/server/commit/5c9dff38c9006d39150ea95b2ca17c4ab7175ec2))
+
+# [2.88.0](https://github.com/standardnotes/server/compare/@standardnotes/domain-events@2.87.0...@standardnotes/domain-events@2.88.0) (2022-11-16)
+
+### Features
+
+* **analytics:** add publishing churn calculation values in the report ([6c43a33](https://github.com/standardnotes/server/commit/6c43a331d09c2dcf1300742509da6a1d8ef2f5b7))
+
 # [2.87.0](https://github.com/standardnotes/server/compare/@standardnotes/domain-events@2.86.3...@standardnotes/domain-events@2.87.0) (2022-11-14)
 
 ### Features

packages/domain-events/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/domain-events",
-  "version": "2.87.0",
+  "version": "2.90.0",
   "engines": {
     "node": ">=18.0.0 <19.0.0"
   },

packages/domain-events/src/Domain/Event/DailyAnalyticsReportGeneratedEventPayload.ts

@@ -32,6 +32,9 @@ export interface DailyAnalyticsReportGeneratedEventPayload {
     periodKeys: Array<string>
     values: Array<{
       rate: number
+      averageCustomersCount: number
+      existingCustomersChurn: number
+      newCustomersChurn: number
       periodKey: string
     }>
   }

packages/domain-events/src/Domain/Event/ItemDumpedEvent.ts

@@ -0,0 +1,7 @@
+import { DomainEventInterface } from './DomainEventInterface'
+import { ItemDumpedEventPayload } from './ItemDumpedEventPayload'
+
+export interface ItemDumpedEvent extends DomainEventInterface {
+  type: 'ITEM_DUMPED'
+  payload: ItemDumpedEventPayload
+}

packages/domain-events/src/Domain/Event/ItemDumpedEventPayload.ts

@@ -0,0 +1,3 @@
+export interface ItemDumpedEventPayload {
+  fileDumpPath: string
+}

packages/domain-events/src/Domain/Event/ItemRevisionCreationRequestedEvent.ts

@@ -0,0 +1,7 @@
+import { DomainEventInterface } from './DomainEventInterface'
+import { ItemRevisionCreationRequestedEventPayload } from './ItemRevisionCreationRequestedEventPayload'
+
+export interface ItemRevisionCreationRequestedEvent extends DomainEventInterface {
+  type: 'ITEM_REVISION_CREATION_REQUESTED'
+  payload: ItemRevisionCreationRequestedEventPayload
+}

packages/domain-events/src/Domain/Event/ItemRevisionCreationRequestedEventPayload.ts

@@ -0,0 +1,3 @@
+export interface ItemRevisionCreationRequestedEventPayload {
+  itemUuid: string
+}

packages/domain-events/src/Domain/index.ts

@@ -46,6 +46,10 @@ export * from './Event/GoogleDriveBackupFailedEvent'
 export * from './Event/GoogleDriveBackupFailedEventPayload'
 export * from './Event/InvoiceGeneratedEvent'
 export * from './Event/InvoiceGeneratedEventPayload'
+export * from './Event/ItemDumpedEvent'
+export * from './Event/ItemDumpedEventPayload'
+export * from './Event/ItemRevisionCreationRequestedEvent'
+export * from './Event/ItemRevisionCreationRequestedEventPayload'
 export * from './Event/ItemsSyncedEvent'
 export * from './Event/ItemsSyncedEventPayload'
 export * from './Event/ListedAccountCreatedEvent'

packages/event-store/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.6.25](https://github.com/standardnotes/server/compare/@standardnotes/event-store@1.6.24...@standardnotes/event-store@1.6.25) (2022-11-21)
+
+**Note:** Version bump only for package @standardnotes/event-store
+
+## [1.6.24](https://github.com/standardnotes/server/compare/@standardnotes/event-store@1.6.23...@standardnotes/event-store@1.6.24) (2022-11-18)
+
+**Note:** Version bump only for package @standardnotes/event-store
+
+## [1.6.23](https://github.com/standardnotes/server/compare/@standardnotes/event-store@1.6.22...@standardnotes/event-store@1.6.23) (2022-11-16)
+
+**Note:** Version bump only for package @standardnotes/event-store
+
 ## [1.6.22](https://github.com/standardnotes/server/compare/@standardnotes/event-store@1.6.21...@standardnotes/event-store@1.6.22) (2022-11-14)
 
 **Note:** Version bump only for package @standardnotes/event-store

packages/event-store/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/event-store",
-  "version": "1.6.22",
+  "version": "1.6.25",
   "description": "Event Store Service",
   "private": true,
   "main": "dist/src/index.js",

packages/files/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.8.25](https://github.com/standardnotes/files/compare/@standardnotes/files-server@1.8.24...@standardnotes/files-server@1.8.25) (2022-11-21)
+
+**Note:** Version bump only for package @standardnotes/files-server
+
+## [1.8.24](https://github.com/standardnotes/files/compare/@standardnotes/files-server@1.8.23...@standardnotes/files-server@1.8.24) (2022-11-18)
+
+**Note:** Version bump only for package @standardnotes/files-server
+
+## [1.8.23](https://github.com/standardnotes/files/compare/@standardnotes/files-server@1.8.22...@standardnotes/files-server@1.8.23) (2022-11-16)
+
+**Note:** Version bump only for package @standardnotes/files-server
+
 ## [1.8.22](https://github.com/standardnotes/files/compare/@standardnotes/files-server@1.8.21...@standardnotes/files-server@1.8.22) (2022-11-14)
 
 **Note:** Version bump only for package @standardnotes/files-server

packages/files/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/files-server",
-  "version": "1.8.22",
+  "version": "1.8.25",
   "engines": {
     "node": ">=18.0.0 <19.0.0"
   },

packages/revisions/.env.sample

@@ -0,0 +1,34 @@
+LOG_LEVEL=info
+NODE_ENV=development
+VERSION=development
+
+AUTH_JWT_SECRET=auth_jwt_secret
+
+PORT=3000
+
+DB_HOST=db
+DB_REPLICA_HOST=db
+DB_PORT=3306
+DB_USERNAME=std_notes_user
+DB_PASSWORD=changeme123
+DB_DATABASE=standard_notes_db
+DB_DEBUG_LEVEL=all # "all" | "query" | "schema" | "error" | "warn" | "info" | "log" | "migration"
+DB_MIGRATIONS_PATH=dist/migrations/*.js
+
+REDIS_URL=redis://cache
+
+SQS_QUEUE_URL=
+SQS_AWS_REGION=
+S3_AWS_REGION=
+S3_BACKUP_BUCKET_NAME=
+
+REDIS_EVENTS_CHANNEL=revisions
+
+# (Optional) New Relic Setup
+NEW_RELIC_ENABLED=false
+NEW_RELIC_APP_NAME="Revisions Server"
+NEW_RELIC_LICENSE_KEY=
+NEW_RELIC_NO_CONFIG_FILE=true
+NEW_RELIC_DISTRIBUTED_TRACING_ENABLED=false
+NEW_RELIC_LOG_ENABLED=false
+NEW_RELIC_LOG_LEVEL=info

packages/revisions/.eslintignore

@@ -0,0 +1,3 @@
+dist
+test-setup.ts
+data

packages/revisions/.eslintrc

@@ -0,0 +1,6 @@
+{
+  "extends": "../../.eslintrc",
+  "parserOptions": {
+    "project": "./linter.tsconfig.json"
+  }
+}

packages/revisions/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [1.1.3](https://github.com/standardnotes/server/compare/@standardnotes/revisions-server@1.1.2...@standardnotes/revisions-server@1.1.3) (2022-11-21)
+
+**Note:** Version bump only for package @standardnotes/revisions-server
+
+## [1.1.2](https://github.com/standardnotes/server/compare/@standardnotes/revisions-server@1.1.1...@standardnotes/revisions-server@1.1.2) (2022-11-21)
+
+### Bug Fixes
+
+* **domain-core:** remove revisions related models to revisions microservice ([a6542dd](https://github.com/standardnotes/server/commit/a6542dd63870a8ada5fd8143d8e2133a570d9329))
+
+## [1.1.1](https://github.com/standardnotes/server/compare/@standardnotes/revisions-server@1.1.0...@standardnotes/revisions-server@1.1.1) (2022-11-18)
+
+**Note:** Version bump only for package @standardnotes/revisions-server
+
+# 1.1.0 (2022-11-18)
+
+### Bug Fixes
+
+* **revisions:** docker entrypoint ([a7d0390](https://github.com/standardnotes/server/commit/a7d039082e570f522824631d7e274398dac34f22))
+
+### Features
+
+* **revisions:** add revisions microservice ([d5c06bf](https://github.com/standardnotes/server/commit/d5c06bfa58a987685fbd8fbab0d22df3fcff3377))

packages/revisions/Dockerfile

@@ -0,0 +1,17 @@
+FROM node:18.12.1-alpine
+
+RUN apk add --update \
+  curl \
+  && rm -rf /var/cache/apk/*
+
+ENV NODE_ENV production
+
+RUN corepack enable
+
+WORKDIR /workspace
+
+COPY ./ /workspace
+
+ENTRYPOINT [ "/workspace/packages/revisions/docker/entrypoint.sh" ]
+
+CMD [ "start-web" ]

packages/revisions/bin/server.ts

@@ -0,0 +1,70 @@
+import 'reflect-metadata'
+
+import 'newrelic'
+
+import * as Sentry from '@sentry/node'
+
+import '../src/Infra/InversifyExpress/InversifyExpressRevisionsController'
+import '../src/Infra/InversifyExpress/InversifyExpressHealthCheckController'
+
+import * as cors from 'cors'
+import { urlencoded, json, Request, Response, NextFunction, RequestHandler, ErrorRequestHandler } from 'express'
+import * as winston from 'winston'
+
+import { InversifyExpressServer } from 'inversify-express-utils'
+import { ContainerConfigLoader } from '../src/Bootstrap/Container'
+import TYPES from '../src/Bootstrap/Types'
+import { Env } from '../src/Bootstrap/Env'
+
+const container = new ContainerConfigLoader()
+void container.load().then((container) => {
+  const env: Env = new Env()
+  env.load()
+
+  const server = new InversifyExpressServer(container)
+
+  server.setConfig((app) => {
+    app.use((_request: Request, response: Response, next: NextFunction) => {
+      response.setHeader('X-Revisions-Version', container.get(TYPES.VERSION))
+      next()
+    })
+    app.use(json())
+    app.use(urlencoded({ extended: true }))
+    app.use(cors())
+
+    if (env.get('SENTRY_DSN', true)) {
+      Sentry.init({
+        dsn: env.get('SENTRY_DSN'),
+        integrations: [new Sentry.Integrations.Http({ tracing: false, breadcrumbs: true })],
+        tracesSampleRate: 0,
+      })
+
+      app.use(Sentry.Handlers.requestHandler() as RequestHandler)
+    }
+  })
+
+  const logger: winston.Logger = container.get(TYPES.Logger)
+
+  server.setErrorConfig((app) => {
+    if (env.get('SENTRY_DSN', true)) {
+      app.use(Sentry.Handlers.errorHandler() as ErrorRequestHandler)
+    }
+
+    app.use((error: Record<string, unknown>, _request: Request, response: Response, _next: NextFunction) => {
+      logger.error(error.stack)
+
+      response.status(500).send({
+        error: {
+          message:
+            "Unfortunately, we couldn't handle your request. Please try again or contact our support if the error persists.",
+        },
+      })
+    })
+  })
+
+  const serverInstance = server.build()
+
+  serverInstance.listen(env.get('PORT'))
+
+  logger.info(`Server started on port ${process.env.PORT}`)
+})

packages/revisions/docker/entrypoint.sh

@@ -0,0 +1,22 @@
+#!/bin/sh
+set -e
+
+COMMAND=$1 && shift 1
+
+case "$COMMAND" in
+  'start-web' )
+    echo "Starting Web..."
+    yarn workspace @standardnotes/revisions-server start
+    ;;
+
+  'start-worker' )
+    echo "Starting Worker..."
+    yarn workspace @standardnotes/revisions-server worker
+    ;;
+
+   * )
+    echo "Unknown command"
+    ;;
+esac
+
+exec "$@"

packages/revisions/jest.config.js

@@ -0,0 +1,11 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const base = require('../../jest.config')
+const { defaults: tsjPreset } = require('ts-jest/presets')
+
+module.exports = {
+  ...base,
+  transform: {
+    ...tsjPreset.transform,
+  },
+  coveragePathIgnorePatterns: ['/Bootstrap/', 'HealthCheckController', '/Infra/', '/Mapping/'],
+}

packages/revisions/linter.tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["dist", "test-setup.ts"]
+}

packages/revisions/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@standardnotes/revisions-server",
+  "version": "1.1.3",
+  "engines": {
+    "node": ">=18.0.0 <19.0.0"
+  },
+  "private": true,
+  "description": "Revisions Server",
+  "main": "dist/src/index.js",
+  "typings": "dist/src/index.d.ts",
+  "repository": "git@github.com:standardnotes/server.git",
+  "author": "Karol Sójko <karolsojko@standardnotes.com>",
+  "license": "AGPL-3.0-or-later",
+  "scripts": {
+    "clean": "rm -fr dist",
+    "setup:env": "cp .env.sample .env",
+    "build": "tsc --build",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "pretest": "yarn lint && yarn build",
+    "test": "jest --coverage --config=./jest.config.js --maxWorkers=50%",
+    "start": "yarn node dist/bin/server.js",
+    "worker": "yarn node dist/bin/worker.js"
+  },
+  "dependencies": {
+    "@newrelic/native-metrics": "^9.0.0",
+    "@newrelic/winston-enricher": "^4.0.0",
+    "@sentry/node": "^7.19.0",
+    "@standardnotes/api": "^1.19.0",
+    "@standardnotes/common": "workspace:^",
+    "@standardnotes/domain-core": "workspace:^",
+    "@standardnotes/domain-events": "workspace:*",
+    "@standardnotes/domain-events-infra": "workspace:*",
+    "@standardnotes/security": "workspace:^",
+    "@standardnotes/time": "workspace:^",
+    "aws-sdk": "^2.1253.0",
+    "cors": "2.8.5",
+    "dotenv": "^16.0.1",
+    "express": "^4.18.2",
+    "helmet": "^6.0.0",
+    "inversify": "^6.0.1",
+    "inversify-express-utils": "^6.4.3",
+    "ioredis": "^5.2.4",
+    "mysql2": "^2.3.3",
+    "newrelic": "^9.6.0",
+    "reflect-metadata": "0.1.13",
+    "typeorm": "^0.3.10",
+    "winston": "^3.8.1"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.9",
+    "@types/dotenv": "^8.2.0",
+    "@types/express": "^4.17.14",
+    "@types/inversify-express-utils": "^2.0.0",
+    "@types/ioredis": "^5.0.0",
+    "@types/jest": "^29.1.1",
+    "@types/newrelic": "^7.0.4",
+    "@typescript-eslint/eslint-plugin": "^5.29.0",
+    "eslint": "^8.14.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "^29.1.2",
+    "npm-check-updates": "^16.0.1",
+    "ts-jest": "^29.0.3",
+    "typescript": "^4.8.4"
+  }
+}

packages/revisions/src/Bootstrap/Container.ts

@@ -0,0 +1,175 @@
+import * as winston from 'winston'
+import Redis from 'ioredis'
+import * as AWS from 'aws-sdk'
+import { Container } from 'inversify'
+import { Repository } from 'typeorm'
+import {
+  DomainEventHandlerInterface,
+  DomainEventMessageHandlerInterface,
+  DomainEventSubscriberFactoryInterface,
+} from '@standardnotes/domain-events'
+import { TokenDecoderInterface, CrossServiceTokenData, TokenDecoder } from '@standardnotes/security'
+import {
+  RedisDomainEventSubscriberFactory,
+  RedisEventMessageHandler,
+  SQSDomainEventSubscriberFactory,
+  SQSEventMessageHandler,
+  SQSNewRelicEventMessageHandler,
+} from '@standardnotes/domain-events-infra'
+import { MapperInterface } from '@standardnotes/domain-core'
+
+import { Env } from './Env'
+import TYPES from './Types'
+import { AppDataSource } from './DataSource'
+import { InversifyExpressApiGatewayAuthMiddleware } from '../Infra/InversifyExpress/InversifyExpressApiGatewayAuthMiddleware'
+import { RevisionsController } from '../Controller/RevisionsController'
+import { GetRevisionsMetada } from '../Domain/UseCase/GetRevisionsMetada/GetRevisionsMetada'
+import { RevisionRepositoryInterface } from '../Domain/Revision/RevisionRepositoryInterface'
+import { MySQLRevisionRepository } from '../Infra/MySQL/MySQLRevisionRepository'
+import { RevisionMetadataPersistenceMapper } from '../Mapping/RevisionMetadataPersistenceMapper'
+import { TypeORMRevision } from '../Infra/TypeORM/TypeORMRevision'
+import { RevisionMetadata } from '../Domain/Revision/RevisionMetadata'
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const newrelicFormatter = require('@newrelic/winston-enricher')
+
+export class ContainerConfigLoader {
+  async load(): Promise<Container> {
+    const env: Env = new Env()
+    env.load()
+
+    const container = new Container()
+
+    await AppDataSource.initialize()
+
+    const redisUrl = env.get('REDIS_URL')
+    const isRedisInClusterMode = redisUrl.indexOf(',') > 0
+    let redis
+    if (isRedisInClusterMode) {
+      redis = new Redis.Cluster(redisUrl.split(','))
+    } else {
+      redis = new Redis(redisUrl)
+    }
+
+    container.bind(TYPES.Redis).toConstantValue(redis)
+
+    const newrelicWinstonFormatter = newrelicFormatter(winston)
+    const winstonFormatters = [winston.format.splat(), winston.format.json()]
+    if (env.get('NEW_RELIC_ENABLED', true) === 'true') {
+      winstonFormatters.push(newrelicWinstonFormatter())
+    }
+
+    const logger = winston.createLogger({
+      level: env.get('LOG_LEVEL') || 'info',
+      format: winston.format.combine(...winstonFormatters),
+      transports: [new winston.transports.Console({ level: env.get('LOG_LEVEL') || 'info' })],
+    })
+    container.bind<winston.Logger>(TYPES.Logger).toConstantValue(logger)
+
+    if (env.get('SQS_AWS_REGION', true)) {
+      container.bind<AWS.SQS>(TYPES.SQS).toConstantValue(
+        new AWS.SQS({
+          apiVersion: 'latest',
+          region: env.get('SQS_AWS_REGION', true),
+        }),
+      )
+    }
+
+    let s3Client = undefined
+    if (env.get('S3_AWS_REGION', true)) {
+      s3Client = new AWS.S3({
+        apiVersion: 'latest',
+        region: env.get('S3_AWS_REGION', true),
+      })
+    }
+    container.bind<AWS.S3 | undefined>(TYPES.S3).toConstantValue(s3Client)
+
+    // Map
+    container
+      .bind<MapperInterface<RevisionMetadata, TypeORMRevision>>(TYPES.RevisionMetadataPersistenceMapper)
+      .toConstantValue(new RevisionMetadataPersistenceMapper())
+
+    // ORM
+    container
+      .bind<Repository<TypeORMRevision>>(TYPES.ORMRevisionRepository)
+      .toConstantValue(AppDataSource.getRepository(TypeORMRevision))
+
+    // Repositories
+    container
+      .bind<RevisionRepositoryInterface>(TYPES.RevisionRepository)
+      .toConstantValue(
+        new MySQLRevisionRepository(
+          container.get(TYPES.ORMRevisionRepository),
+          container.get(TYPES.RevisionMetadataPersistenceMapper),
+        ),
+      )
+
+    // env vars
+    container.bind(TYPES.REDIS_URL).toConstantValue(env.get('REDIS_URL'))
+    container.bind(TYPES.SQS_QUEUE_URL).toConstantValue(env.get('SQS_QUEUE_URL', true))
+    container.bind(TYPES.REDIS_EVENTS_CHANNEL).toConstantValue(env.get('REDIS_EVENTS_CHANNEL'))
+    container.bind(TYPES.AUTH_JWT_SECRET).toConstantValue(env.get('AUTH_JWT_SECRET'))
+    container.bind(TYPES.S3_AWS_REGION).toConstantValue(env.get('S3_AWS_REGION', true))
+    container.bind(TYPES.S3_BACKUP_BUCKET_NAME).toConstantValue(env.get('S3_BACKUP_BUCKET_NAME', true))
+    container.bind(TYPES.NEW_RELIC_ENABLED).toConstantValue(env.get('NEW_RELIC_ENABLED', true))
+    container.bind(TYPES.VERSION).toConstantValue(env.get('VERSION'))
+
+    // use cases
+    container
+      .bind<GetRevisionsMetada>(TYPES.GetRevisionsMetada)
+      .toConstantValue(new GetRevisionsMetada(container.get(TYPES.RevisionRepository)))
+
+    // Controller
+    container
+      .bind<RevisionsController>(TYPES.RevisionsController)
+      .toConstantValue(new RevisionsController(container.get(TYPES.GetRevisionsMetada), container.get(TYPES.Logger)))
+
+    // Handlers
+
+    // Services
+    container
+      .bind<TokenDecoderInterface<CrossServiceTokenData>>(TYPES.CrossServiceTokenDecoder)
+      .toConstantValue(new TokenDecoder<CrossServiceTokenData>(container.get(TYPES.AUTH_JWT_SECRET)))
+
+    // Middleware
+    container
+      .bind<InversifyExpressApiGatewayAuthMiddleware>(TYPES.ApiGatewayAuthMiddleware)
+      .to(InversifyExpressApiGatewayAuthMiddleware)
+
+    const eventHandlers: Map<string, DomainEventHandlerInterface> = new Map([])
+
+    if (env.get('SQS_QUEUE_URL', true)) {
+      container
+        .bind<DomainEventMessageHandlerInterface>(TYPES.DomainEventMessageHandler)
+        .toConstantValue(
+          env.get('NEW_RELIC_ENABLED', true) === 'true'
+            ? new SQSNewRelicEventMessageHandler(eventHandlers, container.get(TYPES.Logger))
+            : new SQSEventMessageHandler(eventHandlers, container.get(TYPES.Logger)),
+        )
+      container
+        .bind<DomainEventSubscriberFactoryInterface>(TYPES.DomainEventSubscriberFactory)
+        .toConstantValue(
+          new SQSDomainEventSubscriberFactory(
+            container.get(TYPES.SQS),
+            container.get(TYPES.SQS_QUEUE_URL),
+            container.get(TYPES.DomainEventMessageHandler),
+          ),
+        )
+    } else {
+      container
+        .bind<DomainEventMessageHandlerInterface>(TYPES.DomainEventMessageHandler)
+        .toConstantValue(new RedisEventMessageHandler(eventHandlers, container.get(TYPES.Logger)))
+      container
+        .bind<DomainEventSubscriberFactoryInterface>(TYPES.DomainEventSubscriberFactory)
+        .toConstantValue(
+          new RedisDomainEventSubscriberFactory(
+            container.get(TYPES.Redis),
+            container.get(TYPES.DomainEventMessageHandler),
+            container.get(TYPES.REDIS_EVENTS_CHANNEL),
+          ),
+        )
+    }
+
+    return container
+  }
+}

packages/revisions/src/Bootstrap/DataSource.ts

@@ -0,0 +1,44 @@
+import { DataSource, LoggerOptions } from 'typeorm'
+
+import { TypeORMRevision } from '../Infra/TypeORM/TypeORMRevision'
+
+import { Env } from './Env'
+
+const env: Env = new Env()
+env.load()
+
+const maxQueryExecutionTime = env.get('DB_MAX_QUERY_EXECUTION_TIME', true)
+  ? +env.get('DB_MAX_QUERY_EXECUTION_TIME', true)
+  : 45_000
+
+export const AppDataSource = new DataSource({
+  type: 'mysql',
+  charset: 'utf8mb4',
+  supportBigNumbers: true,
+  bigNumberStrings: false,
+  maxQueryExecutionTime,
+  replication: {
+    master: {
+      host: env.get('DB_HOST'),
+      port: parseInt(env.get('DB_PORT')),
+      username: env.get('DB_USERNAME'),
+      password: env.get('DB_PASSWORD'),
+      database: env.get('DB_DATABASE'),
+    },
+    slaves: [
+      {
+        host: env.get('DB_REPLICA_HOST'),
+        port: parseInt(env.get('DB_PORT')),
+        username: env.get('DB_USERNAME'),
+        password: env.get('DB_PASSWORD'),
+        database: env.get('DB_DATABASE'),
+      },
+    ],
+    removeNodeErrorCount: 10,
+    restoreNodeTimeout: 5,
+  },
+  entities: [TypeORMRevision],
+  migrations: [env.get('DB_MIGRATIONS_PATH', true) ?? 'dist/migrations/*.js'],
+  migrationsRun: true,
+  logging: <LoggerOptions>env.get('DB_DEBUG_LEVEL'),
+})

packages/revisions/src/Bootstrap/Env.ts

@@ -0,0 +1,24 @@
+import { config, DotenvParseOutput } from 'dotenv'
+import { injectable } from 'inversify'
+
+@injectable()
+export class Env {
+  private env?: DotenvParseOutput
+
+  public load(): void {
+    const output = config()
+    this.env = <DotenvParseOutput>output.parsed
+  }
+
+  public get(key: string, optional = false): string {
+    if (!this.env) {
+      this.load()
+    }
+
+    if (!process.env[key] && !optional) {
+      throw new Error(`Environment variable ${key} not set`)
+    }
+
+    return <string>process.env[key]
+  }
+}

packages/revisions/src/Bootstrap/Types.ts

@@ -0,0 +1,37 @@
+const TYPES = {
+  DBConnection: Symbol.for('DBConnection'),
+  Logger: Symbol.for('Logger'),
+  Redis: Symbol.for('Redis'),
+  SQS: Symbol.for('SQS'),
+  S3: Symbol.for('S3'),
+  // Map
+  RevisionMetadataPersistenceMapper: Symbol.for('RevisionMetadataPersistenceMapper'),
+  // ORM
+  ORMRevisionRepository: Symbol.for('ORMRevisionRepository'),
+  // Repositories
+  RevisionRepository: Symbol.for('RevisionRepository'),
+  // env vars
+  REDIS_URL: Symbol.for('REDIS_URL'),
+  SQS_QUEUE_URL: Symbol.for('SQS_QUEUE_URL'),
+  SQS_AWS_REGION: Symbol.for('SQS_AWS_REGION'),
+  REDIS_EVENTS_CHANNEL: Symbol.for('REDIS_EVENTS_CHANNEL'),
+  AUTH_JWT_SECRET: Symbol.for('AUTH_JWT_SECRET'),
+  S3_AWS_REGION: Symbol.for('S3_AWS_REGION'),
+  S3_BACKUP_BUCKET_NAME: Symbol.for('S3_BACKUP_BUCKET_NAME'),
+  NEW_RELIC_ENABLED: Symbol.for('NEW_RELIC_ENABLED'),
+  VERSION: Symbol.for('VERSION'),
+  // use cases
+  GetRevisionsMetada: Symbol.for('GetRevisionsMetada'),
+  // Controller
+  RevisionsController: Symbol.for('RevisionsController'),
+  // Handlers
+  // Services
+  CrossServiceTokenDecoder: Symbol.for('CrossServiceTokenDecoder'),
+  DomainEventSubscriberFactory: Symbol.for('DomainEventSubscriberFactory'),
+  DomainEventMessageHandler: Symbol.for('DomainEventMessageHandler'),
+  Timer: Symbol.for('Timer'),
+  // Middleware
+  ApiGatewayAuthMiddleware: Symbol.for('ApiGatewayAuthMiddleware'),
+}
+
+export default TYPES

packages/revisions/src/Controller/RevisionsController.spec.ts

@@ -0,0 +1,34 @@
+import { Result } from '@standardnotes/domain-core'
+import { Logger } from 'winston'
+
+import { GetRevisionsMetada } from '../Domain/UseCase/GetRevisionsMetada/GetRevisionsMetada'
+
+import { RevisionsController } from './RevisionsController'
+
+describe('RevisionsController', () => {
+  let getRevisionsMetadata: GetRevisionsMetada
+  let logger: Logger
+
+  const createController = () => new RevisionsController(getRevisionsMetadata, logger)
+
+  beforeEach(() => {
+    getRevisionsMetadata = {} as jest.Mocked<GetRevisionsMetada>
+    getRevisionsMetadata.execute = jest.fn().mockReturnValue(Result.ok())
+
+    logger = {} as jest.Mocked<Logger>
+    logger.warn = jest.fn()
+  })
+
+  it('should get revisions list', async () => {
+    const response = await createController().getRevisions({ itemUuid: '1-2-3' })
+
+    expect(response.status).toEqual(200)
+  })
+
+  it('should indicate failure to get revisions list', async () => {
+    getRevisionsMetadata.execute = jest.fn().mockReturnValue(Result.fail('Oops'))
+    const response = await createController().getRevisions({ itemUuid: '1-2-3' })
+
+    expect(response.status).toEqual(400)
+  })
+})

packages/revisions/src/Controller/RevisionsController.ts

@@ -0,0 +1,31 @@
+import { Logger } from 'winston'
+import { HttpResponse, HttpStatusCode } from '@standardnotes/api'
+
+import { GetRevisionsMetada } from '../Domain/UseCase/GetRevisionsMetada/GetRevisionsMetada'
+import { GetRevisionsMetadataRequestParams } from '../Infra/Http/GetRevisionsMetadataRequestParams'
+
+export class RevisionsController {
+  constructor(private getRevisionsMetadata: GetRevisionsMetada, private logger: Logger) {}
+
+  async getRevisions(params: GetRevisionsMetadataRequestParams): Promise<HttpResponse> {
+    const revisionMetadataOrError = await this.getRevisionsMetadata.execute({ itemUuid: params.itemUuid })
+
+    if (revisionMetadataOrError.isFailed()) {
+      this.logger.warn(revisionMetadataOrError.getError())
+
+      return {
+        status: HttpStatusCode.BadRequest,
+        data: {
+          error: {
+            message: 'Could not retrieve revisions.',
+          },
+        },
+      }
+    }
+
+    return {
+      status: HttpStatusCode.Success,
+      data: { revisions: revisionMetadataOrError.getValue() },
+    }
+  }
+}

packages/revisions/src/Domain/Revision/ContentType.ts

@@ -0,0 +1,22 @@
+import { ContentType as ContentTypeValues } from '@standardnotes/common'
+import { Result, ValueObject } from '@standardnotes/domain-core'
+
+import { ContentTypeProps } from './ContentTypeProps'
+
+export class ContentType extends ValueObject<ContentTypeProps> {
+  get value(): string | null {
+    return this.props.value
+  }
+
+  private constructor(props: ContentTypeProps) {
+    super(props)
+  }
+
+  static create(contentType: string | null): Result<ContentType> {
+    if (contentType !== null && !Object.values(ContentTypeValues).includes(contentType as ContentTypeValues)) {
+      return Result.fail<ContentType>(`Value is not a valid content type: ${contentType}`)
+    } else {
+      return Result.ok<ContentType>(new ContentType({ value: contentType }))
+    }
+  }
+}

packages/revisions/src/Domain/Revision/ContentTypeProps.ts

@@ -0,0 +1,3 @@
+export interface ContentTypeProps {
+  value: string | null
+}

packages/revisions/src/Domain/Revision/Revision.ts

@@ -0,0 +1,17 @@
+import { Entity, Result, UniqueEntityId } from '@standardnotes/domain-core'
+
+import { RevisionProps } from './RevisionProps'
+
+export class Revision extends Entity<RevisionProps> {
+  get id(): UniqueEntityId {
+    return this._id
+  }
+
+  private constructor(props: RevisionProps, id?: UniqueEntityId) {
+    super(props, id)
+  }
+
+  static create(props: RevisionProps, id?: UniqueEntityId): Result<Revision> {
+    return Result.ok<Revision>(new Revision(props, id))
+  }
+}

packages/revisions/src/Domain/Revision/RevisionMetadata.ts

@@ -0,0 +1,17 @@
+import { Entity, Result, UniqueEntityId } from '@standardnotes/domain-core'
+
+import { RevisionMetadataProps } from './RevisionMetadataProps'
+
+export class RevisionMetadata extends Entity<RevisionMetadataProps> {
+  get id(): UniqueEntityId {
+    return this._id
+  }
+
+  private constructor(props: RevisionMetadataProps, id?: UniqueEntityId) {
+    super(props, id)
+  }
+
+  static create(props: RevisionMetadataProps, id?: UniqueEntityId): Result<RevisionMetadata> {
+    return Result.ok<RevisionMetadata>(new RevisionMetadata(props, id))
+  }
+}

packages/revisions/src/Domain/Revision/RevisionMetadataProps.ts

@@ -0,0 +1,8 @@
+import { Timestamps } from '@standardnotes/domain-core'
+
+import { ContentType } from './ContentType'
+
+export interface RevisionMetadataProps {
+  contentType: ContentType
+  timestamps: Timestamps
+}

packages/revisions/src/Domain/Revision/RevisionProps.ts

@@ -0,0 +1,15 @@
+import { Uuid } from '@standardnotes/domain-core'
+
+import { ContentType } from './ContentType'
+
+export interface RevisionProps {
+  itemUuid: Uuid
+  content: string | null
+  contentType: ContentType
+  itemsKeyId: string | null
+  encItemKey: string | null
+  authHash: string | null
+  creationDate: Date
+  createdAt: Date
+  updatedAt: Date
+}

packages/revisions/src/Domain/Revision/RevisionRepositoryInterface.ts

@@ -0,0 +1,7 @@
+import { Uuid } from '@standardnotes/domain-core'
+
+import { RevisionMetadata } from './RevisionMetadata'
+
+export interface RevisionRepositoryInterface {
+  findMetadataByItemId(itemUuid: Uuid): Promise<Array<RevisionMetadata>>
+}

packages/revisions/src/Domain/UseCase/GetRevisionsMetada/GetRevisionsMetada.spec.ts

@@ -0,0 +1,27 @@
+import { RevisionMetadata } from '../../Revision/RevisionMetadata'
+import { RevisionRepositoryInterface } from '../../Revision/RevisionRepositoryInterface'
+import { GetRevisionsMetada } from './GetRevisionsMetada'
+
+describe('GetRevisionsMetada', () => {
+  let revisionRepository: RevisionRepositoryInterface
+
+  const createUseCase = () => new GetRevisionsMetada(revisionRepository)
+
+  beforeEach(() => {
+    revisionRepository = {} as jest.Mocked<RevisionRepositoryInterface>
+    revisionRepository.findMetadataByItemId = jest.fn().mockReturnValue([{} as jest.Mocked<RevisionMetadata>])
+  })
+
+  it('should return revisions metadata for a given item', async () => {
+    const result = await createUseCase().execute({ itemUuid: '84c0f8e8-544a-4c7e-9adf-26209303bc1d' })
+
+    expect(result.isFailed()).toBeFalsy()
+    expect(result.getValue().length).toEqual(1)
+  })
+
+  it('should not return revisions metadata for a an invalid item uuid', async () => {
+    const result = await createUseCase().execute({ itemUuid: '1-2-3' })
+
+    expect(result.isFailed()).toBeTruthy()
+  })
+})

packages/revisions/src/Domain/UseCase/GetRevisionsMetada/GetRevisionsMetada.ts

@@ -0,0 +1,21 @@
+import { Result, UseCaseInterface, Uuid } from '@standardnotes/domain-core'
+
+import { RevisionMetadata } from '../../Revision/RevisionMetadata'
+import { RevisionRepositoryInterface } from '../../Revision/RevisionRepositoryInterface'
+
+import { GetRevisionsMetadaDTO } from './GetRevisionsMetadaDTO'
+
+export class GetRevisionsMetada implements UseCaseInterface<RevisionMetadata[]> {
+  constructor(private revisionRepository: RevisionRepositoryInterface) {}
+
+  async execute(dto: GetRevisionsMetadaDTO): Promise<Result<RevisionMetadata[]>> {
+    const itemUuidOrError = Uuid.create(dto.itemUuid)
+    if (itemUuidOrError.isFailed()) {
+      return Result.fail<RevisionMetadata[]>(`Could not get revisions: ${itemUuidOrError.getError()}`)
+    }
+
+    const revisionsMetdata = await this.revisionRepository.findMetadataByItemId(itemUuidOrError.getValue())
+
+    return Result.ok<RevisionMetadata[]>(revisionsMetdata)
+  }
+}

packages/revisions/src/Domain/UseCase/GetRevisionsMetada/GetRevisionsMetadaDTO.ts

@@ -0,0 +1,3 @@
+export interface GetRevisionsMetadaDTO {
+  itemUuid: string
+}

packages/revisions/src/Infra/Http/GetRevisionsMetadataRequestParams.ts

@@ -0,0 +1,3 @@
+export interface GetRevisionsMetadataRequestParams {
+  itemUuid: string
+}

packages/revisions/src/Infra/InversifyExpress/InversifyExpressApiGatewayAuthMiddleware.ts

@@ -0,0 +1,60 @@
+import { CrossServiceTokenData, TokenDecoderInterface } from '@standardnotes/security'
+import { NextFunction, Request, Response } from 'express'
+import { inject, injectable } from 'inversify'
+import { BaseMiddleware } from 'inversify-express-utils'
+import { Logger } from 'winston'
+
+import TYPES from '../../Bootstrap/Types'
+
+@injectable()
+export class InversifyExpressApiGatewayAuthMiddleware extends BaseMiddleware {
+  constructor(
+    @inject(TYPES.CrossServiceTokenDecoder) private tokenDecoder: TokenDecoderInterface<CrossServiceTokenData>,
+    @inject(TYPES.Logger) private logger: Logger,
+  ) {
+    super()
+  }
+
+  async handler(request: Request, response: Response, next: NextFunction): Promise<void> {
+    try {
+      if (!request.headers['x-auth-token']) {
+        this.logger.debug('ApiGatewayAuthMiddleware missing x-auth-token header.')
+
+        response.status(401).send({
+          error: {
+            tag: 'invalid-auth',
+            message: 'Invalid login credentials.',
+          },
+        })
+
+        return
+      }
+
+      const token: CrossServiceTokenData | undefined = this.tokenDecoder.decodeToken(
+        request.headers['x-auth-token'] as string,
+      )
+
+      if (token === undefined) {
+        this.logger.debug('ApiGatewayAuthMiddleware authentication failure.')
+
+        response.status(401).send({
+          error: {
+            tag: 'invalid-auth',
+            message: 'Invalid login credentials.',
+          },
+        })
+
+        return
+      }
+
+      response.locals.user = token.user
+      response.locals.roles = token.roles
+      response.locals.session = token.session
+      response.locals.readOnlyAccess = token.session?.readonly_access ?? false
+
+      return next()
+    } catch (error) {
+      return next(error)
+    }
+  }
+}

packages/revisions/src/Infra/InversifyExpress/InversifyExpressHealthCheckController.ts

@@ -0,0 +1,9 @@
+import { controller, httpGet } from 'inversify-express-utils'
+
+@controller('/healthcheck')
+export class InversifyExpressHealthCheckController {
+  @httpGet('/')
+  public async get(): Promise<string> {
+    return 'OK'
+  }
+}

packages/revisions/src/Infra/InversifyExpress/InversifyExpressRevisionsController.ts

@@ -0,0 +1,22 @@
+import { Request } from 'express'
+import { BaseHttpController, controller, httpGet, results } from 'inversify-express-utils'
+import { inject } from 'inversify'
+
+import TYPES from '../../Bootstrap/Types'
+import { RevisionsController } from '../../Controller/RevisionsController'
+
+@controller('/items/:itemUuid/revisions', TYPES.ApiGatewayAuthMiddleware)
+export class InversifyExpressRevisionsController extends BaseHttpController {
+  constructor(@inject(TYPES.RevisionsController) private revisionsController: RevisionsController) {
+    super()
+  }
+
+  @httpGet('/')
+  public async getRevisions(req: Request): Promise<results.JsonResult> {
+    const result = await this.revisionsController.getRevisions({
+      itemUuid: req.params.itemUuid,
+    })
+
+    return this.json(result.data, result.status)
+  }
+}

packages/revisions/src/Infra/MySQL/MySQLRevisionRepository.ts

@@ -0,0 +1,35 @@
+import { MapperInterface, Uuid } from '@standardnotes/domain-core'
+import { Repository } from 'typeorm'
+
+import { RevisionMetadata } from '../../Domain/Revision/RevisionMetadata'
+import { RevisionRepositoryInterface } from '../../Domain/Revision/RevisionRepositoryInterface'
+import { TypeORMRevision } from '../TypeORM/TypeORMRevision'
+
+export class MySQLRevisionRepository implements RevisionRepositoryInterface {
+  constructor(
+    private ormRepository: Repository<TypeORMRevision>,
+    private revisionMapper: MapperInterface<RevisionMetadata, TypeORMRevision>,
+  ) {}
+
+  async findMetadataByItemId(itemUuid: Uuid): Promise<Array<RevisionMetadata>> {
+    const queryBuilder = this.ormRepository
+      .createQueryBuilder()
+      .select('uuid', 'uuid')
+      .addSelect('content_type', 'contentType')
+      .addSelect('created_at', 'createdAt')
+      .addSelect('updated_at', 'updatedAt')
+      .where('item_uuid = :item_uuid', {
+        item_uuid: itemUuid,
+      })
+      .orderBy('created_at', 'DESC')
+
+    const simplifiedRevisions = await queryBuilder.getMany()
+
+    const metadata = []
+    for (const simplifiedRevision of simplifiedRevisions) {
+      metadata.push(this.revisionMapper.toDomain(simplifiedRevision))
+    }
+
+    return metadata
+  }
+}

packages/revisions/src/Infra/TypeORM/TypeORMRevision.ts

@@ -0,0 +1,77 @@
+import { ContentType } from '@standardnotes/common'
+
+import { Column, Entity, Index, PrimaryGeneratedColumn } from 'typeorm'
+
+@Entity({ name: 'revisions' })
+export class TypeORMRevision {
+  @PrimaryGeneratedColumn('uuid')
+  declare uuid: string
+
+  @Column({
+    name: 'item_uuid',
+    length: 36,
+  })
+  declare itemUuid: string
+
+  @Column({
+    type: 'mediumtext',
+    nullable: true,
+  })
+  declare content: string | null
+
+  @Column({
+    name: 'content_type',
+    type: 'varchar',
+    length: 255,
+    nullable: true,
+  })
+  declare contentType: ContentType | null
+
+  @Column({
+    type: 'varchar',
+    name: 'items_key_id',
+    length: 255,
+    nullable: true,
+  })
+  declare itemsKeyId: string | null
+
+  @Column({
+    name: 'enc_item_key',
+    type: 'text',
+    nullable: true,
+  })
+  declare encItemKey: string | null
+
+  @Column({
+    name: 'auth_hash',
+    type: 'varchar',
+    length: 255,
+    nullable: true,
+  })
+  declare authHash: string | null
+
+  @Column({
+    name: 'creation_date',
+    type: 'date',
+    nullable: true,
+  })
+  @Index('index_revisions_on_creation_date')
+  declare creationDate: Date
+
+  @Column({
+    name: 'created_at',
+    type: 'datetime',
+    precision: 6,
+    nullable: true,
+  })
+  @Index('index_revisions_on_created_at')
+  declare createdAt: Date
+
+  @Column({
+    name: 'updated_at',
+    type: 'datetime',
+    precision: 6,
+    nullable: true,
+  })
+  declare updatedAt: Date
+}

packages/revisions/src/Mapping/RevisionMetadataPersistenceMapper.ts

@@ -0,0 +1,39 @@
+import { MapperInterface, Timestamps, UniqueEntityId } from '@standardnotes/domain-core'
+
+import { ContentType } from '../Domain/Revision/ContentType'
+import { RevisionMetadata } from '../Domain/Revision/RevisionMetadata'
+import { TypeORMRevision } from '../Infra/TypeORM/TypeORMRevision'
+
+export class RevisionMetadataPersistenceMapper implements MapperInterface<RevisionMetadata, TypeORMRevision> {
+  toDomain(projection: TypeORMRevision): RevisionMetadata {
+    const contentTypeOrError = ContentType.create(projection.contentType)
+    if (contentTypeOrError.isFailed()) {
+      throw new Error(`Could not create content type: ${contentTypeOrError.getError()}`)
+    }
+    const contentType = contentTypeOrError.getValue()
+
+    const timestampsOrError = Timestamps.create(projection.createdAt, projection.updatedAt)
+    if (timestampsOrError.isFailed()) {
+      throw new Error(`Could not create timestamps: ${timestampsOrError.getError()}`)
+    }
+    const timestamps = timestampsOrError.getValue()
+
+    const revisionMetadataOrError = RevisionMetadata.create(
+      {
+        contentType,
+        timestamps,
+      },
+      new UniqueEntityId(projection.uuid),
+    )
+
+    if (revisionMetadataOrError.isFailed()) {
+      throw new Error(`Could not create revision metdata: ${revisionMetadataOrError.getError()}`)
+    }
+
+    return revisionMetadataOrError.getValue()
+  }
+
+  toProjection(_domain: RevisionMetadata): TypeORMRevision {
+    throw new Error('Method not implemented.')
+  }
+}

packages/revisions/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "composite": true,
+    "outDir": "./dist",
+  },
+  "include": [
+    "src/**/*",
+    "bin/**/*",
+    "migrations/**/*",
+  ],
+  "references": []
+}

packages/revisions/wait-for.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+set -e
+
+host="$1"
+shift
+port="$1"
+shift
+cmd="$@"
+
+while ! nc -vz $host $port; do
+  >&2 echo "$host:$port is unavailable yet - waiting for it to start"
+  sleep 10
+done
+
+>&2 echo "$host:$port is up - executing command"
+exec $cmd

packages/scheduler/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.13.26](https://github.com/standardnotes/server/compare/@standardnotes/scheduler-server@1.13.25...@standardnotes/scheduler-server@1.13.26) (2022-11-21)
+
+**Note:** Version bump only for package @standardnotes/scheduler-server
+
+## [1.13.25](https://github.com/standardnotes/server/compare/@standardnotes/scheduler-server@1.13.24...@standardnotes/scheduler-server@1.13.25) (2022-11-18)
+
+**Note:** Version bump only for package @standardnotes/scheduler-server
+
+## [1.13.24](https://github.com/standardnotes/server/compare/@standardnotes/scheduler-server@1.13.23...@standardnotes/scheduler-server@1.13.24) (2022-11-16)
+
+**Note:** Version bump only for package @standardnotes/scheduler-server
+
 ## [1.13.23](https://github.com/standardnotes/server/compare/@standardnotes/scheduler-server@1.13.22...@standardnotes/scheduler-server@1.13.23) (2022-11-14)
 
 **Note:** Version bump only for package @standardnotes/scheduler-server

packages/scheduler/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/scheduler-server",
-  "version": "1.13.23",
+  "version": "1.13.26",
   "engines": {
     "node": ">=18.0.0 <19.0.0"
   },

packages/syncing-server/CHANGELOG.md

@@ -3,6 +3,48 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.15.0](https://github.com/standardnotes/syncing-server-js/compare/@standardnotes/syncing-server@1.14.0...@standardnotes/syncing-server@1.15.0) (2022-11-21)
+
+### Features
+
+* **syncing-server:** add creating item dumps for revision service ([8d152dd](https://github.com/standardnotes/syncing-server-js/commit/8d152ddfcb3c88cbbf9df04e3ed6e2c02571d821))
+
+# [1.14.0](https://github.com/standardnotes/syncing-server-js/compare/@standardnotes/syncing-server@1.13.17...@standardnotes/syncing-server@1.14.0) (2022-11-21)
+
+### Features
+
+* **syncing-server:** add creating revisions in async way ([1ca8531](https://github.com/standardnotes/syncing-server-js/commit/1ca853130547ebfc26bdd9abce0dfb550e8217f6))
+
+## [1.13.17](https://github.com/standardnotes/syncing-server-js/compare/@standardnotes/syncing-server@1.13.16...@standardnotes/syncing-server@1.13.17) (2022-11-21)
+
+**Note:** Version bump only for package @standardnotes/syncing-server
+
+## [1.13.16](https://github.com/standardnotes/syncing-server-js/compare/@standardnotes/syncing-server@1.13.15...@standardnotes/syncing-server@1.13.16) (2022-11-18)
+
+**Note:** Version bump only for package @standardnotes/syncing-server
+
+## [1.13.15](https://github.com/standardnotes/syncing-server-js/compare/@standardnotes/syncing-server@1.13.14...@standardnotes/syncing-server@1.13.15) (2022-11-18)
+
+### Bug Fixes
+
+* **syncing-server:** mapper interface imports in specs ([91f36c3](https://github.com/standardnotes/syncing-server-js/commit/91f36c3a3f37e1d53e2203bdfc932fe98cf57b13))
+
+## [1.13.14](https://github.com/standardnotes/syncing-server-js/compare/@standardnotes/syncing-server@1.13.13...@standardnotes/syncing-server@1.13.14) (2022-11-18)
+
+### Bug Fixes
+
+* mapper interface imports ([1ec0723](https://github.com/standardnotes/syncing-server-js/commit/1ec072373d640c4e2f24b9bb12fec0c678b48032))
+
+## [1.13.13](https://github.com/standardnotes/syncing-server-js/compare/@standardnotes/syncing-server@1.13.12...@standardnotes/syncing-server@1.13.13) (2022-11-17)
+
+### Bug Fixes
+
+* **syncing-server:** paginating with upper bound limit ([94afa34](https://github.com/standardnotes/syncing-server-js/commit/94afa347807d757b46d507086832fbfb3c73353d))
+
+## [1.13.12](https://github.com/standardnotes/syncing-server-js/compare/@standardnotes/syncing-server@1.13.11...@standardnotes/syncing-server@1.13.12) (2022-11-16)
+
+**Note:** Version bump only for package @standardnotes/syncing-server
+
 ## [1.13.11](https://github.com/standardnotes/syncing-server-js/compare/@standardnotes/syncing-server@1.13.10...@standardnotes/syncing-server@1.13.11) (2022-11-14)
 
 ### Bug Fixes

packages/syncing-server/jest.config.js

@@ -7,6 +7,6 @@ module.exports = {
   transform: {
     ...tsjPreset.transform,
   },
-  coveragePathIgnorePatterns: ['/Bootstrap/', 'HealthCheckController'],
+  coveragePathIgnorePatterns: ['/Bootstrap/', 'HealthCheckController', '/Infra/'],
   setupFilesAfterEnv: ['./test-setup.ts'],
 }

packages/syncing-server/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/syncing-server",
-  "version": "1.13.11",
+  "version": "1.15.0",
   "engines": {
     "node": ">=18.0.0 <19.0.0"
   },

packages/syncing-server/src/Bootstrap/Container.ts

@@ -81,9 +81,10 @@ import { ItemRepositoryInterface } from '../Domain/Item/ItemRepositoryInterface'
 import { Repository } from 'typeorm'
 import { UserContentSizeRecalculationRequestedEventHandler } from '../Domain/Handler/UserContentSizeRecalculationRequestedEventHandler'
 import { RevisionMetadataMap } from '../Domain/Map/RevisionMetadataMap'
-import { MapInterface } from '@standardnotes/domain-core'
+import { MapperInterface } from '@standardnotes/domain-core'
 import { RevisionMetadata } from '../Domain/Revision/RevisionMetadata'
 import { SimpleRevisionProjection } from '../Projection/SimpleRevisionProjection'
+import { ItemRevisionCreationRequestedEventHandler } from '../Domain/Handler/ItemRevisionCreationRequestedEventHandler'
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const newrelicFormatter = require('@newrelic/winston-enricher')
@@ -228,10 +229,13 @@ export class ContainerConfigLoader {
     container
       .bind<UserContentSizeRecalculationRequestedEventHandler>(TYPES.UserContentSizeRecalculationRequestedEventHandler)
       .to(UserContentSizeRecalculationRequestedEventHandler)
+    container
+      .bind<ItemRevisionCreationRequestedEventHandler>(TYPES.ItemRevisionCreationRequestedEventHandler)
+      .to(ItemRevisionCreationRequestedEventHandler)
 
     // Map
     container
-      .bind<MapInterface<RevisionMetadata, SimpleRevisionProjection>>(TYPES.RevisionMetadataMap)
+      .bind<MapperInterface<RevisionMetadata, SimpleRevisionProjection>>(TYPES.RevisionMetadataMap)
       .to(RevisionMetadataMap)
 
     // Services
@@ -274,6 +278,7 @@ export class ContainerConfigLoader {
         'USER_CONTENT_SIZE_RECALCULATION_REQUESTED',
         container.get(TYPES.UserContentSizeRecalculationRequestedEventHandler),
       ],
+      ['ITEM_REVISION_CREATION_REQUESTED', container.get(TYPES.ItemRevisionCreationRequestedEventHandler)],
     ])
 
     if (env.get('SQS_QUEUE_URL', true)) {

packages/syncing-server/src/Bootstrap/Types.ts

@@ -49,6 +49,7 @@ const TYPES = {
   EmailBackupRequestedEventHandler: Symbol.for('EmailBackupRequestedEventHandler'),
   CloudBackupRequestedEventHandler: Symbol.for('CloudBackupRequestedEventHandler'),
   UserContentSizeRecalculationRequestedEventHandler: Symbol.for('UserContentSizeRecalculationRequestedEventHandler'),
+  ItemRevisionCreationRequestedEventHandler: Symbol.for('ItemRevisionCreationRequestedEventHandler'),
   // Map
   RevisionMetadataMap: Symbol.for('RevisionMetadataMap'),
   // Services

packages/syncing-server/src/Controller/RevisionsController.spec.ts

@@ -8,13 +8,13 @@ import { results } from 'inversify-express-utils'
 import { ProjectorInterface } from '../Projection/ProjectorInterface'
 import { RevisionServiceInterface } from '../Domain/Revision/RevisionServiceInterface'
 import { RevisionProjection } from '../Projection/RevisionProjection'
-import { MapInterface } from '@standardnotes/domain-core'
+import { MapperInterface } from '@standardnotes/domain-core'
 import { RevisionMetadata } from '../Domain/Revision/RevisionMetadata'
 import { SimpleRevisionProjection } from '../Projection/SimpleRevisionProjection'
 
 describe('RevisionsController', () => {
   let revisionProjector: ProjectorInterface<Revision, RevisionProjection>
-  let revisionMap: MapInterface<RevisionMetadata, SimpleRevisionProjection>
+  let revisionMap: MapperInterface<RevisionMetadata, SimpleRevisionProjection>
   let revisionService: RevisionServiceInterface
   let revision: Revision
   let revisionMetadata: RevisionMetadata
@@ -28,7 +28,7 @@ describe('RevisionsController', () => {
 
     revisionMetadata = {} as jest.Mocked<RevisionMetadata>
 
-    revisionMap = {} as jest.Mocked<MapInterface<RevisionMetadata, SimpleRevisionProjection>>
+    revisionMap = {} as jest.Mocked<MapperInterface<RevisionMetadata, SimpleRevisionProjection>>
 
     revisionProjector = {} as jest.Mocked<ProjectorInterface<Revision, RevisionProjection>>
 

packages/syncing-server/src/Controller/RevisionsController.ts

@@ -8,7 +8,7 @@ import { Revision } from '../Domain/Revision/Revision'
 import { RevisionServiceInterface } from '../Domain/Revision/RevisionServiceInterface'
 import { ErrorTag } from '@standardnotes/common'
 import { RevisionProjection } from '../Projection/RevisionProjection'
-import { MapInterface } from '@standardnotes/domain-core'
+import { MapperInterface } from '@standardnotes/domain-core'
 import { RevisionMetadata } from '../Domain/Revision/RevisionMetadata'
 import { SimpleRevisionProjection } from '../Projection/SimpleRevisionProjection'
 
@@ -18,7 +18,7 @@ export class RevisionsController extends BaseHttpController {
     @inject(TYPES.RevisionService) private revisionService: RevisionServiceInterface,
     @inject(TYPES.RevisionProjector) private revisionProjector: ProjectorInterface<Revision, RevisionProjection>,
     @inject(TYPES.RevisionMetadataMap)
-    private revisionMetadataMap: MapInterface<RevisionMetadata, SimpleRevisionProjection>,
+    private revisionMetadataMap: MapperInterface<RevisionMetadata, SimpleRevisionProjection>,
   ) {
     super()
   }

packages/syncing-server/src/Domain/Event/DomainEventFactory.ts

@@ -6,6 +6,8 @@ import {
   EmailArchiveExtensionSyncedEvent,
   EmailBackupAttachmentCreatedEvent,
   GoogleDriveBackupFailedEvent,
+  ItemDumpedEvent,
+  ItemRevisionCreationRequestedEvent,
   ItemsSyncedEvent,
   OneDriveBackupFailedEvent,
   UserContentSizeRecalculationRequestedEvent,
@@ -19,6 +21,40 @@ import { DomainEventFactoryInterface } from './DomainEventFactoryInterface'
 export class DomainEventFactory implements DomainEventFactoryInterface {
   constructor(@inject(TYPES.Timer) private timer: TimerInterface) {}
 
+  createItemDumpedEvent(fileDumpPath: string, userUuid: string): ItemDumpedEvent {
+    return {
+      type: 'ITEM_DUMPED',
+      createdAt: this.timer.getUTCDate(),
+      meta: {
+        correlation: {
+          userIdentifier: userUuid,
+          userIdentifierType: 'uuid',
+        },
+        origin: DomainEventService.SyncingServer,
+      },
+      payload: {
+        fileDumpPath,
+      },
+    }
+  }
+
+  createItemRevisionCreationRequested(itemUuid: string, userUuid: string): ItemRevisionCreationRequestedEvent {
+    return {
+      type: 'ITEM_REVISION_CREATION_REQUESTED',
+      createdAt: this.timer.getUTCDate(),
+      meta: {
+        correlation: {
+          userIdentifier: userUuid,
+          userIdentifierType: 'uuid',
+        },
+        origin: DomainEventService.SyncingServer,
+      },
+      payload: {
+        itemUuid,
+      },
+    }
+  }
+
   createUserContentSizeRecalculationRequestedEvent(userUuid: string): UserContentSizeRecalculationRequestedEvent {
     return {
       type: 'USER_CONTENT_SIZE_RECALCULATION_REQUESTED',

packages/syncing-server/src/Domain/Event/DomainEventFactoryInterface.ts

@@ -4,6 +4,8 @@ import {
   EmailArchiveExtensionSyncedEvent,
   EmailBackupAttachmentCreatedEvent,
   GoogleDriveBackupFailedEvent,
+  ItemDumpedEvent,
+  ItemRevisionCreationRequestedEvent,
   ItemsSyncedEvent,
   OneDriveBackupFailedEvent,
   UserContentSizeRecalculationRequestedEvent,
@@ -31,4 +33,6 @@ export interface DomainEventFactoryInterface {
     email: string
   }): EmailBackupAttachmentCreatedEvent
   createDuplicateItemSyncedEvent(itemUuid: string, userUuid: string): DuplicateItemSyncedEvent
+  createItemRevisionCreationRequested(itemUuid: string, userUuid: string): ItemRevisionCreationRequestedEvent
+  createItemDumpedEvent(fileDumpPath: string, userUuid: string): ItemDumpedEvent
 }

packages/syncing-server/src/Domain/Handler/ItemRevisionCreationRequestedEventHandler.spec.ts

@@ -0,0 +1,92 @@
+import 'reflect-metadata'
+
+import {
+  DomainEventPublisherInterface,
+  DomainEventService,
+  ItemRevisionCreationRequestedEvent,
+} from '@standardnotes/domain-events'
+import { Item } from '../Item/Item'
+import { ItemRepositoryInterface } from '../Item/ItemRepositoryInterface'
+import { ItemRevisionCreationRequestedEventHandler } from './ItemRevisionCreationRequestedEventHandler'
+import { RevisionServiceInterface } from '../Revision/RevisionServiceInterface'
+import { ItemBackupServiceInterface } from '../Item/ItemBackupServiceInterface'
+import { DomainEventFactoryInterface } from '../Event/DomainEventFactoryInterface'
+
+describe('ItemRevisionCreationRequestedEventHandler', () => {
+  let itemRepository: ItemRepositoryInterface
+  let revisionService: RevisionServiceInterface
+  let event: ItemRevisionCreationRequestedEvent
+  let item: Item
+  let itemBackupService: ItemBackupServiceInterface
+  let domainEventFactory: DomainEventFactoryInterface
+  let domainEventPublisher: DomainEventPublisherInterface
+
+  const createHandler = () =>
+    new ItemRevisionCreationRequestedEventHandler(
+      itemRepository,
+      revisionService,
+      itemBackupService,
+      domainEventFactory,
+      domainEventPublisher,
+    )
+
+  beforeEach(() => {
+    item = {
+      uuid: '1-2-3',
+      content: 'test',
+    } as jest.Mocked<Item>
+
+    itemRepository = {} as jest.Mocked<ItemRepositoryInterface>
+    itemRepository.findByUuid = jest.fn().mockReturnValue(item)
+
+    revisionService = {} as jest.Mocked<RevisionServiceInterface>
+    revisionService.createRevision = jest.fn()
+
+    event = {} as jest.Mocked<ItemRevisionCreationRequestedEvent>
+    event.createdAt = new Date(1)
+    event.payload = {
+      itemUuid: '2-3-4',
+    }
+    event.meta = {
+      correlation: {
+        userIdentifier: '1-2-3',
+        userIdentifierType: 'uuid',
+      },
+      origin: DomainEventService.SyncingServer,
+    }
+
+    itemBackupService = {} as jest.Mocked<ItemBackupServiceInterface>
+    itemBackupService.dump = jest.fn().mockReturnValue('foo://bar')
+
+    domainEventFactory = {} as jest.Mocked<DomainEventFactoryInterface>
+    domainEventFactory.createItemDumpedEvent = jest.fn()
+
+    domainEventPublisher = {} as jest.Mocked<DomainEventPublisherInterface>
+    domainEventPublisher.publish = jest.fn()
+  })
+
+  it('should create a revision for an item', async () => {
+    await createHandler().handle(event)
+
+    expect(revisionService.createRevision).toHaveBeenCalled()
+    expect(domainEventPublisher.publish).toHaveBeenCalled()
+    expect(domainEventFactory.createItemDumpedEvent).toHaveBeenCalled()
+  })
+
+  it('should not create a revision for an item that does not exist', async () => {
+    itemRepository.findByUuid = jest.fn().mockReturnValue(null)
+
+    await createHandler().handle(event)
+
+    expect(revisionService.createRevision).not.toHaveBeenCalled()
+  })
+
+  it('should not create a revision for an item if the dump was not created', async () => {
+    itemBackupService.dump = jest.fn().mockReturnValue('')
+
+    await createHandler().handle(event)
+
+    expect(domainEventPublisher.publish).not.toHaveBeenCalled()
+    expect(domainEventFactory.createItemDumpedEvent).not.toHaveBeenCalled()
+  })
+})

packages/syncing-server/src/Domain/Handler/ItemRevisionCreationRequestedEventHandler.ts

@@ -0,0 +1,39 @@
+import {
+  ItemRevisionCreationRequestedEvent,
+  DomainEventHandlerInterface,
+  DomainEventPublisherInterface,
+} from '@standardnotes/domain-events'
+import { inject, injectable } from 'inversify'
+
+import TYPES from '../../Bootstrap/Types'
+import { DomainEventFactoryInterface } from '../Event/DomainEventFactoryInterface'
+import { ItemBackupServiceInterface } from '../Item/ItemBackupServiceInterface'
+import { ItemRepositoryInterface } from '../Item/ItemRepositoryInterface'
+import { RevisionServiceInterface } from '../Revision/RevisionServiceInterface'
+
+@injectable()
+export class ItemRevisionCreationRequestedEventHandler implements DomainEventHandlerInterface {
+  constructor(
+    @inject(TYPES.ItemRepository) private itemRepository: ItemRepositoryInterface,
+    @inject(TYPES.RevisionService) private revisionService: RevisionServiceInterface,
+    @inject(TYPES.ItemBackupService) private itemBackupService: ItemBackupServiceInterface,
+    @inject(TYPES.DomainEventFactory) private domainEventFactory: DomainEventFactoryInterface,
+    @inject(TYPES.DomainEventPublisher) private domainEventPublisher: DomainEventPublisherInterface,
+  ) {}
+
+  async handle(event: ItemRevisionCreationRequestedEvent): Promise<void> {
+    const item = await this.itemRepository.findByUuid(event.payload.itemUuid)
+    if (item === null) {
+      return
+    }
+
+    const fileDumpPath = await this.itemBackupService.dump(item)
+    if (fileDumpPath) {
+      await this.domainEventPublisher.publish(
+        this.domainEventFactory.createItemDumpedEvent(fileDumpPath, event.meta.correlation.userIdentifier),
+      )
+    }
+
+    await this.revisionService.createRevision(item)
+  }
+}

packages/syncing-server/src/Domain/Item/ItemBackupServiceInterface.ts

@@ -3,4 +3,5 @@ import { Item } from './Item'
 
 export interface ItemBackupServiceInterface {
   backup(items: Array<Item>, authParams: KeyParamsData): Promise<string>
+  dump(item: Item): Promise<string>
 }

packages/syncing-server/src/Domain/Item/ItemService.spec.ts

@@ -7,7 +7,6 @@ import { ItemHash } from './ItemHash'
 import { ItemRepositoryInterface } from './ItemRepositoryInterface'
 import { ItemService } from './ItemService'
 import { ApiVersion } from '../Api/ApiVersion'
-import { RevisionServiceInterface } from '../Revision/RevisionServiceInterface'
 import { DomainEventPublisherInterface } from '@standardnotes/domain-events'
 import { DomainEventFactoryInterface } from '../Event/DomainEventFactoryInterface'
 import { Logger } from 'winston'
@@ -21,7 +20,6 @@ import { ItemProjection } from '../../Projection/ItemProjection'
 
 describe('ItemService', () => {
   let itemRepository: ItemRepositoryInterface
-  let revisionService: RevisionServiceInterface
   let domainEventPublisher: DomainEventPublisherInterface
   let domainEventFactory: DomainEventFactoryInterface
   const revisionFrequency = 300
@@ -47,7 +45,6 @@ describe('ItemService', () => {
       itemSaveValidator,
       itemFactory,
       itemRepository,
-      revisionService,
       domainEventPublisher,
       domainEventFactory,
       revisionFrequency,
@@ -125,9 +122,6 @@ describe('ItemService', () => {
     itemRepository.countAll = jest.fn().mockReturnValue(2)
     itemRepository.save = jest.fn().mockImplementation((item: Item) => item)
 
-    revisionService = {} as jest.Mocked<RevisionServiceInterface>
-    revisionService.createRevision = jest.fn()
-
     timer = {} as jest.Mocked<TimerInterface>
     timer.getTimestampInMicroseconds = jest.fn().mockReturnValue(1616164633241568)
     timer.getUTCDate = jest.fn().mockReturnValue(new Date())
@@ -147,6 +141,7 @@ describe('ItemService', () => {
 
     domainEventFactory = {} as jest.Mocked<DomainEventFactoryInterface>
     domainEventFactory.createDuplicateItemSyncedEvent = jest.fn()
+    domainEventFactory.createItemRevisionCreationRequested = jest.fn()
 
     logger = {} as jest.Mocked<Logger>
     logger.error = jest.fn()
@@ -491,7 +486,8 @@ describe('ItemService', () => {
       syncToken: 'MjpOYU4=',
     })
 
-    expect(revisionService.createRevision).toHaveBeenCalledTimes(1)
+    expect(domainEventFactory.createItemRevisionCreationRequested).toHaveBeenCalledTimes(1)
+    expect(domainEventPublisher.publish).toHaveBeenCalledTimes(1)
   })
 
   it('should not save new items in read only access mode', async () => {
@@ -515,8 +511,6 @@ describe('ItemService', () => {
       savedItems: [],
       syncToken: 'MjoxNjE2MTY0NjMzLjI0MTU2OQ==',
     })
-
-    expect(revisionService.createRevision).toHaveBeenCalledTimes(0)
   })
 
   it('should save new items that are duplicates', async () => {
@@ -538,8 +532,8 @@ describe('ItemService', () => {
       syncToken: 'MjoxNjE2MTY0NjMzLjI0MTU3MQ==',
     })
 
-    expect(revisionService.createRevision).toHaveBeenCalledTimes(1)
-    expect(domainEventPublisher.publish).toHaveBeenCalledTimes(1)
+    expect(domainEventFactory.createItemRevisionCreationRequested).toHaveBeenCalledTimes(1)
+    expect(domainEventPublisher.publish).toHaveBeenCalledTimes(2)
     expect(domainEventFactory.createDuplicateItemSyncedEvent).toHaveBeenCalledTimes(1)
   })
 
@@ -933,8 +927,9 @@ describe('ItemService', () => {
       ],
       syncToken: 'MjoxNjE2MTY0NjMzLjI0MTU2OQ==',
     })
-    expect(domainEventPublisher.publish).toHaveBeenCalledTimes(1)
+    expect(domainEventPublisher.publish).toHaveBeenCalledTimes(2)
     expect(domainEventFactory.createDuplicateItemSyncedEvent).toHaveBeenCalledTimes(1)
+    expect(domainEventFactory.createItemRevisionCreationRequested).toHaveBeenCalledTimes(1)
   })
 
   it('should skip saving conflicting items and mark them as sync conflicts when saving to database fails', async () => {

packages/syncing-server/src/Domain/Item/ItemService.ts

@@ -6,7 +6,6 @@ import { Logger } from 'winston'
 
 import TYPES from '../../Bootstrap/Types'
 import { DomainEventFactoryInterface } from '../Event/DomainEventFactoryInterface'
-import { RevisionServiceInterface } from '../Revision/RevisionServiceInterface'
 import { GetItemsDTO } from './GetItemsDTO'
 import { GetItemsResult } from './GetItemsResult'
 import { Item } from './Item'
@@ -33,7 +32,6 @@ export class ItemService implements ItemServiceInterface {
     @inject(TYPES.ItemSaveValidator) private itemSaveValidator: ItemSaveValidatorInterface,
     @inject(TYPES.ItemFactory) private itemFactory: ItemFactoryInterface,
     @inject(TYPES.ItemRepository) private itemRepository: ItemRepositoryInterface,
-    @inject(TYPES.RevisionService) private revisionService: RevisionServiceInterface,
     @inject(TYPES.DomainEventPublisher) private domainEventPublisher: DomainEventPublisherInterface,
     @inject(TYPES.DomainEventFactory) private domainEventFactory: DomainEventFactoryInterface,
     @inject(TYPES.REVISIONS_FREQUENCY) private revisionFrequency: number,
@@ -49,6 +47,7 @@ export class ItemService implements ItemServiceInterface {
     const lastSyncTime = this.getLastSyncTime(dto)
     const syncTimeComparison = dto.cursorToken ? '>=' : '>'
     const limit = dto.limit === undefined || dto.limit < 1 ? this.DEFAULT_ITEMS_LIMIT : dto.limit
+    const upperBoundLimit = limit < this.maxItemsSyncLimit ? limit : this.maxItemsSyncLimit
 
     const itemQuery: ItemQuery = {
       userUuid: dto.userUuid,
@@ -58,7 +57,7 @@ export class ItemService implements ItemServiceInterface {
       deleted: lastSyncTime ? undefined : false,
       sortBy: 'updated_at_timestamp',
       sortOrder: 'ASC',
-      limit: limit < this.maxItemsSyncLimit ? limit : this.maxItemsSyncLimit,
+      limit: upperBoundLimit,
     }
 
     const itemUuidsToFetch = await this.itemTransferCalculator.computeItemUuidsToFetch(
@@ -76,7 +75,7 @@ export class ItemService implements ItemServiceInterface {
     const totalItemsCount = await this.itemRepository.countAll(itemQuery)
 
     let cursorToken = undefined
-    if (totalItemsCount > limit) {
+    if (totalItemsCount > upperBoundLimit) {
       const lastSyncTime = items[items.length - 1].updatedAtTimestamp / Time.MicrosecondsInASecond
       cursorToken = Buffer.from(`${this.SYNC_TOKEN_VERSION}:${lastSyncTime}`, 'utf-8').toString('base64')
     }
@@ -252,7 +251,9 @@ export class ItemService implements ItemServiceInterface {
     const savedItem = await this.itemRepository.save(dto.existingItem)
 
     if (secondsFromLastUpdate >= this.revisionFrequency) {
-      await this.revisionService.createRevision(savedItem)
+      await this.domainEventPublisher.publish(
+        this.domainEventFactory.createItemRevisionCreationRequested(savedItem.uuid, savedItem.userUuid),
+      )
     }
 
     if (wasMarkedAsDuplicate) {
@@ -269,7 +270,9 @@ export class ItemService implements ItemServiceInterface {
 
     const savedItem = await this.itemRepository.save(newItem)
 
-    await this.revisionService.createRevision(savedItem)
+    await this.domainEventPublisher.publish(
+      this.domainEventFactory.createItemRevisionCreationRequested(savedItem.uuid, savedItem.userUuid),
+    )
 
     if (savedItem.duplicateOf) {
       await this.domainEventPublisher.publish(

packages/syncing-server/src/Domain/Map/RevisionMetadataMap.ts

@@ -1,6 +1,6 @@
 /* istanbul ignore file */
 import { ContentType } from '@standardnotes/common'
-import { MapInterface, UniqueEntityId } from '@standardnotes/domain-core'
+import { MapperInterface, UniqueEntityId } from '@standardnotes/domain-core'
 import { TimerInterface } from '@standardnotes/time'
 import { inject, injectable } from 'inversify'
 
@@ -10,7 +10,7 @@ import { RevisionMetadata } from '../Revision/RevisionMetadata'
 import { RevisionServiceInterface } from '../Revision/RevisionServiceInterface'
 
 @injectable()
-export class RevisionMetadataMap implements MapInterface<RevisionMetadata, SimpleRevisionProjection> {
+export class RevisionMetadataMap implements MapperInterface<RevisionMetadata, SimpleRevisionProjection> {
   constructor(
     @inject(TYPES.RevisionService) private revisionService: RevisionServiceInterface,
     @inject(TYPES.Timer) private timer: TimerInterface,

packages/syncing-server/src/Infra/S3/S3ItemBackupService.spec.ts

@@ -1,59 +0,0 @@
-import 'reflect-metadata'
-
-import { KeyParamsData } from '@standardnotes/responses'
-import { S3 } from 'aws-sdk'
-import { Logger } from 'winston'
-import { Item } from '../../Domain/Item/Item'
-import { S3ItemBackupService } from './S3ItemBackupService'
-import { ProjectorInterface } from '../../Projection/ProjectorInterface'
-import { ItemProjection } from '../../Projection/ItemProjection'
-
-describe('S3ItemBackupService', () => {
-  let s3Client: S3 | undefined
-  let itemProjector: ProjectorInterface<Item, ItemProjection>
-  let s3BackupBucketName = 'backup-bucket'
-  let logger: Logger
-  let item: Item
-  let keyParams: KeyParamsData
-
-  const createService = () => new S3ItemBackupService(s3BackupBucketName, itemProjector, logger, s3Client)
-
-  beforeEach(() => {
-    s3Client = {} as jest.Mocked<S3>
-    s3Client.upload = jest.fn().mockReturnValue({
-      promise: jest.fn().mockReturnValue(Promise.resolve({ Key: 'test' })),
-    })
-
-    logger = {} as jest.Mocked<Logger>
-    logger.warn = jest.fn()
-
-    item = {} as jest.Mocked<Item>
-
-    keyParams = {} as jest.Mocked<KeyParamsData>
-
-    itemProjector = {} as jest.Mocked<ProjectorInterface<Item, ItemProjection>>
-    itemProjector.projectFull = jest.fn().mockReturnValue({ foo: 'bar' })
-  })
-
-  it('should upload items to S3 as a backup file', async () => {
-    await createService().backup([item], keyParams)
-
-    expect((<S3>s3Client).upload).toHaveBeenCalledWith({
-      Body: '{"items":[{"foo":"bar"}],"auth_params":{}}',
-      Bucket: 'backup-bucket',
-      Key: expect.any(String),
-    })
-  })
-
-  it('should not upload items to S3 if bucket name is not configured', async () => {
-    s3BackupBucketName = ''
-    await createService().backup([item], keyParams)
-
-    expect((<S3>s3Client).upload).not.toHaveBeenCalled()
-  })
-
-  it('should not upload items to S3 if S3 client is not configured', async () => {
-    s3Client = undefined
-    expect(await createService().backup([item], keyParams)).toEqual('')
-  })
-})