expo-tiddlywiki-filesystem-android-external-storage 2.11.0 → 2.12.1

package/README.md

@@ -118,6 +118,18 @@ Deletes a directory recursively.
 ### `isExternalStorageManager(): Promise<boolean>`
 Checks if the `MANAGE_EXTERNAL_STORAGE` permission is granted (Android 11+).
 
+## JGit Version Note
+
+This module bundles **JGit 6.2.x** (not the latest 6.10.x) for Android compatibility.
+
+Newer JGit versions (6.3+) call Java 9+ APIs (`InputStream.readNBytes`, `InputStream.transferTo`) that require `coreLibraryDesugaringEnabled` — Android's `desugar_jdk_libs` provides these at build time. The config plugin included in this package automatically enables desugaring in the generated `android/app/build.gradle`.
+
+If you encounter `NoSuchMethodError` for these methods at runtime, verify that the config plugin ran during `expo prebuild` (check that `android/app/build.gradle` contains `coreLibraryDesugaringEnabled true` and `desugar_jdk_libs`).
+
+JGit 6.2.x is the latest release that avoids these Java 9+ API calls while still providing all the Git primitives needed by this module (clone, fetch, push, status, diff, log, etc.). One API trade-off: `CloneCommand.setDepth()` (shallow clone) was introduced in JGit 6.3, so this module does not support `--depth` on clone.
+
+If you need a newer JGit, ensure your app's `minSdkVersion` and desugaring configuration are verified on all target devices.
+
 ## License
 
 MIT

package/android/build.gradle

@@ -14,12 +14,14 @@ android {
   }
   // JGit needs Java 11+
   compileOptions {
+    coreLibraryDesugaringEnabled true
     sourceCompatibility JavaVersion.VERSION_11
     targetCompatibility JavaVersion.VERSION_11
   }
 }
 
 dependencies {
-  implementation 'org.eclipse.jgit:org.eclipse.jgit:6.10.0.202406032230-r'
+  coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:2.1.5'
+  implementation 'org.eclipse.jgit:org.eclipse.jgit:6.2.0.202206071550-r'
   implementation "com.squareup.okhttp3:okhttp:4.12.0"
 }

package/android/src/main/java/expo/modules/externalstorage/GitNetwork.kt

@@ -133,10 +133,6 @@ internal object GitNetwork {
         cloneCommand.setBranchesToClone(listOf("refs/heads/$branch"))
       }
 
-      if (depth > 0) {
-        cloneCommand.setDepth(depth)
-      }
-
       if (noTags) {
         cloneCommand.setNoTags()
       }

package/app.plugin.js

@@ -1,7 +1,34 @@
-const { withAndroidManifest } = require('@expo/config-plugins');
+const { withAndroidManifest, withAppBuildGradle } = require('@expo/config-plugins');
+
+const DESUGAR_DEPENDENCY = "coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:2.1.5'";
+
+function applyCoreLibraryDesugaring(contents) {
+  if (!contents.includes('coreLibraryDesugaringEnabled')) {
+    if (contents.includes('compileOptions {')) {
+      contents = contents.replace(
+        /(compileOptions\s*\{)/,
+        '$1\n        coreLibraryDesugaringEnabled true',
+      );
+    } else {
+      contents = contents.replace(
+        /^(android\s*\{)/m,
+        '$1\n    compileOptions {\n        coreLibraryDesugaringEnabled true\n    }',
+      );
+    }
+  }
+
+  if (!contents.includes('desugar_jdk_libs')) {
+    contents = contents.replace(
+      /^(dependencies\s*\{)/m,
+      `$1\n    ${DESUGAR_DEPENDENCY}`,
+    );
+  }
+
+  return contents;
+}
 
 const withExternalStoragePermission = (config) => {
-  return withAndroidManifest(config, async (config) => {
+  config = withAndroidManifest(config, async (config) => {
     const androidManifest = config.modResults;
     
     if (!androidManifest.manifest['uses-permission']) {
@@ -20,6 +47,13 @@ const withExternalStoragePermission = (config) => {
 
     return config;
   });
+
+  config = withAppBuildGradle(config, (config) => {
+    config.modResults.contents = applyCoreLibraryDesugaring(config.modResults.contents);
+    return config;
+  });
+
+  return config;
 };
 
 module.exports = withExternalStoragePermission;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-tiddlywiki-filesystem-android-external-storage",
-  "version": "2.11.0",
+  "version": "2.12.1",
   "description": "Expo native module for TidGi-Mobile: filesystem I/O + TiddlyWiki .tid/.meta/.json batch parsing + git status in Kotlin (Android) and Swift (iOS)",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -9,8 +9,8 @@
     "build": "tsc -p tsconfig.json",
     "clean": "expo-module clean",
     "lint": "expo-module lint",
-    "test": "expo-module test",
-    "prepare": "tsc -p tsconfig.json"
+    "test": "jest --config jest.config.js",
+    "prepack": "tsc -p tsconfig.json"
   },
   "keywords": [
     "react-native",
@@ -27,13 +27,16 @@
     "react-native": "*"
   },
   "devDependencies": {
+    "@types/jest": "29.5.14",
     "@types/react": "^18.2.0",
     "@types/react-native": "^0.73.0",
     "expo": "^50.0.0",
     "expo-module-scripts": "^3.0.0",
     "expo-modules-core": "^1.11.0",
+    "jest": "29.7.0",
     "react": "^18.2.0",
     "react-native": "^0.73.0",
+    "ts-jest": "~29.0.5",
     "typescript": "^5.0.0"
   },
   "files": [
@@ -42,6 +45,7 @@
     "ios",
     "expo-module.config.json",
     "src",
+    "tsconfig.json",
     "plugin.js",
     "app.plugin.js"
   ],

package/plugin.js

@@ -1,7 +1,34 @@
-const { withAndroidManifest } = require('@expo/config-plugins');
+const { withAndroidManifest, withAppBuildGradle } = require('@expo/config-plugins');
+
+const DESUGAR_DEPENDENCY = "coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:2.1.5'";
+
+function applyCoreLibraryDesugaring(contents) {
+  if (!contents.includes('coreLibraryDesugaringEnabled')) {
+    if (contents.includes('compileOptions {')) {
+      contents = contents.replace(
+        /(compileOptions\s*\{)/,
+        '$1\n        coreLibraryDesugaringEnabled true',
+      );
+    } else {
+      contents = contents.replace(
+        /^(android\s*\{)/m,
+        '$1\n    compileOptions {\n        coreLibraryDesugaringEnabled true\n    }',
+      );
+    }
+  }
+
+  if (!contents.includes('desugar_jdk_libs')) {
+    contents = contents.replace(
+      /^(dependencies\s*\{)/m,
+      `$1\n    ${DESUGAR_DEPENDENCY}`,
+    );
+  }
+
+  return contents;
+}
 
 const withExternalStoragePermission = (config) => {
-  return withAndroidManifest(config, async (config) => {
+  config = withAndroidManifest(config, async (config) => {
     const androidManifest = config.modResults;
     
     if (!androidManifest.manifest['uses-permission']) {
@@ -20,6 +47,13 @@ const withExternalStoragePermission = (config) => {
 
     return config;
   });
+
+  config = withAppBuildGradle(config, (config) => {
+    config.modResults.contents = applyCoreLibraryDesugaring(config.modResults.contents);
+    return config;
+  });
+
+  return config;
 };
 
 module.exports = withExternalStoragePermission;

package/src/__tests__/index.test.ts

@@ -0,0 +1,57 @@
+type ExternalStorageModule = typeof import('../index');
+
+function loadModuleWithPlatform(
+  platformOS: string,
+  nativeModule: Record<string, unknown> = {},
+): { module: ExternalStorageModule; requireNativeModule: jest.Mock } {
+  jest.resetModules();
+  const requireNativeModule = jest.fn(() => nativeModule);
+
+  jest.doMock('react-native', () => ({
+    Platform: {
+      OS: platformOS,
+    },
+  }));
+  jest.doMock('expo-modules-core', () => ({
+    requireNativeModule,
+  }));
+
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
+  const module = require('../index') as ExternalStorageModule;
+  return { module, requireNativeModule };
+}
+
+describe('toPlainPath', () => {
+  it('strips only the file URI scheme from filesystem paths', () => {
+    const { module } = loadModuleWithPlatform('android');
+
+    expect(module.toPlainPath('file:///storage/emulated/0/TidGi/wiki')).toBe('/storage/emulated/0/TidGi/wiki');
+    expect(module.toPlainPath('/storage/emulated/0/TidGi/wiki')).toBe('/storage/emulated/0/TidGi/wiki');
+    expect(module.toPlainPath('content://com.android.externalstorage.documents/tree/primary%3ATidGi')).toBe('content://com.android.externalstorage.documents/tree/primary%3ATidGi');
+  });
+});
+
+describe('ExternalStorage proxy', () => {
+  it('loads the native module lazily when a method is accessed', () => {
+    const nativeExists = jest.fn();
+    const nativeMkdir = jest.fn();
+    const { module, requireNativeModule } = loadModuleWithPlatform('android', {
+      exists: nativeExists,
+      mkdir: nativeMkdir,
+    });
+
+    expect(requireNativeModule).not.toHaveBeenCalled();
+    expect(module.ExternalStorage.exists).toBe(nativeExists);
+    expect(module.ExternalStorage.mkdir).toBe(nativeMkdir);
+    expect(requireNativeModule).toHaveBeenCalledTimes(1);
+    expect(requireNativeModule).toHaveBeenCalledWith('ExternalStorage');
+  });
+
+  it('throws only when the native proxy is accessed on unsupported platforms', () => {
+    const { module, requireNativeModule } = loadModuleWithPlatform('web');
+
+    expect(module.toPlainPath('file:///tmp/wiki')).toBe('/tmp/wiki');
+    expect(requireNativeModule).not.toHaveBeenCalled();
+    expect(() => module.ExternalStorage.exists).toThrow('ExternalStorage native module is only available on Android and iOS');
+  });
+});

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "expo-module-scripts/tsconfig.base",
+  "compilerOptions": {
+    "outDir": "./build",
+    "rootDir": "./src"
+  },
+  "include": ["src"],
+  "exclude": ["src/**/__tests__/**", "src/**/*.test.ts"]
+}