fix(chai-retry-plugin): collision with chai-as-promised plugin
#392
Conversation
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
vladyslav-baliuk
changed the title
chai-as-promised and other plugins chai-as-promised plugin
vladyslav-baliuk
requested review from
alisey and
olehrakwix
and removed request for
yurii-ve
olehrakwix
approved these changes
May 2, 2023
alisey
reviewed
May 2, 2023
| @@ -4,8 +4,9 @@ import { retryFunctionAndAssertions } from './helpers'; | |||
| import type { AssertionMethod, FunctionToRetry, AssertionStackItem, RetryOptions, PromiseLikeAssertion } from './types'; | |||
|
|
|||
| /** | |||
| * Plugin that allows to re-run function passed to `expect` with new `retry` method, retrying would be performed until | |||
| * the result will pass the chained assertion or timeout exceeded or retries limit reached. | |||
| * Plugin that allows to re-run function passed to `expect`, in order to achieve that use new `retry` method, retrying would be performed until | |||
There was a problem hiding this comment.
I don't understand this. The words don't connect into a sentence.
Change to:
This plugin allows to retry an assertion until it succeeds or a timeout is reached.
| @@ -29,67 +30,71 @@ import type { AssertionMethod, FunctionToRetry, AssertionStackItem, RetryOptions | |||
| * await expect(funcToRetry).retry().and.have.property('success').and.be.true; | |||
There was a problem hiding this comment.
Use a more realistic example:
await expect(() => document.title).retry({ timeout: 10_000 }).to.equal('hello');| const description = utils.flag(this, 'message') as string; | ||
| export const chaiRetryPlugin = function (_: typeof Chai, { flag, inspect }: Chai.ChaiUtils) { | ||
| Object.defineProperty(Chai.Assertion.prototype, 'retry', { | ||
| value: function (retryOptions: RetryOptions = {}): PromiseLikeAssertion { |
There was a problem hiding this comment.
Extract this to a named function instead of increasing indentation even further.
| import { chaiRetryPlugin } from '../chai-retry-plugin/chai-retry-plugin'; | ||
|
|
||
| Chai.use(chaiRetryPlugin); | ||
| // `chai-as-promised` should be used in order to test collision between plugins |
There was a problem hiding this comment.
"Should be used" or "is used"?
| await expect(resultFunction).retry({ delay: 200 }).to.equal('Success'); | ||
| }); | ||
|
|
||
| it('should return value that was asserted successfully', async () => { |
There was a problem hiding this comment.
What do you mean by "asserted successfully"? There's no assertion here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes incompatibility with
chai-as-promisedplugin and other minor improvements