react-native-blob-util 0.16.4 → 0.17.0

package/.eslintrc.js

@@ -1,10 +1,11 @@
 module.exports = {
     root: true,
+    extends: '@react-native-community',
     rules: {
         'prettier/prettier': 0,
         "eqeqeq": 2,
         "comma-dangle": 0,
-        "curly": 0,
+        curly: 0,
         "no-console": 1,
         "no-debugger": 1,
         "no-extra-semi": 2,
@@ -24,7 +25,32 @@ module.exports = {
                 "requireReturnDescription": false
             }
         ],
-        "radix": 0
+        "radix": 0,
+
+        "react/display-name": 2,
+        "react/forbid-prop-types": 1,
+        "react/jsx-boolean-value": 1,
+        "react/jsx-closing-bracket-location": 1,
+        "react/jsx-curly-spacing": 1,
+        "react/jsx-indent-props": 0,
+        "react/jsx-max-props-per-line": 0,
+        "react/jsx-no-duplicate-props": 1,
+        "react/jsx-no-literals": 0,
+        "react/jsx-no-undef": 1,
+        "react/jsx-sort-props": 0,
+        "react/jsx-uses-react": 1,
+        "react/jsx-uses-vars": 1,
+        "react/jsx-wrap-multilines": 1,
+        "react/no-danger": 1,
+        "react/no-did-mount-set-state": 1,
+        "react/no-did-update-set-state": 1,
+        "react/no-direct-mutation-state": 1,
+        "react/no-multi-comp": 1,
+        "react/no-set-state": 0,
+        "react/no-unknown-property": 1,
+        "react/prop-types": 0,
+        "react/react-in-jsx-scope": 0,
+        "react/self-closing-comp": 1,
+        "react/sort-comp": 1,
     },
-    "parser": "babel-eslint"
 };

package/Migration.md

@@ -0,0 +1,41 @@
+# Migration to the New Architecture
+
+This file is a tracker for what has been done to work on the migration of this library and to keep also track of the various todo:
+
+## TODO
+
+- [] Write JS spec in Flow for the New Architecture
+- [] Implent the new Native Code on iOS
+- [] Implent the new Native Code on Android
+- [] Test on OldArch app (iOS)
+- [] Test on OldArch app (Android)
+- [] Test on NewArch app (iOS)
+- [] Test on NewArch app (Android)
+- [] Open PR
+
+## Done
+
+### Setup
+1. Forked and cloned the repo
+1. Checked the list of APIs to migrate.
+1. Created an `OldArch` app (0.70) configured for the Old Architecture.
+1. Run the app to make sure that it works properly.
+1. Created a `NewArch` app (0.70) configured for the New Architecture.
+1. Switched the flags for iOS and Android to have the new arch enabled by default
+1. Run the app to make sure that it works properly.
+1. Moved the apps in the `examples` folder
+
+### Installing blob-utils
+1. Move to `OldArch`
+1. Run `yarn add ../..` to install the blob utils.
+1. `cd ios`
+1. `bundle install && bundle exec pod install`
+1. `cd ..`
+1. `npx react-native run-ios`
+1. Copy the app JS code from `examples/ReactNativeBlobUtil/App.js` to `examples/OldArch/App.js`
+1. Fixed various JS issues
+1. The app depends on the `Picker`. *Note:* It does not support the New Arch, we need to figure out another way to choose.
+    1. run `yarn add @react-native-picker/picker`
+    1. run `bundle exec pod install` from the iOS folder
+    1. re-run the app
+1. Repeat the above steps for `NewArch`

package/README.md

@@ -12,11 +12,13 @@ The project will be continued in this repository. React-Native-Blob-Util is full
 
 # Version Compatibility Warning
 
-react-native-blob-util version 0.10.16 and up is only compatible with react native 0.60 and up.
+react-native-blob-util version **0.17.0** and up is only compatible with react native **0.64** and up.
+
+react-native-blob-util version **0.10.16** and up is only compatible with react native **0.60** and up.
 
 ## Features
 
