[MOB-12268] Add click handling and tracking #747

lposen · 2025-10-13T21:30:39Z

🔹 JIRA Ticket(s) if any

MOB-12268

✏️ Description

Add click handling and tracking

Testing

cd into the example dir and run:

yarn install
watchman watch-del-all
yarn start --reset-cache

In a separate terminal, cd into example then either run yarn android
Click on the "Embedded" tab.
Click "Get messages"
In the messages, click "Handle click"
If the link is an action, it should alert. If the link is a link, it should navigate to that link.

…ages

github-actions · 2025-10-13T21:32:11Z

Lines	Statements	Branches	Functions
	62.72% (392/625)	38.64% (97/251)	61.5% (139/226)

qltysh · 2025-10-13T21:33:08Z

All good ✅

src/core/utils/getActionPrefix.ts

src/embedded/classes/IterableEmbeddedManager.ts

…nd-pause-impressio'

qltysh · 2025-11-19T08:07:30Z

Coverage Impact

⬆️ Merging this pull request will increase total coverage on loren/embedded/master by 2.12%.

Modified Files with Diff Coverage (5)

File	% Diff	Uncovered Line #s
src/core/classes/IterableApi.ts	100.0%
src/embedded/classes/IterableEmbeddedManager.ts	100.0%
src/core/classes/Iterable.ts	83.3%	988
src/core/utils/callUrlHandler.ts	83.3%	28
src/core/utils/getActionPrefix.ts	100.0%
Total	95.3%

🤖 Increase coverage with AI coding...

In the `loren/embedded/MOB-12268-android-add-click-handling-and-track` branch, add test coverage for this new code:

- `src/core/classes/Iterable.ts` -- Line 988
- `src/core/utils/callUrlHandler.ts` -- Line 28

🚦 See full report on Qlty Cloud »

🛟 Help

Diff Coverage: Coverage for added or modified lines of code (excludes deleted files). Learn more.
Total Coverage: Coverage for the whole repository, calculated as the sum of all File Coverage. Learn more.
File Coverage: Covered Lines divided by Covered Lines plus Missed Lines. (Excludes non-executable lines including blank lines and comments.)
- Indirect Changes: Changes to File Coverage for files that were not modified in this PR. Learn more.

src/core/utils/getActionPrefix.ts

src/embedded/classes/IterableEmbeddedManager.ts

src/core/utils/callUrlHandler.ts

src/core/utils/getActionPrefix.ts

src/embedded/classes/IterableEmbeddedManager.ts

src/core/utils/callUrlHandler.ts

src/core/utils/getActionPrefix.ts

src/embedded/classes/IterableEmbeddedManager.ts

Copilot

Pull Request Overview

This PR adds click handling and tracking functionality for embedded messages in the Iterable React Native SDK. It implements methods to track clicks on embedded messages and handle associated actions through configured handlers.

Adds trackClick and handleClick methods to IterableEmbeddedManager for tracking and handling clicks on embedded messages
Creates utility functions (getActionPrefix, callUrlHandler) to support URL and custom action handling
Extends native Android implementation to support embedded click tracking via both old and new architecture modules

