-
Notifications
You must be signed in to change notification settings - Fork 197
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
noahdarveau/buffer removal #2598
Merged
Merged
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
jadahiya-MSFT
previously approved these changes
Nov 5, 2024
TrevorJoelHarris
requested changes
Nov 6, 2024
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.
Couple of small questions and I want to follow up with jay about the transpiled uint8array-extras folder
jadahiya-MSFT
approved these changes
Nov 7, 2024
TrevorJoelHarris
approved these changes
Nov 7, 2024
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.
This PR replaces use of the
Buffer
package with uint8array-extras. This change allows for the removal of thebuffer
polyfill, which was previously required asBuffer
was not supported in browsers. Sinceuint8array-extras
is browser-compatible we do not need to include a polyfill for it. TheBuffer
polyfill is rather large, ~22KB when minified, and cannot reap the benefits of treeshaking since polyfills are always included in the global scope. We are only using theBuffer
package in theclipboard
capability, so even if a consumer was treeshaking outclipboard
, they were still getting theBuffer
polyfill included in their bundle, even though it was not doing anything. With this change, anyone not using theclipboard
capability should see a flat ~22KB package size reduction.To include this package, despite it being and NPM package, it was having issues working with Jest for our tests. I'm still not entirely sure what exactly the issue was, but copying the package locally and running it through our typescript transpiler fixed the issue. There was another issue with
TextDecoder
not being supported in jsdom, even though it is supported in both Node and browsers, so I included a jest-setup file that polyfillsTextDecoder
with the Node implementation.