@quintype/framework 7.19.21 → 7.19.22-custom-maxage.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/framework",
-  "version": "7.19.21",
+  "version": "7.19.22-custom-maxage.0",
   "description": "Libraries to help build Quintype Node.js apps",
   "main": "index.js",
   "engines": {

package/server/handlers/cdn-caching.js

@@ -6,6 +6,7 @@ exports.addCacheHeadersToResult = function addCacheHeadersToResult({
   cacheKeys,
   cdnProvider = "cloudflare",
   config,
+  maxAge = "15",
   sMaxAge = "900",
   networkOnly = false,
 }) {
@@ -42,7 +43,7 @@ exports.addCacheHeadersToResult = function addCacheHeadersToResult({
       } else {
         res.setHeader(
           "Cache-Control",
-          `public,max-age=15,s-maxage=${sMaxAge},stale-while-revalidate=1000,stale-if-error=14400`
+          `public,max-age=${maxAge},s-maxage=${sMaxAge},stale-while-revalidate=1000,stale-if-error=14400`
         );
         cdnProviderVal === "akamai" &&
           res.setHeader("Edge-Control", `public,maxage=${sMaxAge},stale-while-revalidate=1000,stale-if-error=14400`);

package/server/handlers/custom-route-handler.js

@@ -19,6 +19,8 @@ function renderStaticPageContent(store, content) {
 }
 
 function writeStaticPageResponse(res, url, page, result, { config, renderLayout, seo }) {
+  const hideHeader = !page.metadata.header;
+  const hideFooter = !page.metadata.footer;
   const qt = {
     pageType: page.type,
     // remove content from data to avoid the script tag inside json breaking the page
@@ -37,6 +39,8 @@ function writeStaticPageResponse(res, url, page, result, { config, renderLayout,
   res.status(page["status-code"] || 200);
 
   return renderLayout(res, {
+    hideHeader,
+    hideFooter,
     title: page.title,
     metadata: page.metadata,
     content: renderStaticPageContent(store, page.content),
@@ -50,7 +54,7 @@ exports.customRouteHandler = function customRouteHandler(
   req,
   res,
   next,
-  { config, client, loadData, loadErrorData, renderLayout, logError, seo, domainSlug, cdnProvider = null, sMaxAge }
+  { config, client, loadData, loadErrorData, renderLayout, logError, seo, domainSlug, cdnProvider = null, sMaxAge, maxAge }
 ) {
   const url = urlLib.parse(req.url, true);
   const path = req.params[0].endsWith("/") ? req.params[0].slice(0, -1) : req.params[0];
@@ -70,6 +74,7 @@ exports.customRouteHandler = function customRouteHandler(
           cdnProvider: cdnProvider,
           config: config,
           sMaxAge,
+          maxAge,
         });
 
         let destination = page["destination-path"] || "/";
@@ -89,6 +94,7 @@ exports.customRouteHandler = function customRouteHandler(
           cdnProvider: cdnProvider,
           config: config,
           sMaxAge,
+          maxAge,
         });
         addStaticPageMimeType({ res, page });
 

package/server/handlers/isomorphic-handler.js

@@ -230,6 +230,7 @@ exports.handleIsomorphicDataLoad = function handleIsomorphicDataLoad(
     redirectToLowercaseSlugs,
     sMaxAge,
     networkOnly,
+    maxAge,
   }
 ) {
   const url = urlLib.parse(req.query.path || "/", true);
@@ -302,6 +303,7 @@ exports.handleIsomorphicDataLoad = function handleIsomorphicDataLoad(
         config: config,
         sMaxAge,
         networkOnly,
+        maxAge,
       });
       const seoInstance = getSeoInstance(seo, config, result.pageType);
       res.json(
@@ -423,6 +425,7 @@ exports.handleIsomorphicRoute = function handleIsomorphicRoute(
     shouldEncodeAmpUri,
     publisherConfig,
     sMaxAge,
+    maxAge,
   }
 ) {
   const url = urlLib.parse(req.url, true);
@@ -437,6 +440,7 @@ exports.handleIsomorphicRoute = function handleIsomorphicRoute(
         cdnProvider: cdnProvider,
         config: config,
         sMaxAge: result.pageType === "tag-page" ? 600 : sMaxAge,
+        maxAge: maxAge,
       });
       return res.redirect(301, result.data.location);
     }
@@ -463,6 +467,7 @@ exports.handleIsomorphicRoute = function handleIsomorphicRoute(
       cdnProvider: cdnProvider,
       config: config,
       sMaxAge: result.pageType === "tag-page" ? 600 : sMaxAge,
+      maxAge: maxAge,
     });
 
     if (preloadJs) {
@@ -537,6 +542,7 @@ exports.handleStaticRoute = function handleStaticRoute(
     oneSignalServiceWorkers,
     publisherConfig,
     sMaxAge,
+    maxAge,
   }
 ) {
   const url = urlLib.parse(path);
@@ -577,6 +583,7 @@ exports.handleStaticRoute = function handleStaticRoute(
         cdnProvider: cdnProvider,
         config: config,
         sMaxAge,
+        maxAge,
       });
 
       const oneSignalScript = oneSignalServiceWorkers ? getOneSignalScript({ config, publisherConfig }) : null;

package/server/handlers/story-redirect.js

@@ -6,7 +6,7 @@ exports.redirectStory = function redirectStory(
   req,
   res,
   next,
-  { logError, config, client, cdnProvider = null, sMaxAge }
+  { logError, config, client, cdnProvider = null, sMaxAge, maxAge }
 ) {
   const storySlug = req.params.storySlug.toLowerCase() || "";
   return Story.getStoryBySlug(client, storySlug)
@@ -18,6 +18,7 @@ exports.redirectStory = function redirectStory(
           cdnProvider: cdnProvider,
           config: config,
           sMaxAge,
+          maxAge,
         });
         return res.redirect(301, `/${story.slug}`);
       } else {

package/server/routes.js

@@ -39,6 +39,7 @@ const prerender = require("@quintype/prerender-node");
  * @param {Array<string>} opts.extraRoutes Additionally forward some routes upstream. This takes an array of express compatible routes, such as ["/foo/*"]
  * @param {boolean} opts.forwardAmp Forward amp story routes upstream (default false)
  * @param {number} opts.sMaxAge Support overriding of proxied response cache header `s-maxage` from Sketches. For Breaking News and if the cacheability is Private, it is not overwritten instead the cache control will be the same as how it's set in sketches. We can set `upstreamRoutesSmaxage: 900` under `publisher` in publisher.yml config file that comes from BlackKnight or pass sMaxAge as a param.
+ * @param {number} opts.maxAge Support overriding of proxied response cache header `maxage` from Sketches. For Breaking News and if the cacheability is Private, it is not overwritten instead the cache control will be the same as how it's set in sketches. We can set `upstreamRoutesMaxage: 15` under `publisher` in publisher.yml config file that comes from BlackKnight or pass maxAge as a param.
  * @param {boolean} opts.forwardFavicon Forward favicon requests to the CMS (default false)
  * @param {boolean} opts.isSitemapUrlEnabled To enable /news_sitemap/today and /news_sitemap/yesterday sitemap news url (default /news_sitemap.xml)
  */
@@ -49,7 +50,7 @@ exports.upstreamQuintypeRoutes = function upstreamQuintypeRoutes(
     forwardFavicon = false,
     extraRoutes = [],
     sMaxAge,
-
+    maxAge,
     config = require("./publisher-config"),
     getClient = require("./api-client").getClient,
     isSitemapUrlEnabled = false,
@@ -67,8 +68,22 @@ exports.upstreamQuintypeRoutes = function upstreamQuintypeRoutes(
   });
 
   const _sMaxAge = get(config, ["publisher", "upstreamRoutesSmaxage"], sMaxAge);
+  const _maxAge = get(config, ["publisher", "upstreamRoutesMaxage"], maxAge);
 
-  parseInt(_sMaxAge) > 0 &&
+  parseInt(_sMaxAge) > 0  &&
+    apiProxy.on("proxyRes", function (proxyRes, req) {
+      const pathName = get(req, ["originalUrl"], "").split("?")[0];
+      const checkForExcludeRoutes = excludeRoutes.some((path) => {
+        const matchFn = match(path, { decode: decodeURIComponent });
+        return matchFn(pathName);
+      });
+      const getCacheControl = get(proxyRes, ["headers", "cache-control"], "");
+      if (!checkForExcludeRoutes && getCacheControl.includes("public")) {
+        proxyRes.headers["cache-control"] = getCacheControl
+        .replace(/s-maxage=\d*/g, `s-maxage=${_sMaxAge}`);
+      }
+    });
+  parseInt(_maxAge) > 0 &&
     apiProxy.on("proxyRes", function (proxyRes, req) {
       const pathName = get(req, ["originalUrl"], "").split("?")[0];
       const checkForExcludeRoutes = excludeRoutes.some((path) => {
@@ -77,7 +92,8 @@ exports.upstreamQuintypeRoutes = function upstreamQuintypeRoutes(
       });
       const getCacheControl = get(proxyRes, ["headers", "cache-control"], "");
       if (!checkForExcludeRoutes && getCacheControl.includes("public")) {
-        proxyRes.headers["cache-control"] = getCacheControl.replace(/s-maxage=\d*/g, `s-maxage=${_sMaxAge}`);
+        proxyRes.headers["cache-control"] = getCacheControl
+        .replace(/max-age=\d*/g, `max-age=${_maxAge}`);
       }
     });
 
@@ -90,7 +106,7 @@ exports.upstreamQuintypeRoutes = function upstreamQuintypeRoutes(
       .catch(() => res.status(503).send({ error: { message: "Config not loaded" } }));
   });
 
-  // Mention the routes which don't want to override the s-maxage value
+  // Mention the routes which don't want to override the s-maxage value and max-age value
   const excludeRoutes = [
     "/qlitics.js",
     "/api/v1/breaking-news",
@@ -288,6 +304,7 @@ function getWithConfig(app, route, handler, opts = {}) {
  * @param {boolean|function} redirectToLowercaseSlugs If set or evaluates to true, then for every story-page request having capital latin letters in the slug, it responds with a 301 redirect to the lowercase slug URL. (default: true)
  * @param {boolean|function} shouldEncodeAmpUri If set to true, then for every story-page request the slug will be encoded, in case of a vernacular slug this should be set to false. Receives path as param (default: true)
  * @param {number} sMaxAge Overrides the s-maxage value, the default value is set to 900 seconds. We can set `isomorphicRoutesSmaxage: 900` under `publisher` in publisher.yml config file that comes from BlackKnight or pass sMaxAge as a param.
+ * @param {number} maxAge Overrides the max-age value, the default value is set to 15 seconds. We can set `isomorphicRoutesMaxage: 15` under `publisher` in publisher.yml config file that comes from BlackKnight or pass maxAge as a param.
  * @param {(string|function)} fcmServerKey  FCM serverKey is used for registering FCM Topic.
  * @param {string} appLoadingPlaceholder This string gets injected into the app container when the page is loaded via service worker. Can be used to show skeleton layouts, animations or other progress indicators before it is replaced by the page content.
  */
@@ -331,6 +348,7 @@ exports.isomorphicRoutes = function isomorphicRoutes(
     redirectToLowercaseSlugs = false,
     shouldEncodeAmpUri,
     sMaxAge = 900,
+    maxAge = 15,
     appLoadingPlaceholder = "",
     fcmServerKey = "",
     webengageConfig = {},
@@ -340,6 +358,8 @@ exports.isomorphicRoutes = function isomorphicRoutes(
 
   const _sMaxAge = parseInt(get(publisherConfig, ["publisher", "isomorphicRoutesSmaxage"], sMaxAge));
 
+  const _maxAge = parseInt(get(publisherConfig, ["publisher", "isomorphicRoutesMaxage"], maxAge));
+
   pickComponent = makePickComponentSync(pickComponent);
   loadData = wrapLoadDataWithMultiDomain(publisherConfig, loadData, 2);
   loadErrorData = wrapLoadDataWithMultiDomain(publisherConfig, loadErrorData, 1);
@@ -422,6 +442,7 @@ exports.isomorphicRoutes = function isomorphicRoutes(
       cdnProvider,
       redirectToLowercaseSlugs,
       sMaxAge: _sMaxAge,
+      maxAge: _maxAge,
       networkOnly: true,
     })
   );
@@ -456,6 +477,7 @@ exports.isomorphicRoutes = function isomorphicRoutes(
         cdnProvider,
         redirectToLowercaseSlugs,
         sMaxAge: _sMaxAge,
+        maxAge: _maxAge,
       })
     );
   }
@@ -489,6 +511,7 @@ exports.isomorphicRoutes = function isomorphicRoutes(
             oneSignalServiceWorkers,
             publisherConfig,
             sMaxAge: _sMaxAge,
+            maxAge: _maxAge,
           },
           route
         )
@@ -517,11 +540,12 @@ exports.isomorphicRoutes = function isomorphicRoutes(
       oneSignalServiceWorkers,
       publisherConfig,
       sMaxAge: _sMaxAge,
+      maxAge: _maxAge,
     })
   );
 
   if (redirectRootLevelStories) {
-    app.get("/:storySlug", withConfig(redirectStory, { logError, cdnProvider, sMaxAge: _sMaxAge }));
+    app.get("/:storySlug", withConfig(redirectStory, { logError, cdnProvider, sMaxAge: _sMaxAge, maxAge: _maxAge }));
   }
 
   if (handleCustomRoute) {
@@ -534,6 +558,7 @@ exports.isomorphicRoutes = function isomorphicRoutes(
         seo,
         cdnProvider,
         sMaxAge: _sMaxAge,
+        maxAge: _maxAge,
       })
     );
   }

