Skip to content

Union pagination params #269

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
tharropoulos merged 2 commits into from
Mar 12, 2026
Merged

Union pagination params #269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12dbc5d
fix(request-adapter): promote per_page to common params for union mul…
tharropoulos Mar 12, 2026
e467bc5
feat(request-adapter): promote union-global pagination params to comm…
tharropoulos Mar 12, 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
6 changes: 5 additions & 1 deletion src/SearchRequestAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,11 @@ export class SearchRequestAdapter {
// Add union parameter if configured
if (this.configuration.union) {
searchRequest.union = this.configuration.union;
commonParams.page = searches[0].page;
["page", "per_page", "offset", "limit", "limit_hits"].forEach((paramName) => {
if (searches[0][paramName] != null) {
commonParams[paramName] = searches[0][paramName];
}
});
}

return this.typesenseClient.multiSearch.perform(searchRequest, commonParams);
Expand Down
129 changes: 129 additions & 0 deletions test/SearchRequestAdpater.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,6 +442,132 @@ describe("SearchRequestAdapter", () => {
);
});

it("promotes per_page to common params for union search", async () => {
const mockTypesenseClient = {
multiSearch: {
perform: jest.fn().mockResolvedValue({ results: [] }),
},
};

const configuration = new Configuration({
union: true,
additionalSearchParameters: {
query_by: "name",
},
});

const instantsearchRequests = [
{
indexName: "products",
params: { query: "test", hitsPerPage: 20 },
},
{
indexName: "brands",
params: { query: "test", hitsPerPage: 20 },
},
];

const subject = new SearchRequestAdapter(instantsearchRequests, mockTypesenseClient, configuration);
await subject.request();

expect(mockTypesenseClient.multiSearch.perform).toHaveBeenCalledWith(
{
union: true,
searches: [
{
collection: "products",
q: "test",
page: 1,
per_page: 20,
query_by: "name",
highlight_full_fields: "name",
},
{
collection: "brands",
q: "test",
page: 1,
per_page: 20,
query_by: "name",
highlight_full_fields: "name",
},
],
},
{
page: 1,
per_page: 20,
},
);
});

it("promotes union-global pagination params from the first search request", async () => {
const mockTypesenseClient = {
multiSearch: {
perform: jest.fn().mockResolvedValue({ results: [] }),
},
};

const configuration = new Configuration({
union: true,
additionalSearchParameters: {
query_by: "name",
offset: 40,
limit: 20,
limit_hits: 200,
},
});

const instantsearchRequests = [
{
indexName: "products",
params: { query: "test", page: 1, hitsPerPage: 20 },
},
{
indexName: "brands",
params: { query: "test", page: 1, hitsPerPage: 20 },
},
];

const subject = new SearchRequestAdapter(instantsearchRequests, mockTypesenseClient, configuration);
await subject.request();

expect(mockTypesenseClient.multiSearch.perform).toHaveBeenCalledWith(
{
union: true,
searches: [
{
collection: "products",
q: "test",
page: 2,
per_page: 20,
query_by: "name",
offset: 40,
limit: 20,
limit_hits: 200,
highlight_full_fields: "name",
},
{
collection: "brands",
q: "test",
page: 2,
per_page: 20,
query_by: "name",
offset: 40,
limit: 20,
limit_hits: 200,
highlight_full_fields: "name",
},
],
},
{
page: 2,
per_page: 20,
offset: 40,
limit: 20,
limit_hits: 200,
},
);
});

it("does not include union parameter in multisearch request when union is false", async () => {
const mockTypesenseClient = {
multiSearch: {
Expand Down Expand Up @@ -548,6 +674,7 @@ describe("SearchRequestAdapter", () => {
collection: "products",
q: "test",
page: 1,
per_page: 20,
query_by: "name",
conversation: true,
conversation_id: "conv_123",
Expand All @@ -563,6 +690,7 @@ describe("SearchRequestAdapter", () => {
{
collection: "products",
page: 1,
per_page: 20,
query_by: "name",
},
],
Expand All @@ -573,6 +701,7 @@ describe("SearchRequestAdapter", () => {
conversation_id: "conv_123",
conversation_model_id: "model_456",
page: 1,
per_page: 20,
},
);
});
Expand Down
Loading