@amazon-devices/react-native-worklets 1.0.0-rn-83

package/Common/cpp/worklets/SharedItems/SynchronizableAccess.h

@@ -0,0 +1,45 @@
+#pragma once
+
+#include <condition_variable>
+#include <mutex>
+
+namespace worklets {
+
+class SynchronizableAccess {
+ public:
+  /**
+   * Allows you to imperatively lock the synchronizable to perform a
+   * transaction.
+   */
+  void lock();
+
+  /**
+   * Unlocks the synchronizable after an imperative lock when the transaction is
+   * complete.
+   */
+  void unlock();
+
+ protected:
+  void getBlockingBefore();
+  void getBlockingAfter();
+
+  // TODO: Shared pointer members (unless they're atomic) can't be assigned
+  // in a non thread-safe manner, therefore `setDirty` has little sense now.
+  // void setDirtyBefore();
+  // void setDirtyAfter();
+
+  void setBlockingBefore();
+  void setBlockingAfter();
+
+ private:
+  int blockingReaders_{0};
+  // int dirtyWriters_{0};
+  bool blockingWriter_{false};
+  bool imperativelyLocked_{false};
+  pthread_t imperativeOwner_{};
+  std::mutex accessLock_;
+  std::recursive_mutex imperativeLock_;
+  std::condition_variable queue_;
+};
+
+} // namespace worklets

package/Common/cpp/worklets/Tools/Defs.h

@@ -0,0 +1,10 @@
+#pragma once
+
+/*
+On Android JS_RUNTIME_HERMES is set in CMakeList.txt,
+but on iOS there is no simple way to defect if Hermes exists
+so we have to check if headers are available.
+*/
+#if __APPLE__ && __has_include(<hermes/hermes.h>)
+#define JS_RUNTIME_HERMES 1
+#endif

package/Common/cpp/worklets/Tools/FeatureFlags.cpp

@@ -0,0 +1,15 @@
+#include <worklets/Tools/FeatureFlags.h>
+
+namespace worklets {
+
+std::unordered_map<std::string, bool> DynamicFeatureFlags::flags_;
+
+bool DynamicFeatureFlags::getFlag(const std::string &name) {
+  return flags_.contains(name) && flags_[name];
+}
+
+void DynamicFeatureFlags::setFlag(const std::string &name, bool value) {
+  flags_[name] = value;
+}
+
+} // namespace worklets

package/Common/cpp/worklets/Tools/FeatureFlags.h

@@ -0,0 +1,44 @@
+#pragma once
+#include <string>
+#include <unordered_map>
+
+namespace worklets {
+
+class StaticFeatureFlags {
+ public:
+#ifdef WORKLETS_FEATURE_FLAGS
+
+// Convert the value under x into a string
+#define XTOSTRING(x) #x
+// Evaluate the flag value; without this step, it would stringify the flag name
+// itself instead of the flag value
+#define TOSTRING(x) XTOSTRING(x)
+
+  static constexpr bool getFlag(const std::string_view &name) {
+    std::string nameStr = name.data();
+    std::string featureFlags = TOSTRING(WORKLETS_FEATURE_FLAGS);
+    if (featureFlags.find("[" + nameStr + ":") == std::string::npos) {
+      throw std::logic_error("Unable to recognize flag: " + nameStr);
+    }
+    return featureFlags.find("[" + nameStr + ":true]") != std::string::npos;
+  }
+
+#else
+
+  static constexpr bool getFlag(const std::string_view &) {
+    return false;
+  }
+
+#endif
+};
+
+class DynamicFeatureFlags {
+ public:
+  static bool getFlag(const std::string &name);
+  static void setFlag(const std::string &name, bool value);
+
+ private:
+  static std::unordered_map<std::string, bool> flags_;
+};
+
+} // namespace worklets

package/Common/cpp/worklets/Tools/JSISerializer.cpp

