Open History to see the last commit
1import {
2 DEFAULT_APPLIED_TX_PRUNE_MAX_AGE_SECONDS,
3 DEFAULT_APPLIED_TX_PRUNE_MAX_ROWS,
4 SingleProcessCoordinator,
5 createSQLiteCorePersistenceAdapter,
6} from '@tanstack/db-sqlite-persistence-core'
7import { CloudflareDOSQLiteDriver } from './do-driver'
8import type {
9 PersistedCollectionCoordinator,
10 PersistedCollectionMode,
11 PersistedCollectionPersistence,
12 SQLiteCoreAdapterOptions,
13 SQLiteDriver,
14} from '@tanstack/db-sqlite-persistence-core'
15import type { DurableObjectStorageLike } from './do-driver'
16
17export type { DurableObjectStorageLike } from './do-driver'
18
19type CloudflareDOCoreSchemaMismatchPolicy =
20 | `sync-present-reset`
21 | `sync-absent-error`
22 | `reset`
23
24export type CloudflareDOSchemaMismatchPolicy =
25 | CloudflareDOCoreSchemaMismatchPolicy
26 | `throw`
27
28type CloudflareDOSQLitePersistenceBaseOptions = Omit<
29 SQLiteCoreAdapterOptions,
30 `driver` | `schemaVersion` | `schemaMismatchPolicy`
31> & {
32 storage: DurableObjectStorageLike
33 coordinator?: PersistedCollectionCoordinator
34 schemaMismatchPolicy?: CloudflareDOSchemaMismatchPolicy
35}
36
37export type CloudflareDOSQLitePersistenceOptions =
38 CloudflareDOSQLitePersistenceBaseOptions
39
40function normalizeSchemaMismatchPolicy(
41 policy: CloudflareDOSchemaMismatchPolicy,
42): CloudflareDOCoreSchemaMismatchPolicy {
43 if (policy === `throw`) {
44 return `sync-absent-error`
45 }
46 return policy
47}
48
49function resolveSchemaMismatchPolicy(
50 explicitPolicy: CloudflareDOSchemaMismatchPolicy | undefined,
51 mode: PersistedCollectionMode,
52): CloudflareDOCoreSchemaMismatchPolicy {
53 if (explicitPolicy) {
54 return normalizeSchemaMismatchPolicy(explicitPolicy)
55 }
56
57 return mode === `sync-present` ? `sync-present-reset` : `sync-absent-error`
58}
59
60function createAdapterCacheKey(
61 schemaMismatchPolicy: CloudflareDOCoreSchemaMismatchPolicy,
62 schemaVersion: number | undefined,
63): string {
64 const schemaVersionKey =
65 schemaVersion === undefined ? `schema:default` : `schema:${schemaVersion}`
66 return `${schemaMismatchPolicy}|${schemaVersionKey}`
67}
68
69function resolveSQLiteDriver(
70 options: CloudflareDOSQLitePersistenceOptions,
71): SQLiteDriver {
72 return new CloudflareDOSQLiteDriver({
73 storage: options.storage,
74 })
75}
76
77function resolveAdapterBaseOptions(
78 options: CloudflareDOSQLitePersistenceOptions,
79): Omit<
80 SQLiteCoreAdapterOptions,
81 `driver` | `schemaVersion` | `schemaMismatchPolicy`
82> {
83 return {
84 appliedTxPruneMaxRows:
85 options.appliedTxPruneMaxRows ?? DEFAULT_APPLIED_TX_PRUNE_MAX_ROWS,
86 appliedTxPruneMaxAgeSeconds:
87 options.appliedTxPruneMaxAgeSeconds ??
88 DEFAULT_APPLIED_TX_PRUNE_MAX_AGE_SECONDS,
89 pullSinceReloadThreshold: options.pullSinceReloadThreshold,
90 }
91}
92
93/**
94 * Creates a shared Durable Object SQLite persistence instance that can be reused
95 * by many collections in a single Durable Object storage.
96 */
97export function createCloudflareDOSQLitePersistence(
98 options: CloudflareDOSQLitePersistenceOptions,
99): PersistedCollectionPersistence {
100 const { coordinator, schemaMismatchPolicy } = options
101 const driver = resolveSQLiteDriver(options)
102 const adapterBaseOptions = resolveAdapterBaseOptions(options)
103 const resolvedCoordinator = coordinator ?? new SingleProcessCoordinator()
104 const adapterCache = new Map<
105 string,
106 ReturnType<typeof createSQLiteCorePersistenceAdapter>
107 >()
108
109 const getAdapterForCollection = (
110 mode: PersistedCollectionMode,
111 schemaVersion: number | undefined,
112 ) => {
113 const resolvedSchemaMismatchPolicy = resolveSchemaMismatchPolicy(
114 schemaMismatchPolicy,
115 mode,
116 )
117 const cacheKey = createAdapterCacheKey(
118 resolvedSchemaMismatchPolicy,
119 schemaVersion,
120 )
121 const cachedAdapter = adapterCache.get(cacheKey)
122 if (cachedAdapter) {
123 return cachedAdapter
124 }
125
126 const adapter = createSQLiteCorePersistenceAdapter({
127 ...adapterBaseOptions,
128 driver,
129 schemaMismatchPolicy: resolvedSchemaMismatchPolicy,
130 ...(schemaVersion === undefined ? {} : { schemaVersion }),
131 })
132 adapterCache.set(cacheKey, adapter)
133 return adapter
134 }
135
136 const createCollectionPersistence = (
137 mode: PersistedCollectionMode,
138 schemaVersion: number | undefined,
139 ): PersistedCollectionPersistence => ({
140 adapter: getAdapterForCollection(mode, schemaVersion),
141 coordinator: resolvedCoordinator,
142 })
143
144 const defaultPersistence = createCollectionPersistence(
145 `sync-absent`,
146 undefined,
147 )
148
149 return {
150 ...defaultPersistence,
151 resolvePersistenceForCollection: ({ mode, schemaVersion }) =>
152 createCollectionPersistence(mode, schemaVersion),
153 // Backward compatible fallback for older callers.
154 resolvePersistenceForMode: (mode) =>
155 createCollectionPersistence(mode, undefined),
156 }
157}