-- Access and write data to Android MedaiaStore (e.g. Downloads folder on devices > Android 9)
+- Access and write data to Android Media Store (e.g. Downloads folder on devices > Android 9)
 - Transfer data directly from/to storage without BASE64 bridging
 - File API supports regular files, Asset files, and CameraRoll files
 - Native-to-native file manipulation API, reduce JS bridging performance loss
@@ -24,6 +26,11 @@ react-native-blob-util version 0.10.16 and up is only compatible with react nati
 - Blob, File, XMLHttpRequest polyfills that make browser-based library available in RN (experimental)
 - JSON stream supported base on [Oboe.js](https://github.com/jimhigson/oboe.js/) @jimhigson
 
+## React Native New Architecture
+With Reacht Native 0.68.0 the switch to enable the new aritechture was introduced.
+Starting with version 0.17.0 this library introduces support for the new architecture as well. Of course the old architecture will still be supproted.
+Further information about it and how to use it you can find here: https://reactnative.dev/docs/next/the-new-architecture/landing-page
+
 ## Android 10 & 11
 
 Android 10 introduced scoped storage for apps. Apps no longer can create own directories directly on the external storage or access files outside the apps own directories. With version 0.14.0 support for the media storage is implemented. For more information please see the chapter about the mediastore API.
@@ -971,7 +978,7 @@ After `0.8.0` we've made some [Web API polyfills](https://github.com/RonRadtke/r
 
 ## Setting A File Transformer
 
-Setting a file transformer will allow you to specify how data should be transformed whenever the library is writing into storage or reading from storage. A use case for this is if you want the files handled by this library to be encrypted. 
+Setting a file transformer will allow you to specify how data should be transformed whenever the library is writing into storage or reading from storage. A use case for this is if you want the files handled by this library to be encrypted.
 
 If you want to use a file transformer, you must implement an interface defined in:
 
@@ -988,7 +995,7 @@ public class MainApplication extends Application implements ReactApplication {
     @Override
     public void onCreate() {
        ...
-       ReactNativeBlobUtilFileTransformer.sharedFileTransformer = new MyCustomEncryptor(); 
+       ReactNativeBlobUtilFileTransformer.sharedFileTransformer = new MyCustomEncryptor();
        ...
     }
 ```
@@ -1005,8 +1012,8 @@ iOS:
 }
 ```
 
-Here are the places where the transformer would apply 
-- Reading a file from the file system  
+Here are the places where the transformer would apply
+- Reading a file from the file system
 - Writing a file into the file system
 - Http response is downloaded to storage directly
 

package/android/build.gradle

@@ -30,11 +30,19 @@ buildscript {
             mavenCentral()
         }
         dependencies {
-            classpath 'com.android.tools.build:gradle:4.1.3'
+            classpath 'com.android.tools.build:gradle:7.2.1'
         }
     }
 }
 
