@quintype/framework 7.22.1-stories-by-external-id.6 → 7.23.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.23.0](https://github.com/quintype/quintype-node-framework/compare/v7.22.0...v7.23.0) (2024-01-04)
+
+
+### Features
+
+* **external id:** add support to retrieve stories with external ids ([#406](https://github.com/quintype/quintype-node-framework/issues/406)) ([a13b281](https://github.com/quintype/quintype-node-framework/commit/a13b281bb9e4aaaf28b0b01355f9937b74cb3be8))
+
 ## [7.22.0](https://github.com/quintype/quintype-node-framework/compare/v7.21.2...v7.22.0) (2023-12-01)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintype/framework",
-  "version": "7.22.1-stories-by-external-id.6",
+  "version": "7.23.0",
   "description": "Libraries to help build Quintype Node.js apps",
   "main": "index.js",
   "engines": {
@@ -33,7 +33,7 @@
     "@ampproject/toolbox-optimizer": "2.8.3",
     "@quintype/amp": "^2.17.13",
     "@quintype/backend": "^2.3.4",
-    "@quintype/components": "^3.4.7-stories-by-external-id.2",
+    "@quintype/components": "^3.5.0",
     "@quintype/prerender-node": "^3.2.26",
     "@quintype/seo": "^1.43.0-config-amp-story-path.1",
     "atob": "^2.1.2",

package/server/handlers/isomorphic-handler.js

@@ -84,15 +84,11 @@ function loadDataForIsomorphicRoute(
       return result;
     }
 
-    const isExternalStoryEnabled = typeof enableExternalStories === "function" ? enableExternalStories(config) : enableExternalStories
+    const isExternalStoryEnabled =
+      typeof enableExternalStories === "function" ? enableExternalStories(config) : enableExternalStories;
     if (isExternalStoryEnabled) {
-      const getExternalIdFromUrl = (pattern, url) => {
-        const index = pattern.split("/").findIndex((e) => e === "EXTERNAL_ID");
-        return url.split("/")[index];
-      };
-
-      const pattern =  typeof externalIdPattern === "function" ? externalIdPattern(config) : externalIdPattern
-      const externalId = getExternalIdFromUrl(pattern, url.pathname);
+      const pattern = typeof externalIdPattern === "function" ? externalIdPattern(config) : externalIdPattern;
+      const externalId = url.pathname.split("/")[pattern.split("/").findIndex((e) => e === "EXTERNAL_ID")];
       const story = await Story.getStoryByExternalId(client, externalId);
       if (story) {
         const params = Object.assign({}, url.query, otherParams, { storySlug: story.slug });

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

@@ -915,36 +915,79 @@ describe("Isomorphic Handler", function () {
   });
 
   describe("External Stories", () => {
-    it("when external stories are enabled and the route matches, render the story page", (done) => {
+    it("should render the story page when external stories are enabled and the route matches", (done) => {
       const app = createApp(
         (pageType, params, config, client, { host }) =>
           Promise.resolve({
             pageType,
             data: { text: "foobar", host },
           }),
-        [{ pageType: "story-page", path: "/*" }],
-        { enableExternalStories: true,
-          externalIdPattern: "/EXTERNAL_ID" }
+        [{ pageType: "story-page", path: "/*/:storySlug" }],
+        {
+          enableExternalStories: true,
+          externalIdPattern: "/EXTERNAL_ID",
+          getClient: (hostname) => ({
+            getConfig: () => Promise.resolve({ "publisher-id": 42 }),
+            getStoryByExternalId: (externalId) =>
+              Promise.resolve({
+                story: { slug: `section/${externalId}`, id: "abcdefgh-blah" },
+              }),
+          }),
+        }
       );
 
       supertest(app)
-      .get("/12345")
-      .expect("Content-Type", /html/)
-      .expect(200)
-      .then((res) => {
-        const response = JSON.parse(res.text);
-        assert.equal(
-          '<div data-page-type="story-page">foobar</div>',
-          response.content
-        );
-        assert.equal("foobar", response.store.qt.data.text);
-        assert.equal("127.0.0.1", response.store.qt.data.host);
-        assert.equal("story-page", response.store.qt.pageType);
-      })
-      .then(done);
+        .get("/12345")
+        .expect("Content-Type", /html/)
+        .expect(200)
+        .then((res) => {
+          const response = JSON.parse(res.text);
+          assert.equal('<div data-page-type="story-page">foobar</div>', response.content);
+          assert.equal("foobar", response.store.qt.data.text);
+          assert.equal("127.0.0.1", response.store.qt.data.host);
+          assert.equal("story-page", response.store.qt.pageType);
+        })
+        .then(done);
     });
 
-    it("when external stories are not enabled render a 404 page", (done) => {
+    it("should render the 404 page when external stories are enabled but the route doesn't match", (done) => {
+      const app = createApp(
+        (pageType, params, config, client) => Promise.resolve(),
+        [{ pageType: "story-page", path: "/:storySlug", exact: true }],
+        {
+          loadErrorData: (err, config, client, { host }) => ({
+            httpStatusCode: err.httpStatusCode,
+            pageType: "not-found",
+            data: { text: "foobar", host },
+          }),
+          enableExternalStories: true,
+          externalIdPattern: "/EXTERNAL_ID",
+          getClient: (hostname) => ({
+            getConfig: () => Promise.resolve({ "publisher-id": 42 }),
+            getStoryByExternalId: (externalId) =>
+              Promise.resolve({
+                story: null
+              }),
+          }),
+        }
+      );
+
+      supertest(app)
+        .get("/abc/def/12345")
+        .expect("Content-Type", /html/)
+        .expect(404)
+        .then((res) => {
+          const response = JSON.parse(res.text);
+          assert.equal(
+            '<div data-page-type="not-found">foobar</div>',
+            response.content
+          );
+          assert.equal("127.0.0.1", response.store.qt.data.host);
+        })
+        .then(done);
+    });
+
+    it("should render a 404 page when external stories are not enabled", (done) => {
       const app = createApp(
         (pageType, params, config, client) => Promise.resolve(),
         [{ pageType: "story-page", path: "/*/:storySlug", exact: true }],
@@ -954,7 +997,12 @@ describe("Isomorphic Handler", function () {
             pageType: "not-found",
             data: { text: "foobar", host },
           }),
-          enableExternalStories: false
+          enableExternalStories: false,
+          getClient: (hostname) => ({
+            getConfig: () => Promise.resolve({ "publisher-id": 42 }),
+            getStoryByExternalId: (externalId) =>
+              Promise.resolve(null),
+          }),
         }
       );