Merge commit '36c66dd290d3ce6eb1ccd310d0c658d4a32bb8eb' as 'repos/effect'

repos/effect/packages/sql/sqlite-react-native/src/SqliteClient.ts

@@ -0,0 +1,357 @@
+/**
+ * Connects Effect SQL to SQLite in React Native using
+ * `@op-engineering/op-sqlite`.
+ *
+ * This module opens an on-device SQLite database and exposes it as both
+ * `SqliteClient` and the generic Effect SQL client. It serializes access,
+ * supports normal and value-based queries, and uses the driver's synchronous
+ * query API by default. `AsyncQuery` and `withAsyncQuery` switch a scoped effect
+ * to the driver's asynchronous query API. Streaming queries and `updateValues`
+ * are not supported by this driver.
+ *
+ * @since 4.0.0
+ */
+import * as Sqlite from "@op-engineering/op-sqlite"
+import * as Config from "effect/Config"
+import * as Context from "effect/Context"
+import * as Effect from "effect/Effect"
+import * as Fiber from "effect/Fiber"
+import { constFalse, identity } from "effect/Function"
+import * as Layer from "effect/Layer"
+import * as Scope from "effect/Scope"
+import * as Semaphore from "effect/Semaphore"
+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 { classifySqliteError, SqlError } from "effect/unstable/sql/SqlError"
+import * as Statement from "effect/unstable/sql/Statement"
+
+const ATTR_DB_SYSTEM_NAME = "db.system.name"
+
+const classifyError = (cause: unknown, message: string, operation: string) =>
+  classifySqliteError(cause, { message, operation })
+
+/**
+ * Runtime identifier attached to SQLite React Native client values.
+ *
+ * @category type IDs
+ * @since 4.0.0
+ */
+export const TypeId: TypeId = "~@effect/sql-sqlite-react-native/SqliteClient"
+
+/**
+ * Type-level identifier for SQLite React Native client values.
+ *
+ * @category type IDs
+ * @since 4.0.0
+ */
+export type TypeId = "~@effect/sql-sqlite-react-native/SqliteClient"
+
+/**
+ * React Native SQLite client service interface, extending `SqlClient` with its configuration and marking `updateValues` as unsupported for SQLite.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface SqliteClient extends Client.SqlClient {
+  readonly [TypeId]: TypeId
+  readonly config: SqliteClientConfig
+
+  /** Not supported in sqlite */
+  readonly updateValues: never
+}
+
+/**
+ * Service tag for the React Native SQLite client.
+ *
+ * @category services
+ * @since 4.0.0
+ */
+export const SqliteClient = Context.Service<SqliteClient>("@effect/sql-sqlite-react-native/SqliteClient")
+
+/**
+ * Configuration for a React Native SQLite client, including the database filename, optional location and encryption key, span attributes, and query/result name transforms.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface SqliteClientConfig {
+  readonly filename: string
+  readonly location?: string | undefined
+  readonly encryptionKey?: string | undefined
+  readonly spanAttributes?: Record<string, unknown> | undefined
+  readonly transformResultNames?: ((str: string) => string) | undefined
+  readonly transformQueryNames?: ((str: string) => string) | undefined
+}
+
+/**
+ * Fiber reference that makes the React Native SQLite client run queries through the asynchronous `execute` API instead of `executeSync`.
+ *
+ * **When to use**
+ *
+ * Use to switch React Native SQLite query execution to the asynchronous driver
+ * API for a scoped effect.
+ *
+ * @category fiber refs
+ * @since 4.0.0
+ */
+export const AsyncQuery = Context.Reference<boolean>(
+  "@effect/sql-sqlite-react-native/Client/asyncQuery",
+  { defaultValue: constFalse }
+)
+
+/**
+ * Runs an effect with `AsyncQuery` enabled, causing React Native SQLite queries in that effect to use the asynchronous driver API.
+ *
+ * @category fiber refs
+ * @since 4.0.0
+ */
+export const withAsyncQuery = <R, E, A>(effect: Effect.Effect<A, E, R>) =>
+  Effect.provideService(effect, AsyncQuery, true)
+
+interface SqliteConnection extends Connection {}
+
+/**
+ * Creates a scoped React Native SQLite client from the supplied configuration, using a single serialized connection and honoring `AsyncQuery` for query execution.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export const make = (
+  options: SqliteClientConfig
+): Effect.Effect<SqliteClient, never, Scope.Scope | Reactivity.Reactivity> =>
+  Effect.gen(function*() {
+    const clientOptions: Parameters<typeof Sqlite.open>[0] = {
+      name: options.filename
+    }
+    if (options.location) {
+      clientOptions.location = options.location
+    }
+    if (options.encryptionKey) {
+      clientOptions.encryptionKey = options.encryptionKey
+    }
+
+    const compiler = Statement.makeCompilerSqlite(options.transformQueryNames)
+    const transformRows = options.transformResultNames ?
+      Statement.defaultTransforms(options.transformResultNames).array :
+      undefined
+
+    const makeConnection = Effect.gen(function*() {
+      const db = Sqlite.open(clientOptions) as DB
+      yield* Effect.addFinalizer(() => Effect.sync(() => db.close()))
+
+      const run = (
+        sql: string,
+        params: ReadonlyArray<unknown> = [],
+        values = false
+      ) =>
+        Effect.withFiber<Array<any>, SqlError>((fiber) => {
+          if (fiber.getRef(AsyncQuery)) {
+            return Effect.map(
+              Effect.tryPromise({
+                try: () => db.execute(sql, params as Array<any>),
+                catch: (cause) =>
+                  new SqlError({ reason: classifyError(cause, "Failed to execute statement (async)", "execute") })
+              }),
+              (result) => values ? result.rawRows ?? [] : result.rows
+            )
+          }
+          return Effect.try({
+            try: () => {
+              const result = db.executeSync(sql, params as Array<any>)
+              return values ? result.rawRows ?? [] : result.rows
+            },
+            catch: (cause) => new SqlError({ reason: classifyError(cause, "Failed to execute statement", "execute") })
+          })
+        })
+
+      return identity<SqliteConnection>({
+        execute(sql, params, transformRows) {
+          return transformRows
+            ? Effect.map(run(sql, params), transformRows)
+            : run(sql, params)
+        },
+        executeRaw(sql, params) {
+          return run(sql, params)
+        },
+        executeValues(sql, params) {
+          return run(sql, params, true)
+        },
+        executeValuesUnprepared(sql, params) {
+          return run(sql, params, true)
+        },
+        executeUnprepared(sql, params, transformRows) {
+          return this.execute(sql, params, transformRows)
+        },
+        executeStream() {
+          return Stream.die("executeStream not implemented")
+        }
+      })
+    })
+
+    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 Object.assign(
+      (yield* Client.make({
+        acquirer,
+        compiler,
+        transactionAcquirer,
+        spanAttributes: [
+          ...(options.spanAttributes ? Object.entries(options.spanAttributes) : []),
+          [ATTR_DB_SYSTEM_NAME, "sqlite"]
+        ],
+        transformRows
+      })) as SqliteClient,
+      {
+        [TypeId]: TypeId,
+        config: options
+      }
+    )
+  })
+
+/**
+ * Builds a layer from an Effect `Config` value, providing both the React Native `SqliteClient` service and the generic `SqlClient` service.
+ *
+ * @category layers
+ * @since 4.0.0
+ */
+export const layerConfig = (
+  config: Config.Wrap<SqliteClientConfig>
+): Layer.Layer<SqliteClient | Client.SqlClient, Config.ConfigError> =>
+  Layer.effectContext(
+    Config.unwrap(config).pipe(
+      Effect.flatMap(make),
+      Effect.map((client) =>
+        Context.make(SqliteClient, client).pipe(
+          Context.add(Client.SqlClient, client)
+        )
+      )
+    )
+  ).pipe(Layer.provide(Reactivity.layer))
+
+/**
+ * Builds a layer from a React Native SQLite client configuration, providing both `SqliteClient` and the generic `SqlClient` service.
+ *
+ * @category layers
+ * @since 4.0.0
+ */
+export const layer = (
+  config: SqliteClientConfig
+): Layer.Layer<SqliteClient | Client.SqlClient> =>
+  Layer.effectContext(
+    Effect.map(make(config), (client) =>
+      Context.make(SqliteClient, client).pipe(
+        Context.add(Client.SqlClient, client)
+      ))
+  ).pipe(Layer.provide(Reactivity.layer))
+
+interface DB {
+  close: () => void
+  delete: (location?: string) => void
+  attach: (params: {
+    secondaryDbFileName: string
+    alias: string
+    location?: string
+  }) => void
+  detach: (alias: string) => void
+  /**
+   * Sync version of the execute function
+   * It will block the JS thread and therefore your UI and should be used with caution
+   *
+   * When writing your queries, you can use the ? character as a placeholder for parameters
+   * The parameters will be automatically escaped and sanitized
+   *
+   * Example:
+   * db.executeSync('SELECT * FROM table WHERE id = ?', [1]);
+   *
+   * If you are writing a query that doesn't require parameters, you can omit the second argument
+   *
+   * If you are writing to the database YOU SHOULD BE USING TRANSACTIONS!
+   * Transactions protect you from partial writes and ensure that your data is always in a consistent state
+   */
+  executeSync: (query: string, params?: Array<any>) => QueryResult
+  /**
+   * Basic query execution function, it is async don't forget to await it
+   *
+   * When writing your queries, you can use the ? character as a placeholder for parameters
+   * The parameters will be automatically escaped and sanitized
+   *
+   * Example:
+   * await db.execute('SELECT * FROM table WHERE id = ?', [1]);
+   *
+   * If you are writing a query that doesn't require parameters, you can omit the second argument
+   *
+   * If you are writing to the database YOU SHOULD BE USING TRANSACTIONS!
+   * Transactions protect you from partial writes and ensure that your data is always in a consistent state
+   *
+   * If you need a large amount of queries ran as fast as possible you should be using `executeBatch`, `executeRaw`, `loadFile` or `executeWithHostObjects`
+   */
+  execute: (query: string, params?: Array<any>) => Promise<QueryResult>
+  /**
+   * Loads a runtime loadable sqlite extension. Libsql and iOS embedded version do not support loading extensions
+   */
+  loadExtension: (path: string, entryPoint?: string) => void
+  /**
+   * Same as `execute` except the results are not returned in objects but rather in arrays with just the values and not the keys
+   * It will be faster since a lot of repeated work is skipped and only the values you care about are returned
+   */
+  executeRaw: (query: string, params?: Array<any>) => Promise<Array<any>>
+  /**
+   * Same as `executeRaw` but it will block the JS thread and therefore your UI and should be used with caution
+   * It will return an array of arrays with just the values and not the keys
+   */
+  executeRawSync: (query: string, params?: Array<any>) => Array<any>
+  /**
+   * Get's the absolute path to the db file. Useful for debugging on local builds and for attaching the DB from users devices
+   */
+  getDbPath: (location?: string) => string
+  /**
+   * Reactive execution of queries when data is written to the database. Check the docs for how to use them.
+   */
+  reactiveExecute: (params: {
+    query: string
+    arguments: Array<any>
+    fireOn: Array<{
+      table: string
+      ids?: Array<number>
+    }>
+    callback: (response: any) => void
+  }) => () => void
+  /** This function is only available for libsql.
+   * Allows to trigger a sync the database with it's remote replica
+   * In order for this function to work you need to use openSync or openRemote functions
+   * with libsql: true in the package.json
+   *
+   * The database is hosted in turso
+   */
+  sync: () => void
+}
+
+interface QueryResult {
+  insertId?: number
+  rowsAffected: number
+  res?: Array<any>
+  rows: Array<Record<string, any>>
+  // An array of intermediate results, just values without column names
+  rawRows?: Array<Array<any>>
+  columnNames?: Array<string>
+  /**
+   * Query metadata, available only for select query results
+   */
+  metadata?: Array<any>
+}

