Uniffi React Native Integration #401

bjtrounson · 2024-12-23T01:38:29Z

Background

After testing an expo modules approach in this PR #394 . We have found that the work to maintain the record types between the Rust layer and expo modules would be too tendinous. So this PR has an initial implementation of using uniffi-bindgen-react-native to create a similar binding as Android and iOS. One downside of this is we have to implement the views all again just for react-native but this downside is worth it long term definitely since the FerrostarCore-RS is still changing it's model quite frequently.

Implementation overview

Implementation of the core integration is following the current Android implementation quite closely apart from segments where there our missing language features and such. We are using uniffi-bindgen-react-native to create the Rust binding the generated TypeScript types are located in src/generated.

Current status

Please let me know missing implementations that should be on the list and I will update it.

Moved to be separate issues

…n instructions

…ostarCore state to the view

bjtrounson · 2024-12-23T01:43:07Z

~~/react-native/cpp/generated/ and /react-native/src/generated should be ignored from the CI checks other typos need to be fixed~~

Edit: I've added these.

bjtrounson · 2024-12-23T19:15:43Z

Initial version of puck, route and trip progress view.

Screenrecorder-2024-12-24-07-28-28-106.mp4

I have discover one issue and it's that I don't think we can currently override the current location that MapLibre is using within maplibre-react-native. I'm wondering if @KiwiKilian might know of any available solution here or if it's something that's going to need to be exposed on that libraries side.

KiwiKilian · 2024-12-23T22:13:45Z

Just glanced at your recent commits, do I understand correctly:

Ferrostar retrieves the location from MapLibre Native and snaps to the route
You are rendering the UserLocation component from MapLibre React Native
You want the UserLocation component to use the snapped coordinates instead of the actual ones, correct?

Currently there is no clean way to do this.

I'm not sure if we you actually want to override the LocationManager. Users might want to use both locations for some reason? We could just extract a dumb UserLocationPuck component, which you can feed any coordinate?

bjtrounson · 2024-12-23T22:25:05Z

You want the UserLocation component to use the snapped coordinates instead of the actual ones, correct?

Yes we only want to use the snapped location when we are navigating and if our snappedToRoute options is enable in the FerrostarCore, I think the android version does this using a StaticEngine and inserts that into MapLibre @ianthetechie might be able to explain that a bit better. But I don't think that will probably be the best approach here.

I'm not sure if we you actually want to override the LocationManager. Users might want to use both locations for some reason? We could just extract a dumb UserLocationPuck component, which you can feed any coordinate?

I really like this idea and I agree users might want a different functionality here, is this something that could be extracted here or have to be expose on the maplibre-react-native side?

bjtrounson · 2024-12-26T23:04:24Z

MapControl need a bit of work, we need some fonts for the +, -, mute, route and recenter button (I've tried + & - as just normal character but it doesn't look good) will look at extracting some google fonts as I think that's what we are using on Android.

We will also need to sort out the camera state mostly for the route overview and recenter. I don't think we can just apply a the navigation camera again to reset like we do on Android. So will have to look at keeping a camera state some where probably a provider that will get updated via the onUserTrackingModeChange event. Then we can reset the camera state that is looking at the provider, not 100% sure this will reset the pitch and zoom though will need to test this.

bjtrounson · 2025-01-16T09:22:53Z

Okay that should be everything for this. I even added the example app and got that stored.

Feel free to finish the review now @ianthetechie

react-native/android/build.gradle

react-native/CONTRIBUTING.md

react-native/README.md

react-native/LICENSE

react-native/CODE_OF_CONDUCT.md

react-native/src/core/FerrostarCore.ts

react-native/src/core/NavigationUiState.ts

react-native/src/views/TripProgressView.tsx

react-native/src/views/_utils.ts

react-native/src/views/maneuver/_icons.tsx

Co-authored-by: Ian Wagner <[email protected]>

…into react-native

Co-authored-by: Ian Wagner <[email protected]>

KiwiKilian · 2025-01-21T05:12:08Z

react-native/android/build.gradle

