@livestore/common 0.3.2-dev.0 → 0.3.2-dev.1

package/src/sync/ClientSessionSyncProcessor.ts

@@ -1,14 +1,24 @@
 /// <reference lib="dom" />
 import { LS_DEV, shouldNeverHappen, TRACE_VERBOSE } from '@livestore/utils'
-import { Option, type Runtime, type Scope } from '@livestore/utils/effect'
-import { BucketQueue, Effect, FiberHandle, Queue, Schema, Stream, Subscribable } from '@livestore/utils/effect'
+import {
+  BucketQueue,
+  Effect,
+  FiberHandle,
+  Option,
+  Queue,
+  type Runtime,
+  Schema,
+  type Scope,
+  Stream,
+  Subscribable,
+} from '@livestore/utils/effect'
 import * as otel from '@opentelemetry/api'
 
-import { type ClientSession, SyncError, type UnexpectedError } from '../adapter-types.js'
-import * as EventSequenceNumber from '../schema/EventSequenceNumber.js'
-import * as LiveStoreEvent from '../schema/LiveStoreEvent.js'
-import { getEventDef, type LiveStoreSchema } from '../schema/mod.js'
-import * as SyncState from './syncstate.js'
+import { type ClientSession, SyncError, type UnexpectedError } from '../adapter-types.ts'
+import * as EventSequenceNumber from '../schema/EventSequenceNumber.ts'
+import * as LiveStoreEvent from '../schema/LiveStoreEvent.ts'
+import { getEventDef, type LiveStoreSchema } from '../schema/mod.ts'
+import * as SyncState from './syncstate.ts'
 
 /**
  * Rebase behaviour:
@@ -52,6 +62,7 @@ export const makeClientSessionSyncProcessor = ({
   span: otel.Span
   params: {
     leaderPushBatchSize: number
+    simulation?: ClientSessionSyncProcessorSimulationParams
   }
   /**
    * Currently only used in the web adapter:
@@ -61,6 +72,11 @@ export const makeClientSessionSyncProcessor = ({
 }): ClientSessionSyncProcessor => {
   const eventSchema = LiveStoreEvent.makeEventDefSchemaMemo(schema)
 
+  const simSleep = <TKey extends keyof ClientSessionSyncProcessorSimulationParams>(
+    key: TKey,
+    key2: keyof ClientSessionSyncProcessorSimulationParams[TKey],
+  ) => Effect.sleep((params.simulation?.[key]?.[key2] ?? 0) as number)
+
   const syncStateRef = {
     // The initial state is identical to the leader's initial state
     current: new SyncState.SyncState({
@@ -161,7 +177,6 @@ export const makeClientSessionSyncProcessor = ({
   const otelContext = otel.trace.setSpan(otel.context.active(), span)
 
   const boot: ClientSessionSyncProcessor['boot'] = Effect.gen(function* () {
-    // eslint-disable-next-line unicorn/prefer-global-this
     if (confirmUnsavedChanges && typeof window !== 'undefined' && typeof window.addEventListener === 'function') {
       const onBeforeUnload = (event: BeforeUnloadEvent) => {
         if (syncStateRef.current.pending.length > 0) {
@@ -230,19 +245,23 @@ export const makeClientSessionSyncProcessor = ({
 
             debugInfo.rebaseCount++
 
+            if (SIMULATION_ENABLED) yield* simSleep('pull', '1_before_leader_push_fiber_interrupt')
+
             yield* FiberHandle.clear(leaderPushingFiberHandle)
 
+            if (SIMULATION_ENABLED) yield* simSleep('pull', '2_before_leader_push_queue_clear')
+
             // Reset the leader push queue since we're rebasing and will push again
             yield* BucketQueue.clear(leaderPushQueue)
 
-            yield* FiberHandle.run(leaderPushingFiberHandle, backgroundLeaderPushing)
+            if (SIMULATION_ENABLED) yield* simSleep('pull', '3_before_rebase_rollback')
 
             if (LS_DEV) {
-              Effect.logDebug(
+              yield* Effect.logDebug(
                 'merge:pull:rebase: rollback',
                 mergeResult.rollbackEvents.length,
                 ...mergeResult.rollbackEvents.slice(0, 10).map((_) => _.toJSON()),
-              ).pipe(Effect.provide(runtime), Effect.runSync)
+              )
             }
 
             for (let i = mergeResult.rollbackEvents.length - 1; i >= 0; i--) {
@@ -253,8 +272,13 @@ export const makeClientSessionSyncProcessor = ({
               }
             }
 
-            // Pushing rebased pending events to leader
+            if (SIMULATION_ENABLED) yield* simSleep('pull', '4_before_leader_push_queue_offer')
+
             yield* BucketQueue.offerAll(leaderPushQueue, mergeResult.newSyncState.pending)
+
+            if (SIMULATION_ENABLED) yield* simSleep('pull', '5_before_leader_push_fiber_run')
+
+            yield* FiberHandle.run(leaderPushingFiberHandle, backgroundLeaderPushing)
           } else {
             span.addEvent('merge:pull:advance', {
               payloadTag: payload._tag,
@@ -353,3 +377,17 @@ export interface ClientSessionSyncProcessor {
     }
   }
 }
+
+// TODO turn this into a build-time "macro" so all simulation snippets are removed for production builds
+const SIMULATION_ENABLED = true
+
+export const ClientSessionSyncProcessorSimulationParams = Schema.Struct({
+  pull: Schema.Struct({
+    '1_before_leader_push_fiber_interrupt': Schema.Int.pipe(Schema.between(0, 1000)),
+    '2_before_leader_push_queue_clear': Schema.Int.pipe(Schema.between(0, 1000)),
+    '3_before_rebase_rollback': Schema.Int.pipe(Schema.between(0, 1000)),
+    '4_before_leader_push_queue_offer': Schema.Int.pipe(Schema.between(0, 1000)),
+    '5_before_leader_push_fiber_run': Schema.Int.pipe(Schema.between(0, 1000)),
+  }),
+})
+type ClientSessionSyncProcessorSimulationParams = typeof ClientSessionSyncProcessorSimulationParams.Type

package/src/sync/index.ts

@@ -1,3 +1,3 @@
-export * from './sync.js'
-export * from './validate-push-payload.js'
-export * from './ClientSessionSyncProcessor.js'
+export * from './ClientSessionSyncProcessor.ts'
+export * from './sync.ts'
+export * from './validate-push-payload.ts'

package/src/sync/next/compact-events.ts

@@ -1,8 +1,8 @@
-import { EventSequenceNumber } from '../../schema/mod.js'
-import { replacesFacts } from './facts.js'
-import { graphologyDag } from './graphology_.js'
-import type { HistoryDag } from './history-dag-common.js'
-import { emptyHistoryDag } from './history-dag-common.js'
+import { EventSequenceNumber } from '../../schema/mod.ts'
+import { replacesFacts } from './facts.ts'
+import { graphologyDag } from './graphology_.ts'
+import type { HistoryDag } from './history-dag-common.ts'
+import { emptyHistoryDag } from './history-dag-common.ts'
 
 /**
  * Idea:

package/src/sync/next/facts.ts

@@ -6,10 +6,10 @@ import type {
   EventDefFactsGroup,
   EventDefFactsSnapshot,
   FactsCallback,
-} from '../../schema/EventDef.js'
-import type * as EventSequenceNumber from '../../schema/EventSequenceNumber.js'
-import { graphologyDag } from './graphology_.js'
-import { EMPTY_FACT_VALUE, type HistoryDag, type HistoryDagNode } from './history-dag-common.js'
+} from '../../schema/EventDef.ts'
+import type * as EventSequenceNumber from '../../schema/EventSequenceNumber.ts'
+import { graphologyDag } from './graphology_.ts'
+import { EMPTY_FACT_VALUE, type HistoryDag, type HistoryDagNode } from './history-dag-common.ts'
 
 export const factsSnapshotForEvents = (
   events: HistoryDagNode[],

package/src/sync/next/graphology.ts

@@ -13,11 +13,9 @@ export declare class IGraph<
   constructor(options?: graphologyTypes.GraphOptions)
 }
 
-export const DirectedGraph = class DirectedGraph extends graphology.DirectedGraph {
-} as typeof IGraph
+export const DirectedGraph = class DirectedGraph extends graphology.DirectedGraph {} as typeof IGraph
 
-export const Graph = class Graph extends graphology.Graph {
-} as typeof IGraph
+export const Graph = class Graph extends graphology.Graph {} as typeof IGraph
 
 // export const graphology = graphology_ as graphologyTypes
 

package/src/sync/next/graphology_.ts

@@ -1,2 +1,2 @@
-export * as graphology from './graphology.js'
 export { default as graphologyDag } from 'graphology-dag'
+export * as graphology from './graphology.ts'

package/src/sync/next/history-dag-common.ts

@@ -1,6 +1,6 @@
-import type { EventDefFactsGroup } from '../../schema/EventDef.js'
-import * as EventSequenceNumber from '../../schema/EventSequenceNumber.js'
-import { graphology } from './graphology_.js'
+import type { EventDefFactsGroup } from '../../schema/EventDef.ts'
+import * as EventSequenceNumber from '../../schema/EventSequenceNumber.ts'
+import { graphology } from './graphology_.ts'
 
 export const connectionTypeOptions = ['parent', 'facts'] as const
 export type ConnectionType = (typeof connectionTypeOptions)[number]

package/src/sync/next/history-dag.ts

@@ -1,6 +1,6 @@
-import * as EventSequenceNumber from '../../schema/EventSequenceNumber.js'
-import { factsToString, validateFacts } from './facts.js'
-import { emptyHistoryDag, type HistoryDagNode, rootParentNum } from './history-dag-common.js'
+import * as EventSequenceNumber from '../../schema/EventSequenceNumber.ts'
+import { factsToString, validateFacts } from './facts.ts'
+import { emptyHistoryDag, type HistoryDagNode, rootParentNum } from './history-dag-common.ts'
 
 export const historyDagFromNodes = (dagNodes: HistoryDagNode[], options?: { skipFactsCheck: boolean }) => {
   if (options?.skipFactsCheck !== true) {

package/src/sync/next/mod.ts

@@ -1,5 +1,5 @@
-export * from './history-dag-common.js'
-export * from './history-dag.js'
-export * from './facts.js'
-export * from './compact-events.js'
-export * from './rebase-events.js'
+export * from './compact-events.ts'
+export * from './facts.ts'
+export * from './history-dag.ts'
+export * from './history-dag-common.ts'
+export * from './rebase-events.ts'

package/src/sync/next/rebase-events.ts

@@ -1,14 +1,14 @@
-import type { EventDef, EventDefFactsSnapshot } from '../../schema/EventDef.js'
-import * as EventSequenceNumber from '../../schema/EventSequenceNumber.js'
-import type * as LiveStoreEvent from '../../schema/LiveStoreEvent.js'
+import type { EventDef, EventDefFactsSnapshot } from '../../schema/EventDef.ts'
+import * as EventSequenceNumber from '../../schema/EventSequenceNumber.ts'
+import type * as LiveStoreEvent from '../../schema/LiveStoreEvent.ts'
 import {
   applyFactGroups,
-  factsIntersect,
   type FactValidationResult,
+  factsIntersect,
   getFactsGroupForEventArgs,
   validateFacts,
-} from './facts.js'
-import type { HistoryDagNode } from './history-dag-common.js'
+} from './facts.ts'
+import type { HistoryDagNode } from './history-dag-common.ts'
 
 export type RebaseEventWithConflict = HistoryDagNode & {
   conflictType: 'overlap' | 'missing-requirement'

package/src/sync/next/test/compact-events.calculator.test.ts

@@ -2,10 +2,10 @@ import { defineEvent } from '@livestore/common/schema'
 import { Schema } from '@livestore/utils/effect'
 import { describe, expect, it } from 'vitest'
 
-import { compactEvents } from '../compact-events.js'
-import { historyDagFromNodes } from '../history-dag.js'
-import { customSerializer } from './compact-events.test.js'
-import { printEvent, toEventNodes } from './event-fixtures.js'
+import { compactEvents } from '../compact-events.ts'
+import { historyDagFromNodes } from '../history-dag.ts'
+import { customSerializer } from './compact-events.test.ts'
+import { printEvent, toEventNodes } from './event-fixtures.ts'
 
 expect.addSnapshotSerializer(customSerializer)
 

package/src/sync/next/test/compact-events.test.ts

@@ -1,11 +1,11 @@
 import type { EventDefFacts } from '@livestore/common/schema'
 import { describe, expect, it } from 'vitest'
 
-import { compactEvents } from '../compact-events.js'
-import { historyDagFromNodes } from '../history-dag.js'
-import type { HistoryDagNode } from '../history-dag-common.js'
-import { EMPTY_FACT_VALUE } from '../history-dag-common.js'
-import { events as eventDefs, printEvent, toEventNodes } from './event-fixtures.js'
+import { compactEvents } from '../compact-events.ts'
+import { historyDagFromNodes } from '../history-dag.ts'
+import type { HistoryDagNode } from '../history-dag-common.ts'
+import { EMPTY_FACT_VALUE } from '../history-dag-common.ts'
+import { events as eventDefs, printEvent, toEventNodes } from './event-fixtures.ts'
 
 const customStringify = (value: any): string => {
   if (value === null) {

package/src/sync/next/test/event-fixtures.ts

@@ -1,12 +1,12 @@
 import { Schema } from '@livestore/utils/effect'
 
-import type { EventDef } from '../../../schema/EventDef.js'
-import { defineEvent, defineFacts } from '../../../schema/EventDef.js'
-import * as EventSequenceNumber from '../../../schema/EventSequenceNumber.js'
-import { factsSnapshotForDag, getFactsGroupForEventArgs } from '../facts.js'
-import { historyDagFromNodes } from '../history-dag.js'
-import type { HistoryDagNode } from '../history-dag-common.js'
-import { rootEventNode } from '../history-dag-common.js'
+import type { EventDef } from '../../../schema/EventDef.ts'
+import { defineEvent, defineFacts } from '../../../schema/EventDef.ts'
+import * as EventSequenceNumber from '../../../schema/EventSequenceNumber.ts'
+import { factsSnapshotForDag, getFactsGroupForEventArgs } from '../facts.ts'
+import { historyDagFromNodes } from '../history-dag.ts'
+import type { HistoryDagNode } from '../history-dag-common.ts'
+import { rootEventNode } from '../history-dag-common.ts'
 
 export const printEvent = ({ seqNum, parentSeqNum, factsGroup, ...rest }: HistoryDagNode) => ({
   seqNum: EventSequenceNumber.toString(seqNum),

package/src/sync/next/test/mod.ts

@@ -1 +1 @@
-export * from './event-fixtures.js'
+export * from './event-fixtures.ts'

package/src/sync/sync.ts

@@ -1,10 +1,10 @@
 import type { Effect, HttpClient, Option, Scope, Stream, SubscriptionRef } from '@livestore/utils/effect'
 import { Schema } from '@livestore/utils/effect'
 
-import type { UnexpectedError } from '../adapter-types.js'
-import type { InitialSyncOptions } from '../leader-thread/types.js'
-import * as EventSequenceNumber from '../schema/EventSequenceNumber.js'
-import type * as LiveStoreEvent from '../schema/LiveStoreEvent.js'
+import type { UnexpectedError } from '../adapter-types.ts'
+import type { InitialSyncOptions } from '../leader-thread/types.ts'
+import * as EventSequenceNumber from '../schema/EventSequenceNumber.ts'
+import type * as LiveStoreEvent from '../schema/LiveStoreEvent.ts'
 
 /**
  * Those arguments can be used to implement multi-tenancy etc and are passed in from the store.

package/src/sync/syncstate.test.ts

@@ -1,16 +1,17 @@
-/* eslint-disable prefer-arrow/prefer-arrow-functions */
 import { describe, expect, it } from 'vitest'
 
