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.

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

Fix documentation to control caching for compressed range requests #11927

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion doc/admin-guide/plugins/compress.en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,9 @@ range-request
-------------

When set to ``true``, causes |TS| to compress responses to Range Requests.
Disabled by default. Setting this to true while setting cache to false leads to delivering corrupted content.
Disabled by default.

WARNING! Do NOT set this to true if cache is set to false. This combination will deliver corrupt content.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this really

 if :ts:cv:`proxy.config.http.cache.http` is set to false (0)

Copy link
Contributor

@masaori335 masaori335 Jan 9, 2025

Choose a reason for hiding this comment

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

This cache here is a configuration of compress plugin. https://docs.trafficserver.apache.org/en/10.0.x/admin-guide/plugins/compress.en.html#cache

Config like below generates corrupted content. ( compressed partial content with status code 200 OK )

cache false
range-request true

Also, I want to mention a thing, even if this cache config is true, and range-request is false like below,

cache true
range-request false

once compressed content is cached, response to the Range request will be "partial content of compressed contents", that's probably not what client want. Actually, intention and spec is unclear.

IMO, if a client send both of Accept-Encoding and Range header, we should choose one of them as a workaround. ( I'll file an issue and PR for this )

Copy link
Contributor

Choose a reason for hiding this comment

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

The second case, cache true and range-request false, is covered by #11975


compressible-content-type
-------------------------
Expand Down