Skip to content
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

[Snyk] Upgrade jwt-decode from 3.1.2 to 4.0.0 #50

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nerdy-tech-com-gitub
Copy link
Owner

@nerdy-tech-com-gitub nerdy-tech-com-gitub commented Dec 8, 2024

snyk-top-banner

Snyk has created this PR to upgrade jwt-decode from 3.1.2 to 4.0.0.

ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.


⚠️ Warning: This PR contains major version upgrade(s), and may be a breaking change.

  • The recommended version is 6 versions ahead of your current version.

  • The recommended version was released on a year ago.

Issues fixed by the recommended upgrade:

Issue Score Exploit Maturity
high severity Regular Expression Denial of Service (ReDoS)
SNYK-JS-CROSSSPAWN-8303230
169 Proof of Concept
medium severity Regular Expression Denial of Service (ReDoS)
SNYK-JS-PATHTOREGEXP-7925106
169 Proof of Concept
Release notes
Package name: jwt-decode
  • 4.0.0 - 2023-10-27

    A new version of the library, including a couple of improvements:

    • No longer include a polyfill for atob, as this is supported in all major browsers (and node environments > 14).
    • Compile to ES2017, dropping support for anything that does not support ES2017 (which should be very limited according to caniuse)
    • Use Node's atob when running on node.
    • Drop support for Node 14 and 16, add support for Node 20.
    • Add support for package.json's exports field, for better CJS/ESM support
    • Reorganize build artifacts for better CJS/ESM support (cjs and esm needs to be their own directory with a cjs specific package.json file)
    • Drop manual UMD bundle creation in index.standalone.ts, but rely on rollup instead.
    • Infer JwtPayload and JwtHeader default types from the header argument by using overloads.

    Even though some users might experience breaking changes, mostly because of the exports field, the majority should be able to update without making any changes, assuming the SDK is used in environments with support for atob.

    Migration to v4.0.0

    The jwtDecode function is now no longer the default export, and is instead provided as a named export. Make sure to update your code in places where you are importing this function:

    -import jwtDecodefrom "jwt-decode";
    +import { jwtDecode } from "jwt-decode";
  • 4.0.0-beta.4 - 2023-09-05

    Breaking changes

    Fixed

  • 4.0.0-beta.3 - 2023-08-16

    Breaking changes

    Changed

  • 4.0.0-beta.2 - 2023-08-04

    Changed

    Fixed

    • Ensure types are bundled and correctly linked #174 (jonkoops)
  • 4.0.0-beta.1 - 2023-07-29

    Fixed

  • 4.0.0-beta.0 - 2023-07-28

    A new version of the library, including a couple of improvements:

    • No longer include a polyfill for atob, as this is supported in all major browsers (and node environments > 14).
    • Compile to ES2017, dropping support for anything that does not support ES2017 (which should be very limited according to caniuse)
    • Use Node's atob when running on node.
    • Drop support for Node 14, add support for Node 20.
    • Add support for package.json's exports field, for better CJS/ESM support
    • Reorganize build artifacts for better CJS/ESM support (cjs and esm needs to be their own directory with a cjs specific package.json file)
    • Drop manual UMD bundle creation in index.standalone.ts, but rely on rollup instead.
    • Infer JwtPayload and JwtHeader default types from the header argument by using overloads.

    Additionally, this PR ensures the file size is decreased:

    • ESM and CJS decreased by 22%
    • UMD decreased by 37%

    Even though some users might experience breaking changes, mostly because of the exports field, the majority should be able to update without making any changes, assuming the SDK is used in environments with support for atob.

  • 3.1.2 - 2020-11-16

    3.1.2

from jwt-decode GitHub release notes

Important

  • Warning: This PR contains a major version upgrade, and may be a breaking change.
  • Check the changes in this PR to ensure they won't cause issues with your project.
  • This PR was automatically created by Snyk using the credentials of a real user.
  • Max score is 1000. Note that the real score may have changed since the PR was raised.

Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.

For more information:

Summary by Sourcery

Build:

  • Upgrade jwt-decode dependency from version 3.1.2 to 4.0.0 in package.json.

Snyk has created this PR to upgrade jwt-decode from 3.1.2 to 4.0.0.

See this package in npm:
jwt-decode

See this project in Snyk:
https://app.snyk.io/org/nerds-github/project/1ce64081-e07a-4bf8-bb78-d92e784e5df0?utm_source=github&utm_medium=referral&page=upgrade-pr
Copy link

sourcery-ai bot commented Dec 8, 2024

Reviewer's Guide by Sourcery

This PR upgrades the jwt-decode dependency from version 3.1.2 to 4.0.0. The upgrade includes breaking changes in how the library is imported and used, along with improvements in bundle size and modern JavaScript support. The update also addresses security vulnerabilities related to ReDoS in cross-spawn and path-to-regexp dependencies.

Class diagram for jwt-decode import changes

classDiagram
    class JwtDecode {
        <<interface>>
        +decode(token: string): JwtPayload
    }
    class JwtPayload {
        +header: JwtHeader
        +payload: Object
    }
    class JwtHeader {
        +alg: String
        +typ: String
    }
    note for JwtDecode "jwtDecode is now a named export instead of a default export"
Loading

File-Level Changes

Change Details Files
Update jwt-decode dependency version with breaking changes
  • Changed import syntax from default to named export
  • Dropped support for Node.js versions 14 and 16
  • Added support for Node.js 20
  • Removed atob polyfill in favor of native implementations
  • Added package.json exports field for better CJS/ESM support
  • Improved bundle size with 22% reduction for ESM/CJS and 37% for UMD
packages/artifact/package.json

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have skipped reviewing this pull request. Here's why:

  • It seems to have been created by a bot ('[Snyk]' found in title). We assume it knows what it's doing!
  • We don't review packaging changes - Let us know if you'd like us to change this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants