react-native-windows 0.69.0-preview.2 → 0.69.0-preview.5

package/Shared/Modules/IHttpModuleProxy.h

@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#pragma once
+
+#include "IRequestBodyHandler.h"
+#include "IResponseHandler.h"
+#include "IUriHandler.h"
+
+// Standard Library
+#include <functional>
+
+namespace Microsoft::React {
+
+/// <summary>
+/// Provides partial access to HttpModule methods directly to other native modules
+/// without switching to the JavaScript queue thread.
+/// </summary>
+struct IHttpModuleProxy {
+  virtual ~IHttpModuleProxy() noexcept {}
+
+  // TODO: Implement custom URI handlers.
+  virtual void AddUriHandler(std::shared_ptr<IUriHandler> uriHandler) noexcept = 0;
+
+  virtual void AddRequestBodyHandler(std::shared_ptr<IRequestBodyHandler> requestBodyHandler) noexcept = 0;
+
+  virtual void AddResponseHandler(std::shared_ptr<IResponseHandler> responseHandler) noexcept = 0;
+};
+
+} // namespace Microsoft::React

package/Shared/Modules/IRequestBodyHandler.h

@@ -0,0 +1,52 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#pragma once
+
+// Folly
+#include <folly/dynamic.h>
+
+// Standard Library
+#include <string>
+
+namespace Microsoft::React {
+
+/// <summary>
+/// Allows adding custom handling to build the {@link RequestBody} from the JS body payload.
+/// </summary>
+struct IRequestBodyHandler {
+  /// <summary>
+  /// Returns if the handler should be used for a JS body payload.
+  /// </summary>
+  /// <param name="data">
+  /// folly object potentially containing a blob reference.
+  /// "blob"  - folly object holding blob metadata. Optional.
+  /// </param>
+  /// <returns>
+  /// true  - <paramref name="data" /> contains a blob reference.
+  /// false - <paramref name="data" /> does not contain a blob reference.
+  /// </returns>
+  virtual bool Supports(folly::dynamic &data) = 0;
+
+  /// <summary>
+  /// Returns the {@link RequestBody} for the JS body payload.
+  /// </summary>
+  /// <param name="data">
+  /// Incoming folly object containing the blob metadada.
+  /// Structure:
+  /// "blob"  - folly object info
+  ///   "blobId"  - Blob unique identifier
+  ///   "offset"  - Start index to read the blob
+  ///   "size"    - Amount of bytes to read from the blob
+  /// </param>
+  /// <returns>
+  /// folly::dynamic object with the following entries:
+  /// "type"  - Request content type
+  /// "size"  - Amount of bytes
+  /// "bytes" - Raw body content
+  ///           NOTE: This is an arbitrary key. Pending non-folly structured object to model request body.
+  /// </returns>
+  virtual folly::dynamic ToRequestBody(folly::dynamic &data, std::string &contentType) = 0;
+};
+
+} // namespace Microsoft::React

package/Shared/Modules/IResponseHandler.h

@@ -0,0 +1,27 @@
+#pragma once
+
+// Folly
+#include <folly/dynamic.h>
+
+// Standard Library
+#include <string>
+#include <vector>
+
+namespace Microsoft::React {
+
+/// <summary>
+/// Allows adding custom handling to build the JS body payload from the {@link ResponseBody}.
+/// </summary>
+struct IResponseHandler {
+  /// <summary>
+  /// Returns if the handler should be used for a response type.
+  /// </summary>
+  virtual bool Supports(std::string &responseType) = 0;
+
+  /// <summary>
+  /// Returns the JS body payload for the {@link ResponseBody}.
+  /// </summary>
+  virtual folly::dynamic ToResponseData(std::vector<uint8_t> &&content) = 0;
+};
+
+} // namespace Microsoft::React

package/Shared/Modules/IUriHandler.h