package/test/integration/sketches-proxy-test.js

@@ -189,6 +189,79 @@ describe("Sketches Proxy", function () {
     });
   });
 
+  describe("Override the max-age cache header", function () {
+    function getClientStub(hostname) {
+      return {
+        getHostname: () => "demo.quintype.io",
+        getConfig: () =>
+          Promise.resolve({
+            foo: "bar",
+            "sketches-host": "https://www.foo.com",
+          }),
+        baseUrl: "https://www.foo.com",
+      };
+    }
+    function buildApp(maxAge, { app = express() } = {}) {
+      upstreamQuintypeRoutes(app, {
+        config: {
+          sketches_host: `https://demo.quintype.io`,
+        },
+        getClient: getClientStub,
+        extraRoutes: ["/custom-route"],
+        forwardAmp: true,
+        forwardFavicon: true,
+        publisherConfig: {},
+        maxAge: maxAge,
+      });
+      return app;
+    }
+
+    it("Override the max-age cache header when maxAge value is present", function (done) {
+      const maxAge = 3600;
+      supertest(buildApp(maxAge))
+        .get("/api/v1/config")
+        .expect(200)
+        .then((res) => {
+          const cacheControl = res.headers["cache-control"];
+          assert.equal(cacheControl, "public,max-age=3600,s-maxage=240,stale-while-revalidate=300,stale-if-error=7200");
+        })
+        .then(done);
+    });
+
+    it("Does not override the max-age cache header if cacheability is Private", function (done) {
+      const maxAge = 15;
+      supertest(buildApp(maxAge))
+        .get("/api/auth/v1/users/me")
+        .then((res) => {
+          const cacheControl = res.headers["cache-control"];
+          assert.equal(cacheControl, "private,no-cache,no-store");
+        })
+        .then(done);
+    });
+
+    it("Does not override the max-age cache header for Breaking News", function (done) {
+      const maxAge = 3600;
+      supertest(buildApp(maxAge))
+        .get("/api/v1/breaking-news")
+        .then((res) => {
+          const cacheControl = res.headers["cache-control"];
+          assert.equal(cacheControl, "public,max-age=15,s-maxage=240,stale-while-revalidate=300,stale-if-error=7200");
+        })
+        .then(done);
+    });
+
+    it("if maxAge value is not present, do not override cache headers", function (done) {
+      supertest(buildApp())
+        .get("/api/v1/config")
+        .expect(200)
+        .then((res) => {
+          const cacheControl = res.headers["cache-control"];
+          assert.equal(cacheControl, "public,max-age=15,s-maxage=240,stale-while-revalidate=300,stale-if-error=7200");
+        })
+        .then(done);
+    });
+  });
+
   describe("sitemap requests", function () {
     function buildApp({ isSitemapUrlEnabled }) {
       const app = express();