expo-sqlite-mock 2.0.1 → 2.2.0

package/README.md

@@ -3,11 +3,11 @@
 [![License: MIT](https://img.shields.io/npm/l/expo-sqlite-mock.svg)](https://github.com/zfben/expo-sqlite-mock/blob/main/packages/faasjs/jest/LICENSE)
 [![NPM Version](https://img.shields.io/npm/v/expo-sqlite-mock.svg)](https://www.npmjs.com/package/expo-sqlite-mock)
 
-Use expo-sqlite with jest.
+Use [expo-sqlite](https://docs.expo.dev/versions/latest/sdk/sqlite/) with jest.
 
 ## Notice
 
-- **~2.0.0** is for expo-sqlite ~52.
+- **~2.0.0** is for expo-sqlite >=52.
 - **~1.0.0** is for expo-sqlite ~51.
 
 ## Usage
@@ -15,8 +15,51 @@ Use expo-sqlite with jest.
 1. `npm install -D expo-sqlite-mock` or `bun add -D expo-sqlite-mock`
 2. Add `"setupFilesAfterEnv": ["expo-sqlite-mock/src/setup.ts"]` and `"testTimeout": 10000` to your jest config (It's in `package.json` for default expo project).
 
+Example:
+
+```json
+{
+  "jest": {
+    "preset": "jest-expo",
+    "setupFilesAfterEnv": ["expo-sqlite-mock/src/setup.ts"],
+    "testTimeout": 10000
+  }
+}
+```
+
+### Advanced
+
+You can set the `EXPO_SQLITE_MOCK` environment variable to a custom SQLite database location.
+
+Tips:
+
+1. Please use `JEST_WORKER_ID` to avoid concurrent test cases writing to the same file.
+2. Update your `.gitignore` to ignore the SQLite database file.
+
+Example:
+
+```ts
+it("test", async () => {
+  // or you can set it beforeAll or beforeEach
+  process.env.EXPO_SQLITE_MOCK = `${__dirname}/test_${process.env.JEST_WORKER_ID}.db`;
+
+  // your test code
+
+  // clear the env var
+  delete process.env.EXPO_SQLITE_MOCK;
+});
+```
+
 ## Changelog
 
+- **2.2.0**
+  - Compatible with drizzle
+  - Clean up the code
+
+- **2.1.0**
+  - Support custom SQLite database location by setting the `EXPO_SQLITE_MOCK` environment variable.
+  - Update peer dependencies.
+
 - **2.0.1**
   - Fix setup.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-sqlite-mock",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "license": "MIT",
   "homepage": "https://github.com/zfben/expo-sqlite-mock",
   "repository": {
@@ -11,10 +11,11 @@
     "url": "https://github.com/zfben/expo-sqlite-mock/issues"
   },
   "scripts": {
-    "test": "jest --coverage --forceExit --detectOpenHandles --testTimeout=10000"
+    "test": "jest --coverage --forceExit --testTimeout=10000"
   },
   "jest": {
     "preset": "jest-expo",
+    "testEnvironment": "node",
     "testRegex": "/*\\.test\\.tsx?$"
   },
   "files": [
@@ -25,19 +26,22 @@
     "better-sqlite3": "*",
     "jest": "*",
     "expo-sqlite": "*",
-    "expo": "~52"
+    "expo": ">=52"
   },
   "devDependencies": {
     "typescript": "*",
-    "@biomejs/biome": "*",
+    "@faasjs/lint": "*",
     "expo-sqlite": "*",
     "better-sqlite3": "*",
     "@types/better-sqlite3": "*",
-    "@types/react": "*",
-    "react": "*",
-    "react-test-renderer": "18.3.1",
-    "@faasjs/jest": "*",
+    "@types/react": "^18",
+    "react": "^18",
+    "react-test-renderer": "^18",
+    "react-native": "~0.77",
     "@testing-library/react-native": "*",
-    "jest-expo": "~52"
+    "jest-expo": "~52",
+    "@types/jest": "*",
+    "jest": "*",
+    "drizzle-orm": "*"
   }
 }

package/src/ExpoSQLiteNext.ts

@@ -1,4 +1,3 @@
-import assert from 'node:assert'
 import sqlite3 from 'better-sqlite3'
 
 import type { SQLiteOpenOptions } from 'expo-sqlite/src/NativeDatabase'
@@ -18,19 +17,18 @@ export const mockedExpoSqliteNext = {
     for (const db of dbs) await db.closeAsync()
   },
 
-  NativeDatabase: jest
-    .fn()
-    .mockImplementation(
-      (databaseName: string, options?: SQLiteOpenOptions, serializedData?: Uint8Array) =>
-        new NativeDatabase(databaseName, options, serializedData)
-    ),
+  NativeDatabase: (
+    databaseName: string,
+    options?: SQLiteOpenOptions,
+    serializedData?: Uint8Array
+  ) => new NativeDatabase(databaseName, options, serializedData),
 
-  NativeStatement: jest.fn().mockImplementation(() => new NativeStatement()),
+  NativeStatement: () => new NativeStatement(),
 
   defaultDatabaseDirectory: '.',
 
-  ensureDatabasePathExistsAsync: jest.fn().mockImplementation(async (databasePath: string) => {}),
-  ensureDatabasePathExistsSync: jest.fn().mockImplementation((databasePath: string) => {}),
+  ensureDatabasePathExistsAsync: async (_databasePath: string) => {},
+  ensureDatabasePathExistsSync: (_databasePath: string) => {},
 }
 
 //#region async sqlite3
@@ -41,22 +39,27 @@ export const mockedExpoSqliteNext = {
 class NativeDatabase {
   private readonly sqlite3Db: sqlite3.Database
 
-  constructor(databaseName: string, options?: SQLiteOpenOptions, serializedData?: Uint8Array) {
+  constructor(
+    _databaseName: string,
+    _options?: SQLiteOpenOptions,
+    serializedData?: Uint8Array
+  ) {
     if (serializedData != null) {
       this.sqlite3Db = new sqlite3(Buffer.from(serializedData))
     } else {
-      this.sqlite3Db = new sqlite3(':memory:')
+      this.sqlite3Db = new sqlite3(process.env.EXPO_SQLITE_MOCK || ':memory:')
     }
     dbs.push(this)
   }
 
   //#region Asynchronous API
 
-  initAsync = jest.fn().mockResolvedValue(null)
+  initAsync = () => Promise.resolve()
   isInTransactionAsync = async () => this.sqlite3Db.inTransaction
   closeAsync = async () => this.sqlite3Db.close()
   execAsync = async (source: string) => this.sqlite3Db.exec(source)
-  serializeAsync = async (databaseName: string) => this.sqlite3Db.serialize({ attached: databaseName })
+  serializeAsync = async (databaseName: string) =>
+    this.sqlite3Db.serialize({ attached: databaseName })
   prepareAsync = async (nativeStatement: NativeStatement, source: string) => {
     nativeStatement.sqlite3Stmt = this.sqlite3Db.prepare(source)
   }
@@ -65,11 +68,12 @@ class NativeDatabase {
 
   //#region Synchronous API
 
-  initSync = jest.fn()
+  initSync = () => {}
   isInTransactionSync = () => this.sqlite3Db.inTransaction
   closeSync = () => this.sqlite3Db.close()
   execSync = (source: string) => this.sqlite3Db.exec(source)
-  serializeSync = (databaseName: string) => this.sqlite3Db.serialize({ attached: databaseName })
+  serializeSync = (databaseName: string) =>
+    this.sqlite3Db.serialize({ attached: databaseName })
   prepareSync = (nativeStatement: NativeStatement, source: string) => {
     nativeStatement.sqlite3Stmt = this.sqlite3Db.prepare(source)
   }
@@ -82,40 +86,43 @@ class NativeDatabase {
 class NativeStatement {
   public sqlite3Stmt: sqlite3.Statement | null = null
   private iterator: ReturnType<sqlite3.Statement['iterate']> | null = null
+  private cachedRows: any[] = []
 
   //#region Asynchronous API
 
-  public runAsync = jest
-    .fn()
-    .mockImplementation(
-      (
-        database: NativeDatabase,
-        bindParams: SQLiteBindPrimitiveParams,
-        bindBlobParams: SQLiteBindBlobParams,
-        shouldPassAsArray: boolean
-      ): Promise<SQLiteRunResult & { firstRowValues: SQLiteColumnValues }> =>
-        Promise.resolve(this._run(normalizeSQLite3Args(bindParams, bindBlobParams, shouldPassAsArray)))
+  public runAsync = (
+    _database: NativeDatabase,
+    bindParams: SQLiteBindPrimitiveParams,
+    bindBlobParams: SQLiteBindBlobParams,
+    shouldPassAsArray: boolean
+  ): Promise<SQLiteRunResult & { firstRowValues: SQLiteColumnValues }> =>
+    Promise.resolve(
+      this._run(
+        normalizeSQLite3Args(bindParams, bindBlobParams, shouldPassAsArray)
+      )
     )
-  public stepAsync = jest.fn().mockImplementation((database: NativeDatabase): Promise<any> => {
-    assert(this.sqlite3Stmt)
+  public stepAsync = (_database: NativeDatabase): Promise<any> => {
     if (this.iterator == null) {
       this.iterator = this.sqlite3Stmt.iterate()
       // Since the first row is retrieved by `_run()`, we need to skip the first row here.
       this.iterator.next()
     }
     const result = this.iterator.next()
-    const columnValues = result.done === false ? Object.values(result.value as Record<string, any>) : null
+    const columnValues =
+      result.done === false
+        ? Object.values(result.value as Record<string, any>)
+        : null
     return Promise.resolve(columnValues)
-  })
-  public getAllAsync = (database: NativeDatabase) => Promise.resolve(this._allValues())
-  public getColumnNamesAsync = async (database: NativeDatabase) => {
-    assert(this.sqlite3Stmt)
+  }
+  public getAllAsync = (_database: NativeDatabase) =>
+    Promise.resolve(this._allValues())
+  public getColumnNamesAsync = async (_database: NativeDatabase) => {
     return this.sqlite3Stmt.columns().map(column => column.name)
   }
-  public resetAsync = async (database: NativeDatabase) => {
+  public resetAsync = async (_database: NativeDatabase) => {
     this._reset()
   }
-  public finalizeAsync = async (database: NativeDatabase) => {
+  public finalizeAsync = async (_database: NativeDatabase) => {
     this._finalize()
   }
 
@@ -123,19 +130,17 @@ class NativeStatement {
 
   //#region Synchronous API
 
-  public runSync = jest
-    .fn()
-    .mockImplementation(
-      (
-        database: NativeDatabase,
-        bindParams: SQLiteBindPrimitiveParams,
-        bindBlobParams: SQLiteBindBlobParams,
-        shouldPassAsArray: boolean
-      ): SQLiteRunResult & { firstRowValues: SQLiteColumnValues } =>
-        this._run(normalizeSQLite3Args(bindParams, bindBlobParams, shouldPassAsArray))
+  public runSync = (
+    _database: NativeDatabase,
+    bindParams: SQLiteBindPrimitiveParams,
+    bindBlobParams: SQLiteBindBlobParams,
+    shouldPassAsArray: boolean
+  ): SQLiteRunResult & { firstRowValues: SQLiteColumnValues } =>
+    this._run(
+      normalizeSQLite3Args(bindParams, bindBlobParams, shouldPassAsArray)
     )
-  public stepSync = (database: NativeDatabase): any => {
-    assert(this.sqlite3Stmt)
+
+  public stepSync = (_database: NativeDatabase): any => {
     if (this.iterator == null) {
       this.iterator = this.sqlite3Stmt.iterate()
       // Since the first row is retrieved by `_run()`, we need to skip the first row here.
@@ -143,33 +148,48 @@ class NativeStatement {
     }
 
     const result = this.iterator.next()
-    const columnValues = result.done === false ? Object.values(result.value as Record<string, any>) : null
+    const columnValues =
+      result.done === false
+        ? Object.values(result.value as Record<string, any>)
+        : null
     return columnValues
   }
-  public getAllSync = (database: NativeDatabase) => this._allValues()
-  public getColumnNamesSync = (database: NativeDatabase) => {
-    assert(this.sqlite3Stmt)
+  public getAllSync = (_database: NativeDatabase) => this._allValues()
+  public getColumnNamesSync = (_database: NativeDatabase) => {
     return this.sqlite3Stmt.columns().map(column => column.name)
   }
-  public resetSync = (database: NativeDatabase) => {
+  public resetSync = (_database: NativeDatabase) => {
     this._reset()
   }
-  public finalizeSync = (database: NativeDatabase) => {
+  public finalizeSync = (_database: NativeDatabase) => {
     this._finalize()
   }
 
   //#endregion
 
-  private _run = (...params: any[]): SQLiteRunResult & { firstRowValues: SQLiteColumnValues } => {
-    assert(this.sqlite3Stmt)
+  private _run = (
+    ...params: any[]
+  ): SQLiteRunResult & { firstRowValues: SQLiteColumnValues } => {
     this.sqlite3Stmt.bind(...params)
+
+    // Avoid insert with returning being executed multiple times
+    if (this.sqlite3Stmt.source.includes(' returning ')) {
+      this.cachedRows = this.sqlite3Stmt.all()
+
+      return {
+        lastInsertRowId: this.cachedRows[0].id,
+        changes: params.length,
+        firstRowValues: Object.values(this.cachedRows[0]),
+      }
+    }
+
     const result = this.sqlite3Stmt.run()
 
     // better-sqlite3 does not support run() returning the first row, use get() instead.
     let firstRow: any
     try {
       firstRow = this.sqlite3Stmt.get()
-    } catch {
+    } catch (_) {
       // better-sqlite3 may throw `TypeError: This statement does not return data. Use run() instead`
       firstRow = null
     }
@@ -181,7 +201,9 @@ class NativeStatement {
   }
 
   private _allValues = (): SQLiteColumnNames[] => {
-    assert(this.sqlite3Stmt)
+    if (this.sqlite3Stmt.source.includes(' returning '))
+      return this.cachedRows.slice(1).map(row => Object.values(row))
+
     const sqlite3Stmt = this.sqlite3Stmt as any
     // Since the first row is retrieved by `_run()`, we need to skip the first row here.
     return sqlite3Stmt
@@ -191,7 +213,6 @@ class NativeStatement {
   }
 
   private _reset = () => {
-    assert(this.sqlite3Stmt)
     this.iterator?.return?.()
     this.iterator = this.sqlite3Stmt.iterate()
   }