[0.72] Port #11718 and #11849 to 0.72 (#11913)

* Get StructInfo<T>::FieldMap lazy initialized (#11718) * Get StructInfo<T>::FieldMap lazy initialized * yarn format * Change files * Add REACT_MODULE_NOREG which is REACT_MODULE but without auto registration (#11849) * #define REACT_MODULE_NOREG * yarn format * Add unit test * ... * ... * Change files * Change files
microsoft · Jul 20, 2023 · 4765f49 · 4765f49
1 parent 39eae21
commit 4765f49
Show file tree

Hide file tree

Showing 8 changed files with 65 additions and 7 deletions.
diff --git a/change/react-native-windows-7561f877-ffe1-4c19-a77a-f2aff6866491.json b/change/react-native-windows-7561f877-ffe1-4c19-a77a-f2aff6866491.json
@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "Port #11718 and #11849 to 0.72",
+  "packageName": "react-native-windows",
+  "email": "53799235+ZihanChen-MSFT@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}
diff --git a/vnext/Microsoft.ReactNative.Cxx.UnitTests/NativeModuleTest.cpp b/vnext/Microsoft.ReactNative.Cxx.UnitTests/NativeModuleTest.cpp
@@ -688,6 +688,18 @@ TEST_CLASS (NativeModuleTest) {
     m_module = React::ReactNonAbiValue<SimpleNativeModule>::GetPtrUnsafe(m_moduleObject);
   }
 
+  TEST_METHOD(EnsureReactModuleAutoRegistered) {
+    bool registered = false;
+    auto current = React::ModuleRegistration::Head();
+    while (current) {
+      if (wcscmp(current->ModuleName(), L"SimpleNativeModule") == 0) {
+        registered = true;
+      }
+      current = current->Next();
+    }
+    TestCheck(registered);
+  }
+
   TEST_METHOD(TestMethodCall_Add) {
     m_builderMock.Call1(L"Add", std::function<void(int)>([](int result) noexcept { TestCheck(result == 8); }), 3, 5);
     TestCheck(m_builderMock.IsResolveCallbackCalled());

diff --git a/vnext/Microsoft.ReactNative.Cxx/JSValueReader.h b/vnext/Microsoft.ReactNative.Cxx/JSValueReader.h
@@ -409,7 +409,7 @@ inline void ReadValue(IJSValueReader const &reader, /*out*/ JSValueArray &value)
 template <class T, std::enable_if_t<!std::is_void_v<decltype(GetStructInfo(static_cast<T *>(nullptr)))>, int>>
 inline void ReadValue(IJSValueReader const &reader, /*out*/ T &value) noexcept {
   if (reader.ValueType() == JSValueType::Object) {
-    const auto &fieldMap = StructInfo<T>::FieldMap;
+    const auto &fieldMap = StructInfo<T>::GetFieldMap();
     hstring propertyName;
     while (reader.GetNextObjectProperty(/*out*/ propertyName)) {
       auto it = fieldMap.find(std::wstring_view(propertyName));

diff --git a/vnext/Microsoft.ReactNative.Cxx/JSValueWriter.h b/vnext/Microsoft.ReactNative.Cxx/JSValueWriter.h
@@ -234,7 +234,7 @@ inline void WriteCustomDirectEventTypeConstant(IJSValueWriter const &writer, std
 template <class T, std::enable_if_t<!std::is_void_v<decltype(GetStructInfo(static_cast<T *>(nullptr)))>, int>>
 inline void WriteValue(IJSValueWriter const &writer, T const &value) noexcept {
   writer.WriteObjectBegin();
-  for (const auto &fieldEntry : StructInfo<T>::FieldMap) {
+  for (const auto &fieldEntry : StructInfo<T>::GetFieldMap()) {
     writer.WritePropertyName(fieldEntry.first);
     fieldEntry.second.WriteField(writer, &value);
   }

diff --git a/vnext/Microsoft.ReactNative.Cxx/ModuleRegistration.h b/vnext/Microsoft.ReactNative.Cxx/ModuleRegistration.h
@@ -51,6 +51,28 @@
   INTERNAL_REACT_RECOMPOSER_4(     \
       (__VA_ARGS__, INTERNAL_REACT_MODULE_3_ARGS, INTERNAL_REACT_MODULE_2_ARGS, INTERNAL_REACT_MODULE_1_ARG, ))
 
+// Another version of REACT_MODULE but does not do auto registration
+#define INTERNAL_REACT_MODULE_NOREG_3_ARGS(moduleStruct, moduleName, eventEmitterName)                 \
+  struct moduleStruct;                                                                                 \
+  template <class TRegistry>                                                                           \
+  constexpr void GetReactModuleInfo(moduleStruct *, TRegistry &registry) noexcept {                    \
+    registry.RegisterModule(                                                                           \
+        moduleName, eventEmitterName, winrt::Microsoft::ReactNative::ReactAttributeId<__COUNTER__>{}); \
+  }
+
+#define INTERNAL_REACT_MODULE_NOREG_2_ARGS(moduleStruct, moduleName) \
+  INTERNAL_REACT_MODULE_NOREG_3_ARGS(moduleStruct, moduleName, L"")
+
+#define INTERNAL_REACT_MODULE_NOREG_1_ARG(moduleStruct) \
+  INTERNAL_REACT_MODULE_NOREG_2_ARGS(moduleStruct, L## #moduleStruct)
+
+#define INTERNAL_REACT_MODULE_NOREG(...)   \
+  INTERNAL_REACT_RECOMPOSER_4(             \
+      (__VA_ARGS__,                        \
+       INTERNAL_REACT_MODULE_NOREG_3_ARGS, \
+       INTERNAL_REACT_MODULE_NOREG_2_ARGS, \
+       INTERNAL_REACT_MODULE_NOREG_1_ARG, ))
+
 // Provide meta data information about struct member.
 // For each member with a 'custom attribute' macro we create a static method to provide meta data.
 // The member Id is generated as a ReactMemberId<__COUNTER__> type.

diff --git a/vnext/Microsoft.ReactNative.Cxx/NativeModules.h b/vnext/Microsoft.ReactNative.Cxx/NativeModules.h
@@ -30,6 +30,11 @@
 #define REACT_MODULE(/* moduleStruct, [opt] moduleName, [opt] eventEmitterName */...) \
   INTERNAL_REACT_MODULE(__VA_ARGS__)(__VA_ARGS__)
 
+// REACT_MODULE_NOREG is REACT_MODULE without auto registration
+// they have the same arguments
+#define REACT_MODULE_NOREG(/* moduleStruct, [opt] moduleName, [opt] eventEmitterName */...) \
+  INTERNAL_REACT_MODULE_NOREG(__VA_ARGS__)(__VA_ARGS__)
+
 // REACT_INIT(method)
 // Arguments:
 // - method (required) - the method name the macro is attached to.

diff --git a/vnext/Microsoft.ReactNative.Cxx/StructInfo.h b/vnext/Microsoft.ReactNative.Cxx/StructInfo.h
@@ -113,12 +113,12 @@ void FieldWriter(IJSValueWriter const &writer, const void *obj, const uintptr_t
 
 template <class T>
 struct StructInfo {
-  static const FieldMap FieldMap;
+  static const FieldMap &GetFieldMap() {
+    static const FieldMap fieldMap = GetStructInfo(static_cast<T *>(nullptr));
+    return fieldMap;
+  }
 };
 
-template <class T>
-/*static*/ const FieldMap StructInfo<T>::FieldMap = GetStructInfo(static_cast<T *>(nullptr));
-
 template <int I>
 using ReactFieldId = std::integral_constant<int, I>;
 

diff --git a/vnext/Microsoft.ReactNative.IntegrationTests/TurboModuleTests.cpp b/vnext/Microsoft.ReactNative.IntegrationTests/TurboModuleTests.cpp
@@ -163,7 +163,7 @@ struct CppTurboModuleSpec : TurboModuleSpec {
   }
 };
 
-REACT_MODULE(CppTurboModule)
+REACT_MODULE_NOREG(CppTurboModule)
 struct CppTurboModule {
   using ModuleSpec = CppTurboModuleSpec;
 
@@ -558,6 +558,18 @@ struct CppTurboModulePackageProvider : winrt::implements<CppTurboModulePackagePr
 } // namespace
 
 TEST_CLASS (TurboModuleTests) {
+  TEST_METHOD(EnsureReactModuleNotAutoRegistered) {
+    bool registered = false;
+    auto current = ModuleRegistration::Head();
+    while (current) {
+      if (wcscmp(current->ModuleName(), L"CppTurboModule") == 0) {
+        registered = true;
+      }
+      current = current->Next();
+    }
+    TestCheck(!registered);
+  }
+
   TEST_METHOD(ExecuteSampleTurboModule) {
     TestEventService::Initialize();