feat: Expose Rokt launcher config options #1033

alexs-mparticle · 2025-05-20T21:08:47Z

Instructions

PR target branch should be against development
PR title name should follow this format: https://github.com/mParticle/mparticle-workflows/blob/main/.github/workflows/pr-title-check.yml
PR branch prefix should follow this format: https://github.com/mParticle/mparticle-workflows/blob/main/.github/workflows/pr-branch-check-name.yml

Summary

Exposes Rokt integration launcher config options. This will act as a pass-through for the Kit SDK to pass configuration options to the Rokt Web SDK.

Testing Plan

Was this tested locally? If not, explain why.
Using a sample app, pass in various rokt configuration options to window.mParticle.config and verify that they appear in the Rokt Web SDK selectPlacements call.

Reference Issue (For mParticle employees only. Ignore if you are an outside contributor)

Closes https://go.mparticle.com/work/SQDSDKS-7318

Copilot

Pull Request Overview

This PR adds support for passing Rokt Web SDK launcher options through the Kit SDK, alongside existing sandbox settings.

Introduces a nested IRoktOptions type to bundle managerOptions (sandbox) and new launcherOptions.
Updates RoktManager to store and expose launcherOptions during initialization.
Expands test coverage for both provided and omitted launcher options in roktManager.spec.ts.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
test/jest/roktManager.spec.ts	Updated tests to wrap sandbox under `managerOptions` and added cases for `launcherOptions`.
src/sdkRuntimeModels.ts	Exposed `launcherOptions` in `SDKInitConfig` for consumer configuration.
src/roktManager.ts	Added `IRoktOptions` with `launcherOptions`, updated init logic and interfaces.

Comments suppressed due to low confidence (2)

test/jest/roktManager.spec.ts:250

[nitpick] The test description says 'empty launcher options' but asserts undefined; consider updating the wording to 'undefined launcher options' for clarity.

