@livestore/common 0.3.0-dev.11 → 0.3.0-dev.13

package/src/schema/table-def.ts

@@ -1,17 +1,16 @@
-import type { Nullable, PrettifyFlat } from '@livestore/db-schema'
-import { SqliteDsl } from '@livestore/db-schema'
+import type { Nullable } from '@livestore/utils'
 import { shouldNeverHappen } from '@livestore/utils'
+import type { Types } from '@livestore/utils/effect'
 import { ReadonlyRecord, Schema } from '@livestore/utils/effect'
 
 import type { DerivedMutationHelperFns } from '../derived-mutations.js'
 import { makeDerivedMutationDefsForTable } from '../derived-mutations.js'
 import type { QueryBuilder } from '../query-builder/mod.js'
 import { makeQueryBuilder } from '../query-builder/mod.js'
+import { SqliteDsl } from './db-schema/mod.js'
 
 export const { blob, boolean, column, datetime, integer, isColumnDefinition, json, real, text } = SqliteDsl
 
-export { SqliteDsl } from '@livestore/db-schema'
-
 export type StateType = 'singleton' | 'dynamic'
 
 export type DefaultSqliteTableDef = SqliteDsl.TableDefinition<string, SqliteDsl.Columns>
@@ -61,7 +60,7 @@ export type TableOptionsInput = Partial<{
     | boolean
     | {
         enabled: true
-        localOnly?: boolean
+        clientOnly?: boolean
       }
 }>
 
@@ -115,7 +114,7 @@ export type TableOptions = {
         /**
          * When set to true, the mutations won't be synced over the network
          */
-        localOnly: boolean
+        clientOnly: boolean
       }
 
   /** Derived based on whether the table definition has one or more columns (besides the `id` column) */
@@ -153,12 +152,12 @@ export const table = <
     disableAutomaticIdColumn: options?.disableAutomaticIdColumn ?? false,
     deriveMutations:
       options?.deriveMutations === true
-        ? { enabled: true as const, localOnly: false }
+        ? { enabled: true as const, clientOnly: false }
         : options?.deriveMutations === false
           ? { enabled: false as const }
           : options?.deriveMutations === undefined
             ? { enabled: false as const }
-            : { enabled: true as const, localOnly: options.deriveMutations.localOnly ?? false },
+            : { enabled: true as const, clientOnly: options.deriveMutations.clientOnly ?? false },
     isSingleColumn: SqliteDsl.isColumnDefinition(columnOrColumns) === true,
     requiredInsertColumnNames: 'type-level-only',
   }
@@ -234,7 +233,7 @@ export const table = <
 export const tableHasDerivedMutations = <TTableDef extends TableDefBase>(
   tableDef: TTableDef,
 ): tableDef is TTableDef & {
-  options: { deriveMutations: { enabled: true; localOnly: boolean } }
+  options: { deriveMutations: { enabled: true; clientOnly: boolean } }
 } & DerivedMutationHelperFns<TTableDef['sqliteDef']['columns'], TTableDef['options']> =>
   tableDef.options.deriveMutations.enabled === true
 
@@ -242,6 +241,8 @@ export const tableIsSingleton = <TTableDef extends TableDefBase>(
   tableDef: TTableDef,
 ): tableDef is TTableDef & { options: { isSingleton: true } } => tableDef.options.isSingleton === true
 
+export type PrettifyFlat<T> = T extends infer U ? { [K in keyof U]: U[K] } : never
+
 type SqliteTableDefForInput<
   TName extends string,
   TColumns extends SqliteDsl.Columns | SqliteDsl.ColumnDefinition<any, any>,
@@ -268,13 +269,13 @@ type WithDefaults<
   isSingleton: TOptionsInput['isSingleton'] extends true ? true : false
   disableAutomaticIdColumn: TOptionsInput['disableAutomaticIdColumn'] extends true ? true : false
   deriveMutations: TOptionsInput['deriveMutations'] extends true
-    ? { enabled: true; localOnly: boolean }
+    ? { enabled: true; clientOnly: boolean }
     : TOptionsInput['deriveMutations'] extends false
       ? { enabled: false }
-      : TOptionsInput['deriveMutations'] extends { enabled: true; localOnly?: boolean }
+      : TOptionsInput['deriveMutations'] extends { enabled: true; clientOnly?: boolean }
         ? {
             enabled: true
-            localOnly: TOptionsInput['deriveMutations']['localOnly'] extends true ? true : false
+            clientOnly: TOptionsInput['deriveMutations']['clientOnly'] extends true ? true : false
           }
         : never
   isSingleColumn: SqliteDsl.IsSingleColumn<TColumns>
@@ -283,7 +284,7 @@ type WithDefaults<
 
 export namespace FromTable {
   // TODO this sometimes doesn't preserve the order of columns
-  export type RowDecoded<TTableDef extends TableDefBase> = PrettifyFlat<
+  export type RowDecoded<TTableDef extends TableDefBase> = Types.Simplify<
     Nullable<Pick<RowDecodedAll<TTableDef>, NullableColumnNames<TTableDef>>> &
       Omit<RowDecodedAll<TTableDef>, NullableColumnNames<TTableDef>>
   >
@@ -302,7 +303,7 @@ export namespace FromTable {
     >
   }
 
-  export type RowEncoded<TTableDef extends TableDefBase> = PrettifyFlat<
+  export type RowEncoded<TTableDef extends TableDefBase> = Types.Simplify<
     Nullable<Pick<RowEncodeNonNullable<TTableDef>, NullableColumnNames<TTableDef>>> &
       Omit<RowEncodeNonNullable<TTableDef>, NullableColumnNames<TTableDef>>
   >
@@ -314,7 +315,7 @@ export namespace FromTable {
 
 export namespace FromColumns {
   // TODO this sometimes doesn't preserve the order of columns
-  export type RowDecoded<TColumns extends SqliteDsl.Columns> = PrettifyFlat<
+  export type RowDecoded<TColumns extends SqliteDsl.Columns> = Types.Simplify<
     Nullable<Pick<RowDecodedAll<TColumns>, NullableColumnNames<TColumns>>> &
       Omit<RowDecodedAll<TColumns>, NullableColumnNames<TColumns>>
   >
@@ -323,7 +324,7 @@ export namespace FromColumns {
     [K in keyof TColumns]: Schema.Schema.Type<TColumns[K]['schema']>
   }
 
-  export type RowEncoded<TColumns extends SqliteDsl.Columns> = PrettifyFlat<
+  export type RowEncoded<TColumns extends SqliteDsl.Columns> = Types.Simplify<
     Nullable<Pick<RowEncodeNonNullable<TColumns>, NullableColumnNames<TColumns>>> &
       Omit<RowEncodeNonNullable<TColumns>, NullableColumnNames<TColumns>>
   >

package/src/schema-management/migrations.ts

@@ -1,8 +1,8 @@
-import { SqliteAst, SqliteDsl } from '@livestore/db-schema'
 import { memoizeByStringifyArgs } from '@livestore/utils'
 import { Effect, Schema as EffectSchema } from '@livestore/utils/effect'
 
-import type { SqliteDb } from '../adapter-types.js'
+import type { MigrationsReport, MigrationsReportEntry, SqliteDb, UnexpectedError } from '../adapter-types.js'
+import { SqliteAst, SqliteDsl } from '../schema/db-schema/mod.js'
 import type { LiveStoreSchema } from '../schema/mod.js'
 import type { SchemaMetaRow, SchemaMutationsMetaRow } from '../schema/system-tables.js'
 import {
@@ -54,7 +54,7 @@ export const migrateDb = ({
   db: SqliteDb
   schema: LiveStoreSchema
   onProgress?: (opts: { done: number; total: number }) => Effect.Effect<void>
-}) =>
+}): Effect.Effect<MigrationsReport, UnexpectedError> =>
   Effect.gen(function* () {
     yield* migrateTable({
       db,
@@ -81,6 +81,7 @@ export const migrateDb = ({
 
     const tablesToMigrate = new Set<{ tableAst: SqliteAst.Table; schemaHash: number }>()
 
+    const migrationsReportEntries: MigrationsReportEntry[] = []
     for (const tableDef of tableDefs) {
       const tableAst = tableDef.sqliteDef.ast
       const tableName = tableAst.name
@@ -90,9 +91,10 @@ export const migrateDb = ({
       if (schemaHash !== dbSchemaHash) {
         tablesToMigrate.add({ tableAst, schemaHash })
 
-        console.log(
-          `Schema hash mismatch for table '${tableName}' (DB: ${dbSchemaHash}, expected: ${schemaHash}), migrating table...`,
-        )
+        migrationsReportEntries.push({
+          tableName,
+          hashes: { expected: schemaHash, actual: dbSchemaHash },
+        })
       }
     }
 
@@ -107,6 +109,8 @@ export const migrateDb = ({
         yield* onProgress({ done: processedTables, total: tablesCount })
       }
     }
+
+    return { migrations: migrationsReportEntries }
   })
 
 export const migrateTable = ({

package/src/sql-queries/sql-queries.ts

@@ -1,7 +1,7 @@
-import type { SqliteDsl } from '@livestore/db-schema'
 import { shouldNeverHappen } from '@livestore/utils'
 import { pipe, ReadonlyArray, Schema, TreeFormatter } from '@livestore/utils/effect'
 
+import type { SqliteDsl } from '../schema/db-schema/mod.js'
 import { sql } from '../util.js'
 import { objectEntries } from './misc.js'
 import * as ClientTypes from './types.js'

package/src/sql-queries/sql-query-builder.ts

@@ -1,5 +1,4 @@
-import type { SqliteDsl } from '@livestore/db-schema'
-
+import type { SqliteDsl } from '../schema/db-schema/mod.js'
 import type { BindValues } from './sql-queries.js'
 import * as SqlQueries from './sql-queries.js'
 import type * as ClientTypes from './types.js'

package/src/sql-queries/types.ts

@@ -1,6 +1,8 @@
-import type { Prettify, SqliteDsl } from '@livestore/db-schema'
+import type { Prettify } from '@livestore/utils'
 import type { Schema } from '@livestore/utils/effect'
 
+import type { SqliteDsl } from '../schema/db-schema/mod.js'
+
 export type DecodedValuesForTableAll<TSchema extends SqliteDsl.DbSchema, TTableName extends keyof TSchema> = {
   [K in keyof GetColumns<TSchema, TTableName>]: Schema.Schema.Type<GetColumn<TSchema, TTableName, K>['schema']>
 }

package/src/sync/ClientSessionSyncProcessor.ts

@@ -1,13 +1,13 @@
 import { LS_DEV, shouldNeverHappen, TRACE_VERBOSE } from '@livestore/utils'
 import type { Runtime, Scope } from '@livestore/utils/effect'
-import { Effect, Schema, Stream } from '@livestore/utils/effect'
+import { Effect, Queue, Schema, Stream, Subscribable } from '@livestore/utils/effect'
 import * as otel from '@opentelemetry/api'
 
 import type { ClientSession, 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 * as SyncState from './syncstate.js'
 
 /**
  * Rebase behaviour:
@@ -44,18 +44,19 @@ export const makeClientSessionSyncProcessor = ({
   const mutationEventSchema = MutationEvent.makeMutationEventSchemaMemo(schema)
 
   const syncStateRef = {
-    current: new SyncState({
-      localHead: clientSession.leaderThread.mutations.initialMutationEventId,
-      upstreamHead: clientSession.leaderThread.mutations.initialMutationEventId,
+    current: new SyncState.SyncState({
+      localHead: clientSession.leaderThread.initialState.leaderHead,
+      upstreamHead: clientSession.leaderThread.initialState.leaderHead,
       pending: [],
       // TODO init rollbackTail from leader to be ready for backend rebasing
       rollbackTail: [],
     }),
   }
 
+  const syncStateUpdateQueue = Queue.unbounded<SyncState.SyncState>().pipe(Effect.runSync)
   const isLocalEvent = (mutationEventEncoded: MutationEvent.EncodedWithMeta) => {
     const mutationDef = schema.mutations.get(mutationEventEncoded.mutation)!
-    return mutationDef.options.localOnly
+    return mutationDef.options.clientOnly
   }
 
   const push: ClientSessionSyncProcessor['push'] = (batch, { otelContext }) => {
@@ -64,14 +65,19 @@ export const makeClientSessionSyncProcessor = ({
     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)
+      const nextIdPair = EventId.nextPair(baseEventId, mutationDef.options.clientOnly)
       baseEventId = nextIdPair.id
       return new MutationEvent.EncodedWithMeta(
-        Schema.encodeUnknownSync(mutationEventSchema)({ ...mutationEvent, ...nextIdPair }),
+        Schema.encodeUnknownSync(mutationEventSchema)({
+          ...mutationEvent,
+          ...nextIdPair,
+          clientId: clientSession.clientId,
+          sessionId: clientSession.sessionId,
+        }),
       )
     })
 
-    const updateResult = updateSyncState({
+    const updateResult = SyncState.updateSyncState({
       syncState: syncStateRef.current,
       payload: { _tag: 'local-push', newEvents: encodedMutationEvents },
       isLocalEvent,
@@ -88,6 +94,7 @@ export const makeClientSessionSyncProcessor = ({
     }
 
     syncStateRef.current = updateResult.newSyncState
+    syncStateUpdateQueue.offer(updateResult.newSyncState).pipe(Effect.runSync)
 
     const writeTables = new Set<string>()
     for (const mutationEvent of updateResult.newEvents) {
@@ -111,6 +118,21 @@ 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 (typeof window !== 'undefined') {
+      const onBeforeUnload = (event: BeforeUnloadEvent) => {
+        if (syncStateRef.current.pending.length > 0) {
+          // Trigger the default browser dialog
+          event.preventDefault()
+        }
+      }
+
+      yield* Effect.acquireRelease(
+        Effect.sync(() => window.addEventListener('beforeunload', onBeforeUnload)),
+        () => Effect.sync(() => window.removeEventListener('beforeunload', onBeforeUnload)),
+      )
+    }
+
     yield* clientSession.leaderThread.mutations.pull.pipe(
       Stream.tap(({ payload, remaining }) =>
         Effect.gen(function* () {
@@ -119,7 +141,7 @@ export const makeClientSessionSyncProcessor = ({
             yield* clientSession.devtools.pullLatch.await
           }
 
-          const updateResult = updateSyncState({
+          const updateResult = SyncState.updateSyncState({
             syncState: syncStateRef.current,
             payload,
             isLocalEvent,
@@ -132,6 +154,7 @@ export const makeClientSessionSyncProcessor = ({
           }
 
           syncStateRef.current = updateResult.newSyncState
+          syncStateUpdateQueue.offer(updateResult.newSyncState).pipe(Effect.runSync)
 
           if (updateResult._tag === 'rebase') {
             span.addEvent('pull:rebase', {
@@ -143,11 +166,11 @@ export const makeClientSessionSyncProcessor = ({
               remaining,
             })
             if (LS_DEV) {
-              console.debug(
+              Effect.logDebug(
                 'pull:rebase: rollback',
                 updateResult.eventsToRollback.length,
                 ...updateResult.eventsToRollback.map((_) => _.toJSON()),
-              )
+              ).pipe(Effect.provide(runtime), Effect.runSync)
             }
 
             for (let i = updateResult.eventsToRollback.length - 1; i >= 0; i--) {
@@ -197,7 +220,14 @@ export const makeClientSessionSyncProcessor = ({
   return {
     push,
     boot,
-    syncStateRef,
+    syncState: Subscribable.make({
+      get: Effect.gen(function* () {
+        const syncState = syncStateRef.current
+        if (syncStateRef === undefined) return shouldNeverHappen('Not initialized')
+        return syncState
+      }),
+      changes: Stream.fromQueue(syncStateUpdateQueue),
+    }),
   } satisfies ClientSessionSyncProcessor
 }
 
@@ -210,5 +240,5 @@ export interface ClientSessionSyncProcessor {
   }
   boot: Effect.Effect<void, UnexpectedError, Scope.Scope>
 
-  syncStateRef: { current: SyncState }
+  syncState: Subscribable.Subscribable<SyncState.SyncState>
 }

package/src/sync/next/facts.ts

@@ -231,5 +231,5 @@ export const compareEventIds = (a: EventId.EventId, b: EventId.EventId) => {
   if (a.global !== b.global) {
     return a.global - b.global
   }
-  return a.local - b.local
+  return a.client - b.client
 }

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 = EventId.make({ global: EventId.ROOT.global - 1, client: EventId.clientDefault })
 
 export type HistoryDagNode = {
   id: EventId.EventId
@@ -30,6 +30,8 @@ export type HistoryDagNode = {
   /** Facts are being used for conflict detection and history compaction */
   factsGroup: MutationEventFactsGroup
   meta?: any
+  clientId: string
+  sessionId: string | undefined
 }
 
 export const rootEventNode: HistoryDagNode = {
@@ -39,6 +41,8 @@ export const rootEventNode: HistoryDagNode = {
   mutation: '__Root__',
   args: {},
   factsGroup: { modifySet: new Map(), modifyUnset: new Map(), depRequire: new Map(), depRead: new Map() },
+  clientId: 'root',
+  sessionId: undefined,
 }
 
 export const EMPTY_FACT_VALUE = Symbol('EMPTY_FACT_VALUE')

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

@@ -3,7 +3,7 @@ import { factsToString, validateFacts } from './facts.js'
 import { emptyHistoryDag, type HistoryDagNode, rootParentId } from './history-dag-common.js'
 
 export const eventIdToString = (eventId: EventId.EventId) =>
-  eventId.local === 0 ? eventId.global.toString() : `${eventId.global}.${eventId.local}`
+  eventId.client === 0 ? eventId.global.toString() : `${eventId.global}.${eventId.client}`
 
 export const historyDagFromNodes = (dagNodes: HistoryDagNode[], options?: { skipFactsCheck: boolean }) => {
   if (options?.skipFactsCheck !== true) {

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

@@ -43,11 +43,15 @@ export const rebaseEvents = ({
   pendingLocalEvents,
   newRemoteEvents,
   currentFactsSnapshot,
+  clientId,
+  sessionId,
 }: {
   pendingLocalEvents: HistoryDagNode[]
   newRemoteEvents: HistoryDagNode[]
   rebaseFn: RebaseFn
   currentFactsSnapshot: MutationEventFactsSnapshot
+  clientId: string
+  sessionId: string | undefined
 }): ReadonlyArray<MutationEvent.AnyDecoded> => {
   const initialSnapshot = new Map(currentFactsSnapshot)
   applyFactGroups(
@@ -89,10 +93,12 @@ 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: EventId.make({ global: headGlobalId + index + 1, client: EventId.clientDefault }),
+        parentId: EventId.make({ global: headGlobalId + index, client: EventId.clientDefault }),
         mutation: event.mutation,
         args: event.args,
+        clientId,
+        sessionId,
       }) satisfies MutationEvent.AnyDecoded,
   )
 }

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

@@ -10,7 +10,7 @@ import { toEventNodes } from './mutation-fixtures.js'
 expect.addSnapshotSerializer(customSerializer)
 
 const compact = (events: any[]) => {
-  const dag = historyDagFromNodes(toEventNodes(events, mutations))
+  const dag = historyDagFromNodes(toEventNodes(events, mutations, 'client-id', 'session-id'))
   const compacted = compactEvents(dag)
 
   return Array.from(compacted.dag.nodeEntries())
@@ -50,8 +50,8 @@ describe('compactEvents calculator', () => {
 
     expect(expected).toMatchInlineSnapshot(`
       [
-        { id: 0, parentId: -1, mutation: "add", args: { value: 1 }, facts: "" }
-        { id: 1, parentId: 0, mutation: "add", args: { value: 1 }, facts: "" }
+        { id: 0, parentId: -1, mutation: "add", args: { value: 1 }, clientId: "client-id", sessionId: "session-id", facts: "" }
+        { id: 1, parentId: 0, mutation: "add", args: { value: 1 }, clientId: "client-id", sessionId: "session-id", facts: "" }
       ]
     `)
   })
@@ -64,8 +64,8 @@ describe('compactEvents calculator', () => {
 
     expect(expected).toMatchInlineSnapshot(`
       [
-        { id: 0, parentId: -1, mutation: "multiply", args: { value: 2 }, facts: "?multiplyByZero -multiplyByZero" }
-        { id: 1, parentId: 0, mutation: "multiply", args: { value: 2 }, facts: "?multiplyByZero -multiplyByZero" }
+        { id: 0, parentId: -1, mutation: "multiply", args: { value: 2 }, clientId: "client-id", sessionId: "session-id", facts: "?multiplyByZero -multiplyByZero" }
+        { id: 1, parentId: 0, mutation: "multiply", args: { value: 2 }, clientId: "client-id", sessionId: "session-id", facts: "?multiplyByZero -multiplyByZero" }
       ]
     `)
   })
@@ -79,7 +79,7 @@ describe('compactEvents calculator', () => {
 
     expect(expected).toMatchInlineSnapshot(`
       [
-        { id: 2, parentId: -1, mutation: "multiply", args: { value: 0 }, facts: "+multiplyByZero" }
+        { id: 2, parentId: -1, mutation: "multiply", args: { value: 0 }, clientId: "client-id", sessionId: "session-id", facts: "+multiplyByZero" }
       ]
     `)
   })
@@ -94,8 +94,8 @@ describe('compactEvents calculator', () => {
 
     expect(expected).toMatchInlineSnapshot(`
       [
-        { id: 2, parentId: -1, mutation: "multiply", args: { value: 0 }, facts: "+multiplyByZero" }
-        { id: 3, parentId: 2, mutation: "add", args: { value: 1 }, facts: "" }
+        { id: 2, parentId: -1, mutation: "multiply", args: { value: 0 }, clientId: "client-id", sessionId: "session-id", facts: "+multiplyByZero" }
+        { id: 3, parentId: 2, mutation: "add", args: { value: 1 }, clientId: "client-id", sessionId: "session-id", facts: "" }
       ]
     `)
   })
@@ -111,10 +111,10 @@ describe('compactEvents calculator', () => {
 
     expect(expected).toMatchInlineSnapshot(`
       [
-        { id: 0, parentId: -1, mutation: "add", args: { value: 1 }, facts: "" }
-        { id: 2, parentId: 0, mutation: "multiply", args: { value: 0 }, facts: "+multiplyByZero" }
-        { id: 3, parentId: 2, mutation: "multiply", args: { value: 2 }, facts: "?multiplyByZero +multiplyByZero -multiplyByZero" }
-        { id: 4, parentId: 3, mutation: "add", args: { value: 1 }, facts: "" }
+        { id: 0, parentId: -1, mutation: "add", args: { value: 1 }, clientId: "client-id", sessionId: "session-id", facts: "" }
+        { id: 2, parentId: 0, mutation: "multiply", args: { value: 0 }, clientId: "client-id", sessionId: "session-id", facts: "+multiplyByZero" }
+        { id: 3, parentId: 2, mutation: "multiply", args: { value: 2 }, clientId: "client-id", sessionId: "session-id", facts: "?multiplyByZero +multiplyByZero -multiplyByZero" }
+        { id: 4, parentId: 3, mutation: "add", args: { value: 1 }, clientId: "client-id", sessionId: "session-id", facts: "" }
       ]
     `)
   })