@@ -0,0 +1,342 @@
+#include <worklets/Tools/JSISerializer.h>
+
+#include <cxxabi.h>
+#include <iostream>
+#include <sstream>
+
+namespace worklets {
+
+const std::vector<std::string> SUPPORTED_ERROR_TYPES = {
+    "Error",
+    "AggregateError",
+    "EvalError",
+    "RangeError",
+    "ReferenceError",
+    "SyntaxError",
+    "TypeError",
+    "URIError",
+    "InternalError"};
+
+const std::vector<std::string> SUPPORTED_INDEXED_COLLECTION_TYPES = {
+    "Int8Array",
+    "Uint8Array",
+    "Uint8ClampedArray",
+    "Int16Array",
+    "Uint16Array",
+    "Int32Array",
+    "Uint32Array",
+    "BigInt64Array",
+    "BigUint64Array",
+    "Float32Array",
+    "Float64Array",
+};
+
+const std::vector<std::string> SUPPORTED_STRUCTURED_DATA_TYPES = {
+    "ArrayBuffer",
+    "SharedArrayBuffer",
+    "DataView",
+    "Atomics",
+    "JSON",
+};
+
+const std::vector<std::string> SUPPORTED_MANAGING_MEMORY_TYPES = {
+    "WeakRef",
+    "FinalizationRegistry",
+};
+
+const std::vector<std::string> SUPPORTED_ABSTRACTION_OBJECT_TYPES = {
+    "Iterator",
+    "AsyncIterator",
+    "Promise",
+    "GeneratorFunction",
+    "AsyncGeneratorFunction",
+    "Generator",
+    "AsyncGenerator",
+    "AsyncFunction",
+};
+
+const std::vector<std::string> SUPPORTED_REFLECTION_TYPES = {
+    "Reflect",
+    "Proxy",
+};
+
+static inline std::string getObjectTypeName(
+    jsi::Runtime &rt,
+    const jsi::Object &object) {
+  return object.getPropertyAsObject(rt, "constructor")
+      .getProperty(rt, "name")
+      .toString(rt)
+      .utf8(rt);
+}
+
+static inline bool isInstanceOf(
+    jsi::Runtime &rt,
+    const jsi::Object &object,
+    const std::string &type) {
+  return getObjectTypeName(rt, object) == type;
+}
+
+static inline bool isInstanceOfAny(
+    jsi::Runtime &rt,
+    const jsi::Object &object,
+    const std::vector<std::string> &supportedTypes) {
+  auto instanceType = getObjectTypeName(rt, object);
+
+  return std::find(
+             supportedTypes.begin(), supportedTypes.end(), instanceType) !=
+      supportedTypes.end();
+}
+
+JSISerializer::JSISerializer(jsi::Runtime &rt)
+    : rt_(rt),
+      visitedNodes_(rt_.global()
+                        .getPropertyAsFunction(rt_, "Set")
+                        .callAsConstructor(rt_)
+                        .asObject(rt_)) {}
+
+std::string JSISerializer::stringifyWithName(const jsi::Object &object) {
+  std::stringstream ss;
+  ss << '[' << getObjectTypeName(rt_, object) << ']';
+
+  return ss.str();
+}
+
+std::string JSISerializer::stringifyArray(const jsi::Array &arr) {
+  std::stringstream ss;
+  ss << '[';
+
+  for (size_t i = 0, length = arr.size(rt_); i < length; i++) {
+    jsi::Value element = arr.getValueAtIndex(rt_, i);
+    ss << stringifyJSIValueRecursively(element);
+    if (i != length - 1) {
+      ss << ", ";
+    }
+  }
+
+  ss << ']';
+
+  return ss.str();
+}
+
+std::string JSISerializer::stringifyFunction(const jsi::Function &func) {
+  std::stringstream ss;
+  auto kind = (func.isHostFunction(rt_) ? "jsi::HostFunction" : "Function");
+  auto name = func.getProperty(rt_, "name").toString(rt_).utf8(rt_);
+  name = name.empty() ? "anonymous" : name;
+
+  ss << '[' << kind << ' ' << name << ']';
+  return ss.str();
+}
+
+std::string JSISerializer::stringifyHostObject(jsi::HostObject &hostObject) {
+  int status = -1;
+  char *hostObjClassName =
+      abi::__cxa_demangle(typeid(hostObject).name(), NULL, NULL, &status);
+  if (status != 0) {
+    return "[jsi::HostObject]";
+  }
+
+  std::stringstream ss;
+  ss << "[jsi::HostObject(" << hostObjClassName << ")";
+  std::free(hostObjClassName);
+
+  auto props = hostObject.getPropertyNames(rt_);
+  auto propsCount = props.size();
+
+  if (propsCount > 0) {
+    ss << " {";
+    auto lastKey = props.back().utf8(rt_);
+    for (const auto &key : props) {
+      auto formattedKey = key.utf8(rt_);
+      auto value = hostObject.get(rt_, key);
+      ss << '"' << formattedKey << '"' << ": "
+         << stringifyJSIValueRecursively(value);
+      if (formattedKey != lastKey) {
+        ss << ", ";
+      }
+    }
+    ss << '}';
+  }
+  ss << ']';
+
+  return ss.str();
+}
+
+std::string JSISerializer::stringifyObject(const jsi::Object &object) {
+  std::stringstream ss;
+  ss << '{';
+
+  auto props = object.getPropertyNames(rt_);
+
+  for (size_t i = 0, propsCount = props.size(rt_); i < propsCount; i++) {
+    jsi::String propName = props.getValueAtIndex(rt_, i).toString(rt_);
+    ss << '"' << propName.utf8(rt_) << '"' << ": "
+       << stringifyJSIValueRecursively(object.getProperty(rt_, propName));
+    if (i != propsCount - 1) {
+      ss << ", ";
+    }
+  }
+
+  ss << '}';
+
+  return ss.str();
+}
+
+std::string JSISerializer::stringifyError(const jsi::Object &object) {
+  std::stringstream ss;
+  ss << '[' << object.getProperty(rt_, "name").toString(rt_).utf8(rt_) << ": "
+     << object.getProperty(rt_, "message").toString(rt_).utf8(rt_) << ']';
+  return ss.str();
+}
+
+std::string JSISerializer::stringifySet(const jsi::Object &object) {
+  std::stringstream ss;
+  jsi::Function arrayFrom = rt_.global()
+                                .getPropertyAsObject(rt_, "Array")
+                                .getPropertyAsFunction(rt_, "from");
+  jsi::Object result = arrayFrom.call(rt_, object).asObject(rt_);
+
+  if (!result.isArray(rt_)) {
+    return "[Set]";
+  }
+
+  auto arr = result.asArray(rt_);
+  ss << "Set {";
+
+  for (size_t i = 0, length = arr.size(rt_); i < length; i++) {
+    ss << stringifyJSIValueRecursively(arr.getValueAtIndex(rt_, i));
+    if (i != length - 1) {
+      ss << ", ";
+    }
+  }
+
+  ss << '}';
+
+  return ss.str();
+}
+
+std::string JSISerializer::stringifyMap(const jsi::Object &object) {
+  std::stringstream ss;
+  jsi::Function arrayFrom = rt_.global()
+                                .getPropertyAsObject(rt_, "Array")
+                                .getPropertyAsFunction(rt_, "from");
+  jsi::Object result = arrayFrom.call(rt_, object).asObject(rt_);
+
+  if (!result.isArray(rt_)) {
+    return "[Map]";
+  }
+
+  auto arr = result.asArray(rt_);
+  ss << "Map {";
+
+  for (size_t i = 0, length = arr.size(rt_); i < length; i++) {
+    auto pair = arr.getValueAtIndex(rt_, i).asObject(rt_).getArray(rt_);
+    auto key = pair.getValueAtIndex(rt_, 0);
+    auto value = pair.getValueAtIndex(rt_, 1);
+    ss << stringifyJSIValueRecursively(key) << ": "
+       << stringifyJSIValueRecursively(value);
+    if (i != length - 1) {
+      ss << ", ";
+    }
+  }
+
+  ss << '}';
+
+  return ss.str();
+}
+
+std::string JSISerializer::stringifyRecursiveType(const jsi::Object &object) {
+  auto type = getObjectTypeName(rt_, object);
+
+  if (type == "Array") {
+    return "[...]";
+  }
+  if (type == "Object") {
+    return "{...}";
+  }
+  return "...";
+}
+
+std::string JSISerializer::stringifyWithToString(const jsi::Object &object) {
+  return object.getPropertyAsFunction(rt_, "toString")
+      .callWithThis(rt_, object)
+      .toString(rt_)
+      .utf8(rt_);
+}
+
+std::string JSISerializer::stringifyJSIValueRecursively(
+    const jsi::Value &value,
+    bool isTopLevel) {
+  if (value.isBool() || value.isNumber()) {
+    return value.toString(rt_).utf8(rt_);
+  }
+  if (value.isString()) {
+    return isTopLevel ? value.getString(rt_).utf8(rt_)
+                      : '"' + value.getString(rt_).utf8(rt_) + '"';
+  }
+  if (value.isSymbol()) {
+    return value.getSymbol(rt_).toString(rt_);
+  }
+  if (value.isBigInt()) {
+    return value.getBigInt(rt_).toString(rt_).utf8(rt_) + 'n';
+  }
+  if (value.isUndefined()) {
+    return "undefined";
+  }
+  if (value.isNull()) {
+    return "null";
+  }
+  if (value.isObject()) {
+    jsi::Object object = value.asObject(rt_);
+
+    if (hasBeenVisited(object)) {
+      return stringifyRecursiveType(object);
+    }
+    markAsVisited(object);
+
+    if (object.isArray(rt_)) {
+      return stringifyArray(object.getArray(rt_));
+    }
+    if (object.isFunction(rt_)) {
+      return stringifyFunction(object.getFunction(rt_));
+    }
+    if (object.isHostObject(rt_)) {
+      return stringifyHostObject(*object.getHostObject(rt_));
+    }
+    if (isInstanceOfAny(rt_, object, SUPPORTED_ERROR_TYPES)) {
+      return stringifyError(object);
+    }
+    if (isInstanceOfAny(rt_, object, SUPPORTED_INDEXED_COLLECTION_TYPES) ||
+        isInstanceOfAny(rt_, object, SUPPORTED_STRUCTURED_DATA_TYPES) ||
+        isInstanceOfAny(rt_, object, SUPPORTED_MANAGING_MEMORY_TYPES) ||
+        isInstanceOfAny(rt_, object, SUPPORTED_ABSTRACTION_OBJECT_TYPES) ||
+        isInstanceOfAny(rt_, object, SUPPORTED_REFLECTION_TYPES) ||
+        isInstanceOf(rt_, object, "Intl") ||
+        isInstanceOf(rt_, object, "WeakMap") ||
+        isInstanceOf(rt_, object, "WeakSet")) {
+      // TODO: Consider extending this log info
+      return stringifyWithName(object);
+    }
+    if (isInstanceOf(rt_, object, "Date") ||
+        isInstanceOf(rt_, object, "RegExp")) {
+      return stringifyWithToString(object);
+    }
+    if (isInstanceOf(rt_, object, "Map")) {
+      return stringifyMap(object);
+    }
+    if (isInstanceOf(rt_, object, "Set")) {
+      return stringifySet(object);
+    }
+    return stringifyObject(object);
+  }
+
+  throw std::runtime_error("[Worklets] Unsupported value type.");
+}
+
+std::string stringifyJSIValue(jsi::Runtime &rt, const jsi::Value &value) {
+  JSISerializer serializer(rt);
+
+  return serializer.stringifyJSIValueRecursively(value, true);
+}
+
+} // namespace worklets

