Skip to content

fix(recommend): omit fallbackParameters from query when not passed as params #6716

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(recommend): omit fallbackParameters from query when not passed as params #6716

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
58 changes: 56 additions & 2 deletions ...s/instantsearch.js/src/connectors/looking-similar/__tests__/connectLookingSimilar-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,6 @@ describe('connectLookingSimilar', () => {
maxRecommendations: 10,
threshold: 95,
queryParameters: { userToken: 'token' },
fallbackParameters: {},
})
.addLookingSimilar({
// @ts-expect-error
Expand All @@ -127,7 +126,62 @@ describe('connectLookingSimilar', () => {
maxRecommendations: 10,
threshold: 95,
queryParameters: { userToken: 'token' },
fallbackParameters: {},
})
);
});

it('adds escapeHTML tags', () => {
const render = () => {};
const makeWidget = connectLookingSimilar(render);
const widget = makeWidget({
objectIDs: ['1', '2'],
limit: 10,
threshold: 95,
queryParameters: { userToken: 'token' },
fallbackParameters: { query: 'query' },
escapeHTML: true,
});

// @ts-expect-error
const actual = widget.getWidgetParameters(new RecommendParameters(), {
uiState: {},
});

expect(actual).toEqual(
new RecommendParameters()
.addLookingSimilar({
// @ts-expect-error
$$id: widget.$$id,
objectID: '1',
maxRecommendations: 10,
threshold: 95,
queryParameters: {
userToken: 'token',
highlightPostTag: '__/ais-highlight__',
highlightPreTag: '__ais-highlight__',
},
fallbackParameters: {
query: 'query',
highlightPostTag: '__/ais-highlight__',
highlightPreTag: '__ais-highlight__',
},
})
.addLookingSimilar({
// @ts-expect-error
$$id: widget.$$id,
objectID: '2',
maxRecommendations: 10,
threshold: 95,
queryParameters: {
userToken: 'token',
highlightPostTag: '__/ais-highlight__',
highlightPreTag: '__ais-highlight__',
},
fallbackParameters: {
query: 'query',
highlightPostTag: '__/ais-highlight__',
highlightPreTag: '__ais-highlight__',
},
})
);
});
Expand Down
10 changes: 6 additions & 4 deletions packages/instantsearch.js/src/connectors/looking-similar/connectLookingSimilar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,10 +215,12 @@ export default (function connectLookingSimilar<
objectID,
maxRecommendations: limit,
threshold,
fallbackParameters: {
...fallbackParameters,
...(escapeHTML ? TAG_PLACEHOLDER : {}),
},
fallbackParameters: fallbackParameters
? {
...fallbackParameters,
...(escapeHTML ? TAG_PLACEHOLDER : {}),
}
: undefined,
queryParameters: {
...queryParameters,
...(escapeHTML ? TAG_PLACEHOLDER : {}),
Expand Down
58 changes: 56 additions & 2 deletions ...instantsearch.js/src/connectors/related-products/__tests__/connectRelatedProducts-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,6 @@ describe('connectRelatedProducts', () => {
maxRecommendations: 10,
threshold: 95,
queryParameters: { userToken: 'token' },
fallbackParameters: {},
})
.addRelatedProducts({
// @ts-expect-error
Expand All @@ -127,7 +126,62 @@ describe('connectRelatedProducts', () => {
maxRecommendations: 10,
threshold: 95,
queryParameters: { userToken: 'token' },
fallbackParameters: {},
})
);
});

it('adds escapeHTML tags', () => {
const render = () => {};
const makeWidget = connectRelatedProducts(render);
const widget = makeWidget({
objectIDs: ['1', '2'],
limit: 10,
threshold: 95,
queryParameters: { userToken: 'token' },
fallbackParameters: { query: 'query' },
escapeHTML: true,
});

// @ts-expect-error
const actual = widget.getWidgetParameters(new RecommendParameters(), {
uiState: {},
});

expect(actual).toEqual(
new RecommendParameters()
.addRelatedProducts({
// @ts-expect-error
$$id: widget.$$id,
objectID: '1',
maxRecommendations: 10,
threshold: 95,
queryParameters: {
userToken: 'token',
highlightPostTag: '__/ais-highlight__',
highlightPreTag: '__ais-highlight__',
},
fallbackParameters: {
highlightPostTag: '__/ais-highlight__',
highlightPreTag: '__ais-highlight__',
query: 'query',
},
})
.addRelatedProducts({
// @ts-expect-error
$$id: widget.$$id,
objectID: '2',
maxRecommendations: 10,
threshold: 95,
queryParameters: {
userToken: 'token',
highlightPostTag: '__/ais-highlight__',
highlightPreTag: '__ais-highlight__',
},
fallbackParameters: {
highlightPostTag: '__/ais-highlight__',
highlightPreTag: '__ais-highlight__',
query: 'query',
},
})
);
});
Expand Down
10 changes: 6 additions & 4 deletions packages/instantsearch.js/src/connectors/related-products/connectRelatedProducts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,10 +216,12 @@ export default (function connectRelatedProducts<
objectID,
maxRecommendations: limit,
threshold,
fallbackParameters: {
...fallbackParameters,
...(escapeHTML ? TAG_PLACEHOLDER : {}),
},
fallbackParameters: fallbackParameters
? {
...fallbackParameters,
...(escapeHTML ? TAG_PLACEHOLDER : {}),
}
: undefined,
queryParameters: {
...queryParameters,
...(escapeHTML ? TAG_PLACEHOLDER : {}),
Expand Down
42 changes: 40 additions & 2 deletions ...ges/instantsearch.js/src/connectors/trending-items/__tests__/connectTrendingItems-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,6 @@ describe('connectTrendingItems', () => {
maxRecommendations: 10,
threshold: 95,
queryParameters: { userToken: 'token' },
fallbackParameters: {},
})
);
});
Expand Down Expand Up @@ -165,7 +164,46 @@ describe('connectTrendingItems', () => {
maxRecommendations: 10,
threshold: 95,
queryParameters: { userToken: 'token' },
fallbackParameters: {},
})
);
});

