@quintype/framework 7.7.4 → 7.8.0-prerender-query-param.0

package/CHANGELOG.md

@@ -2,15 +2,6 @@
 
 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.7.4](https://github.com/quintype/quintype-node-framework/compare/v7.7.3...v7.7.4) (2022-07-13)
-
-### [7.7.3](https://github.com/quintype/quintype-node-framework/compare/v7.7.2...v7.7.3) (2022-07-13)
-
-
-### Bug Fixes
-
-* remove prerender query param after the prerender check ([#314](https://github.com/quintype/quintype-node-framework/issues/314)) ([94eac28](https://github.com/quintype/quintype-node-framework/commit/94eac28bfd04483cc665c5ce4d2fc8768c84a31b))
-
 ### [7.7.2](https://github.com/quintype/quintype-node-framework/compare/v7.7.1...v7.7.2) (2022-07-08)
 
 ### [7.7.1](https://github.com/quintype/quintype-node-framework/compare/v7.7.0...v7.7.1) (2022-07-06)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/framework",
-  "version": "7.7.4",
+  "version": "7.8.0-prerender-query-param.0",
   "description": "Libraries to help build Quintype Node.js apps",
   "main": "index.js",
   "engines": {
@@ -31,7 +31,7 @@
   "homepage": "https://github.com/quintype/quintype-node-framework#readme",
   "dependencies": {
     "@ampproject/toolbox-optimizer": "2.8.3",
-    "@quintype/amp": "^2.4.25",
+    "@quintype/amp": "^2.4.23",
     "@quintype/backend": "^2.3.1",
     "@quintype/components": "^3.0.0",
     "@quintype/prerender-node": "^3.2.24",

package/server/amp/handlers/index.js

@@ -1,7 +1,9 @@
 const { ampStoryPageHandler } = require("./story-page");
 const { storyPageInfiniteScrollHandler } = require("./infinite-scroll");
+const { bookendHandler } = require("./visual-stories-bookend");
 
 module.exports = {
   ampStoryPageHandler,
   storyPageInfiniteScrollHandler,
+  bookendHandler,
 };

package/server/amp/handlers/visual-stories-bookend.js

@@ -0,0 +1,77 @@
+const get = require("lodash/get");
+
+function getStoryUrl(story, config) {
+  if (get(story, ["story-template"]) === "news-elsewhere") {
+    return get(story, ["metadata", "reference-url"], "");
+  }
+  return `${config["sketches-host"]}/${story.slug}`;
+}
+
+async function bookendHandler(req, res, next, { config, client, sMaxAge = "900" }) {
+  const { storyId, sectionId } = req.query;
+  if (!storyId || !sectionId) {
+    res.status(400).json({
+      error: {
+        message: "Please provide 'storyId' and 'sectionId' query parameters",
+      },
+    });
+    return;
+  }
+
+  const relatedStoriesResponse = await client.getRelatedStories(storyId, sectionId);
+  const relatedStories = relatedStoriesResponse["related-stories"];
+
+  if (!relatedStories.length) {
+    res.status(404).json({ error: { message: "Not Found" } });
+    return;
+  }
+
+  const fbAppId = get(config, ["public-integrations", "facebook", "app-id"], "");
+
+  const jsonPayLoad = {
+    bookendVersion: "v1.0",
+    shareProviders: [
+      "twitter",
+      "email",
+      {
+        provider: "facebook",
+        app_id: fbAppId,
+      },
+      "whatsapp",
+      "linkedin",
+      "gplus",
+    ],
+    components: [].concat(
+      [
+        {
+          type: "heading",
+          text: "More to read",
+        },
+      ],
+      relatedStories.map((story) => ({
+        type: "small",
+        title: `${story.headline}`,
+        image: `${config["cdn-name"]}${story["hero-image-s3-key"]}?w=480&auto=format&compress`,
+        url: getStoryUrl(story, config),
+      })),
+      [
+        {
+          type: "cta-link",
+          links: [
+            {
+              text: "More stories",
+              url: `${config["sketches-host"]}`,
+            },
+          ],
+        },
+      ]
+    ),
+  };
+
+  res.header("Cache-Control", `public,max-age=15,s-maxage=${sMaxAge},stale-while-revalidate=1000,stale-if-error=14400`);
+  res.header("Vary", "Accept-Encoding");
+
+  res.json(jsonPayLoad);
+}
+
+module.exports = { bookendHandler };

package/server/routes.js

@@ -345,8 +345,10 @@ exports.isomorphicRoutes = function isomorphicRoutes(
   if (prerenderServiceUrl) {
     app.use((req, res, next) => {
       if (req.query.prerender) {
+        delete req.query.prerender;
         try {
           // eslint-disable-next-line global-require
+          prerender.set("protocol", "https");
           prerender.set("prerenderServiceUrl", prerenderServiceUrl)(req, res, next);
         } catch (e) {
           logError(e);
@@ -626,9 +628,10 @@ exports.mountQuintypeAt = function (app, mountAt) {
  *
  */
 exports.ampRoutes = (app, opts = {}) => {
-  const { ampStoryPageHandler, storyPageInfiniteScrollHandler } = require("./amp/handlers");
+  const { ampStoryPageHandler, storyPageInfiniteScrollHandler, bookendHandler } = require("./amp/handlers");
 
   getWithConfig(app, "/amp/story/*", ampStoryPageHandler, opts);
   getWithConfig(app, "/amp/api/v1/amp-infinite-scroll", storyPageInfiniteScrollHandler, opts);
+  getWithConfig(app, "/amp/api/v1/bookend.json", bookendHandler, opts);
   getWithConfig(app, "/ampstories/*", ampStoryPageHandler, { ...opts, isVisualStory: true });
 };

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

@@ -446,3 +446,41 @@ describe("Amp infinite scroll handler", () => {
       });
   });
 });
+
+describe("Amp visual stories bookend handler", () => {
+  it("returns the bookend if there are related stories", function (done) {
+    const app = createApp({
+      clientStub: getClientStubWithRelatedStories([{ headline: "foo" }]),
+    });
+    supertest(app)
+      .get("/amp/api/v1/bookend.json?storyId=111&sectionId=222")
+      .expect("Content-Type", /json/)
+      .expect("Cache-Control", /public/)
+      .expect(200)
+      .then((res) => {
+        const response = JSON.parse(res.text);
+        assert.equal("v1.0", response.bookendVersion);
+        assert.equal(3, response.components.length);
+        assert.equal("foo", response.components[1].title);
+      })
+      .then(() => done());
+  });
+  it("returns a 404 if there are no related stories", (done) => {
+    const app = createApp({ clientStub: getClientStubWithRelatedStories([]) });
+    supertest(app)
+      .get("/amp/api/v1/bookend.json?storyId=111&sectionId=222")
+      .expect("Content-Type", /json/)
+      .expect(404)
+      .then(() => done());
+  });
+  it("returns a 400 if 'storyId' and 'sectionId' query params aren't passed", (done) => {
+    const app = createApp({
+      clientStub: getClientStubWithRelatedStories([{ headline: "foo" }]),
+    });
+    supertest(app)
+      .get("/amp/api/v1/bookend.json")
+      .expect("Content-Type", /json/)
+      .expect(400)
+      .then(() => done());
+  });
+});