package/Common/cpp/worklets/Tools/JSISerializer.h

@@ -0,0 +1,51 @@
+#pragma once
+
+// amznmod_react - export symbols for reanimated
+#include <keplerui-083/keplerscript-export.h>
+
+#include <jsi/jsi.h>
+#include <string>
+#include <vector>
+
+using namespace facebook;
+
+namespace worklets {
+
+class JSISerializer {
+ public:
+  explicit JSISerializer(jsi::Runtime &rt);
+  std::string stringifyJSIValueRecursively(
+      const jsi::Value &value,
+      bool isTopLevel = false);
+
+ private:
+  std::string stringifyArray(const jsi::Array &arr);
+  std::string stringifyFunction(const jsi::Function &func);
+  std::string stringifyHostObject(jsi::HostObject &hostObject);
+  std::string stringifyObject(const jsi::Object &object);
+  std::string stringifyError(const jsi::Object &object);
+  std::string stringifySet(const jsi::Object &object);
+  std::string stringifyMap(const jsi::Object &object);
+  std::string stringifyWithName(const jsi::Object &object);
+  std::string stringifyWithToString(const jsi::Object &object);
+  std::string stringifyRecursiveType(const jsi::Object &object);
+
+  bool hasBeenVisited(const jsi::Object &object) {
+    return visitedNodes_.getPropertyAsFunction(rt_, "has")
+        .callWithThis(rt_, visitedNodes_, object)
+        .getBool();
+  }
+
+  void markAsVisited(const jsi::Object &object) {
+    visitedNodes_.getPropertyAsFunction(rt_, "add")
+        .callWithThis(rt_, visitedNodes_, object);
+  }
+
+  jsi::Runtime &rt_;
+  jsi::Object visitedNodes_;
+};
+
+// amznmod_react - export symbols for reanimated
+std::string KEPLERSCRIPT_EXPORT stringifyJSIValue(jsi::Runtime &rt, const jsi::Value &value);
+
+} // namespace worklets

