feat(miniflare): Implement KV/Assets plugin and Workers Assets simulator by CarmenPopoviciu · Pull Request #6403 · cloudflare/workers-sdk

CarmenPopoviciu · 2024-08-02T10:20:26Z

What this PR solves / how to test

This commit extends Miniflare's KV plugin's behaviour to support Workers assets, and therefore enables the emulation of Workers with assets in local development.

Fixes WC-2394

Author has addressed the following

Tests
- TODO (before merge)
- Included
- Not necessary because:
E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
- I don't know
- Required / Maybe required
- Not required because: miniflare changes
Changeset (Changeset guidelines)
- TODO (before merge)
- Included
- Not necessary because:
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s):
- Not necessary because: experimental feature

changeset-bot · 2024-08-02T10:20:31Z

🦋 Changeset detected

Latest commit: 9c0098e

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

This PR includes changesets to release 5 packages

Name	Type
miniflare	Minor
@cloudflare/workers-shared	Minor
@cloudflare/pages-shared	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

github-actions · 2024-08-02T10:22:52Z

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/10401949551/npm-package-wrangler-6403

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10401949551/npm-package-wrangler-6403 dev path/to/script.js

Additional artifacts:

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

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

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

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

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

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

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

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

wrangler@3.71.0 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.

packages/miniflare/src/plugins/kv/assets.ts

packages/miniflare/src/plugins/kv/index.ts

packages/miniflare/src/workers/kv/assets.worker.ts

packages/miniflare/test/fixtures/assets/modules.ts

packages/miniflare/src/plugins/kv/index.ts

.changeset/eight-terms-beg.md

fixtures/workers-with-assets/tests/index.test.ts

packages/miniflare/README.md

packages/miniflare/src/plugins/kv/assets.ts

packages/workers-shared/asset-server-worker/src/index.ts

packages/miniflare/test/plugins/kv/assets.spec.ts

packages/miniflare/src/workers/kv/assets.worker.ts

packages/miniflare/src/plugins/kv/assets.ts

packages/miniflare/test/plugins/kv/assets.spec.ts

packages/miniflare/src/plugins/kv/assets.ts

packages/miniflare/README.md

packages/miniflare/src/plugins/kv/assets.ts

packages/miniflare/src/workers/kv/constants.ts

packages/wrangler/src/dev/miniflare.ts

packages/workers-shared/asset-server-worker/src/index.ts

packages/miniflare/src/workers/kv/assets.worker.ts

CarmenPopoviciu · 2024-08-14T16:30:09Z

@petebacondarwin this is ready to re-review

petebacondarwin

Let's get this in and iterate next week.

packages/miniflare/src/plugins/kv/assets.ts

This commit adds a new KV/Assets plugin and an Assets Worker in Miniflare, that are meant to emulate Workers with Assets in local development.

CarmenPopoviciu force-pushed the carmen/dev-with-assets branch 2 times, most recently from 04d2d43 to 909d11f Compare August 5, 2024 08:56

CarmenPopoviciu marked this pull request as ready for review August 5, 2024 08:57

CarmenPopoviciu requested a review from a team as a code owner August 5, 2024 08:57

CarmenPopoviciu commented Aug 5, 2024

View reviewed changes

packages/miniflare/src/plugins/kv/assets.ts Outdated Show resolved Hide resolved

CarmenPopoviciu commented Aug 5, 2024

View reviewed changes

packages/miniflare/src/plugins/kv/index.ts Outdated Show resolved Hide resolved

CarmenPopoviciu commented Aug 5, 2024

View reviewed changes

packages/miniflare/src/workers/kv/assets.worker.ts Outdated Show resolved Hide resolved

CarmenPopoviciu commented Aug 5, 2024

View reviewed changes

packages/miniflare/test/fixtures/assets/modules.ts Outdated Show resolved Hide resolved

