-
-
Notifications
You must be signed in to change notification settings - Fork 694
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
Fix 1564 #1566
Fix 1564 #1566
Conversation
my preference would be that an not sure how best to avoid confusion there |
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 agree but I'd add that we should aim for consistency between interfaces.
IMO:
expect(f).to.be.a.function()
/f.should.be.a.function()
/assert.isFunction(f)
should alias acallable()
assert, and so likewisenot.a.function
/isNotFunction
should be an alias for.not.callable()
expect(f).to.be.callable()
/f.should.be.callbable()
/assert.isCallable(f)
should check to see if the object can be called (i.e.typeof f == 'function'
).not.callable
would be!= 'function
.expect(f).to.be.an.async.function()
/f.should.be.an.async.function()
/assert.isAsyncFunction(f)
can checkbe.a('AsyncFunction')
. This means it should be possible to chain.a.callable.async.function()
even if that's redundant. Becausenot
is chainable,assert.isNotAsyncFunction
will only test that its not async, not that it's not callable. So.a.callable.not.async.function()
would pass for regular functions & generator functions, and fail for async functions (generator or otherwise).expect(f).to.be.a.generator.function()
/f.should.be.a.generator.function()
/assert.isGeneratorFunction(f)
can checkbe.a('GeneratorFunction')
, although arguably it should also pass for async generators, as they're still generator functions?- This also means
expect(f).to.be.an.async.generator.function()
/f.should.be.an.async.generator.function()
/assert.isAsyncGeneratorFunction(f)
should work for async generators.
Perhaps the async asserts should check if the stringtag matches /^Async.*Function$/
and the generator asserts should check it matches /GeneratorFunction$/
?
Recently in NodeJS's new One of the points is that a regular Function can return a Promise and thus be used like an AsyncFunction, even though it is not. So, my preference is that |
Yooo! I pushed some changes based off of #1566 (review) for early feedback. Please comment any thoughts (and prayers) if something looks off otherwise I'll continue down this road 😸 |
lib/chai/interface/assert.js
Outdated
@@ -590,6 +591,56 @@ assert.isNotFunction = function (val, msg) { | |||
new Assertion(val, msg, assert.isNotFunction, true).to.not.be.a('function'); | |||
}; | |||
|
|||
/** | |||
* TODO |
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.
TODO
lib/chai/interface/assert.js
Outdated
}; | ||
|
||
/** | ||
* TODO |
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.
TODO
I like the way the code is going and I appreciate your work on this. From my understanding of the code right now, it looks like this in the
So far, to check if an object is an AsyncGeneratorFunction we could test for AsyncFunction and GeneratorFunction. Is this right? If so, I'm in love with it 👍 I believe some tests to ensure the behavior of Also, I am not familiar with the internals of Chai, but does it automatically create the negation of the new assertions, i.e. |
We could add a |
i think it is important we do this part Keith mentioned otherwise, the various places people use e.g. then you would just negate |
Y'all know of a good way to do this that allows us to set the error message to say |
currently we'd do it by if we want to make an actual chain to be or we could just word it more like |
in its current state, looks like you have this:
i do wonder if we are over complicating it. i think i would have:
i think we should just fix up you could argue then we don't need what do you think? sorry for any chaos im causing by picking at this 😂 |
No this is great! I think getting this right is important.
Yeah I think we might be. When in doubt go with the most simple solution so I'm all for it. I'll take a crack at that next. |
I was looking at this and this the tests just fail because we're using
Now we could carve out a exception for functions instead of using |
strange, that isn't what i expected. what leads to it using deep-eql? i thought |
Ah! The chai code can be a bit terse to read sometimes 😅 You're correct! I'll make a push in a minute. |
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.
This is quite a bit smaller PR now I think but might need more tests for the different interfaces.
as far as the interface goes, looks good to me i think. much simpler than introducing brand new chains for each function type IMO be good to get keith's opinion some time though too |
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.
Generally LGTM, but could add a few more tests to prevent future regressions of this type.
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---|---|---| | [actions/setup-java](https://github.com/actions/setup-java) | action | major | `v3` -> `v4` | [![age](https://developer.mend.io/api/mc/badges/age/github-tags/actions%2fsetup-java/v4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/github-tags/actions%2fsetup-java/v4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/github-tags/actions%2fsetup-java/v3/v4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/github-tags/actions%2fsetup-java/v3/v4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [chai](http://chaijs.com) ([source](https://github.com/chaijs/chai)) | devDependencies | major | [`4.5.0` -> `5.1.1`](https://renovatebot.com/diffs/npm/chai/4.5.0/5.1.1) | [![age](https://developer.mend.io/api/mc/badges/age/npm/chai/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/chai/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/chai/4.5.0/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/chai/4.5.0/5.1.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>actions/setup-java (actions/setup-java)</summary> ### [`v4`](https://github.com/actions/setup-java/compare/v3...v4) [Compare Source](https://github.com/actions/setup-java/compare/v3...v4) </details> <details> <summary>chaijs/chai (chai)</summary> ### [`v5.1.1`](https://github.com/chaijs/chai/releases/tag/v5.1.1) [Compare Source](https://github.com/chaijs/chai/compare/v5.1.0...v5.1.1) #### What's Changed - Set up ESLint for JSDoc comments by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1605 - build(deps-dev): bump ip from 1.1.8 to 1.1.9 by [@​dependabot](https://github.com/dependabot) in [chaijs/chai#1608 - Correct Mocha import instructions by [@​MattiSG](https://github.com/MattiSG) in [chaijs/chai#1611 - fix: support some virtual contexts in `toThrow` by [@​43081j](https://github.com/43081j) in [chaijs/chai#1609 #### New Contributors - [@​MattiSG](https://github.com/MattiSG) made their first contribution in [chaijs/chai#1611 **Full Changelog**: chaijs/chai@v5.1.0...v5.1.1 ### [`v5.1.0`](https://github.com/chaijs/chai/releases/tag/v5.1.0) [Compare Source](https://github.com/chaijs/chai/compare/v5.0.3...v5.1.0) #### What's Changed - Remove useless guards and add parentheses to constuctors by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1593 - Cleanup jsdoc comments by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1596 - Convert comments in "legal comments" format to jsdoc or normal comments by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1598 - Implement `iterable` assertion by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1592 - Assert interface fix by [@​developer-bandi](https://github.com/developer-bandi) in [chaijs/chai#1601 - Set support in same members by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1583 - Fix publish script by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1602 #### New Contributors - [@​developer-bandi](https://github.com/developer-bandi) made their first contribution in [chaijs/chai#1601 **Full Changelog**: chaijs/chai@v5.0.3...v5.1.0 ### [`v5.0.3`](https://github.com/chaijs/chai/releases/tag/v5.0.3) [Compare Source](https://github.com/chaijs/chai/compare/v5.0.2...v5.0.3) Fix bad v5.0.2 publish. **Full Changelog**: chaijs/chai@v5.0.2...v5.0.3 ### [`v5.0.2`](https://github.com/chaijs/chai/releases/tag/v5.0.2) [Compare Source](https://github.com/chaijs/chai/compare/v5.0.0...v5.0.2) #### What's Changed - build(deps): bump nanoid and mocha by [@​dependabot](https://github.com/dependabot) in [chaijs/chai#1558 - remove `bump-cli` by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1559 - Update developer dependencies by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1560 - fix: removes `??` for node compat (5.x) by [@​43081j](https://github.com/43081j) in [chaijs/chai#1576 - Update `loupe` to latest version by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1579 - Re-enable some webkit tests by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1580 - Remove a bunch of if statements in test/should.js by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1581 - Remove a bunch of unused files by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1582 - Fix 1564 by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1566 **Full Changelog**: chaijs/chai@v5.0.1...v5.0.2 ### [`v5.0.0`](https://github.com/chaijs/chai/releases/tag/v5.0.0) [Compare Source](https://github.com/chaijs/chai/compare/v4.5.0...v5.0.0) #### BREAKING CHANGES - Chai now only supports EcmaScript Modules (ESM). This means your tests will need to either have `import {...} from 'chai'` or `import('chai')`. `require('chai')` will cause failures in nodejs. If you're using ESM and seeing failures, it may be due to a bundler or transpiler which is incorrectly converting import statements into require calls. - Dropped support for Internet Explorer. - Dropped support for NodeJS < 18. - Minimum supported browsers are now Firefox 100, Safari 14.1, Chrome 100, Edge 100. Support for browsers prior to these versions is "best effort" (bug reports on older browsers will be assessed individually and may be marked as wontfix). #### What's Changed - feat: use chaijs/loupe for inspection by [@​pcorpet](https://github.com/pcorpet) in [chaijs/chai#1401 - docs: fix URL in README by [@​Izzur](https://github.com/Izzur) in [chaijs/chai#1413 - Remove `get-func-name` dependency by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1416 - Convert Makefile script to npm scripts by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1424 - Clean up README badges by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1422 - fix: package.json - deprecation warning on exports field by [@​stevenjoezhang](https://github.com/stevenjoezhang) in [chaijs/chai#1400 - fix: deep-eql bump package to support symbols by [@​snewcomer](https://github.com/snewcomer) in [chaijs/chai#1458 - ES module conversion PoC by [@​43081j](https://github.com/43081j) in [chaijs/chai#1498 - chore: drop commonjs support by [@​43081j](https://github.com/43081j) in [chaijs/chai#1503 - Update pathval by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1527 - Update check-error by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1528 - update `deep-eql` to latest version by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1542 - Inline `type-detect` as a simple function by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1544 - Update loupe by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1545 - Typo 'Test an object' not 'Test and object' by [@​mavaddat](https://github.com/mavaddat) in [chaijs/chai#1460 - Update `assertion-error` to it's latest major version! by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1543 - Replacing Karma with Web Test Runner by [@​koddsson](https://github.com/koddsson) in [chaijs/chai#1546 #### New Contributors - [@​Izzur](https://github.com/Izzur) made their first contribution in [chaijs/chai#1413 - [@​stevenjoezhang](https://github.com/stevenjoezhang) made their first contribution in [chaijs/chai#1400 - [@​43081j](https://github.com/43081j) made their first contribution in [chaijs/chai#1498 **Full Changelog**: chaijs/chai@4.3.1...v5.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 2pm on Monday" in timezone Europe/Zurich, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View the [repository job log](https://developer.mend.io/github/adobe/spacecat-shared). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4yNi4xIiwidXBkYXRlZEluVmVyIjoiMzguMjYuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Dominique Jäggi <[email protected]>
Fix #1564 by introducing new
isAsyncFunction
andisNotAsyncFunction
assertions.The thinking is that even though async functions are functions this change will allow for more granular assertions.
I'm still not sure if this is what we'd like though. Async functions are still functions so I could see a argument being made for
isFunction
asserting that a async function is indeed a function. Maybe we should add aisSynchronousFunction
to specifically check if a function is not async and then leaveisFunction
to assert for both sync and async functions?Interested in hearing thoughts.
@43081j @keithamus @ReDemoNBR