@quintype/framework 6.3.0 → 7.0.1-enable-webengage.1

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 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.0.0](https://github.com/quintype/quintype-node-framework/compare/v6.3.1...v7.0.0) (2021-11-30)
+
+### [6.3.1](https://github.com/quintype/quintype-node-framework/compare/v6.3.0...v6.3.1) (2021-11-25)
+
+
+### Bug Fixes
+
+* remove visual stories from amp infinite scroll ([#282](https://github.com/quintype/quintype-node-framework/issues/282)) ([719f048](https://github.com/quintype/quintype-node-framework/commit/719f0482bcd730604dcc4273cf2e8465f2232fb6))
+
 ## [6.3.0](https://github.com/quintype/quintype-node-framework/compare/v6.2.0...v6.3.0) (2021-11-18)
 
 ## [6.2.0](https://github.com/quintype/quintype-node-framework/compare/v5.0.5...v6.2.0) (2021-10-11)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/framework",
-  "version": "6.3.0",
+  "version": "7.0.1-enable-webengage.1",
   "description": "Libraries to help build Quintype Node.js apps",
   "main": "index.js",
   "scripts": {
@@ -26,75 +26,76 @@
   },
   "homepage": "https://github.com/quintype/quintype-node-framework#readme",
   "dependencies": {
-    "@ampproject/toolbox-optimizer": "2.8.0",
-    "@quintype/amp": "^2.4.15",
+    "@ampproject/toolbox-optimizer": "2.8.3",
+    "@quintype/amp": "^2.4.16-enable-webengage.0",
     "@quintype/backend": "^2.1.0",
-    "@quintype/components": "^2.31.2",
+    "@quintype/components": "^3.0.0",
     "@quintype/prerender-node": "^3.2.24",
     "@quintype/seo": "^1.38.1",
     "atob": "^2.1.2",
+    "chalk": "^4.1.2",
     "cluster": "^0.7.7",
     "compression": "^1.7.4",
-    "ejs": "^2.6.1",
-    "express": "^4.16.4",
-    "firebase": "^6.0.2",
+    "ejs": "^3.1.6",
+    "express": "^4.17.1",
+    "firebase": "^9.1.1",
     "get-youtube-id": "^1.0.1",
     "grpc": "^1.21.1",
-    "http-proxy": "^1.17.0",
-    "js-yaml": "^3.13.1",
-    "lodash": "^4.17.15",
+    "http-proxy": "^1.18.1",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
     "mocha-snapshots": "^4.2.0",
-    "morgan": "^1.9.1",
+    "morgan": "^1.10.0",
     "path-to-regexp": "^6.2.0",
-    "react": "^16.8.6",
-    "react-dom": "^16.8.6",
-    "react-redux": "^7.0.1",
-    "react-router": "^5.0.0",
-    "redux": "^4.0.1",
+    "react": "^16.14.0",
+    "react-dom": "^16.14.0",
+    "react-redux": "^7.2.5",
+    "react-router": "^5.2.1",
+    "redux": "^4.1.1",
     "request-promise": "^4.2.6",
-    "sleep-promise": "^8.0.1",
-    "winston": "3.2.1"
+    "sleep-promise": "^9.1.0",
+    "winston": "3.3.3"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "^7.14.5",
-    "@loadable/component": "^5.14.1",
-    "@loadable/server": "^5.14.2",
-    "@quintype/build": "^3.13.0",
+    "@babel/eslint-parser": "^7.15.7",
+    "@loadable/component": "^5.15.0",
+    "@loadable/server": "^5.15.1",
+    "@quintype/build": "^3.13.1",
     "babel-plugin-quintype-assets": "^1.1.1",
-    "babel-plugin-react-css-modules": "^5.2.4",
+    "babel-plugin-react-css-modules": "^5.2.6",
     "babel-plugin-transform-es2015-modules-commonjs": "^6.26.2",
     "babel-plugin-transform-object-rest-spread": "^6.26.0",
     "babel-preset-es2015": "^6.24.1",
     "babel-preset-es2015-tree-shaking": "^1.0.1",
     "babel-preset-react": "^6.24.1",
     "babel-register": "^6.26.0",
-    "better-docs": "^1.3.0",
-    "eslint": "^5.16.0",
-    "eslint-config-prettier": "^4.1.0",
-    "eslint-config-standard": "^12.0.0",
-    "eslint-plugin-import": "^2.17.2",
-    "eslint-plugin-node": "^8.0.1",
-    "eslint-plugin-prettier": "^3.0.1",
-    "eslint-plugin-promise": "^4.1.1",
-    "eslint-plugin-react": "^7.12.4",
-    "eslint-plugin-standard": "^4.0.1",
-    "gh-pages": "^2.1.1",
-    "history": "^4.9.0",
-    "husky": "^4.3.8",
-    "jsdoc": "^3.6.3",
-    "jsdom": "^14.0.0",
+    "better-docs": "^2.3.2",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-react": "^7.26.1",
+    "eslint-plugin-standard": "^4.1.0",
+    "gh-pages": "^3.2.3",
+    "history": "^5.0.1",
+    "husky": "^7.0.2",
+    "jsdoc": "^3.6.7",
+    "jsdom": "^17.0.0",
     "jsdom-global": "3.0.2",
-    "lint-staged": "^8.1.5",
-    "mocha": "^6.1.4",
-    "nyc": "^14.1.1",
-    "onchange": "^4.1.0",
+    "lint-staged": "^11.2.0",
+    "mocha": "^9.1.2",
+    "nyc": "^15.1.0",
+    "onchange": "^7.1.0",
     "path": "^0.12.7",
-    "prettier": "^2.2.1",
-    "standard-version": "^8.0.1",
-    "supertest": "^4.0.2"
+    "prettier": "^2.4.1",
+    "standard-version": "^9.3.1",
+    "supertest": "^6.1.6"
   },
   "peerDependencies": {
-    "@quintype/seo": "^1.22.0"
+    "@quintype/seo": "^1.39.0"
   },
   "nyc": {
     "exclude": [

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

@@ -9,7 +9,11 @@ class InfiniteScrollAmp {
   // eslint-disable-next-line class-methods-use-this
   getFilteredCollItems(coll, storyId) {
     return coll.items.filter(
-      ({ type, story }) => type === "story" && story["story-content-id"] !== storyId && story.access !== "subscription"
+      ({ type, story }) =>
+        type === "story" &&
+        story["story-content-id"] !== storyId &&
+        story.access !== "subscription" &&
+        story["story-template"] !== "visual-story"
     );
   }
 

package/server/publisher-config.js

@@ -13,6 +13,6 @@
 const fs = require("fs");
 const yaml = require("js-yaml");
 
-const publisher = yaml.safeLoad(fs.readFileSync("config/publisher.yml"));
+const publisher = yaml.load(fs.readFileSync("config/publisher.yml"));
 
 module.exports = publisher;

package/server/start.js

@@ -10,10 +10,12 @@
 // istanbul ignore file
 // This is the start file, to be called from your start.js
 
+const chalk = require('chalk');
 const cluster = require("cluster");
 const process = require("process");
 const { initializeAllClients } = require("./api-client");
 const logger = require("./logger");
+const logSuccess = chalk.bold.cyanBright;
 
 function startMaster({ workers = 4 }) {
   let terminating = false;
@@ -62,7 +64,7 @@ function startMaster({ workers = 4 }) {
 }
 
 async function startWorker(appThunk, opts) {
-  if (process.env.NODE_ENV != "production") {
+  if (process.env.NODE_ENV !== "production") {
     require("@quintype/build")(opts);
   }
   require("../assetify/server")();
@@ -71,9 +73,11 @@ async function startWorker(appThunk, opts) {
     const app = appThunk();
 
     await initializeAllClients();
-    const server = app.listen(opts.port || 3000, () =>
-      console.log(`App listening on port ${opts.port || 3000}!`)
-    );
+    const server = app.listen(opts.port || 3000, () => {
+      console.log(logSuccess(`||=============================||`));
+      console.log(logSuccess(`|| App listening on port ${opts.port || 3000}! ||`))
+      console.log(logSuccess(`||=============================||`));
+    });
 
     process.on("SIGTERM", () => {
       server.close(() => {
@@ -83,7 +87,7 @@ async function startWorker(appThunk, opts) {
     });
     process.on("SIGHUP", () => {});
   } catch (e) {
-    if (process.env.NODE_ENV != "production") {
+    if (process.env.NODE_ENV !== "production") {
       console.log(e.stack);
     }
 

package/server/static-configuration.js

@@ -18,7 +18,7 @@ module.exports = fs
   .readdirSync("config")
   .filter((x) => x.match(/\.yml$/))
   .reduce((acc, x) => {
-    acc[x.replace(/\.yml$/, "")] = yaml.safeLoad(
+    acc[x.replace(/\.yml$/, "")] = yaml.load(
       fs.readFileSync(`config/${x}`)
     );
     return acc;

package/server/utils/apm.js

@@ -0,0 +1,7 @@
+const handleSpanInstance = (_) => {
+    return true;
+};
+
+module.exports = {
+    handleSpanInstance
+};

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

@@ -14,6 +14,7 @@ function getClientStub({
               type: "story",
               id: 1111,
               story: {
+                "story-template": "text",
                 headline: "aaa",
                 "story-content-id": 1111,
                 slug: "sports/aa",
@@ -24,6 +25,7 @@ function getClientStub({
               type: "story",
               id: 2222,
               story: {
+                "story-template": "visual-story",
                 headline: "bbb",
                 "story-content-id": 2222,
                 slug: "sports/bb",
@@ -34,6 +36,7 @@ function getClientStub({
               type: "story",
               id: 3333,
               story: {
+                "story-template": "text",
                 headline: "ccc",
                 "story-content-id": 3333,
                 slug: "sports/cc",
@@ -44,6 +47,7 @@ function getClientStub({
               type: "story",
               id: 4444,
               story: {
+                "story-template": "text",
                 headline: "ddd",
                 "story-content-id": 4444,
                 slug: "sports/dd",
@@ -54,6 +58,7 @@ function getClientStub({
               type: "story",
               id: 5555,
               story: {
+                "story-template": "text",
                 headline: "eee",
                 "story-content-id": 5555,
                 slug: "sports/ee",
@@ -64,6 +69,7 @@ function getClientStub({
               type: "story",
               id: 6666,
               story: {
+                "story-template": "text",
                 headline: "fff",
                 "story-content-id": 6666,
                 slug: "sports/ff",
@@ -150,6 +156,20 @@ describe("getInitialInlineConfig method of InfiniteScrollAmp helper function", f
     assert.strictEqual(false, /sports\/bb/.test(inlineConfig));
     assert.strictEqual(false, /bb\/b.jpg/.test(inlineConfig));
   });
+  it("should remove visual stories from infinite scroll", async function () {
+    const clientStub = getClientStub();
+    const infiniteScrollAmp = new InfiniteScrollAmp({
+      ampConfig: {},
+      client: clientStub,
+      publisherConfig: dummyPublisherConfig,
+    });
+    const inlineConfig = await infiniteScrollAmp.getInitialInlineConfig({
+      itemsToTake: 5,
+      storyId: 3333,
+    });
+    assert.strictEqual(false, /sports\/bb/.test(inlineConfig));
+    assert.strictEqual(false, /bb\/b.jpg/.test(inlineConfig));
+  });
   it("should format JSON as per AMP spec", async function () {
     // https://amp.dev/documentation/components/amp-next-page/
     const clientStub = getClientStub();
@@ -167,13 +187,7 @@ describe("getInitialInlineConfig method of InfiniteScrollAmp helper function", f
       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;
+        if (keys.includes("image") && keys.includes("url") && keys.includes("title") && keys.length === 3) return;
         throw new Error("Invalid InlineConfigStructure");
       });
       return true;
@@ -215,7 +229,7 @@ describe("getResponse method of InfiniteScrollAmp helper function", function ()
     const jsonResponse = await infiniteScrollAmp.getResponse({ itemsTaken: 2 });
     assert.strictEqual(jsonResponse instanceof Error, true);
   });
-  it("should remove current story from response", async function() {
+  it("should remove current story from response", async function () {
     const clientStub = getClientStub();
     const infiniteScrollAmp = new InfiniteScrollAmp({
       ampConfig: {},
@@ -226,8 +240,20 @@ describe("getResponse method of InfiniteScrollAmp helper function", function ()
     const jsonResponse = await infiniteScrollAmp.getResponse({ itemsTaken: 2 });
     assert.strictEqual(false, /sports\/dd/.test(jsonResponse));
     assert.strictEqual(false, /dd\/d.jpg/.test(jsonResponse));
-  })
-  it("should format JSON as per AMP spec", async function() {
+  });
+  it("should remove visual stories from response", async function () {
+    const clientStub = getClientStub();
+    const infiniteScrollAmp = new InfiniteScrollAmp({
+      ampConfig: {},
+      client: clientStub,
+      publisherConfig: dummyPublisherConfig,
+      queryParams: { "story-id": 4444 },
+    });
+    const jsonResponse = await infiniteScrollAmp.getResponse({ itemsTaken: 2 });
+    assert.strictEqual(false, /sports\/bb/.test(jsonResponse));
+    assert.strictEqual(false, /bb\/b.jpg/.test(jsonResponse));
+  });
+  it("should format JSON as per AMP spec", async function () {
     // https://amp.dev/documentation/components/amp-next-page/
     const clientStub = getClientStub();
     const infiniteScrollAmp = new InfiniteScrollAmp({
@@ -239,23 +265,17 @@ describe("getResponse method of InfiniteScrollAmp helper function", function ()
     const jsonResponse = await infiniteScrollAmp.getResponse({ itemsTaken: 2 });
     function isJsonConfigStructureValid(jsonStr) {
       const parsed = JSON.parse(jsonStr);
-      const stories = parsed.pages
+      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;
+        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)
-  })
+    assert.strictEqual(isJsonConfigStructureValid(jsonResponse), true);
+  });
   // 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
   // })