feat: New MMKV Core and readOnly mode (#753)

* feat: Update MMKV core to V2

* feat: Add `isReadOnly` prop and config

* chore: Lockfiles

* feat: Upgrade deps

* feat: Upgrade deps in package

* fix: Fix missing template argument for `MMKVConfig`

* fix: Add `isReadOnly` to props

* feat: Throw JS Error about readonly

* fix: Format

* docs: Add `readOnly` to config docs

README.md

@@ -111,7 +111,8 @@ export const storage = new MMKV({
   id: `user-${userId}-storage`,
   path: `${USER_DIRECTORY}/storage`,
   encryptionKey: 'hunter2',
-  mode: Mode.MULTI_PROCESS
+  mode: Mode.MULTI_PROCESS,
+  readOnly: false
 })
 ```
 
@@ -123,6 +124,7 @@ The following values can be configured:
 * `path`: The MMKV instance's root path. By default, MMKV stores file inside `$(Documents)/mmkv/`. You can customize MMKV's root directory on MMKV initialization (documentation: [iOS](https://github.com/Tencent/MMKV/wiki/iOS_advance#customize-location) / [Android](https://github.com/Tencent/MMKV/wiki/android_advance#customize-location))
 * `encryptionKey`: The MMKV instance's encryption/decryption key. By default, MMKV stores all key-values in plain text on file, relying on iOS's/Android's sandbox to make sure the file is encrypted. Should you worry about information leaking, you can choose to encrypt MMKV. (documentation: [iOS](https://github.com/Tencent/MMKV/wiki/iOS_advance#encryption) / [Android](https://github.com/Tencent/MMKV/wiki/android_advance#encryption))
 * `mode`: The MMKV's process behaviour - when set to `MULTI_PROCESS`, the MMKV instance will assume data can be changed from the outside (e.g. App Clips, Extensions or App Groups).
+* `readOnly`: Whether this MMKV instance should be in read-only mode. This is typically more efficient and avoids unwanted writes to the data if not needed. Any call to `set(..)` will throw.
 
 ### Set
 

package/cpp/MmkvHostObject.cpp

@@ -26,6 +26,10 @@ MmkvHostObject::MmkvHostObject(const facebook::react::MMKVConfig& config) {
   std::string* pathPtr = path.size() > 0 ? &path : nullptr;
   std::string* encryptionKeyPtr = encryptionKey.size() > 0 ? &encryptionKey : nullptr;
   MMKVMode mode = getMMKVMode(config);
+  if (config.readOnly.has_value() && config.readOnly.value()) {
+    MmkvLogger::log("RNMMKV", "Instance is read-only!");
+    mode = mode | MMKVMode::MMKV_READ_ONLY;
+  }
 
 #ifdef __APPLE__
   instance = MMKV::mmkvWithID(config.id, mode, encryptionKeyPtr, pathPtr);
@@ -62,7 +66,7 @@ MmkvHostObject::~MmkvHostObject() {
 std::vector<jsi::PropNameID> MmkvHostObject::getPropertyNames(jsi::Runtime& rt) {
   return jsi::PropNameID::names(rt, "set", "getBoolean", "getBuffer", "getString", "getNumber",
                                 "contains", "delete", "getAllKeys", "deleteAll", "recrypt", "trim",
-                                "size");
+                                "size", "isReadOnly");
 }
 
 MMKVMode MmkvHostObject::getMMKVMode(const facebook::react::MMKVConfig& config) {
@@ -130,7 +134,12 @@ jsi::Value MmkvHostObject::get(jsi::Runtime& runtime, const jsi::PropNameID& pro
           }
 
           if (!successful) [[unlikely]] {
-            throw std::runtime_error("Failed to set " + keyName + "!");
+            if (instance->isReadOnly()) {
+              throw jsi::JSError(runtime,
+                                 "Failed to set " + keyName + "! This instance is read-only!");
+            } else {
+              throw jsi::JSError(runtime, "Failed to set " + keyName + "!");
+            }
           }
 
           return jsi::Value::undefined();
@@ -310,7 +319,7 @@ jsi::Value MmkvHostObject::get(jsi::Runtime& runtime, const jsi::PropNameID& pro
           }
 
           if (!successful) [[unlikely]] {
-            throw std::runtime_error("Failed to recrypt MMKV instance!");
+            throw jsi::JSError(runtime, "Failed to recrypt MMKV instance!");
           }
 
           return jsi::Value::undefined();
@@ -336,5 +345,11 @@ jsi::Value MmkvHostObject::get(jsi::Runtime& runtime, const jsi::PropNameID& pro
     return jsi::Value(static_cast<int>(size));
   }
 
+  if (propName == "isReadOnly") {
+    // MMKV.isReadOnly
+    bool isReadOnly = instance->isReadOnly();
+    return jsi::Value(isReadOnly);
+  }
+
   return jsi::Value::undefined();
 }

package/cpp/NativeMmkvModule.h

@@ -22,7 +22,7 @@ namespace facebook::react {
 // The MMKVConfiguration type from JS
 using MMKVConfig =
     NativeMmkvConfiguration<std::string, std::optional<std::string>, std::optional<std::string>,
-                            std::optional<NativeMmkvMode>>;
+                            std::optional<NativeMmkvMode>, std::optional<bool>>;
 template <> struct Bridging<MMKVConfig> : NativeMmkvConfigurationBridging<MMKVConfig> {};
 
 // The TurboModule itself

package/example/Gemfile.lock

@@ -95,8 +95,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (>= 6.1.7.5, < 7.1.0)
-  cocoapods (>= 1.13, < 1.15)
+  activesupport (>= 6.1.7.5, != 7.1.0)
+  cocoapods (>= 1.13, != 1.15.1, != 1.15.0)
 
 RUBY VERSION
    ruby 2.6.10p210