Why Download Filenames Break with Non-ASCII Characters
Debug broken downloaded filenames caused by Content-Disposition encoding, browser differences, URL encoding and fallback filename handling.
Quick Answer
Download filenames break with non-ASCII characters when Content-Disposition is encoded incorrectly, filename and filename* disagree, proxies rewrite headers, or browsers choose different fallbacks. Use RFC-compatible filename* encoding and test real browsers.
Example Scenario
A generated CSV downloads as report.csv in English but becomes garbled for a filename containing Chinese, accents or spaces. The file content is correct; only the browser-selected filename is wrong.
Step-by-Step Explanation
- Inspect the Content-Disposition response header.
- Check filename and filename* parameters.
- Verify percent encoding and UTF-8 handling.
- Test browser behavior instead of assuming one client.
- Avoid user-controlled unsafe filename characters.
- Provide an ASCII fallback where needed.
Start by Naming the Contract That Broke
Download filenames break with non-ASCII characters when header encoding is ambiguous or rewritten. Debugging is slower when every symptom is treated as a generic API failure. Name the contract first: request shape, response shape, retry behavior, file type, time zone, numeric precision, logging policy or delivery semantics. Once the contract is named, each observation has a place to belong.
The most useful first signal is usually file content is correct but saved filename is garbled. It tells you which boundary produced the failure and prevents the team from rewriting unrelated client code. Keep the original request, response or log line available while you investigate.
A good working note should say what was expected, what actually happened and which layer observed it. That note is more valuable than a screenshot of a stack trace because it can be compared with documentation, tests and production logs.
If the issue is intermittent, keep one failing sample and one passing sample from the same release window. The passing sample prevents overfitting the fix to one user, while the failing sample keeps the investigation grounded in evidence instead of guesses about the system.
Separate Symptoms from Evidence
The visible symptom may be Content-Disposition differs between origin and browser response, but the evidence should be more precise. Capture the exact Content-Disposition header and the saved filename chosen by the browser, then compare it with a successful case from the same environment. Environment, user role and feature flag differences can otherwise look like code regressions.
Avoid starting with broad fixes. First check whether filename* uses UTF-8 percent encoding with a safe ASCII fallback. If that detail differs from the healthy request, you have a concrete lead. If it matches, move to the next layer instead of guessing.
When multiple teams are involved, preserve the raw evidence in a safe form. Redact secrets, but keep field names, status codes, headers, timestamps and request ids. Sanitized evidence still lets another team reproduce the reasoning.
Look for Boundary Translation Errors
Many production bugs happen when data crosses a boundary and changes meaning. A browser form, generated client, proxy, queue worker, database mapper or logging pipeline can transform the value before the final system sees it.
For this issue, inspect proxy or CDN header transformations between origin and client, including any header normalization added by security middleware. That is where small differences usually become visible. A value may still look reasonable to a human while failing the receiver's stricter expectation.
Use comparison tools when the payload is large. Diff the failing sample against a known-good sample, then reduce it to the smallest input that still fails. A minimal failing sample turns a vague incident into a contract discussion.
Boundary errors also need ownership clarity. Decide which component is allowed to transform the value and which component must reject it. Without that decision, every layer may add a small compatibility patch, and the system becomes harder to reason about after the incident.
Choose a Fix That Matches the Failure Mode
The first safe fix is often sending both safe ASCII fallback and UTF-8 filename*. It addresses the observed boundary instead of hiding the symptom. If the problem is a contract mismatch, the fix should update the producer, consumer or documented contract deliberately.
The second fix to consider is sanitizing filename characters before header creation. This is useful when old clients, partner integrations or delayed deployments mean two shapes must be accepted for a short time. Compatibility should be explicit and temporary where possible.
A third option is testing browser download behavior with real non-ASCII examples. Use this when the system needs better operational visibility before making a behavioral change. Good diagnostics can prevent a small correction from becoming a larger regression.
Keep Production Diagnostics Safe
Diagnostics should explain the failure without exposing sensitive data. For this topic, useful logs include request id, status code, safe field paths, environment and a short reason code. They should not include tokens, full personal records or secret payloads.
If the failure reaches support, include raw header, browser and selected filename captured together. That gives the next debugger a trail without requiring access to private customer data. It also helps separate one-off bad input from a systemic contract drift.
When adding logs, add deletion and retention awareness. Debug logs that are safe today can become risky if they accumulate raw payloads for months. Prefer structured fields over copied bodies.
A safe diagnostic should also be cheap to leave in place. If it requires developers to enable raw payload logging during every incident, the next emergency will recreate the same privacy and security risk. Prefer stable reason codes, counters and compact metadata that can remain active in production.
Prevention Checklist
Add a regression test for spaces, quotes, accents, CJK and emoji filename cases across desktop and mobile browsers. The test should fail when the boundary behavior changes unexpectedly. A small test around the contract is often more valuable than a broad snapshot that nobody reviews.
Review download headers during release with proxy and CDN behavior included during release. Many bugs in this category appear during rolling deploys, integration updates or data migrations, not during a clean local run.
Document which characters are allowed and how fallback names are generated. The goal is not a long policy page; it is a short, accurate rule that future developers can apply while changing the same path.
After the fix, replay the original failing case and one known-good case. If both behave correctly, record the evidence in the incident or changelog. This closes the loop and keeps the next investigation from starting over.
Code Examples
const name = '报告 2026.csv';
const encoded = encodeURIComponent(name);
console.log("attachment; filename=report.csv; filename*=UTF-8''" + encoded);const fallback = originalName.replace(/[^a-z0-9._-]/gi, '_');console.log({ requestId, contentDisposition, userAgent });Common Mistakes
- Putting raw non-ASCII text directly into filename.
- Forgetting an ASCII fallback.
- Testing only one browser.
- Letting proxies rewrite or strip download headers.
- Allowing slashes or control characters in filenames.
FAQ
Why does the file content work but filename fail?
Filename is chosen from headers and browser rules, separate from file bytes.
What is filename*?
A Content-Disposition parameter for encoded international filenames.
Should filenames be sanitized?
Yes. Remove unsafe path and control characters before sending headers.
Why test multiple browsers?
Download header handling can differ across browser versions and platforms.