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

Dependency: Remove node-fetch #28160

Open
wants to merge 5 commits into
base: next
Choose a base branch
from
Open

Conversation

yk-kd
Copy link

@yk-kd yk-kd commented Jun 9, 2024

Closes #27156

What I did

Updated node-fetch package from v2 to v3.
node-fetch v3 removes the whatwg-url dependency, so no more issue warnings.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@shilman shilman added dependencies patch:yes Bugfix & documentation PR that need to be picked to main branch ci:normal labels Jun 9, 2024
Copy link

nx-cloud bot commented Jun 9, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit fb7ac64. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@valentinpalkovic
Copy link
Contributor

valentinpalkovic commented Jun 9, 2024

Hi @yk-kd,

thank you for your contribution!

v3 of node-fetch is ESM only and since our build output is CJS and ESM, the import will fail in CJS environments. You have to use dynamic imports to import node-fetch, because dynamic imports are the only way importing ESM in CJS. The dynamic import has to happen in a asynchronous function though, because we don’t support top-level awaits so far.

So you have to change the "normal" import to an async import (const nodeFetch = await import('node-fetch')) and additionally move the import into the function, where it is used. Make sure that the parent function is marked as asynchronous. If it isn’t the case yet, please make sure to transform it to an async function and to await it everywhere, where it is called.

@valentinpalkovic valentinpalkovic self-assigned this Jun 9, 2024
@yk-kd
Copy link
Author

yk-kd commented Jun 10, 2024

@valentinpalkovic

thank you for your review.

I fixed to use dynamic import in commonjs.
Nodejs 18 can use fetch without node-fetch.
Have you considered removing the node-fetch dependency?

@valentinpalkovic
Copy link
Contributor

Good call! Let’s try it!

@yk-kd yk-kd changed the title Dependency: Update node-fetch Dependency: Remove node-fetch Jun 10, 2024
@yk-kd
Copy link
Author

yk-kd commented Jun 10, 2024

@valentinpalkovic
I finished.
Lock files still appeared to have node-fetch dependencies.
I didn't look at it in detail, but it looked like a dependency on CI, such as octokit or danger.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal dependencies patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: DeprecationWarning: The punycode module is deprecated
3 participants