chore(Android): add autolinking on Fabric #1585

kkafar · 2022-09-10T12:29:28Z

Description

This PR integrates the library with Android autolinking mechanism 🥳

Up to this moment, react-native-screens had custom linking mechanism which builded rnscreens_modules & rnscreens_common shared libraries and loaded them during runtime, leveraging JNI's OnLoad method to add our custom component descriptors providers to ComponentDescriptorProviderRegistry instance. Since this PR forward, this custom loading mechanism is no longer needed as it shall be done by RNCLI autolinking.

See my comments below this PR description to see comments on fragile changes.

IMPORTANT: This PR requires @react-native-community/cli 9.1.0 or newer (support for cmakeListsPath in react-native.config.js & Android autolinking). This version is shipped with react-native since 0.70.0 => with merging of this PR we drop support for older react-native versions on Fabric.

See #1595 for additional commentary on important changes & implementation details.

I also recommend to go through discussion under this description to gain better understanding of changes.

Changes

Removed custom extrenalNativeBuild configuration from library's gradle build.
Removed custom loading mechanism that was used to load rnscreen_modules shared library.
Removed code responsible for building rnscreens_modules SO.
Added custom CMake build for react_codegen_rnscreens target (replacement of rnscreen_modules). See (1) below.
Added RNCLI configuration. Note that now all library's component descriptors must be enumerated manually. See (2) below.

(1)

Autolinking expects react_codegen_rnscreens to be the name of the library. The name is autogenerated.

I believe it would be possible to create separate target containing only custom cpp code with adding a line like:

target_link_libraries(${CMAKE_PROJECT_NAME} rnscreens_modules)

in our custom CMakeLists.txt so react_cdegen_rnscreens contains only codegened symbols but I did not test that.

(2)

If component has interfaceOnly codegen config option set to true codegen does not generate part of the required code, including component descriptor (CD). This is the case for ScreenNativeComponent. This leads to its manually created CD not being picked up by autolinking ==> we need to somehow inform RNCLI that this CD exists. This is done by specifying componentDescriptors option in react-native.config.js file. AFAIK it does not allow to extend set of codegen'd CDs, it only allows to overwrite it, hence we need to specify all CDs manually.

Test code and steps to reproduce

Build any of FabricExample applications in the repository (or create fresh React Native app) and see that they work properly

Checklist

Ensured that CI passes

For now it is only partially filtered (there is also code for other components for now). I'm not sure whether I should leave all the codegened code or leave only the RNSScreen part.

As we provide custom implementation

Setting `componentDescriptors` causes RNCLI to not search for autogenerated ones -> we need to specify all of them manually

This CMake builds both custom cpp code & generated one. It seems to me, that it must be done this way as project name recognized by autogenerated RN CLI cmake is `react_codegen_rnscreens` and we can not change that => only this library is included in final build.

IMPORTANT: this causes our custom `rnscreens.h` header to take precedence over its codegened counterpart when imported in following way in `rncli.cpp`: ```c++ ``` This is important beacuse it allows us to inject `RNSScreenComponentDescriptor` symbol into `rncli.cpp` translation unit scope.

We no longer build this target as we want to rely on new Android autolinking.

codegen

libreact_codegen_rnscreens.so library This symbol for some, unknown yet reason, is not visible during linking of lib<project-name>.so (exactly during linking rncli.cpp.o file). We enforce desired visibility with compiler attributte. Note however that this solution should be only temporary as the exact reason should be tracked down and the issue shall be fixed with more generic approach.

This file is not only no longer used, but also it does not contain valid configuration for our library. This file was replaced with common/cpp/CMakeLists.txt as we migrated to CMake build system.

exists

Up to this point, some paths were hardcoded, this is no longer the case.

This is temporary workaround as `rnscreens.{h,cpp}` files are not part of common cpp code - they are android specific I believe. They must be moved to android JNI directory along with CMakeLists.txt

specific directory These files are not shared between iOS & Android platforms.

WoLewicki · 2022-09-16T08:44:07Z

android/src/main/jni/CMakeLists.txt

+set(RNS_COMMON_DIR ${RNS_ANDROID_DIR}/../common/cpp)
+set(RNS_GENERATED_DIR ${RNS_ANDROID_DIR}/build/generated)
+set(RNS_GENERATED_JNI_DIR ${RNS_GENERATED_DIR}/source/codegen/jni)
+set(RNS_GENERATED_REACT_DIR ${RNS_GENERATED_JNI_DIR}/react/renderer/components/rnscreens)


