Added disposing/release mechanism to the system

To make sure we free any underlying values due to the dreaded hermes GC issue where internally allocated memory is not calcualated when considering garbage collection we need to implement this ourselves. A shared value is now disposed and all resources allocated should be released. This is done through wrappers. When deleting argument wrappers we also release any resources. Fixes #129
margelo · Oct 28, 2023 · e66f5d5 · e66f5d5
1 parent 800cf1b
commit e66f5d5
Show file tree

Hide file tree

Showing 10 changed files with 97 additions and 5 deletions.
diff --git a/cpp/WKTJsiWorklet.h b/cpp/WKTJsiWorklet.h
@@ -301,7 +301,7 @@ class JsiWorklet : public JsiHostObject,
                       .asString(runtime)
                       .utf8(runtime);
     }
-    
+
     // Double-check if the code property is valid.
     bool isCodeEmpty = std::all_of(_code.begin(), _code.end(), std::isspace);
     if (isCodeEmpty) {

diff --git a/cpp/base/WKTJsiHostObject.cpp b/cpp/base/WKTJsiHostObject.cpp
@@ -31,6 +31,13 @@ JsiHostObject::~JsiHostObject() {
 #endif
 }
 
+void JsiHostObject::dispose() {
+  if (!_disposed) {
+    dispose(_disposed);
+    _disposed = true;
+  }
+}
+
 void JsiHostObject::set(jsi::Runtime &rt, const jsi::PropNameID &name,
                         const jsi::Value &value) {
 

diff --git a/cpp/base/WKTJsiHostObject.h b/cpp/base/WKTJsiHostObject.h
@@ -143,6 +143,11 @@ class JsiHostObject : public jsi::HostObject {
   JsiHostObject();
   ~JsiHostObject();
 
+  /**
+   Disposes and releases all used resources
+   */
+  void dispose();
+
 protected:
   /**
    Override to return map of name/functions
@@ -194,7 +199,13 @@ class JsiHostObject : public jsi::HostObject {
    */
   std::vector<jsi::PropNameID> getPropertyNames(jsi::Runtime &runtime) override;
 
+  /**
+   Override to dispose
+   */
+  virtual void dispose(bool disposed) {}
+
 private:
   std::map<void *, std::map<std::string, jsi::Function>> _hostFunctionCache;
+  std::atomic<bool> _disposed = {false};
 };
 } // namespace RNWorklet
diff --git a/cpp/sharedvalues/WKTJsiSharedValue.h b/cpp/sharedvalues/WKTJsiSharedValue.h
@@ -30,6 +30,11 @@ class JsiSharedValue : public JsiHostObject {
    */
   ~JsiSharedValue() { _valueWrapper = nullptr; }
 
+  JSI_HOST_FUNCTION(dispose) {
+    JsiHostObject::dispose();
+    return jsi::Value::undefined();
+  }
+
   JSI_HOST_FUNCTION(toString) {
     return jsi::String::createFromUtf8(runtime,
                                        _valueWrapper->toString(runtime));
@@ -100,6 +105,7 @@ class JsiSharedValue : public JsiHostObject {
   }
 
   JSI_EXPORT_FUNCTIONS(JSI_EXPORT_FUNC(JsiSharedValue, toString),
+                       JSI_EXPORT_FUNC(JsiSharedValue, dispose),
                        JSI_EXPORT_FUNC(JsiSharedValue, addListener))
 
   JSI_EXPORT_PROPERTY_GETTERS(JSI_EXPORT_PROP_GET(JsiSharedValue, value))
@@ -122,6 +128,13 @@ class JsiSharedValue : public JsiHostObject {
     _valueWrapper->removeListener(listenerId);
   }
 
+protected:
+  void dispose(bool disposed) override {
+    if (!disposed) {
+      _valueWrapper->release_wrapped_resources();
+    }
+  }
+
 private:
   std::shared_ptr<JsiWrapper> _valueWrapper;
   std::shared_ptr<JsiWorkletContext> _context;

diff --git a/cpp/wrappers/WKTArgumentsWrapper.h b/cpp/wrappers/WKTArgumentsWrapper.h
@@ -20,6 +20,12 @@ class ArgumentsWrapper {
     }
   }
 
+  ~ArgumentsWrapper() {
+    for (size_t i = 0; i < _arguments.size(); i++) {
+      _arguments[i]->release_wrapped_resources();
+    }
+  }
+
   size_t getCount() const { return _count; }
 
   std::vector<jsi::Value> getArguments(jsi::Runtime &runtime) const {

diff --git a/cpp/wrappers/WKTJsiArrayWrapper.h b/cpp/wrappers/WKTJsiArrayWrapper.h
@@ -32,6 +32,8 @@ class JsiArrayWrapper : public JsiHostObject,
                   JsiWrapper *parent)
       : JsiWrapper(runtime, value, parent, JsiWrapperType::Array) {}
 
+  ~JsiArrayWrapper() { JsiHostObject::dispose(); }
+
   JSI_HOST_FUNCTION(toStringImpl) {
     return jsi::String::createFromUtf8(runtime, toString(runtime));
   }
@@ -413,6 +415,18 @@ class JsiArrayWrapper : public JsiHostObject,
 
   const std::vector<std::shared_ptr<JsiWrapper>> &getArray() { return _array; }
 
+  /**
+    Overridden dispose - release our array resources!
+   */
+  void release_wrapped_resources() override {
+    for (size_t i = 0; i < _array.size(); i++) {
+      _array[i]->release_wrapped_resources();
+    }
+  }
+
+protected:
+  void dispose(bool disposed) override { release_wrapped_resources(); }
+
 private:
   /**
    Creates a proxy for the host object so that we can make the runtime trust

diff --git a/cpp/wrappers/WKTJsiObjectWrapper.h b/cpp/wrappers/WKTJsiObjectWrapper.h
@@ -30,6 +30,8 @@ class JsiObjectWrapper : public JsiHostObject,
                    JsiWrapper *parent)
       : JsiWrapper(runtime, value, parent) {}
 
+  ~JsiObjectWrapper() { JsiHostObject::dispose(); }
+
   JSI_HOST_FUNCTION(toStringImpl) {
     return jsi::String::createFromUtf8(runtime, toString(runtime));
   }
@@ -156,7 +158,22 @@ class JsiObjectWrapper : public JsiHostObject,
     }
   }
 
+  /**
+    Overridden dispose - release our array resources!
+  */
+  void release_wrapped_resources() override {
+    for (auto it = _properties.begin(); it != _properties.end(); it++) {
+      it->second->release_wrapped_resources();
+    }
+  }
+
 protected:
+  void dispose(bool disposed) override {
+    if (!disposed) {
+      release_wrapped_resources();
+    }
+  }
+
   jsi::Value getAsProxyOrValue(jsi::Runtime &runtime) override {
     if (getType() == JsiWrapperType::Object) {
       return getObjectAsProxy(runtime, shared_from_this());

diff --git a/cpp/wrappers/WKTJsiPromiseWrapper.h b/cpp/wrappers/WKTJsiPromiseWrapper.h
@@ -78,7 +78,20 @@ class JsiPromiseWrapper
 
   explicit JsiPromiseWrapper(jsi::Runtime &runtime);
 
-  ~JsiPromiseWrapper() {}
+  ~JsiPromiseWrapper() { JsiHostObject::dispose(); }
+
+  /**
+    Overridden dispose - release our array resources!
+   */
+  void release_wrapped_resources() override {
+    if (_reason != nullptr) {
+      _reason->release_wrapped_resources();
+    }
+    if (_value != nullptr) {
+      _value->release_wrapped_resources();
+    }
+  }
+
   /**
    Returns true if the object is a thenable object - ie. an object with a then
    function. Which is basically what a promise is.
@@ -138,6 +151,12 @@ class JsiPromiseWrapper
   }
 
 protected:
+  void dispose(bool disposed) override {
+    if (!disposed) {
+      release_wrapped_resources();
+    }
+  }
+
   jsi::Value then(jsi::Runtime &runtime, const jsi::Value &thisValue,
                   const jsi::Value *thenFn, const jsi::Value *catchFn);
 

diff --git a/cpp/wrappers/WKTJsiWrapper.h b/cpp/wrappers/WKTJsiWrapper.h
@@ -137,6 +137,11 @@ class JsiWrapper {
    */
   void removeListener(size_t listenerId) { _listeners.erase(listenerId); }
 
+  /**
+    Override to ensure releasing resources correctly
+   */
+  virtual void release_wrapped_resources() {}
+
 protected:
   /**
    * Returns a wrapper for the value
@@ -185,7 +190,6 @@ class JsiWrapper {
                           const jsi::Value &thisValue,
                           const jsi::Value *arguments, size_t count);
 
-protected:
   /**
    * Sets the value from a JS value
    * @param runtime runtime for the value
@@ -253,10 +257,10 @@ class JsiWrapper {
    * @param parent Parent wrapper
    */
   explicit JsiWrapper(JsiWrapper *parent) : _parent(parent) {
-    _readWriteMutex = new std::mutex();
+    _readWriteMutex = std::make_shared<std::mutex>();
   }
 
-  std::mutex *_readWriteMutex;
+  std::shared_ptr<std::mutex> _readWriteMutex;
   JsiWrapper *_parent;
 
   JsiWrapperType _type;

diff --git a/src/types.ts b/src/types.ts
@@ -2,6 +2,7 @@ export interface ISharedValue<T> {
   get value(): T;
   set value(v: T);
   addListener(listener: () => void): () => void;
+  dispose: () => void;
 }
 
 export interface IWorklet {