Skip to content

Adding Discord-only TurboModule support #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 8, 2023

Conversation

Flewp
Copy link

@Flewp Flewp commented Feb 8, 2023

In This PR..

Adding Support for building only Discord TurboModules.

How It's Done

We accomplish in two parts (TL;DRs in bold)

  1. Adding an option in ReactPlugin.kt to codegen only modules with a package name starting with com.discord. Codegen is the "third pillar" of "The New Architecture". It allows us to define the schema of what's communicated through the JSI, and have the Makefiles/Java/etc. generated for us, to the point where all we need to do is include and implement their generated interface on the native side, and call the generated interface from the JS side. The vanilla way to codegen is by running the generateCodegenArtifactsFromSchema gradle task with newArchEnabled=true, normally this task is added as part of the build when newArchEnabled=true, so it's not normally run standalone, though it can be. This task is problematic because some of our third party dependencies, like react-native-reanimated or react-native-gesture-handler have codegen support, and this task will codegen every module that has codegen support. If we run codegen, then run a build with newArchEnabled=false, it creates build issues with these third party dependencies because their generated schemas share the same class name as their legacy-module-schema equivalents, thus we get class name duplicate errors. The fix for this is to add in a new project level gradle option: onlyDiscordTurboModulesEnabled. This creates an extra condition during the codegen process to only codegen modules that begin with com.discord, we can then run (at the react-native/ReactAndroid level)
ORG_GRADLE_PROJECT_newArchEnabled=true ORG_GRADLE_PROJECT_onlyDiscordTurboModulesEnabled=true ./gradlew generateCodegenArtifactsFromSchema

This runs the task with both newArchEnabled and onlyDiscordTurboModulesEnabled set to true, codegen-ing only Discord TurboModules.

  1. Adding extra options to the generated CMakeLists.txt to support libraries/headers needed to compile generated code with the JSI. The JSI (javascript interface) is React Native's "new way" of communicating between javascript and native code synchronously, it's written in C++. The JSI is the alternative method of the "old way" of communicating between JS/native, via the JSON bridge asynchronously. When a module is codegen'd, it generates a CMakeLists.txt describing how to compile the generated .h and .cpp files, which are the JSI layer of the TurboModule. In order to compile against the JSI layer, we need a handful of libraries (*.so) and their associated headers. These resources are assumed to be available, but they aren't when compiling with newArchEnabled=false. These new options allow us to pass in a couple extra CMake options: PREBUILT_CMAKE, which is a .cmake file that includes library definitions for the needed JSI *.sos. EXTRA_INCLUDE_DIRECTORIES, which allows us to define an extra set of header directories, so the compiled source knows where <fbjni/fbjni.h> and all of the other includes are.

Assumptions

For the moment, we must build React Native from source if we're building out these Discord-only-TurboModules. We can fix this in the future, but there's two versions of react-native-codegen in this repository. One in packages/ for when building React Native from source, and one provided via yarn, which'll eventually end up in node_modules, for when providing a pre-built React Native artifact. This PR only includes the impl for the build-from-source approach while we stand up the initial Discord TurboModules. A future PR will provide the impl for the prebuilt approach.

