[CDX-470] Add `additionalTrackingKeys` option by t3t3c · Pull Request #472 · Constructor-io/constructorio-client-javascript

t3t3c · 2026-06-22T10:28:09Z

Summary

Adds additionalTrackingKeys option to ConstructorClientOptions that accepts an array of API key strings
When configured, every tracking event queued via RequestQueue is duplicated for each additional key, with the key swapped in both the URL query string and POST body
Invalid entries (non-strings, empty strings) are filtered out silently

Usage

const cio = new ConstructorIO({
  apiKey: 'primary-key',
  sendTrackingEvents: true,
  additionalTrackingKeys: ['secondary-key', 'tertiary-key'],
});

// All tracker methods now send events to all 3 keys
cio.tracker.trackPurchase({ items: [...], revenue: 12.00 });

Changes

src/types/index.d.ts — Added additionalTrackingKeys?: string[] to options interface
src/constructorio.js — Pass through the new option
src/utils/request-queue.js — Duplicate queued requests for each additional key
spec/src/utils/request-queue.js — Unit tests (5 cases)
spec/src/modules/tracker.js — Integration test

Test plan

Unit tests: duplication works, empty array, missing option, invalid entries, GET requests
Integration test: fetch called with both primary and additional key URLs
Existing test suite: no regressions
Lint passes

Resolves CDX-470

…vents Adds a new `additionalTrackingKeys` client option that duplicates tracking events to additional API keys. When configured, each tracking event queued via RequestQueue is also sent to each additional key with the `key` parameter swapped in both the URL and POST body.

Copilot

Pull request overview

Adds an additionalTrackingKeys client option to support duplicating tracking events across multiple Constructor.io API keys, primarily by cloning queued RequestQueue entries with the key swapped in the URL/body.

Changes:

Introduces additionalTrackingKeys?: string[] on ConstructorClientOptions and wires it through ConstructorIO options.
Updates RequestQueue to enqueue duplicate tracking requests per additional key.
Adds unit + integration tests validating duplication behavior and invalid-key filtering.

Reviewed changes

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

Show a summary per file

File	Description
src/utils/request-queue.js	Duplicates queued tracking requests for each configured additional key
src/types/index.d.ts	Adds `additionalTrackingKeys?: string[]` to the public options type
src/constructorio.js	Plumbs `additionalTrackingKeys` through normalized client options
spec/src/utils/request-queue.js	Unit tests for duplication, empty/missing option, invalid entries, GET behavior
spec/src/modules/tracker.js	Integration test asserting fetch is called for both primary + additional keys

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

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

esezen

Thanks! This is looking great. I left some comments

- Use Set to remove duplicate additionalTrackingKeys and exclude the primary apiKey - Assert duplicate request URL does not contain the original key - Add test verifying request bodies are identical except for the key field - Improve JSDoc description for additionalTrackingKeys parameter Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

…-client-js Resolve conflicts: keep both useWindowParameters (from master) and additionalTrackingKeys (from this branch) in constructorio.js and index.d.ts. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

evanyan13

Hey @t3t3c
Thank you so much for making the changes! The PR is looking great in general. 🔥
Just left some comments for your consideration please

evanyan13

Hi @t3t3c
Thanks for making the changes so promptly!
Have left some comment regarding the new update to setClientOptions
For your consideration please

…amic updates

evanyan13

LGTM!
Thanks @t3t3c for the PR and the changes
@jjl014 Could we get your review & approval to push this change please
Thank you!

constructor-claude-bedrock

Code Review

This PR adds an additionalTrackingKeys option that duplicates every tracking event to one or more additional API keys — the implementation is compact and the tests are thorough. A few correctness and reliability issues need to be addressed before merging.

Inline comments: 6 discussions added

Overall Assessment: ⚠️ Needs Work

constructor-claude-bedrock · 2026-07-17T06:32:37Z

+        expect(queue[2].url).to.contain('key=another-valid-key');
+      });
+
+      it('Should not duplicate events when additionalTrackingKeys contains the primary key or duplicates', () => {


Suggestion: This test is a good addition. However, the test verifies that queue.length === 2 (primary + one unique extra), which is correct. Consider also asserting that neither queue[0] nor queue[1] contains a duplicate of the primary key in both the URL and the body to make the intent of the deduplication explicit:

expect(queue[0].body.key).to.equal('primary-key'); expect(queue[1].body.key).to.equal('extra-key');

This guards against the body not being swapped even when the URL deduplication works correctly.

constructor-claude-bedrock · 2026-07-17T06:32:37Z

+          additionalTrackingKeys: ['extra-key-1', 'extra-key-2'],
+        });
+
+        expect(instance.options).to.have.property('additionalTrackingKeys').to.deep.equal(['extra-key-1', 'extra-key-2']);


