Add Miniflare/startWorker() + node:test tutorial
#19254
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying cloudflare-docs with
|
| Latest commit: |
bf3abd8
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://e65f1bc6.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://penalosa-improve-testing-doc.cloudflare-docs-7ou.pages.dev |
node:test tutorialnode:test tutorial
edmundhung
reviewed
Jan 20, 2025
edmundhung
approved these changes
Jan 21, 2025
irvinebroque
approved these changes
Jan 21, 2025
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
emily-shen
reviewed
Jan 21, 2025
| When using the [Vitest integration](/workers/testing/vitest-integration/), your entire test suite runs in [`workerd`](https://github.com/cloudflare/workerd), which is why it's possible to unit test individual functions. By contrast, when using a different testing framework to run tests via Miniflare, only your Worker itself is running in [`workerd`](https://github.com/cloudflare/workerd)—your test files run in Node.js. This means that importing functions from your Worker into your test files might exhibit different behaviour than you'd see at runtime if the functions rely on `workerd`-specific behaviour. | ||
| </Details> | ||
|
|
||
| ## Interacting with Bindings |
There was a problem hiding this comment.
Maybe this is already sufficiently obvious, but could be worth noting (somewhere on this page) that all bindings specified in your wrangler config file have to be passed into Miniflare's config options. (And mention that these could be mocked, even if there isn't an example for now - I see you opened an issue to track that for later)
There was a problem hiding this comment.
I'll add that in a followup PR
|
Preview URL: https://3a175b86.preview.developers.cloudflare.com Files with changes (up to 15)
|
ToriLindsay
approved these changes
Feb 11, 2025
Co-authored-by: ToriLindsay <tgalatro@cloudflare.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a tutorial for how to test using Miniflare &
node:test. Still to come, a tutorial for how to test usingstartWorker()andnode:test.Documentation checklist