@livestore/common 0.3.0-dev.10 → 0.3.0-dev.2

package/dist/sync/ClientSessionSyncProcessor.js

@@ -1,134 +0,0 @@
-import { LS_DEV, shouldNeverHappen, TRACE_VERBOSE } from '@livestore/utils';
-import { Effect, Schema, Stream } from '@livestore/utils/effect';
-import * as otel from '@opentelemetry/api';
-import * as EventId from '../schema/EventId.js';
-import * as MutationEvent from '../schema/MutationEvent.js';
-import { SyncState, updateSyncState } from './syncstate.js';
-/**
- * Rebase behaviour:
- * - We continously pull mutations from the leader and apply them to the local store.
- * - If there was a race condition (i.e. the leader and client session have both advacned),
- *   we'll need to rebase the local pending mutations on top of the leader's head.
- * - The goal is to never block the UI, so we'll interrupt rebasing if a new mutations is pushed by the client session.
- * - We also want to avoid "backwards-jumping" in the UI, so we'll transactionally apply a read model changes during a rebase.
- * - We might need to make the rebase behaviour configurable e.g. to let users manually trigger a rebase
- */
-export const makeClientSessionSyncProcessor = ({ schema, initialLeaderHead, pushToLeader, pullFromLeader, applyMutation, rollback, refreshTables, span, }) => {
-    const mutationEventSchema = MutationEvent.makeMutationEventSchemaMemo(schema);
-    const syncStateRef = {
-        current: new SyncState({
-            localHead: initialLeaderHead,
-            upstreamHead: initialLeaderHead,
-            pending: [],
-            // TODO init rollbackTail from leader to be ready for backend rebasing
-            rollbackTail: [],
-        }),
-    };
-    const isLocalEvent = (mutationEventEncoded) => {
-        const mutationDef = schema.mutations.get(mutationEventEncoded.mutation);
-        return mutationDef.options.localOnly;
-    };
-    const push = (batch, { otelContext }) => {
-        // TODO validate batch
-        let baseEventId = syncStateRef.current.localHead;
-        const encodedMutationEvents = batch.map((mutationEvent) => {
-            const mutationDef = schema.mutations.get(mutationEvent.mutation);
-            const nextIdPair = EventId.nextPair(baseEventId, mutationDef.options.localOnly);
-            baseEventId = nextIdPair.id;
-            return new MutationEvent.EncodedWithMeta(Schema.encodeUnknownSync(mutationEventSchema)({ ...mutationEvent, ...nextIdPair }));
-        });
-        const updateResult = updateSyncState({
-            syncState: syncStateRef.current,
-            payload: { _tag: 'local-push', newEvents: encodedMutationEvents },
-            isLocalEvent,
-            isEqualEvent: MutationEvent.isEqualEncoded,
-        });
-        span.addEvent('local-push', {
-            batchSize: encodedMutationEvents.length,
-            updateResult: TRACE_VERBOSE ? JSON.stringify(updateResult) : undefined,
-        });
-        if (updateResult._tag !== 'advance') {
-            return shouldNeverHappen(`Expected advance, got ${updateResult._tag}`);
-        }
-        syncStateRef.current = updateResult.newSyncState;
-        const writeTables = new Set();
-        for (const mutationEvent of updateResult.newEvents) {
-            // TODO avoid encoding and decoding here again
-            const decodedMutationEvent = Schema.decodeSync(mutationEventSchema)(mutationEvent);
-            const res = applyMutation(decodedMutationEvent, { otelContext, withChangeset: true });
-            for (const table of res.writeTables) {
-                writeTables.add(table);
-            }
-            mutationEvent.meta.sessionChangeset = res.sessionChangeset;
-        }
-        // console.debug('pushToLeader', encodedMutationEvents.length, ...encodedMutationEvents.map((_) => _.toJSON()))
-        pushToLeader(encodedMutationEvents);
-        return { writeTables };
-    };
-    const otelContext = otel.trace.setSpan(otel.context.active(), span);
-    const boot = Effect.gen(function* () {
-        yield* pullFromLeader.pipe(Stream.tap(({ payload, remaining }) => Effect.gen(function* () {
-            // console.log('pulled payload from leader', { payload, remaining })
-            const updateResult = updateSyncState({
-                syncState: syncStateRef.current,
-                payload,
-                isLocalEvent,
-                isEqualEvent: MutationEvent.isEqualEncoded,
-            });
-            if (updateResult._tag === 'reject') {
-                debugger;
-                throw new Error('TODO: implement reject in client-session-sync-queue for pull');
-            }
-            syncStateRef.current = updateResult.newSyncState;
-            if (updateResult._tag === 'rebase') {
-                span.addEvent('pull:rebase', {
-                    payloadTag: payload._tag,
-                    payload: TRACE_VERBOSE ? JSON.stringify(payload) : undefined,
-                    newEventsCount: updateResult.newEvents.length,
-                    rollbackCount: updateResult.eventsToRollback.length,
-                    res: TRACE_VERBOSE ? JSON.stringify(updateResult) : undefined,
-                    remaining,
-                });
-                if (LS_DEV) {
-                    console.debug('pull:rebase: rollback', updateResult.eventsToRollback.length, ...updateResult.eventsToRollback.map((_) => _.toJSON()));
-                }
-                for (let i = updateResult.eventsToRollback.length - 1; i >= 0; i--) {
-                    const event = updateResult.eventsToRollback[i];
-                    if (event.meta.sessionChangeset) {
-                        rollback(event.meta.sessionChangeset);
-                        event.meta.sessionChangeset = undefined;
-                    }
-                }
-                pushToLeader(updateResult.newSyncState.pending);
-            }
-            else {
-                span.addEvent('pull:advance', {
-                    payloadTag: payload._tag,
-                    payload: TRACE_VERBOSE ? JSON.stringify(payload) : undefined,
-                    newEventsCount: updateResult.newEvents.length,
-                    res: TRACE_VERBOSE ? JSON.stringify(updateResult) : undefined,
-                    remaining,
-                });
-            }
-            if (updateResult.newEvents.length === 0)
-                return;
-            const writeTables = new Set();
-            for (const mutationEvent of updateResult.newEvents) {
-                const decodedMutationEvent = Schema.decodeSync(mutationEventSchema)(mutationEvent);
-                const res = applyMutation(decodedMutationEvent, { otelContext, withChangeset: true });
-                for (const table of res.writeTables) {
-                    writeTables.add(table);
-                }
-                mutationEvent.meta.sessionChangeset = res.sessionChangeset;
-            }
-            refreshTables(writeTables);
-        })), Stream.runDrain, Effect.forever, // NOTE Whenever the leader changes, we need to re-start the stream
-        Effect.tapCauseLogPretty, Effect.forkScoped);
-    });
-    return {
-        push,
-        boot,
-        syncStateRef,
-    };
-};
-//# sourceMappingURL=ClientSessionSyncProcessor.js.map

