Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

node-persistence.test.ts

216 lines6.3 KB

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