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

package/src/schema/MutationEvent.ts

@@ -1,4 +1,5 @@
 import { memoizeByRef } from '@livestore/utils'
+import type { Deferred } from '@livestore/utils/effect'
 import { Schema } from '@livestore/utils/effect'
 
 import * as EventId from './EventId.js'
@@ -29,31 +30,10 @@ export type MutationEventEncoded<TMutationsDef extends MutationDef.Any> = {
   parentId: EventId.EventId
 }
 
-export type AnyDecoded = MutationEvent<MutationDef.Any>
-export const AnyDecoded = Schema.Struct({
-  mutation: Schema.String,
-  args: Schema.Any,
-  id: EventId.EventId,
-  parentId: EventId.EventId,
-}).annotations({ title: 'MutationEvent.AnyDecoded' })
-
+export type Any = MutationEvent<MutationDef.Any>
 export type AnyEncoded = MutationEventEncoded<MutationDef.Any>
-export const AnyEncoded = Schema.Struct({
-  mutation: Schema.String,
-  args: Schema.Any,
-  id: EventId.EventId,
-  parentId: EventId.EventId,
-}).annotations({ title: 'MutationEvent.AnyEncoded' })
-
-export const AnyEncodedGlobal = Schema.Struct({
-  mutation: Schema.String,
-  args: Schema.Any,
-  id: EventId.GlobalEventId,
-  parentId: EventId.GlobalEventId,
-}).annotations({ title: 'MutationEvent.AnyEncodedGlobal' })
-export type AnyEncodedGlobal = typeof AnyEncodedGlobal.Type
 
-export type PartialAnyDecoded = MutationEventPartial<MutationDef.Any>
+export type PartialAny = MutationEventPartial<MutationDef.Any>
 export type PartialAnyEncoded = MutationEventPartialEncoded<MutationDef.Any>
 
 export type PartialForSchema<TSchema extends LiveStoreSchema> = {
@@ -64,9 +44,8 @@ export type ForSchema<TSchema extends LiveStoreSchema> = {
   [K in keyof TSchema['_MutationDefMapType']]: MutationEvent<TSchema['_MutationDefMapType'][K]>
 }[keyof TSchema['_MutationDefMapType']]
 
-export const isPartialMutationEvent = (
-  mutationEvent: AnyDecoded | PartialAnyDecoded,
-): mutationEvent is PartialAnyDecoded => 'id' in mutationEvent === false && 'parentId' in mutationEvent === false
+export const isPartialMutationEvent = (mutationEvent: Any | PartialAny): mutationEvent is PartialAny =>
+  'id' in mutationEvent === false && 'parentId' in mutationEvent === false
 
 export type ForMutationDefRecord<TMutationsDefRecord extends MutationDefRecord> = Schema.Schema<
   {
@@ -126,21 +105,33 @@ export const makeMutationEventPartialSchema = <TSchema extends LiveStoreSchema>(
         args: def.schema,
       }),
     ),
-  ).annotations({ title: 'MutationEventPartial' }) as any
+  ).annotations({ title: 'MutationEventSchemaPartial' }) as any
 
 export const makeMutationEventSchemaMemo = memoizeByRef(makeMutationEventSchema)
 