Would it be possible to extract rnscreens to a variable so that library authors could change only that variable for their usecase?

I guess I could do it, but it comes down to simply using find & replace option in code editor. I will, however refine variable names and do some cleanup.

So I went with your suggestion. All it takes now is to change LIB_LITERAL constant. However some further customisation may be required as you noticed in RNSVG (adding custom dependencies etc.)

android/src/main/jni/CMakeLists.txt

common/cpp/react/renderer/components/rnscreens/RNSScreenShadowNode.h

common/cpp/react/renderer/components/rnscreens/RNSScreenComponentDescriptor.h

android/src/main/jni/rnscreens.h

android/src/main/jni/CMakeLists.txt

explicitly This is better as it also handles Windows C++ compilers.

tomekzaw

🚀

WoLewicki

I added some comments. Sorry for late review 😅

WoLewicki · 2022-09-16T14:32:31Z

android/src/main/jni/CMakeLists.txt

+  react_render_mapbuffer
+  rrc_view
+  turbomodulejsijni
+  yoga


Based on the changes needed in rnsvg, maybe it would be good to add a comment that you should add here all libraries that your custom state depend on.

android/src/main/jni/rnscreens.cpp

WoLewicki · 2022-09-16T14:43:30Z

android/src/main/jni/rnscreens.h

