chore(release): publish new version

- @standardnotes/api-gateway@1.81.12
 - @standardnotes/home-server@1.18.29
 - @standardnotes/websockets-server@1.17.7

packages/api-gateway/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.81.12](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.81.11...@standardnotes/api-gateway@1.81.12) (2023-11-09)
+
+### Bug Fixes
+
+* reduce websockets api communication data ([#919](https://github.com/standardnotes/api-gateway/issues/919)) ([c4ae12d](https://github.com/standardnotes/api-gateway/commit/c4ae12d53fc166879f90a4c5dbad1ab1cb4797e2))
+
 ## [1.81.11](https://github.com/standardnotes/api-gateway/compare/@standardnotes/api-gateway@1.81.10...@standardnotes/api-gateway@1.81.11) (2023-11-07)
 
 ### Bug Fixes

packages/api-gateway/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/api-gateway",
-  "version": "1.81.11",
+  "version": "1.81.12",
   "engines": {
     "node": ">=18.0.0 <21.0.0"
   },

packages/api-gateway/src/Service/Http/HttpServiceProxy.ts

@@ -143,7 +143,18 @@ export class HttpServiceProxy implements ServiceProxyInterface {
       return
     }
 
-    await this.callServer(this.webSocketServerUrl, request, response, endpointOrMethodIdentifier, payload)
+    const isARequestComingFromApiGatewayAndShouldBeKeptInMinimalFormat = request.headers.connectionid !== undefined
+    if (isARequestComingFromApiGatewayAndShouldBeKeptInMinimalFormat) {
+      await this.callServerWithLegacyFormat(
+        this.webSocketServerUrl,
+        request,
+        response,
+        endpointOrMethodIdentifier,
+        payload,
+      )
+    } else {
+      await this.callServer(this.webSocketServerUrl, request, response, endpointOrMethodIdentifier, payload)
+    }
   }
 
   async callPaymentsServer(

packages/auth/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.
 
+## [1.167.2](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.167.1...@standardnotes/auth-server@1.167.2) (2023-11-08)
+
+### Bug Fixes
+
+* add logs about sending websocket events to clients ([9465f2e](https://github.com/standardnotes/server/commit/9465f2ecd8e8f0bf3ebeeb3976227b1b105aded0))
+
+## [1.167.1](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.167.0...@standardnotes/auth-server@1.167.1) (2023-11-08)
+
+### Bug Fixes
+
+* **auth:** path to delete accounts script ([ca8a3fc](https://github.com/standardnotes/server/commit/ca8a3fc77d91410f0dee8c3ddef29c09947c9cf5))
+
+# [1.167.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.166.0...@standardnotes/auth-server@1.167.0) (2023-11-08)
+
+### Features
+
+* script to mass delete accounts from CSV source ([#913](https://github.com/standardnotes/server/issues/913)) ([a6dea50](https://github.com/standardnotes/server/commit/a6dea50d745ff6f051fd9ede168aef27036159c3))
+
 # [1.166.0](https://github.com/standardnotes/server/compare/@standardnotes/auth-server@1.165.4...@standardnotes/auth-server@1.166.0) (2023-11-07)
 
 ### Features

packages/auth/bin/delete_accounts.ts

@@ -0,0 +1,43 @@
+import 'reflect-metadata'
+
+import { Logger } from 'winston'
+
+import { ContainerConfigLoader } from '../src/Bootstrap/Container'
+import TYPES from '../src/Bootstrap/Types'
+import { Env } from '../src/Bootstrap/Env'
+import { DeleteAccountsFromCSVFile } from '../src/Domain/UseCase/DeleteAccountsFromCSVFile/DeleteAccountsFromCSVFile'
+
+const inputArgs = process.argv.slice(2)
+const fileName = inputArgs[0]
+const mode = inputArgs[1]
+
+const deleteAccounts = async (deleteAccountsFromCSVFile: DeleteAccountsFromCSVFile): Promise<void> => {
+  await deleteAccountsFromCSVFile.execute({
+    fileName,
+    dryRun: mode !== 'delete',
+  })
+}
+
+const container = new ContainerConfigLoader('worker')
+void container.load().then((container) => {
+  const env: Env = new Env()
+  env.load()
+
+  const logger: Logger = container.get(TYPES.Auth_Logger)
+
+  logger.info('Starting mass accounts deletion from CSV file')
+
+  const deleteAccountsFromCSVFile = container.get<DeleteAccountsFromCSVFile>(TYPES.Auth_DeleteAccountsFromCSVFile)
+
+  Promise.resolve(deleteAccounts(deleteAccountsFromCSVFile))
+    .then(() => {
+      logger.info('Accounts deleted.')
+
+      process.exit(0)
+    })
+    .catch((error) => {
+      logger.error(`Could not delete accounts: ${error.message}`)
+
+      process.exit(1)
+    })
+})

packages/auth/docker/entrypoint-delete-accounts.js

@@ -0,0 +1,11 @@
+'use strict'
+
+const path = require('path')
+
+const pnp = require(path.normalize(path.resolve(__dirname, '../../..', '.pnp.cjs'))).setup()
+
+const index = require(path.normalize(path.resolve(__dirname, '../dist/bin/delete_accounts.js')))
+
+Object.defineProperty(exports, '__esModule', { value: true })
+
+exports.default = index

packages/auth/docker/entrypoint.sh

@@ -40,6 +40,13 @@ case "$COMMAND" in
     node docker/entrypoint-user-email-backup.js $EMAIL
     ;;
 
+  'delete-accounts' )
+    echo "[Docker] Starting Accounts Deleting from CSV..."
+    FILE_NAME=$1 && shift 1
+    MODE=$1 && shift 1
+    node docker/entrypoint-delete-accounts.js $FILE_NAME $MODE
+    ;;
+
    * )
     echo "[Docker] Unknown command"
     ;;

packages/auth/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/auth-server",
-  "version": "1.166.0",
+  "version": "1.167.2",
   "engines": {
     "node": ">=18.0.0 <21.0.0"
   },
@@ -32,6 +32,7 @@
     "migrate": "yarn build && yarn typeorm migration:run -d dist/src/Bootstrap/DataSource.js"
   },
   "dependencies": {
+    "@aws-sdk/client-s3": "^3.445.0",
     "@aws-sdk/client-sns": "^3.427.0",
     "@aws-sdk/client-sqs": "^3.427.0",
     "@cbor-extract/cbor-extract-linux-arm64": "^2.1.1",

packages/auth/src/Bootstrap/Container.ts

@@ -2,6 +2,7 @@ import * as winston from 'winston'
 import Redis from 'ioredis'
 import { SNSClient, SNSClientConfig } from '@aws-sdk/client-sns'
 import { SQSClient, SQSClientConfig } from '@aws-sdk/client-sqs'
+import { S3Client } from '@aws-sdk/client-s3'
 import { Container } from 'inversify'
 import {
   DomainEventHandlerInterface,
@@ -276,6 +277,9 @@ import { UserInvitedToSharedVaultEventHandler } from '../Domain/Handler/UserInvi
 import { TriggerPostSettingUpdateActions } from '../Domain/UseCase/TriggerPostSettingUpdateActions/TriggerPostSettingUpdateActions'
 import { TriggerEmailBackupForUser } from '../Domain/UseCase/TriggerEmailBackupForUser/TriggerEmailBackupForUser'
 import { TriggerEmailBackupForAllUsers } from '../Domain/UseCase/TriggerEmailBackupForAllUsers/TriggerEmailBackupForAllUsers'
+import { CSVFileReaderInterface } from '../Domain/CSV/CSVFileReaderInterface'
+import { S3CsvFileReader } from '../Infra/S3/S3CsvFileReader'
+import { DeleteAccountsFromCSVFile } from '../Domain/UseCase/DeleteAccountsFromCSVFile/DeleteAccountsFromCSVFile'
 
 export class ContainerConfigLoader {
   constructor(private mode: 'server' | 'worker' = 'server') {}
@@ -370,6 +374,19 @@ export class ContainerConfigLoader {
       }
       const sqsClient = new SQSClient(sqsConfig)
       container.bind<SQSClient>(TYPES.Auth_SQS).toConstantValue(sqsClient)
+
+      container.bind<S3Client>(TYPES.Auth_S3).toConstantValue(
+        new S3Client({
+          apiVersion: 'latest',
+          region: env.get('S3_AWS_REGION', true),
+        }),
+      )
+
+      container
+        .bind<CSVFileReaderInterface>(TYPES.Auth_CSVFileReader)
+        .toConstantValue(
+          new S3CsvFileReader(env.get('S3_AUTH_SCRIPTS_DATA_BUCKET', true), container.get<S3Client>(TYPES.Auth_S3)),
+        )
     }
 
     container.bind(TYPES.Auth_SNS_TOPIC_ARN).toConstantValue(env.get('SNS_TOPIC_ARN', true))
@@ -1251,6 +1268,17 @@ export class ContainerConfigLoader {
           container.get<TriggerEmailBackupForUser>(TYPES.Auth_TriggerEmailBackupForUser),
         ),
       )
+    if (!isConfiguredForHomeServer) {
+      container
+        .bind<DeleteAccountsFromCSVFile>(TYPES.Auth_DeleteAccountsFromCSVFile)
+        .toConstantValue(
+          new DeleteAccountsFromCSVFile(
+            container.get<CSVFileReaderInterface>(TYPES.Auth_CSVFileReader),
+            container.get<DeleteAccount>(TYPES.Auth_DeleteAccount),
+            container.get<winston.Logger>(TYPES.Auth_Logger),
+          ),
+        )
+    }
 
     // Controller
     container

packages/auth/src/Bootstrap/Types.ts

@@ -3,6 +3,7 @@ const TYPES = {
   Auth_Redis: Symbol.for('Auth_Redis'),
   Auth_SNS: Symbol.for('Auth_SNS'),
   Auth_SQS: Symbol.for('Auth_SQS'),
+  Auth_S3: Symbol.for('Auth_S3'),
   // Mapping
   Auth_SessionTracePersistenceMapper: Symbol.for('Auth_SessionTracePersistenceMapper'),
   Auth_AuthenticatorChallengePersistenceMapper: Symbol.for('Auth_AuthenticatorChallengePersistenceMapper'),
@@ -167,6 +168,7 @@ const TYPES = {
   Auth_TriggerPostSettingUpdateActions: Symbol.for('Auth_TriggerPostSettingUpdateActions'),
   Auth_TriggerEmailBackupForUser: Symbol.for('Auth_TriggerEmailBackupForUser'),
   Auth_TriggerEmailBackupForAllUsers: Symbol.for('Auth_TriggerEmailBackupForAllUsers'),
+  Auth_DeleteAccountsFromCSVFile: Symbol.for('Auth_DeleteAccountsFromCSVFile'),
   // Handlers
   Auth_AccountDeletionRequestedEventHandler: Symbol.for('Auth_AccountDeletionRequestedEventHandler'),
   Auth_SubscriptionPurchasedEventHandler: Symbol.for('Auth_SubscriptionPurchasedEventHandler'),
@@ -251,6 +253,7 @@ const TYPES = {
   Auth_BaseOfflineController: Symbol.for('Auth_BaseOfflineController'),
   Auth_BaseListedController: Symbol.for('Auth_BaseListedController'),
   Auth_BaseFeaturesController: Symbol.for('Auth_BaseFeaturesController'),
+  Auth_CSVFileReader: Symbol.for('Auth_CSVFileReader'),
 }
 
 export default TYPES

packages/auth/src/Domain/CSV/CSVFileReaderInterface.ts

@@ -0,0 +1,5 @@
+import { Result } from '@standardnotes/domain-core'
+
+export interface CSVFileReaderInterface {
+  getValues(fileName: string): Promise<Result<string[]>>
+}

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

@@ -0,0 +1,72 @@
+import { Logger } from 'winston'
+import { Result } from '@standardnotes/domain-core'
+
+import { CSVFileReaderInterface } from '../../CSV/CSVFileReaderInterface'
+import { DeleteAccount } from '../DeleteAccount/DeleteAccount'
+import { DeleteAccountsFromCSVFile } from './DeleteAccountsFromCSVFile'
+
+describe('DeleteAccountsFromCSVFile', () => {
+  let csvFileReader: CSVFileReaderInterface
+  let deleteAccount: DeleteAccount
+  let logger: Logger
+
+  const createUseCase = () => new DeleteAccountsFromCSVFile(csvFileReader, deleteAccount, logger)
+
+  beforeEach(() => {
+    csvFileReader = {} as jest.Mocked<CSVFileReaderInterface>
+    csvFileReader.getValues = jest.fn().mockResolvedValue(Result.ok(['email1']))
+
+    deleteAccount = {} as jest.Mocked<DeleteAccount>
+    deleteAccount.execute = jest.fn().mockResolvedValue(Result.ok(''))
+
+    logger = {} as jest.Mocked<Logger>
+    logger.info = jest.fn()
+  })
+
+  it('should delete accounts', async () => {
+    const useCase = createUseCase()
+
+    const result = await useCase.execute({ fileName: 'test.csv', dryRun: false })
+
+    expect(result.isFailed()).toBeFalsy()
+  })
+
+  it('should return error if csv file is invalid', async () => {
+    csvFileReader.getValues = jest.fn().mockResolvedValue(Result.fail('Oops'))
+
+    const useCase = createUseCase()
+
+    const result = await useCase.execute({ fileName: 'test.csv', dryRun: false })
+
+    expect(result.isFailed()).toBeTruthy()
+  })
+
+  it('should return error if csv file is empty', async () => {
+    csvFileReader.getValues = jest.fn().mockResolvedValue(Result.ok([]))
+
+    const useCase = createUseCase()
+
+    const result = await useCase.execute({ fileName: 'test.csv', dryRun: false })
+
+    expect(result.isFailed()).toBeTruthy()
+  })
+
+  it('should do nothing on a dry run', async () => {
+    const useCase = createUseCase()
+
+    const result = await useCase.execute({ fileName: 'test.csv', dryRun: true })
+
+    expect(deleteAccount.execute).not.toHaveBeenCalled()
+    expect(result.isFailed()).toBeFalsy()
+  })
+
+  it('should return error if delete account fails', async () => {
+    deleteAccount.execute = jest.fn().mockResolvedValue(Result.fail('Oops'))
+
+    const useCase = createUseCase()
+
+    const result = await useCase.execute({ fileName: 'test.csv', dryRun: false })
+
+    expect(result.isFailed()).toBeTruthy()
+  })
+})

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

@@ -0,0 +1,47 @@
+import { Result, UseCaseInterface } from '@standardnotes/domain-core'
+import { Logger } from 'winston'
+
+import { DeleteAccount } from '../DeleteAccount/DeleteAccount'
+import { CSVFileReaderInterface } from '../../CSV/CSVFileReaderInterface'
+import { DeleteAccountsFromCSVFileDTO } from './DeleteAccountsFromCSVFileDTO'
+
+export class DeleteAccountsFromCSVFile implements UseCaseInterface<void> {
+  constructor(
+    private csvFileReader: CSVFileReaderInterface,
+    private deleteAccount: DeleteAccount,
+    private logger: Logger,
+  ) {}
+
+  async execute(dto: DeleteAccountsFromCSVFileDTO): Promise<Result<void>> {
+    const emailsOrError = await this.csvFileReader.getValues(dto.fileName)
+    if (emailsOrError.isFailed()) {
+      return Result.fail(emailsOrError.getError())
+    }
+    const emails = emailsOrError.getValue()
+
+    if (emails.length === 0) {
+      return Result.fail(`No emails found in CSV file ${dto.fileName}`)
+    }
+
+    if (dto.dryRun) {
+      const firstTenEmails = emails.slice(0, 10)
+      this.logger.info(
+        `Dry run mode enabled. Would delete ${emails.length} accounts. First 10 emails: ${firstTenEmails}`,
+      )
+
+      return Result.ok()
+    }
+
+    for (const email of emails) {
+      const deleteAccountOrError = await this.deleteAccount.execute({
+        username: email,
+      })
+
+      if (deleteAccountOrError.isFailed()) {
+        return Result.fail(deleteAccountOrError.getError())
+      }
+    }
+
+    return Result.ok()
+  }
+}

packages/auth/src/Domain/UseCase/DeleteAccountsFromCSVFile/DeleteAccountsFromCSVFileDTO.ts

@@ -0,0 +1,4 @@
+export interface DeleteAccountsFromCSVFileDTO {
+  fileName: string
+  dryRun: boolean
+}

packages/auth/src/Infra/S3/S3CsvFileReader.ts

@@ -0,0 +1,32 @@
+import { S3Client, GetObjectCommand } from '@aws-sdk/client-s3'
+import { Result } from '@standardnotes/domain-core'
+
+import { CSVFileReaderInterface } from '../../Domain/CSV/CSVFileReaderInterface'
+
+export class S3CsvFileReader implements CSVFileReaderInterface {
+  constructor(
+    private s3BucketName: string,
+    private s3Client: S3Client,
+  ) {}
+
+  async getValues(fileName: string): Promise<Result<string[]>> {
+    if (this.s3BucketName.length === 0) {
+      return Result.fail('S3 bucket name is not set')
+    }
+
+    const response = await this.s3Client.send(
+      new GetObjectCommand({
+        Bucket: this.s3BucketName,
+        Key: fileName,
+      }),
+    )
+
+    if (response.Body === undefined) {
+      return Result.fail(`Could not find CSV file at path: ${fileName}`)
+    }
+
+    const csvContent = await response.Body.transformToString()
+
+    return Result.ok(csvContent.split('\n').filter((line) => line.length > 0))
+  }
+}

packages/auth/src/Infra/WebSockets/WebSocketsClientService.ts

@@ -5,12 +5,14 @@ import { DomainEventFactoryInterface } from '../../Domain/Event/DomainEventFacto
 import { User } from '../../Domain/User/User'
 import { ClientServiceInterface } from '../../Domain/Client/ClientServiceInterface'
 import { DomainEventPublisherInterface } from '@standardnotes/domain-events'
+import { Logger } from 'winston'
 
 @injectable()
 export class WebSocketsClientService implements ClientServiceInterface {
   constructor(
     @inject(TYPES.Auth_DomainEventFactory) private domainEventFactory: DomainEventFactoryInterface,
     @inject(TYPES.Auth_DomainEventPublisher) private domainEventPublisher: DomainEventPublisherInterface,
+    @inject(TYPES.Auth_Logger) private logger: Logger,
   ) {}
 
   async sendUserRolesChangedEvent(user: User): Promise<void> {
@@ -20,6 +22,8 @@ export class WebSocketsClientService implements ClientServiceInterface {
       (await user.roles).map((role) => role.name),
     )
 
+    this.logger.info(`[WebSockets] Requesting message ${event.type} to user ${user.uuid}`)
+
     await this.domainEventPublisher.publish(
       this.domainEventFactory.createWebSocketMessageRequestedEvent({
         userUuid: user.uuid,

packages/home-server/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.18.29](https://github.com/standardnotes/server/compare/@standardnotes/home-server@1.18.28...@standardnotes/home-server@1.18.29) (2023-11-09)
+
+**Note:** Version bump only for package @standardnotes/home-server
+
+## [1.18.28](https://github.com/standardnotes/server/compare/@standardnotes/home-server@1.18.27...@standardnotes/home-server@1.18.28) (2023-11-08)
+
+**Note:** Version bump only for package @standardnotes/home-server
+
+## [1.18.27](https://github.com/standardnotes/server/compare/@standardnotes/home-server@1.18.26...@standardnotes/home-server@1.18.27) (2023-11-08)
+
+**Note:** Version bump only for package @standardnotes/home-server
+
+## [1.18.26](https://github.com/standardnotes/server/compare/@standardnotes/home-server@1.18.25...@standardnotes/home-server@1.18.26) (2023-11-08)
+
+**Note:** Version bump only for package @standardnotes/home-server
+
 ## [1.18.25](https://github.com/standardnotes/server/compare/@standardnotes/home-server@1.18.24...@standardnotes/home-server@1.18.25) (2023-11-07)
 
 **Note:** Version bump only for package @standardnotes/home-server

packages/home-server/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/home-server",
-  "version": "1.18.25",
+  "version": "1.18.29",
   "engines": {
     "node": ">=18.0.0 <21.0.0"
   },

packages/syncing-server/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.120.4](https://github.com/standardnotes/syncing-server-js/compare/@standardnotes/syncing-server@1.120.3...@standardnotes/syncing-server@1.120.4) (2023-11-08)
+
+### Bug Fixes
+
+* add logs about sending websocket events to clients ([9465f2e](https://github.com/standardnotes/syncing-server-js/commit/9465f2ecd8e8f0bf3ebeeb3976227b1b105aded0))
+
 ## [1.120.3](https://github.com/standardnotes/syncing-server-js/compare/@standardnotes/syncing-server@1.120.2...@standardnotes/syncing-server@1.120.3) (2023-11-07)
 
 **Note:** Version bump only for package @standardnotes/syncing-server

packages/syncing-server/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/syncing-server",
-  "version": "1.120.3",
+  "version": "1.120.4",
   "engines": {
     "node": ">=18.0.0 <21.0.0"
   },

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

@@ -554,6 +554,7 @@ export class ContainerConfigLoader {
         new SendEventToClient(
           container.get<DomainEventFactoryInterface>(TYPES.Sync_DomainEventFactory),
           container.get<DomainEventPublisherInterface>(TYPES.Sync_DomainEventPublisher),
+          container.get<Logger>(TYPES.Sync_Logger),
         ),
       )
     container

packages/syncing-server/src/Domain/UseCase/Syncing/SendEventToClient/SendEventToClient.spec.ts

@@ -5,14 +5,19 @@ import {
 } from '@standardnotes/domain-events'
 import { DomainEventFactoryInterface } from '../../../Event/DomainEventFactoryInterface'
 import { SendEventToClient } from './SendEventToClient'
+import { Logger } from 'winston'
 
 describe('SendEventToClient', () => {
   let domainEventFactory: DomainEventFactoryInterface
   let domainEventPublisher: DomainEventPublisherInterface
+  let logger: Logger
 
-  const createUseCase = () => new SendEventToClient(domainEventFactory, domainEventPublisher)
+  const createUseCase = () => new SendEventToClient(domainEventFactory, domainEventPublisher, logger)
 
   beforeEach(() => {
+    logger = {} as jest.Mocked<Logger>
+    logger.info = jest.fn()
+
     domainEventFactory = {} as jest.Mocked<DomainEventFactoryInterface>
     domainEventFactory.createWebSocketMessageRequestedEvent = jest
       .fn()

packages/syncing-server/src/Domain/UseCase/Syncing/SendEventToClient/SendEventToClient.ts

@@ -3,11 +3,13 @@ import { DomainEventPublisherInterface } from '@standardnotes/domain-events'
 
 import { SendEventToClientDTO } from './SendEventToClientDTO'
 import { DomainEventFactoryInterface } from '../../../Event/DomainEventFactoryInterface'
+import { Logger } from 'winston'
 
 export class SendEventToClient implements UseCaseInterface<void> {
   constructor(
     private domainEventFactory: DomainEventFactoryInterface,
     private domainEventPublisher: DomainEventPublisherInterface,
+    private logger: Logger,
   ) {}
 
   async execute(dto: SendEventToClientDTO): Promise<Result<void>> {
@@ -17,6 +19,8 @@ export class SendEventToClient implements UseCaseInterface<void> {
     }
     const userUuid = userUuidOrError.getValue()
 
+    this.logger.info(`[WebSockets] Requesting message ${dto.event.type} to user ${dto.userUuid}`)
+
     const event = this.domainEventFactory.createWebSocketMessageRequestedEvent({
       userUuid: userUuid.value,
       message: JSON.stringify(dto.event),

packages/websockets/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.17.7](https://github.com/standardnotes/server/compare/@standardnotes/websockets-server@1.17.6...@standardnotes/websockets-server@1.17.7) (2023-11-09)
+
+### Bug Fixes
+
+* reduce websockets api communication data ([#919](https://github.com/standardnotes/server/issues/919)) ([c4ae12d](https://github.com/standardnotes/server/commit/c4ae12d53fc166879f90a4c5dbad1ab1cb4797e2))
+
 ## [1.17.6](https://github.com/standardnotes/server/compare/@standardnotes/websockets-server@1.17.5...@standardnotes/websockets-server@1.17.6) (2023-11-07)
 
 **Note:** Version bump only for package @standardnotes/websockets-server

packages/websockets/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standardnotes/websockets-server",
-  "version": "1.17.6",
+  "version": "1.17.7",
   "engines": {
     "node": ">=18.0.0 <21.0.0"
   },

packages/websockets/src/Domain/UseCase/AddWebSocketsConnection/AddWebSocketsConnection.spec.ts

@@ -16,11 +16,23 @@ describe('AddWebSocketsConnection', () => {
 
     logger = {} as jest.Mocked<Logger>
     logger.debug = jest.fn()
+    logger.error = jest.fn()
   })
 
   it('should save a web sockets connection for a user for further communication', async () => {
-    await createUseCase().execute({ userUuid: '1-2-3', connectionId: '2-3-4' })
+    const result = await createUseCase().execute({ userUuid: '1-2-3', connectionId: '2-3-4' })
 
     expect(webSocketsConnectionRepository.saveConnection).toHaveBeenCalledWith('1-2-3', '2-3-4')
+    expect(result.isFailed()).toBe(false)
+  })
+
+  it('should return a failure if the web sockets connection could not be saved', async () => {
+    webSocketsConnectionRepository.saveConnection = jest
+      .fn()
+      .mockRejectedValueOnce(new Error('Could not save connection'))
+
+    const result = await createUseCase().execute({ userUuid: '1-2-3', connectionId: '2-3-4' })
+
+    expect(result.isFailed()).toBe(true)
   })
 })

packages/websockets/src/Domain/UseCase/AddWebSocketsConnection/AddWebSocketsConnection.ts

@@ -1,26 +1,32 @@
 import { inject, injectable } from 'inversify'
 import { Logger } from 'winston'
+import { Result, UseCaseInterface } from '@standardnotes/domain-core'
+
 import TYPES from '../../../Bootstrap/Types'
 import { WebSocketsConnectionRepositoryInterface } from '../../WebSockets/WebSocketsConnectionRepositoryInterface'
-import { UseCaseInterface } from '../UseCaseInterface'
 import { AddWebSocketsConnectionDTO } from './AddWebSocketsConnectionDTO'
-import { AddWebSocketsConnectionResponse } from './AddWebSocketsConnectionResponse'
 
 @injectable()
-export class AddWebSocketsConnection implements UseCaseInterface {
+export class AddWebSocketsConnection implements UseCaseInterface<void> {
   constructor(
     @inject(TYPES.WebSocketsConnectionRepository)
     private webSocketsConnectionRepository: WebSocketsConnectionRepositoryInterface,
     @inject(TYPES.Logger) private logger: Logger,
   ) {}
 
-  async execute(dto: AddWebSocketsConnectionDTO): Promise<AddWebSocketsConnectionResponse> {
-    this.logger.debug(`Persisting connection ${dto.connectionId} for user ${dto.userUuid}`)
+  async execute(dto: AddWebSocketsConnectionDTO): Promise<Result<void>> {
+    try {
+      this.logger.debug(`Persisting connection ${dto.connectionId} for user ${dto.userUuid}`)
 
-    await this.webSocketsConnectionRepository.saveConnection(dto.userUuid, dto.connectionId)
+      await this.webSocketsConnectionRepository.saveConnection(dto.userUuid, dto.connectionId)
 
-    return {
-      success: true,
+      return Result.ok()
+    } catch (error) {
+      this.logger.error(
+        `Error persisting connection ${dto.connectionId} for user ${dto.userUuid}: ${(error as Error).message}`,
+      )
+
+      return Result.fail((error as Error).message)
     }
   }
 }

packages/websockets/src/Domain/UseCase/AddWebSocketsConnection/AddWebSocketsConnectionResponse.ts

@@ -1,3 +0,0 @@
-export type AddWebSocketsConnectionResponse = {
-  success: boolean
-}

packages/websockets/src/Domain/UseCase/RemoveWebSocketsConnection/RemoveWebSocketsConnection.spec.ts

@@ -16,11 +16,23 @@ describe('RemoveWebSocketsConnection', () => {
 
     logger = {} as jest.Mocked<Logger>
     logger.debug = jest.fn()
+    logger.error = jest.fn()
   })
 
   it('should remove a web sockets connection', async () => {
-    await createUseCase().execute({ connectionId: '2-3-4' })
+    const result = await createUseCase().execute({ connectionId: '2-3-4' })
 
     expect(webSocketsConnectionRepository.removeConnection).toHaveBeenCalledWith('2-3-4')
+    expect(result.isFailed()).toBe(false)
+  })
+
+  it('should return a failure if the web sockets connection could not be removed', async () => {
+    webSocketsConnectionRepository.removeConnection = jest
+      .fn()
+      .mockRejectedValueOnce(new Error('Could not remove connection'))
+
+    const result = await createUseCase().execute({ connectionId: '2-3-4' })
+
+    expect(result.isFailed()).toBe(true)
   })
 })

packages/websockets/src/Domain/UseCase/RemoveWebSocketsConnection/RemoveWebSocketsConnection.ts

@@ -1,26 +1,30 @@
 import { inject, injectable } from 'inversify'
 import { Logger } from 'winston'
+import { Result, UseCaseInterface } from '@standardnotes/domain-core'
+
 import TYPES from '../../../Bootstrap/Types'
 import { WebSocketsConnectionRepositoryInterface } from '../../WebSockets/WebSocketsConnectionRepositoryInterface'
-import { UseCaseInterface } from '../UseCaseInterface'
 import { RemoveWebSocketsConnectionDTO } from './RemoveWebSocketsConnectionDTO'
-import { RemoveWebSocketsConnectionResponse } from './RemoveWebSocketsConnectionResponse'
 
 @injectable()
-export class RemoveWebSocketsConnection implements UseCaseInterface {
+export class RemoveWebSocketsConnection implements UseCaseInterface<void> {
   constructor(
     @inject(TYPES.WebSocketsConnectionRepository)
     private webSocketsConnectionRepository: WebSocketsConnectionRepositoryInterface,
     @inject(TYPES.Logger) private logger: Logger,
   ) {}
 
-  async execute(dto: RemoveWebSocketsConnectionDTO): Promise<RemoveWebSocketsConnectionResponse> {
-    this.logger.debug(`Removing connection ${dto.connectionId}`)
+  async execute(dto: RemoveWebSocketsConnectionDTO): Promise<Result<void>> {
+    try {
+      this.logger.debug(`Removing connection ${dto.connectionId}`)
 
-    await this.webSocketsConnectionRepository.removeConnection(dto.connectionId)
+      await this.webSocketsConnectionRepository.removeConnection(dto.connectionId)
 
-    return {
-      success: true,
+      return Result.ok()
+    } catch (error) {
+      this.logger.error(`Error removing connection ${dto.connectionId}: ${(error as Error).message}`)
+
+      return Result.fail((error as Error).message)
     }
   }
 }

packages/websockets/src/Domain/UseCase/RemoveWebSocketsConnection/RemoveWebSocketsConnectionResponse.ts

@@ -1,3 +0,0 @@
-export type RemoveWebSocketsConnectionResponse = {
-  success: boolean
-}

packages/websockets/src/Infra/InversifyExpressUtils/AnnotatedWebSocketsController.ts

@@ -36,21 +36,27 @@ export class AnnotatedWebSocketsController extends BaseHttpController {
   async storeWebSocketsConnection(
     request: Request,
     response: Response,
-  ): Promise<results.JsonResult | results.BadRequestErrorMessageResult> {
-    await this.addWebSocketsConnection.execute({
+  ): Promise<results.OkResult | results.BadRequestResult> {
+    const result = await this.addWebSocketsConnection.execute({
       userUuid: response.locals.user.uuid,
       connectionId: request.params.connectionId,
     })
 
-    return this.json({ success: true })
+    if (result.isFailed()) {
+      return this.badRequest()
+    }
+
+    return this.ok()
   }
 
   @httpDelete('/connections/:connectionId')
-  async deleteWebSocketsConnection(
-    request: Request,
-  ): Promise<results.JsonResult | results.BadRequestErrorMessageResult> {
-    await this.removeWebSocketsConnection.execute({ connectionId: request.params.connectionId })
+  async deleteWebSocketsConnection(request: Request): Promise<results.OkResult | results.BadRequestResult> {
+    const result = await this.removeWebSocketsConnection.execute({ connectionId: request.params.connectionId })
 
-    return this.json({ success: true })
+    if (result.isFailed()) {
+      return this.badRequest()
+    }
+
+    return this.ok()
   }
 }