Skip to content

Add handling of brotli/gzip pre-compressed files #923

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 22, 2025
Merged

Add handling of brotli/gzip pre-compressed files #923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e8c143
Add handling of brotli/gzip pre-compressed files
azeitler Aug 30, 2025
8a014cf
Bump version from 14.1.1 to 14.1.2
azeitler Aug 30, 2025
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
6 changes: 3 additions & 3 deletions lib/core/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,9 @@ module.exports = function createMiddleware(_dir, _options) {
path.relative(path.join('/', baseDir), pathname)
)
);
// determine compressed forms if they were to exist
gzippedFile = `${file}.gz`;
brotliFile = `${file}.br`;
// determine compressed forms if they were to exist, make sure to handle pre-compressed files, i.e. files with .br/.gz extension. we will serve them "as-is"
gzippedFile = file.endsWith('gz') ? file : `${file}.gz`;
brotliFile = file.endsWith('br') ? file : `${file}.br`;
Comment on lines +204 to +205
Copy link
Contributor

Choose a reason for hiding this comment

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

Careful! We need to check for the dot (.) in the file extension too. A common format for comicbook archives (.cbr) also passes .endsWith('br') and would be sent with the header for brotli encoding. I tested this myself and it results in an error in my browser.

Suggested change
gzippedFile = file.endsWith('gz') ? file : `${file}.gz`;
brotliFile = file.endsWith('br') ? file : `${file}.br`;
gzippedFile = file.endsWith('.gz') ? file : `${file}.gz`;
brotliFile = file.endsWith('.br') ? file : `${file}.br`;


Object.keys(headers).forEach((key) => {
res.setHeader(key, headers[key]);
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "http-server",
"version": "14.1.1",
"version": "14.1.2",
"description": "A simple zero-configuration command-line http server",
"main": "./lib/http-server",
"repository": {
Expand Down