Merge pull request #94 from OP-Engineering/osp/custom-asset-path

Make moveAssetsDatabase async, add custom path and add overwrite option

.github/workflows/ci.yml

@@ -71,7 +71,7 @@ jobs:
           yarn turbo run build:android --cache-dir="${{ env.TURBO_CACHE_DIR }}"
 
   build-ios:
-    runs-on: self-hosted
+    runs-on: macos-latest
     env:
       TURBO_CACHE_DIR: .turbo/ios
     steps:
@@ -126,7 +126,7 @@ jobs:
           yarn turbo run build:ios --cache-dir="${{ env.TURBO_CACHE_DIR }}"
 
   build-ios-sqlcipher:
-    runs-on: self-hosted
+    runs-on: macos-latest
     env:
       TURBO_CACHE_DIR: .turbo/ios
     steps:

android/src/main/java/com/op/sqlite/OPSQLiteModule.kt

@@ -1,13 +1,16 @@
 package com.op.sqlite
 
 import android.util.Log
+import com.facebook.react.bridge.Promise
 import com.facebook.react.bridge.ReactApplicationContext
 import com.facebook.react.bridge.ReactMethod
 import com.facebook.react.bridge.ReactContextBaseJavaModule
+import com.facebook.react.bridge.ReadableMap
 import java.io.File
 import java.io.FileOutputStream
 import java.io.InputStream
 import java.io.OutputStream
+import com.facebook.react.util.RNLog;
 
 //@ReactModule(name = OPSQLiteModule.NAME)
 internal class OPSQLiteModule(context: ReactApplicationContext?) : ReactContextBaseJavaModule(context) {
@@ -47,25 +50,33 @@ internal class OPSQLiteModule(context: ReactApplicationContext?) : ReactContextB
         }
     }
 
-    @ReactMethod(isBlockingSynchronousMethod = true)
-    fun moveAssetsDatabase(name: String, extension: String): Boolean {
+    @ReactMethod
+    fun moveAssetsDatabase(args: ReadableMap, promise: Promise) {
+        val filename = args.getString("filename")!!
+        val path = args.getString("path") ?: "custom"
+        val overwrite = if(args.hasKey("overwrite")) { args.getBoolean("overwrite") } else false
         val context = reactApplicationContext
         val assetsManager = context.assets
 
         try {
             // Open the input stream for the asset file
-            val inputStream: InputStream = assetsManager.open("custom/$name.$extension")
+            val inputStream: InputStream = assetsManager.open("$path/$filename")
 
             // Create the output file in the documents directory
             val databasesFolder =
                     context.getDatabasePath("defaultDatabase")
                             .absolutePath
                             .replace("defaultDatabase", "")
 
-            val outputFile = File(databasesFolder, "$name.$extension")
+            val outputFile = File(databasesFolder, filename)
 
             if (outputFile.exists()) {
-                return true
+                if(overwrite) {
+                    outputFile.delete()
+                } else {
+                    promise.resolve(true)
+                    return
+                }
             }
 
             // Open the output stream for the output file
@@ -82,9 +93,10 @@ internal class OPSQLiteModule(context: ReactApplicationContext?) : ReactContextB
             inputStream.close()
             outputStream.close()
 
-            return true
+            promise.resolve(true)
         } catch (exception: Exception) {
-            return false
+            RNLog.e(this.reactApplicationContext, "Exception: $exception")
+            promise.resolve(false)
         }
     }
 

example/android/link-assets-manifest.json

@@ -4,6 +4,10 @@
     {
       "path": "assets/sample.sqlite",
       "sha1": "0f1675ac593b261b41a5144bc14f41163bd2a0c2"
+    },
+    {
+      "path": "assets/sqlite/sample2.sqlite",
+      "sha1": "0f1675ac593b261b41a5144bc14f41163bd2a0c2"
     }
   ]
 }

example/ios/OPSQLiteExample.xcodeproj/project.pbxproj

@@ -13,6 +13,7 @@
 		13B07FC11A68108700A75B9A /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = 13B07FB71A68108700A75B9A /* main.m */; };
 		3B5A9E3FD2C56B364AF5A4F3 /* libPods-OPSQLiteExample.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 6EE3066EB7AAB7E17B1CAB50 /* libPods-OPSQLiteExample.a */; };
 		81AB9BB82411601600AC10FF /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 81AB9BB72411601600AC10FF /* LaunchScreen.storyboard */; };
+		AC1DF06E9759460CAA51B7B1 /* sample2.sqlite in Resources */ = {isa = PBXBuildFile; fileRef = 9218E48CFB1F478CAC374D68 /* sample2.sqlite */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXFileReference section */
@@ -31,6 +32,7 @@
 		89C6BE57DB24E9ADA2F236DE /* Pods-OPSQLiteExample-OPSQLiteExampleTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OPSQLiteExample-OPSQLiteExampleTests.release.xcconfig"; path = "Target Support Files/Pods-OPSQLiteExample-OPSQLiteExampleTests/Pods-OPSQLiteExample-OPSQLiteExampleTests.release.xcconfig"; sourceTree = "<group>"; };
 		96FD9FD0FC4F4540AC7A9CE6 /* sample.sqlite */ = {isa = PBXFileReference; explicitFileType = undefined; fileEncoding = 9; includeInIndex = 0; lastKnownFileType = unknown; name = sample.sqlite; path = ../assets/sample.sqlite; sourceTree = "<group>"; };
 		ED297162215061F000B7C4FE /* JavaScriptCore.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = JavaScriptCore.framework; path = System/Library/Frameworks/JavaScriptCore.framework; sourceTree = SDKROOT; };
+		9218E48CFB1F478CAC374D68 /* sample2.sqlite */ = {isa = PBXFileReference; name = "sample2.sqlite"; path = "../assets/sqlite/sample2.sqlite"; sourceTree = "<group>"; fileEncoding = undefined; lastKnownFileType = unknown; explicitFileType = undefined; includeInIndex = 0; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -102,6 +104,7 @@
 			isa = PBXGroup;
 			children = (
 				96FD9FD0FC4F4540AC7A9CE6 /* sample.sqlite */,
+				9218E48CFB1F478CAC374D68 /* sample2.sqlite */,
 			);
 			name = Resources;
 			sourceTree = "<group>";
@@ -181,6 +184,7 @@
 				81AB9BB82411601600AC10FF /* LaunchScreen.storyboard in Resources */,
 				13B07FBF1A68108700A75B9A /* Images.xcassets in Resources */,
 				022AA638EE144393ADDCAEC0 /* sample.sqlite in Resources */,
+				AC1DF06E9759460CAA51B7B1 /* sample2.sqlite in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

example/ios/OPSQLiteExample/Info.plist

@@ -32,7 +32,7 @@
 		<true/>
 	</dict>
 	<key>NSLocationWhenInUseUsageDescription</key>
-	<string></string>
+	<string/>
 	<key>UILaunchStoryboardName</key>
 	<string>LaunchScreen</string>
 	<key>UIRequiredDeviceCapabilities</key>

example/ios/link-assets-manifest.json

@@ -4,6 +4,10 @@
     {
       "path": "assets/sample.sqlite",
       "sha1": "0f1675ac593b261b41a5144bc14f41163bd2a0c2"
+    },
+    {
+      "path": "assets/sqlite/sample2.sqlite",
+      "sha1": "0f1675ac593b261b41a5144bc14f41163bd2a0c2"
     }
   ]
 }

example/src/App.tsx

@@ -80,7 +80,7 @@ export default function App() {
   };
 
   const openAssetsDb = async () => {
-    const moved = moveAssetsDatabase('sample', 'sqlite');
+    const moved = await moveAssetsDatabase({filename: 'sample.sqlite'});
     console.log('moved', moved);
     const db = open({name: 'sample.sqlite'});
     const users = db.execute('SELECT * FROM User');

example/src/tests/dbsetup.spec.ts

@@ -3,6 +3,7 @@ import {
   ANDROID_EXTERNAL_FILES_PATH,
   IOS_LIBRARY_PATH,
   isSQLCipher,
+  moveAssetsDatabase,
   open,
 } from '@op-engineering/op-sqlite';
 import chai from 'chai';
@@ -91,6 +92,29 @@ export function dbSetupTests() {
       db.delete();
     });
 
+    it('Moves assets database simple', async () => {
+      const copied = await moveAssetsDatabase({filename: 'sample.sqlite'});
+
+      expect(copied).to.equal(true);
+    });
+    it('Moves assets database with path', async () => {
+      const copied = await moveAssetsDatabase({
+        filename: 'sample2.sqlite',
+        path: 'sqlite',
+      });
+
+      expect(copied).to.equal(true);
+    });
+    it('Moves assets database with path and overwrite', async () => {
+      const copied = await moveAssetsDatabase({
+        filename: 'sample2.sqlite',
+        path: 'sqlite',
+        overwrite: true,
+      });
+
+      expect(copied).to.equal(true);
+    });
+
     // it('Should fail creating in-memory with non-bool arg', async () => {
     //   try {
     //     open({

ios/OPSQLite.mm

@@ -87,29 +87,46 @@ - (NSDictionary *)getConstants {
   return @true;
 }
 
-RCT_EXPORT_BLOCKING_SYNCHRONOUS_METHOD(moveAssetsDatabase
-                                       : (NSString *)name extension
-                                       : (NSString *)extension) {
+RCT_EXPORT_METHOD(moveAssetsDatabase
+                  : (NSDictionary *)args resolve
+                  : (RCTPromiseResolveBlock)resolve reject
+                  : (RCTPromiseRejectBlock)reject) {
   NSString *documentPath = [NSSearchPathForDirectoriesInDomains(
       NSLibraryDirectory, NSUserDomainMask, true) objectAtIndex:0];
-  NSString *sourcePath = [[NSBundle mainBundle] pathForResource:name
-                                                         ofType:extension];
 
-  NSString *destinationPath = [documentPath
-      stringByAppendingPathComponent:[NSString stringWithFormat:@"%@.%@", name,
-                                                                extension]];
+  NSString *filename = args[@"filename"];
+  BOOL overwrite = args[@"overwrite"];
 
+  NSString *sourcePath = [[NSBundle mainBundle] pathForResource:filename
+                                                         ofType:nil];
+
+  NSString *destinationPath =
+      [documentPath stringByAppendingPathComponent:filename];
+
+  NSError *error;
   NSFileManager *fileManager = [NSFileManager defaultManager];
   if ([fileManager fileExistsAtPath:destinationPath]) {
-    return @true;
+    if (overwrite) {
+      [fileManager removeItemAtPath:destinationPath error:&error];
+      if (error) {
+        NSLog(@"Error: %@", error);
+        resolve(@false);
+        return;
+      }
+    } else {
+      resolve(@true);
+      return;
+    }
   }
 
-  NSError *error;
   [fileManager copyItemAtPath:sourcePath toPath:destinationPath error:&error];
   if (error) {
-    return @false;
+    NSLog(@"Error: %@", error);
+    resolve(@false);
+    return;
   }
-  return @true;
+  resolve(@true);
+  return;
 }
 
 // #if RCT_NEW_ARCH_ENABLED

src/index.ts

@@ -489,11 +489,12 @@ export const open = (options: {
   };
 };
 
-export const moveAssetsDatabase = (
-  dbName: string,
-  extension: string
-): boolean => {
-  return NativeModules.OPSQLite.moveAssetsDatabase(dbName, extension);
+export const moveAssetsDatabase = (args: {
+  filename: string;
+  path?: string;
+  overwrite?: boolean;
+}): boolean => {
+  return NativeModules.OPSQLite.moveAssetsDatabase(args);
 };
 
 export const isSQLCipher = (): boolean => {