@quintype/framework 7.7.6 → 7.7.8-custom-inifinite-scroller.1

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 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.7](https://github.com/quintype/quintype-node-framework/compare/v7.7.0...v7.7.7) (2022-07-29)
+
+
+### 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))
+* remove prerender query param after the prerender check [#314](https://github.com/quintype/quintype-node-framework/issues/314) ([#317](https://github.com/quintype/quintype-node-framework/issues/317)) ([0067d81](https://github.com/quintype/quintype-node-framework/commit/0067d81fe545a726948db14a44768876b41f6ba8))
+
 ### [7.7.6](https://github.com/quintype/quintype-node-framework/compare/v7.7.5...v7.7.6) (2022-07-28)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/framework",
-  "version": "7.7.6",
+  "version": "7.7.8-custom-inifinite-scroller.1",
   "description": "Libraries to help build Quintype Node.js apps",
   "main": "index.js",
   "engines": {
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "prepublishOnly": "npm test && ./bin-dev-scripts/standard-version-release.sh",
-    "test": "NODE_ENV=test npx mocha --timeout 5000 --recursive --require ./test/babel",
+    "test": "NODE_ENV=test npx mocha --recursive --require ./test/babel",
     "watch-test": "NODE_ENV=test npx mocha --recursive --watch --require ./test/babel",
     "coverage": "nyc --all npm test",
     "coverage-html": "nyc --all --reporter=html npm test",
@@ -31,7 +31,7 @@
   "homepage": "https://github.com/quintype/quintype-node-framework#readme",
   "dependencies": {
     "@ampproject/toolbox-optimizer": "2.8.3",
-    "@quintype/amp": "^2.4.26",
+    "@quintype/amp": "^2.4.29-custom-infinite-scroll.1",
     "@quintype/backend": "^2.3.1",
     "@quintype/components": "^3.0.0",
     "@quintype/prerender-node": "^3.2.26",

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

@@ -86,15 +86,23 @@ async function ampStoryPageHandler(
     const seoTags =
       seoInstance && seoInstance.getMetaTags(config, "story-page-amp", { data: { story, timezone }, config }, { url });
 
-    const infiniteScrollAmp = new InfiniteScrollAmp({
-      ampConfig,
-      publisherConfig: config,
-      client,
-    });
-    const infiniteScrollInlineConfig = await infiniteScrollAmp.getInitialInlineConfig({
-      itemsToTake: 5,
-      storyId: story["story-content-id"],
-    });
+    const infiniteScroll = get(opts, ["featureConfig", "infiniteScroll"], "");
+    let infiniteScrollInlineConfig = [];
+
+    if (infiniteScroll.source === "custom") {
+      infiniteScrollInlineConfig = await infiniteScroll.inlineConfig({ offset: 0, limit: 5 });
+    } else {
+      const infiniteScrollAmp = new InfiniteScrollAmp({
+        ampConfig,
+        publisherConfig: config,
+        client,
+        infiniteScroll,
+      });
+      infiniteScrollInlineConfig = await infiniteScrollAmp.getInitialInlineConfig({
+        itemsToTake: 5,
+        story: story,
+      });
+    }
     if (infiniteScrollInlineConfig instanceof Error) return next(infiniteScrollInlineConfig);
     if (infiniteScrollInlineConfig) {
       set(

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

@@ -1,9 +1,9 @@
 class InfiniteScrollAmp {
-  constructor({ ampConfig, client, publisherConfig, queryParams }) {
+  constructor({ ampConfig, client, publisherConfig, queryParams, infiniteScroll }) {
     this.client = client;
     this.publisherConfig = publisherConfig;
     this.queryParams = queryParams;
-    this.collSlug = "amp-infinite-scroll"; // this is hardcoded to "amp-infinite-scroll" temporarily. Ideally it should come from ampConfig from platform
+    this.infiniteScroll = infiniteScroll;
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -17,6 +17,14 @@ class InfiniteScrollAmp {
     );
   }
 
+  getFilteredApiItems(relatedStories) {
+    return relatedStories.filter(
+      (story) =>
+        story.access !== "subscription" &&
+        story["story-template"] !== "visual-story"
+    );
+  }
+
   formatData({ itemsArr, type }) {
     // formats configuration as per need of amp infinite scroll
     const arr = itemsArr.map((item) => ({
@@ -44,31 +52,46 @@ class InfiniteScrollAmp {
   async getResponse({ itemsTaken }) {
     const { "story-id": storyId } = this.queryParams;
     if (!storyId) return new Error(`Query param "story-id" missing`);
-
-    const collection = await this.client.getCollectionBySlug(this.collSlug);
-    if (!collection || collection.error)
-      return new Error(`Infinite scroll collection ${this.collSlug} returned falsy value`);
-    const filteredItems = this.getFilteredCollItems(collection, storyId);
+    let filteredItems = [];
+    const sourceType = this.infiniteScroll && this.infiniteScroll.source;
+    if (sourceType === "relatedStoriesApi") {
+      const story = await this.client.getStoryById(storyId);
+      const relatedStoriesList = await story.getRelatedStories(this.client);
+      if (!relatedStoriesList)
+        return new Error(`RelatedStories List returned falsy value`);
+      filteredItems = this.getFilteredApiItems(relatedStoriesList);
+    } else {
+      const collection = await this.client.getCollectionBySlug("amp-infinite-scroll");
+      if (!collection || collection.error)
+        return new Error(`Infinite scroll collection amp-infinite-scroll returned falsy value`);
+      filteredItems = this.getFilteredCollItems(collection, storyId);
+    }
     const slicedItems = filteredItems.slice(itemsTaken);
     const formattedData = this.formatData({ itemsArr: slicedItems });
-
     return JSON.stringify(formattedData);
   }
 
-  async getInitialInlineConfig({ itemsToTake, storyId }) {
+  async getInitialInlineConfig({ itemsToTake, story }) {
+    const storyId = story && story["story-content-id"];
     if (!itemsToTake || !storyId) return new Error("Required params for getInitialInlineConfig missing");
-
-    const collection = await this.client.getCollectionBySlug(this.collSlug);
-    if (!collection || (collection.items && !collection.items.length) || collection.error) return null;
-    const filteredItems = this.getFilteredCollItems(collection, storyId);
+    const sourceType = this.infiniteScroll && this.infiniteScroll.source;
+    let filteredItems = [];
+    if (sourceType === "relatedStoriesApi") {
+      const relatedStoriesList = await story.getRelatedStories(this.client);
+      if (!relatedStoriesList)
+        return new Error(`RelatedStories List returned falsy value`);
+      filteredItems = this.getFilteredApiItems(relatedStoriesList);
+    } else {
+      const collection = await this.client.getCollectionBySlug("amp-infinite-scroll");
+      if (!collection || (collection.items && !collection.items.length) || collection.error) return null;
+      filteredItems = this.getFilteredCollItems(collection, storyId);
+    }
     const slicedItems = filteredItems.slice(0, itemsToTake);
     const formattedData = this.formatData({
       itemsArr: slicedItems,
       type: "inline",
     });
-
     return JSON.stringify(formattedData);
   }
 }
-
 module.exports = InfiniteScrollAmp;

package/test/unit/amp/infinite-scroll-helper.js

@@ -3,8 +3,17 @@
 
 const assert = require("assert");
 const InfiniteScrollAmp = require("../../../server/amp/helpers/infinite-scroll");
+const { getTextStory } = require("../../data/amp-test-data");
 
 function getClientStub({
+  getStoryById = (id) =>
+    new Promise((resolve) => {
+      if (id === "4444")
+        resolve({
+          story: getTextStory({ "story-content-id": "7f3d5bdb-ec52-4047-ac0d-df4036ec974b" }),
+        });
+      resolve(null);
+    }),
   getCollectionBySlug = (slug) =>
     new Promise((resolve) => {
       if (slug === "amp-infinite-scroll")
@@ -83,6 +92,7 @@ function getClientStub({
 } = {}) {
   return {
     getCollectionBySlug,
+    getStoryById
   };
 }
 const dummyPublisherConfig = {
@@ -118,7 +128,13 @@ describe("getInitialInlineConfig method of InfiniteScrollAmp helper function", f
     });
     const inlineConfig = await infiniteScrollAmp.getInitialInlineConfig({
       itemsToTake: 5,
-      storyId: 2222,
+      story: {
+        "story-template": "text",
+        headline: "aaa",
+        "story-content-id": 1111,
+        slug: "sports/aa",
+        "hero-image-s3-key": "aa/a.jpg",
+      },
     });
     assert.strictEqual(inlineConfig, null);
   });
@@ -138,7 +154,13 @@ describe("getInitialInlineConfig method of InfiniteScrollAmp helper function", f
     });
     const inlineConfig = await infiniteScrollAmp.getInitialInlineConfig({
       itemsToTake: 5,
-      storyId: 2222,
+      story: {
+        "story-template": "text",
+        headline: "aaa",
+        "story-content-id": 1111,
+        slug: "sports/aa",
+        "hero-image-s3-key": "aa/a.jpg",
+      },
     });
     assert.strictEqual(inlineConfig, null);
   });
@@ -151,7 +173,13 @@ describe("getInitialInlineConfig method of InfiniteScrollAmp helper function", f
     });
     const inlineConfig = await infiniteScrollAmp.getInitialInlineConfig({
       itemsToTake: 5,
-      storyId: 2222,
+      story: {
+        "story-template": "text",
+        headline: "aaa",
+        "story-content-id": 1111,
+        slug: "sports/aa",
+        "hero-image-s3-key": "aa/a.jpg",
+      },
     });
     assert.strictEqual(false, /sports\/bb/.test(inlineConfig));
     assert.strictEqual(false, /bb\/b.jpg/.test(inlineConfig));
@@ -165,7 +193,13 @@ describe("getInitialInlineConfig method of InfiniteScrollAmp helper function", f
     });
     const inlineConfig = await infiniteScrollAmp.getInitialInlineConfig({
       itemsToTake: 5,
-      storyId: 3333,
+      story: {
+        "story-template": "text",
+        headline: "aaa",
+        "story-content-id": 1111,
+        slug: "sports/aa",
+        "hero-image-s3-key": "aa/a.jpg",
+      },
     });
     assert.strictEqual(false, /sports\/bb/.test(inlineConfig));
     assert.strictEqual(false, /bb\/b.jpg/.test(inlineConfig));
@@ -180,7 +214,13 @@ describe("getInitialInlineConfig method of InfiniteScrollAmp helper function", f
     });
     const inlineConfig = await infiniteScrollAmp.getInitialInlineConfig({
       itemsToTake: 5,
-      storyId: 2222,
+      story: {
+        "story-template": "text",
+        headline: "aaa",
+        "story-content-id": 1111,
+        slug: "sports/aa",
+        "hero-image-s3-key": "aa/a.jpg",
+      },
     });
     function isInlineConfigStructureValid(jsonStr) {
       const stories = JSON.parse(jsonStr);
@@ -225,6 +265,7 @@ describe("getResponse method of InfiniteScrollAmp helper function", function ()
       client: clientStub,
       publisherConfig: dummyPublisherConfig,
       queryParams: { "story-id": 2222 },
+      infiniteScroll: { "source": "" }
     });
     const jsonResponse = await infiniteScrollAmp.getResponse({ itemsTaken: 2 });
     assert.strictEqual(jsonResponse instanceof Error, true);