-
Notifications
You must be signed in to change notification settings - Fork 3
fix(NODE-6730): allow webpack bundling #67
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
Merged
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
1fe6088
fix(NODE-6730): allow webpack bundling
durran c16a085
chore: add git ignore
durran e77cc7f
chore: update readme
durran 86da582
test: move to unit dir
durran 6a6773e
fix: eslint
durran 7799f4f
chore: add github action for webpack
durran 896b569
chore: rename workflow
durran 3d173cc
fix: throw if no debug
durran d7e9f74
Update src/index.ts
durran f52f714
chore: document catch and rethrow
durran 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 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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
dist/* |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
'use strict'; | ||
|
||
const { execSync } = require('node:child_process'); | ||
const { readFileSync } = require('node:fs'); | ||
const { resolve } = require('node:path'); | ||
|
||
const xtrace = (...args) => { | ||
console.log(`running: ${args[0]}`); | ||
return execSync(...args); | ||
}; | ||
|
||
const ceRoot = resolve(__dirname, '../../..'); | ||
console.log(`mongodb-client-encryption package root: ${ceRoot}`); | ||
|
||
const ceVersion = JSON.parse( | ||
readFileSync(resolve(ceRoot, 'package.json'), { encoding: 'utf8' }) | ||
).version; | ||
console.log(`mongodb-client-encryption Version: ${ceVersion}`); | ||
|
||
xtrace('npm pack --pack-destination test/bundling/webpack', { cwd: ceRoot }); | ||
|
||
xtrace(`npm install --no-save mongodb-client-encryption-${ceVersion}.tgz`); | ||
|
||
console.log('mongodb-client-encryption installed!'); |
Oops, something went wrong.
Oops, something went wrong.
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.
The Debug native binding is never published by us, so no reason to attempt to include it in the published package and generate a warning from Webpack.
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.
It is kinda nice to have the code set up to pull in the debug build when dev-ing locally. So all we need here is a
try {}
around therequire
You may see "Module not found: Error: Can't resolve" but it is printed as a "WARNING" and does not stop the build and that's the intended behavior
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 had a conversation with Bailey about this and we thought it was more developer friendly to not have a warning even in the event of a valid bundle. I'm on that side that the bundle should be warning-free, since the debug aspect is only for ourselves and would never be published.
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.
Also just to clarify with the double try/catch, Webpack will still issue a warning about the Debug module not being available, though it will not fail. I think it's a better developer experience that if they bundle the module correctly, no warning is issued.
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.
The warning is desirable IMO because each warning alerts you to what your bundle is missing, you can squash them in your webpack config if you don't want to see them and it creates an intentional "paper trail" of the resolutions you don't care about.
We may not ship Debug but it can still be built and imported if Release is removed.
If we really feel strongly about not having Debug that's fine but we shouldn't introduce a console.log on import when this is missing, we can just throw inside this catch. The module is going to throw anyway when
mc
is accessed duringextends mc.MongoCrypt
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.
RFC @addaleax, our resident webpack user 😅
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.
Yeah, definitely feeling strongly that:
npm install --debug --build-from-source ...
isn't that hard and it's usually what a (sufficiently experienced) user will do to start diagnosing issues with native addonsrequire()
ing a native addon package should throw if the addon itself is unavailable – that's just the general expectation for how addon packages behaveconsole.error()
is much more disruptive than a warning in webpack. Most webpack configs will result in a bunch of warnings being printed, that's unfortunately more or less a fact of lifeThere 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've updated to throw now if both modules are missing.