CarmenPopoviciu force-pushed the carmen/dev-with-assets branch from 909d11f to 7b670cb Compare August 5, 2024 11:35

CarmenPopoviciu commented Aug 5, 2024

View reviewed changes

packages/miniflare/src/plugins/kv/index.ts Outdated Show resolved Hide resolved

CarmenPopoviciu force-pushed the carmen/dev-with-assets branch 4 times, most recently from 13c9577 to 28e2453 Compare August 6, 2024 07:30

petebacondarwin requested changes Aug 6, 2024

View reviewed changes

CarmenPopoviciu commented Aug 8, 2024

View reviewed changes

packages/miniflare/test/plugins/kv/assets.spec.ts Outdated Show resolved Hide resolved

CarmenPopoviciu force-pushed the carmen/dev-with-assets branch from 28e2453 to 83ce8a3 Compare August 12, 2024 18:02

CarmenPopoviciu commented Aug 12, 2024

View reviewed changes

packages/miniflare/src/plugins/kv/assets.ts Outdated Show resolved Hide resolved

CarmenPopoviciu commented Aug 12, 2024

View reviewed changes

packages/miniflare/src/plugins/kv/assets.ts Outdated Show resolved Hide resolved

CarmenPopoviciu force-pushed the carmen/dev-with-assets branch from 83ce8a3 to 68f31f1 Compare August 12, 2024 18:10

CarmenPopoviciu commented Aug 12, 2024

View reviewed changes

packages/miniflare/README.md Outdated Show resolved Hide resolved

CarmenPopoviciu force-pushed the carmen/dev-with-assets branch 3 times, most recently from 3d31814 to 72bd983 Compare August 12, 2024 20:54

petebacondarwin reviewed Aug 13, 2024

View reviewed changes

CarmenPopoviciu force-pushed the carmen/dev-with-assets branch 3 times, most recently from 5510317 to 9af15dc Compare August 14, 2024 16:03

CarmenPopoviciu force-pushed the carmen/dev-with-assets branch from 9af15dc to badc4d9 Compare August 14, 2024 16:26

petebacondarwin approved these changes Aug 15, 2024

View reviewed changes

packages/miniflare/src/plugins/kv/assets.ts Outdated Show resolved Hide resolved

packages/miniflare/src/plugins/kv/assets.ts Outdated Show resolved Hide resolved

CarmenPopoviciu force-pushed the carmen/dev-with-assets branch from badc4d9 to f53cf10 Compare August 15, 2024 09:30

feat(miniflare): Implement KV/Assets plugin and Workers Assets simulator

9c0098e

This commit adds a new KV/Assets plugin and an Assets Worker in Miniflare, that are meant to emulate Workers with Assets in local development.

CarmenPopoviciu force-pushed the carmen/dev-with-assets branch from f53cf10 to 9c0098e Compare August 15, 2024 09:43

CarmenPopoviciu merged commit 00f340f into main Aug 15, 2024

CarmenPopoviciu deleted the carmen/dev-with-assets branch August 15, 2024 11:15

workers-devprod mentioned this pull request Aug 15, 2024

Version Packages #6490

Merged

This was referenced Aug 17, 2024

[Snyk] Upgrade @cloudflare/kv-asset-handler from 0.1.3 to 0.3.4 mightysai1997/remix#4

Open

[Snyk] Upgrade @cloudflare/kv-asset-handler from 0.1.3 to 0.3.4 mightysai1997/remix#5

Open

Conversation

CarmenPopoviciu commented Aug 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR solves / how to test

Author has addressed the following

Uh oh!

changeset-bot bot commented Aug 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Aug 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CarmenPopoviciu commented Aug 14, 2024

Uh oh!

petebacondarwin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CarmenPopoviciu commented Aug 2, 2024 •

edited

Loading

changeset-bot bot commented Aug 2, 2024 •

edited

Loading

github-actions bot commented Aug 2, 2024 •

edited

Loading