Adds streaming HTMLRewriter content docs and changelog #19578
Merged
Conversation
This file contains hidden or 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
mikenomitch
requested review from
a team,
ToriLindsay,
elithrar,
irvinebroque,
jasnell,
jonesphillip and
rita3ko
as code owners
npaun
approved these changes
Jan 30, 2025
irvinebroque
approved these changes
Jan 30, 2025
|
|
||
| import { Render, TypeScriptExample } from "~/components"; | ||
|
|
||
| [`HTMLRewriter`](/workers/runtime-apis/html-rewriter) now supports replacing HTML with content from a stream. |
Contributor
There was a problem hiding this comment.
speak 2nd person — you can now...
|
|
||
| [`HTMLRewriter`](/workers/runtime-apis/html-rewriter) now supports replacing HTML with content from a stream. | ||
|
|
||
| This allows you to process HTML more efficiently, as content does not have to be loaded into memory before replacements are made. |
Contributor
Author
There was a problem hiding this comment.
I think it's just before because you would've await'd response.body previously, then passed in the string
src/content/changelogs-next/2025-02-03-html-rewriter-streaming.mdx
Outdated
Show resolved
Hide resolved
Contributor
irvinebroque
left a comment
irvinebroque
left a comment
There was a problem hiding this comment.
Think we can do a bit more here to speak directly to use case
ex:
- I have some site, some origin
- I have a Worker in front
- In my Worker, I need to transform the HTML response — for example, I need to insert a
<script>tag into the page - Before — I had to fetch the entire response object from the origin, and only after getting the whole response, I could pass that response into
HTMLRewriter. This made things slower, because it prevented streaming the bytes of the response back to the client, as I receive them from the origin - After — I can pass the response directly in, and HTMLRewriter can immediately start parsing and handling rewriting content as it receives bytes of the response, and stream that back to the client immediately
github-actions
bot
assigned
elithrar,
irvinebroque,
jonesphillip,
rita3ko,
GregBrimble,
jasnell and
ToriLindsay
Deploying cloudflare-docs with
|
| Latest commit: |
3dcbcaf
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://326df2ed.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://mnomitch-streaming-html-rewr.cloudflare-docs-7ou.pages.dev |
Contributor
|
Files with changes (up to 15)
|
Contributor
Author
|
@irvinebroque - gave it another pass |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
9 participants
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
Adds documentation and a changelog for recent updates to HTMLRewriter that allow for streamed content.