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

Build: Always cleanup Verdaccio ports before running registry #30023

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

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Dec 11, 2024

Closes #

What I did

For years we had issues in the task command where the run-registry task would fail with:

🎬 starting verdaccio (this takes ±5 seconds, so be patient)
info --- plugin successfully loaded: verdaccio-auth-memory
node:events:496
      throw er; // Unhandled 'error' event
      ^

Error: listen EADDRINUSE: address already in use :::6001
    at Server.setupListenHandle [as _listen2] (node:net:1907:16)
    at listenInCluster (node:net:1964:12)
    at Server.listen (node:net:2066:7)
    at /Users/yannbraga/open-source/storybook/scripts/run-registry.ts:67:11
    at new Promise (<anonymous>)
    at startVerdaccio (/Users/yannbraga/open-source/storybook/scripts/run-registry.ts:38:3)
    at run (/Users/yannbraga/open-source/storybook/scripts/run-registry.ts:175:3)

This PR fixes that issue by killing the processes in the verdaccio ports before running the registry task

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-storybook/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>

Greptile Summary

Added port cleanup functionality to prevent Verdaccio server hanging issues by automatically killing processes on specific ports before starting the registry server.

  • Added scripts/utils/kill-port.ts utility to handle process termination on both Windows and Unix systems
  • Modified scripts/run-registry.ts to cleanup ports 6001 and 6002 before starting Verdaccio
  • Added error handling to ensure port cleanup happens even when registry startup fails
  • Extracted hardcoded port numbers into constants for better maintainability

@yannbf yannbf added build Internal-facing build tooling & test updates ci:normal labels Dec 11, 2024
@yannbf yannbf self-assigned this Dec 11, 2024
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.

2 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings | Greptile

scripts/utils/kill-port.ts Show resolved Hide resolved
scripts/utils/kill-port.ts Show resolved Hide resolved
Comment on lines 229 to 234
logger.error(e);
rm(join(root, '.npmrc'), { force: true }).then(() => {
process.exit(1);
cleanupVerdaccioProcesses().then(() => {
process.exit(1);
});
});
Copy link
Contributor

Choose a reason for hiding this comment

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

logic: error handling chain could fail silently if rm() or cleanupVerdaccioProcesses() rejects - should wrap in try/catch

scripts/utils/kill-port.ts Show resolved Hide resolved
Copy link

nx-cloud bot commented Dec 11, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit aefde6b. 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.

@yannbf yannbf force-pushed the yann/fix-verdaccio-hanging branch from ba94f06 to 89e2abe Compare December 11, 2024 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Internal-facing build tooling & test updates ci:normal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants