musora-content-services 2.107.8 → 2.110.3

package/src/services/sync/store-configs.ts

@@ -2,18 +2,20 @@ import { SyncStoreConfig } from "./store"
 import { ContentLike, ContentProgress, Practice, UserAwardProgress, PracticeDayNote } from "./models"
 import { handlePull, handlePush, makeFetchRequest } from "./fetch"
 
-import type SyncStore from "./store"
 import type BaseModel from "./models/Base"
 
-export default function createStoresFromConfig(createStore: <TModel extends BaseModel>(config: SyncStoreConfig<TModel>) => SyncStore<TModel>) {
+// keeps type-safety in each entry
+const c = <TModel extends BaseModel>(config: SyncStoreConfig<TModel>) => config
+
+export default function createStoresFromConfig() {
   return [
-    createStore({
+    c({
       model: ContentLike,
       pull: handlePull(makeFetchRequest('/api/content/v1/user/likes')),
       push: handlePush(makeFetchRequest('/api/content/v1/user/likes', { method: 'POST' })),
     }),
 
-    createStore({
+    c({
       model: ContentProgress,
       comparator: (server, local) => {
         if (server.record.progress_percent === 0 || local.progress_percent === 0) {
@@ -26,22 +28,22 @@ export default function createStoresFromConfig(createStore: <TModel extends Base
       push: handlePush(makeFetchRequest('/content/user/progress', { method: 'POST' })),
     }),
 
-    createStore({
+    c({
       model: Practice,
       pull: handlePull(makeFetchRequest('/api/user/practices/v1')),
       push: handlePush(makeFetchRequest('/api/user/practices/v1', { method: 'POST' })),
     }),
 
-    createStore({
+    c({
       model: PracticeDayNote,
       pull: handlePull(makeFetchRequest('/api/user/practices/v1/notes')),
       push: handlePush(makeFetchRequest('/api/user/practices/v1/notes', { method: 'POST' })),
     }),
 
-    createStore({
+    c({
       model: UserAwardProgress,
       pull: handlePull(makeFetchRequest('/api/content/v1/user/awards')),
       push: handlePush(makeFetchRequest('/api/content/v1/user/awards', { method: 'POST' })),
     })
-  ] as unknown as SyncStore<BaseModel>[]
+  ]
 }

package/src/services/sync/telemetry/flood-prevention.ts

@@ -0,0 +1,27 @@
+import { SyncTelemetry, type SentryBrowserOptions } from ".";
+
+export function errorHandler(event: ErrorEvent) {
+  if (SyncTelemetry.getInstance()?.shouldIgnoreException(event.error)) {
+    event.preventDefault() // doesn't reliably work in all browsers - error still logged to console
+  }
+}
+
+export function rejectionHandler(event: PromiseRejectionEvent) {
+  if (SyncTelemetry.getInstance()?.shouldIgnoreRejection(event.reason)) {
+    event.preventDefault()
+  }
+}
+
+type ReturnsUndefined<T extends (...args: any[]) => any> = (...args: Parameters<T>) => ReturnType<T> | undefined
+
+/**
+ * Sentry beforeSend hook to prevent sending events for ignored exceptions,
+ * namely numerous eager watermelon queries that fail after IndexedDB failure
+ */
+export const floodPreventionSentryBeforeSend: ReturnsUndefined<NonNullable<SentryBrowserOptions['beforeSend']>> = (_event, hint) => {
+  if (hint?.originalException && SyncTelemetry.getInstance()?.shouldIgnoreException(hint.originalException)) {
+    return null
+  }
+
+  return undefined
+}

package/src/services/sync/telemetry/index.ts

@@ -15,6 +15,15 @@ export type Span = InjectedSentry.Span
 
 export const SYNC_TELEMETRY_TRACE_PREFIX = 'sync:'
 
+export enum SeverityLevel {
+  DEBUG = 0,
+  INFO = 1,
+  LOG = 2,
+  WARNING = 3,
+  ERROR = 4,
+  FATAL = 5
+}
+
 export class SyncTelemetry {
   private static instance: SyncTelemetry | null = null
 
@@ -33,13 +42,20 @@ export class SyncTelemetry {
 
   private userId: string
   private Sentry: SentryLike;
+  private level: SeverityLevel
+  private pretty: boolean
+
+  private ignorePatterns: (string | RegExp)[] = []
 
   // allows us to know if Sentry shouldn't double-capture a dev-prettified console.error log
   private _ignoreConsole = false
 
-  constructor(userId: string, { Sentry }: { Sentry: SentryLike }) {
+  constructor(userId: string, { Sentry, level, pretty }: { Sentry: SentryLike, level?: keyof typeof SeverityLevel, pretty?: boolean }) {
     this.userId = userId
     this.Sentry = Sentry
+    this.level = typeof level !== 'undefined' && level in SeverityLevel ? SeverityLevel[level] : SeverityLevel.LOG
+    this.pretty = typeof pretty !== 'undefined' ? pretty : true
+
     watermelonLogger.log = (...messages: any[]) => this.log('[Watermelon]', ...messages);
     watermelonLogger.warn = (...messages: any[]) => this.warn('[Watermelon]', ...messages);
     watermelonLogger.error = (...messages: any[]) => this.error('[Watermelon]', ...messages);
@@ -67,8 +83,10 @@ export class SyncTelemetry {
     })
   }
 
-  capture(err: SyncError) {
-    err.markReported()
+  capture(err: Error, context = {}) {
+    const wrapped = err instanceof SyncError ? err : new SyncUnexpectedError((err as Error).message, context);
+
+    wrapped.markReported()
     this.Sentry.captureException(err, err instanceof SyncUnexpectedError ? {
       mechanism: {
         handled: false
@@ -85,33 +103,59 @@ export class SyncTelemetry {
     return this._ignoreConsole
   }
 
+  /**
+   * Ignore messages/errors in the future that match provided patterns
+   */
+  ignoreLike(...patterns: (RegExp | string)[]) {
+    this.ignorePatterns.push(...patterns)
+  }
+
+  shouldIgnoreRejection(reason: any) {
+    const message = reason instanceof Error ? `${reason.name}: ${reason.message}` : reason
+    return this.shouldIgnoreMessage(message)
+  }
+
+  shouldIgnoreException(exception: unknown) {
+    if (exception instanceof Error) {
+      return this.shouldIgnoreMessage(exception.message)
+    }
+
+    return false
+  }
+
+  shouldIgnoreMessages(messages: any[]) {
+    return messages.some(message => {
+      return this.shouldIgnoreMessage(message)
+    })
+  }
+
   debug(...messages: any[]) {
-    console.debug(...this.formattedConsoleMessages(...messages));
+    this.level <= SeverityLevel.DEBUG && !this.shouldIgnoreMessages(messages) && console.debug(...this.formattedConsoleMessages(...messages));
     this.recordBreadcrumb('debug', ...messages)
   }
 
   info(...messages: any[]) {
-    console.info(...this.formattedConsoleMessages(...messages));
+    this.level <= SeverityLevel.INFO && !this.shouldIgnoreMessages(messages) && console.info(...this.formattedConsoleMessages(...messages));
     this.recordBreadcrumb('info', ...messages)
   }
 
   log(...messages: any[]) {
-    console.log(...this.formattedConsoleMessages(...messages));
+    this.level <= SeverityLevel.LOG && !this.shouldIgnoreMessages(messages) && console.log(...this.formattedConsoleMessages(...messages));
     this.recordBreadcrumb('log', ...messages)
   }
 
   warn(...messages: any[]) {
-    console.warn(...this.formattedConsoleMessages(...messages));
+    this.level <= SeverityLevel.WARNING && !this.shouldIgnoreMessages(messages) && console.warn(...this.formattedConsoleMessages(...messages));
     this.recordBreadcrumb('warning', ...messages)
   }
 
   error(...messages: any[]) {
-    console.error(...this.formattedConsoleMessages(...messages));
+    this.level <= SeverityLevel.ERROR && !this.shouldIgnoreMessages(messages) && console.error(...this.formattedConsoleMessages(...messages));
     this.recordBreadcrumb('error', ...messages)
   }
 
   fatal(...messages: any[]) {
-    console.error(...this.formattedConsoleMessages(...messages));
+    this.level <= SeverityLevel.FATAL && !this.shouldIgnoreMessages(messages) && console.error(...this.formattedConsoleMessages(...messages));
     this.recordBreadcrumb('fatal', ...messages)
   }
 
@@ -124,6 +168,10 @@ export class SyncTelemetry {
   }
 
   private formattedConsoleMessages(...messages: any[]) {
+    if (!this.pretty) {
+      return messages
+    }
+
     const date = new Date();
     return [...this.consolePrefix(date), ...messages, ...this.consoleSuffix(date)];
   }
@@ -136,4 +184,18 @@ export class SyncTelemetry {
   private consoleSuffix(date: Date) {
     return [` [${date.toLocaleTimeString()}, ${date.getTime()}]`];
   }
+
+  private shouldIgnoreMessage(message: any) {
+    if (message instanceof Error) message = message.message
+    if (typeof message !== 'string') return false
+
+    return this.ignorePatterns.some(pattern => {
+      if (typeof pattern === 'string') {
+        return message.indexOf(pattern) !== -1
+      } else if (pattern instanceof RegExp) {
+        return pattern.test(message)
+      }
+      return false
+    })
+  }
 }

package/src/services/sync/telemetry/sampling.ts

@@ -38,16 +38,12 @@ export const syncSentryBeforeSendTransaction: ReturnsUndefined<NonNullable<Sentr
 
 // sentry doesn't bother to expose your chosen environment in tracesSampler
 // so we have to make consumers pass in our greedy option
-export const createSyncSentryTracesSampler = (greedy = false) => {
+export const createSyncSentryTracesSampler = () => {
   const sampler: ReturnsUndefined<NonNullable<SentryBrowserOptions['tracesSampler']>> = (context) => {
     if (!context.name.startsWith(SYNC_TELEMETRY_TRACE_PREFIX)) {
       return undefined
     }
 
-    if (greedy) {
-      return true
-    }
-
     const { parentSampled, attributes } = context
 
     if (parentSampled) {
@@ -58,7 +54,7 @@ export const createSyncSentryTracesSampler = (greedy = false) => {
       return userBucketedSampler(attributes.userId as string | number, 0.1)
     }
 
-    return false
+    return undefined
   }
 
   return sampler

package/src/services/user/types.d.ts

@@ -5,13 +5,6 @@ export interface BrandMethodLevels {
   singeo: string
 }
 
-export interface BrandTotalXp {
-  drumeo: string
-  pianote: string
-  guitareo: string
-  singeo: string
-}
-
 export interface BrandTimePracticed {
   drumeo: number
   pianote: number

package/test/sync/adapter.ts

@@ -1,41 +1,9 @@
 import adapterFactory from '../../src/services/sync/adapters/factory'
 import LokiJSAdapter from '../../src/services/sync/adapters/lokijs'
-import EventEmitter from '../../src/services/sync/utils/event-emitter'
 
-export default function syncStoreAdapter(userId: string, bus: SyncAdapterEventBus) {
+export default function syncStoreAdapter(userId: string) {
   return adapterFactory(LokiJSAdapter, `user:${userId}`, {
     useWebWorker: false,
-    useIncrementalIndexedDB: true,
-    extraLokiOptions: {
-      autosave: true,
-      autosaveInterval: 300, // increase for better performance at cost of potential data loss on tab close/crash
-    },
-    onQuotaExceededError: () => {
-      // Browser ran out of disk space or possibly in incognito mode
-      // called ONLY at startup
-      // ideal place to trigger banner (?) to user when also offline?
-      // (so that the non-customizable browser default onbeforeunload confirmation (in offline-unload-warning.ts) has context and makes sense)
-      bus.emit('quotaExceededError')
-    },
-    onSetUpError: () => {
-      // TODO - Database failed to load -- offer the user to reload the app or log out
-    },
-    extraIncrementalIDBOptions: {
-      lazyCollections: ['content_like'],
-      onDidOverwrite: () => {
-        // Called when this adapter is forced to overwrite contents of IndexedDB.
-        // This happens if there's another open tab of the same app that's making changes.
-        // this scenario is handled-ish in `idb-clobber-avoidance`
-      },
-      onversionchange: () => {
-        // no-op
-        // indexeddb was deleted in another browser tab (user logged out), so we must make sure we delete
-        // in-memory db in this tab as well,
-        // but we rely on sync manager setup/teardown to `unsafeResetDatabase` and redirect for this,
-        // though reloading the page might be useful as well
-      },
-    },
+    useIncrementalIndexedDB: true
   })
 }
-
-export class SyncAdapterEventBus extends EventEmitter<{ quotaExceededError: [] }> {}

package/test/sync/initialize-sync-manager.js

@@ -1,16 +1,6 @@
 import { SyncManager, SyncContext } from '../../src/services/sync/index'
-import {
-  BaseSessionProvider,
-  BaseConnectivityProvider,
-  BaseDurabilityProvider,
-  BaseTabsProvider,
-  BaseVisibilityProvider,
-} from '../../src/services/sync/context/providers/'
-import adapterFactory from '../../src/services/sync/adapters/factory'
-import LokiJSAdapter from '../../src/services/sync/adapters/lokijs'
-import EventEmitter from '../../src/services/sync/utils/event-emitter'
-import { InitialStrategy, PollingStrategy } from '../../src/services/sync/strategies/index'
-import { SyncTelemetry, SentryLike } from '../../src/services/sync/telemetry/index'
+import { InitialStrategy } from '../../src/services/sync/strategies/index'
+import { SyncTelemetry, SeverityLevel, SentryLike } from '../../src/services/sync/telemetry/index'
 import {
   ContentLike,
   ContentProgress,
@@ -19,7 +9,7 @@ import {
 } from '../../src/services/sync/models/index'
 import syncDatabaseFactory from '../../src/services/sync/database/factory'
 
-import syncAdapter, { SyncAdapterEventBus } from './adapter'
+import syncAdapter from './adapter'
 
 export function initializeSyncManager(userId) {
   if (SyncManager.getInstanceOrNull()) {
@@ -45,10 +35,9 @@ export function initializeSyncManager(userId) {
     },
   }
 
-  SyncTelemetry.setInstance(new SyncTelemetry(userId, { Sentry: dummySentry }))
+  SyncTelemetry.setInstance(new SyncTelemetry(userId, { Sentry: dummySentry, level: SeverityLevel.WARNING, pretty: false }))
 
-  const adapterBus = new SyncAdapterEventBus()
-  const adapter = syncAdapter(userId, adapterBus)
+  const adapter = syncAdapter(userId)
   const db = syncDatabaseFactory(adapter)
 
   const context = new SyncContext({
@@ -88,16 +77,10 @@ export function initializeSyncManager(userId) {
   const manager = new SyncManager(context, db)
 
   const initialStrategy = manager.createStrategy(InitialStrategy)
-  const aggressivePollingStrategy = manager.createStrategy(PollingStrategy, 3600_000)
-
-  manager.syncStoresWithStrategies(
-    manager.storesForModels([ContentLike, ContentProgress, Practice, PracticeDayNote]),
-    [initialStrategy, aggressivePollingStrategy]
-  )
 
-  manager.protectStores(
-    manager.storesForModels([ContentLike, ContentProgress, Practice, PracticeDayNote]),
-    []
+  manager.registerStrategies(
+    [ContentLike, ContentProgress, Practice, PracticeDayNote],
+    [initialStrategy]
   )
 
   SyncManager.assignAndSetupInstance(manager)

package/.claude/settings.local.json

@@ -1,9 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(rg:*)",
-      "Bash(npm run lint:*)"
-    ],
-    "deny": []
-  }
-}

package/src/services/sync/concurrency-safety.ts

@@ -1,4 +0,0 @@
-import type SyncContext from "./context"
-import type SyncStore from "./store"
-
-export type SyncConcurrencySafetyMechanism = (context: SyncContext, stores: SyncStore[]) => () => void