Skip to content

feat: add support for maxItems in run options #330

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
B4nan merged 6 commits into from
Mar 9, 2023
Merged

feat: add support for maxItems in run options #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3fa41bf
feat: Add support for maxItems run options
novotnyj Mar 7, 2023
1609dd1
Add maxItems to tasks
novotnyj Mar 7, 2023
37cef1f
Add maxItems to call
novotnyj Mar 7, 2023
5c51b6c
Fix lint
novotnyj Mar 7, 2023
11b0129
Fix comment
novotnyj Mar 8, 2023
dae1898
Add extra tests for call method
novotnyj Mar 8, 2023
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
12 changes: 11 additions & 1 deletion src/resource_clients/actor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,18 @@ export class ActorClient extends ResourceClient {
timeout: ow.optional.number,
waitForFinish: ow.optional.number,
webhooks: ow.optional.array.ofType(ow.object),
maxItems: ow.optional.number.not.negative,
}));

const { waitForFinish, timeout, memory, build } = options;
const { waitForFinish, timeout, memory, build, maxItems } = options;

const params = {
waitForFinish,
timeout,
memory,
build,
webhooks: stringifyWebhooksToBase64(options.webhooks),
maxItems,
};

const request: AxiosRequestConfig = {
Expand Down Expand Up @@ -115,6 +117,7 @@ export class ActorClient extends ResourceClient {
timeout: ow.optional.number.not.negative,
waitSecs: ow.optional.number.not.negative,
webhooks: ow.optional.array.ofType(ow.object),
maxItems: ow.optional.number.not.negative,
}));

const { waitSecs, ...startOptions } = options;
Expand Down Expand Up @@ -324,6 +327,13 @@ export interface ActorStartOptions {
* [ad hook webhooks documentation](https://docs.apify.com/webhooks/ad-hoc-webhooks) for detailed description.
*/
webhooks?: readonly WebhookUpdateData[];

/**
* Specifies maximum number of items that the actor run should return.
* This is used by pay per result actors to limit the maximum number of results that will be charged to customer.
* Value can be accessed in actor run using `APIFY_ACTOR_MAX_ITEMS` environment variable.
*/
maxItems?: number;
}

export interface ActorCallOptions extends Omit<ActorStartOptions, 'waitForFinish'> {
Expand Down
5 changes: 4 additions & 1 deletion src/resource_clients/task.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,16 +63,18 @@ export class TaskClient extends ResourceClient {
timeout: ow.optional.number,
waitForFinish: ow.optional.number,
webhooks: ow.optional.array.ofType(ow.object),
maxItems: ow.optional.number.not.negative,
}));

const { waitForFinish, timeout, memory, build } = options;
const { waitForFinish, timeout, memory, build, maxItems } = options;

const params = {
waitForFinish,
timeout,
memory,
build,
webhooks: stringifyWebhooksToBase64(options.webhooks),
maxItems,
};

const request: ApifyRequestConfig = {
Expand Down Expand Up @@ -105,6 +107,7 @@ export class TaskClient extends ResourceClient {
timeout: ow.optional.number.not.negative,
waitSecs: ow.optional.number.not.negative,
webhooks: ow.optional.array.ofType(ow.object),
maxItems: ow.optional.number.not.negative,
}));

const { waitSecs, ...startOptions } = options;
Expand Down
38 changes: 38 additions & 0 deletions test/actors.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,18 @@ describe('Actor methods', () => {
validateRequest({ webhooks: stringifyWebhooksToBase64(webhooks) }, { actorId });
});

test('start() with max items works', async () => {
const actorId = 'some-id';

const res = await client.actor(actorId).start(undefined, { maxItems: 100 });
expect(res.id).toEqual('run-actor');
validateRequest({ maxItems: 100 }, { actorId });

const browserRes = await page.evaluate((id, opts) => client.actor(id).start(undefined, opts), actorId, { maxItems: 100 });
expect(browserRes).toEqual(res);
validateRequest({ maxItems: 100 }, { actorId });
});

test('call() works', async () => {
const actorId = 'some-id';
const contentType = 'application/x-www-form-urlencoded';
Expand Down Expand Up @@ -244,6 +256,32 @@ describe('Actor methods', () => {
}, { actorId }, { some: 'body' }, { 'content-type': contentType });
});

test('call() works with maxItems', async () => {
const actorId = 'some-id';
const runId = 'started-run-id';
const data = { id: runId, actId: actorId, status: 'SUCCEEDED' };
const body = { data };
const waitSecs = 1;
const maxItems = 100;

mockServer.setResponse({ body });
const res = await client.actor(actorId).call(undefined, { waitSecs, maxItems });

expect(res).toEqual(data);
validateRequest({ waitForFinish: waitSecs }, { runId });
validateRequest({ maxItems }, { actorId });

const callBrowserRes = await page.evaluate(
(id, i, opts) => client.actor(id).call(i, opts), actorId, undefined, {
waitSecs,
maxItems,
},
);
expect(callBrowserRes).toEqual(res);
validateRequest({ waitForFinish: waitSecs }, { runId });
validateRequest({ maxItems }, { actorId });
});

test('build() works', async () => {
const actorId = 'some-id';

Expand Down
44 changes: 44 additions & 0 deletions test/tasks.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,17 @@ describe('Task methods', () => {
validateRequest(query, { taskId });
});

test('start() works with maxItems', async () => {
const taskId = 'some-id';
const res = await client.task(taskId).start(undefined, { maxItems: 100 });
expect(res.id).toEqual('run-task');
validateRequest({ maxItems: 100 }, { taskId });

const browserRes = await page.evaluate((id, opts) => client.task(id).start(undefined, opts), taskId, { maxItems: 100 });
expect(browserRes).toEqual(res);
validateRequest({ maxItems: 100 }, { taskId });
});

test('call() works', async () => {
const taskId = 'some-task-id';
const input = { some: 'body' };
Expand Down Expand Up @@ -297,6 +308,39 @@ describe('Task methods', () => {
}, { taskId }, { some: 'body' });
});

test('call() works with maxItems', async () => {
const taskId = 'some-task-id';
const actId = 'started-actor-id';
const runId = 'started-run-id';
const data = { id: runId, actId, status: 'SUCCEEDED' };
const body = { data };
const waitSecs = 1;
const maxItems = 100;

const query = { maxItems };

mockServer.setResponse({ body });
const res = await client.task(taskId).call(undefined, {
waitSecs,
maxItems,
});
expect(res).toEqual(data);

expect(res).toEqual(data);
validateRequest({ waitForFinish: waitSecs }, { runId });
validateRequest(query, { taskId });

const callBrowserRes = await page.evaluate(
(id, i, opts) => client.task(id).call(i, opts), taskId, undefined, {
waitSecs,
maxItems,
},
);
expect(callBrowserRes).toEqual(res);
validateRequest({ waitForFinish: waitSecs }, { runId });
validateRequest({ maxItems }, { taskId });
});

test('webhooks().list() works', async () => {
const taskId = 'some-task-id';
const query = {
Expand Down