send longer cache headers by default

lib/all-badge-examples.js

@@ -2219,6 +2219,9 @@ function findCategory(wantedCategory) {
 
 function loadExamples() {
   loadServiceClasses().forEach(ServiceClass => {
+    if (ServiceClass.category === 'debug') {
+      return;
+    }
     const category = findCategory(ServiceClass.category);
     if (category === undefined) {
       throw Error(`Unknown category ${ServiceClass.category} referenced in ${ServiceClass.name}`);

lib/request-handler.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const envFlag = require('node-env-flag');
 // eslint-disable-next-line node/no-deprecated-api
 const domain = require('domain');
 const request = require('request');
@@ -79,13 +80,18 @@ function handleRequest (makeBadge, handlerOptions) {
   return (queryParams, match, end, ask) => {
     const reqTime = new Date();
 
+    let maxAge = envFlag(process.env.LONG_CACHE, false) ? 900 : 0;
     if (queryParams.maxAge !== undefined && /^[0-9]+$/.test(queryParams.maxAge)) {
-      ask.res.setHeader('Cache-Control', 'max-age=' + queryParams.maxAge);
-      ask.res.setHeader('Expires', new Date(+reqTime + queryParams.maxAge * 1000).toGMTString());
-    } else {
-      // Cache management - no cache, so it won't be cached by GitHub's CDN.
+      // always let queryParams.maxAge override the default
+      // regardless of env.LONG_CACHE setting
+      maxAge = queryParams.maxAge;
+    }
+    if (maxAge === 0) {
       ask.res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate');
-      ask.res.setHeader('Expires', reqTime.toGMTString());  // Proxies, GitHub, see #221.
+      ask.res.setHeader('Expires', reqTime.toGMTString());
+    } else {
+      ask.res.setHeader('Cache-Control', 'max-age=' + maxAge);
+      ask.res.setHeader('Expires', new Date(+reqTime + maxAge * 1000).toGMTString());
     }
 
     ask.res.setHeader('Date', reqTime.toGMTString());

lib/request-handler.spec.js

@@ -33,9 +33,12 @@ describe('The request handler', function() {
   before(analytics.load);
 
   let camp;
+  const initialLongCache = process.env.LONG_CACHE;
+
   beforeEach(function (done) {
     camp = Camp.start({ port: config.port, hostname: '::' });
     camp.on('listening', () => done());
+    process.env.LONG_CACHE = initialLongCache;
   });
   afterEach(function (done) {
     clearRequestCache();
@@ -105,15 +108,32 @@ describe('The request handler', function() {
         expect(handlerCallCount).to.equal(1);
       });
 
-      it('should set the expires header to current time', async function () {
+      it('should set the expires header to current time + 15 mins if LONG_CACHE on', async function () {
+        process.env.LONG_CACHE = 1;
         const res = await fetch(`${baseUri}/testing/123.json`);
-        expect(res.headers.get('expires')).to.equal(res.headers.get('date'));
+        const expectedExpiry = new Date(+(new Date(res.headers.get('date'))) + 900000).toGMTString();
+        expect(res.headers.get('expires')).to.equal(expectedExpiry);
+        expect(res.headers.get('cache-control')).to.equal('max-age=900');
       });
 
       it('should set the expires header to current time + max-age', async function () {
         const res = await fetch(`${baseUri}/testing/123.json?maxAge=3600`);
         const expectedExpiry = new Date(+(new Date(res.headers.get('date'))) + 3600000).toGMTString();
         expect(res.headers.get('expires')).to.equal(expectedExpiry);
+        expect(res.headers.get('cache-control')).to.equal('max-age=3600');
+      });
+
+      it('should set Cache-Control: no-cache, no-store, must-revalidate if maxAge=0', async function () {
+        const res = await fetch(`${baseUri}/testing/123.json?maxAge=0`);
+        expect(res.headers.get('expires')).to.equal(res.headers.get('date'));
+        expect(res.headers.get('cache-control')).to.equal('no-cache, no-store, must-revalidate');
+      });
+
+      it('should set Cache-Control: no-cache, no-store, must-revalidate if LONG_CACHE off', async function () {
+        process.env.LONG_CACHE = 0;
+        const res = await fetch(`${baseUri}/testing/123.json`);
+        expect(res.headers.get('expires')).to.equal(res.headers.get('date'));
+        expect(res.headers.get('cache-control')).to.equal('no-cache, no-store, must-revalidate');
       });
 
       describe('the cache key', function () {

services/time/time.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const BaseService = require('../base');
+
+module.exports = class Time extends BaseService {
+
+  async handle({library}) {
+    return { message: new Date() };
+  }
+
+  // Metadata
+  static get defaultBadgeData() {
+    return {
+      label: 'time',
+      color: 'blue',
+    };
+  }
+
+  static get category() {
+    return 'debug';
+  }
+
+  static get url() {
+    return {
+      base: 'servertime',
+      format: '',
+      capture: []
+    };
+  }
+
+  static get examples() {
+    return [];
+  }
+};