@quintype/framework 7.10.5-infinite-scroll-tests.0 → 7.11.0-react-upgrade.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/framework",
-  "version": "7.10.5-infinite-scroll-tests.0",
+  "version": "7.11.0-react-upgrade.0",
   "description": "Libraries to help build Quintype Node.js apps",
   "main": "index.js",
   "engines": {
@@ -31,11 +31,11 @@
   "homepage": "https://github.com/quintype/quintype-node-framework#readme",
   "dependencies": {
     "@ampproject/toolbox-optimizer": "2.8.3",
-    "@quintype/amp": "^2.6.0",
-    "@quintype/backend": "^2.3.2",
+    "@quintype/amp": "^2.5.0",
+    "@quintype/backend": "^2.3.1",
     "@quintype/components": "^3.0.0",
     "@quintype/prerender-node": "^3.2.26",
-    "@quintype/seo": "^1.39.0",
+    "@quintype/seo": "1.40.12-react-upgrade.0",
     "atob": "^2.1.2",
     "babel-plugin-react-css-modules": "^5.2.6",
     "chalk": "^4.1.2",
@@ -52,8 +52,8 @@
     "mocha-snapshots": "^4.2.0",
     "morgan": "^1.10.0",
     "path-to-regexp": "^6.2.0",
-    "react": "^16.14.0",
-    "react-dom": "^16.14.0",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
     "react-redux": "^7.2.5",
     "react-router": "^5.2.1",
     "redux": "^4.1.1",
@@ -99,7 +99,7 @@
     "supertest": "^6.1.6"
   },
   "peerDependencies": {
-    "@quintype/seo": "^1.39.0"
+    "@quintype/seo": "1.40.12-react-upgrade.0"
   },
   "nyc": {
     "exclude": [

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

@@ -57,7 +57,7 @@ class InfiniteScrollAmp {
     };
     if (this.infiniteScrollSource === "relatedStoriesApi") {
       const relatedStoriesList = await this.client.getRelatedStories(storyId, null, params);
-      if (!relatedStoriesList || (relatedStoriesList["related-stories"] && !relatedStoriesList["related-stories"].length) || relatedStoriesList["related-stories"].error || relatedStoriesList === null)
+      if (!relatedStoriesList)
         return new Error();
       return filteredItems = this.getFilteredApiItems(relatedStoriesList["related-stories"]);
     } else {

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")
@@ -113,156 +122,7 @@ function getClientStub({
 } = {}) {
   return {
     getCollectionBySlug,
-  };
-}
-
-function getRelatedStoriesClientStub({
-  getRelatedStories = () =>
-    new Promise((resolve) => {
-      resolve({
-        "related-stories": [
-          {
-            "story-template": "text",
-            headline: "aaa",
-            "story-content-id": 1111,
-            slug: "sports/aa",
-            "hero-image-s3-key": "aa/a.jpg",
-            access: "public",
-          },
-          {
-            "story-template": "visual-story",
-            headline: "bbb",
-            "story-content-id": 2222,
-            slug: "sports/bb",
-            "hero-image-s3-key": "bb/b.jpg",
-            access: "public",
-          },
-          {
-            "story-template": "text",
-            headline: "ccc",
-            "story-content-id": 3333,
-            slug: "sports/cc",
-            "hero-image-s3-key": "cc/c.jpg",
-            access: "public",
-          },
-          {
-            "story-template": "text",
-            headline: "ddd",
-            "story-content-id": 4444,
-            slug: "sports/dd",
-            "hero-image-s3-key": "dd/d.jpg",
-            access: "public",
-          },
-          {
-            "story-template": "text",
-            headline: "eee",
-            "story-content-id": 5555,
-            slug: "politics/ee",
-            "hero-image-s3-key": "ee/e.jpg",
-            access: "public",
-          },
-          {
-            "story-template": "text",
-            headline: "fff",
-            "story-content-id": 6666,
-            slug: "politics/ff",
-            "hero-image-s3-key": "ff/f.jpg",
-            access: "public",
-          },
-          {
-            "story-template": "text",
-            headline: "ggg",
-            "story-content-id": 7777,
-            slug: "politics/gg",
-            "hero-image-s3-key": "gg/g.jpg",
-            access: "public",
-          },
-          {
-            "story-template": "text",
-            headline: "hhh",
-            "story-content-id": 8888,
-            slug: "politics/hh",
-            "hero-image-s3-key": "hh/h.jpg",
-            access: "public",
-          },
-        ],
-      });
-    }),
-} = {}) {
-  return {
-    getRelatedStories,
-  };
-}
-
-function getCustomApiStoriesClientStub({
-  getCustomApiStories = () =>
-    new Promise((resolve) => {
-      resolve(
-        [
-          {
-            title: "aaa",
-            url: "sports/aa",
-            image: "aa/a.jpg",
-          },
-          {
-            title: "bbb",
-            url: "sports/bb",
-            image: "bb/b.jpg",
-          },
-          {
-            title: "ccc",
-            url: "sports/cc",
-            image: "cc/c.jpg",
-          },
-          {
-            title: "ddd",
-            url: "sports/dd",
-            image: "dd/d.jpg",
-          },
-          {
-            title: "eee",
-            url: "politics/ee",
-            image: "ee/e.jpg",
-          },
-          {
-            title: "fff",
-            url: "politics/ff",
-            image: "ff/f.jpg",
-          },
-          {
-            title: "ggg",
-            url: "politics/gg",
-            image: "gg/g.jpg",
-          },
-          {
-            title: "hhh",
-            url: "politics/hh",
-            image: "hh/h.jpg",
-          },
-        ]
-      );
-    }),
-} = {}) {
-  return {
-    getCustomApiStories,
-  };
-}
-class CustomInfiniteScrollAmp {
-  constructor({ client, publisherConfig, queryParams, infiniteScrollSource }) {
-    this.client = client;
-    this.publisherConfig = publisherConfig;
-    this.queryParams = queryParams;
-    this.infiniteScrollSource = infiniteScrollSource;
-  }
-
-  async getCustomStoryList({ type = "inlineConfig" }) {
-    const customStories = await this.client.getCustomApiStories();
-    if (!customStories || customStories === null || customStories.length === 0)
-      return new Error();
-    if (type === "remoteConfig") {
-      return JSON.stringify({ pages: customStories });
-    }
-    return JSON.stringify(customStories);
+    getStoryById,
   };
 }
 const dummyPublisherConfig = {
@@ -270,7 +130,6 @@ const dummyPublisherConfig = {
 };
 
 describe("getInitialInlineConfig method of InfiniteScrollAmp helper function", function () {
-  // collection
   it("should throw err if storyId isn't passed", async function () {
     const infiniteScrollAmp = new InfiniteScrollAmp({
       ampConfig: {},
@@ -371,166 +230,9 @@ describe("getInitialInlineConfig method of InfiniteScrollAmp helper function", f
   // it("should take the first 'n' stories", async function() {
   //   // this test needs to be written after https://github.com/quintype/quintype-node-framework/pull/202 is merged
   // })
-  /// related-stories
-  it("should throw err if storyId isn't passed for relatedStoriesApi", async function () {
-    const infiniteScrollAmp = new InfiniteScrollAmp({
-      ampConfig: {},
-      client: getRelatedStoriesClientStub(),
-      publisherConfig: dummyPublisherConfig,
-      infiniteScrollSource: "relatedStoriesApi",
-    });
-    const inlineConfig = await infiniteScrollAmp.getInitialInlineConfig({ storyId: "" });
-    assert.strictEqual(inlineConfig instanceof Error, true);
-    assert.throws(() => {
-      throw new Error("Required params for getInitialInlineConfig missing");
-    }, inlineConfig);
-  });
-
-  it("should return null if relatedStoriesApi infinite scroll collection doesn't exist", async function () {
-    const clientStub = getRelatedStoriesClientStub({
-      getRelatedStories: () =>
-        new Promise((resolve) => {
-          resolve(null);
-        }),
-    });
-    const infiniteScrollAmp = new InfiniteScrollAmp({
-      ampConfig: {},
-      client: clientStub,
-      publisherConfig: dummyPublisherConfig,
-      infiniteScrollSource: "relatedStoriesApi",
-    });
-    const inlineConfig = await infiniteScrollAmp.getInitialInlineConfig({
-      storyId: 2222,
-    });
-    assert.strictEqual(inlineConfig, null);
-  });
-
-  it("should return null if relatedStoriesApi infinite scroll collection contains no stories", async function () {
-    const clientStub = getRelatedStoriesClientStub({
-      getRelatedStories: () =>
-        new Promise((resolve) => {
-          resolve({
-            "related-stories": [],
-          });
-        }),
-    });
-    const infiniteScrollAmp = new InfiniteScrollAmp({
-      ampConfig: {},
-      client: clientStub,
-      publisherConfig: dummyPublisherConfig,
-      infiniteScrollSource: "relatedStoriesApi",
-    });
-    const inlineConfig = await infiniteScrollAmp.getInitialInlineConfig({
-      storyId: 2222,
-    });
-    assert.strictEqual(inlineConfig, null);
-  });
-
-  it("should remove visual stories from relatedStoriesApi infinite scroll", async function () {
-    const clientStub = getRelatedStoriesClientStub();
-    const infiniteScrollAmp = new InfiniteScrollAmp({
-      ampConfig: {},
-      client: clientStub,
-      publisherConfig: dummyPublisherConfig,
-      infiniteScrollSource: "relatedStoriesApi",
-    });
-    const inlineConfig = await infiniteScrollAmp.getInitialInlineConfig({
-      storyId: 3333,
-    });
-
-    assert.strictEqual(false, /sports\/bb/.test(inlineConfig));
-    assert.strictEqual(false, /bb\/b.jpg/.test(inlineConfig));
-  });
-
-  it("Related Stories Response should be in JSON format as per AMP spec", async function () {
-    // https://amp.dev/documentation/components/amp-next-page/
-    const clientStub = getRelatedStoriesClientStub();
-    const infiniteScrollAmp = new InfiniteScrollAmp({
-      ampConfig: {},
-      client: clientStub,
-      publisherConfig: dummyPublisherConfig,
-      infiniteScrollSource: "relatedStoriesApi",
-    });
-    const inlineConfig = await infiniteScrollAmp.getInitialInlineConfig({
-      storyId: 2222,
-    });
-    function isInlineConfigStructureValid(jsonStr) {
-      const stories = JSON.parse(jsonStr);
-      if (!stories.length) throw new Error("Can't verify empty array!");
-      stories.forEach((story) => {
-        const keys = Object.keys(story);
-        if (keys.includes("image") && keys.includes("url") && keys.includes("title") && keys.length === 3) return;
-        throw new Error("Invalid InlineConfigStructure");
-      });
-      return true;
-    }
-    assert.strictEqual(isInlineConfigStructureValid(inlineConfig), true);
-  });
-
-  /// custom-stories
-  it("should return null if CustomApi Stories infinite scroll collection doesn't exist", async function () {
-    const clientStub = getCustomApiStoriesClientStub({
-      getCustomApiStories: () =>
-        new Promise((resolve) => {
-          resolve(null);
-        }),
-    });
-    const customInfiniteScrollAmp = new CustomInfiniteScrollAmp({
-      client: clientStub,
-      publisherConfig: dummyPublisherConfig,
-      infiniteScrollSource: "custom",
-    });
-    const inlineConfig = await customInfiniteScrollAmp.getCustomStoryList({
-      type: "inlineConfig",
-    });
-    assert.strictEqual(inlineConfig instanceof Error, true);
-  });
-
-  it("should return null if CustomApi Stories infinite scroll collection contains no stories", async function () {
-    const clientStub = getCustomApiStoriesClientStub({
-      getCustomApiStories: () =>
-        new Promise((resolve) => {
-          resolve([]);
-        }),
-    });
-    const customInfiniteScrollAmp = new CustomInfiniteScrollAmp({
-      client: clientStub,
-      publisherConfig: dummyPublisherConfig,
-      infiniteScrollSource: "custom",
-    });
-    const inlineConfig = await customInfiniteScrollAmp.getCustomStoryList({
-      type: "inlineConfig",
-    });
-    assert.strictEqual(inlineConfig instanceof Error, true);
-  });
-
-  it("CustomApi Stories Response should be in JSON format as per AMP spec", async function () {
-    // https://amp.dev/documentation/components/amp-next-page/
-    const clientStub = getCustomApiStoriesClientStub();
-    const customInfiniteScrollAmp = new CustomInfiniteScrollAmp({
-      client: clientStub,
-      publisherConfig: dummyPublisherConfig,
-      infiniteScrollSource: "custom",
-    });
-    const inlineConfig = await customInfiniteScrollAmp.getCustomStoryList({
-      type: "inlineConfig",
-    });
-    function isInlineConfigStructureValid(jsonStr) {
-      const stories = JSON.parse(jsonStr);
-      if (!stories.length) throw new Error("Can't verify empty array!");
-      stories.forEach((story) => {
-        const keys = Object.keys(story);
-        if (keys.includes("image") && keys.includes("url") && keys.includes("title") && keys.length === 3) return;
-        throw new Error("Invalid InlineConfigStructure");
-      });
-      return true;
-    }
-    assert.strictEqual(isInlineConfigStructureValid(inlineConfig), true);
-  });
 });
 
 describe("getResponse method of InfiniteScrollAmp helper function", function () {
-  // collection
   it("should throw an error if 'story-id' isn't passed as query param", async function () {
     const infiniteScrollAmp = new InfiniteScrollAmp({
       ampConfig: {},
@@ -538,7 +240,7 @@ describe("getResponse method of InfiniteScrollAmp helper function", function ()
       publisherConfig: dummyPublisherConfig,
       queryParams: { foo: "bar" },
     });
-    const jsonResponse = await infiniteScrollAmp.getResponse();
+    const jsonResponse = await infiniteScrollAmp.getResponse({ itemsTaken: 2 });
     assert.strictEqual(jsonResponse instanceof Error, true);
     assert.throws(() => {
       throw new Error(`Query param "story-id" missing`);
@@ -557,7 +259,7 @@ describe("getResponse method of InfiniteScrollAmp helper function", function ()
       publisherConfig: dummyPublisherConfig,
       queryParams: { "story-id": 2222 },
     });
-    const jsonResponse = await infiniteScrollAmp.getResponse();
+    const jsonResponse = await infiniteScrollAmp.getResponse({ itemsTaken: 2 });
     assert.strictEqual(jsonResponse instanceof Error, true);
   });
   it("should remove current story from response", async function () {
@@ -568,7 +270,7 @@ describe("getResponse method of InfiniteScrollAmp helper function", function ()
       publisherConfig: dummyPublisherConfig,
       queryParams: { "story-id": 4444 },
     });
-    const jsonResponse = await infiniteScrollAmp.getResponse();
+    const jsonResponse = await infiniteScrollAmp.getResponse({ itemsTaken: 2 });
     assert.strictEqual(false, /sports\/dd/.test(jsonResponse));
     assert.strictEqual(false, /dd\/d.jpg/.test(jsonResponse));
   });
@@ -580,7 +282,7 @@ describe("getResponse method of InfiniteScrollAmp helper function", function ()
       publisherConfig: dummyPublisherConfig,
       queryParams: { "story-id": 4444 },
     });
-    const jsonResponse = await infiniteScrollAmp.getResponse();
+    const jsonResponse = await infiniteScrollAmp.getResponse({ itemsTaken: 2 });
     assert.strictEqual(false, /sports\/bb/.test(jsonResponse));
     assert.strictEqual(false, /bb\/b.jpg/.test(jsonResponse));
   });
@@ -593,7 +295,7 @@ describe("getResponse method of InfiniteScrollAmp helper function", function ()
       publisherConfig: dummyPublisherConfig,
       queryParams: { "story-id": 4444 },
     });
-    const jsonResponse = await infiniteScrollAmp.getResponse();
+    const jsonResponse = await infiniteScrollAmp.getResponse({ itemsTaken: 2 });
     function isJsonConfigStructureValid(jsonStr) {
       const parsed = JSON.parse(jsonStr);
       const stories = parsed.pages;
@@ -610,120 +312,4 @@ describe("getResponse method of InfiniteScrollAmp helper function", function ()
   // it("should omit the first 'n' stories, take the rest", async function() {
   //   // this test needs to be written after https://github.com/quintype/quintype-node-framework/pull/202 is merged
   // })
-  // related-stories
-  it("should throw an error if 'story-id' isn't passed as query param in relatedStoriesApi", async function () {
-    const infiniteScrollAmp = new InfiniteScrollAmp({
-      ampConfig: {},
-      client: getRelatedStoriesClientStub(),
-      publisherConfig: dummyPublisherConfig,
-      queryParams: { foo: "bar" },
-      infiniteScrollSource: "relatedStoriesApi",
-    });
-    const jsonResponse = await infiniteScrollAmp.getResponse();
-    assert.strictEqual(jsonResponse instanceof Error, true);
-    assert.throws(() => {
-      throw new Error(`Query param "story-id" missing`);
-    }, jsonResponse);
-  });
-
-  it("should throw an error if relatedStoriesApi infinite scroll collection doesn't exist", async function () {
-    const clientStub = getRelatedStoriesClientStub({
-      getRelatedStories: () =>
-        new Promise((resolve) => {
-          resolve(null);
-        }),
-    });
-    const infiniteScrollAmp = new InfiniteScrollAmp({
-      ampConfig: {},
-      client: clientStub,
-      publisherConfig: dummyPublisherConfig,
-      queryParams: { "story-id": 2222 },
-      infiniteScrollSource: "relatedStoriesApi",
-    });
-    const jsonResponse = await infiniteScrollAmp.getResponse();
-    assert.strictEqual(jsonResponse instanceof Error, true);
-  });
-
-  it("should remove visual stories from relatedStoriesApi response", async function () {
-    const clientStub = getRelatedStoriesClientStub();
-    const infiniteScrollAmp = new InfiniteScrollAmp({
-      ampConfig: {},
-      client: clientStub,
-      publisherConfig: dummyPublisherConfig,
-      queryParams: { "story-id": 4444 },
-      infiniteScrollSource: "relatedStoriesApi",
-    });
-    const jsonResponse = await infiniteScrollAmp.getResponse();
-    assert.strictEqual(false, /sports\/bb/.test(jsonResponse));
-    assert.strictEqual(false, /bb\/b.jpg/.test(jsonResponse));
-  });
-
-  it("should format JSON as per AMP spec in relatedStoriesApi", async function () {
-    // https://amp.dev/documentation/components/amp-next-page/
-    const clientStub = getRelatedStoriesClientStub();
-    const infiniteScrollAmp = new InfiniteScrollAmp({
-      ampConfig: {},
-      client: clientStub,
-      publisherConfig: dummyPublisherConfig,
-      queryParams: { "story-id": 4444 },
-      infiniteScrollSource: "relatedStoriesApi",
-    });
-    const jsonResponse = await infiniteScrollAmp.getResponse();
-    function isJsonConfigStructureValid(jsonStr) {
-      const parsed = JSON.parse(jsonStr);
-      const stories = parsed.pages;
-      if (!stories.length) throw new Error("Can't verify empty array!");
-      stories.forEach((story) => {
-        const keys = Object.keys(story);
-        if (keys.includes("image") && keys.includes("url") && keys.includes("title") && keys.length === 3) return;
-        throw new Error("Invalid InlineConfigStructure");
-      });
-      return true;
-    }
-    assert.strictEqual(isJsonConfigStructureValid(jsonResponse), true);
-  });
-
-  // custom-stories
-  it("should throw an error if customApi infinite scroll collection doesn't exist", async function () {
-    const clientStub = getCustomApiStoriesClientStub({
-      getCustomApiStories: () =>
-        new Promise((resolve) => {
-          resolve(null);
-        }),
-    });
-    const customInfiniteScrollAmp = new CustomInfiniteScrollAmp({
-      client: clientStub,
-      publisherConfig: dummyPublisherConfig,
-      infiniteScrollSource: "custom",
-    });
-    const jsonResponse = await customInfiniteScrollAmp.getCustomStoryList({
-      type: "remoteConfig",
-    });
-    assert.strictEqual(jsonResponse instanceof Error, true);
-  });
-
-  it("should format JSON as per AMP spec in customApi list", async function () {
-    // https://amp.dev/documentation/components/amp-next-page/
-    const clientStub = getCustomApiStoriesClientStub();
-    const customInfiniteScrollAmp = new CustomInfiniteScrollAmp({
-      client: clientStub,
-      publisherConfig: dummyPublisherConfig,
-      infiniteScrollSource: "custom",
-    });
-    const jsonResponse = await customInfiniteScrollAmp.getCustomStoryList({
-      type: "remoteConfig",
-    });
-    function isJsonConfigStructureValid(jsonStr) {
-      const parsed = JSON.parse(jsonStr);
-      const stories = parsed.pages;
-      if (!stories.length) throw new Error("Can't verify empty array!");
-      stories.forEach((story) => {
-        const keys = Object.keys(story);
-        if (keys.includes("image") && keys.includes("url") && keys.includes("title") && keys.length === 3) return;
-        throw new Error("Invalid InlineConfigStructure");
-      });
-      return true;
-    }
-    assert.strictEqual(isJsonConfigStructureValid(jsonResponse), true);
-  });
 });