Fixes for Webpack 5 browser environments #664
Open
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
Webpack 5 no longer automatically provides polyfills for Node APIs from browser environments. (See "Automatic polyfills for native Node.js modules were removed" under the [Webpack 5 release announcement][1].) This causes problems for Bunyan's use of Node.js-only globals like `process` and `Buffer`. As I understand it, one solution is to do an explicit `require` and, if needed, [configure Webpack's resolve.fallback option][2] to specify how to resolve the `require`d modules. (Bunyan does something similar to this for the `os` and `fs` modules.) The other solution is to check whether the modules are available before continuing. I opted for the second solution in this PR, to avoid introducing a dependency on the [buffer][3] module. This means that Bunyan won't directly support Buffer objects in the browser. There are two references to `process` that I didn't update: `process.env` check and a reference to `process.stderr.write`. `process.env` is specially handled by Node.js, and `process.stderr` is addressed by trentm#628. [1]: https://webpack.js.org/blog/2020-10-10-webpack-5-release/ [2]: https://stackoverflow.com/q/64557638/25507 [3]: https://www.npmjs.com/package/buffer
|
@joshkel are we going to move this PR forward? |
|
@mr-pinzhang As far as I know, it's ready to go. I haven't heard anything from the Bunyan team. I've since switched to Pino; it's a largely drop-in replacement for Bunyan and works better with Webpack 5. |
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.
Webpack 5 no longer automatically provides polyfills for Node APIs from browser environments. (See "Automatic polyfills for native Node.js modules were removed" under the Webpack 5 release announcement.) This causes problems for Bunyan's use of Node.js-only globals like
processandBuffer.As I understand it, one solution is to do an explicit
requireand, if needed, configure Webpack's resolve.fallback option to specify how to resolve therequired modules. (Bunyan does something similar to this for theosandfsmodules.)The other solution is to check whether the modules are available before continuing.
I opted for the second solution in this PR, to avoid introducing a dependency on the buffer module. This means that Bunyan won't directly support Buffer objects in the browser.
There are two references to
processthat I didn't update:process.envcheck and a reference toprocess.stderr.write.process.envis specially handled by Node.js, andprocess.stderris addressed by #628.