-import * as EventSequenceNumber from '../schema/EventSequenceNumber.js'
-import * as LiveStoreEvent from '../schema/LiveStoreEvent.js'
-import * as SyncState from './syncstate.js'
+import * as EventSequenceNumber from '../schema/EventSequenceNumber.ts'
+import * as LiveStoreEvent from '../schema/LiveStoreEvent.ts'
+import * as SyncState from './syncstate.ts'
 
 class TestEvent extends LiveStoreEvent.EncodedWithMeta {
+  public readonly payload: string
+  public readonly isClient: boolean
   constructor(
     seqNum: EventSequenceNumber.EventSequenceNumberInput,
     parentSeqNum: EventSequenceNumber.EventSequenceNumberInput,
-    public readonly payload: string,
-    public readonly isClient: boolean,
+    payload: string,
+    isClient: boolean,
   ) {
     super({
       seqNum: EventSequenceNumber.make(seqNum),
@@ -20,6 +21,8 @@ class TestEvent extends LiveStoreEvent.EncodedWithMeta {
       clientId: 'static-local-id',
       sessionId: 'static-session-id',
     })
+    this.payload = payload
+    this.isClient = isClient
   }
 
   rebase_ = (parentSeqNum: EventSequenceNumber.EventSequenceNumber, rebaseGeneration: number) => {

package/src/sync/syncstate.ts

@@ -1,8 +1,8 @@
 import { casesHandled, LS_DEV, shouldNeverHappen } from '@livestore/utils'
 import { Match, ReadonlyArray, Schema } from '@livestore/utils/effect'
 
-import * as EventSequenceNumber from '../schema/EventSequenceNumber.js'
-import * as LiveStoreEvent from '../schema/LiveStoreEvent.js'
+import * as EventSequenceNumber from '../schema/EventSequenceNumber.ts'
+import * as LiveStoreEvent from '../schema/LiveStoreEvent.ts'
 
 /**
  * SyncState represents the current sync state of a sync node relative to an upstream node.

package/src/sync/validate-push-payload.ts

@@ -1,7 +1,7 @@
 import { Effect } from '@livestore/utils/effect'
 
-import type { EventSequenceNumber, LiveStoreEvent } from '../schema/mod.js'
-import { InvalidPushError } from './sync.js'
+import type { EventSequenceNumber, LiveStoreEvent } from '../schema/mod.ts'
+import { InvalidPushError } from './sync.ts'
 
 // TODO proper batch validation
 export const validatePushPayload = (

package/src/util.ts

@@ -30,7 +30,6 @@ export const sql = (template: TemplateStringsArray, ...args: unknown[]): string
     str += template[i] + String(arg)
   }
 
-  // eslint-disable-next-line unicorn/prefer-at
   return str + template[template.length - 1]
 }
 

package/src/version.ts

@@ -2,7 +2,7 @@
 // import packageJson from '../package.json' with { type: 'json' }
 // export const liveStoreVersion = packageJson.version
 
-export const liveStoreVersion = '0.3.2-dev.0' as const
+export const liveStoreVersion = '0.3.2-dev.1' as const
 
 /**
  * This version number is incremented whenever the internal storage format changes in a breaking way.