package/Common/cpp/worklets/Tools/JSLogger.cpp

@@ -0,0 +1,68 @@
+#include <worklets/Tools/JSLogger.h>
+
+#include <memory>
+#include <utility>
+
+namespace worklets {
+
+void JSLogger::warnOnJS(const std::string &warning) const {
+#ifndef NDEBUG
+  jsScheduler_->scheduleOnJS([warning](jsi::Runtime &rnRuntime) {
+    auto console = rnRuntime.global().getPropertyAsObject(rnRuntime, "console");
+    auto warn = console.getPropertyAsFunction(rnRuntime, "warn");
+    warn.call(rnRuntime, jsi::String::createFromUtf8(rnRuntime, warning));
+  });
+#endif // NDEBUG
+}
+
+void JSLogger::reportFatalErrorOnJS(
+    const std::shared_ptr<JSScheduler> &jsScheduler,
+    JSErrorData &&jsErrorData,
+    bool force) {
+  auto job = [jsErrorData = std::move(jsErrorData),
+              force](jsi::Runtime &rnRuntime) {
+    reportFatalErrorOnJS(rnRuntime, jsErrorData, force);
+  };
+  if (jsScheduler->canInvokeSyncOnJS()) {
+    jsScheduler->invokeSyncOnJS(job);
+  } else {
+    jsScheduler->scheduleOnJS(job);
+  }
+}
+
+void JSLogger::reportFatalErrorOnJS(
+    jsi::Runtime &rnRuntime,
+    const JSErrorData &jsErrorData,
+    bool force) {
+  const auto &global = rnRuntime.global();
+  const auto errorInstance = rnRuntime.global()
+                                 .getPropertyAsFunction(rnRuntime, "Error")
+                                 .callAsConstructor(rnRuntime)
+                                 .asObject(rnRuntime);
+
+  errorInstance.setProperty(
+      rnRuntime,
+      "message",
+      jsi::String::createFromUtf8(rnRuntime, jsErrorData.message));
+
+  errorInstance.setProperty(
+      rnRuntime,
+      "stack",
+      jsi::String::createFromUtf8(rnRuntime, jsErrorData.stack));
+
+  errorInstance.setProperty(
+      rnRuntime,
+      "name",
+      jsi::String::createFromUtf8(rnRuntime, jsErrorData.name));
+
+  errorInstance.setProperty(
+      rnRuntime,
+      "jsEngine",
+      jsi::String::createFromUtf8(rnRuntime, jsErrorData.jsEngine));
+
+  const auto &reportFatalErrorFunction =
+      global.getPropertyAsFunction(rnRuntime, "__reportFatalRemoteError");
+  reportFatalErrorFunction.call(rnRuntime, errorInstance, force);
+}
+
+} // namespace worklets