Suggestion: The setClientOptions test for additionalTrackingKeys only covers the DOM-less path. Given that the existing tests for other options (e.g. apiKey, segments) include a parallel test that asserts the change propagates to sub-module options (instance.tracker.options, instance.search.options, etc.), consider adding the same assertion here — or, at minimum, asserting instance.tracker.requests.options.additionalTrackingKeys if direct access is available. This ensures the shared-reference contract (noted above in the constructorio.js comment) is actually tested.

Claude raised a good point. We should have equivalent tests for the DOM context.

jjl014

Looking pretty solid to me. I did leave a couple comments that I'd like to get your thoughts on. Thanks!

jjl014 · 2026-07-17T19:26:30Z

+        const encodedOriginalKey = helpers.encodeURIComponentRFC3986(this.options.apiKey);
+
+        const uniqueKeys = new Set(
+          additionalKeys.filter((key) => key && typeof key === 'string' && key !== this.options.apiKey),
+        );
+
+        uniqueKeys.forEach((additionalKey) => {
+          const encodedAdditionalKey = helpers.encodeURIComponentRFC3986(additionalKey);
+          const swappedUrl = url.replace(`key=${encodedOriginalKey}`, `key=${encodedAdditionalKey}`);


Any reason why we're doing this validation and uniqueness check every time we queue an event?

It feels like an additional step that could be handled earlier (e.g. during client instantiation in the construtor or when setClientOptions is called)?

jjl014 · 2026-07-17T19:27:29Z

+          additionalTrackingKeys: ['extra-key-1', 'extra-key-2'],
+        });
+
+        expect(instance.options).to.have.property('additionalTrackingKeys').to.deep.equal(['extra-key-1', 'extra-key-2']);


Claude raised a good point. We should have equivalent tests for the DOM context.

jjl014 · 2026-07-17T21:14:12Z

        this.options.serviceUrl = formattedServiceUrl || this.options.serviceUrl;
      }
+
+      if (Array.isArray(additionalTrackingKeys)) {


Not a big deal, but if we wanted to stop sending events to multiple keys, we would have to send [] at the moment. Should also support null here?

Copilot AI review requested due to automatic review settings June 22, 2026 10:28

t3t3c requested a review from a team as a code owner June 22, 2026 10:28

Copilot started reviewing on behalf of t3t3c June 22, 2026 10:28 View session

This comment was marked as outdated.

Sign in to view

Copilot AI reviewed Jun 22, 2026

View reviewed changes

Comment thread src/utils/request-queue.js Outdated

Comment thread src/constructorio.js

Change encodeURIComponent to encodeURIComponentRFC3986

ad68a18

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

This comment was marked as outdated.

Sign in to view

t3t3c added 2 commits June 22, 2026 12:40

Add additionalTrackingKeys parameter to ConstructorIO client

35750b3

Address PR feedback: add JSDoc for additionalTrackingKeys, rename test

b2b471b

This comment was marked as outdated.

Sign in to view

esezen requested changes Jun 26, 2026

View reviewed changes

Comment thread src/utils/request-queue.js

Comment thread spec/src/modules/tracker.js

Comment thread spec/src/modules/tracker.js

Comment thread src/constructorio.js Outdated

t3t3c and others added 2 commits July 3, 2026 12:46

This comment was marked as outdated.

Sign in to view

evanyan13 reviewed Jul 15, 2026

View reviewed changes

Comment thread src/constructorio.js

Comment thread src/utils/request-queue.js Outdated

Comment thread spec/src/utils/request-queue.js

Comment thread spec/src/utils/request-queue.js Outdated

Comment thread spec/src/modules/tracker.js

t3t3c added 5 commits July 15, 2026 11:28

add additionalTrackingKeys option to setClientOptions

ad7223a

rename encodedKey to encodedAdditionalKey

5ba822e

Add test for additionalTrackingKeys deduplication against primary key

bea7b45

Remove body.key assertion

70d7fa0

Add URL key check to additionalTrackingKeys test

7dc32ee

This comment was marked as outdated.

Sign in to view

evanyan13 reviewed Jul 15, 2026

View reviewed changes

Comment thread src/constructorio.js

Comment thread src/constructorio.js

Add additionalTrackingKeys JSDoc to setClientOptions and test for dyn…

3a6875f

…amic updates

This comment was marked as outdated.

Sign in to view

Update test name

0892bb1

evanyan13 approved these changes Jul 17, 2026

View reviewed changes

constructor-claude-bedrock Bot reviewed Jul 17, 2026

View reviewed changes

jjl014 reviewed Jul 17, 2026

View reviewed changes

Uh oh!

Conversation

t3t3c commented Jun 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Usage

Changes

Test plan

Uh oh!

This comment was marked as outdated.

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!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

esezen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

evanyan13 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

evanyan13 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

evanyan13 left a comment

Choose a reason for hiding this comment

Uh oh!

constructor-claude-bedrock Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

constructor-claude-bedrock Bot Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

constructor-claude-bedrock Bot Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

jjl014 Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

jjl014 left a comment

Choose a reason for hiding this comment

Uh oh!

jjl014 Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

jjl014 Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

jjl014 Jul 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

t3t3c commented Jun 22, 2026 •

edited

Loading