Open History to see the last commit
1import { mkdtempSync, rmSync } from 'node:fs'
2import { tmpdir } from 'node:os'
3import { join } from 'node:path'
4import { describe, expect, it } from 'vitest'
5import {
6 createBrowserWASQLitePersistence,
7 persistedCollectionOptions,
8} from '../src'
9import { BrowserWASQLiteDriver } from '../src/wa-sqlite-driver'
10import { SingleProcessCoordinator } from '../../db-sqlite-persistence-core/src'
11import { runRuntimePersistenceContractSuite } from '../../db-sqlite-persistence-core/tests/contracts/runtime-persistence-contract'
12import { createWASQLiteTestDatabase } from './helpers/wa-sqlite-test-db'
13import type {
14 RuntimePersistenceContractTodo,
15 RuntimePersistenceDatabaseHarness,
16} from '../../db-sqlite-persistence-core/tests/contracts/runtime-persistence-contract'
17
18function createRuntimeDatabaseHarness(): RuntimePersistenceDatabaseHarness {
19 const tempDirectory = mkdtempSync(join(tmpdir(), `db-browser-persistence-`))
20 const dbPath = join(tempDirectory, `state.sqlite`)
21 const drivers = new Set<BrowserWASQLiteDriver>()
22
23 return {
24 createDriver: () => {
25 const database = createWASQLiteTestDatabase({
26 filename: dbPath,
27 })
28 const driver = new BrowserWASQLiteDriver({ database })
29 drivers.add(driver)
30 return driver
31 },
32 cleanup: async () => {
33 for (const driver of drivers) {
34 try {
35 await driver.close()
36 } catch {
37 // ignore cleanup errors from already-closed handles
38 }
39 }
40 drivers.clear()
41 rmSync(tempDirectory, { recursive: true, force: true })
42 },
43 }
44}
45
46runRuntimePersistenceContractSuite(
47 `browser wa-sqlite runtime persistence helpers`,
48 {
49 createDatabaseHarness: createRuntimeDatabaseHarness,
50 createAdapter: (driver) =>
51 createBrowserWASQLitePersistence({
52 database: (driver as BrowserWASQLiteDriver).getDatabase(),
53 }).adapter,
54 createPersistence: (driver, coordinator) =>
55 createBrowserWASQLitePersistence({
56 database: (driver as BrowserWASQLiteDriver).getDatabase(),
57 coordinator,
58 }),
59 createCoordinator: () => new SingleProcessCoordinator(),
60 },
61)
62
63describe(`browser wa-sqlite persistence helpers`, () => {
64 it(`defaults coordinator to SingleProcessCoordinator`, () => {
65 const runtimeHarness = createRuntimeDatabaseHarness()
66 const driver = runtimeHarness.createDriver()
67 try {
68 const persistence = createBrowserWASQLitePersistence({
69 database: (driver as BrowserWASQLiteDriver).getDatabase(),
70 })
71 expect(persistence.coordinator).toBeInstanceOf(SingleProcessCoordinator)
72 } finally {
73 runtimeHarness.cleanup()
74 }
75 })
76
77 it(`allows overriding the default coordinator`, () => {
78 const runtimeHarness = createRuntimeDatabaseHarness()
79 const driver = runtimeHarness.createDriver()
80 try {
81 const coordinator = new SingleProcessCoordinator()
82 const persistence = createBrowserWASQLitePersistence({
83 database: (driver as BrowserWASQLiteDriver).getDatabase(),
84 coordinator,
85 })
86 expect(persistence.coordinator).toBe(coordinator)
87 } finally {
88 runtimeHarness.cleanup()
89 }
90 })
91
92 it(`infers schema policy from sync mode`, async () => {
93 const tempDirectory = mkdtempSync(
94 join(tmpdir(), `db-browser-schema-infer-`),
95 )
96 const dbPath = join(tempDirectory, `state.sqlite`)
97 const collectionId = `todos`
98 const firstDatabase = createWASQLiteTestDatabase({ filename: dbPath })
99
100 try {
101 const firstPersistence = createBrowserWASQLitePersistence({
102 database: firstDatabase,
103 })
104
105 const firstCollectionOptions = persistedCollectionOptions<
106 RuntimePersistenceContractTodo,
107 string
108 >({
109 id: collectionId,
110 schemaVersion: 1,
111 getKey: (todo) => todo.id,
112 persistence: firstPersistence,
113 })
114
115 await firstCollectionOptions.persistence.adapter.applyCommittedTx(
116 collectionId,
117 {
118 txId: `tx-1`,
119 term: 1,
120 seq: 1,
121 rowVersion: 1,
122 mutations: [
123 {
124 type: `insert`,
125 key: `1`,
126 value: {
127 id: `1`,
128 title: `before mismatch`,
129 score: 1,
130 },
131 },
132 ],
133 },
134 )
135 } finally {
136 await Promise.resolve(firstDatabase.close?.())
137 }
138
139 const secondDatabase = createWASQLiteTestDatabase({ filename: dbPath })
140 try {
141 const secondPersistence = createBrowserWASQLitePersistence({
142 database: secondDatabase,
143 })
144
145 const syncAbsentOptions = persistedCollectionOptions<
146 RuntimePersistenceContractTodo,
147 string
148 >({
149 id: collectionId,
150 schemaVersion: 2,
151 getKey: (todo) => todo.id,
152 persistence: secondPersistence,
153 })
154 await expect(
155 syncAbsentOptions.persistence.adapter.loadSubset(collectionId, {}),
156 ).rejects.toThrow(`Schema version mismatch`)
157
158 const syncPresentOptions = persistedCollectionOptions<
159 RuntimePersistenceContractTodo,
160 string
161 >({
162 id: collectionId,
163 schemaVersion: 2,
164 getKey: (todo) => todo.id,
165 sync: {
166 sync: ({ markReady }) => {
167 markReady()
168 },
169 },
170 persistence: secondPersistence,
171 })
172 const rows = await syncPresentOptions.persistence.adapter.loadSubset(
173 collectionId,
174 {},
175 )
176 expect(rows).toEqual([])
177 } finally {
178 await Promise.resolve(secondDatabase.close?.())
179 rmSync(tempDirectory, { recursive: true, force: true })
180 }
181 })
182})