feat: allow to track server timings

xing · Mar 12, 2018 · 31ee6ad · 31ee6ad
1 parent 3b29a96
commit 31ee6ad
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 24 deletions.
diff --git a/packages/build/lib/server.js b/packages/build/lib/server.js
@@ -23,6 +23,7 @@ process.on('unhandledRejection', function(error) {
 function runDevelop(options, callback) {
   var compiler = webpack(developConfig);
   var app = express();
+  app.use(hopsExpressUtils.timings);
   app.use(
     webpackDevMiddleware(compiler, {
       noInfo: true,

diff --git a/packages/config/README.md b/packages/config/README.md
diff --git a/packages/config/index.js b/packages/config/index.js
@@ -31,6 +31,7 @@ function applyDefaultConfig(config) {
       assetPath: '',
       workerPath: '<basePath>/sw.js',
       workerFile: null,
+      enableServerTimings: true,
       browsers: '> 1%, last 2 versions, Firefox ESR',
       node: 'current',
       envVars: { HOPS_MODE: 'dynamic' },

diff --git a/packages/express/lib/app.js b/packages/express/lib/app.js
@@ -15,6 +15,7 @@ var swRe = new RegExp(hopsConfig.workerPath + '$');
 
 function createApp(options) {
   var app = express();
+  app.use(utils.timings);
   app.use(helmet());
   app.use(compression());
   app.use(utils.rewritePath);

diff --git a/packages/express/lib/utils.js b/packages/express/lib/utils.js
@@ -120,6 +120,13 @@ exports.assetsMiddleware = function assetsMiddleware(req, res, next) {
   next();
 };
 
+exports.timings = hopsConfig.enableServerTimings
+  ? require('server-timings')
+  : function(req, res, next) {
+      res.locals.timings = { start: function() {}, end: function() {} };
+      next();
+    };
+
 exports.bootstrap = hopsConfig.bootstrapServer || function() {};
 
 exports.teardown = hopsConfig.teardownServer || function() {};
diff --git a/packages/express/package.json b/packages/express/package.json
@@ -26,6 +26,7 @@
     "express": "^4.16.0",
     "helmet": "^3.8.2",
     "hops-config": "10.2.0-rc.0",
-    "mime": "^2.2.0"
+    "mime": "^2.2.0",
+    "server-timings": "^2.0.1"
   }
 }
diff --git a/packages/spec/config.js b/packages/spec/config.js
@@ -35,6 +35,7 @@ describe('config', function() {
       buildDir: path.resolve('build'),
       cacheDir: path.resolve(path.join('node_modules', '.cache', 'hops')),
       workerFile: null,
+      enableServerTimings: true,
       workerPath: '/sw.js',
     });
   });

diff --git a/yarn.lock b/yarn.lock
@@ -5578,7 +5578,7 @@ on-finished@~2.3.0:
   dependencies:
     ee-first "1.1.1"
 
-on-headers@~1.0.1:
+on-headers@^1.0.1, on-headers@~1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/on-headers/-/on-headers-1.0.1.tgz#928f5d0f470d49342651ea6794b0857c100693f7"
 
@@ -7223,6 +7223,12 @@ serve-static@1.13.1:
     parseurl "~1.3.2"
     send "0.16.1"
 
+server-timings@^2.0.1:
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/server-timings/-/server-timings-2.0.1.tgz#77b9febc1fab102d1b2c5dc8838767780d0c7c93"
+  dependencies:
+    on-headers "^1.0.1"
+
 serverless-http@^1.5.2:
   version "1.5.3"
   resolved "https://registry.yarnpkg.com/serverless-http/-/serverless-http-1.5.3.tgz#86b695a354a7780715672291cc5c1f5fc6bcff2e"