-
Notifications
You must be signed in to change notification settings - Fork 4
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.
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
Map error type to message #1782
Merged
+90
−6
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
import { poll, PollingTimeout } from "./poll"; | ||
|
||
describe("poll", () => { | ||
test("should only call input function once if it succeeds", async () => { | ||
const testFn = jest.fn(async () => { | ||
return new Promise((resolve) => { | ||
resolve("foo"); | ||
}); | ||
}); | ||
|
||
const res = await poll(testFn, { | ||
interval: 50, | ||
timeout: 1000, | ||
}); | ||
|
||
expect(res).toEqual("foo"); | ||
expect(testFn).toHaveBeenCalledTimes(1); | ||
}); | ||
|
||
test("should call function at least twice and timeout", async () => { | ||
const testFn = jest.fn(async () => { | ||
throw new Error("1) What"); | ||
}); | ||
|
||
const res = await poll(testFn, { | ||
interval: 1, | ||
timeout: 100, | ||
}); | ||
|
||
expect(res).toEqual(PollingTimeout); | ||
expect(testFn).toHaveBeenNthCalledWith(1); | ||
expect(testFn).toHaveBeenNthCalledWith(2); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
import { delay } from "./delay"; | ||
|
||
/** | ||
* Static literal symbol for a timed out polling try. | ||
*/ | ||
export const PollingTimeout = "timeout"; | ||
export type PollingTimeout = typeof PollingTimeout; | ||
|
||
/** | ||
* @generic T type of the returned value | ||
* @param fn () => Promise T - the fn called to poll for values | ||
* @param opts.timeout number - how long to try total from start to finish. | ||
* @param opts.interval number - the time between tries. | ||
* @param opts.retries number - number of retries. | ||
* @param opts.validator (value: T) => Promise<boolean> - check the value returned from the fn | ||
* @returns Promise T | PollingTimeout | null | ||
*/ | ||
export const poll = async <T>( | ||
fn: () => Promise<T | null | PollingTimeout>, | ||
opts: { | ||
timeout: number; | ||
interval: number; | ||
validator?: (value: T | null | PollingTimeout) => Promise<boolean>; | ||
}, | ||
): Promise<T | null | PollingTimeout> => { | ||
if (opts.timeout <= 0) { | ||
return PollingTimeout; | ||
} | ||
|
||
const start = Date.now(); | ||
|
||
try { | ||
const value = await fn(); | ||
if (value && (!opts.validator || (await opts.validator(value)))) { | ||
return value; | ||
} | ||
} catch { | ||
await delay(opts.interval); | ||
|
||
const end = Date.now(); | ||
|
||
return poll<T>(fn, { ...opts, timeout: opts.timeout - (end - start) }); | ||
} | ||
await delay(opts.interval); | ||
|
||
const end = Date.now(); | ||
|
||
return poll<T>(fn, { ...opts, timeout: opts.timeout - (end - start) }); | ||
}; |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does this actually change? Since error type should only be one of two types it seems like the old code should cover all cases?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suspect the types are probably wrong and not all errors are accounted for. Even so, I don't think the previous code is good practice as it assumes that there will only ever be 2 error types