Add ISerialization interface (#52624)

Summary:
Pull Request resolved: #52624

Add a new optional interface `ISerialization` to JSI. This interface
contains four APIs to clone objects from one runtime to another runtime.

Four methods are introduced in this interface:
* `serialize`: Takes in a JS value (represented by `jsi::Value`) and
serialize the value into an opaque `Serialized` object.

* `deserialize`: Takes in the `Serialized` object created by `serialize`
and deserialize it into the runtime, returning the created JS value.

* `serializeWithTransfer`: Takes in a JS value (represented by
`jsi::Value`) and a `transferList` (a `jsi::Array` of `jsi::Value`s).
This will serialize the `value` into an opaque `Serialize` object and
transfer the ownership of everything in `transferList` into the
`Serialized` object. If any non-transferable values is passed into the
transferList, this will throw. This `Serialized` object must only be
deserialized once.

* `deserializeWithTransfer`: Takes in the `Serialized` object created by
`serializeWithTransfer`. It will deserialize the object into the runtime
and  any value owned by the `Serialized` object will now be owned by the
current runtime. It will return an `jsi::Array` where the first value is
the deserialized value passed into `serializeWithTransfer`, followed by
all transferred values.

The lifetime of the `Serialized` object created from the APIs is
independent of the original object and runtime.

Note that objects can only be copied into another runtime instance of
the same type. For example, a serialized object produced by the Hermes
runtime can only be deserialized by another Hermes runtime.

Changelog: [Internal]

Reviewed By: dannysu, fbmal7

Differential Revision: D76547681

fbshipit-source-id: 0c774f3f469c26d3894cac179f4ce5e32cf5ad7f

Author: tsaichien

packages/react-native/ReactCommon/jsi/jsi/jsi.cpp

@@ -284,6 +284,10 @@ HostObject::~HostObject() {}
 
 NativeState::~NativeState() {}
 
+#ifdef JSI_UNSTABLE
+Serialized::~Serialized() {}
+#endif
+
 Runtime::~Runtime() {}
 
 ICast* Runtime::castInterface(const UUID& /*interfaceUUID*/) {

packages/react-native/ReactCommon/jsi/jsi/jsi.h

@@ -257,6 +257,72 @@ class JSI_EXPORT NativeState {
 // the future. Until released, these features may be subject to change. After
 // release, these features will be moved out of JSI_UNSTABLE and become frozen.
 #ifdef JSI_UNSTABLE
+/// Opaque class that is used to store serialized object from a runtime. The
+/// lifetime of this object is orthogonal to the original runtime object, and
+/// may outlive the original object.
+class JSI_EXPORT Serialized {
+ public:
+  /// Uses \p secretAddr to validate if the Serialized data is supported. If so,
+  /// return the pointer to the underlying serialized data. Otherwise, return a
+  /// nullptr. This should be used by the runtime to deserialize the data.
+  virtual void* getPrivate(const void* secretAddr) = 0;
+  virtual ~Serialized();
+};
+
+/// Provides a set of APIs that allows copying objects between different
+/// runtime instances. The runtimes instances must be of the same type. As an
+/// example, a serialized object from Hermes runtime may only be deserialized by
+/// another Hermes runtime.
+class JSI_EXPORT ISerialization : public ICast {
+ public:
+  static constexpr jsi::UUID uuid{
+      0xd40fe0ec,
+      0xa47c,
+      0x42c9,
+      0x8c09,
+      0x661aeab832d8};
+
+  /// Serializes the given Value \p value using the structured clone algorithm.
+  /// It returns a shared pointer of an opaque Serialized object that can be
+  /// deserialized multiple times. The lifetime of the Serialized object is not
+  /// tied to the lifetime of the original object.
+  virtual std::shared_ptr<Serialized> serialize(Value& value) = 0;
+
+  /// Given a Serialized object provided by \p serialized, deserialize it using
+  /// the structured clone algorithm into a JS value in the current runtime.
+  /// Returns the deserialized JS value.
+  virtual Value deserialize(const std::shared_ptr<Serialized>& serialized) = 0;
+
+  /// Serializes the given jsi::Value \p value using the structured clone
+  /// algorithm. \p transferList must be a JS Array. Given the length property
+  /// of \p transferList, this API will transfer everything at index [0, length
+  /// - 1] to the serialized object. The transferred values will no longer be
+  /// usable in the original runtime. It returns a unique pointer of an opaque
+  /// Serialized object that can be deserialized once only by
+  /// deserializeWithTransfer. The lifetime of the Serialized object is not tied
+  /// to the lifetime of the original object.
+  virtual std::unique_ptr<Serialized> serializeWithTransfer(
+      Value& value,
+      const Array& transferList) = 0;
+
+  /// Using the structure clone algorithm, deserialize the object provided by \p
+  /// serialized into a JS value in the current runtime. \p serialized must be
+  /// created by serializeWithTransfer. If the current runtime does not support
+  /// the serialization scheme in \p serialized, then this method will throw and
+  /// \p serialized will remain unmodified. Otherwise, this will consume the
+  /// serialized data entirely and make the serialized objects in the current
+  /// runtime. Any transferred values in the serialized object will be owned by
+  /// the current runtime.
+  //  This method returns an Array containing the deserialized values, where the
+  //  first element is the value passed into serializeWithTransfer,
+  /// followed by all transferred values.
+  virtual Array deserializeWithTransfer(
+      std::unique_ptr<Serialized>& serialized) = 0;
+
+ protected:
+  ~ISerialization() = default;
+};
+
 #endif // JSI_UNSTABLE
 
 /// Represents a JS runtime.  Movable, but not copyable.  Note that