Skip to content

[9.0] Fix default perPage option (#239073) #243621

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

Closed
kibanamachine wants to merge 1 commit into from
Closed

[9.0] Fix default perPage option (#239073) #243621

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
38 changes: 37 additions & 1 deletion src/core/packages/saved-objects/api-server-internal/src/lib/point_in_time_finder.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

import { loggerMock, type MockedLogger } from '@kbn/logging-mocks';
import type {
SavedObjectsFindResult,
SavedObjectsCreatePointInTimeFinderOptions,
SavedObjectsFindResult,
} from '@kbn/core-saved-objects-api-server';
import { savedObjectsPointInTimeFinderMock } from '../mocks';

Expand Down Expand Up @@ -352,6 +352,7 @@ describe('createPointInTimeFinder()', () => {
sortField: 'updated_at',
sortOrder: 'desc',
type: ['visualization'],
perPage: 1000,
}),
internalOptions
);
Expand Down Expand Up @@ -516,5 +517,40 @@ describe('createPointInTimeFinder()', () => {
expect(repository.find).toHaveBeenCalledTimes(2);
expect(repository.closePointInTime).toHaveBeenCalledTimes(2);
});

test('applies defaults as expected', async () => {
repository.openPointInTimeForType.mockResolvedValueOnce({
id: 'abc123',
});
repository.find.mockResolvedValueOnce({
total: 2,
saved_objects: mockHits,
pit_id: 'abc123',
per_page: 2,
page: 0,
});

const findOptions: SavedObjectsCreatePointInTimeFinderOptions = {
type: ['visualization'],
search: 'foo*',
};

const finder = new PointInTimeFinder(findOptions, {
logger,
client: repository,
});
await finder.find().next();

expect(repository.find).toHaveBeenCalledWith(
expect.objectContaining({
pit: expect.objectContaining({ id: 'abc123', keepAlive: '2m' }),
sortField: 'updated_at',
sortOrder: 'desc',
type: ['visualization'],
perPage: 1000,
}),
undefined
);
});
});
});
6 changes: 3 additions & 3 deletions src/core/packages/saved-objects/api-server-internal/src/lib/point_in_time_finder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export class PointInTimeFinder<T = unknown, A = unknown>
{
readonly #log: Logger;
readonly #client: SavedObjectsPointInTimeFinderClient;
readonly #findOptions: SavedObjectsFindOptions;
readonly #findOptions: SavedObjectsFindOptions & { perPage: number };
readonly #internalOptions: SavedObjectsFindInternalOptions | undefined;
#open: boolean = false;
#pitId?: string;
Expand Down Expand Up @@ -91,7 +91,7 @@ export class PointInTimeFinder<T = unknown, A = unknown>
this.#log.debug(`Collected [${lastResultsCount}] saved objects`);

// Close PIT if this was our last page
if (this.#pitId && lastResultsCount < this.#findOptions.perPage!) {
if (this.#pitId && lastResultsCount < this.#findOptions.perPage) {
await this.close();
}

Expand All @@ -103,7 +103,7 @@ export class PointInTimeFinder<T = unknown, A = unknown>

// We've reached the end when there are fewer hits than our perPage size,
// or when `close()` has been called.
} while (this.#open && lastResultsCount >= this.#findOptions.perPage!);
} while (this.#open && lastResultsCount >= this.#findOptions.perPage);

return;
}
Expand Down