+namespace facebook {
+namespace react {
+
+JSI_EXPORT


It would be nice to add information why it is needed at all.

See #1585 (comment)

## Description Update supported React Native version for Fabric in library's main readme. Support for older versions has been dropped as we added autolinking in #1585 (it [requires `@react-native-community/cli` 9.1.0 or newer](https://github.com/react-native-community/cli/releases/tag/v9.1.0) (support for `cmakeListsPath` in config) which is shipped with React Native since 0.70.0) ## Changes Since 3.18.0 Fabric will be supported only with React Native 0.70.0 or newer. ## Test code and steps to reproduce -- ## Checklist - [ ] Ensured that CI passes

## Description Add code comments for few changes introduced in #1585. ## Changes Just few code comments. See the changes. ## Test code and steps to reproduce -- ## Checklist - [x] Ensured that CI passes

## Description The `RNScreensComponentsRegistry` class was used for custom linking (loading of `rnscreen_modules` shared library to java runtime). With merge of #1585 it became redundant. ## Changes Removed unused class & its source file. ## Test code and steps to reproduce Just build the application and see that everything works as usual. ## Checklist - [ ] Ensured that CI passes

## Description Autolinking was added with #1585 and it added `react-native.config.js` file with codegen configuration, **but** it did not add this file to npm include list causing its absence in final released package... Fixes #1608 ## Changes Added `react-native.config.js` to npm file list in main `package.json` ## Test code and steps to reproduce See #1608 for reproductions. ## Checklist - [x] Ensured that CI passes

kkafar added 29 commits September 10, 2022 14:27

chore: update codegen config configuration in main package.json

d5a9109

chore: remove files with custom autolinking C++ code

4f84579

chore: remove custom linking code from gradle build

da0faed

chore: apply recomended directory structure to common cpp code

e177bf4

chore: copy codegened implementation of cpp code for RNSScreen

d3b7f73

For now it is only partially filtered (there is also code for other components for now). I'm not sure whether I should leave all the codegened code or leave only the RNSScreen part.

chore: remove ComponentsDescriptors.h

da63061

As we provide custom implementation

chore: remove ShadowNodes{.cpp,.h} as we provide custom implementation

7963fd0

chore: add JSI_EXPORT macros to shadow node decl

882f032

chore: add module provider cpp code

57f3346

chore: add custom RN CLI config

d54857f

fix: add all components descriptors & specify cmakeListsPath

0ccc2ea

Setting `componentDescriptors` causes RNCLI to not search for autogenerated ones -> we need to specify all of them manually

chore: add some debug statements to custom Cmake

1a00f6a

chore: rename custom file with component descriptors & add there all CDs

e1d5f3e

fix: rename component descriptor file

ba5252b

chore: make main project use custom rnscreens.h file

de99905

chore: remove debug messages from cmakelists.txt

449316f

chore: do not take rnscreens-generated.cpp source file

29bd651

chore: do not manually load rnscreens_modules shared library

81b86ad

We no longer build this target as we want to rely on new Android autolinking.

chore: remove all RNSScreen code that is & can be autogenerated by

4b56ca7

codegen

style: remove codegend comments & format cpp code

b573d77

chore: remove unused common/cpp/Android.mk file

7bd60c4

This file is not only no longer used, but also it does not contain valid configuration for our library. This file was replaced with common/cpp/CMakeLists.txt as we migrated to CMake build system.

chore: update RNCLI configuration as common/cpp/Android.mk no longer

e2a4909

exists

chore: generalise path resolution in CMake

007895b

Up to this point, some paths were hardcoded, this is no longer the case.

fix: iOS build

c94c6e8

This is temporary workaround as `rnscreens.{h,cpp}` files are not part of common cpp code - they are android specific I believe. They must be moved to android JNI directory along with CMakeLists.txt

chore: move Android specific configuration & cpp files to Android

5d4912c

specific directory These files are not shared between iOS & Android platforms.

fix: include path

48630ec

kkafar requested a review from WoLewicki September 15, 2022 15:37

kkafar marked this pull request as ready for review September 15, 2022 17:04

WoLewicki reviewed Sep 16, 2022

View reviewed changes

kkafar requested a review from tomekzaw September 16, 2022 11:43

tomekzaw reviewed Sep 16, 2022

View reviewed changes

kkafar added 6 commits September 16, 2022 14:24

chore: use JSI_EXPORT macro instead of setting compiler attribute

2cfe611

explicitly This is better as it also handles Windows C++ compilers.

style: remove trailing whitespace

8ce7490

fix: add mising dot in glob pattern for cpp sources

0d9f573

style: use uppercase for CMake constants

213e592

chore: parametrize library target name in cmake

9c00515

refact: generalize variable names

3afe846

kkafar force-pushed the @kkafar/fabric-autolinking branch from b241138 to 3afe846 Compare September 16, 2022 13:00

kkafar requested review from tomekzaw and WoLewicki September 16, 2022 13:02

Merge branch 'main' into @kkafar/fabric-autolinking

509f1af

tomekzaw approved these changes Sep 16, 2022

View reviewed changes

kkafar merged commit 5a24879 into main Sep 19, 2022

kkafar deleted the @kkafar/fabric-autolinking branch September 19, 2022 08:39

WoLewicki approved these changes Sep 19, 2022

View reviewed changes

kkafar mentioned this pull request Sep 19, 2022

docs: update supported RN version for Fabric #1594

Merged

1 task

kkafar mentioned this pull request Sep 19, 2022

chore: add code comments for autolinking #1595

Merged

1 task

kkafar mentioned this pull request Sep 23, 2022

chore: remove redundant java class #1599

Merged

1 task

moul-bot mentioned this pull request Oct 5, 2022

fix(deps): bump react-native-screens from 3.9.0 to 3.18.0 in /js berty/berty#4454

Closed

This was referenced Oct 11, 2022

attempt child is not RNScreen type with React Navigation v6.0 #1608

Closed

fix: add react-native.config.js to npm package #1611

Merged

This was referenced Oct 12, 2022

fix(deps): bump react-native-screens from 3.9.0 to 3.18.1 in /js berty/berty#4463

Closed

fix(deps): bump react-native-screens from 3.9.0 to 3.18.2 in /js berty/berty#4467

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(Android): add autolinking on Fabric #1585

chore(Android): add autolinking on Fabric #1585

kkafar commented Sep 10, 2022 •

edited

Loading

WoLewicki Sep 16, 2022

kkafar Sep 16, 2022

kkafar Sep 16, 2022

tomekzaw left a comment

WoLewicki left a comment

WoLewicki Sep 16, 2022

WoLewicki Sep 16, 2022

kkafar Sep 19, 2022

chore(Android): add autolinking on Fabric #1585

chore(Android): add autolinking on Fabric #1585

Conversation

kkafar commented Sep 10, 2022 • edited Loading

Description

Changes

Test code and steps to reproduce

Checklist

WoLewicki Sep 16, 2022

Choose a reason for hiding this comment

kkafar Sep 16, 2022

Choose a reason for hiding this comment

kkafar Sep 16, 2022

Choose a reason for hiding this comment

tomekzaw left a comment

Choose a reason for hiding this comment

WoLewicki left a comment

Choose a reason for hiding this comment

WoLewicki Sep 16, 2022

Choose a reason for hiding this comment

WoLewicki Sep 16, 2022

Choose a reason for hiding this comment

kkafar Sep 19, 2022

Choose a reason for hiding this comment

kkafar commented Sep 10, 2022 •

edited

Loading