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

Switch to capnp-es #7788

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Switch to capnp-es #7788

wants to merge 11 commits into from

Conversation

penalosa
Copy link
Contributor

@penalosa penalosa commented Jan 15, 2025 •
edited
Loading

The capnp-ts dependency we use for Miniflare (and for type generation in workerd for constructing and reading the capnp format for the runtime) is blocking workerd upgrading TS versions to 5.7 (and will block Miniflare when we get around to upgrading—we're currently on 5.6). capnp-ts effectively abandoned and hasn't been touched in 4 years, so this PR switches us to use capnp-es. It's a followup to unjs/capnp-es#10.

  • Tests
    • TODO (before merge)
    • Tests included
    • Tests not necessary because: This change is covered by existing tests
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required
    • Not required because:
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Documentation not necessary because: internal packaging change

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jan 15, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: 95d7afb

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

This PR includes changesets to release 5 packages
Name Type
miniflare Patch
@cloudflare/pages-shared Patch
@cloudflare/vite-plugin Patch
@cloudflare/vitest-pool-workers Patch
wrangler 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 e2e Run e2e tests on a PR label Jan 20, 2025
@penalosa penalosa force-pushed the penalosa/use-capnp-es branch from 82f3c67 to 47ba5eb Compare January 20, 2025 19:54
@penalosa penalosa marked this pull request as ready for review January 20, 2025 19:55
@penalosa penalosa requested review from a team as code owners January 20, 2025 19:55
petebacondarwin
petebacondarwin reviewed Jan 20, 2025
View reviewed changes
packages/miniflare/package.json Outdated
@@ -30,8 +30,7 @@
"bootstrap.js"
],
"scripts": {
"build": "node scripts/build.mjs && pnpm run types:build",
"capnp:workerd": "capnpc -o ts src/runtime/config/workerd.capnp",
"build": "capnp-es node_modules/workerd/workerd.capnp -ots && mv node_modules/workerd/workerd.ts src/runtime/config/generated.ts && node scripts/build.mjs && pnpm run types:build",
Copy link
Contributor

Choose a reason for hiding this comment

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

Is mv going to work on Windows?

Generally it is better to put this stuff into a Node.js script I think

Copy link
Contributor Author

Choose a reason for hiding this comment

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

c1e6afe

petebacondarwin
petebacondarwin approved these changes Jan 20, 2025
View reviewed changes
Copy link
Contributor

@petebacondarwin petebacondarwin left a comment

Choose a reason for hiding this comment

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

Assuming all the CI checks pass!

packages/miniflare/src/plugins/assets/index.ts
const hashBuffer = await crypto.subtle.digest("SHA-256", data.buffer);
const hashBuffer = await crypto.subtle.digest(
"SHA-256",
data.buffer as ArrayBuffer
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this cast now necessary?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Part of this involved upgrading TS to 5.7 from 5.6 for the Miniflare package—I can probably remove that, but it was causing some issues with capnp-es

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 20, 2025 •
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/12893285713/npm-package-wrangler-7788

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12893285713/npm-package-wrangler-7788 dev path/to/script.js
Additional artifacts:

cloudflare-workers-bindings-extension:

wget https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12893285713/npm-package-cloudflare-workers-bindings-extension-7788 -O ./cloudflare-workers-bindings-extension.0.0.0-vcdbc26e2d.vsix && code --install-extension ./cloudflare-workers-bindings-extension.0.0.0-vcdbc26e2d.vsix

create-cloudflare:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12893285713/npm-package-create-cloudflare-7788 --no-auto-update

@cloudflare/kv-asset-handler:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12893285713/npm-package-cloudflare-kv-asset-handler-7788

miniflare:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12893285713/npm-package-miniflare-7788

@cloudflare/pages-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12893285713/npm-package-cloudflare-pages-shared-7788

@cloudflare/unenv-preset:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12893285713/npm-package-cloudflare-unenv-preset-7788

@cloudflare/vite-plugin:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12893285713/npm-package-cloudflare-vite-plugin-7788

@cloudflare/vitest-pool-workers:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12893285713/npm-package-cloudflare-vitest-pool-workers-7788

@cloudflare/workers-editor-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12893285713/npm-package-cloudflare-workers-editor-shared-7788

@cloudflare/workers-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12893285713/npm-package-cloudflare-workers-shared-7788

@cloudflare/workflows-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/12893285713/npm-package-cloudflare-workflows-shared-7788

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.20241230.2
workerd 1.20241230.0 1.20241230.0
workerd --version 1.20241230.0 2024-12-30

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

@penalosa penalosa force-pushed the penalosa/use-capnp-es branch from 8e9d944 to 95d7afb Compare January 21, 2025 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@petebacondarwin petebacondarwin petebacondarwin approved these changes

Assignees
No one assigned
Labels
e2e Run e2e tests on a PR
Projects
workers-sdk
Status: Approved
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@penalosa @petebacondarwin