feat: re-export default Mongoose instance properties for ESM named imports support #12256
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
…ports support Fix #12148
imranbarbhuiya
suggested changes
Aug 11, 2022
AbdelrahmanHafez
requested changes
Aug 11, 2022
hasezoey
reviewed
Aug 12, 2022
index.js
Outdated
| module.exports.deleteModel = mongoose.deleteModel; | ||
| module.exports.modelNames = mongoose.modelNames; | ||
| module.exports.plugin = mongoose.plugin; | ||
| // module.exports.connection = mongoose.connection; |
There was a problem hiding this comment.
why not export the default connection, is it also because of "custom driver may overwrite this"?
There was a problem hiding this comment.
Yes exactly. setDriver() can recreate the default connection.
…t re-exported for Node ESM re: #12148
1 task
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.
Fix #12148
Summary
I did some reading in https://github.com/nodejs/node/pull/35249/files and https://simonplend.com/node-js-now-supports-named-imports-from-commonjs-modules-but-what-does-that-mean/, it looks like all we need to do to support ESM named imports in Node is to explicitly re-export all the properties on the Mongoose global.
This does come with some caveats. Most notably that
thiswill no longer be an instance ofMongoosein all exported functions by default. This shouldn't break anything - we added support for destructured imports in a73c2ab. But it is still a risk.I'm also not exporting
ConnectionandCollection, because those are custom getters and overwriting those can break support for custom drivers.Examples