@quintype/framework 7.24.2 → 7.25.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.25.0](https://github.com/quintype/quintype-node-framework/compare/v7.24.2...v7.25.0) (2024-02-23)
+
+
+### Features
+
+* **amp:** disable amp for a particular story ([#402](https://github.com/quintype/quintype-node-framework/issues/402)) ([8e99d24](https://github.com/quintype/quintype-node-framework/commit/8e99d24b38c6ff3eb452bc2362043910f3179e9b))
+
 ### [7.24.2](https://github.com/quintype/quintype-node-framework/compare/v7.24.1...v7.24.2) (2024-02-22)
 
 ### [7.24.1](https://github.com/quintype/quintype-node-framework/compare/v7.24.0...v7.24.1) (2024-02-22)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/framework",
-  "version": "7.24.2",
+  "version": "7.25.0",
   "description": "Libraries to help build Quintype Node.js apps",
   "main": "index.js",
   "engines": {

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

@@ -9,6 +9,7 @@ const { optimize, getDomainSpecificOpts } = require("../helpers");
 const { storyToCacheKey } = require("../../caching");
 const { addCacheHeadersToResult } = require("../../handlers/cdn-caching");
 const { getRedirectUrl } = require("../../../server/redirect-url-helper");
+const { getAmpPageBasePath } = require("../helpers/get-amp-page-base-path");
 
 /**
  * ampStoryPageHandler gets all the things needed and calls "ampifyStory" function (which comes from ampLib)
@@ -40,6 +41,10 @@ async function ampStoryPageHandler(
 ) {
   try {
     const opts = cloneDeep(rest);
+    const isCorrectAmpPath = req.path.startsWith(`${getAmpPageBasePath(opts, config)}/`);
+    if (!isCorrectAmpPath) {
+      return next();
+    }
     const redirectUrls = opts && opts.redirectUrls;
     const getEnableAmp = get(opts, ["enableAmp"], true);
     const enableAmp = typeof getEnableAmp === "function" ? opts.enableAmp(config) : getEnableAmp;
@@ -47,9 +52,16 @@ 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) {
-      return res.redirect(301, `/${req.params[0]}`);
+    if ((!isVisualStory && !enableAmp) || isAmpDisabled === "true") {
+      const ampPageBasePath = getAmpPageBasePath(opts, config);
+      const redirectUrl = `/${req.params[0]}`.startsWith(ampPageBasePath)
+        ? `/${req.params[0]}`.replace(ampPageBasePath, "")
+        : `/${req.params[0]}`;
+
+      return res.redirect(301, redirectUrl);
     }
 
     const domainSpecificOpts = getDomainSpecificOpts(opts, domainSlug);
@@ -57,7 +69,6 @@ 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 = [];
 

package/server/routes.js

@@ -657,6 +657,9 @@ exports.mountQuintypeAt = function (app, mountAt) {
  * 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
  *
+ * To disable amp version for a specific story, you need to create a story attribute in bold with the slug {disable-amp-for-single-story} and values {true} and {false}. Set its value to "true" in the story which you want to disable amp. Please make sure to name the attributes and values in the exact same way as mentioned
+ * attribute slug: "disable-amp-for-single-story" values: "true" , "false". This will redirect '<amp-page-base-path>/:slug' to the non-amp page
+ *
  * @param {Express} app Express app to add the routes to
  * @param {Object} opts Options object used to configure amp. Passing this is optional
  * @param {Object} opts.templates An object that's used to pass custom templates. Each key corresponds to the template name and corresponding value is the template
@@ -672,6 +675,6 @@ exports.ampRoutes = (app, opts = {}) => {
   const { ampStoryPageHandler, storyPageInfiniteScrollHandler } = require("./amp/handlers");
 
   getWithConfig(app, "/amp/api/v1/amp-infinite-scroll", storyPageInfiniteScrollHandler, opts);
-  getWithConfig(app, "/amp/*", ampStoryPageHandler, opts);
   getWithConfig(app, "/ampstories/*", ampStoryPageHandler, { ...opts, isVisualStory: true });
+  getWithConfig(app, "/*", ampStoryPageHandler, opts);
 };

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

@@ -239,12 +239,148 @@ describe("ampStoryPageHandler integration tests", () => {
         return done();
       });
   });
+  it("should redirect to non-amp page if isAmpDisabled is true", (done) => {
+    const clientStubWithRedirectToWebVersion = () =>
+      getClientStub({
+        getStoryBySlug: (slug, params) =>
+          Promise.resolve({
+            story: {
+              id: "1",
+              url: "https://www.foo.com/cricket/ipl-2021",
+              "hero-image-metadata": {
+                width: 5472,
+                height: 3648,
+                "mime-type": "image/jpeg",
+                "file-size": 6127839,
+                "file-name": "Sample file",
+                "focus-point": [2609, 1102],
+              },
+              "hero-image-s3-key": "barandbench/2020-01/sample.jpg",
+              "story-content-id": "987c0480-41c8-41d2-ad35-36b5f92be73e",
+              metadata: {
+                "story-attributes": {
+                  "disable-amp-for-single-story": ["true"],
+                },
+              },
+              cards: [
+                {
+                  "story-elements": [
+                    {
+                      description: "",
+                      "page-url":
+                        "/story/7f3d5bdb-ec52-4047-ac0d-df4036ec974b/element/9eb8f5cc-6ebe-4fb0-88b8-eca79efde210",
+                      type: "text",
+                      "family-id": "e9e12f9f-8b9f-4b93-a8c8-83c7b278000f",
+                      title: "",
+                      id: "9eb8f5cc-6ebe-4fb0-88b8-eca79efde210",
+                      metadata: {},
+                      subtype: null,
+                      text: "<p>In India today, the legal profession is growing in lockstep with one of the world’s most dynamic economies. It’s no surprise then— that in terms of absolute numbers— India’s legal profession is the world’s second largest, with over 1.4 million enrolled lawyers in legal practices nationwide.</p>",
+                    },
+                  ],
+                  "card-updated-at": 1581327522163,
+                  "content-version-id": "efaf78de-c90b-4d15-b040-c84ebb29cabf",
+                  "card-added-at": 1581327522163,
+                  status: "draft",
+                  id: "bf486412-1e8b-45d1-a5fd-51939cfe1ce1",
+                  "content-id": "bf486412-1e8b-45d1-a5fd-51939cfe1ce1",
+                  version: 1,
+                  metadata: {},
+                },
+              ],
+              sections: [{ id: 1, name: "Sports" }],
+              "story-template": "text",
+              "is-amp-supported": true,
+            },
+          }),
+      });
+    const app = createApp({
+      clientStub: clientStubWithRedirectToWebVersion,
+      enableAmp: true,
+    });
+    supertest(app)
+      .get("/amp/story/cricket/ipl-2021")
+      .expect(301)
+      .expect("Location", "/cricket/ipl-2021")
+      .end((err) => {
+        if (err) return done(err);
+        return done();
+      });
+  });
+  it("should show amp page if isAmpDisabled is false", (done) => {
+    const clientStubWithRedirectToWebVersion = () =>
+      getClientStub({
+        getStoryBySlug: (slug, params) =>
+          Promise.resolve({
+            story: {
+              id: "1",
+              url: "https://www.foo.com/cricket/ipl-2021",
+              "hero-image-metadata": {
+                width: 5472,
+                height: 3648,
+                "mime-type": "image/jpeg",
+                "file-size": 6127839,
+                "file-name": "Sample file",
+                "focus-point": [2609, 1102],
+              },
+              "hero-image-s3-key": "barandbench/2020-01/sample.jpg",
+              "story-content-id": "987c0480-41c8-41d2-ad35-36b5f92be73e",
+              metadata: {
+                "story-attributes": {
+                  "disable-amp-for-single-story": ["false"],
+                },
+              },
+              cards: [
+                {
+                  "story-elements": [
+                    {
+                      description: "",
+                      "page-url":
+                        "/story/7f3d5bdb-ec52-4047-ac0d-df4036ec974b/element/9eb8f5cc-6ebe-4fb0-88b8-eca79efde210",
+                      type: "text",
+                      "family-id": "e9e12f9f-8b9f-4b93-a8c8-83c7b278000f",
+                      title: "",
+                      id: "9eb8f5cc-6ebe-4fb0-88b8-eca79efde210",
+                      metadata: {},
+                      subtype: null,
+                      text: "<p>In India today, the legal profession is growing in lockstep with one of the world’s most dynamic economies. It’s no surprise then— that in terms of absolute numbers— India’s legal profession is the world’s second largest, with over 1.4 million enrolled lawyers in legal practices nationwide.</p>",
+                    },
+                  ],
+                  "card-updated-at": 1581327522163,
+                  "content-version-id": "efaf78de-c90b-4d15-b040-c84ebb29cabf",
+                  "card-added-at": 1581327522163,
+                  status: "draft",
+                  id: "bf486412-1e8b-45d1-a5fd-51939cfe1ce1",
+                  "content-id": "bf486412-1e8b-45d1-a5fd-51939cfe1ce1",
+                  version: 1,
+                  metadata: {},
+                },
+              ],
+              sections: [{ id: 1, name: "Sports" }],
+              "story-template": "text",
+              "is-amp-supported": true,
+            },
+          }),
+      });
+    const app = createApp({
+      clientStub: clientStubWithRedirectToWebVersion,
+      enableAmp: true,
+    });
+    supertest(app)
+      .get("/amp/story/cricket/ipl-2021")
+      .expect("Content-Type", /html/)
+      .expect(200)
+      .end((err) => {
+        if (err) return done(err);
+        return done();
+      });
+  });
   it("should redirect to non-amp page if enableAmp is false", (done) => {
     const app = createApp({
       enableAmp: false,
     });
     supertest(app)
-      .get("/amp/cricket/ipl-2021")
+      .get("/amp/story/cricket/ipl-2021")
       .expect(301)
       .expect("Location", "/cricket/ipl-2021")
       .end((err) => {

package/test/unit/amp/amp-story-page-handler.js

@@ -36,6 +36,7 @@ function getClientStub({
 const dummyReq = {
   url: "foo",
   params: "/story/slug",
+  path: "/amp/story/slug",
 };
 const dummyRes = {
   redirect: () => null,