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

Core: Do not prebundle better-opn #29137

Merged
merged 1 commit into from
Sep 16, 2024
Merged

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Sep 16, 2024

Closes #29123

What I did

Do not prebundle better-opn since its binary osascript cannot be found.

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>

name before after diff z %
createSize 0 B 0 B 0 B - -
generateSize 77.3 MB 77.3 MB 0 B 0.49 0%
initSize 162 MB 163 MB 339 kB 1.63 0.2%
diffSize 85 MB 85.3 MB 339 kB 2.78 0.4%
buildSize 7.58 MB 7.58 MB 0 B 1.5 0%
buildSbAddonsSize 1.67 MB 1.67 MB 0 B 1.53 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 2.34 MB 2.34 MB 0 B 1.22 0%
buildSbPreviewSize 352 kB 352 kB 0 B 1 0%
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 4.55 MB 4.55 MB 0 B 1.53 0%
buildPreviewSize 3.02 MB 3.02 MB 0 B 1 0%
testBuildSize 0 B 0 B 0 B - -
testBuildSbAddonsSize 0 B 0 B 0 B - -
testBuildSbCommonSize 0 B 0 B 0 B - -
testBuildSbManagerSize 0 B 0 B 0 B - -
testBuildSbPreviewSize 0 B 0 B 0 B - -
testBuildStaticSize 0 B 0 B 0 B - -
testBuildPrebuildSize 0 B 0 B 0 B - -
testBuildPreviewSize 0 B 0 B 0 B - -
name before after diff z %
createTime 6.8s 23.2s 16.3s 1.73 🔺70.4%
generateTime 19.7s 21.1s 1.4s 0.16 6.6%
initTime 16.8s 16.7s -94ms -0.48 -0.6%
buildTime 11.9s 11.7s -134ms 0.11 -1.1%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 6.1s 7s 940ms 0.12 13.3%
devManagerResponsive 3.9s 4.6s 693ms 0.24 15%
devManagerHeaderVisible 693ms 744ms 51ms -0.57 6.9%
devManagerIndexVisible 725ms 777ms 52ms -0.59 6.7%
devStoryVisibleUncached 1s 1.3s 317ms 0.05 22.8%
devStoryVisible 724ms 776ms 52ms -0.6 6.7%
devAutodocsVisible 621ms 730ms 109ms 0.08 14.9%
devMDXVisible 621ms 763ms 142ms 0.35 18.6%
buildManagerHeaderVisible 736ms 733ms -3ms -0.34 -0.4%
buildManagerIndexVisible 767ms 806ms 39ms 0.14 4.8%
buildStoryVisible 768ms 804ms 36ms -0.15 4.5%
buildAutodocsVisible 603ms 640ms 37ms -0.75 5.8%
buildMDXVisible 594ms 659ms 65ms -0.36 9.9%

Greptile Summary

This PR moves the 'better-opn' package from devDependencies to dependencies in the @storybook/core package.json file to address an issue with missing scripts at runtime.

  • Moved 'better-opn' from devDependencies to dependencies in code/core/package.json
  • Addresses issue [Bug]: better-opn is bundled and therefore openChrome.applescript is missing. #29123 where 'openChrome.applescript' was missing due to bundling
  • Ensures 'better-opn' and its associated scripts are available at runtime
  • Improves reliability of browser opening functionality in Storybook
  • May affect package size and installation process for @storybook/core

@valentinpalkovic valentinpalkovic self-assigned this Sep 16, 2024
@valentinpalkovic valentinpalkovic added bug patch:yes Bugfix & documentation PR that need to be picked to main branch labels Sep 16, 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.

LGTM

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

Copy link

nx-cloud bot commented Sep 16, 2024

☁️ Nx Cloud Report

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

Sent with 💌 from NxCloud.

@shilman shilman merged commit 8e9d63b into next Sep 16, 2024
61 of 69 checks passed
@shilman shilman deleted the valentin/do-not-prebundle-better-opn branch September 16, 2024 15:53
storybook-bot pushed a commit that referenced this pull request Sep 16, 2024
…better-opn

Core: Do not prebundle better-opn
(cherry picked from commit 8e9d63b)
storybook-bot pushed a commit that referenced this pull request Sep 16, 2024
…better-opn

Core: Do not prebundle better-opn
(cherry picked from commit 8e9d63b)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal core patch:done Patch/release PRs already cherry-picked to main/release branch 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]: better-opn is bundled and therefore openChrome.applescript is missing.
2 participants