-/** Equivalent to AnyEncoded but with a meta field and some convenience methods */
+export const Any = Schema.Struct({
+  mutation: Schema.String,
+  args: Schema.Any,
+  id: EventId.EventId,
+  parentId: EventId.EventId,
+}).annotations({ title: 'MutationEvent.Any' })
+
+export const DecodedAny = Schema.typeSchema(Any).annotations({
+  title: 'MutationEvent.DecodedAny',
+})
+
+export const EncodedAny = Schema.encodedSchema(Any).annotations({
+  title: 'MutationEvent.EncodedAny',
+})
+
+/** Equivalent to EncodedAny but with a meta field and some convenience methods */
 export class EncodedWithMeta extends Schema.Class<EncodedWithMeta>('MutationEvent.EncodedWithMeta')({
   mutation: Schema.String,
   args: Schema.Any,
   id: EventId.EventId,
   parentId: EventId.EventId,
-  // TODO get rid of `meta` again by cleaning up the usage implementations
   meta: Schema.optionalWith(
-    Schema.Any as Schema.Schema<{
-      sessionChangeset?: Uint8Array
-    }>,
+    Schema.Any as Schema.Schema<{ deferred?: Deferred.Deferred<void>; sessionChangeset?: Uint8Array }>,
     { default: () => ({}) },
   ),
 }) {
@@ -158,21 +149,8 @@ export class EncodedWithMeta extends Schema.Class<EncodedWithMeta>('MutationEven
   rebase = (parentId: EventId.EventId, isLocal: boolean) =>
     new EncodedWithMeta({
       ...this,
-      ...EventId.nextPair(parentId, isLocal),
+      ...EventId.nextPair(this.id, isLocal),
     })
-
-  static fromGlobal = (mutationEvent: AnyEncodedGlobal) =>
-    new EncodedWithMeta({
-      ...mutationEvent,
-      id: { global: mutationEvent.id, local: EventId.localDefault },
-      parentId: { global: mutationEvent.parentId, local: EventId.localDefault },
-    })
-
-  toGlobal = (): AnyEncodedGlobal => ({
-    ...this,
-    id: this.id.global,
-    parentId: this.parentId.global,
-  })
 }
 
 export const isEqualEncoded = (a: AnyEncoded, b: AnyEncoded) =>

package/src/schema/system-tables.ts

@@ -1,7 +1,6 @@
 import { type SqliteAst as __SqliteAst, SqliteDsl } from '@livestore/db-schema'
 import { Schema } from '@livestore/utils/effect'
 
-import * as EventId from './EventId.js'
 import type { FromTable } from './table-def.js'
 import { table } from './table-def.js'
 
@@ -47,15 +46,14 @@ export const sessionChangesetMetaTable = table(
   SESSION_CHANGESET_META_TABLE,
   {
     // TODO bring back primary key
-    idGlobal: SqliteDsl.integer({ schema: EventId.GlobalEventId }),
-    idLocal: SqliteDsl.integer({ schema: EventId.LocalEventId }),
-    changeset: SqliteDsl.blob({ nullable: true }),
+    idGlobal: SqliteDsl.integer({}),
+    idLocal: SqliteDsl.integer({}),
+    // idGlobal: SqliteDsl.integer({ primaryKey: true }),
+    // idLocal: SqliteDsl.integer({ primaryKey: true }),
+    changeset: SqliteDsl.blob({}),
     debug: SqliteDsl.json({ nullable: true }),
   },
-  {
-    disableAutomaticIdColumn: true,
-    indexes: [{ columns: ['idGlobal', 'idLocal'], name: 'idx_session_changeset_id' }],
-  },
+  { disableAutomaticIdColumn: true },
 )
 
 export type SessionChangesetMetaRow = FromTable.RowDecoded<typeof sessionChangesetMetaTable>
@@ -72,22 +70,16 @@ export const MUTATION_LOG_META_TABLE = 'mutation_log'
 export const mutationLogMetaTable = table(
   MUTATION_LOG_META_TABLE,
   {
-    idGlobal: SqliteDsl.integer({ primaryKey: true, schema: EventId.GlobalEventId }),
-    idLocal: SqliteDsl.integer({ primaryKey: true, schema: EventId.LocalEventId }),
-    parentIdGlobal: SqliteDsl.integer({ schema: EventId.GlobalEventId }),
-    parentIdLocal: SqliteDsl.integer({ schema: EventId.LocalEventId }),
+    idGlobal: SqliteDsl.integer({ primaryKey: true }),
+    idLocal: SqliteDsl.integer({ primaryKey: true }),
+    parentIdGlobal: SqliteDsl.integer({}),
+    parentIdLocal: SqliteDsl.integer({}),
     mutation: SqliteDsl.text({}),
     argsJson: SqliteDsl.text({ schema: Schema.parseJson(Schema.Any) }),
     schemaHash: SqliteDsl.integer({}),
     syncMetadataJson: SqliteDsl.text({ schema: Schema.parseJson(Schema.Option(Schema.JsonValue)) }),
   },
-  {
-    disableAutomaticIdColumn: true,
-    indexes: [
-      { columns: ['idGlobal'], name: 'idx_idGlobal' },
-      { columns: ['idGlobal', 'idLocal'], name: 'idx_mutationlog_id' },
-    ],
-  },
+  { disableAutomaticIdColumn: true, indexes: [] },
 )
 
 export type MutationLogMetaRow = FromTable.RowDecoded<typeof mutationLogMetaTable>

package/src/schema-management/migrations.ts

@@ -129,10 +129,10 @@ export const migrateTable = ({
 
     if (behaviour === 'drop-and-recreate') {
       // TODO need to possibly handle cascading deletes due to foreign keys
-      dbExecute(db, sql`drop table if exists '${tableName}'`)
-      dbExecute(db, sql`create table if not exists '${tableName}' (${columnSpec}) strict`)
+      dbExecute(db, sql`drop table if exists ${tableName}`)
+      dbExecute(db, sql`create table if not exists ${tableName} (${columnSpec}) strict`)
     } else if (behaviour === 'create-if-not-exists') {
-      dbExecute(db, sql`create table if not exists '${tableName}' (${columnSpec}) strict`)
+      dbExecute(db, sql`create table if not exists ${tableName} (${columnSpec}) strict`)
     }
 
     for (const index of tableAst.indexes) {
@@ -162,11 +162,11 @@ export const migrateTable = ({
 
 const createIndexFromDefinition = (tableName: string, index: SqliteAst.Index) => {
   const uniqueStr = index.unique ? 'UNIQUE' : ''
-  return sql`create ${uniqueStr} index if not exists '${index.name}' on '${tableName}' (${index.columns.join(', ')})`
+  return sql`create ${uniqueStr} index if not exists ${index.name} on ${tableName} (${index.columns.join(', ')})`
 }
 
 export const makeColumnSpec = (tableAst: SqliteAst.Table) => {
-  const primaryKeys = tableAst.columns.filter((_) => _.primaryKey).map((_) => `'${_.name}'`)
+  const primaryKeys = tableAst.columns.filter((_) => _.primaryKey).map((_) => _.name)
   const columnDefStrs = tableAst.columns.map(toSqliteColumnSpec)
   if (primaryKeys.length > 0) {
     columnDefStrs.push(`PRIMARY KEY (${primaryKeys.join(', ')})`)
@@ -191,5 +191,5 @@ const toSqliteColumnSpec = (column: SqliteAst.Column) => {
     return `default ${encodedDefaultValue}`
   })()
 
-  return `'${column.name}' ${columnTypeStr} ${nullableStr} ${defaultValueStr}`
+  return `${column.name} ${columnTypeStr} ${nullableStr} ${defaultValueStr}`
 }

package/src/sync/{ClientSessionSyncProcessor.ts → client-session-sync-processor.ts}

@@ -3,11 +3,12 @@ import type { Scope } from '@livestore/utils/effect'
 import { Effect, Schema, Stream } from '@livestore/utils/effect'
 import * as otel from '@opentelemetry/api'
 
-import type { ClientSessionLeaderThreadProxy, UnexpectedError } from '../adapter-types.js'
+import type { Coordinator, UnexpectedError } from '../adapter-types.js'
 import * as EventId from '../schema/EventId.js'
 import { type LiveStoreSchema } from '../schema/mod.js'
 import * as MutationEvent from '../schema/MutationEvent.js'
-import { SyncState, updateSyncState } from './syncstate.js'
+import type { SyncState } from './syncstate.js'
+import { updateSyncState } from './syncstate.js'
 
 /**
  * Rebase behaviour:
@@ -31,9 +32,9 @@ export const makeClientSessionSyncProcessor = ({
   schema: LiveStoreSchema
   initialLeaderHead: EventId.EventId
   pushToLeader: (batch: ReadonlyArray<MutationEvent.AnyEncoded>) => void
-  pullFromLeader: ClientSessionLeaderThreadProxy['mutations']['pull']
+  pullFromLeader: Coordinator['mutations']['pull']
   applyMutation: (
-    mutationEventDecoded: MutationEvent.PartialAnyDecoded,
+    mutationEventDecoded: MutationEvent.PartialAny,
     options: { otelContext: otel.Context; withChangeset: boolean },
   ) => {
     writeTables: Set<string>
@@ -41,18 +42,19 @@ export const makeClientSessionSyncProcessor = ({
   }
   rollback: (changeset: Uint8Array) => void
   refreshTables: (tables: Set<string>) => void
+  // rebaseBehaviour: 'auto-rebase' | 'manual-rebase'
   span: otel.Span
 }): ClientSessionSyncProcessor => {
   const mutationEventSchema = MutationEvent.makeMutationEventSchemaMemo(schema)
 
   const syncStateRef = {
-    current: new SyncState({
+    current: {
       localHead: initialLeaderHead,
       upstreamHead: initialLeaderHead,
       pending: [],
       // TODO init rollbackTail from leader to be ready for backend rebasing
       rollbackTail: [],
-    }),
+    } as SyncState,
   }
 
   const isLocalEvent = (mutationEventEncoded: MutationEvent.EncodedWithMeta) => {
@@ -102,7 +104,6 @@ export const makeClientSessionSyncProcessor = ({
       mutationEvent.meta.sessionChangeset = res.sessionChangeset
     }
 
-    // console.debug('pushToLeader', encodedMutationEvents.length, ...encodedMutationEvents.map((_) => _.toJSON()))
     pushToLeader(encodedMutationEvents)
 
     return { writeTables }
@@ -154,8 +155,6 @@ export const makeClientSessionSyncProcessor = ({
                 event.meta.sessionChangeset = undefined
               }
             }
-
-            pushToLeader(updateResult.newSyncState.pending)
           } else {
             span.addEvent('pull:advance', {
               payloadTag: payload._tag,
@@ -183,7 +182,6 @@ export const makeClientSessionSyncProcessor = ({
         }),
       ),
       Stream.runDrain,
-      Effect.forever, // NOTE Whenever the leader changes, we need to re-start the stream
       Effect.tapCauseLogPretty,
       Effect.forkScoped,
     )
@@ -198,7 +196,7 @@ export const makeClientSessionSyncProcessor = ({
 
 export interface ClientSessionSyncProcessor {
   push: (
-    batch: ReadonlyArray<MutationEvent.PartialAnyDecoded>,
+    batch: ReadonlyArray<MutationEvent.PartialAny>,
     options: { otelContext: otel.Context },
   ) => {
     writeTables: Set<string>

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 './client-session-sync-processor.js'

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

@@ -20,7 +20,7 @@ export const emptyHistoryDag = (): HistoryDag =>
   })
 
 // TODO consider making `ROOT_ID` parent to itself
-export const rootParentId = EventId.make({ global: EventId.ROOT.global - 1, local: EventId.localDefault })
+export const rootParentId = { global: EventId.ROOT.global - 1, local: 0 } satisfies EventId.EventId
 
 export type HistoryDagNode = {
   id: EventId.EventId

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

@@ -1,4 +1,4 @@
-import * as EventId from '../../schema/EventId.js'
+import type * as EventId from '../../schema/EventId.js'
 import type * as MutationEvent from '../../schema/MutationEvent.js'
 import type { MutationDef, MutationEventFactsSnapshot } from '../../schema/mutations.js'
 import {
@@ -19,13 +19,13 @@ export type RebaseInput = {
   newRemoteEvents: RebaseEventWithConflict[]
   pendingLocalEvents: RebaseEventWithConflict[]
   validate: (args: {
-    rebasedLocalEvents: MutationEvent.PartialAnyDecoded[]
+    rebasedLocalEvents: MutationEvent.PartialAny[]
     mutationDefs: Record<string, MutationDef.Any>
   }) => FactValidationResult
 }
 
 export type RebaseOutput = {
-  rebasedLocalEvents: MutationEvent.PartialAnyDecoded[]
+  rebasedLocalEvents: MutationEvent.PartialAny[]
 }
 
 export type RebaseFn = (input: RebaseInput) => RebaseOutput
@@ -48,7 +48,7 @@ export const rebaseEvents = ({
   newRemoteEvents: HistoryDagNode[]
   rebaseFn: RebaseFn
   currentFactsSnapshot: MutationEventFactsSnapshot
-}): ReadonlyArray<MutationEvent.AnyDecoded> => {
+}): MutationEvent.Any[] => {
   const initialSnapshot = new Map(currentFactsSnapshot)
   applyFactGroups(
     newRemoteEvents.map((event) => event.factsGroup),
@@ -89,10 +89,10 @@ export const rebaseEvents = ({
   return rebasedLocalEvents.map(
     (event, index) =>
       ({
-        id: EventId.make({ global: headGlobalId + index + 1, local: EventId.localDefault }),
-        parentId: EventId.make({ global: headGlobalId + index, local: EventId.localDefault }),
+        id: { global: headGlobalId + index + 1, local: 0 } satisfies EventId.EventId,
+        parentId: { global: headGlobalId + index, local: 0 } satisfies EventId.EventId,
         mutation: event.mutation,
         args: event.args,
-      }) satisfies MutationEvent.AnyDecoded,
+      }) satisfies MutationEvent.Any,
   )
 }

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

@@ -140,9 +140,16 @@ export const toEventNodes = (
 
   let currentEventId: EventId.EventId = EventId.ROOT
 
+  const getNextEventId = (mutationDef: MutationDef.Any): EventId.EventId => {
+    if (mutationDef.options.localOnly) {
+      return { global: currentEventId.global, local: currentEventId.local + 1 }
+    }
+    return { global: currentEventId.global + 1, local: 0 }
+  }
+
   const eventNodes = partialEvents.map((partialEvent) => {
     const mutationDef = mutationDefs[partialEvent.mutation]!
-    const eventId = EventId.nextPair(currentEventId, mutationDef.options.localOnly).id
+    const eventId = getNextEventId(mutationDef)
     currentEventId = eventId
 
     const factsSnapshot = factsSnapshotForDag(historyDagFromNodes(nodesAcc, { skipFactsCheck: true }), undefined)
@@ -217,8 +224,8 @@ const getParentId = (eventId: EventId.EventId): EventId.EventId => {
   const localParentId = eventId.local - 1
 
   if (localParentId < 0) {
-    return EventId.make({ global: globalParentId - 1, local: EventId.localDefault })
+    return { global: globalParentId - 1, local: 0 }
   }
 
-  return EventId.make({ global: globalParentId, local: localParentId })
+  return { global: globalParentId, local: localParentId }
 }

package/src/sync/sync.ts

@@ -1,23 +1,12 @@
-import type { Effect, HttpClient, Option, Scope, Stream, SubscriptionRef } from '@livestore/utils/effect'
+import type { Effect, HttpClient, Option, 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 EventId from '../schema/EventId.js'
 import type * as MutationEvent from '../schema/MutationEvent.js'
 
-/**
- * Those arguments can be used to implement multi-tenancy etc and are passed in from the store.
- */
-export type MakeBackendArgs = {
-  storeId: string
-  clientId: string
-}
-
-export type SyncOptions = {
-  makeBackend: (args: MakeBackendArgs) => Effect.Effect<SyncBackend<any>, UnexpectedError, Scope.Scope>
-  /** @default { _tag: 'Skip' } */
-  initialSyncOptions?: InitialSyncOptions
+export interface SyncBackendOptionsBase {
+  type: string
+  [key: string]: Schema.JsonValue
 }
 
 export type SyncBackend<TSyncMetadata = Schema.JsonValue> = {
@@ -29,7 +18,7 @@ export type SyncBackend<TSyncMetadata = Schema.JsonValue> = {
   ) => Stream.Stream<
     {
       batch: ReadonlyArray<{
-        mutationEventEncoded: MutationEvent.AnyEncodedGlobal
+        mutationEventEncoded: MutationEvent.AnyEncoded
         metadata: Option.Option<TSyncMetadata>
       }>
       remaining: number
@@ -44,7 +33,7 @@ export type SyncBackend<TSyncMetadata = Schema.JsonValue> = {
      * - Number of events: 1-100
      * - event ids must be in ascending order
      * */
-    batch: ReadonlyArray<MutationEvent.AnyEncodedGlobal>,
+    batch: ReadonlyArray<MutationEvent.AnyEncoded>,
   ) => Effect.Effect<
     {
       /** Indexes are relative to `batch` */
@@ -57,7 +46,6 @@ export type SyncBackend<TSyncMetadata = Schema.JsonValue> = {
 }
 
 export class IsOfflineError extends Schema.TaggedError<IsOfflineError>()('IsOfflineError', {}) {}
-
 export class InvalidPushError extends Schema.TaggedError<InvalidPushError>()('InvalidPushError', {
   reason: Schema.Union(
     Schema.TaggedStruct('Unexpected', {
@@ -73,7 +61,6 @@ export class InvalidPushError extends Schema.TaggedError<InvalidPushError>()('In
     }),
   ),
 }) {}
-
 export class InvalidPullError extends Schema.TaggedError<InvalidPullError>()('InvalidPullError', {
   message: Schema.String,
 }) {}