# Files changed · PR \#7272 · pingdotgg/t3code [View on GitCafe](https://git.cafe/pingdotgg/t3code/pull/7272/diffs) Repository: [pingdotgg/t3code](https://git.cafe/pingdotgg/t3code) Visibility: public [refactor\(shared\): move the node:sqlite Effect SQL client into shared](https://git.cafe/pingdotgg/t3code/pull/7272.md) Version: 5 Head commit: ae568f8bd04fb8734dc76529f42363c8f544c1bf Base commit: 1a5aa8592169f1da2a1db4aaf9472887eb70b4a9 Comparison base: 1a5aa8592169f1da2a1db4aaf9472887eb70b4a9 Showing up to 20 entries from this revision. If the pull request changes, reopen the first page before continuing. ## apps/server/scripts/migrate-dev-db.test.ts Status: modified; +1; −1 ```diff @@ -6,7 +6,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { runMigrations } from "../src/persistence/Migrations.ts"; -import * as NodeSqliteClient from "../src/persistence/NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; import { runMigrateDevDb } from "./migrate-dev-db.ts"; const withDatabase = ( ``` ## apps/server/scripts/migrate-dev-db.ts Status: modified; +1; −1 ```diff @@ -39,7 +39,7 @@ import { Command, Flag } from "effect/unstable/cli"; import { migrationManifest, runMigrations } from "../src/persistence/Migrations.ts"; -import * as NodeSqliteClient from "../src/persistence/NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; export class MigrateDevDbNotInWorktreeError extends Schema.TaggedErrorClass()( "MigrateDevDbNotInWorktreeError", ``` ## apps/server/scripts/t3-sqlite-state.test.ts Status: modified; +1; −1 ```diff @@ -5,7 +5,7 @@ import * as Path from "effect/Path"; import * as SqlClient from "effect/unstable/sql/SqlClient"; -import * as NodeSqliteClient from "../src/persistence/NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; import { runSqliteState } from "./t3-sqlite-state.ts"; const createFixtureDatabase = Effect.fn("createSqliteStateFixtureDatabase")(function* ( ``` ## apps/server/scripts/t3-sqlite-state.ts Status: modified; +1; −1 ```diff @@ -15,7 +15,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { Argument, Command, Flag } from "effect/unstable/cli"; -import * as NodeSqliteClient from "../src/persistence/NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; export const SqliteStateOperation = Schema.Literals(["query", "exec"]); export type SqliteStateOperation = typeof SqliteStateOperation.Type; ``` ## apps/server/src/persistence/Layers/Sqlite.ts Status: modified; +1; −1 ```diff @@ -18,7 +18,7 @@ }; const defaultSqliteClientLoaders = { bun: () => import("@effect/sql-sqlite-bun/SqliteClient"), - node: () => import("../NodeSqliteClient.ts"), + node: () => import("@t3tools/shared/nodeSqliteClient"), } satisfies Record Promise>; const makeRuntimeSqliteLayer = Effect.fn("makeRuntimeSqliteLayer")(function* ( ``` ## apps/server/src/persistence/Migrations/016_CanonicalizeModelSelections.test.ts Status: modified; +1; −1 ```diff @@ -4,7 +4,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { runMigrations } from "../Migrations.ts"; -import * as NodeSqliteClient from "../NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; const layer = it.layer(Layer.mergeAll(NodeSqliteClient.layerMemory())); ``` ## apps/server/src/persistence/Migrations/019_ProjectionSnapshotLookupIndexes.test.ts Status: modified; +1; −1 ```diff @@ -4,7 +4,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { runMigrations } from "../Migrations.ts"; -import * as NodeSqliteClient from "../NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; const layer = it.layer(Layer.mergeAll(NodeSqliteClient.layerMemory())); ``` ## apps/server/src/persistence/Migrations/024_BackfillProjectionThreadShellSummary.test.ts Status: modified; +1; −1 ```diff @@ -4,7 +4,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { runMigrations } from "../Migrations.ts"; -import * as NodeSqliteClient from "../NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; const layer = it.layer(Layer.mergeAll(NodeSqliteClient.layerMemory())); ``` ## apps/server/src/persistence/Migrations/025_CleanupInvalidProjectionPendingApprovals.test.ts Status: modified; +1; −1 ```diff @@ -4,7 +4,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { runMigrations } from "../Migrations.ts"; -import * as NodeSqliteClient from "../NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; const layer = it.layer(Layer.mergeAll(NodeSqliteClient.layerMemory())); ``` ## apps/server/src/persistence/Migrations/026_CanonicalizeModelSelectionOptions.test.ts Status: modified; +1; −1 ```diff @@ -4,7 +4,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { runMigrations } from "../Migrations.ts"; -import * as NodeSqliteClient from "../NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; const layer = it.layer(Layer.mergeAll(NodeSqliteClient.layerMemory())); ``` ## apps/server/src/persistence/Migrations/027_028_ProviderInstanceIdColumns.test.ts Status: modified; +1; −1 ```diff @@ -4,7 +4,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { runMigrations } from "../Migrations.ts"; -import * as NodeSqliteClient from "../NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; const layer = it.layer(Layer.mergeAll(NodeSqliteClient.layerMemory())); ``` ## apps/server/src/persistence/Migrations/029_ProjectionThreadDetailOrderingIndexes.test.ts Status: modified; +1; −1 ```diff @@ -4,7 +4,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { runMigrations } from "../Migrations.ts"; -import * as NodeSqliteClient from "../NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; const layer = it.layer(Layer.mergeAll(NodeSqliteClient.layerMemory())); ``` ## apps/server/src/persistence/Migrations/031_AuthAuthorizationScopes.test.ts Status: modified; +1; −1 ```diff @@ -4,7 +4,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { runMigrations } from "../Migrations.ts"; -import * as NodeSqliteClient from "../NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; const layer = it.layer(Layer.mergeAll(NodeSqliteClient.layerMemory())); ``` ## apps/server/src/persistence/Migrations/035_ProjectionThreadTitleRegeneration.test.ts Status: modified; +1; −1 ```diff @@ -4,7 +4,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { runMigrations } from "../Migrations.ts"; -import * as NodeSqliteClient from "../NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; const layer = it.layer(Layer.mergeAll(NodeSqliteClient.layerMemory())); ``` ## apps/server/src/persistence/Migrations/040_ProjectionProjectFaviconPath.test.ts Status: modified; +1; −1 ```diff @@ -4,7 +4,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { runMigrations } from "../Migrations.ts"; -import * as NodeSqliteClient from "../NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; const layer = it.layer(Layer.mergeAll(NodeSqliteClient.layerMemory())); ``` ## apps/server/src/persistence/Migrations/041_AuthSessionClientConnection.test.ts Status: modified; +1; −1 ```diff @@ -4,7 +4,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { runMigrations } from "../Migrations.ts"; -import * as NodeSqliteClient from "../NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; const layer = it.layer(Layer.mergeAll(NodeSqliteClient.layerMemory())); ``` ## apps/server/src/persistence/Migrations/042_ProjectionThreadLinkedPullRequest.test.ts Status: modified; +1; −1 ```diff @@ -4,7 +4,7 @@ import * as SqlClient from "effect/unstable/sql/SqlClient"; import { runMigrations } from "../Migrations.ts"; -import * as NodeSqliteClient from "../NodeSqliteClient.ts"; +import * as NodeSqliteClient from "@t3tools/shared/nodeSqliteClient"; const layer = it.layer(Layer.mergeAll(NodeSqliteClient.layerMemory())); ``` ## apps/server/src/persistence/NodeSqliteClient.test.ts Status: deleted; +0; −56 ```diff @@ -1,56 +1,0 @@ -import { assert, it } from "@effect/vitest"; -import * as Effect from "effect/Effect"; -import * as Layer from "effect/Layer"; -import * as SqlClient from "effect/unstable/sql/SqlClient"; - -import * as SqliteClient from "./NodeSqliteClient.ts"; - -const layer = it.layer(SqliteClient.layerMemory()); - -layer("NodeSqliteClient", (it) => { - it.effect("runs prepared queries and returns positional values", () => - Effect.gen(function* () { - const sql = yield* SqlClient.SqlClient; - - yield* sql`CREATE TABLE entries(id INTEGER PRIMARY KEY, name TEXT NOT NULL)`; - yield* sql`INSERT INTO entries(name) VALUES (${"alpha"}), (${"beta"})`; - - const rows = yield* sql<{ readonly id: number; readonly name: string }>` - SELECT id, name FROM entries ORDER BY id - `; - assert.equal(rows.length, 2); - assert.equal(rows[0]?.name, "alpha"); - assert.equal(rows[1]?.name, "beta"); - - const values = yield* sql`SELECT id, name FROM entries ORDER BY id`.values; - assert.equal(values.length, 2); - assert.equal(values[0]?.[1], "alpha"); - assert.equal(values[1]?.[1], "beta"); - - const unpreparedValues = yield* sql`SELECT id, name FROM entries ORDER BY id` - .valuesUnprepared; - assert.deepEqual(unpreparedValues, values); - }), - ); - - it.effect("returns a typed failure when an unprepared statement cannot be prepared", () => - Effect.gen(function* () { - const sql = yield* SqlClient.SqlClient; - const error = yield* Effect.flip(sql.unsafe("SELECT FROM").unprepared); - - assert.equal(error._tag, "SqlError"); - assert.equal(error.reason.operation, "prepare"); - }), - ); -}); - -it.effect("returns a typed failure when the database cannot be opened", () => - Effect.gen(function* () { - const error = yield* Effect.flip( - Layer.build(SqliteClient.layer({ filename: "\0" })).pipe(Effect.scoped), - ); - - assert.equal(error._tag, "SqlError"); - assert.equal(error.reason.operation, "open"); - }), -); ``` ## apps/server/src/persistence/NodeSqliteClient.ts Status: deleted; +0; −331 ```diff @@ -1,331 +1,0 @@ -/** - * Port of `@effect/sql-sqlite-node` that uses the native `node:sqlite` - * bindings instead of `better-sqlite3`. - * - * @module SqliteClient - */ -import * as NodeSqlite from "node:sqlite"; - -import * as Cache from "effect/Cache"; -import * as Config from "effect/Config"; -import * as Duration from "effect/Duration"; -import * as Effect from "effect/Effect"; -import * as Fiber from "effect/Fiber"; -import { identity } from "effect/Function"; -import * as Layer from "effect/Layer"; -import * as Schema from "effect/Schema"; -import * as Scope from "effect/Scope"; -import * as Semaphore from "effect/Semaphore"; -import * as Context from "effect/Context"; -import * as Stream from "effect/Stream"; -import * as Reactivity from "effect/unstable/reactivity/Reactivity"; -import * as Client from "effect/unstable/sql/SqlClient"; -import type { Connection } from "effect/unstable/sql/SqlConnection"; -import { SqlError, classifySqliteError } from "effect/unstable/sql/SqlError"; -import * as Statement from "effect/unstable/sql/Statement"; - -const ATTR_DB_SYSTEM_NAME = "db.system.name"; - -export const TypeId: TypeId = "~local/sqlite-node/SqliteClient"; - -export type TypeId = "~local/sqlite-node/SqliteClient"; - -export interface SqliteClientConfig { - readonly filename: string; - readonly readonly?: boolean | undefined; - readonly allowExtension?: boolean | undefined; - readonly prepareCacheSize?: number | undefined; - readonly prepareCacheTTL?: Duration.Input | undefined; - readonly spanAttributes?: Record | undefined; - readonly transformResultNames?: ((str: string) => string) | undefined; - readonly transformQueryNames?: ((str: string) => string) | undefined; -} - -export interface SqliteMemoryClientConfig extends Omit< - SqliteClientConfig, - "filename" | "readonly" -> {} - -export class UnsupportedNodeSqliteVersionError extends Schema.TaggedErrorClass()( - "UnsupportedNodeSqliteVersionError", - { - nodeVersion: Schema.String, - requirement: Schema.String, - }, -) { - override get message(): string { - return `Node.js ${this.nodeVersion} is missing required node:sqlite APIs. Upgrade to ${this.requirement}.`; - } -} - -export class UnsupportedNodeSqliteOperationError extends Schema.TaggedErrorClass()( - "UnsupportedNodeSqliteOperationError", - {}, -) { - override get message(): string { - return "Node SQLite does not support executeStream."; - } -} - -/** - * Verify that the current Node.js version includes the `node:sqlite` APIs - * used by `NodeSqliteClient` — specifically `StatementSync.columns()` (added - * in Node 22.16.0 / 23.11.0). - * - * @see https://github.com/nodejs/node/pull/57490 - */ -const checkNodeSqliteCompat = () => { - const parts = process.versions.node.split(".").map(Number); - const major = parts[0] ?? 0; - const minor = parts[1] ?? 0; - const supported = (major === 22 && minor >= 16) || (major === 23 && minor >= 11) || major >= 24; - - if (!supported) { - return Effect.die( - new UnsupportedNodeSqliteVersionError({ - nodeVersion: process.versions.node, - requirement: "Node.js >=22.16, >=23.11, or >=24", - }), - ); - } - return Effect.void; -}; - -const makeWithDatabase = Effect.fn("makeWithDatabase")(function* ( - options: SqliteClientConfig, - openDatabase: () => NodeSqlite.DatabaseSync, -): Effect.fn.Return { - yield* checkNodeSqliteCompat(); - - const compiler = Statement.makeCompilerSqlite(options.transformQueryNames); - const transformRows = options.transformResultNames - ? Statement.defaultTransforms(options.transformResultNames).array - : undefined; - - const makeConnection = Effect.gen(function* () { - const scope = yield* Effect.scope; - const db = yield* Effect.try({ - try: openDatabase, - catch: (cause) => - new SqlError({ - reason: classifySqliteError(cause, { - message: "Failed to open database", - operation: "open", - }), - }), - }); - yield* Scope.addFinalizer( - scope, - Effect.try({ - try: () => db.close(), - catch: (cause) => - new SqlError({ - reason: classifySqliteError(cause, { - message: "Failed to close database", - operation: "close", - }), - }), - }).pipe(Effect.orDie), - ); - - const statementReaderCache = new WeakMap(); - const hasRows = (statement: NodeSqlite.StatementSync): boolean => { - const cached = statementReaderCache.get(statement); - if (cached !== undefined) { - return cached; - } - const value = statement.columns().length > 0; - statementReaderCache.set(statement, value); - return value; - }; - - const prepare = (sql: string) => - Effect.try({ - try: () => db.prepare(sql), - catch: (cause) => - new SqlError({ - reason: classifySqliteError(cause, { - message: "Failed to prepare statement", - operation: "prepare", - }), - }), - }); - - const prepareCache = yield* Cache.make({ - capacity: options.prepareCacheSize ?? 200, - timeToLive: options.prepareCacheTTL ?? Duration.minutes(10), - lookup: prepare, - }); - - const runStatement = ( - statement: NodeSqlite.StatementSync, - params: ReadonlyArray, - raw: boolean, - ) => - Effect.withFiber, SqlError>((fiber) => { - try { - statement.setReadBigInts(Boolean(Context.get(fiber.context, Client.SafeIntegers))); - if (hasRows(statement)) { - return Effect.succeed(statement.all(...(params as any))); - } - const result = statement.run(...(params as any)); - return Effect.succeed(raw ? (result as unknown as ReadonlyArray) : []); - } catch (cause) { - return Effect.fail( - new SqlError({ - reason: classifySqliteError(cause, { - message: "Failed to execute statement", - operation: "execute", - }), - }), - ); - } - }); - - const run = (sql: string, params: ReadonlyArray, raw = false) => - Effect.flatMap(Cache.get(prepareCache, sql), (s) => runStatement(s, params, raw)); - - const runStatementValues = ( - statement: NodeSqlite.StatementSync, - params: ReadonlyArray, - ) => - Effect.acquireUseRelease( - Effect.succeed(statement), - (statement) => - Effect.try({ - try: () => { - if (hasRows(statement)) { - statement.setReturnArrays(true); - // Safe to cast to array after we've setReturnArrays(true) - return statement.all(...(params as any)) as unknown as ReadonlyArray< - ReadonlyArray - >; - } - statement.run(...(params as any)); - return []; - }, - catch: (cause) => - new SqlError({ - reason: classifySqliteError(cause, { - message: "Failed to execute statement", - operation: "execute", - }), - }), - }), - (statement) => - Effect.try({ - try: () => { - if (hasRows(statement)) { - statement.setReturnArrays(false); - } - }, - catch: (cause) => - new SqlError({ - reason: classifySqliteError(cause, { - message: "Failed to reset statement result mode", - operation: "resetResultMode", - }), - }), - }).pipe(Effect.orDie), - ); - - const runValues = (sql: string, params: ReadonlyArray) => - Effect.flatMap(Cache.get(prepareCache, sql), (statement) => - runStatementValues(statement, params), - ); - - return identity({ - execute(sql, params, rowTransform) { - return rowTransform ? Effect.map(run(sql, params), rowTransform) : run(sql, params); - }, - executeRaw(sql, params) { - return run(sql, params, true); - }, - executeValues(sql, params) { - return runValues(sql, params); - }, - executeValuesUnprepared(sql, params) { - return Effect.flatMap(prepare(sql), (statement) => - runStatementValues(statement, params ?? []), - ); - }, - executeUnprepared(sql, params, rowTransform) { - const effect = prepare(sql).pipe( - Effect.flatMap((statement) => runStatement(statement, params ?? [], false)), - ); - return rowTransform ? Effect.map(effect, rowTransform) : effect; - }, - executeStream(_sql, _params) { - return Stream.die(new UnsupportedNodeSqliteOperationError()); - }, - }); - }); - - const semaphore = yield* Semaphore.make(1); - const connection = yield* makeConnection; - - const acquirer = semaphore.withPermits(1)(Effect.succeed(connection)); - const transactionAcquirer = Effect.uninterruptibleMask((restore) => { - const fiber = Fiber.getCurrent()!; - const scope = Context.getUnsafe(fiber.context, Scope.Scope); - return Effect.as( - Effect.tap(restore(semaphore.take(1)), () => Scope.addFinalizer(scope, semaphore.release(1))), - connection, - ); - }); - - return yield* Client.make({ - acquirer, - compiler, - transactionAcquirer, - spanAttributes: [ - ...(options.spanAttributes ? Object.entries(options.spanAttributes) : []), - [ATTR_DB_SYSTEM_NAME, "sqlite"], - ], - transformRows, - }); -}); - -const make = ( - options: SqliteClientConfig, -): Effect.Effect => - makeWithDatabase( - options, - () => - new NodeSqlite.DatabaseSync(options.filename, { - readOnly: options.readonly ?? false, - allowExtension: options.allowExtension ?? false, - }), - ); - -const makeMemory = ( - config: SqliteMemoryClientConfig = {}, -): Effect.Effect => - makeWithDatabase( - { - ...config, - filename: ":memory:", - readonly: false, - }, - () => { - const database = new NodeSqlite.DatabaseSync(":memory:", { - allowExtension: config.allowExtension ?? false, - }); - return database; - }, - ); - -export const layerConfig = ( - config: Config.Wrap, -): Layer.Layer => - Layer.effect(Client.SqlClient, Config.unwrap(config).pipe(Effect.flatMap(make))).pipe( - Layer.provide(Reactivity.layer), - ); - -export const layer = (config: SqliteClientConfig): Layer.Layer => - Layer.effect(Client.SqlClient, make(config)).pipe(Layer.provide(Reactivity.layer)); - -export const layerMemory = ( - config: SqliteMemoryClientConfig = {}, -): Layer.Layer => - Layer.effect(Client.SqlClient, makeMemory(config)).pipe(Layer.provide(Reactivity.layer)); ``` ## packages/shared/package.json Status: modified; +4; −0 ```diff @@ -246,6 +246,10 @@ "./claudeCompaction": { "types": "./src/claudeCompaction.ts", "import": "./src/claudeCompaction.ts" + }, + "./nodeSqliteClient": { + "types": "./src/nodeSqliteClient.ts", + "import": "./src/nodeSqliteClient.ts" } }, "scripts": { ``` [Next page](https://git.cafe/pingdotgg/t3code/pull/7272/diffs?after=InBhY2thZ2VzL3NoYXJlZC9wYWNrYWdlLmpzb24i&expectedVersion=5&format=markdown)