@Flewp Flewp requested a review from seato February 8, 2023 17:09
@Flewp Flewp force-pushed the flewp/turbomodule-support branch from 81e5d11 to 648b4d5 Compare February 8, 2023 17:11
@Flewp Flewp merged commit fb12cf3 into 0.70.6-discord-1 Feb 8, 2023
hannomargelo pushed a commit that referenced this pull request May 20, 2025
…tion for existing view (facebook#51294)

Summary:
Pull Request resolved: facebook#51294

changelog: [internal]

Fix a crash where a node that is supposed to be culled doesn't get visited because culling context is not updated.
The differentiator would generate a create instruction for a view that already exists.

Stack trace for the crash:
```
* thread #1, queue = 'com.apple.main-thread', stop reason = signal SIGABRT
  * frame #0: 0x0000000111740874 libsystem_kernel.dylib`__pthread_kill + 8
    frame #1: 0x00000001117aa2ec libsystem_pthread.dylib`pthread_kill + 264
    frame #2: 0x0000000180171ea8 libsystem_c.dylib`abort + 100
    frame #3: 0x00000001802b0144 libc++abi.dylib`abort_message + 128
    frame #4: 0x000000018029fe4c libc++abi.dylib`demangling_terminate_handler() + 296
    frame #5: 0x000000018006f220 libobjc.A.dylib`_objc_terminate() + 124
    frame #6: 0x00000001375d1964 INFRAFramework`meta_terminate() + 5468
    frame #7: 0x00000001802af570 libc++abi.dylib`std::__terminate(void (*)()) + 12
    frame #8: 0x00000001802b2498 libc++abi.dylib`__cxxabiv1::failed_throw(__cxxabiv1::__cxa_exception*) + 32
    frame #9: 0x00000001802b2478 libc++abi.dylib`__cxa_throw + 88
    frame #10: 0x0000000180093904 libobjc.A.dylib`objc_exception_throw + 384
    frame #11: 0x0000000180e6999c Foundation`-[NSAssertionHandler handleFailureInFunction:file:lineNumber:description:] + 268
    frame #12: 0x000000031a3bcfc8 XPLAT_6_Framework`-[RCTComponentViewRegistry dequeueComponentViewWithComponentHandle:tag:] + 528
    frame #13: 0x000000031a3ccdec XPLAT_6_Framework`RCTPerformMountInstructions(std::__1::vector<facebook::react::ShadowViewMutation, std::__1::allocator<facebook::react::ShadowViewMutation>> const&, RCTComponentViewRegistry*, RCTMountingTransactionObserverCoordinator&, int) + 356
    frame #14: 0x000000031a3ccc7c XPLAT_6_Framework`-[RCTMountingManager performTransaction:]::$_1::operator()(facebook::react::MountingTransaction const&, facebook::react::SurfaceTelemetry const&) const + 80
    frame #15: 0x000000031a3ccc20 XPLAT_6_Framework`decltype(std::declval<-[RCTMountingManager performTransaction:]::$_1&>()(std::declval<facebook::react::MountingTransaction const&>(), std::declval<facebook::react::SurfaceTelemetry const&>())) std::__1::__invoke[abi:ne190102]<-[RCTMountingManager performTransaction:]::$_1&, facebook::react::MountingTransaction const&, facebook::react::SurfaceTelemetry const&>(-[RCTMountingManager performTransaction:]::$_1&, facebook::react::MountingTransaction const&, facebook::react::SurfaceTelemetry const&) + 40
    frame #16: 0x000000031a3ccbc8 XPLAT_6_Framework`void std::__1::__invoke_void_return_wrapper<void, true>::__call[abi:ne190102]<-[RCTMountingManager performTransaction:]::$_1&, facebook::react::MountingTransaction const&, facebook::react::SurfaceTelemetry const&>(-[RCTMountingManager performTransaction:]::$_1&, facebook::react::MountingTransaction const&, facebook::react::SurfaceTelemetry const&) + 40
    frame #17: 0x000000031a3ccb94 XPLAT_6_Framework`std::__1::__function::__alloc_func<-[RCTMountingManager performTransaction:]::$_1, std::__1::allocator<-[RCTMountingManager performTransaction:]::$_1>, void (facebook::react::MountingTransaction const&, facebook::react::SurfaceTelemetry const&)>::operator()[abi:ne190102](facebook::react::MountingTransaction const&, facebook::react::SurfaceTelemetry const&) + 44
    frame #18: 0x000000031a3cba1c XPLAT_6_Framework`std::__1::__function::__func<-[RCTMountingManager performTransaction:]::$_1, std::__1::allocator<-[RCTMountingManager performTransaction:]::$_1>, void (facebook::react::MountingTransaction const&, facebook::react::SurfaceTelemetry const&)>::operator()(facebook::react::MountingTransaction const&, facebook::react::SurfaceTelemetry const&) + 44
    frame #20: 0x000000032f219804 XPLAT_1_Framework`std::__1::function<void (facebook::react::MountingTransaction const&, facebook::react::SurfaceTelemetry const&)>::operator()(this=0x000000016d4f0c78, __arg=0x000000016d4f0a10, __arg=0x000000016d4f0978) const at function.h:989:10
    frame #21: 0x000000032f219668 XPLAT_1_Framework`facebook::react::TelemetryController::pullTransaction(this=0x00000003f4680f00, willMount=0x000000016d4f0c98, doMount=0x000000016d4f0c78, didMount=0x000000016d4f0c58) const at TelemetryController.cpp:39:3
    frame #22: 0x000000031a3c5b28 XPLAT_6_Framework`-[RCTMountingManager performTransaction:] + 544
    frame #23: 0x000000031a3c5864 XPLAT_6_Framework`-[RCTMountingManager initiateTransaction:] + 456
    frame #24: 0x000000031a3c5240 XPLAT_6_Framework`__42-[RCTMountingManager scheduleTransaction:]_block_invoke + 308
    frame #25: 0x0000000131f81b84 BOTTOMFramework`__RCTExecuteOnMainQueue_block_invoke + 40
    frame #26: 0x000000018017c788 libdispatch.dylib`_dispatch_call_block_and_release + 24
    frame #27: 0x0000000180197278 libdispatch.dylib`_dispatch_client_callout + 12
    frame #28: 0x00000001801b2fcc libdispatch.dylib`_dispatch_main_queue_drain.cold.7 + 24
    frame #29: 0x000000018018c1c4 libdispatch.dylib`_dispatch_main_queue_drain + 1184
    frame #30: 0x000000018018bd14 libdispatch.dylib`_dispatch_main_queue_callback_4CF + 40
    frame #31: 0x0000000180427fec CoreFoundation`__CFRUNLOOP_IS_SERVICING_THE_MAIN_DISPATCH_QUEUE__ + 12
    frame #32: 0x00000001804229f8 CoreFoundation`__CFRunLoopRun + 1920
    frame #33: 0x0000000180421e3c CoreFoundation`CFRunLoopRunSpecific + 536
    frame #34: 0x0000000190f62d00 GraphicsServices`GSEventRunModal + 164
    frame #35: 0x0000000185bcec98 UIKitCore`-[UIApplication _run] + 796
    frame #36: 0x0000000185bd3064 UIKitCore`UIApplicationMain + 124
    frame #37: 0x0000000115fbf0bc PRODUCTFramework`main + 200
    frame #38: 0x00000001114293d8 dyld_sim`start_sim + 20
    frame #39: 0x0000000111506b4c dyld`start + 6000
```

Reviewed By: rubennorte

Differential Revision: D74654157

fbshipit-source-id: 9181bcd28524c71d0ca4620bd630dc0baa172386
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant