feat: add use method for rokt kit by jaissica12 · Pull Request #1067 · mParticle/mparticle-web-sdk

jaissica12 · 2025-09-09T20:14:07Z

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

Added use method roktManager.ts, snippet, snippet.rokt.js and relates tests

Testing Plan

Was this tested locally? If not, explain why.
{explain how this has been tested, and what, if any, additional testing should be done}

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

Closes https://rokt.atlassian.net/browse/SDKE-143

rmi22186

tiny comment for whitespace, otherwise LGTM!

rmi22186 · 2025-09-10T02:11:59Z

@alexs-mparticle should review to understand what features we are adding as well

alexs-mparticle · 2025-09-10T14:58:40Z

@alexs-mparticle should review to understand what features we are adding as well

@jaissica12 Not sure if @rmi22186 mentioned this, but we should also update DefinitelyTyped to reflect this new method as well.

alexs-mparticle · 2025-09-10T15:00:46Z

+        try {
+            return this.kit.use<T>(name);
+        } catch (error) {
+            return Promise.reject(error instanceof Error ? error : new Error('Unknown error occurred'));


I think we should have a more explicit error message as we know that the use method is related to extensions.

Suggested change

return Promise.reject(error instanceof Error ? error : new Error('Unknown error occurred'));

return Promise.reject(error instanceof Error ? error : new Error('Error using extension: ' + name));

jaissica12 · 2025-09-10T16:00:13Z

@alexs-mparticle should review to understand what features we are adding as well

@jaissica12 Not sure if @rmi22186 mentioned this, but we should also update DefinitelyTyped to reflect this new method as well.

Thanks for mentioning, I'll create a ticket for this and raise PR with the changes

rmi22186 · 2025-09-10T16:33:21Z

We should also just add the remaining public methods to the snippet so that customers don't have to update them in the future.

alexs-mparticle · 2025-09-12T15:44:43Z

 export interface IRoktLauncher {
    selectPlacements: (options: IRoktSelectPlacementsOptions) => Promise<IRoktSelection>;
    hashAttributes: (attributes: IRoktPartnerAttributes) => Promise<Record<string, string>>;
+    use: <T = any>(name: string) => Promise<T>;


We should avoid using any.

Suggested change

use: <T = any>(name: string) => Promise<T>;

use: <T>(name: string) => Promise<T>;

alexs-mparticle · 2025-09-12T15:44:52Z

    setExtensionData<T>(extensionData: IRoktPartnerExtensionData<T>): void;
+    terminate: () => Promise<void>;
+    getVersion: () => Promise<string>;
+    use: <T = any>(name: string) => Promise<T>;


Suggested change

use: <T = any>(name: string) => Promise<T>;

use: <T>(name: string) => Promise<T>;

alexs-mparticle · 2025-09-12T15:45:01Z

        }
    }