package/Common/cpp/worklets/Tools/JSLogger.h

@@ -0,0 +1,37 @@
+#pragma once
+
+#include <worklets/Tools/JSScheduler.h>
+
+#include <memory>
+#include <string>
+
+namespace worklets {
+
+struct JSErrorData {
+  std::string message;
+  std::string stack;
+  std::string name;
+  std::string jsEngine;
+};
+
+class JSLogger {
+ public:
+  explicit JSLogger(const std::shared_ptr<JSScheduler> &jsScheduler)
+      : jsScheduler_(jsScheduler) {}
+  void warnOnJS(const std::string &warning) const;
+
+  static void reportFatalErrorOnJS(
+      const std::shared_ptr<JSScheduler> &jsScheduler,
+      JSErrorData &&jsErrorData,
+      bool force = false);
+
+ private:
+  static void reportFatalErrorOnJS(
+      jsi::Runtime &rnRuntime,
+      const JSErrorData &jsErrorData,
+      bool force = false);
+
+  const std::shared_ptr<JSScheduler> jsScheduler_;
+};
+
+} // namespace worklets

package/Common/cpp/worklets/Tools/JSScheduler.cpp

@@ -0,0 +1,24 @@
+#include <react/debug/react_native_assert.h>
+#include <worklets/Tools/JSScheduler.h>
+
+#include <utility>
+
+namespace worklets {
+
+void JSScheduler::scheduleOnJS(Job job) {
+  jsCallInvoker_->invokeAsync(
+      [job = std::move(job), &rt = rnRuntime_] { job(rt); });
+}
+
+bool JSScheduler::canInvokeSyncOnJS() {
+  return isJavaScriptQueue_();
+}
+
+void JSScheduler::invokeSyncOnJS(Job job) {
+  react_native_assert(
+      canInvokeSyncOnJS() &&
+      "JSScheduler::invokeSyncOnJS should only be called from the JS thread");
+  job(rnRuntime_);
+}
+
+} // namespace worklets

package/Common/cpp/worklets/Tools/JSScheduler.h

@@ -0,0 +1,39 @@
+#pragma once
+
+#include <keplerui-083/keplerscript-export.h>
+
+#include <ReactCommon/CallInvoker.h>
+#include <jsi/jsi.h>
+
+#include <memory>
+
+using namespace facebook;
+using namespace react;
+
+namespace worklets {
+
+class KEPLERSCRIPT_EXPORT JSScheduler {
+  using Job = std::function<void(jsi::Runtime &rt)>;
+
+ public:
+  explicit JSScheduler(
+      jsi::Runtime &rnRuntime,
+      const std::shared_ptr<CallInvoker> &jsCallInvoker,
+      std::function<bool()> &&isJavaScriptQueue)
+      : rnRuntime_(rnRuntime),
+        jsCallInvoker_(jsCallInvoker),
+        isJavaScriptQueue_(isJavaScriptQueue) {}
+
+  void scheduleOnJS(std::function<void(jsi::Runtime &rt)> job);
+
+  void invokeSyncOnJS(std::function<void(jsi::Runtime &rt)> job);
+
+  bool canInvokeSyncOnJS();
+
+ protected:
+  jsi::Runtime &rnRuntime_;
+  const std::shared_ptr<CallInvoker> jsCallInvoker_;
+  const std::function<bool()> isJavaScriptQueue_;
+};
+
+} // namespace worklets

package/Common/cpp/worklets/Tools/PlatformLogger.h

@@ -0,0 +1,16 @@
+#pragma once
+
+#include <string>
+
+namespace worklets {
+
+class PlatformLogger {
+ public:
+  static void log(const char *str);
+  static void log(const std::string &str);
+  static void log(const double d);
+  static void log(const int i);
+  static void log(const bool b);
+};
+
+} // namespace worklets