@@ -0,0 +1,37 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#pragma once
+
+// Folly
+#include <folly/dynamic.h>
+
+// Standard Library
+#include <string>
+
+namespace Microsoft::React {
+
+/// <summary>
+/// Allows to implement a custom fetching process for specific URIs. It is the handler's job to
+/// fetch the URI and return the JS body payload.
+/// </summary>
+struct IUriHandler {
+  /// <summary>
+  /// Returns whether the handler should be used for a given URI.
+  /// </summary>
+  virtual bool Supports(std::string &uri, std::string &responseType) = 0;
+
+  /// <summary>
+  /// Fetch the URI and return the JS body payload.
+  /// </summary>
+  /// <returns>
+  /// Blob representation in a dynamic object with the folliwing structure:
+  /// "blobId"      - Blob unique identifier
+  /// "offset"      - Blob segment starting offset
+  /// "size"        - Number of bytes fetched from blob
+  /// "name"        - File name obtained from the URI
+  /// "lastModified - Last write to local file in milliseconds
+  virtual folly::dynamic Fetch(std::string &uri) = 0;
+};
+
+} // namespace Microsoft::React

package/Shared/Modules/IWebSocketModuleContentHandler.h

@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#pragma once
+
+// React Native
+#include <folly/dynamic.h>
+
+// Standard Library
+#include <string>
+#include <vector>
+
+namespace Microsoft::React {
+
+/// <summary>
+/// See https://github.com/facebook/react-native/blob/v0.63.2/React/CoreModules/RCTWebSocketModule.h#L12
+/// </summary>
+struct IWebSocketModuleContentHandler {
+  virtual ~IWebSocketModuleContentHandler() noexcept {}
+
+  virtual void ProcessMessage(std::string &&message, folly::dynamic &params) = 0;
+
+  virtual void ProcessMessage(std::vector<uint8_t> &&message, folly::dynamic &params) = 0;
+};
+
+} // namespace Microsoft::React

package/Shared/Modules/IWebSocketModuleProxy.h

@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#pragma once
+
+// Standard Library
+#include <memory>
+#include <string>
+
+namespace Microsoft::React {
+
+/// <summary>
+/// Provides partial access to WebSocketModule methods directly to other native modules
+/// without switching to the JavaScript queue thread.
+/// </summary>
+struct IWebSocketModuleProxy {
+  virtual ~IWebSocketModuleProxy() noexcept {}
+
+  virtual void SendBinary(std::string &&base64String, int64_t id) noexcept = 0;
+};
+
+} // namespace Microsoft::React

package/Shared/Modules/NetworkingModule.cpp

