Skip to content

[REM-3439] Viewable impressions tracking #456

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.

Sign up for GitHub

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

Merged
esezen merged 5 commits into from
Jun 11, 2026
Merged

[REM-3439] Viewable impressions tracking #456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0658c95
[REM-3439] Add `trackResultsImpressionView`, types and tests
ZSnake Jun 1, 2026
786031d
Merge branch 'master' into REM-3439/results-impression-tracking
ZSnake Jun 9, 2026
b3b3532
[REM-3439] Remove 100 items limit, add sponsored listings attributes …
ZSnake Jun 9, 2026
780de84
[REM-3439] Update jsdoc with all item fields
ZSnake Jun 10, 2026
455bcc7
[REM-3439] Add item-level validations to trackREsultsImpressionView a…
ZSnake Jun 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
332 changes: 332 additions & 0 deletions spec/src/modules/tracker.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15529,6 +15529,338 @@ describe(`ConstructorIO - Tracker${bundledDescriptionSuffix}`, () => {
});
});

describe('trackResultsImpressionView', () => {
const requiredParameters = {
items: [
{
itemId: '1',
itemName: 'Item 1',
variationId: 'VAR-1',
slCampaignId: 'campaign-123',
slCampaignOwner: 'owner-abc',
},
{
itemId: '2',
itemName: 'Item 2',
variationId: 'VAR-2',
slCampaignId: 'campaign-456',
slCampaignOwner: 'owner-def',
},
],
};
const optionalParameters = {
filterName: 'category',
filterValue: 'shoes',
searchTerm: 'red shoes',
};
Comment thread
Copilot marked this conversation as resolved.

it('Should respond with a valid response when required parameters are provided', (done) => {
Comment thread
constructor-claude-bedrock[bot] marked this conversation as resolved.
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
...requestQueueOptions,
});

tracker.on('success', (responseParams) => {
const requestParams = helpers.extractUrlParamsFromFetch(fetchSpy);
const bodyParams = helpers.extractBodyParamsFromFetch(fetchSpy);

// Request
expect(fetchSpy).to.have.been.called;
expect(requestParams).to.have.property('key');
expect(requestParams).to.have.property('i');
expect(requestParams).to.have.property('s');
expect(requestParams).to.have.property('c').to.equal(clientVersion);
expect(requestParams).to.have.property('_dt');
validateOriginReferrer(requestParams);

// Body
expect(bodyParams).to.have.property('items').to.deep.equal([
{
item_id: '1',
item_name: 'Item 1',
variation_id: 'VAR-1',
sl_campaign_id: 'campaign-123',
sl_campaign_owner: 'owner-abc',
},
{
item_id: '2',
item_name: 'Item 2',
variation_id: 'VAR-2',
sl_campaign_id: 'campaign-456',
sl_campaign_owner: 'owner-def',
},
]);

// Response
expect(responseParams).to.have.property('method').to.equal('POST');
expect(responseParams).to.have.property('message').to.equal('ok');

done();
});

tracker.on('error', (error) => {
done(error);
});

expect(tracker.trackResultsImpressionView(requiredParameters)).to.equal(true);
});

it('Should respond with a valid response when required and optional parameters are provided', (done) => {
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
...requestQueueOptions,
});

tracker.on('success', (responseParams) => {
const bodyParams = helpers.extractBodyParamsFromFetch(fetchSpy);

// Body
expect(fetchSpy).to.have.been.called;
expect(bodyParams).to.have.property('items');
expect(bodyParams).to.have.property('filter_name').to.equal(optionalParameters.filterName);
expect(bodyParams).to.have.property('filter_value').to.equal(optionalParameters.filterValue);
expect(bodyParams).to.have.property('search_term').to.equal(optionalParameters.searchTerm);

// Response
expect(responseParams).to.have.property('method').to.equal('POST');
expect(responseParams).to.have.property('message').to.equal('ok');

done();
});

tracker.on('error', (error) => {
done(error);
});

expect(tracker.trackResultsImpressionView({ ...requiredParameters, ...optionalParameters })).to.equal(true);
});

it('Should respond with a valid response when required parameters and segments are provided', (done) => {
const segments = ['foo', 'bar'];
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
segments,
fetch: fetchSpy,
...requestQueueOptions,
});

tracker.on('success', (responseParams) => {
const bodyParams = helpers.extractBodyParamsFromFetch(fetchSpy);

// Body
expect(fetchSpy).to.have.been.called;
expect(bodyParams).to.have.property('us').to.deep.equal(segments);

// Response
expect(responseParams).to.have.property('method').to.equal('POST');
expect(responseParams).to.have.property('message').to.equal('ok');

done();
});

tracker.on('error', (error) => {
done(error);
});

expect(tracker.trackResultsImpressionView(requiredParameters)).to.equal(true);
});

it('Should respond with a valid response when required parameters and userId are provided', (done) => {
const userId = 'user-id';
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
userId,
fetch: fetchSpy,
...requestQueueOptions,
});

tracker.on('success', (responseParams) => {
const bodyParams = helpers.extractBodyParamsFromFetch(fetchSpy);

// Body
expect(fetchSpy).to.have.been.called;
expect(bodyParams).to.have.property('ui').to.equal(userId);

// Response
expect(responseParams).to.have.property('method').to.equal('POST');
expect(responseParams).to.have.property('message').to.equal('ok');

done();
});

tracker.on('error', (error) => {
done(error);
});