+def isNewArchitectureEnabled() {
+    return project.hasProperty("newArchEnabled") && project.newArchEnabled == "true"
+}
+
+if (isNewArchitectureEnabled()) {
+    apply plugin: 'com.facebook.react'
+}
+
 android {
     compileSdkVersion safeExtGet('compileSdkVersion', 30)
     buildToolsVersion safeExtGet('buildToolsVersion', '28.0.3')
@@ -43,6 +51,7 @@ android {
         targetSdkVersion safeExtGet('targetSdkVersion', 30)
         versionCode 1
         versionName "1.0"
+        buildConfigField("boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString())
     }
     buildTypes {
         release {
@@ -55,6 +64,15 @@ android {
     }
     productFlavors {
     }
+    sourceSets {
+        main {
+            if (isNewArchitectureEnabled()) {
+                java.srcDirs += ['src/newarch']
+            } else {
+                java.srcDirs += ['src/oldarch']
+            }
+        }
+    }
 }
 
 dependencies {

package/android/src/main/java/com/ReactNativeBlobUtil/ReactNativeBlobUtilBody.java

@@ -173,7 +173,7 @@ class ReactNativeBlobUtilBody extends RequestBody {
             if (ReactNativeBlobUtilUtils.isAsset(orgPath)) {
                 try {
                     String assetName = orgPath.replace(ReactNativeBlobUtilConst.FILE_PREFIX_BUNDLE_ASSET, "");
-                    return ReactNativeBlobUtil.RCTContext.getAssets().open(assetName);
+                    return ReactNativeBlobUtilImpl.RCTContext.getAssets().open(assetName);
                 } catch (Exception e) {
                     throw new Exception("error when getting request stream from asset : " + e.getLocalizedMessage());
                 }
@@ -190,7 +190,7 @@ class ReactNativeBlobUtilBody extends RequestBody {
         } else if (rawBody.startsWith(ReactNativeBlobUtilConst.CONTENT_PREFIX)) {
             String contentURI = rawBody.substring(ReactNativeBlobUtilConst.CONTENT_PREFIX.length());
             try {
-                return ReactNativeBlobUtil.RCTContext.getContentResolver().openInputStream(Uri.parse(contentURI));
+                return ReactNativeBlobUtilImpl.RCTContext.getContentResolver().openInputStream(Uri.parse(contentURI));
             } catch (Exception e) {
                 throw new Exception("error when getting request stream for content URI: " + contentURI, e);
             }
@@ -215,12 +215,12 @@ class ReactNativeBlobUtilBody extends RequestBody {
     private File createMultipartBodyCache() throws IOException {
         String boundary = "ReactNativeBlobUtil-" + mTaskId;
 
-        File outputDir = ReactNativeBlobUtil.RCTContext.getCacheDir(); // context being the Activity pointer
+        File outputDir = ReactNativeBlobUtilImpl.RCTContext.getCacheDir(); // context being the Activity pointer
         File outputFile = File.createTempFile("rnfb-form-tmp", "", outputDir);
         FileOutputStream os = new FileOutputStream(outputFile);
 
         ArrayList<FormField> fields = countFormDataLength();
-        ReactApplicationContext ctx = ReactNativeBlobUtil.RCTContext;
+        ReactApplicationContext ctx = ReactNativeBlobUtilImpl.RCTContext;
 
         for (FormField field : fields) {
             String data = field.data;
@@ -344,7 +344,7 @@ class ReactNativeBlobUtilBody extends RequestBody {
     private ArrayList<FormField> countFormDataLength() throws IOException {
         long total = 0;
         ArrayList<FormField> list = new ArrayList<>();
-        ReactApplicationContext ctx = ReactNativeBlobUtil.RCTContext;
+        ReactApplicationContext ctx = ReactNativeBlobUtilImpl.RCTContext;
         for (int i = 0; i < form.size(); i++) {
             FormField field = new FormField(form.getMap(i));
             list.add(field);
@@ -442,7 +442,7 @@ class ReactNativeBlobUtilBody extends RequestBody {
             args.putString("total", String.valueOf(contentLength));
 
             // emit event to js context
-            ReactNativeBlobUtil.RCTContext.getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
+            ReactNativeBlobUtilImpl.RCTContext.getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
                     .emit(ReactNativeBlobUtilConst.EVENT_UPLOAD_PROGRESS, args);
         }
     }

package/android/src/main/java/com/ReactNativeBlobUtil/ReactNativeBlobUtilFS.java

@@ -258,15 +258,15 @@ class ReactNativeBlobUtilFS {
             if (resolved != null && resolved.startsWith(ReactNativeBlobUtilConst.FILE_PREFIX_BUNDLE_ASSET)) {
                 String assetName = path.replace(ReactNativeBlobUtilConst.FILE_PREFIX_BUNDLE_ASSET, "");
                 // This fails should an asset file be >2GB
-                length = (int) ReactNativeBlobUtil.RCTContext.getAssets().openFd(assetName).getLength();
+                length = (int) ReactNativeBlobUtilImpl.RCTContext.getAssets().openFd(assetName).getLength();
                 bytes = new byte[length];
-                InputStream in = ReactNativeBlobUtil.RCTContext.getAssets().open(assetName);
+                InputStream in = ReactNativeBlobUtilImpl.RCTContext.getAssets().open(assetName);
                 bytesRead = in.read(bytes, 0, length);
                 in.close();
             }
             // issue 287
             else if (resolved == null) {
-                InputStream in = ReactNativeBlobUtil.RCTContext.getContentResolver().openInputStream(Uri.parse(path));
+                InputStream in = ReactNativeBlobUtilImpl.RCTContext.getContentResolver().openInputStream(Uri.parse(path));
                 // TODO See https://developer.android.com/reference/java/io/InputStream.html#available()
                 // Quote: "Note that while some implementations of InputStream will return the total number of bytes
                 // in the stream, many will not. It is never correct to use the return value of this method to
@@ -358,6 +358,10 @@ class ReactNativeBlobUtilFS {
         }
         res.put("MainBundleDir", ctx.getApplicationInfo().dataDir);
 
+        // TODO Change me with the correct path
+        res.put("LibraryDir", "");
+        res.put("ApplicationSupportDir", "");
+
         return res;
     }
 
@@ -441,7 +445,7 @@ class ReactNativeBlobUtilFS {
      * @return String
      */
     static String getTmpPath(String taskId) {
-        return ReactNativeBlobUtil.RCTContext.getFilesDir() + "/ReactNativeBlobUtilTmp_" + taskId;
+        return ReactNativeBlobUtilImpl.RCTContext.getFilesDir() + "/ReactNativeBlobUtilTmp_" + taskId;
     }
 
 
@@ -614,7 +618,7 @@ class ReactNativeBlobUtilFS {
         if (isAsset(path)) {
             try {
                 String filename = path.replace(ReactNativeBlobUtilConst.FILE_PREFIX_BUNDLE_ASSET, "");
-                com.ReactNativeBlobUtil.ReactNativeBlobUtil.RCTContext.getAssets().openFd(filename);
+                com.ReactNativeBlobUtil.ReactNativeBlobUtilImpl.RCTContext.getAssets().openFd(filename);
                 callback.invoke(true, false);
             } catch (IOException e) {
                 callback.invoke(false, false);
@@ -779,7 +783,7 @@ class ReactNativeBlobUtilFS {
             WritableMap stat = Arguments.createMap();
             if (isAsset(path)) {
                 String name = path.replace(ReactNativeBlobUtilConst.FILE_PREFIX_BUNDLE_ASSET, "");
-                AssetFileDescriptor fd = ReactNativeBlobUtil.RCTContext.getAssets().openFd(name);
+                AssetFileDescriptor fd = ReactNativeBlobUtilImpl.RCTContext.getAssets().openFd(name);
                 stat.putString("filename", name);
                 stat.putString("path", path);
                 stat.putString("type", "asset");
@@ -1020,7 +1024,7 @@ class ReactNativeBlobUtilFS {
      */
     private static InputStream inputStreamFromPath(String path) throws IOException {
         if (path.startsWith(ReactNativeBlobUtilConst.FILE_PREFIX_BUNDLE_ASSET)) {
-            return ReactNativeBlobUtil.RCTContext.getAssets().open(path.replace(ReactNativeBlobUtilConst.FILE_PREFIX_BUNDLE_ASSET, ""));
+            return ReactNativeBlobUtilImpl.RCTContext.getAssets().open(path.replace(ReactNativeBlobUtilConst.FILE_PREFIX_BUNDLE_ASSET, ""));
         }
         return new FileInputStream(new File(path));
     }
@@ -1034,7 +1038,7 @@ class ReactNativeBlobUtilFS {
     private static boolean isPathExists(String path) {
         if (path.startsWith(ReactNativeBlobUtilConst.FILE_PREFIX_BUNDLE_ASSET)) {
             try {
-                ReactNativeBlobUtil.RCTContext.getAssets().open(path.replace(com.ReactNativeBlobUtil.ReactNativeBlobUtilConst.FILE_PREFIX_BUNDLE_ASSET, ""));
+                ReactNativeBlobUtilImpl.RCTContext.getAssets().open(path.replace(com.ReactNativeBlobUtil.ReactNativeBlobUtilConst.FILE_PREFIX_BUNDLE_ASSET, ""));
             } catch (IOException e) {
                 return false;
             }