it('should initialize the manager with empty launcher options when not provided', () => {

src/roktManager.ts:53

[nitpick] The launcherOptions property on IRoktKit is only used internally by RoktManager; consider removing it from the public IRoktKit interface to avoid confusion.

launcherOptions?: Dictionary<any>;

src/roktManager.ts

src/mp-instance.ts

test/jest/roktManager.spec.ts

rmi22186 · 2025-05-29T02:51:59Z

test/jest/roktManager.spec.ts

+                {
+                    managerOptions: { sandbox: true },
+                }


Is there a test from the past that shows if sandbox is passed into the selectPlacements call that it will override MP's isDevelopmentMode boolean?

Not really. We treat both createLauncher and selectPlacements sandbox flags as pass throughs.

rmi22186

This looks good, just minor comments

Copilot

Pull Request Overview

This PR exposes Rokt launcher configuration options so that the Kit SDK can pass these options through to the Rokt Web SDK. Key changes include:

Updating tests in both identity and RoktManager suites to validate new configuration and behavior.
Adjusting SDK and Manager interfaces and initialization parameters to support launcherOptions.
Modifying mp-instance and identity logic to integrate with the updated RoktManager API.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
test/src/tests-identity.ts	Added tests for Rokt Manager behavior and new identify helper functions.
test/jest/roktManager.spec.ts	Updated tests to verify proper initialization of launcher and manager options.
src/sdkRuntimeModels.ts	Updated SDKInitConfig to include launcherOptions.
src/roktManager.ts	Updated options handling to use the new IRoktOptions structure and store launcherOptions.
src/mp-instance.ts	Modified RoktManager initialization to pass managerOptions and launcherOptions.
src/identity.js	Added a check to update currentUser from Identity when the RoktManager is ready.

test/src/tests-identity.ts

src/identity.js

test/src/tests-identity.ts

rmi22186 · 2025-05-30T04:46:58Z

src/identity.js

@@ -1677,6 +1677,10 @@ export default function Identity(mpInstance) {
        }
        mpInstance._Store.isInitialized = true;

+        if (mpInstance._RoktManager.isReady()) {


So if it's not ready yet because identity returns faster than rokt manager gets initialized, this means there still won't be a current user right/. Is there a way to queue setting the current user for when it is ready?

Actually is more of a check to see if the Rokt Kit is being used at all. We could potentially create a new method called isConfigured or isActive, but I felt like that might be unnecessary.

ah got it. yea seems like it's more readable/grokable if you go with an approach like isActive. I think you can make it a tech debt ticket.

src/roktManager.ts

test/src/tests-identity.ts

rmi22186 · 2025-05-30T04:55:59Z

Food for thought - If we are passing sandbox to createLauncher now, is there a reason to include it in the selectPlacements call?

Co-authored-by: Robert Ing <[email protected]>

Copilot

Pull Request Overview

This PR exposes configuration options for Rokt's launcher, enabling the Kit SDK to pass these options to the Rokt Web SDK. Key changes include:

Extending the SDK's configuration by introducing a new "launcherOptions" parameter.
Adding tests to validate the behavior of Rokt Manager with respect to user identity and launcher options.
Updating various modules (including sdkRuntimeModels, mp-instance, and identity) to properly propagate and utilize the new configuration options.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
test/src/tests-identity.ts	Added tests for validating the behavior when a user’s email is identified and when identity calls fail.
test/jest/roktManager.spec.ts	Updated tests to verify initialization of launcher options and sandbox mode.
src/sdkRuntimeModels.ts	Added a new optional launcherOptions field to the SDK initialization configuration.
src/roktManager.ts	Refactored the RoktManager initialization to support new launcherOptions and managerOptions.
src/mp-instance.ts	Updated initialization logic to pass new Rokt options to RoktManager.
src/identity.js	Modified identity flow to set currentUser in RoktManager when ready.

src/roktManager.ts

sonarqubecloud · 2025-05-30T17:40:29Z

Quality Gate failed

Failed conditions
3.2% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

rmi22186

~~My previous comment was actually that I didn't think we needed RoktManager.sandbox at all because we aren't using it anywhere, right? What is its current purpose?~~

Ignore me!

# [2.41.0](v2.40.0...v2.41.0) (2025-06-02) ### Bug Fixes * Initialize Rokt before processing forwarders ([#1034](#1034)) ([cf09cd0](cf09cd0)) ### Features * Expose Rokt launcher config options ([#1033](#1033)) ([c2d25af](c2d25af))

mparticle-automation · 2025-06-02T14:28:02Z

🎉 This PR is included in version 2.41.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

alexs-mparticle mentioned this pull request May 20, 2025

feat: Expose Rokt launcher config options mparticle-integrations/mparticle-javascript-integration-rokt#30

Merged

alexs-mparticle requested a review from Copilot May 20, 2025 21:09

Copilot AI reviewed May 20, 2025

View reviewed changes

src/roktManager.ts Outdated Show resolved Hide resolved

alexs-mparticle requested a review from rmi22186 May 21, 2025 17:31

alexs-mparticle marked this pull request as ready for review May 21, 2025 17:31

alexs-mparticle requested review from BrandonStalnaker and Mansi-mParticle May 21, 2025 17:31

rmi22186 reviewed May 27, 2025

View reviewed changes

src/roktManager.ts Show resolved Hide resolved

alexs-mparticle force-pushed the feat/SQDSDKS-7318-rokt-launcher-config branch from 8e5e823 to 31367de Compare May 27, 2025 14:44

rmi22186 reviewed May 27, 2025

View reviewed changes

src/mp-instance.ts Show resolved Hide resolved

rmi22186 reviewed May 27, 2025

View reviewed changes

test/jest/roktManager.spec.ts Show resolved Hide resolved

rmi22186 reviewed May 29, 2025

View reviewed changes

alexs-mparticle added 6 commits May 29, 2025 17:23

feat: Expose Rokt launcher config options

e021cb8

Revise launcher options passthrough

a997faf

Address PR Comments

be68d8b

Fix failing tests

4a13aab

Add tests for identity in Rokt Manager

9616f4c

Remove .only

c411fa7

alexs-mparticle force-pushed the feat/SQDSDKS-7318-rokt-launcher-config branch from 957f614 to c411fa7 Compare May 29, 2025 21:26

Update tests

233b492

alexs-mparticle requested review from Copilot and rmi22186 May 29, 2025 21:32

Copilot AI reviewed May 29, 2025

View reviewed changes

test/src/tests-identity.ts Show resolved Hide resolved

src/identity.js Show resolved Hide resolved

alexs-mparticle commented May 29, 2025

View reviewed changes

test/src/tests-identity.ts Outdated Show resolved Hide resolved

alexs-mparticle and others added 2 commits May 29, 2025 17:51

Update test/src/tests-identity.ts

fea9947

Clean up code

561154f

rmi22186 requested changes May 30, 2025

View reviewed changes

Clean up code

cff24b0

alexs-mparticle and others added 2 commits May 30, 2025 11:12

Apply suggestions from code review

236e66b

Co-authored-by: Robert Ing <[email protected]>

Clean up comment

2b418c2

alexs-mparticle requested review from rmi22186 and Copilot May 30, 2025 15:22

Copilot AI reviewed May 30, 2025

View reviewed changes

src/roktManager.ts Show resolved Hide resolved

src/roktManager.ts Show resolved Hide resolved

Decouple placement sandbox option from global options

08d5398

rmi22186 requested changes May 30, 2025

View reviewed changes

rmi22186 approved these changes May 30, 2025

View reviewed changes

alexs-mparticle merged commit c2d25af into development Jun 2, 2025
32 of 36 checks passed

mparticle-automation added the released label Jun 2, 2025

feat: Expose Rokt launcher config options #1033

feat: Expose Rokt launcher config options #1033

Uh oh!

Conversation

alexs-mparticle commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Instructions

Summary

Testing Plan

Reference Issue (For mParticle employees only. Ignore if you are an outside contributor)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rmi22186 May 29, 2025

Choose a reason for hiding this comment

Uh oh!

alexs-mparticle May 29, 2025

Choose a reason for hiding this comment

Uh oh!

rmi22186 left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rmi22186 May 30, 2025

Choose a reason for hiding this comment

Uh oh!

alexs-mparticle May 30, 2025

Choose a reason for hiding this comment

Uh oh!

rmi22186 May 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rmi22186 commented May 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented May 30, 2025

Quality Gate failed

Uh oh!

rmi22186 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mparticle-automation commented Jun 2, 2025

Uh oh!

Uh oh!

alexs-mparticle commented May 20, 2025 •

edited

Loading

rmi22186 left a comment •

edited

Loading