feat: Migrate library to a react-native-nitro-modules (#55)

Co-authored-by: Oskar Kwaśniewski <[email protected]>

Author: chrispader

.github/workflows/lint-cpp.yml

@@ -11,6 +11,9 @@ on:
       - "**/*.cpp"
       - "**/*.c"
       - "**/*.mm"
+    paths-ignore:
+      - "node_modules"
+      - "**/node_modules"
   pull_request:
     paths:
       - ".github/workflows/lint-cpp.yml"
@@ -19,6 +22,9 @@ on:
       - "**/*.cpp"
       - "**/*.c"
       - "**/*.mm"
+    paths-ignore:
+      - "node_modules"
+      - "**/node_modules"
 
 jobs:
   lint:

bun.lockb

@@ -7,6 +7,27 @@ PODS:
   - hermes-engine (0.76.1):
     - hermes-engine/Pre-built (= 0.76.1)
   - hermes-engine/Pre-built (0.76.1)
+  - NitroModules (0.16.1):
+    - DoubleConversion
+    - glog
+    - hermes-engine
+    - RCT-Folly (= 2024.01.01.00)
+    - RCTRequired
+    - RCTTypeSafety
+    - React-Core
+    - React-debug
+    - React-Fabric
+    - React-featureflags
+    - React-graphics
+    - React-ImageManager
+    - React-NativeModulesApple
+    - React-RCTFabric
+    - React-rendererdebug
+    - React-utils
+    - ReactCodegen
+    - ReactCommon/turbomodule/bridging
+    - ReactCommon/turbomodule/core
+    - Yoga
   - RCT-Folly (2024.01.01.00):
     - boost
     - DoubleConversion
@@ -1242,27 +1263,6 @@ PODS:
     - ReactCommon/turbomodule/bridging
     - ReactCommon/turbomodule/core
     - Yoga
-  - react-native-quick-sqlite (8.2.5):
-    - DoubleConversion
-    - glog
-    - hermes-engine
-    - RCT-Folly (= 2024.01.01.00)
-    - RCTRequired
-    - RCTTypeSafety
-    - React-Core
-    - React-debug
-    - React-Fabric
-    - React-featureflags
-    - React-graphics
-    - React-ImageManager
-    - React-NativeModulesApple
-    - React-RCTFabric
-    - React-rendererdebug
-    - React-utils
-    - ReactCodegen
-    - ReactCommon/turbomodule/bridging
-    - ReactCommon/turbomodule/core
-    - Yoga
   - react-native-safe-area-context (4.14.0):
     - DoubleConversion
     - glog
@@ -1596,6 +1596,28 @@ PODS:
     - React-logger (= 0.76.1)
     - React-perflogger (= 0.76.1)
     - React-utils (= 0.76.1)
+  - RNQuickSQLite (8.2.5):
+    - DoubleConversion
+    - glog
+    - hermes-engine
+    - NitroModules
+    - RCT-Folly (= 2024.01.01.00)
+    - RCTRequired
+    - RCTTypeSafety
+    - React-Core
+    - React-debug
+    - React-Fabric
+    - React-featureflags
+    - React-graphics
+    - React-ImageManager
+    - React-NativeModulesApple
+    - React-RCTFabric
+    - React-rendererdebug
+    - React-utils
+    - ReactCodegen
+    - ReactCommon/turbomodule/bridging
+    - ReactCommon/turbomodule/core
+    - Yoga
   - RNScreens (3.35.0):
     - DoubleConversion
     - glog
@@ -1651,6 +1673,7 @@ DEPENDENCIES:
   - fmt (from `../../node_modules/react-native/third-party-podspecs/fmt.podspec`)
   - glog (from `../../node_modules/react-native/third-party-podspecs/glog.podspec`)
   - hermes-engine (from `../../node_modules/react-native/sdks/hermes-engine/hermes-engine.podspec`)
+  - NitroModules (from `../../node_modules/react-native-nitro-modules`)
   - RCT-Folly (from `../../node_modules/react-native/third-party-podspecs/RCT-Folly.podspec`)
   - RCT-Folly/Fabric (from `../../node_modules/react-native/third-party-podspecs/RCT-Folly.podspec`)
   - RCTDeprecation (from `../../node_modules/react-native/ReactApple/Libraries/RCTFoundation/RCTDeprecation`)
@@ -1682,7 +1705,6 @@ DEPENDENCIES:
   - React-logger (from `../../node_modules/react-native/ReactCommon/logger`)
   - React-Mapbuffer (from `../../node_modules/react-native/ReactCommon`)
   - React-microtasksnativemodule (from `../../node_modules/react-native/ReactCommon/react/nativemodule/microtasks`)
-  - react-native-quick-sqlite (from `../../package`)
   - react-native-safe-area-context (from `../../node_modules/react-native-safe-area-context`)
   - React-nativeconfig (from `../../node_modules/react-native/ReactCommon`)
   - React-NativeModulesApple (from `../../node_modules/react-native/ReactCommon/react/nativemodule/core/platform/ios`)
@@ -1711,6 +1733,7 @@ DEPENDENCIES:
   - React-utils (from `../../node_modules/react-native/ReactCommon/react/utils`)
   - ReactCodegen (from `build/generated/ios`)
   - ReactCommon/turbomodule/core (from `../../node_modules/react-native/ReactCommon`)
+  - RNQuickSQLite (from `../../package`)
   - RNScreens (from `../../node_modules/react-native-screens`)
   - Yoga (from `../../node_modules/react-native/ReactCommon/yoga`)
 
@@ -1732,6 +1755,8 @@ EXTERNAL SOURCES:
   hermes-engine:
     :podspec: "../../node_modules/react-native/sdks/hermes-engine/hermes-engine.podspec"
     :tag: hermes-2024-09-09-RNv0.76.0-db6d12e202e15f7a446d8848d6ca8f7abb3cfb32
+  NitroModules:
+    :path: "../../node_modules/react-native-nitro-modules"
   RCT-Folly:
     :podspec: "../../node_modules/react-native/third-party-podspecs/RCT-Folly.podspec"
   RCTDeprecation:
@@ -1790,8 +1815,6 @@ EXTERNAL SOURCES:
     :path: "../../node_modules/react-native/ReactCommon"
   React-microtasksnativemodule:
     :path: "../../node_modules/react-native/ReactCommon/react/nativemodule/microtasks"
-  react-native-quick-sqlite:
-    :path: "../../package"
   react-native-safe-area-context:
     :path: "../../node_modules/react-native-safe-area-context"
   React-nativeconfig:
@@ -1848,6 +1871,8 @@ EXTERNAL SOURCES:
     :path: build/generated/ios
   ReactCommon:
     :path: "../../node_modules/react-native/ReactCommon"
+  RNQuickSQLite:
+    :path: "../../package"
   RNScreens:
     :path: "../../node_modules/react-native-screens"
   Yoga:
@@ -1860,6 +1885,7 @@ SPEC CHECKSUMS:
   fmt: 10c6e61f4be25dc963c36bd73fc7b1705fe975be
   glog: 08b301085f15bcbb6ff8632a8ebaf239aae04e6a
   hermes-engine: 46f1ffbf0297f4298862068dd4c274d4ac17a1fd
+  NitroModules: 69af449f389d4c548848a400e1270f672a64e5a3
   RCT-Folly: bf5c0376ffe4dd2cf438dcf86db385df9fdce648
   RCTDeprecation: fde92935b3caa6cb65cbff9fbb7d3a9867ffb259
   RCTRequired: 75c6cee42d21c1530a6f204ba32ff57335d19007
@@ -1889,7 +1915,6 @@ SPEC CHECKSUMS:
   React-logger: 97c9dafae1f1a638001a9d1d0e93d431f2f9cb7b
   React-Mapbuffer: 3146a13424f9fec2ea1f1462d49d566e4d69b732
   React-microtasksnativemodule: 02d218c79c72d373a92a8552183f4ead0d1c6e05
-  react-native-quick-sqlite: 975bea33bc233f8cd468b3a27c50d88521ade800
   react-native-safe-area-context: 2500e4fe998caad50ad3bc51ec23ef951308569e
   React-nativeconfig: 93fe8c85a8c40820c57814e30f3e44b94c995a7b
   React-NativeModulesApple: b3e076fd0d7b73417fe1e8c8b26e3c57ae9b74aa
@@ -1918,6 +1943,7 @@ SPEC CHECKSUMS:
   React-utils: 5362bd16a9563f9916e7a56c011ddc533507650f
   ReactCodegen: 4e26d365313307cc7c95e693529e539acfb5c64c
   ReactCommon: 422e364463f33e336fc4db196aeb50fd801d90d6
+  RNQuickSQLite: 8ef02913f22a4ca65f44cf826acd0185aa5d6771
   RNScreens: e389d6a6a66a4f0d3662924ecae803073ccce8ec
   SocketRocket: d4aabe649be1e368d1318fdf28a022d714d65748
   Yoga: db69236006b8b1c6d55ab453390c882306cbf219

example/ios/Podfile.lock

@@ -23,6 +23,7 @@
     "expo-status-bar": "^1.12.1",
     "react": "*",
     "react-native": "*",
+    "react-native-nitro-modules": "*",
     "react-native-quick-sqlite": "8.2.5",
     "react-native-safe-area-context": "^4.14.0",
     "react-native-screens": "^3.35.0",

example/package.json

@@ -13,8 +13,8 @@ const Stack = createNativeStackNavigator<ParamList>()
 export default function App() {
   return (
     <NavigationContainer>
-      <Stack.Navigator initialRouteName="QuickSQLite Example">
-        <Stack.Screen name="QuickSQLite Example" component={HomeScreen} />
+      <Stack.Navigator initialRouteName="NitroSQLite Example">
+        <Stack.Screen name="NitroSQLite Example" component={HomeScreen} />
         <Stack.Screen name="Unit Tests" component={UnitTestScreen} />
         <Stack.Screen name="Benchmarks" component={BenchmarkScreen} />
       </Stack.Navigator>

example/src/App.tsx

@@ -1,5 +1,5 @@
 export type ParamList = {
-  'QuickSQLite Example': undefined
+  'NitroSQLite Example': undefined
   'Unit Tests': undefined
   'Benchmarks': undefined
 }

example/src/navigation.ts

@@ -107,7 +107,7 @@ export const BenchmarkScreen: React.FC<Props> = () => {
 
     setResults({})
     setIsLoading(true)
-    console.log('--------- BEGINNING QuickSQLite BENCHMARKS ---------')
+    console.log('--------- BEGINNING NitroSQLite BENCHMARKS ---------')
 
     async function start(i = 0): Promise<void> {
       const benchmark = benchmarks[i]!
@@ -121,7 +121,7 @@ export const BenchmarkScreen: React.FC<Props> = () => {
 
     await start()
 
-    console.log('--------- FINISHED QuickSQLite BENCHMARKS! ---------')
+    console.log('--------- FINISHED NitroSQLite BENCHMARKS! ---------')
     setIsLoading(false)
   }, [])
 

example/src/screens/BenchmarkScreen.tsx

@@ -5,7 +5,7 @@ import type { ParamList } from '../navigation'
 import { StatusBar } from 'expo-status-bar'
 import { ScreenStyles } from '../styles'
 
-type Props = NativeStackScreenProps<ParamList, 'QuickSQLite Example'>
+type Props = NativeStackScreenProps<ParamList, 'NitroSQLite Example'>
 
 export const HomeScreen: React.FC<Props> = ({ navigation }) => {
   return (

example/src/screens/HomeScreen.tsx

@@ -1,7 +1,7 @@
 import Chance from 'chance'
 import type {
   QuickSQLiteConnection,
-  SQLBatchTuple,
+  BatchQueryCommand,
 } from 'react-native-quick-sqlite'
 import { open } from 'react-native-quick-sqlite'
 
@@ -24,7 +24,7 @@ export function resetTestDb() {
 
 // Copyright 2024 Oscar Franco
 // Taken from "op-sqlite" example project.
-// Used to demonstrate the performance of QuickSQLite.
+// Used to demonstrate the performance of NitroSQLite.
 const ROWS = 300000
 export let largeDb: QuickSQLiteConnection | undefined
 export function resetLargeDb() {
@@ -43,11 +43,12 @@ export function resetLargeDb() {
 
     largeDb.execute('PRAGMA mmap_size=268435456')
 
-    const insertions: SQLBatchTuple[] = []
+    const insertions: BatchQueryCommand[] = []
     for (let i = 0; i < ROWS; i++) {
-      insertions.push([
-        'INSERT INTO "Test" (id, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14) VALUES(?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)',
-        [
+      insertions.push({
+        query:
+          'INSERT INTO "Test" (id, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14) VALUES(?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)',
+        params: [
           i,
           chance.name(),
           chance.name(),
@@ -64,7 +65,7 @@ export function resetLargeDb() {
           chance.floating(),
           chance.floating(),
         ],
-      ])
+      })
     }
 
     largeDb.executeBatch(insertions)

example/src/tests/db.ts

@@ -1,12 +1,12 @@
 import Chance from 'chance'
 import type {
   QuickSQLiteConnection,
-  SQLBatchTuple,
+  BatchQueryCommand,
 } from 'react-native-quick-sqlite'
 import { beforeEach, describe, it } from './MochaRNAdapter'
 import chai from 'chai'
 import { testDb as testDbInternal, resetTestDb } from './db'
-import type { User } from '../model/User'
+import { User } from '../model/User'
 
 function isError(e: unknown): e is Error {
   return e instanceof Error
@@ -424,10 +424,8 @@ export function registerUnitTests() {
         })
       } catch (e) {
         if (isError(e)) {
-          console.log(e.message)
-
           expect(e.message)
-            .to.include('SQL execution error')
+            .to.include('SqlExecutionError')
             .and.to.include('cannot store TEXT value in REAL column User.id')
 
           const res = testDb.execute('SELECT * FROM User')
@@ -578,15 +576,17 @@ export function registerUnitTests() {
       const name2 = chance.name()
       const age2 = chance.integer()
       const networth2 = chance.floating()
-      const commands: SQLBatchTuple[] = [
-        [
-          'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
-          [id1, name1, age1, networth1],
-        ],
-        [
-          'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
-          [id2, name2, age2, networth2],
-        ],
+      const commands: BatchQueryCommand[] = [
+        {
+          query:
+            'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
+          params: [id1, name1, age1, networth1],
+        },
+        {
+          query:
+            'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
+          params: [id2, name2, age2, networth2],
+        },
       ]
 
       testDb.executeBatch(commands)
@@ -612,15 +612,17 @@ export function registerUnitTests() {
       const name2 = chance.name()
       const age2 = chance.integer()
       const networth2 = chance.floating()
-      const commands: SQLBatchTuple[] = [
-        [
-          'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
-          [id1, name1, age1, networth1],
-        ],
-        [
-          'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
-          [id2, name2, age2, networth2],
-        ],
+      const commands: BatchQueryCommand[] = [
+        {
+          query:
+            'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
+          params: [id1, name1, age1, networth1],
+        },
+        {
+          query:
+            'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
+          params: [id2, name2, age2, networth2],
+        },
       ]
 
       await testDb.executeBatchAsync(commands)