react-native-ota-hot-update 1.0.9 → 1.1.1

package/README.md

@@ -36,6 +36,31 @@ Open `AppDelegate.m` and add this:
 #endif
 }
 ```
+#### For downloading in background mode on IOS, following this (optional):
+
+AppDelegate.h:
+```bash
+@property (nonatomic, assign) UIBackgroundTaskIdentifier taskIdentifier;
+```
+AppDelegate.mm:
+
+```bash
+- (void)applicationWillResignActive:(UIApplication *)application {
+   if (self.taskIdentifier != UIBackgroundTaskInvalid) {
+      [application endBackgroundTask:self.taskIdentifier];
+      self.taskIdentifier = UIBackgroundTaskInvalid;
+   }
+ 
+   __weak AppDelegate *weakSelf = self;
+   self.taskIdentifier = [application beginBackgroundTaskWithName:nil expirationHandler:^{
+      if (weakSelf) {
+          [application endBackgroundTask:weakSelf.taskIdentifier];
+          weakSelf.taskIdentifier = UIBackgroundTaskInvalid;
+      }
+   }];
+}
+```
+
 
 ### Android
 Open `MainApplication.java/kt` and add these codes bellow:
@@ -53,12 +78,24 @@ override fun getJSBundleFile(): String? {
 Here is the guideline to control bundle js by yourself, in here i am using Firebase storage to store bundlejs file and a json file that announce new version is comming:
 
 #### 1.Add these script into your package.json to export bundlejs file:
+
+- For react native CLI:
 ```bash
 "scripts": {
   "export-android": "mkdir -p android/output && react-native bundle --platform android --dev false --entry-file index.js --bundle-output android/output/index.android.bundle --assets-dest android/output  && cd android && find output -type f | zip index.android.bundle.zip -@ && cd .. && rm -rf android/output",
   "export-ios": "mkdir -p ios/output && react-native bundle --platform ios --dev false --entry-file index.js --bundle-output ios/output/main.jsbundle --assets-dest ios/output && cd ios && find output -type f | zip main.jsbundle.zip -@ && cd .. && rm -rf ios/output"
 }
 ```
+- For expo / expo bare project:
+
+```bash
+"scripts": {
+  "export-android": "mkdir -p android/output && npx expo export:embed --platform android --entry-file node_modules/expo/AppEntry.js --bundle-output android/output/index.android.bundle --dev false  --assets-dest android/output && cd android && find output -type f | zip index.android.bundle.zip -@ && cd .. && rm -rf android/output",
+  "export-ios": "mkdir -p ios/output && npx expo export:embed --platform ios --entry-file node_modules/expo/AppEntry.js --bundle-output ios/output/main.jsbundle --dev false  --assets-dest ios/output && cd ios && find output -type f | zip main.jsbundle.zip -@ && cd .. && rm -rf ios/output"
+}
+```
+For expo you might need check path of `--entry-file node_modules/expo/AppEntry.js`, get it from package.json / main
+
 These commands are export bundle file and compress it as a zip file, one for android and one for ios. You can create your own script that export and auto upload to your server.
 
 Then create an json file: `update.json` like that:
@@ -100,6 +137,18 @@ After you have done everything related to version manager, you just handle the w
 
 The important thing: this library will control `version` by it self, need always pass version as parameter in `downloadBundleUri`, it will storage as a cache and use this to check whether need update version in the next time. Default of `version` is **0**
 
+## Tips for manage bundles
+
+In this demo project i have used firebase storage to control the bundles and version, but that is not useful. I would like to suggest you to use some CMS to control the bundles.
+For CMS, it has a lot open sources, now i am using strapi CMS to control the version, i also create auto release script like code push and can integrate with CI/CD. Here is some screenshot of strapi CMS:
+
+![](https://github.com/vantuan88291/react-native-ota-hot-update/raw/main/scr2.png)
+
+![](https://github.com/vantuan88291/react-native-ota-hot-update/raw/main/scr3.png)
+
+Beside strapi you can also try craftcms, payloadcms...
+You can refer folder sampleComponent, it has the logic of update with CMS and also include script auto upload the bundle to CMS.
+Contact me via email if you want to implement hot update via CMS (need service fee)
 
 ## Functions
 
@@ -122,6 +171,7 @@ The important thing: this library will control `version` by it self, need always
 | updateFail(message: string)               | No       | Callback | Will trigger when install update failed                                                          |
 | restartAfterInstall            | No       | boolean  | default is `false`, if `true` will restart the app after install success to apply the new change |
 | progress            | No       | void     | A callback to show progress when downloading bundle                                              |
+| extensionBundle            | No       | string   | extension of bundle js file, default is .bundle for android, ios is .jsbundle                    |
 
 ## DownloadManager
 

package/android/src/main/java/com/rnhotupdate/HotUpdateModule.java

@@ -50,7 +50,7 @@ public class HotUpdateModule extends ReactContextBaseJavaModule {
             return false;
         }
     }
-    private String unzip(File zipFile) {
+    private String unzip(File zipFile, String extension) {
         File destDir = zipFile.getParentFile(); // Directory of the zip file
 
         String bundleFilePath = null;
@@ -78,7 +78,7 @@ public class HotUpdateModule extends ReactContextBaseJavaModule {
                         }
                     }
                 }
-                if (newFile.getAbsolutePath().contains(".bundle")) {
+                if (newFile.getAbsolutePath().contains(extension)) {
                     bundleFilePath = newFile.getAbsolutePath();
                 }
             }
@@ -90,12 +90,12 @@ public class HotUpdateModule extends ReactContextBaseJavaModule {
     }
 
     @ReactMethod
-    public void setupBundlePath(String path, Promise promise) {
+    public void setupBundlePath(String path, String extension, Promise promise) {
         if (path != null) {
             deleteOldBundleIfneeded();
             File file = new File(path);
             if (file.exists() && file.isFile()) {
-                String fileUnzip = unzip(file);
+                String fileUnzip = unzip(file, extension != null ? extension : ".bundle");
                 Log.d("setupBundlePath: ", fileUnzip);
                 if (fileUnzip != null) {
                     file.delete();

package/ios/RNhotupdate.m

@@ -97,7 +97,7 @@ RCT_EXPORT_MODULE()
         return [[NSBundle mainBundle] URLForResource:@"main" withExtension:@"jsbundle"];
     }
 }
-- (NSString *)searchForJsBundleInDirectory:(NSString *)directoryPath {
+- (NSString *)searchForJsBundleInDirectory:(NSString *)directoryPath extension:(NSString *)extension {
     NSFileManager *fileManager = [NSFileManager defaultManager];
     NSError *error;
 
@@ -114,11 +114,11 @@ RCT_EXPORT_MODULE()
         if ([fileManager fileExistsAtPath:filePath isDirectory:&isDirectory]) {
             if (isDirectory) {
                 // Recursively search in subdirectories
-                NSString *foundPath = [self searchForJsBundleInDirectory:filePath];
+                NSString *foundPath = [self searchForJsBundleInDirectory:filePath extension:extension];
                 if (foundPath) {
                     return foundPath;
                 }
-            } else if ([filePath hasSuffix:@".jsbundle"]) {
+            } else if ([filePath hasSuffix:extension]) {
                 // Return the path if it's a .jsbundle file
                 return filePath;
             }
@@ -127,7 +127,7 @@ RCT_EXPORT_MODULE()
 
     return nil;
 }
-- (NSString *)unzipFileAtPath:(NSString *)zipFilePath {
+- (NSString *)unzipFileAtPath:(NSString *)zipFilePath extension:(NSString *)extension  {
     // Define the directory where the files will be extracted
     NSString *extractedFolderPath = [[zipFilePath stringByDeletingPathExtension] stringByAppendingPathExtension:@"unzip"];
 
@@ -151,7 +151,7 @@ RCT_EXPORT_MODULE()
         return nil;
     }
     // Find .jsbundle files in the extracted directory
-        NSString *jsbundleFilePath = [self searchForJsBundleInDirectory:extractedFolderPath];
+    NSString *jsbundleFilePath = [self searchForJsBundleInDirectory:extractedFolderPath extension:extension];
 
         // Delete the zip file after extraction
         NSError *removeError = nil;
@@ -165,11 +165,11 @@ RCT_EXPORT_MODULE()
 }
 
 // Expose setupBundlePath method to JavaScript
-RCT_EXPORT_METHOD(setupBundlePath:(NSString *)path withResolver:(RCTPromiseResolveBlock)resolve withRejecter:(RCTPromiseRejectBlock)reject) {
+RCT_EXPORT_METHOD(setupBundlePath:(NSString *)path extension:(NSString *)extension withResolver:(RCTPromiseResolveBlock)resolve withRejecter:(RCTPromiseRejectBlock)reject) {
     if ([self isFilePathValid:path]) {
         [self removeBundleIfNeeded];
         //Unzip file
-        NSString *extractedFilePath = [self unzipFileAtPath:path];
+        NSString *extractedFilePath = [self unzipFileAtPath:path extension:(extension != nil) ? extension : @".jsbundle"];
         NSLog(@"file extraction----- %@", extractedFilePath);
         if (extractedFilePath) {
             NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-ota-hot-update",
-  "version": "1.0.9",
+  "version": "1.1.1",
   "description": "Hot update for react native",
   "main": "src/index",
   "repository": "https://github.com/vantuan88291/react-native-ota-hot-update",

package/src/index.tsx

@@ -1,10 +1,10 @@
 import { NativeModules, Platform } from 'react-native';
 import {DownloadManager} from './download';
 const LINKING_ERROR =
-  'The package \'rn-hotupdate\' doesn\'t seem to be linked. Make sure: \n\n' +
-  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
-  '- You rebuilt the app after installing the package\n' +
-  '- You are not using Expo Go\n';
+    'The package \'rn-hotupdate\' doesn\'t seem to be linked. Make sure: \n\n' +
+    Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+    '- You rebuilt the app after installing the package\n' +
+    '- You are not using Expo Go\n';
 
 export interface UpdateOption {
   headers?: object
@@ -12,21 +12,23 @@ export interface UpdateOption {
   updateSuccess?(): void
   updateFail?(message?: string): void
   restartAfterInstall?: boolean
+  extensionBundle?: string,
 }
 const RNhotupdate = NativeModules.RNhotupdate
-  ? NativeModules.RNhotupdate
-  : new Proxy(
-      {},
-      {
-        get() {
-          throw new Error(LINKING_ERROR);
-        },
-      }
+    ? NativeModules.RNhotupdate
+    : new Proxy(
+        {},
+        {
+          get() {
+            throw new Error(LINKING_ERROR);
+          },
+        }
     );
 const downloadBundleFile = async (downloadManager: DownloadManager, uri: string, headers?: object, callback?: (received: string, total: string) => void) => {
   const res = await downloadManager
       .config({
         fileCache: Platform.OS === 'android',
+        IOSBackgroundTask: true,
       })
       .fetch('GET', uri, {
         ...headers,
@@ -38,8 +40,8 @@ const downloadBundleFile = async (downloadManager: DownloadManager, uri: string,
       });
   return res.path();
 };
-function setupBundlePath(path: string): Promise<boolean> {
-  return RNhotupdate.setupBundlePath(path);
+function setupBundlePath(path: string, extension?: string): Promise<boolean> {
+  return RNhotupdate.setupBundlePath(path, extension);
 }
 function deleteBundlePath(): Promise<boolean> {
   return RNhotupdate.deleteBundle();
@@ -90,7 +92,7 @@ async function downloadBundleUri(downloadManager: DownloadManager, uri: string,
   try {
     const path = await downloadBundleFile(downloadManager, uri, option?.headers, option?.progress);
     if (path) {
-      setupBundlePath(path).then(success => {
+      setupBundlePath(path, option?.extensionBundle).then(success => {
         if (success) {
           setCurrentVersion(version);
           option?.updateSuccess?.();