-
Notifications
You must be signed in to change notification settings - Fork 27
fix(ios): register RoktEventManager as a TurboModule so events survive bridgeless #376
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
Open
jamesnrokt
wants to merge
1
commit into
main
Choose a base branch
from
fix/rokt-event-manager-turbomodule
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /** | ||
| * The Rokt event emitter is an `RCTEventEmitter`, which conforms only to `RCTBridgeModule`. | ||
| * Bridgeless does not instantiate those unless the host app enabled TurboModule interop, so | ||
| * resolving it purely through `NativeModules` left it undefined and dropped every Rokt event | ||
| * before it reached JS. It is now registered via codegen and must be resolved through the | ||
| * TurboModule registry first, with a `NativeModules` fallback for the old architecture. | ||
| */ | ||
|
|
||
| function loadRoktEventManager( | ||
| turboModule: unknown, | ||
| nativeModules: Record<string, unknown> | ||
| ) { | ||
| jest.resetModules(); | ||
| jest.doMock( | ||
| 'react-native', | ||
| () => ({ | ||
| NativeModules: nativeModules, | ||
| TurboModuleRegistry: { get: jest.fn(() => turboModule) }, | ||
| }), | ||
| { virtual: true } | ||
| ); | ||
| // eslint-disable-next-line @typescript-eslint/no-var-requires | ||
| return require('../rokt/rokt-event-manager').RoktEventManager; | ||
| } | ||
|
|
||
| afterEach(() => { | ||
| jest.resetModules(); | ||
| }); | ||
|
|
||
| describe('RoktEventManager resolution', () => { | ||
| it('resolves through the TurboModule registry when NativeModules has no entry', () => { | ||
| const turboModule = { addListener: jest.fn(), removeListeners: jest.fn() }; | ||
|
|
||
| expect(loadRoktEventManager(turboModule, {})).toBe(turboModule); | ||
| }); | ||
|
|
||
| it('prefers the TurboModule registry over NativeModules', () => { | ||
| const turboModule = { addListener: jest.fn(), removeListeners: jest.fn() }; | ||
| const legacyModule = { addListener: jest.fn() }; | ||
|
|
||
| expect( | ||
| loadRoktEventManager(turboModule, { RoktEventManager: legacyModule }) | ||
| ).toBe(turboModule); | ||
| }); | ||
|
|
||
| it('falls back to NativeModules on the old architecture', () => { | ||
| const legacyModule = { addListener: jest.fn() }; | ||
|
|
||
| expect(loadRoktEventManager(null, { RoktEventManager: legacyModule })).toBe( | ||
| legacyModule | ||
| ); | ||
| }); | ||
|
|
||
| it('is null when neither is available, so NativeEventEmitter is not handed undefined', () => { | ||
| expect(loadRoktEventManager(null, {})).toBeNull(); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import type { TurboModule } from 'react-native'; | ||
| import { TurboModuleRegistry } from 'react-native'; | ||
|
|
||
| /** | ||
| * Event channel for Rokt placement events. | ||
| * | ||
| * The native side is an `RCTEventEmitter`, which only conforms to `RCTBridgeModule`. | ||
| * Under bridgeless that is not enough to be instantiated unless the host app has | ||
| * opted into TurboModule interop, so this spec exists to register the emitter as a | ||
| * TurboModule and keep `RoktEvents` reaching JS in every architecture. | ||
| * | ||
| * iOS only. Android delivers the same events over `RCTDeviceEventEmitter`, so this | ||
| * module is absent there and `TurboModuleRegistry.get` returns null by design. | ||
| */ | ||
| export interface Spec extends TurboModule { | ||
| addListener(eventName: string): void; | ||
| removeListeners(count: number): void; | ||
| } | ||
|
|
||
| export default TurboModuleRegistry.get<Spec>('RoktEventManager'); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import { NativeModules, TurboModuleRegistry } from 'react-native'; | ||
|
|
||
| const ROKT_EVENT_MANAGER_MODULE_NAME = 'RoktEventManager'; | ||
|
|
||
| /** | ||
| * The native emitter that carries `RoktEvents` and `LayoutHeightChanges` to JS. | ||
| * | ||
| * Resolved through the TurboModule registry first: the native class is an | ||
| * `RCTEventEmitter`, and under bridgeless those are only instantiated when the host app | ||
| * has enabled TurboModule interop. Registering it via codegen makes it resolvable either | ||
| * way; without this the module is undefined and every Rokt event is dropped silently. | ||
| * | ||
| * Falls back to `NativeModules` for the old architecture, and is null on Android, where | ||
| * the same events arrive over `RCTDeviceEventEmitter` and `NativeEventEmitter` accepts a | ||
| * null module. | ||
| */ | ||
| export const RoktEventManager = | ||
| TurboModuleRegistry.get(ROKT_EVENT_MANAGER_MODULE_NAME) ?? | ||
| NativeModules[ROKT_EVENT_MANAGER_MODULE_NAME] ?? | ||
| null; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to test this won Android and see it need any other changes.