@@ -261,7 +261,7 @@ void NetworkingModule::NetworkingHelper::SendRequest(
   int64_t requestId = ++s_lastRequestId;
 
   // Enforce supported args
-  assert(responseType == "text" || responseType == "base64");
+  assert(responseType == "text" || responseType == "base64" || responseType == "blob");
 
   // Callback with the requestId
   cb({requestId});

package/Shared/Modules/WebSocketModule.cpp

@@ -5,10 +5,16 @@
 
 #include <Modules/WebSocketModule.h>
 
-#include <Utils.h>
+#include <Modules/CxxModuleUtilities.h>
+#include <Modules/IWebSocketModuleContentHandler.h>
+#include <ReactPropertyBag.h>
+
+// React Native
 #include <cxxreact/Instance.h>
 #include <cxxreact/JsArgumentHelpers.h>
-#include "Unicode.h"
+
+// Windows API
+#include <winrt/Windows.Security.Cryptography.h>
 
 // Standard Libriary
 #include <iomanip>
@@ -18,25 +24,26 @@ using namespace facebook::xplat;
 using facebook::react::Instance;
 using folly::dynamic;
 
-using Microsoft::Common::Unicode::Utf16ToUtf8;
-using Microsoft::Common::Unicode::Utf8ToUtf16;
-
 using std::shared_ptr;
 using std::string;
 using std::weak_ptr;
 
+using winrt::Microsoft::ReactNative::IReactPropertyBag;
+using winrt::Microsoft::ReactNative::ReactNonAbiValue;
+using winrt::Microsoft::ReactNative::ReactPropertyBag;
+using winrt::Microsoft::ReactNative::ReactPropertyId;
+
+using winrt::Windows::Foundation::IInspectable;
+using winrt::Windows::Security::Cryptography::CryptographicBuffer;
+
 namespace {
+using Microsoft::React::IWebSocketModuleProxy;
 using Microsoft::React::WebSocketModule;
+using Microsoft::React::Modules::SendEvent;
 using Microsoft::React::Networking::IWebSocketResource;
 
 constexpr char moduleName[] = "WebSocketModule";
 
-static void SendEvent(weak_ptr<Instance> weakInstance, string &&eventName, dynamic &&args) {
-  if (auto instance = weakInstance.lock()) {
-    instance->callJSFunction("RCTDeviceEventEmitter", "emit", dynamic::array(std::move(eventName), std::move(args)));
-  }
-}
-
 static shared_ptr<IWebSocketResource>
 GetOrCreateWebSocket(int64_t id, string &&url, weak_ptr<WebSocketModule::SharedState> weakState) {
   auto state = weakState.lock();
@@ -91,14 +98,37 @@ GetOrCreateWebSocket(int64_t id, string &&url, weak_ptr<WebSocketModule::SharedS
       auto args = dynamic::object("id", id);
       SendEvent(weakInstance, "websocketOpen", std::move(args));
     });
-    ws->SetOnMessage([id, weakInstance](size_t length, const string &message, bool isBinary) {
-      auto strongInstance = weakInstance.lock();
-      if (!strongInstance)
-        return;
+    ws->SetOnMessage(
+        [id, weakInstance, propBag = ReactPropertyBag{state->InspectableProps.try_as<IReactPropertyBag>()}](
+            size_t length, const string &message, bool isBinary) {
+          auto strongInstance = weakInstance.lock();
+          if (!strongInstance)
+            return;
+
+          dynamic args = dynamic::object("id", id)("type", isBinary ? "binary" : "text");
+          shared_ptr<Microsoft::React::IWebSocketModuleContentHandler> contentHandler;
+          auto propId = ReactPropertyId<ReactNonAbiValue<weak_ptr<Microsoft::React::IWebSocketModuleContentHandler>>>{
+              L"BlobModule.ContentHandler"};
+          if (auto prop = propBag.Get(propId))
+            contentHandler = prop.Value().lock();
+
+          if (contentHandler) {
+            if (isBinary) {
+              auto buffer = CryptographicBuffer::DecodeFromBase64String(winrt::to_hstring(message));
+              winrt::com_array<uint8_t> arr;
+              CryptographicBuffer::CopyToByteArray(buffer, arr);
+              auto data = std::vector<uint8_t>(arr.begin(), arr.end());
+
+              contentHandler->ProcessMessage(std::move(data), args);
+            } else {
+              contentHandler->ProcessMessage(string{message}, args);
+            }
+          } else {
+            args["data"] = message;
+          }
 
-      auto args = dynamic::object("id", id)("data", message)("type", isBinary ? "binary" : "text");
-      SendEvent(weakInstance, "websocketMessage", std::move(args));
-    });
+          SendEvent(weakInstance, "websocketMessage", std::move(args));
+        });
     ws->SetOnClose([id, weakInstance](IWebSocketResource::CloseCode code, const string &reason) {
       auto strongInstance = weakInstance.lock();
       if (!strongInstance)
@@ -119,9 +149,24 @@ GetOrCreateWebSocket(int64_t id, string &&url, weak_ptr<WebSocketModule::SharedS
 
 namespace Microsoft::React {
 
-WebSocketModule::WebSocketModule() : m_sharedState{std::make_shared<SharedState>()} {
+#pragma region WebSocketModule
+
+WebSocketModule::WebSocketModule(winrt::Windows::Foundation::IInspectable const &inspectableProperties)
+    : m_sharedState{std::make_shared<SharedState>()},
+      m_proxy{std::make_shared<WebSocketModuleProxy>(inspectableProperties)} {
   m_sharedState->ResourceFactory = [](string &&url) { return IWebSocketResource::Make(); };
   m_sharedState->Module = this;
+  m_sharedState->InspectableProps = inspectableProperties;
+
+  auto propBag = ReactPropertyBag{m_sharedState->InspectableProps.try_as<IReactPropertyBag>()};
+
+  auto proxyPropId = ReactPropertyId<ReactNonAbiValue<weak_ptr<IWebSocketModuleProxy>>>{L"WebSocketModule.Proxy"};
+  auto proxy = weak_ptr<IWebSocketModuleProxy>{m_proxy};
+  propBag.Set(proxyPropId, std::move(proxy));
+
+  auto statePropId = ReactPropertyId<ReactNonAbiValue<weak_ptr<SharedState>>>{L"WebSocketModule.SharedState"};
+  auto state = weak_ptr<SharedState>{m_sharedState};
+  propBag.Set(statePropId, std::move(state));
 }
 
 WebSocketModule::~WebSocketModule() noexcept /*override*/ {
@@ -167,7 +212,7 @@ std::vector<facebook::xplat::module::CxxModule::Method> WebSocketModule::getMeth
           const auto& headersDynamic = optionsDynamic["headers"];
           for (const auto& header : headersDynamic.items())
           {
-            options.emplace(Utf8ToUtf16(header.first.getString()), header.second.getString());
+            options.emplace(winrt::to_hstring(header.first.getString()), header.second.getString());
           }
         }
 
@@ -246,12 +291,37 @@ std::vector<facebook::xplat::module::CxxModule::Method> WebSocketModule::getMeth
 } // getMethods
 // clang-format on
 
+#pragma endregion WebSocketModule
+
+#pragma region WebSocketModuleProxy
+
+WebSocketModuleProxy::WebSocketModuleProxy(IInspectable const &inspectableProperties) noexcept
+    : m_inspectableProps{inspectableProperties} {}
+
+void WebSocketModuleProxy::SendBinary(std::string &&base64String, int64_t id) noexcept /*override*/ {
+  auto propBag = ReactPropertyBag{m_inspectableProps.try_as<IReactPropertyBag>()};
+  auto sharedPropId =
+      ReactPropertyId<ReactNonAbiValue<weak_ptr<WebSocketModule::SharedState>>>{L"WebSocketModule.SharedState"};
+  auto state = propBag.Get(sharedPropId).Value();
+
+  weak_ptr weakWs = GetOrCreateWebSocket(id, {}, std::move(state));
+  if (auto sharedWs = weakWs.lock()) {
+    sharedWs->SendBinary(std::move(base64String));
+  }
+}
+
+#pragma endregion WebSocketModuleProxy
+
 /*extern*/ const char *GetWebSocketModuleName() noexcept {
   return moduleName;
 }
 
-/*extern*/ std::unique_ptr<facebook::xplat::module::CxxModule> CreateWebSocketModule() noexcept {
-  return std::make_unique<WebSocketModule>();
+/*extern*/ std::unique_ptr<facebook::xplat::module::CxxModule> CreateWebSocketModule(
+    IInspectable const &inspectableProperties) noexcept {
+  if (auto properties = inspectableProperties.try_as<IReactPropertyBag>())
+    return std::make_unique<WebSocketModule>(properties);
+
+  return nullptr;
 }
 
 } // namespace Microsoft::React

package/Shared/Modules/WebSocketModule.h

@@ -3,13 +3,31 @@
 
 #pragma once
 
+#include <Modules/IWebSocketModuleProxy.h>
 #include <Networking/IWebSocketResource.h>
 
 // React Native
 #include <cxxreact/CxxModule.h>
 
+// Windows API
+#include <winrt/Windows.Foundation.h>
+
 namespace Microsoft::React {
 
+class WebSocketModuleProxy final : public IWebSocketModuleProxy {
+  // Property bag high level reference.
+  winrt::Windows::Foundation::IInspectable m_inspectableProps;
+
+ public:
+  WebSocketModuleProxy(winrt::Windows::Foundation::IInspectable const &inspectableProperties) noexcept;
+
+#pragma region IWebSocketModuleProxy
+
+  void SendBinary(std::string &&base64String, int64_t id) noexcept override;
+
+#pragma endregion
+};
+
 ///
 /// Realizes <c>NativeModules</c> projection.
 /// <remarks>See react-native/Libraries/WebSocket/WebSocket.js</remarks>
@@ -18,7 +36,7 @@ class WebSocketModule : public facebook::xplat::module::CxxModule {
  public:
   enum MethodId { Connect = 0, Close = 1, Send = 2, SendBinary = 3, Ping = 4, SIZE = 5 };
 
-  WebSocketModule();
+  WebSocketModule(winrt::Windows::Foundation::IInspectable const &inspectableProperties);
 
   ~WebSocketModule() noexcept override;
 
@@ -38,6 +56,9 @@ class WebSocketModule : public facebook::xplat::module::CxxModule {
     /// Keeps a raw reference to the module object to lazily retrieve the React Instance as needed.
     /// </summary>
     CxxModule *Module{nullptr};
+
+    // Property bag high level reference.
+    winrt::Windows::Foundation::IInspectable InspectableProps;
   };
 
 #pragma region CxxModule overrides
@@ -74,6 +95,11 @@ class WebSocketModule : public facebook::xplat::module::CxxModule {
   /// Keeps members that can be accessed threads other than this module's owner accessible.
   /// </summary>
   std::shared_ptr<SharedState> m_sharedState;
+
+  /// <summary>
+  /// Exposes a subset of the module's methods.
+  /// </summary>
+  std::shared_ptr<IWebSocketModuleProxy> m_proxy;
 };
 
 } // namespace Microsoft::React

package/Shared/Networking/IHttpResource.h

@@ -3,6 +3,12 @@
 
 #pragma once
 
+// Folly
+#include <folly/dynamic.h>
+
+// Windows API
+#include <winrt/Windows.Foundation.h>
+
 // Standard Library
 #include <functional>
 #include <memory>
@@ -14,6 +20,7 @@ namespace Microsoft::React::Networking {
 struct IHttpResource {
   typedef std::unordered_map<std::string, std::string> Headers;
 
+  // TODO: Implement Form data
   struct BodyData {
     enum class Type : size_t { Empty, String, Base64, Uri, Form } Type = Type::Empty;
     std::string Data;
@@ -27,13 +34,53 @@ struct IHttpResource {
 
   static std::shared_ptr<IHttpResource> Make() noexcept;
 
+  static std::shared_ptr<IHttpResource> Make(
+      winrt::Windows::Foundation::IInspectable const &inspectableProperties) noexcept;
+
   virtual ~IHttpResource() noexcept {}
 
+  /// <summary>
+  /// Initiates an HTTP request.
+  /// </summary>
+  /// <param name="method">
+  /// HTTP verb to send in de request.
+  /// GET | POST | PUT | DELETE | OPTIONS
+  /// </param>
+  /// <param name="url">
+  /// Server/service remote endpoint to send the request to.
+  /// </param>
+  /// <param name="requestId">
+  /// Request unique identifier.
+  /// </param>
+  /// <param name="headers">
+  /// HTTP request header map.
+  /// </param>
+  /// <param name="data">
+  /// Dynamic map containing request payload.
+  /// The payload may be an empty request body or one of the following:
+  /// "string"  - UTF-8 string payload
+  /// "base64"  - Base64-encoded data string
+  /// "uri"     - URI data reference
+  /// "form"    - Form-encoded data
+  /// </param>
+  /// <param name="responseType">
+  /// text | binary | blob
+  /// </param>
+  /// <param name="useIncrementalUpdates">
+  /// Response body to be retrieved in several iterations.
+  /// </param>
+  /// <param name="timeout">
+  /// Request timeout in miliseconds.
+  /// </param>
+  /// <param name="withCredentials">
+  /// Allow including credentials in request.
+  /// </param>
   virtual void SendRequest(
       std::string &&method,
       std::string &&url,
+      int64_t requestId,
       Headers &&headers,
-      BodyData &&bodyData,
+      folly::dynamic &&data,
       std::string &&responseType,
       bool useIncrementalUpdates,
       int64_t timeout,
@@ -43,9 +90,10 @@ struct IHttpResource {
 
   virtual void ClearCookies() noexcept = 0;
 
-  virtual void SetOnRequest(std::function<void(int64_t requestId)> &&handler) noexcept = 0;
+  virtual void SetOnRequestSuccess(std::function<void(int64_t requestId)> &&handler) noexcept = 0;
   virtual void SetOnResponse(std::function<void(int64_t requestId, Response &&response)> &&handler) noexcept = 0;
   virtual void SetOnData(std::function<void(int64_t requestId, std::string &&responseData)> &&handler) noexcept = 0;
+  virtual void SetOnData(std::function<void(int64_t requestId, folly::dynamic &&responseData)> &&handler) noexcept = 0;
   virtual void SetOnError(
       std::function<void(int64_t requestId, std::string &&errorMessage /*, bool isTimeout*/)> &&handler) noexcept = 0;
 };