fix: update file-type to resolve vulnerability #205
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
dpopp07
commented
Jul 25, 2022
|
I restarted the bulids for this PR because the original builds were canceled by travis due to the build credits issue. |
The `file-type` package has a vulnerability that persists until v16.5.4. This commit updates the package to v16.5.4 to avoid the vulnerability. However, the package update required changes in how we use the package in our code which resulted in incompatible updates to a couple of functions that are part of our public API. Though it is unlikely these functions are being widely used, this change will need to go into a new major version. BREAKING CHANGE: two synchronous public functions are now asynchronous The function `getContentType` formerly returned a string but now returns a Promise that resolves to a string. The function `buildRequestFileObject` formerly returned a `FileObject` but now returns a Promise that resolves to a `FileObject`. Fixes #204 Signed-off-by: Dustin Popp <dpopp07@gmail.com>
dpopp07
force-pushed
the
dp/file-type-vulnerability
branch
from
8b768cc to
d7b60c1
Compare
ibm-devx-sdk
pushed a commit
that referenced
this pull request
Jul 28, 2022
# [3.0.0](v2.17.15...v3.0.0) (2022-07-28) ### Bug Fixes * update file-type to resolve vulnerability ([#205](#205)) ([843e66d](843e66d)), closes [#204](#204) ### BREAKING CHANGES * two synchronous public functions are now asynchronous The function `getContentType` formerly returned a string but now returns a Promise that resolves to a string. The function `buildRequestFileObject` formerly returned a `FileObject` but now returns a Promise that resolves to a `FileObject`.
|
🎉 This PR is included in version 3.0.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
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.
Resolves #204
The CVE states that v16.5.4 is clean, so I upgraded to that and modified the code accordingly. It led to some function changes from sync to async but all functions that should really only be used internally. That said, I think these functions are technically exported as part of the public API, so we should evaluate if this should considered a breaking change or a necessary fix of broken (vulnerable) code.
I wanted to upgrade to v17 but that caused a number of TypeScript errors from the
file-typeinternal code. I may open an issue there to see if I can find out why it's happening.