BREAKING CHANGE: Async stack traces for custom methods and statics, remove promiseOrCallback()
#15376
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR removes callback support from custom methods and statics by eliminating the promiseOrCallback helper and updating middleware hook handling. It also improves async stack traces for static hooks and updates corresponding tests and documentation.
- Removed promiseOrCallback helper and its tests.
- Updated custom method/statically hooked functions to return Promises.
- Adjusted test cases and migration documentation, plus updated CI Node.js versions.
Reviewed Changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| test/model.middleware.test.js | Added test for async stack traces in static hooks. |
| test/helpers/promiseOrCallback.test.js | Removed tests for now-deprecated promiseOrCallback helper. |
| test/document.test.js | Updated custom method hooks from callback to async, with new tests. |
| lib/utils.js | Removed export of promiseOrCallback. |
| lib/helpers/promiseOrCallback.js | Removed deprecated helper file. |
| lib/helpers/model/applyStaticHooks.js | Replaced wrapper logic with hooks.createWrapper. |
| lib/helpers/model/applyHooks.js | Switched to a wrapper-based approach for custom methods. |
| docs/migrating_to_9.md | Documented the breaking change and migration path to async methods. |
| .github/workflows/test.yml | Updated supported Node.js versions. |
Files not reviewed (1)
- package.json: Language not supported
hasezoey
approved these changes
Apr 28, 2025
Co-authored-by: hasezoey <[email protected]>
…omattic/mongoose into vkarpov15/async-custom-hooks-statics
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.
Summary
Some more changes re: mongoosejs/kareem#39. Given that we've gotten rid of
promiseOrCallback(), this also means we've finally fully removed callback support from our client-facing API. The last outstanding callback support was for hooks for custom statics and methods.Examples