package/dist/sync/ClientSessionSyncProcessor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ClientSessionSyncProcessor.js","sourceRoot":"","sources":["../../src/sync/ClientSessionSyncProcessor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAE3E,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAChE,OAAO,KAAK,IAAI,MAAM,oBAAoB,CAAA;AAG1C,OAAO,KAAK,OAAO,MAAM,sBAAsB,CAAA;AAE/C,OAAO,KAAK,aAAa,MAAM,4BAA4B,CAAA;AAC3D,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAE3D;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,EAC7C,MAAM,EACN,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,aAAa,EACb,QAAQ,EACR,aAAa,EACb,IAAI,GAgBL,EAA8B,EAAE;IAC/B,MAAM,mBAAmB,GAAG,aAAa,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAA;IAE7E,MAAM,YAAY,GAAG;QACnB,OAAO,EAAE,IAAI,SAAS,CAAC;YACrB,SAAS,EAAE,iBAAiB;YAC5B,YAAY,EAAE,iBAAiB;YAC/B,OAAO,EAAE,EAAE;YACX,sEAAsE;YACtE,YAAY,EAAE,EAAE;SACjB,CAAC;KACH,CAAA;IAED,MAAM,YAAY,GAAG,CAAC,oBAAmD,EAAE,EAAE;QAC3E,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,oBAAoB,CAAC,QAAQ,CAAE,CAAA;QACxE,OAAO,WAAW,CAAC,OAAO,CAAC,SAAS,CAAA;IACtC,CAAC,CAAA;IAED,MAAM,IAAI,GAAuC,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;QAC1E,sBAAsB;QAEtB,IAAI,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC,SAAS,CAAA;QAChD,MAAM,qBAAqB,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE;YACxD,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAE,CAAA;YACjE,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;YAC/E,WAAW,GAAG,UAAU,CAAC,EAAE,CAAA;YAC3B,OAAO,IAAI,aAAa,CAAC,eAAe,CACtC,MAAM,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC,EAAE,GAAG,aAAa,EAAE,GAAG,UAAU,EAAE,CAAC,CACnF,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,MAAM,YAAY,GAAG,eAAe,CAAC;YACnC,SAAS,EAAE,YAAY,CAAC,OAAO;YAC/B,OAAO,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,qBAAqB,EAAE;YACjE,YAAY;YACZ,YAAY,EAAE,aAAa,CAAC,cAAc;SAC3C,CAAC,CAAA;QAEF,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE;YAC1B,SAAS,EAAE,qBAAqB,CAAC,MAAM;YACvC,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS;SACvE,CAAC,CAAA;QAEF,IAAI,YAAY,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACpC,OAAO,iBAAiB,CAAC,yBAAyB,YAAY,CAAC,IAAI,EAAE,CAAC,CAAA;QACxE,CAAC;QAED,YAAY,CAAC,OAAO,GAAG,YAAY,CAAC,YAAY,CAAA;QAEhD,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAA;QACrC,KAAK,MAAM,aAAa,IAAI,YAAY,CAAC,SAAS,EAAE,CAAC;YACnD,8CAA8C;YAC9C,MAAM,oBAAoB,GAAG,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,aAAa,CAAC,CAAA;YAClF,MAAM,GAAG,GAAG,aAAa,CAAC,oBAAoB,EAAE,EAAE,WAAW,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAA;YACrF,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;gBACpC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;YACxB,CAAC;YACD,aAAa,CAAC,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAA;QAC5D,CAAC;QAED,+GAA+G;QAC/G,YAAY,CAAC,qBAAqB,CAAC,CAAA;QAEnC,OAAO,EAAE,WAAW,EAAE,CAAA;IACxB,CAAC,CAAA;IAED,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,CAAA;IAEnE,MAAM,IAAI,GAAuC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QACnE,KAAK,CAAC,CAAC,cAAc,CAAC,IAAI,CACxB,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,CACpC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAClB,oEAAoE;YAEpE,MAAM,YAAY,GAAG,eAAe,CAAC;gBACnC,SAAS,EAAE,YAAY,CAAC,OAAO;gBAC/B,OAAO;gBACP,YAAY;gBACZ,YAAY,EAAE,aAAa,CAAC,cAAc;aAC3C,CAAC,CAAA;YAEF,IAAI,YAAY,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACnC,QAAQ,CAAA;gBACR,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;YACjF,CAAC;YAED,YAAY,CAAC,OAAO,GAAG,YAAY,CAAC,YAAY,CAAA;YAEhD,IAAI,YAAY,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACnC,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE;oBAC3B,UAAU,EAAE,OAAO,CAAC,IAAI;oBACxB,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;oBAC5D,cAAc,EAAE,YAAY,CAAC,SAAS,CAAC,MAAM;oBAC7C,aAAa,EAAE,YAAY,CAAC,gBAAgB,CAAC,MAAM;oBACnD,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS;oBAC7D,SAAS;iBACV,CAAC,CAAA;gBACF,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,CAAC,KAAK,CACX,uBAAuB,EACvB,YAAY,CAAC,gBAAgB,CAAC,MAAM,EACpC,GAAG,YAAY,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CACxD,CAAA;gBACH,CAAC;gBAED,KAAK,IAAI,CAAC,GAAG,YAAY,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;oBACnE,MAAM,KAAK,GAAG,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAE,CAAA;oBAC/C,IAAI,KAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;wBAChC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;wBACrC,KAAK,CAAC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAA;oBACzC,CAAC;gBACH,CAAC;gBAED,YAAY,CAAC,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;YACjD,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;oBAC5B,UAAU,EAAE,OAAO,CAAC,IAAI;oBACxB,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;oBAC5D,cAAc,EAAE,YAAY,CAAC,SAAS,CAAC,MAAM;oBAC7C,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS;oBAC7D,SAAS;iBACV,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,YAAY,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAM;YAE/C,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAA;YACrC,KAAK,MAAM,aAAa,IAAI,YAAY,CAAC,SAAS,EAAE,CAAC;gBACnD,MAAM,oBAAoB,GAAG,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,aAAa,CAAC,CAAA;gBAClF,MAAM,GAAG,GAAG,aAAa,CAAC,oBAAoB,EAAE,EAAE,WAAW,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAA;gBACrF,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;oBACpC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;gBACxB,CAAC;gBAED,aAAa,CAAC,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAA;YAC5D,CAAC;YAED,aAAa,CAAC,WAAW,CAAC,CAAA;QAC5B,CAAC,CAAC,CACH,EACD,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,OAAO,EAAE,mEAAmE;QACnF,MAAM,CAAC,iBAAiB,EACxB,MAAM,CAAC,UAAU,CAClB,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,YAAY;KACwB,CAAA;AACxC,CAAC,CAAA"}

package/src/schema/EventId.test.ts

@@ -1,12 +0,0 @@
-import { Vitest } from '@livestore/utils/node-vitest'
-import { expect } from 'vitest'
-
-import { EventId } from './mod.js'
-
-Vitest.describe('EventId', () => {
-  Vitest.test('nextPair', () => {
-    const e_0_0 = EventId.make({ global: 0, local: 0 })
-    expect(EventId.nextPair(e_0_0, false).id).toStrictEqual({ global: 1, local: 0 })
-    expect(EventId.nextPair(e_0_0, true).id).toStrictEqual({ global: 0, local: 1 })
-  })
-})