Reviewed Changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/embedded/classes/IterableEmbeddedManager.ts	Adds `trackClick` and `handleClick` methods with constructor changes to accept config
src/embedded/classes/IterableEmbeddedManager.test.ts	Updates test initialization to pass required `IterableConfig` parameter
src/core/utils/index.ts	Exports new utility functions for action prefix detection and URL handling
src/core/utils/getActionPrefix.ts	New utility to detect custom action prefixes (action://, itbl://)
src/core/utils/callUrlHandler.ts	New utility to handle URL opening with fallback logic
src/core/enums/index.ts	Exports new `IterableCustomActionPrefix` enum
src/core/enums/IterableCustomActionPrefix.ts	Defines custom action URL prefixes
src/core/enums/IterableActionSource.ts	Adds `embedded` as new action source enum value
src/core/classes/IterableApi.ts	Adds `trackEmbeddedClick` method to bridge TypeScript to native
src/core/classes/Iterable.ts	Refactors to use extracted `callUrlHandler` utility and updates embedded manager initialization
src/api/NativeRNIterableAPI.ts	Adds `trackEmbeddedClick` method to native module interface
example/src/components/Embedded/Embedded.tsx	Adds UI controls and handlers to demonstrate click tracking functionality
android/src/oldarch/java/com/RNIterableAPIModule.java	Implements `trackEmbeddedClick` method for old architecture
android/src/newarch/java/com/RNIterableAPIModule.java	Implements `trackEmbeddedClick` method for new architecture
android/src/main/java/com/iterable/reactnative/Serialization.java	Adds conversion method from ReadableMap to IterableEmbeddedMessage
android/src/main/java/com/iterable/reactnative/RNIterableAPIModuleImpl.java	Implements core logic for tracking embedded clicks

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-19T09:15:00Z

src/core/enums/IterableCustomActionPrefix.ts

@@ -0,0 +1,9 @@
+/**
+ * Enum representing the prefix of build-in custom action URL.


Typo in documentation: "build-in" should be "built-in".

Suggested change

* Enum representing the prefix of build-in custom action URL.

* Enum representing the prefix of built-in custom action URL.

Copilot · 2025-11-19T09:15:01Z

src/api/NativeRNIterableAPI.ts

+  trackEmbeddedClick(
+    message: EmbeddedMessage,
+    buttonId: string | null,
+    clickedUrl: string | null
+  ): void;


The Android native implementation adds the trackEmbeddedClick method, but there's no corresponding iOS implementation visible in this PR. This will cause the feature to not work on iOS devices. Ensure that the iOS native module also implements this method, or document that this feature is Android-only if that's intentional.

Copilot · 2025-11-19T09:15:01Z

src/embedded/classes/IterableEmbeddedManager.ts

+   * Handles a click on an embedded message.
+   *
+   * This will fire the correct handlers set in the config, and will track the
+   * click.  It should be use on either a button click or a click on the message itself.


Typo in documentation: "use" should be "used".

Suggested change

* click. It should be use on either a button click or a click on the message itself.

* click. It should be used on either a button click or a click on the message itself.

Copilot · 2025-11-19T09:15:01Z

src/embedded/classes/IterableEmbeddedManager.ts

+   * click.  It should be use on either a button click or a click on the message itself.
+   *
+   * @param message - The embedded message.
+   * @param buttonId - The button ID.
+   * @param clickedUrl - The clicked URL.
+   *
+   * @example
+   * ```typescript
+   * Iterable.embeddedManager.handleClick(message, buttonId, clickedUrl);


Incorrect parameter documented in JSDoc. The third parameter is named action but the documentation refers to it as clickedUrl.

Suggested change

* click. It should be use on either a button click or a click on the message itself.

*

* @param message - The embedded message.

* @param buttonId - The button ID.

* @param clickedUrl - The clicked URL.

*

* @example

* ```typescript

* Iterable.embeddedManager.handleClick(message, buttonId, clickedUrl);

* click. It should be used on either a button click or a click on the message itself.

*

* @param message - The embedded message.

* @param buttonId - The button ID.

* @param action - The action to handle (typically an IterableAction instance or null).

*

* @example

* ```typescript

* Iterable.embeddedManager.handleClick(message, buttonId, action);

Copilot · 2025-11-19T09:15:02Z

src/embedded/classes/IterableEmbeddedManager.ts

+  /**
+   * The config for the Iterable SDK.
+   */
+  private _config: IterableConfig = new IterableConfig();


This write to property '_config' is useless, since another property write always overrides it.

Suggested change

private _config: IterableConfig = new IterableConfig();

private _config: IterableConfig;

This probably is a good suggestion. It can be null

…nd-pause-impressio' into loren/embedded/MOB-12268-android-add-click-handling-and-track

src/core/utils/callUrlHandler.ts

src/core/utils/getActionPrefix.ts

src/embedded/classes/IterableEmbeddedManager.ts

…bedded messages

Ayyanchira

Overall looking great! Bug bash will give us the confidence we need

Ayyanchira · 2025-12-24T02:15:08Z

android/src/main/java/com/iterable/reactnative/Serialization.java

+     * This is needed as in new arch you can only pass in basic types, which
+     * then need to be converted in the native layer.
+     */
+    static IterableEmbeddedMessage embeddedMessageFromReadableMap(ReadableMap messageMap) {


annotation like @nullable here will future proof for kotlin conversion if it ever happens and also for test frameworks

Ayyanchira · 2025-12-24T02:21:38Z

src/core/enums/index.ts

 export * from './IterableLogLevel';
 export * from './IterablePushPlatform';
 export * from './IterableRetryBackoff';
+export * from './IterableCustomActionPrefix';


Not sure about the custom prefix idea. Can DM you regarding this for clarification

Ayyanchira · 2025-12-24T02:22:37Z

src/core/utils/callUrlHandler.ts

+  context: IterableActionContext
+) {
+  if (!config.urlHandler?.(url, context)) {
+    Linking.canOpenURL(url)


This needs to be tested thoroughly to see its behavior.

Ayyanchira · 2025-12-24T02:24:46Z

src/embedded/classes/IterableEmbeddedManager.ts

+  /**
+   * The config for the Iterable SDK.
+   */
+  private _config: IterableConfig = new IterableConfig();


This probably is a good suggestion. It can be null

lposen added 2 commits October 13, 2025 13:39

feat: add trackEmbeddedClick method to handle clicks on embedded mess…

00506f0

…ages

feat: implement handleClick method in IterableEmbeddedManager

45ef4eb

qltysh bot reviewed Oct 13, 2025

View reviewed changes

src/core/utils/getActionPrefix.ts Show resolved Hide resolved

src/embedded/classes/IterableEmbeddedManager.ts Show resolved Hide resolved

lposen changed the title ~~feat: add trackEmbeddedClick method to handle clicks on embedded mess…~~ [MOB-12268] Add click handling and tracking Oct 13, 2025

lposen added the embedded Issues/PRs related to Embedded Messages label Oct 14, 2025

lposen mentioned this pull request Oct 14, 2025

[MOB-7052] Embedded messaging feature #751

Open

Merge branch 'loren/embedded/MOB-12267-android-add-start-impression-a…

9d60963

…nd-pause-impressio'

qltysh bot reviewed Nov 19, 2025

View reviewed changes

src/core/utils/getActionPrefix.ts Show resolved Hide resolved

src/embedded/classes/IterableEmbeddedManager.ts Show resolved Hide resolved

lposen added 2 commits November 19, 2025 01:00

refactor: rnew IterableEmbeddedManager instantiation in Iterable class

5c2bc6d

fix: improve URL handling and logging in callUrlHandler;

974e9b2

qltysh bot reviewed Nov 19, 2025

View reviewed changes

src/core/utils/callUrlHandler.ts Show resolved Hide resolved

src/core/utils/getActionPrefix.ts Show resolved Hide resolved

src/embedded/classes/IterableEmbeddedManager.ts Show resolved Hide resolved

qltysh bot reviewed Nov 19, 2025

View reviewed changes

src/core/utils/callUrlHandler.ts Show resolved Hide resolved

src/core/utils/getActionPrefix.ts Show resolved Hide resolved

src/embedded/classes/IterableEmbeddedManager.ts Show resolved Hide resolved

lposen requested a review from Copilot November 19, 2025 09:09

lposen marked this pull request as ready for review November 19, 2025 09:09

Copilot started reviewing on behalf of lposen November 19, 2025 09:09 View session

Copilot finished reviewing on behalf of lposen November 19, 2025 09:13

Copilot AI reviewed Nov 19, 2025

View reviewed changes

Merge branch 'loren/embedded/MOB-12267-android-add-start-impression-a…

40f496f

…nd-pause-impressio' into loren/embedded/MOB-12268-android-add-click-handling-and-track

qltysh bot reviewed Dec 11, 2025

View reviewed changes

src/core/utils/callUrlHandler.ts Show resolved Hide resolved

src/core/utils/getActionPrefix.ts Show resolved Hide resolved

src/embedded/classes/IterableEmbeddedManager.ts Show resolved Hide resolved

lposen added 2 commits December 23, 2025 17:05

test: implement click handling and tracking for embedded messages

6c418c3

test: add trackEmbeddedClick method and enhance click handling for em…

ecb2204

…bedded messages

Ayyanchira approved these changes Dec 24, 2025

View reviewed changes

Base automatically changed from loren/embedded/MOB-12267-android-add-start-impression-and-pause-impressio to loren/embedded/master December 24, 2025 19:38

lposen merged commit 64ebe17 into loren/embedded/master Dec 24, 2025
4 of 5 checks passed

lposen deleted the loren/embedded/MOB-12268-android-add-click-handling-and-track branch December 24, 2025 19:39

		@@ -0,0 +1,9 @@
		/**
		* Enum representing the prefix of build-in custom action URL.

	* Enum representing the prefix of build-in custom action URL.
	* Enum representing the prefix of built-in custom action URL.

	* click. It should be use on either a button click or a click on the message itself.
	* click. It should be used on either a button click or a click on the message itself.

	private _config: IterableConfig = new IterableConfig();
	private _config: IterableConfig;

[MOB-12268] Add click handling and tracking #747

[MOB-12268] Add click handling and tracking #747

Uh oh!

Conversation

lposen commented Oct 13, 2025 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔹 JIRA Ticket(s) if any

✏️ Description

Testing

Uh oh!

github-actions bot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

qltysh bot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

qltysh bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Ayyanchira Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Ayyanchira left a comment

Choose a reason for hiding this comment

Uh oh!

Ayyanchira Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

Ayyanchira Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

Ayyanchira Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

Ayyanchira Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lposen commented Oct 13, 2025 •

edited by atlassian bot

Loading

github-actions bot commented Oct 13, 2025 •

edited

Loading

qltysh bot commented Oct 13, 2025 •

edited

Loading

qltysh bot commented Nov 19, 2025 •

edited

Loading