Skip to content

Add optional seedItemIds to trackRecommendationClick #256

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 4 commits into from
Jun 8, 2026
Merged

Add optional seedItemIds to trackRecommendationClick #256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1722b03
Add optional seedItemIds to trackRecommendationClick
Sher-Bakhodirov Jun 2, 2026
930a4d5
Add optional seedItemIds to trackRecommendationView
Sher-Bakhodirov Jun 2, 2026
811f30a
add support for number type of seedItemIds
Sher-Bakhodirov Jun 5, 2026
9dcc597
Bump ci version
esezen Jun 5, 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
2 changes: 1 addition & 1 deletion .github/workflows/run-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node: ["18.13.0"]
node: ["22.18.0"]
Comment thread
esezen marked this conversation as resolved.
steps:
- name: Check out code
uses: actions/checkout@v3
Expand Down
257 changes: 247 additions & 10 deletions spec/src/modules/tracker.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2785,7 +2785,8 @@ describe('ConstructorIO - Tracker', () => {

expect(tracker.trackSearchResultsLoaded(term, {
...requiredParameters,
...optionalParameters }, userParameters)).to.equal(true);
...optionalParameters,
}, userParameters)).to.equal(true);
});

it('Should respond with a valid response when term, required parameters and user identifier are provided', (done) => {
Expand Down Expand Up @@ -4398,10 +4399,12 @@ describe('ConstructorIO - Tracker', () => {
apiKey: testApiKey,
fetch: fetchSpy,
});
const fullParameters = { ...requiredParameters,
const fullParameters = {
...requiredParameters,
type: 'add_to_loves',
displayName: 'Add To Loves List',
isCustomType: true };
isCustomType: true,
};

tracker.on('success', (responseParams) => {
const requestParams = helpers.extractBodyParamsFromFetch(fetchSpy);
Expand Down Expand Up @@ -4457,9 +4460,11 @@ describe('ConstructorIO - Tracker', () => {
apiKey: testApiKey,
fetch: fetchSpy,
});
const fullParameters = { ...requiredParameters,
const fullParameters = {
...requiredParameters,
display_name: 'Add To Loves List',
is_custom_type: true };
is_custom_type: true,
};

tracker.on('success', (responseParams) => {
const requestParams = helpers.extractBodyParamsFromFetch(fetchSpy);
Expand Down Expand Up @@ -4525,9 +4530,11 @@ describe('ConstructorIO - Tracker', () => {
apiKey: testApiKey,
fetch: fetchSpy,
});
const fullParameters = { ...requiredParameters,
const fullParameters = {
...requiredParameters,
type: 'add_to_loves',
is_custom_type: true };
is_custom_type: true,
};

tracker.on('error', (responseParams) => {
const requestParams = helpers.extractBodyParamsFromFetch(fetchSpy);
Expand Down Expand Up @@ -4694,7 +4701,7 @@ describe('ConstructorIO - Tracker', () => {
const requestParams = helpers.extractBodyParamsFromFetch(fetchSpy);

try {
// Request
// Request
expect(fetchSpy).to.have.been.called;
expect(requestParams).to.have.property('key');
expect(requestParams).to.have.property('i');
Expand Down Expand Up @@ -4729,7 +4736,7 @@ describe('ConstructorIO - Tracker', () => {
const requestParams = helpers.extractBodyParamsFromFetch(fetchSpy);

try {
// Request
// Request
expect(fetchSpy).to.have.been.called;
expect(requestParams).to.have.property('key');
expect(requestParams).to.have.property('i');
Expand Down Expand Up @@ -5772,6 +5779,121 @@ describe('ConstructorIO - Tracker', () => {

expect(tracker.trackRecommendationView(requiredParameters, { ...userParameters, userId })).to.equal(true);
});

it('Should return valid response and omit seed_item_ids if no seedItemIds provided', (done) => {
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,
fetch: fetchSpy,
});

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

// Request
expect(fetchSpy).to.have.been.called;
expect(requestParams).to.not.have.property('seed_item_ids');

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

done();
});

expect(tracker.trackRecommendationView(requiredParameters, userParameters)).to.equal(true);
});
it('Should return valid response with seed_item_ids if seedItemIds is an array', (done) => {
Comment thread
esezen marked this conversation as resolved.
const seedItemIds = ['123', '456'];
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
});

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

// Request
expect(fetchSpy).to.have.been.called;
expect(requestParams).to.have.property('seed_item_ids').to.deep.equal(seedItemIds);

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

done();
});

expect(tracker.trackRecommendationView({ ...requiredParameters, seedItemIds }, userParameters)).to.equal(true);
});
it('Should return valid response with seed_item_ids if seedItemIds is a string', (done) => {
const seedItemIds = '123';
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
});

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

// Request
expect(fetchSpy).to.have.been.called;
expect(requestParams).to.have.property('seed_item_ids').to.deep.equal([seedItemIds]);

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

done();
});

expect(tracker.trackRecommendationView({ ...requiredParameters, seedItemIds }, userParameters)).to.equal(true);
});
it('Should return valid response with seed_item_ids if seedItemIds is a number', (done) => {
const seedItemIds = 123;
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
});

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

// Request
expect(fetchSpy).to.have.been.called;
expect(requestParams).to.have.property('seed_item_ids').to.deep.equal([String(seedItemIds)]);

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

done();
});

expect(tracker.trackRecommendationView({ ...requiredParameters, seedItemIds }, userParameters)).to.equal(true);
});
it('Should return valid response and omit seed_item_ids if seedItemIds is not string, number, or array', (done) => {
const seedItemIds = { seedItemIds: ['123', '456'] };
Comment thread
constructor-claude-bedrock[bot] marked this conversation as resolved.
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
});

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

// Request
expect(fetchSpy).to.have.been.called;
expect(requestParams).to.not.have.property('seed_item_ids');

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

done();
});

expect(tracker.trackRecommendationView({ ...requiredParameters, seedItemIds }, userParameters)).to.equal(true);
});
});

describe('trackRecommendationClick', () => {
Expand Down Expand Up @@ -6341,6 +6463,121 @@ describe('ConstructorIO - Tracker', () => {

expect(tracker.trackRecommendationClick(requiredParameters, { ...userParameters, userId })).to.equal(true);
});

it('Should return valid response and omit seed_item_ids if no seedItemIds provided', (done) => {
Comment thread
constructor-claude-bedrock[bot] marked this conversation as resolved.
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
});

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

// Request
expect(fetchSpy).to.have.been.called;
expect(requestParams).to.not.have.property('seed_item_ids');

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

done();
});

expect(tracker.trackRecommendationClick(requiredParameters, userParameters)).to.equal(true);
});
it('Should return valid response with seed_item_ids if seedItemIds is an array', (done) => {
const seedItemIds = ['123', '456'];
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
});

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

// Request
expect(fetchSpy).to.have.been.called;
expect(requestParams).to.have.property('seed_item_ids').to.deep.equal(seedItemIds);

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

done();
});

expect(tracker.trackRecommendationClick({ ...requiredParameters, seedItemIds }, userParameters)).to.equal(true);
});
it('Should return valid response with seed_item_ids if seedItemIds is a string', (done) => {
const seedItemIds = '123';
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
});

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

// Request
expect(fetchSpy).to.have.been.called;
expect(requestParams).to.have.property('seed_item_ids').to.deep.equal([seedItemIds]);

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

done();
});

expect(tracker.trackRecommendationClick({ ...requiredParameters, seedItemIds }, userParameters)).to.equal(true);
});
it('Should return valid response with seed_item_ids if seedItemIds is a number', (done) => {
const seedItemIds = 123;
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
});

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

// Request
expect(fetchSpy).to.have.been.called;
expect(requestParams).to.have.property('seed_item_ids').to.deep.equal([String(seedItemIds)]);

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

done();
});

expect(tracker.trackRecommendationClick({ ...requiredParameters, seedItemIds }, userParameters)).to.equal(true);
});
it('Should return valid response and omit seed_item_ids if seedItemIds is not string, number, or array', (done) => {
const seedItemIds = { seedItemIds: ['123', '456'] };
const { tracker } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
});

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

// Request
expect(fetchSpy).to.have.been.called;
expect(requestParams).to.not.have.property('seed_item_ids');

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

done();
});

expect(tracker.trackRecommendationClick({ ...requiredParameters, seedItemIds }, userParameters)).to.equal(true);
});
});

describe('trackBrowseResultsLoaded', () => {
Expand Down Expand Up @@ -8095,7 +8332,7 @@ describe('ConstructorIO - Tracker', () => {
it('Should throw an error when providing no messageType parameter', () => {
const { tracker } = new ConstructorIO({ apiKey: testApiKey });

expect(tracker.on(null, () => {})).to.be.an('error');
expect(tracker.on(null, () => { })).to.be.an('error');
});

it('Should throw an error when providing an invalid callback parameter', () => {
Expand Down
Loading
Loading