it('adds escapeHTML tags', () => {
const render = () => {};
const makeWidget = connectTrendingItems(render);
const widget = makeWidget({
facetName: 'key',
facetValue: 'value',
limit: 10,
threshold: 95,
queryParameters: { userToken: 'token' },
escapeHTML: true,
fallbackParameters: { query: 'query' },
});

// @ts-expect-error
const actual = widget.getWidgetParameters(new RecommendParameters(), {
uiState: {},
});

expect(actual).toEqual(
new RecommendParameters().addTrendingItems({
// @ts-expect-error
$$id: widget.$$id,
facetName: 'key',
facetValue: 'value',
maxRecommendations: 10,
threshold: 95,
queryParameters: {
userToken: 'token',
highlightPostTag: '__/ais-highlight__',
highlightPreTag: '__ais-highlight__',
},
fallbackParameters: {
highlightPostTag: '__/ais-highlight__',
highlightPreTag: '__ais-highlight__',
query: 'query',
},
})
);
});
Expand Down
10 changes: 6 additions & 4 deletions packages/instantsearch.js/src/connectors/trending-items/connectTrendingItems.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,10 +235,12 @@ export default (function connectTrendingItems<
facetValue: facetValue as string,
maxRecommendations: limit,
threshold,
fallbackParameters: {
...fallbackParameters,
...(escapeHTML ? TAG_PLACEHOLDER : {}),
},
fallbackParameters: fallbackParameters
? {
...fallbackParameters,
...(escapeHTML ? TAG_PLACEHOLDER : {}),
}
: undefined,
queryParameters: {
...queryParameters,
...(escapeHTML ? TAG_PLACEHOLDER : {}),
Expand Down