chore: global sync per minute safety limit (#2765)

Author: karolsojko

packages/services/src/Domain/Application/Options/OptionalOptions.ts

@@ -18,6 +18,11 @@ export interface ApplicationOptionalConfiguratioOptions {
    */
   webSocketUrl?: string
 
+  /**
+   * Amount sync calls allowed per minute.
+   */
+  syncCallsThresholdPerMinute?: number
+
   /**
    * 3rd party library function for prompting U2F authenticator device registration
    *

packages/snjs/lib/Application/Dependencies/Dependencies.ts

@@ -176,11 +176,15 @@ import { Logger, isNotUndefined, isDeinitable, LoggerInterface } from '@standard
 import { EncryptionOperators } from '@standardnotes/encryption'
 import { AsymmetricMessagePayload, AsymmetricMessageSharedVaultInvite } from '@standardnotes/models'
 import { PureCryptoInterface } from '@standardnotes/sncrypto-common'
+import { SyncFrequencyGuard } from '@Lib/Services/Sync/SyncFrequencyGuard'
+import { SyncFrequencyGuardInterface } from '@Lib/Services/Sync/SyncFrequencyGuardInterface'
 
 export class Dependencies {
   private factory = new Map<symbol, () => unknown>()
   private dependencies = new Map<symbol, unknown>()
 
+  private DEFAULT_SYNC_CALLS_THRESHOLD_PER_MINUTE = 200
+
   constructor(private options: FullyResolvedApplicationOptions) {
     this.dependencies.set(TYPES.DeviceInterface, options.deviceInterface)
     this.dependencies.set(TYPES.AlertService, options.alertService)
@@ -1341,6 +1345,12 @@ export class Dependencies {
       )
     })
 
+    this.factory.set(TYPES.SyncFrequencyGuard, () => {
+      return new SyncFrequencyGuard(
+        this.options.syncCallsThresholdPerMinute ?? this.DEFAULT_SYNC_CALLS_THRESHOLD_PER_MINUTE,
+      )
+    })
+
     this.factory.set(TYPES.SyncService, () => {
       return new SyncService(
         this.get<ItemManager>(TYPES.ItemManager),
@@ -1358,6 +1368,7 @@ export class Dependencies {
         },
         this.get<Logger>(TYPES.Logger),
         this.get<WebSocketsService>(TYPES.WebSocketsService),
+        this.get<SyncFrequencyGuardInterface>(TYPES.SyncFrequencyGuard),
         this.get<InternalEventBus>(TYPES.InternalEventBus),
       )
     })

packages/snjs/lib/Application/Dependencies/Types.ts

@@ -29,6 +29,7 @@ export const TYPES = {
   SessionManager: Symbol.for('SessionManager'),
   SubscriptionManager: Symbol.for('SubscriptionManager'),
   HistoryManager: Symbol.for('HistoryManager'),
+  SyncFrequencyGuard: Symbol.for('SyncFrequencyGuard'),
   SyncService: Symbol.for('SyncService'),
   ProtectionService: Symbol.for('ProtectionService'),
   UserService: Symbol.for('UserService'),

packages/snjs/lib/Services/Sync/SyncFrequencyGuard.spec.ts

@@ -0,0 +1,38 @@
+import { SyncFrequencyGuard } from './SyncFrequencyGuard'
+
+describe('SyncFrequencyGuard', () => {
+  const createUseCase = () => new SyncFrequencyGuard(3)
+
+  it('should return false when sync calls threshold is not reached', () => {
+    const useCase = createUseCase()
+
+    expect(useCase.isSyncCallsThresholdReachedThisMinute()).toBe(false)
+  })
+
+  it('should return true when sync calls threshold is reached', () => {
+    const useCase = createUseCase()
+
+    useCase.incrementCallsPerMinute()
+    useCase.incrementCallsPerMinute()
+    useCase.incrementCallsPerMinute()
+
+    expect(useCase.isSyncCallsThresholdReachedThisMinute()).toBe(true)
+  })
+
+  it('should return false when sync calls threshold is reached but a new minute has started', () => {
+    const spyOnGetCallsPerMinuteKey = jest.spyOn(SyncFrequencyGuard.prototype as any, 'getCallsPerMinuteKey')
+    spyOnGetCallsPerMinuteKey.mockReturnValueOnce('2020-1-1T1:1')
+
+    const useCase = createUseCase()
+
+    useCase.incrementCallsPerMinute()
+    useCase.incrementCallsPerMinute()
+    useCase.incrementCallsPerMinute()
+
+    spyOnGetCallsPerMinuteKey.mockReturnValueOnce('2020-1-1T1:2')
+
+    expect(useCase.isSyncCallsThresholdReachedThisMinute()).toBe(false)
+
+    spyOnGetCallsPerMinuteKey.mockRestore()
+  })
+})

packages/snjs/lib/Services/Sync/SyncFrequencyGuard.ts

@@ -0,0 +1,40 @@
+import { SyncFrequencyGuardInterface } from './SyncFrequencyGuardInterface'
+
+export class SyncFrequencyGuard implements SyncFrequencyGuardInterface {
+  private callsPerMinuteMap: Map<string, number>
+
+  constructor(private syncCallsThresholdPerMinute: number) {
+    this.callsPerMinuteMap = new Map<string, number>()
+  }
+
+  isSyncCallsThresholdReachedThisMinute(): boolean {
+    const stringDateToTheMinute = this.getCallsPerMinuteKey()
+    const persistedCallsCount = this.callsPerMinuteMap.get(stringDateToTheMinute) || 0
+
+    return persistedCallsCount >= this.syncCallsThresholdPerMinute
+  }
+
+  incrementCallsPerMinute(): void {
+    const stringDateToTheMinute = this.getCallsPerMinuteKey()
+    const persistedCallsCount = this.callsPerMinuteMap.get(stringDateToTheMinute)
+    const newMinuteStarted = persistedCallsCount === undefined
+
+    if (newMinuteStarted) {
+      this.clear()
+
+      this.callsPerMinuteMap.set(stringDateToTheMinute, 1)
+    } else {
+      this.callsPerMinuteMap.set(stringDateToTheMinute, persistedCallsCount + 1)
+    }
+  }
+
+  clear(): void {
+    this.callsPerMinuteMap.clear()
+  }
+
+  private getCallsPerMinuteKey(): string {
+    const now = new Date()
+
+    return `${now.getFullYear()}-${now.getMonth()}-${now.getDate()}T${now.getHours()}:${now.getMinutes()}`
+  }
+}

packages/snjs/lib/Services/Sync/SyncFrequencyGuardInterface.ts

@@ -0,0 +1,5 @@
+export interface SyncFrequencyGuardInterface {
+  incrementCallsPerMinute(): void
+  isSyncCallsThresholdReachedThisMinute(): boolean
+  clear(): void
+}

packages/snjs/lib/Services/Sync/SyncService.ts

@@ -97,6 +97,7 @@ import {
 import { CreatePayloadFromRawServerItem } from './Account/Utilities'
 import { DecryptedServerConflictMap, TrustedServerConflictMap } from './Account/ServerConflictMap'
 import { ContentType } from '@standardnotes/domain-core'
+import { SyncFrequencyGuardInterface } from './SyncFrequencyGuardInterface'
 
 const DEFAULT_MAJOR_CHANGE_THRESHOLD = 15
 const INVALID_SESSION_RESPONSE_STATUS = 401
@@ -169,6 +170,7 @@ export class SyncService
     private readonly options: ApplicationSyncOptions,
     private logger: LoggerInterface,
     private sockets: WebSocketsService,
+    private syncFrequencyGuard: SyncFrequencyGuardInterface,
     protected override internalEventBus: InternalEventBusInterface,
   ) {
     super(internalEventBus)
@@ -643,7 +645,8 @@ export class SyncService
     const syncInProgress = this.opStatus.syncInProgress
     const databaseLoaded = this.databaseLoaded
     const canExecuteSync = !this.syncLock
-    const shouldExecuteSync = canExecuteSync && databaseLoaded && !syncInProgress
+    const syncLimitReached = this.syncFrequencyGuard.isSyncCallsThresholdReachedThisMinute()
+    const shouldExecuteSync = canExecuteSync && databaseLoaded && !syncInProgress && !syncLimitReached
 
     if (shouldExecuteSync) {
       this.syncLock = true
@@ -1296,6 +1299,8 @@ export class SyncService
 
     this.lastSyncDate = new Date()
 
+    this.syncFrequencyGuard.incrementCallsPerMinute()
+
     if (operation instanceof AccountSyncOperation && operation.numberOfItemsInvolved >= this.majorChangeThreshold) {
       void this.notifyEvent(SyncEvent.MajorDataChange)
     }

packages/snjs/mocha/lib/AppContext.js

@@ -16,13 +16,14 @@ const MaximumSyncOptions = {
 let GlobalSubscriptionIdCounter = 1001
 
 export class AppContext {
-  constructor({ identifier, crypto, email, password, passcode, host } = {}) {
+  constructor({ identifier, crypto, email, password, passcode, host, syncCallsThresholdPerMinute } = {}) {
     this.identifier = identifier || `${Math.random()}`
     this.crypto = crypto
     this.email = email || UuidGenerator.GenerateUuid()
     this.password = password || UuidGenerator.GenerateUuid()
     this.passcode = passcode || 'mypasscode'
     this.host = host || Defaults.getDefaultHost()
+    this.syncCallsThresholdPerMinute = syncCallsThresholdPerMinute
   }
 
   enableLogging() {
@@ -46,6 +47,7 @@ export class AppContext {
       undefined,
       this.host,
       this.crypto || new FakeWebCrypto(),
+      this.syncCallsThresholdPerMinute,
     )
 
     this.application.dependencies.get(TYPES.Logger).setLevel('error')

packages/snjs/mocha/lib/Applications.js

@@ -2,7 +2,7 @@ import WebDeviceInterface from './web_device_interface.js'
 import FakeWebCrypto from './fake_web_crypto.js'
 import * as Defaults from './Defaults.js'
 
-export function createApplicationWithOptions({ identifier, environment, platform, host, crypto, device }) {
+export function createApplicationWithOptions({ identifier, environment, platform, host, crypto, device, syncCallsThresholdPerMinute }) {
   if (!device) {
     device = new WebDeviceInterface()
     device.environment = environment
@@ -22,11 +22,12 @@ export function createApplicationWithOptions({ identifier, environment, platform
     defaultHost: host || Defaults.getDefaultHost(),
     appVersion: Defaults.getAppVersion(),
     webSocketUrl: Defaults.getDefaultWebSocketUrl(),
+    syncCallsThresholdPerMinute,
   })
 }
 
-export function createApplication(identifier, environment, platform, host, crypto) {
-  return createApplicationWithOptions({ identifier, environment, platform, host, crypto })
+export function createApplication(identifier, environment, platform, host, crypto, syncCallsThresholdPerMinute) {
+  return createApplicationWithOptions({ identifier, environment, platform, host, crypto, syncCallsThresholdPerMinute })
 }
 
 export function createApplicationWithFakeCrypto(identifier, environment, platform, host) {

packages/snjs/mocha/lib/factory.js

@@ -43,16 +43,16 @@ export async function createAndInitSimpleAppContext(
   }
 }
 
-export async function createAppContextWithFakeCrypto(identifier, email, password) {
-  return createAppContext({ identifier, crypto: new FakeWebCrypto(), email, password })
+export async function createAppContextWithFakeCrypto(identifier, email, password, syncCallsThresholdPerMinute) {
+  return createAppContext({ identifier, crypto: new FakeWebCrypto(), email, password, syncCallsThresholdPerMinute })
 }
 
 export async function createAppContextWithRealCrypto(identifier) {
   return createAppContext({ identifier, crypto: new SNWebCrypto() })
 }
 
-export async function createAppContext({ identifier, crypto, email, password, host } = {}) {
-  const context = new AppContext({ identifier, crypto, email, password, host })
+export async function createAppContext({ identifier, crypto, email, password, host, syncCallsThresholdPerMinute } = {}) {
+  const context = new AppContext({ identifier, crypto, email, password, host, syncCallsThresholdPerMinute })
   await context.initialize()
   return context
 }