+    public use<T = any>(name: string): Promise<T> {


Suggested change

public use<T = any>(name: string): Promise<T> {

public use<T>(name: string): Promise<T> {

alexs-mparticle · 2025-09-15T13:18:14Z


 //load the SDK
-(function(e){window.mParticle=window.mParticle||{};window.mParticle.EventType={Unknown:0,Navigation:1,Location:2,Search:3,Transaction:4,UserContent:5,UserPreference:6,Social:7,Other:8,Media:9};window.mParticle.eCommerce={Cart:{}};window.mParticle.Identity={};window.mParticle.Rokt={};window.mParticle.config=window.mParticle.config||{};window.mParticle.config.rq=[];window.mParticle.config.snippetVersion=2.5;window.mParticle.ready=function(e){window.mParticle.config.rq.push(e)};var t=["endSession","logError","logBaseEvent","logEvent","logForm","logLink","logPageView","setSessionAttribute","setAppName","setAppVersion","setOptOut","setPosition","startNewSession","startTrackingLocation","stopTrackingLocation"];var i=["setCurrencyCode","logCheckout"];var n=["identify","login","logout","modify"];var o=["selectPlacements","hashAttributes","setExtensionData"];t.forEach(function(e){window.mParticle[e]=r(e)});i.forEach(function(e){window.mParticle.eCommerce[e]=r(e,"eCommerce")});n.forEach(function(e){window.mParticle.Identity[e]=r(e,"Identity")});o.forEach(function(e){window.mParticle.Rokt[e]=r(e,"Rokt")});function r(t,i){return function(){if(i){t=i+"."+t}var e=Array.prototype.slice.call(arguments);e.unshift(t);window.mParticle.config.rq.push(e)}}var c,a,s=window.mParticle.config,l=s.isDevelopmentMode?1:0,w="?env="+l,d=window.mParticle.config.dataPlan;if(d){c=d.planId;a=d.planVersion;if(c){if(a&&(a<1||a>1e3)){a=null}w+="&plan_id="+c+(a?"&plan_version="+a:"")}}var m=window.mParticle.config.versions;var f=[];if(m){Object.keys(m).forEach(function(e){f.push(e+"="+m[e])})}var p=document.createElement("script");p.type="text/javascript";p.async=true;p.src=("https:"==document.location.protocol?"https://jssdkcdns":"http://jssdkcdn")+".mparticle.com/js/v2/"+e+"/mparticle.js"+w+"&"+f.join("&");var P=document.getElementsByTagName("script")[0];P.parentNode.insertBefore(p,P)})("REPLACE WITH API KEY");
+(function(e){window.mParticle=window.mParticle||{};window.mParticle.EventType={Unknown:0,Navigation:1,Location:2,Search:3,Transaction:4,UserContent:5,UserPreference:6,Social:7,Other:8,Media:9};window.mParticle.eCommerce={Cart:{}};window.mParticle.Identity={};window.mParticle.Rokt={};window.mParticle.config=window.mParticle.config||{};window.mParticle.config.rq=[];window.mParticle.config.snippetVersion=2.5;window.mParticle.ready=function(e){window.mParticle.config.rq.push(e)};var t=["endSession","logError","logBaseEvent","logEvent","logForm","logLink","logPageView","setSessionAttribute","setAppName","setAppVersion","setOptOut","setPosition","startNewSession","startTrackingLocation","stopTrackingLocation"];var i=["setCurrencyCode","logCheckout"];var n=["identify","login","logout","modify"];var o=["selectPlacements","hashAttributes","setExtensionData","use","getVersion","terminate"];t.forEach(function(e){window.mParticle[e]=r(e)});i.forEach(function(e){window.mParticle.eCommerce[e]=r(e,"eCommerce")});n.forEach(function(e){window.mParticle.Identity[e]=r(e,"Identity")});o.forEach(function(e){window.mParticle.Rokt[e]=r(e,"Rokt")});function r(t,i){return function(){if(i){t=i+"."+t}var e=Array.prototype.slice.call(arguments);e.unshift(t);window.mParticle.config.rq.push(e)}}var a,c,s=window.mParticle.config,l=s.isDevelopmentMode?1:0,w="?env="+l,d=window.mParticle.config.dataPlan;if(d){a=d.planId;c=d.planVersion;if(a){if(c&&(c<1||c>1e3)){c=null}w+="&plan_id="+a+(c?"&plan_version="+c:"")}}var m=window.mParticle.config.versions;var f=[];if(m){Object.keys(m).forEach(function(e){f.push(e+"="+m[e])})}var p=document.createElement("script");p.type="text/javascript";p.async=true;p.src=("https:"==document.location.protocol?"https://jssdkcdns":"http://jssdkcdn")+".mparticle.com/js/v2/"+e+"/mparticle.js"+w+"&"+f.join("&");var P=document.getElementsByTagName("script")[0];P.parentNode.insertBefore(p,P)})("REPLACE WITH API KEY");


Bump the version number of the snippet.js and then run the build command again.

Co-authored-by: Robert Ing <rmi22186@gmail.com>

rmi22186 · 2025-09-15T15:04:58Z

+    getVersion: () => Promise<string>;
+    terminate: () => Promise<void>;


I'd remove these for now

Suggested change

getVersion: () => Promise<string>;

terminate: () => Promise<void>;

rmi22186 · 2025-09-15T15:06:06Z

+    terminate: () => Promise<void>;
+    getVersion: () => Promise<string>;


ditto

Suggested change

terminate: () => Promise<void>;

getVersion: () => Promise<string>;

Add these to the branch you are creating for supporting these APIs so it all goes in as 1 PR.

rmi22186 · 2025-09-15T15:08:14Z

                    hashAttributes: jest.fn(),
-                    selectPlacements: jest.fn()
+                    selectPlacements: jest.fn(),
+                    use: jest.fn(),


Can you create a test for use? Something like "should call kit.use with the same argument passed to mParticle.Rokt.use"

sonarqubecloud · 2025-09-15T15:28:43Z

Quality Gate failed

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

See analysis details on SonarQube Cloud

# [2.45.0](v2.44.0...v2.45.0) (2025-09-15) ### Features * add use method for rokt kit ([#1067](#1067)) ([bdcd4c5](bdcd4c5)) * added noFunctional and noTargeting flags ([#1059](#1059)) ([9235483](9235483))

mparticle-automation · 2025-09-15T18:36:41Z

🎉 This PR is included in version 2.45.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

jaissica12 requested a review from rmi22186 September 9, 2025 20:38

jaissica12 marked this pull request as ready for review September 9, 2025 20:43

rmi22186 approved these changes Sep 10, 2025

View reviewed changes

Comment thread test/jest/roktManager.spec.ts Outdated

rmi22186 requested a review from alexs-mparticle September 10, 2025 02:11

alexs-mparticle requested changes Sep 10, 2025

View reviewed changes

jaissica12 requested a review from alexs-mparticle September 10, 2025 16:00

jaissica12 changed the title ~~feat: added use method for rokt kit~~ feat: added use, getVersion, terminate method for rokt kit Sep 12, 2025

alexs-mparticle requested changes Sep 12, 2025

View reviewed changes

jaissica12 requested review from alexs-mparticle and rmi22186 September 12, 2025 16:40

alexs-mparticle reviewed Sep 15, 2025

View reviewed changes

jaissica12 changed the title ~~feat: added use, getVersion, terminate method for rokt kit~~ feat: add use method for rokt kit Sep 15, 2025

Jaissica Hora and others added 6 commits September 15, 2025 10:32

feat: added use method for rokt kit

f0bca65

Update test/jest/roktManager.spec.ts

b3ac5dc

Co-authored-by: Robert Ing <rmi22186@gmail.com>

chore: updated error message

bda9cd5

fix: update snippet, README and clean up generic types

510b1dc

chore: bump up snippet version

c279269

chore: bump up snippet version to 2.7

27f7f18

jaissica12 force-pushed the feat/SDKE-143-support-mParticle.Rokt.use-in-mp-web-sdk branch from c624db9 to 27f7f18 Compare September 15, 2025 14:55

rmi22186 reviewed Sep 15, 2025

View reviewed changes

chore: updated jest test for use, added getVersion, terminate in snippet

ba9be58

jaissica12 requested review from alexs-mparticle and rmi22186 September 15, 2025 15:44

alexs-mparticle approved these changes Sep 15, 2025

View reviewed changes

jaissica12 merged commit bdcd4c5 into development Sep 15, 2025
42 of 49 checks passed

mparticle-automation added the released label Sep 15, 2025

	return Promise.reject(error instanceof Error ? error : new Error('Unknown error occurred'));
	return Promise.reject(error instanceof Error ? error : new Error('Error using extension: ' + name));

	use: <T = any>(name: string) => Promise<T>;
	use: <T>(name: string) => Promise<T>;

	public use<T = any>(name: string): Promise<T> {
	public use<T>(name: string): Promise<T> {

		getVersion: () => Promise<string>;
		terminate: () => Promise<void>;

Uh oh!

Conversation

jaissica12 commented Sep 9, 2025

Instructions

Summary

Testing Plan

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

Uh oh!

rmi22186 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rmi22186 commented Sep 10, 2025

Uh oh!

alexs-mparticle commented Sep 10, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jaissica12 commented Sep 10, 2025

Uh oh!

rmi22186 commented Sep 10, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Sep 15, 2025

Quality Gate failed

Uh oh!

Uh oh!

mparticle-automation commented Sep 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants