@quintype/framework 7.22.0-disable-amp-story.2 → 7.22.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [7.22.0](https://github.com/quintype/quintype-node-framework/compare/v7.21.2...v7.22.0) (2023-12-01)
+
+
+### Features
+
+* add support to configure amp story page path through featureConfig ([#403](https://github.com/quintype/quintype-node-framework/issues/403)) ([876e89a](https://github.com/quintype/quintype-node-framework/commit/876e89aeb1b4fadc9c071ffb7dcf824fc419a963))
+
 ### [7.21.2](https://github.com/quintype/quintype-node-framework/compare/v7.21.1...v7.21.2) (2023-11-15)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/framework",
-  "version": "7.22.0-disable-amp-story.2",
+  "version": "7.22.0",
   "description": "Libraries to help build Quintype Node.js apps",
   "main": "index.js",
   "engines": {
@@ -35,7 +35,7 @@
     "@quintype/backend": "^2.3.3",
     "@quintype/components": "^3.3.0",
     "@quintype/prerender-node": "^3.2.26",
-    "@quintype/seo": "^1.43.0-disable-amp-story.1",
+    "@quintype/seo": "^1.43.0-config-amp-story-path.1",
     "atob": "^2.1.2",
     "babel-plugin-react-css-modules": "^5.2.6",
     "chalk": "^4.1.2",

package/server/amp/handlers/infinite-scroll.js

@@ -11,6 +11,8 @@ async function storyPageInfiniteScrollHandler(req, res, next, { client, config,
   const infiniteScrollSource = get(opts, ["featureConfig", "infiniteScroll", "source"], "collection");
 
   const infiniteScrollAmp = new InfiniteScrollAmp({
+    opts,
+    config,
     ampConfig,
     publisherConfig: config,
     client,

package/server/amp/handlers/story-page.js

@@ -47,10 +47,8 @@ async function ampStoryPageHandler(
     if (typeof redirectUrls === "function" || (redirectUrls && Object.keys(redirectUrls).length > 0)) {
       await getRedirectUrl(req, res, next, { redirectUrls, config });
     }
-    const story = await Story.getStoryBySlug(client, req.params["0"]);
-    const isAmpDisabled = get(story, ["metadata", "story-attributes", "disable-amp-for-single-story", "0"], "false");
 
-    if ((!isVisualStory && !enableAmp) || isAmpDisabled === "true") {
+    if (!isVisualStory && !enableAmp) {
       return res.redirect(301, `/${req.params[0]}`);
     }
 
@@ -59,6 +57,7 @@ async function ampStoryPageHandler(
     const { ampifyStory, unsupportedStoryElementsPresent } = ampLibrary;
     // eslint-disable-next-line no-return-await
     const ampConfig = await config.memoizeAsync("amp-config", async () => await AmpConfig.getAmpConfig(client));
+    const story = await Story.getStoryBySlug(client, req.params["0"]);
     let relatedStoriesCollection;
     let relatedStories = [];
 
@@ -100,6 +99,8 @@ async function ampStoryPageHandler(
       infiniteScrollInlineConfig = await inlineConfig();
     } else {
       const infiniteScrollAmp = new InfiniteScrollAmp({
+        opts,
+        config,
         ampConfig,
         publisherConfig: config,
         client,

package/server/amp/helpers/get-amp-page-base-path.js

@@ -0,0 +1,10 @@
+const get = require("lodash/get");
+
+function getAmpPageBasePath(opts = {}, config) {
+  let ampPageBasePath = get(opts, ["featureConfig", "ampPageBasePath"], "/amp/story");
+  ampPageBasePath = typeof ampPageBasePath === "function" ? ampPageBasePath(config) : ampPageBasePath;
+
+  return ampPageBasePath;
+}
+
+module.exports = { getAmpPageBasePath };

package/server/amp/helpers/infinite-scroll.js

@@ -1,6 +1,10 @@
+const { getAmpPageBasePath } = require("./get-amp-page-base-path");
+
 class InfiniteScrollAmp {
-  constructor({ ampConfig, client, publisherConfig, queryParams, infiniteScrollSource }) {
+  constructor({ config = {}, opts = {}, ampConfig, client, publisherConfig, queryParams, infiniteScrollSource }) {
     this.client = client;
+    this.opts = opts;
+    this.config = config;
     this.publisherConfig = publisherConfig;
     this.queryParams = queryParams;
     this.infiniteScrollSource = infiniteScrollSource;
@@ -19,18 +23,17 @@ class InfiniteScrollAmp {
 
   getFilteredApiItems(relatedStories) {
     return relatedStories.filter(
-      (story) =>
-        story.access !== "subscription" &&
-        story["story-template"] !== "visual-story"
+      (story) => story.access !== "subscription" && story["story-template"] !== "visual-story"
     );
   }
 
   formatData({ itemsArr, type }) {
     // formats configuration as per need of amp infinite scroll
+    const ampPageBasePath = getAmpPageBasePath(this.opts, this.config);
     const arr = itemsArr.map((item) => ({
       image: this.getImagePath(item),
       title: item.headline,
-      url: `/amp/story/${item.slug}`,
+      url: `${ampPageBasePath}/${item.slug}`,
     }));
     switch (type) {
       case "inline":
@@ -57,40 +60,38 @@ class InfiniteScrollAmp {
     };
     if (this.infiniteScrollSource === "relatedStoriesApi") {
       const relatedStoriesList = await this.client.getRelatedStories(storyId, null, params);
-      if (!relatedStoriesList || !relatedStoriesList["related-stories"].length)
-        return new Error();
-      return filteredItems = this.getFilteredApiItems(relatedStoriesList["related-stories"]);
+      if (!relatedStoriesList || !relatedStoriesList["related-stories"].length) return new Error();
+      return (filteredItems = this.getFilteredApiItems(relatedStoriesList["related-stories"]));
     } else {
       const collection = await this.client.getCollectionBySlug("amp-infinite-scroll");
       if (!collection || (collection.items && !collection.items.length) || collection.error || collection === null)
         return new Error();
-      const collectionItems = this.getFilteredCollItems(collection, storyId).map(items => items.story);
-      return filteredItems = type === "inlineConfig"
-        ? collectionItems.slice(0, 5)
-        : collectionItems.slice(5);
+      const collectionItems = this.getFilteredCollItems(collection, storyId).map((items) => items.story);
+      return (filteredItems = type === "inlineConfig" ? collectionItems.slice(0, 5) : collectionItems.slice(5));
     }
   }
 
   async getResponse() {
     const { "story-id": storyId } = this.queryParams;
     if (!storyId) return new Error(`Query param "story-id" missing`);
-    const filteredItems =
-      await this.getInfiniteScrollList({ storyId, type: "remoteConfig", offset: 5 });
-    if (filteredItems instanceof Error) return new Error(`Infinite scroll collection amp-infinite-scroll returned falsy value`);
+    const filteredItems = await this.getInfiniteScrollList({ storyId, type: "remoteConfig", offset: 5 });
+    if (filteredItems instanceof Error)
+      return new Error(`Infinite scroll collection amp-infinite-scroll returned falsy value`);
     const formattedData = this.formatData({ itemsArr: filteredItems });
     return JSON.stringify(formattedData);
   }
 
   async getInitialInlineConfig({ storyId }) {
     if (!storyId) return new Error("Required params for getInitialInlineConfig missing");
-    const filteredItems =
-      await this.getInfiniteScrollList({ storyId, type: "inlineConfig", offset: 0, limit: 5 });
+    const filteredItems = await this.getInfiniteScrollList({ storyId, type: "inlineConfig", offset: 0, limit: 5 });
 
     if (filteredItems instanceof Error) return null;
-    const formattedData = filteredItems.length > 0 && this.formatData({
-      itemsArr: filteredItems,
-      type: "inline",
-    });
+    const formattedData =
+      filteredItems.length > 0 &&
+      this.formatData({
+        itemsArr: filteredItems,
+        type: "inline",
+      });
     return JSON.stringify(formattedData);
   }
 }

package/server/handlers/isomorphic-handler.js

@@ -426,6 +426,7 @@ exports.handleIsomorphicRoute = function handleIsomorphicRoute(
     publisherConfig,
     sMaxAge,
     maxAge,
+    ampPageBasePath,
   }
 ) {
   const url = urlLib.parse(req.url, true);
@@ -457,6 +458,7 @@ exports.handleIsomorphicRoute = function handleIsomorphicRoute(
         client,
         req,
         shouldEncodeAmpUri,
+        ampPageBasePath,
       });
     }
 

package/server/impl/light-page-impl.js

@@ -3,13 +3,9 @@ const _ = require("lodash");
 function addLightPageHeaders(
   result,
   lightPages,
-  { config, res, client, req, shouldEncodeAmpUri = true }
+  { config, res, client, req, shouldEncodeAmpUri = true, ampPageBasePath }
 ) {
-  const isAmpSupported = _.get(
-    result,
-    ["data", "story", "is-amp-supported"],
-    false
-  );
+  const isAmpSupported = _.get(result, ["data", "story", "is-amp-supported"], false);
 
   if (typeof lightPages === "function" && !lightPages(config)) {
     return;
@@ -24,10 +20,8 @@ function addLightPageHeaders(
       path = shouldEncodeAmpUri ? encodeURIComponent(path) : path;
     }
 
-    res.set(
-      "X-QT-Light-Pages-Url",
-      `${req.protocol}://${req.hostname}/amp/story/${path}`
-    );
+    const ampPagePath = typeof ampPageBasePath === "function" ? ampPageBasePath(config) : ampPageBasePath;
+    res.set("X-QT-Light-Pages-Url", `${req.protocol}://${req.hostname}${ampPagePath}/${path}`);
   }
 }
 

package/server/routes.js

@@ -70,7 +70,7 @@ 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) => {
@@ -79,8 +79,7 @@ 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(/s-maxage=\d*/g, `s-maxage=${_sMaxAge}`);
       }
     });
   parseInt(_maxAge) > 0 &&
@@ -92,8 +91,7 @@ exports.upstreamQuintypeRoutes = function upstreamQuintypeRoutes(
       });
       const getCacheControl = get(proxyRes, ["headers", "cache-control"], "");
       if (!checkForExcludeRoutes && getCacheControl.includes("public")) {
-        proxyRes.headers["cache-control"] = getCacheControl
-        .replace(/max-age=\d*/g, `max-age=${_maxAge}`);
+        proxyRes.headers["cache-control"] = getCacheControl.replace(/max-age=\d*/g, `max-age=${_maxAge}`);
       }
     });
 
@@ -319,6 +317,7 @@ exports.isomorphicRoutes = function isomorphicRoutes(
     seo,
     manifestFn,
     assetLinkFn,
+    ampPageBasePath = "/amp/story",
 
     oneSignalServiceWorkers = false,
     staticRoutes = [],
@@ -541,6 +540,7 @@ exports.isomorphicRoutes = function isomorphicRoutes(
       publisherConfig,
       sMaxAge: _sMaxAge,
       maxAge: _maxAge,
+      ampPageBasePath,
     })
   );
 
@@ -648,7 +648,7 @@ exports.mountQuintypeAt = function (app, mountAt) {
 /**
  * *ampRoutes* handles all the amp page routes using the *[@quintype/amp](https://developers.quintype.com/quintype-node-amp)* library
  * routes matched:
- * GET - "/amp/story/:slug"* returns amp story page
+ * GET - "/amp/:slug"* returns amp story page
  * GET - "/amp/api/v1/amp-infinite-scroll" returns the infinite scroll config JSON. Passed to <amp-next-page> component's `src` attribute
  *
  * @param {Express} app Express app to add the routes to
@@ -665,7 +665,7 @@ exports.mountQuintypeAt = function (app, mountAt) {
 exports.ampRoutes = (app, opts = {}) => {
   const { ampStoryPageHandler, storyPageInfiniteScrollHandler } = require("./amp/handlers");
 
-  getWithConfig(app, "/amp/story/*", ampStoryPageHandler, opts);
   getWithConfig(app, "/amp/api/v1/amp-infinite-scroll", storyPageInfiniteScrollHandler, opts);
+  getWithConfig(app, "/amp/*", ampStoryPageHandler, opts);
   getWithConfig(app, "/ampstories/*", ampStoryPageHandler, { ...opts, isVisualStory: true });
 };

package/test/integration/amp-handler-test.js

@@ -244,7 +244,7 @@ describe("ampStoryPageHandler integration tests", () => {
       enableAmp: false,
     });
     supertest(app)
-      .get("/amp/story/cricket/ipl-2021")
+      .get("/amp/cricket/ipl-2021")
       .expect(301)
       .expect("Location", "/cricket/ipl-2021")
       .end((err) => {