feat(assets-sync): add assets.toml content-type overrides#64
Draft
lwshang wants to merge 2 commits into
Draft
Conversation
New plugin-side config file (passed via `SyncExecInput.files`) lets
users override asset content-type by glob pattern:
[[asset]]
match = "/*.md"
content_type = "text/markdown; charset=utf-8"
Resolution walks `[[asset]]` blocks in declaration order — first
matching `content_type` wins; falls back to `mime_guess::from_path`
otherwise. The override is applied in `prepare_asset` before
`encoders_for` runs, so a `.did` declared as `text/plain` also picks
up gzip compression and stores the right type for cert-tree drift
detection. Result feeds `CreateAssetArguments.content_type` so the
canister emits exactly one `Content-Type` in the certified response —
closes the duplicate-header pitfall of the legacy `.ic-assets.json5`
`headers.Content-Type` workaround.
Also lifts `HeaderPattern` from `headers.rs` into a shared
`KeyPattern` in `glob.rs` since both `_headers` rules and
`assets.toml` blocks match against asset keys with the same dialect.
Pure refactor; `_headers` semantics unchanged.
Strict v1 schema: `#[serde(deny_unknown_fields)]` on both the top
level and per-block — typo protection beats forward compat for an
unreleased plugin. The standard filename `assets.toml` is convention,
not enforced — the manifest's `files:` field is the authoritative
declaration of which file is the asset config.
Design rationale and parked open questions in `ASSETS-TOML.md`.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Two scenarios on a fixture that mirrors the developer-docs case: 1. `content_type_overrides_land_on_canister` — deploy with overrides for `/*.did`, `/*.sh`, `/llms.txt` and verify the HTTP gateway returns the configured `Content-Type` exactly (proves the override survived certification, since the gateway validates the `IC-Certificate` before responding). 2. `content_type_edit_propagates_on_redeploy` — flip an override and redeploy without changing the asset bytes; verify the new `Content-Type` reaches clients (proves drift detection triggers delete-then-recreate when content-type changes). Also documents the feature in the top-level README under "Per-glob content-type overrides" and refreshes the `_headers` paragraph to mention the now-supported glob syntax (`/*.md`, mid-path wildcards). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 (what this PR would have done)
Added an opt-in
assets.tomlconfig file (passed inline via the manifest'sfiles:field) that let users override an asset'sContent-Typeby glob pattern. v1 scoped to this one field; broader[[asset]]knobs (ignore,encodings,allow_raw_access) were sketched inASSETS-TOML.mdfor follow-ups.Replaced by #66 which expresses the same overrides inside
_headers(e.g./*.did\n Content-Type: text/plain; charset=utf-8). The plugin extractsContent-Typefrom_headersand routes it intoCreateAssetArguments.content_typeso the canister still emits exactly one certifiedContent-Typeper response.🤖 Generated with Claude Code