Skip to content

Change polling behavior #114

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
mattt merged 2 commits into from
Aug 4, 2023
Merged

Change polling behavior #114

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
0268770
Remove max_attempts parameter from wait method
mattt Aug 4, 2023
80dc3fb
Set default polling interval to 500ms
mattt Aug 4, 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
3 changes: 1 addition & 2 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ declare module 'replicate' {
identifier: `${string}/${string}:${string}`,
options: {
input: object;
wait?: { interval?: number; max_attempts?: number };
wait?: { interval?: number };
webhook?: string;
webhook_events_filter?: WebhookEventType[];
signal?: AbortSignal;
Expand All @@ -106,7 +106,6 @@ declare module 'replicate' {
prediction: Prediction,
options: {
interval?: number;
max_attempts?: number;
},
stop?: (prediction: Prediction) => Promise<boolean>
): Promise<Prediction>;
Expand Down
17 changes: 3 additions & 14 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,7 @@ class Replicate {
* @param {object} options
* @param {object} options.input - Required. An object with the model inputs
* @param {object} [options.wait] - Options for waiting for the prediction to finish
* @param {number} [options.wait.interval] - Polling interval in milliseconds. Defaults to 250
* @param {number} [options.wait.max_attempts] - Maximum number of polling attempts. Defaults to no limit
* @param {number} [options.wait.interval] - Polling interval in milliseconds. Defaults to 500
* @param {string} [options.webhook] - An HTTPS URL for receiving a webhook when the prediction has new output
* @param {string[]} [options.webhook_events_filter] - You can change which events trigger webhook requests by specifying webhook events (`start`|`output`|`logs`|`completed`)
* @param {AbortSignal} [options.signal] - AbortSignal to cancel the prediction
Expand Down Expand Up @@ -247,8 +246,7 @@ class Replicate {
* @async
* @param {object} prediction - Prediction object
* @param {object} options - Options
* @param {number} [options.interval] - Polling interval in milliseconds. Defaults to 250
* @param {number} [options.max_attempts] - Maximum number of polling attempts. Defaults to no limit
* @param {number} [options.interval] - Polling interval in milliseconds. Defaults to 500
* @param {Function} [stop] - Async callback function that is called after each polling attempt. Receives the prediction object as an argument. Return false to cancel polling.
* @throws {Error} If the prediction doesn't complete within the maximum number of attempts
* @throws {Error} If the prediction failed
Expand All @@ -271,9 +269,7 @@ class Replicate {
// eslint-disable-next-line no-promise-executor-return
const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));

let attempts = 0;
const interval = options.interval || 250;
const max_attempts = options.max_attempts || null;
const interval = options.interval || 500;

let updatedPrediction = await this.predictions.get(id);

Expand All @@ -287,13 +283,6 @@ class Replicate {
break;
}

attempts += 1;
if (max_attempts && attempts > max_attempts) {
throw new Error(
`Prediction ${id} did not finish after ${max_attempts} attempts`
);
}

await sleep(interval);
updatedPrediction = await this.predictions.get(prediction.id);
/* eslint-enable no-await-in-loop */
Expand Down