repos/effect/packages/sql/sqlite-react-native/src/SqliteMigrator.ts

@@ -0,0 +1,55 @@
+/**
+ * Utilities for applying Effect SQL migrations to React Native SQLite databases.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers that execute ordered migrations through the
+ * current React Native SQLite `SqlClient`. Use it when a mobile app needs to
+ * bring its on-device database schema up to date during startup, before opening
+ * repositories or sync services, or in integration tests that create app-local
+ * database files.
+ *
+ * React Native SQLite databases are scoped by the client configuration, so the
+ * migrator should be run with the same `filename`, `location`, and encryption
+ * key as the rest of the application. Migrations run through the package's
+ * single serialized connection; by default statements use the synchronous
+ * driver API and can block the JS thread, so long migration sets may want to run
+ * under `SqliteClient.withAsyncQuery`. Mobile upgrades can be interrupted by app
+ * suspension or process death, so keep migrations transaction-aware and avoid
+ * assuming a fresh database on every launch.
+ *
+ * @since 4.0.0
+ */
+import type * as Effect from "effect/Effect"
+import * as Layer from "effect/Layer"
+import * as Migrator from "effect/unstable/sql/Migrator"
+import type * as Client from "effect/unstable/sql/SqlClient"
+import type { SqlError } from "effect/unstable/sql/SqlError"
+
+/**
+ * @since 4.0.0
+ */
+export * from "effect/unstable/sql/Migrator"
+
+/**
+ * Runs SQL migrations for a React Native SQLite database using the shared `Migrator` implementation and the current `SqlClient`.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export const run: <R>(
+  options: Migrator.MigratorOptions<R>
+) => Effect.Effect<
+  ReadonlyArray<readonly [id: number, name: string]>,
+  SqlError | Migrator.MigrationError,
+  Client.SqlClient | R
+> = Migrator.make({})
+
+/**
+ * Creates a layer that runs the configured React Native SQLite migrations during layer construction and provides no services.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export const layer = <R>(
+  options: Migrator.MigratorOptions<R>
+): Layer.Layer<never, SqlError | Migrator.MigrationError, R | Client.SqlClient> => Layer.effectDiscard(run(options))

repos/effect/packages/sql/sqlite-react-native/src/index.ts

@@ -0,0 +1,15 @@
+/**
+ * @since 4.0.0
+ */
+
+// @barrel: Auto-generated exports. Do not edit manually.
+
+/**
+ * @since 4.0.0
+ */
+export * as SqliteClient from "./SqliteClient.ts"
+
+/**
+ * @since 4.0.0
+ */
+export * as SqliteMigrator from "./SqliteMigrator.ts"