Merge pull request #230 from jfhbrook/revert-228-brotli-encoding

Revert "Add support for brotli encoding"

Author: jfhbrook

README.md

@@ -97,7 +97,6 @@ const opts = {
   cache: 'max-age=3600',
   cors: false,
   gzip: true,
-  brotli: false,
   defaultExt: 'html',
   handleError: true,
   serverHeader: true,
@@ -210,16 +209,6 @@ that the behavior is appropriate. If `./public/some-file.js.gz` is not valid
 gzip, this will fall back to `./public/some-file.js`. You can turn this off
 with `opts.gzip === false`.
 
-### `opts.brotli`
-### `--brotli`
-
-Serve `./public/some-file.js.br` in place of `./public/some-file.js` when the 
-[brotli encoded](https://github.com/google/brotli) version exists and ecstatic 
-determines that the behavior is appropriate. If the request does not contain 
-`br` in the HTTP `accept-encoding` header, ecstatic will instead attempt to 
-serve a gzipped version (if `opts.gzip` is `true`), or fall back to 
-`./public.some-file.js`. Defaults to **false**.
-
 ### `opts.serverHeader`
 ### `--no-server-header`
 

lib/ecstatic.js

@@ -32,7 +32,7 @@ function decodePathname(pathname) {
 
 
 // Check to see if we should try to compress a file with gzip.
-function shouldCompressGzip(req) {
+function shouldCompress(req) {
   const headers = req.headers;
 
   return headers && headers['accept-encoding'] &&
@@ -42,16 +42,6 @@ function shouldCompressGzip(req) {
     ;
 }
 
-function shouldCompressBrotli(req) {
-  const headers = req.headers;
-
-  return headers && headers['accept-encoding'] &&
-    headers['accept-encoding']
-    .split(',')
-    .some(el => ['*', 'br'].indexOf(el.trim()) !== -1)
-  ;
-}
-
 function hasGzipId12(gzipped, cb) {
   const stream = fs.createReadStream(gzipped, { start: 0, end: 1 });
   let buffer = Buffer('');
@@ -176,8 +166,7 @@ module.exports = function createMiddleware(_dir, _options) {
     const parsed = url.parse(req.url);
     let pathname = null;
     let file = null;
-    let gzippedFile = null;
-    let brotliFile = null;
+    let gzipped = null;
 
     // Strip any null bytes from the url
     // This was at one point necessary because of an old bug in url.parse
@@ -209,9 +198,7 @@ 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`;
+    gzipped = `${file}.gz`;
 
     if (serverHeader !== false) {
       // Set common headers.
@@ -242,7 +229,7 @@ module.exports = function createMiddleware(_dir, _options) {
 
     function serve(stat) {
       // Do a MIME lookup, fall back to octet-stream and handle gzip
-      // and brotli special case.
+      // special case.
       const defaultType = opts.contentType || 'application/octet-stream';
       let contentType = mime.lookup(file, defaultType);
       let charSet;
@@ -251,21 +238,19 @@ module.exports = function createMiddleware(_dir, _options) {
       const etag = generateEtag(stat, weakEtags);
       let cacheControl = cache;
       let stream = null;
+
       if (contentType) {
         charSet = mime.charsets.lookup(contentType, 'utf-8');
         if (charSet) {
           contentType += `; charset=${charSet}`;
         }
       }
 
-      if (file === gzippedFile) { // is .gz picked up
+      if (file === gzipped) { // is .gz picked up
         res.setHeader('Content-Encoding', 'gzip');
+
         // strip gz ending and lookup mime type
         contentType = mime.lookup(path.basename(file, '.gz'), defaultType);
-      } else if (file === brotliFile) { // is .br picked up
-        res.setHeader('Content-Encoding', 'br');
-        // strip br ending and lookup mime type
-        contentType = mime.lookup(path.basename(file, '.br'), defaultType);
       }
 
       if (typeof cacheControl === 'function') {
@@ -416,13 +401,13 @@ module.exports = function createMiddleware(_dir, _options) {
       });
     }
 
-    // serve gzip file if exists and is valid
-    function tryServeWithGzip() {
-      fs.stat(gzippedFile, (err, stat) => {
+    // Look for a gzipped file if this is turned on
+    if (opts.gzip && shouldCompress(req)) {
+      fs.stat(gzipped, (err, stat) => {
         if (!err && stat.isFile()) {
-          hasGzipId12(gzippedFile, (gzipErr, isGzip) => {
+          hasGzipId12(gzipped, (gzipErr, isGzip) => {
             if (!gzipErr && isGzip) {
-              file = gzippedFile;
+              file = gzipped;
               serve(stat);
             } else {
               statFile();
@@ -432,29 +417,6 @@ module.exports = function createMiddleware(_dir, _options) {
           statFile();
         }
       });
-    }
-
-    // serve brotli file if exists, otherwise try gzip
-    function tryServeWithBrotli(shouldTryGzip) {
-      fs.stat(brotliFile, (err, stat) => {
-        if (!err && stat.isFile()) {
-          file = brotliFile;
-          serve(stat);
-        } else if (shouldTryGzip) {
-          tryServeWithGzip();
-        } else {
-          statFile();
-        }
-      });
-    }
-
-    const shouldTryBrotli = opts.brotli && shouldCompressBrotli(req);
-    const shouldTryGzip = opts.gzip && shouldCompressGzip(req);
-    // always try brotli first, next try gzip, finally serve without compression
-    if (shouldTryBrotli) {
-      tryServeWithBrotli(shouldTryGzip);
-    } else if (shouldTryGzip) {
-      tryServeWithGzip();
     } else {
       statFile();
     }

lib/ecstatic/defaults.json

@@ -8,7 +8,6 @@
   "cache": "max-age=3600",
   "cors": false,
   "gzip": true,
-  "brotli": false,
   "defaultExt": ".html",
   "handleError": true,
   "serverHeader": true,

lib/ecstatic/opts.js

@@ -14,7 +14,6 @@ module.exports = (opts) => {
   let si = defaults.si;
   let cache = defaults.cache;
   let gzip = defaults.gzip;
-  let brotli = defaults.brotli;
   let defaultExt = defaults.defaultExt;
   let handleError = defaults.handleError;
   const headers = {};
@@ -106,10 +105,6 @@ module.exports = (opts) => {
       gzip = opts.gzip;
     }
 
-    if (typeof opts.brotli !== 'undefined' && opts.brotli !== null) {
-      brotli = opts.brotli;
-    }
-
     aliases.handleError.some((k) => {
       if (isDeclared(k)) {
         handleError = opts[k];
@@ -200,7 +195,6 @@ module.exports = (opts) => {
     defaultExt,
     baseDir: (opts && opts.baseDir) || '/',
     gzip,
-    brotli,
     handleError,
     headers,
     serverHeader,