+
+    sourceSets {
+      main {
+        manifest.srcFile "src/main/AndroidManifestNew.xml"


This is why you have two AndroidManifests. I think one wants to keep it for better compatibility?

Ah makes sense, I think maybe uniffi-bindgen-react-native generates one and moved the old one not 100% sure.
I've changed that to look at the current.

It also pointed out that I needed to change the package name in the manifest.

I actually think one wants to have two files:

AndroidManifest.xml

It has the package attribute on <manifest> tag

Used automatically, even without reference in build.gradle, when supportsNamespace is false

AndroidManifestNew.xml

Doesn't have the package attribute on <manifest> tag, because the namespace is that withing build.gradle

Is only used when supportsNamespace is true

Everything else is the same in both files

This is the default setup from React Native Builder Bob

Otherwise you will get the following warning:

Setting the namespace via the package attribute in the source AndroidManifest.xml is no longer supported.

It is explained here: callstack/react-native-builder-bob#431

On the other hand, if you only aim for most recent React Native versions support, it might not be necessary? But then the supportsNameSpace check should be removed and the one and only AndroidManifest.xml should not contain a package attribute?

Oh wow this is good to know I'll add those back then.

Ahh, fascinating! Thanks for jumping in on this @KiwiKilian!

…patibility

ianthetechie

Great work; I think just one last question!

ianthetechie · 2025-01-27T16:06:45Z

react-native/android/build.gradle

+
+    sourceSets {
+      main {
+        manifest.srcFile "src/main/AndroidManifestNew.xml"


Ahh, fascinating! Thanks for jumping in on this @KiwiKilian!

react-native/example/README.md

ianthetechie · 2025-01-27T16:15:31Z

react-native/example/android/app/build.gradle

+dependencies {
+    // The version of react-native is set by the React Native Gradle Plugin
+    implementation("com.facebook.react:react-android")
+
+    if (hermesEnabled.toBoolean()) {
+        implementation("com.facebook.react:hermes-android")
+    } else {
+        implementation jscFlavor
+    }
+}


ianthetechie · 2025-01-27T16:45:44Z

react-native/example/ios/FerrostarExampleTests/FerrostarExampleTests.m

+#import <React/RCTRootView.h>
+
+#define TIMEOUT_SECONDS 600
+#define TEXT_TO_LOOK_FOR @"Welcome to React"


Gotcha. Can leave for now and see how things go as we develop a proper onboarding guide for RN.

react-native/android/cpp-adapter.cpp

…rated

…igationUiState correctly

ianthetechie

Thanks! This looks good to merge now 🚀

bjtrounson added 9 commits December 20, 2024 00:41

Initial uniffi setup

b08a438

Initial FerrostarCore and Route Provider implementation

b6f97a3

FerrostarCore mostly done but without the location provider and spoke…

a9fa7d1

…n instructions

Location Provider Implementation

ae1feff

intergration of LocationProvider into FerrostarCore

44f8ad6

Event listener for navigation state so we can since the external Ferr…

6721cec

…ostarCore state to the view

Early NavigationView

621ce74

Working FerrostarCore

f419c1f

Initial views and UI

9e74c58

bjtrounson added 3 commits December 24, 2024 07:59

Working puck and trip progress view with formatters

a551b25

typo fixes

a3ec716

forgot one word in typo check

fa218d4

bjtrounson added 4 commits December 26, 2024 01:17

added icons

56ae448

changed TripProgressView styling

4217567

Added InstructionView

6d99b4c

fix navigation camera to have pitch and zoom

1d1796a

bjtrounson marked this pull request as draft December 26, 2024 03:58

bjtrounson added 4 commits December 26, 2024 21:11

fix icons names

981c007

change some styling in the instruction view

eb250ea

fix the estimatedArrival time

b5ccf0b

Add initial map control till needs onPress handlers

db63261

ianthetechie self-requested a review January 7, 2025 02:07

bjtrounson marked this pull request as ready for review January 7, 2025 02:39

This was referenced Jan 10, 2025

Ferrostar support for Expo Modules & React Native (Android only for now) #394

Closed

Map control for react native #420

Open

bjtrounson added 5 commits January 16, 2025 22:16

fix: handling location edge cases

94d354f

feat: add map control events and state

cb19e4e

chore: remove deprecated setAccessToken from default export

927b614

feat: add more icons and improve icons on other elements

d0112eb

Trying to fix camera issues when route focus

49120af

ianthetechie reviewed Jan 21, 2025

View reviewed changes

bjtrounson and others added 9 commits January 21, 2025 16:15

Update react-native/android/build.gradle

eeabe48

Co-authored-by: Ian Wagner <[email protected]>

chore: delete auto-generated code

fcd3a89

chore: add auto-generated code to .gitignore

2478e2a

chore: update package.json for new license and ts for new imports

442a4a9

Update react-native/src/core/FerrostarCore.ts

008d247

Co-authored-by: Ian Wagner <[email protected]>

changed fastestInterval to 1000 as suggested

2eae9a0

Merge branch 'react-native' of https://github.com/bjtrounson/ferrostar …

227366a

…into react-native

Update react-native/example/ios/FerrostarExample/Info.plist

a973eaa

Co-authored-by: Ian Wagner <[email protected]>

Add JSDoc link to comments since syntax is different to Android

e195139

bjtrounson requested a review from ianthetechie January 21, 2025 04:49

KiwiKilian reviewed Jan 21, 2025

View reviewed changes

bjtrounson and others added 2 commits January 21, 2025 18:17

Changed the AndroidManifest that build.gradle is pointing at

1b2e953

Revert back the AndroidManifestNew.xml since it's used for better com…

1846a91

…patibility

ianthetechie reviewed Jan 27, 2025

View reviewed changes

bjtrounson added 6 commits January 28, 2025 10:35

Update the example README.md with some helpful information

d846537

Add to the .gitignore

8b004e6

added package name to auto-generation and build.gradle

4181e5d

remove CMakeList.txt and AndroidManifest.xml since they are auto-gene…

69addcc

…rated

correct AndroidManifest.xml ignore

f5f2ade

Add TripState extensions as utils functions and apply them to the Nav…

779e3b8

…igationUiState correctly

ianthetechie approved these changes Jan 28, 2025

View reviewed changes

ianthetechie merged commit be820af into stadiamaps:main Jan 28, 2025
14 checks passed

bjtrounson deleted the react-native branch January 28, 2025 03:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uniffi React Native Integration #401

Uniffi React Native Integration #401

bjtrounson commented Dec 23, 2024 •

edited

Loading

bjtrounson commented Dec 23, 2024 •

edited

Loading

bjtrounson commented Dec 23, 2024 •

edited

Loading

KiwiKilian commented Dec 23, 2024

bjtrounson commented Dec 23, 2024 •

edited

Loading

bjtrounson commented Dec 26, 2024

bjtrounson commented Jan 16, 2025

KiwiKilian Jan 21, 2025

bjtrounson Jan 21, 2025

KiwiKilian Jan 21, 2025 •

edited

Loading

KiwiKilian Jan 21, 2025 •

edited

Loading

bjtrounson Jan 21, 2025

ianthetechie Jan 27, 2025

ianthetechie left a comment

ianthetechie Jan 27, 2025

ianthetechie Jan 27, 2025

ianthetechie Jan 27, 2025

ianthetechie left a comment

Uniffi React Native Integration #401

Uniffi React Native Integration #401

Conversation

bjtrounson commented Dec 23, 2024 • edited Loading

Background

Implementation overview

Current status

Moved to be separate issues

bjtrounson commented Dec 23, 2024 • edited Loading

bjtrounson commented Dec 23, 2024 • edited Loading

KiwiKilian commented Dec 23, 2024

bjtrounson commented Dec 23, 2024 • edited Loading

bjtrounson commented Dec 26, 2024

bjtrounson commented Jan 16, 2025

KiwiKilian Jan 21, 2025

Choose a reason for hiding this comment

bjtrounson Jan 21, 2025

Choose a reason for hiding this comment

KiwiKilian Jan 21, 2025 • edited Loading

Choose a reason for hiding this comment

KiwiKilian Jan 21, 2025 • edited Loading

Choose a reason for hiding this comment

bjtrounson Jan 21, 2025

Choose a reason for hiding this comment

ianthetechie Jan 27, 2025

Choose a reason for hiding this comment

ianthetechie left a comment

Choose a reason for hiding this comment

ianthetechie Jan 27, 2025

Choose a reason for hiding this comment

ianthetechie Jan 27, 2025

Choose a reason for hiding this comment

ianthetechie Jan 27, 2025

Choose a reason for hiding this comment

ianthetechie left a comment

Choose a reason for hiding this comment

bjtrounson commented Dec 23, 2024 •

edited

Loading

bjtrounson commented Dec 23, 2024 •

edited

Loading

bjtrounson commented Dec 23, 2024 •

edited

Loading

bjtrounson commented Dec 23, 2024 •

edited

Loading

KiwiKilian Jan 21, 2025 •

edited

Loading

KiwiKilian Jan 21, 2025 •

edited

Loading