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.

Sign up for GitHub

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

Jump to bottom

Publish shared utilities for the online editing experience #6446

Merged
merged 16 commits into from
Aug 9, 2024
Merged

Publish shared utilities for the online editing experience #6446

merged 16 commits into from
Aug 9, 2024

Conversation

penalosa
Copy link
Contributor

@penalosa penalosa commented Aug 8, 2024 •
edited
Loading

What this PR solves / how to test

Scaffolding & initial work for https://jira.cfdata.org/browse/DEVX-1309. This PR exposes a new package @cloudflare/workers-editor-shared which will be used to power the Workers Playground and Quick Edit. It also refactors the Workers Playground to depend on this new package.

See https://github.com/cloudflare/wrangler2/blob/penalosa/shared-editor/packages/workers-playground/README.md for instructions on running the Playground locally.

Author has addressed the following

  • Tests
    • TODO (before merge)
    • Included
    • Not necessary because: This code is currently only tested manually
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required / Maybe required
    • Not required because: This code is currently only tested manually
  • Changeset (Changeset guidelines)
    • TODO (before merge)
    • Included
    • Not necessary because:
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Not necessary because: New package intended for internal use

@penalosa penalosa requested a review from a team as a code owner August 8, 2024 14:39
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Aug 8, 2024 •
edited
Loading

🦋 Changeset detected

Latest commit: e04dca8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@cloudflare/workers-editor-shared Minor
workers-playground Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@penalosa penalosa added the preview:workers-playground Trigger a workers playground preview deploy label Aug 8, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 8, 2024 •
edited
Loading

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10319513760/npm-package-wrangler-6446

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/6446/npm-package-wrangler-6446

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10319513760/npm-package-wrangler-6446 dev path/to/script.js
Additional artifacts: 
npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10319513760/npm-package-create-cloudflare-6446 --no-auto-update
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10319513760/npm-package-cloudflare-kv-asset-handler-6446
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10319513760/npm-package-miniflare-6446
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10319513760/npm-package-cloudflare-pages-shared-6446
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10319513760/npm-package-cloudflare-vitest-pool-workers-6446
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10319513760/npm-package-cloudflare-workers-editor-shared-6446
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10319513760/npm-package-cloudflare-workers-shared-6446

Note that these links will no longer work once the GitHub Actions artifact expires.

[email protected] includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20240806.0
workerd 1.20240806.0 1.20240806.0
workerd --version 1.20240806.0 2024-08-06

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

andyjessop
andyjessop reviewed Aug 9, 2024
View reviewed changes
Copy link
Contributor

@andyjessop andyjessop left a comment

Choose a reason for hiding this comment

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

This is a nice improvement!

packages/workers-editor-shared/package.json
@@ -0,0 +1,60 @@
{
"name": "@cloudflare/workers-editor-shared",
"version": "0.0.15",
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be 0.1.0 instead of 0.0.15?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

At this stage it's pretty arbitrary. Once merged changesets will take over, and in particular the first public release will be 0.1.0 (given the changeset file in this PR).

packages/workers-editor-shared/vite.config.ts Outdated Show resolved Hide resolved
packages/workers-editor-shared/tsconfig.json Outdated Show resolved Hide resolved
packages/workers-editor-shared/lib/useInjectSources.tsx Show resolved Hide resolved
packages/workers-playground/src/QuickEditor/HTTPTab/ResponseView.tsx Show resolved Hide resolved
@penalosa penalosa force-pushed the penalosa/shared-editor branch from 4ef6a36 to 719e124 Compare August 9, 2024 10:08
andyjessop
andyjessop approved these changes Aug 9, 2024
View reviewed changes
Copy link
Contributor

@andyjessop andyjessop left a comment

Choose a reason for hiding this comment

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

LGTM!

andyjessop
andyjessop reviewed Aug 9, 2024
View reviewed changes
packages/workers-editor-shared/lib/useInjectSources.tsx
* an iframe which renders the `format-errors` worker. It will construct the `MessageChannel`
* & `MessagePort`s appropriately to construct the right messages for inflating the `format-errors`
* stack traces: https://github.com/cloudflare/workers-sdk/tree/main/packages/format-errors/README.md#L28
*/
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

@penalosa penalosa merged commit d2b7482 into main Aug 9, 2024
18 checks passed
@penalosa penalosa deleted the penalosa/shared-editor branch August 9, 2024 14:02
@workers-devprod workers-devprod mentioned this pull request Aug 9, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andyjessop andyjessop andyjessop approved these changes

@edmundhung edmundhung Awaiting requested review from edmundhung

Assignees
No one assigned
Labels
preview:workers-playground Trigger a workers playground preview deploy
Projects
workers-sdk
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@penalosa @andyjessop @edmundhung