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

Chore: Improve varous aspects of sandbox creation #28965

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

Conversation

tobiasdiez
Copy link
Contributor

@tobiasdiez tobiasdiez commented Aug 23, 2024

What I did

While working on the Nuxt Sandbox, I've encountered a few issues - and these are fixed with this PR.
Namely,

  • Copying the temporary sandbox to the storybook folder doesn't work if the code is checked out in a different partition than where the system puts temp files (fs.move only works on the same partition; while fs.copy works also accross partitions)
  • On Windows, the Yarn config steps failed due to using touch and due to a strange formatting error (I'm aware that offically WSL is recommended, but that was actualyl the only error I've encountered using Windows directly)
  • This error during the yarn setup was never shown, which made debugging this a bit hard.
  • The docs mentioned an outdated file where the sandbox should be configured.

All of these points are adressed, each one in their own commit.

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>

Greptile Summary

This PR improves various aspects of sandbox creation in Storybook, addressing cross-platform compatibility issues and enhancing error handling.

  • Updated docs/contribute/code.mdx with correct file path for sandbox templates
  • Modified scripts/sandbox/generate.ts to use copy instead of rename for cross-partition compatibility
  • Improved scripts/sandbox/utils/yarn.ts for Windows compatibility by replacing touch with fs.writeFileSync()
  • Updated Yarn configuration in scripts/utils/yarn.ts to use string format for unsafeHttpWhitelist

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.

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

@@ -21,7 +22,7 @@ export async function setupYarn({ cwd, pnp = false, version = 'classic' }: Setup

export async function localizeYarnConfigFiles(baseDir: string, beforeDir: string) {
await Promise.allSettled([
runCommand(`touch yarn.lock`, { cwd: beforeDir }),
fs.writeFileSync(join(beforeDir, 'yarn.lock'), '', { flag: 'a' }),
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Ensure this operation is wrapped in a try-catch block to handle potential file system errors

Copy link

nx-cloud bot commented Aug 23, 2024

☁️ Nx Cloud Report

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

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