@livestore/common 0.4.0-dev.24 → 0.4.0-dev.25

package/src/leader-thread/leader-worker-devtools.ts

@@ -1,7 +1,15 @@
 import { Effect, FiberMap, Option, Stream, SubscriptionRef } from '@livestore/utils/effect'
 import { nanoid } from '@livestore/utils/nanoid'
 
-import { Devtools, IntentionalShutdownCause, liveStoreVersion, UnknownError } from '../index.ts'
+import {
+  Devtools,
+  devtoolsProtocolVersion,
+  IntentionalShutdownCause,
+  isDevtoolsProtocolVersionSupported,
+  liveStoreVersion,
+  resolveDevtoolsProtocolVersion,
+  UnknownError,
+} from '../index.ts'
 import { SystemTables } from '../schema/mod.ts'
 import type { DevtoolsOptions, PersistenceInfoPair } from './types.ts'
 import { LeaderThreadCtx } from './types.ts'
@@ -166,18 +174,19 @@ const listenToDevtools = ({
 
           switch (decodedEvent._tag) {
             case 'LSD.Leader.Ping': {
-              // Check version mismatch and respond with VersionMismatch if versions don't match
-              if (decodedEvent.liveStoreVersion !== liveStoreVersion) {
+              if (isDevtoolsProtocolVersionSupported(decodedEvent.devtoolsProtocolVersion) === false) {
                 yield* sendMessage(
                   Devtools.Leader.VersionMismatch.make({
                     ...reqPayload,
                     appVersion: liveStoreVersion,
                     receivedVersion: decodedEvent.liveStoreVersion,
+                    appDevtoolsProtocolVersion: devtoolsProtocolVersion,
+                    receivedDevtoolsProtocolVersion: resolveDevtoolsProtocolVersion(decodedEvent.devtoolsProtocolVersion),
                   }),
                 )
                 return
               }
-              yield* sendMessage(Devtools.Leader.Pong.make({ ...reqPayload }))
+              yield* sendMessage(Devtools.Leader.Pong.make({ ...reqPayload, devtoolsProtocolVersion }))
               return
             }
             case 'LSD.Leader.SnapshotReq': {
@@ -352,10 +361,10 @@ const listenToDevtools = ({
               return
             }
             case 'LSD.Leader.SyncHistoryUnsubscribe': {
-              const { requestId } = decodedEvent
-              console.log('LSD.SyncHistoryUnsubscribe', requestId)
+              const unsubscribeRequestId = decodedEvent.requestId
+              console.log('LSD.SyncHistoryUnsubscribe', unsubscribeRequestId)
 
-              yield* FiberMap.remove(subscriptionFiberMap, requestId)
+              yield* FiberMap.remove(subscriptionFiberMap, unsubscribeRequestId)
 
               return
             }
@@ -408,9 +417,9 @@ const listenToDevtools = ({
               return
             }
             case 'LSD.Leader.NetworkStatusUnsubscribe': {
-              const { requestId } = decodedEvent
+              const unsubscribeRequestId = decodedEvent.requestId
 
-              yield* FiberMap.remove(subscriptionFiberMap, requestId)
+              yield* FiberMap.remove(subscriptionFiberMap, unsubscribeRequestId)
 
               return
             }

package/src/version.ts

@@ -1,13 +1,24 @@
 import pkg from '../package.json' with { type: 'json' }
 
 /**
- * Current LiveStore version used for DevTools version compatibility checks.
+ * Current LiveStore package version used for display, release assets, and install guidance.
  *
- * Can be overridden at runtime via `globalThis.__LIVESTORE_VERSION_OVERRIDE__` for testing purposes.
- * This allows Playwright tests to simulate version mismatch scenarios without rebuilding.
+ * Can be overridden at runtime via `globalThis.__LIVESTORE_VERSION_OVERRIDE__` for testing display-only version values.
  */
 export const liveStoreVersion: string = (globalThis as any).__LIVESTORE_VERSION_OVERRIDE__ ?? pkg.version
 
+export const devtoolsProtocolVersion: number =
+  (globalThis as any).__LIVESTORE_DEVTOOLS_PROTOCOL_VERSION_OVERRIDE__ ?? 1
+
+export const supportedDevtoolsProtocolVersions: ReadonlyArray<number> = [devtoolsProtocolVersion]
+
+export const resolveDevtoolsProtocolVersion = (version: number | undefined): number => version ?? 1
+
+export const isDevtoolsProtocolVersionSupported = (
+  version: number | undefined,
+  supportedVersions: ReadonlyArray<number> = supportedDevtoolsProtocolVersions,
+): boolean => supportedVersions.includes(resolveDevtoolsProtocolVersion(version))
+
 /**
  * CRITICAL: Increment this version whenever you modify client-side EVENTLOG table schemas.
  *