expect(tracker.trackResultsImpressionView(requiredParameters)).to.equal(true);
});

it('Should respond with a valid response when required parameters and testCells are provided', (done) => {
const testCells = { foo: 'bar' };
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
testCells,
...requestQueueOptions,
});

tracker.on('success', (responseParams) => {
const bodyParams = helpers.extractBodyParamsFromFetch(fetchSpy);

// Body
expect(fetchSpy).to.have.been.called;
expect(bodyParams).to.have.property(`ef-${Object.keys(testCells)[0]}`).to.equal(Object.values(testCells)[0]);

// Response
expect(responseParams).to.have.property('method').to.equal('POST');
expect(responseParams).to.have.property('message').to.equal('ok');

done();
});

tracker.on('error', (error) => {
done(error);
});

expect(tracker.trackResultsImpressionView(requiredParameters)).to.equal(true);
});

it('Should send along origin_referrer query param if sendReferrerWithTrackingEvents is true', (done) => {
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
sendReferrerWithTrackingEvents: true,
...requestQueueOptions,
});

tracker.on('success', (responseParams) => {
const bodyParams = helpers.extractBodyParamsFromFetch(fetchSpy);

// Body
expect(fetchSpy).to.have.been.called;
validateOriginReferrer(bodyParams);

// Response
expect(responseParams).to.have.property('method').to.equal('POST');
expect(responseParams).to.have.property('message').to.equal('ok');

done();
});
Comment on lines +15738 to +15750

tracker.on('error', (error) => {
done(error);
});

expect(tracker.trackResultsImpressionView(requiredParameters)).to.equal(true);
});

it('Should not send along origin_referrer query param if sendReferrerWithTrackingEvents is false', (done) => {
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
sendReferrerWithTrackingEvents: false,
...requestQueueOptions,
});

tracker.on('success', (responseParams) => {
const bodyParams = helpers.extractBodyParamsFromFetch(fetchSpy);

// Body
expect(fetchSpy).to.have.been.called;
expect(bodyParams).to.not.have.property('origin_referrer');

// Response
expect(responseParams).to.have.property('method').to.equal('POST');
expect(responseParams).to.have.property('message').to.equal('ok');

done();
});
Comment on lines +15767 to +15779

tracker.on('error', (error) => {
done(error);
});

expect(tracker.trackResultsImpressionView(requiredParameters)).to.equal(true);
});

it('Should throw an error when invalid parameters are provided', () => {
const { tracker } = new ConstructorIO({ apiKey: testApiKey });

expect(tracker.trackResultsImpressionView([])).to.be.an('error');
});

it('Should throw an error when no parameters are provided', () => {
const { tracker } = new ConstructorIO({ apiKey: testApiKey });

expect(tracker.trackResultsImpressionView()).to.be.an('error');
});

it('Should throw an error when items is not provided', () => {
const { tracker } = new ConstructorIO({ apiKey: testApiKey });

expect(tracker.trackResultsImpressionView({})).to.be.an('error');
});

it('Should throw an error when items is an empty array', () => {
Comment thread
constructor-claude-bedrock[bot] marked this conversation as resolved.
Comment thread
constructor-claude-bedrock[bot] marked this conversation as resolved.
const { tracker } = new ConstructorIO({ apiKey: testApiKey });

expect(tracker.trackResultsImpressionView({ items: [] })).to.be.an('error');
});

it('Should throw an error when an item is missing itemId', () => {
const { tracker } = new ConstructorIO({ apiKey: testApiKey });

expect(tracker.trackResultsImpressionView({ items: [{ itemName: 'Shoe' }] })).to.be.an('error');
});

it('Should throw an error when an item is missing itemName', () => {
const { tracker } = new ConstructorIO({ apiKey: testApiKey });

expect(tracker.trackResultsImpressionView({ items: [{ itemId: '1' }] })).to.be.an('error');
});

it('Should throw an error when items contains non-object entries', () => {

@constructor-claude-bedrock constructor-claude-bedrock Bot Jun 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: The test suite covers most error and happy-path scenarios well. However, there is no test verifying that slCampaignId and slCampaignOwner fields are correctly serialized to sl_campaign_id and sl_campaign_owner in the request body when passed as optional item properties. While the first required-parameters test does include these fields and checks deep.equal, it would be more explicit to have a dedicated optional-item-properties test (similar to how filterName/filterValue/searchTerm get their own optional-parameters test) to confirm the snake_case transformation of sponsored listing fields is correct independently.

const { tracker } = new ConstructorIO({ apiKey: testApiKey });

expect(tracker.trackResultsImpressionView({ items: ['string'] })).to.be.an('error');
});

if (!skipNetworkTimeoutTests) {
it('Should be rejected when network request timeout is provided and reached', (done) => {
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
...requestQueueOptions,
});

tracker.on('error', ({ message }) => {
expect(message).to.equal(timeoutRejectionMessage);
done();
});

expect(tracker.trackResultsImpressionView(requiredParameters, { timeout: 10 })).to.equal(true);
});

it('Should be rejected when global network request timeout is provided and reached', (done) => {
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
networkParameters: {
timeout: 20,
},
...requestQueueOptions,
});

tracker.on('error', ({ message }) => {
expect(message).to.equal(timeoutRejectionMessage);
done();
});

expect(tracker.trackResultsImpressionView(requiredParameters)).to.equal(true);
});
}
});

describe('trackMediaImpressionView', () => {
let requiredParameters;

Expand Down
Loading
Loading