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

Merged
merged 2 commits into from
Jul 3, 2024

Conversation

yk-kd
Copy link
Contributor

@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 beff8b5. 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
Contributor 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 yk-kd force-pushed the update-node-fetch branch 2 times, most recently from 263efaf to fb7ac64 Compare June 17, 2024 12:45
@yk-kd yk-kd force-pushed the update-node-fetch branch 8 times, most recently from 322a287 to beece5e Compare July 1, 2024 17:18
@yk-kd
Copy link
Contributor Author

yk-kd commented Jul 1, 2024

@valentinpalkovic
Node-fetch under code seems to have been removed in #27039
I've changed it so that it is removed from scripts as well, just in case.
Should I close the PR now that the original purpose has been achieved?

@valentinpalkovic
Copy link
Contributor

Hi @yk-kd. No, don’t close it. The core package consolidation moved nearly all Storybook packages to code/core. I guess node/fetch is a dependency there.

@yk-kd
Copy link
Contributor Author

yk-kd commented Jul 1, 2024

Hi @valentinpalkovic,

There is no node-fetch dependency in package.json when grepping under code.
There is one in yarn.lock, but it is a dependency of danger or octokit.

@valentinpalkovic
Copy link
Contributor

Interesting! @ndelangen have you removed node-fetch as part of CPC?

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

PR Summary

  • Removed node-fetch import from /docs/_snippets/loader-story.md
  • Removed node-fetch import from /docs/_snippets/storybook-preview-global-loader.md
  • Removed node-fetch dependency from /scripts/event-log-checker.ts
  • Removed node-fetch and its types from /scripts/package.json
  • Removed node-fetch import from /scripts/release/is-version-published.ts

10 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

@valentinpalkovic valentinpalkovic merged commit 640415d into storybookjs:next Jul 3, 2024
47 of 49 checks passed
@github-actions github-actions bot mentioned this pull request Jul 3, 2024
5 tasks
@yk-kd yk-kd deleted the update-node-fetch branch July 3, 2024 14:49
@valentinpalkovic valentinpalkovic removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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