feature: link related ideas

gatsby-node.js

@@ -2,11 +2,7 @@ const _ = require("lodash");
 const fs = require("fs");
 const path = require("path");
 const { createFilePath } = require("gatsby-source-filesystem");
-const {
-    stringWithDefault,
-    resolveToArray,
-    resourceQuery,
-} = require("./gatsby/utils/gatsby-resolver-utils");
+const { createIdeaPostResolver } = require("./gatsby/resolvers/resolvers");
 const {
     RESOURCES_GATSBY_NODE_KEY,
     MARKDOWN_REMARK_GATSBY_NODE_KEY,
@@ -26,25 +22,11 @@ const read = (p) => fs.readFileSync(path.join(__dirname, p), "utf8");
 
 const DATA_ONLY_PAGES = [ALLENITE_TEMPLATE_KEY, PROGRAM_TEMPLATE_KEY];
 
+const templateKeysWithNodes = Object.keys(TEMPLATE_KEY_TO_TYPE);
+
 exports.createSchemaCustomization = ({ actions }) => {
     const { createTypes } = actions;
-    const typeDefs = [
-        `type PreliminaryFindings {
-            summary: String!
-            figures: [ImgWithCaption!]!
-        }
-
-        type ImgWithCaption @dontInfer {
-            type: String!
-            url: String
-            file: File @fileByRelativePath
-            caption: String
-        }
-
-        `,
-    ];
     createTypes(read("gatsby/schema/base.gql"));
-    createTypes(typeDefs);
 };
 
 /**
@@ -61,60 +43,7 @@ exports.createResolvers = ({ reporter, createResolvers }) => {
                 }),
             },
         },
-        Frontmatter: {
-            description: {
-                resolve: (source) =>
-                    stringWithDefault(
-                        source.description,
-                        "No description provided.",
-                    ),
-            },
-            authors: {
-                resolve: (source) => resolveToArray(source.authors),
-            },
-            title: {
-                resolve: (source) =>
-                    stringWithDefault(source.title, "No title provided."),
-            },
-            resources: {
-                resolve: async (source, _args, context) => {
-                    const names = resolveToArray(source.resources);
-                    const results = await Promise.all(
-                        names.map((name) =>
-                            context.nodeModel.findOne(resourceQuery(name)),
-                        ),
-                    );
-                    results.forEach((result, i) => {
-                        if (!result) {
-                            const msg = `Resource "${names[i]}" not found for idea "${source.title}". Check for typos and ensure the resource file exists with the correct templateKey.`;
-                            reporter.error(msg, new Error(msg));
-                        }
-                    });
-                    return results.filter(Boolean);
-                },
-            },
-            nextSteps: {
-                resolve: (source) => source.nextSteps ?? null,
-            },
-            program: {
-                resolve: (source) => resolveToArray(source.program),
-            },
-            preliminaryFindings: {
-                resolve: (source) => {
-                    const raw = source.preliminaryFindings;
-                    if (!raw || typeof raw !== "object") {
-                        return {
-                            summary: "",
-                            figures: [],
-                        };
-                    }
-                    return {
-                        summary: stringWithDefault(raw.summary, ""),
-                        figures: resolveToArray(raw.figures),
-                    };
-                },
-            },
-        },
+        IdeaPost: createIdeaPostResolver(reporter),
     });
 };
 
@@ -128,11 +57,10 @@ exports.createPages = ({ actions, graphql }) => {
 
     // Create pages for any markdown files that are configured to have their
     // own node type (e.g. Resource) based on their templateKey.
-    const typedNodePages = Object.keys(TEMPLATE_KEY_TO_TYPE).map(
-        (templateKey) => {
-            const nodeKey = TEMPLATE_KEY_TO_TYPE[templateKey];
-            const allKeyString = `all${nodeKey}`;
-            return graphql(`
+    const typedNodePages = templateKeysWithNodes.map((templateKey) => {
+        const nodeKey = TEMPLATE_KEY_TO_TYPE[templateKey];
+        const allKeyString = `all${nodeKey}`;
+        return graphql(`
         {
             ${allKeyString} {
                 nodes {
@@ -142,23 +70,20 @@ exports.createPages = ({ actions, graphql }) => {
             }
         }
     `).then((result) => {
-                if (result.errors) {
-                    result.errors.forEach((e) => console.error(e.toString()));
-                    return Promise.reject(result.errors);
-                }
+            if (result.errors) {
+                result.errors.forEach((e) => console.error(e.toString()));
+                return Promise.reject(result.errors);
+            }
 
-                result.data[allKeyString].nodes.forEach((node) => {
-                    createPage({
-                        path: node.slug,
-                        component: path.resolve(
-                            `src/templates/${templateKey}.tsx`,
-                        ),
-                        context: { id: node.id },
-                    });
+            result.data[allKeyString].nodes.forEach((node) => {
+                createPage({
+                    path: node.slug,
+                    component: path.resolve(`src/templates/${templateKey}.tsx`),
+                    context: { id: node.id },
                 });
             });
-        },
-    );
+        });
+    });
 
     /**
      * We make pages from all markdown files that are consumed by gatsby-transformer-remark,
@@ -198,7 +123,7 @@ exports.createPages = ({ actions, graphql }) => {
             // Skip creating pages for data-only pages (software, dataset, etc.)
             if (
                 DATA_ONLY_PAGES.includes(templateKey) ||
-                templateKey in TEMPLATE_KEY_TO_TYPE
+                templateKeysWithNodes.includes(templateKey)
             ) {
                 return;
             }
@@ -274,9 +199,7 @@ exports.onCreateNode = ({
         // in the createPages.
         if (
             node.frontmatter?.templateKey &&
-            Object.keys(TEMPLATE_KEY_TO_TYPE).includes(
-                node.frontmatter?.templateKey,
-            )
+            templateKeysWithNodes.includes(node.frontmatter?.templateKey)
         ) {
             const nodeType = TEMPLATE_KEY_TO_TYPE[node.frontmatter.templateKey];
 

gatsby/constants.js

@@ -1,9 +1,12 @@
 const ALLENITE_TEMPLATE_KEY = `allenite`;
 const PROGRAM_TEMPLATE_KEY = `program`;
 const RESOURCES_TEMPLATE_KEY = `resource`;
+const IDEA_POST_TEMPLATE_KEY = `idea-post`;
 
 const RESOURCES_GATSBY_NODE_KEY = `Resource`;
+const IDEA_POST_GATSBY_NODE_KEY = `IdeaPost`;
 const MARKDOWN_REMARK_GATSBY_NODE_KEY = `MarkdownRemark`;
+const IDEAS_SLUG_DIRECTORY = `ideas`;
 
 /**
  * Maps frontmatter templateKey → a distinct GraphQL node type.
@@ -14,12 +17,17 @@ const MARKDOWN_REMARK_GATSBY_NODE_KEY = `MarkdownRemark`;
  */
 const TEMPLATE_KEY_TO_TYPE = {
     [RESOURCES_TEMPLATE_KEY]: RESOURCES_GATSBY_NODE_KEY,
+    [IDEA_POST_TEMPLATE_KEY]: IDEA_POST_GATSBY_NODE_KEY,
 };
+
 module.exports = {
     ALLENITE_TEMPLATE_KEY,
     PROGRAM_TEMPLATE_KEY,
     RESOURCES_TEMPLATE_KEY,
     MARKDOWN_REMARK_GATSBY_NODE_KEY,
     TEMPLATE_KEY_TO_TYPE,
     RESOURCES_GATSBY_NODE_KEY,
+    IDEA_POST_TEMPLATE_KEY,
+    IDEA_POST_GATSBY_NODE_KEY,
+    IDEAS_SLUG_DIRECTORY,
 };

gatsby/resolvers/resolvers.js

@@ -0,0 +1,77 @@
+const {
+    stringWithDefault,
+    resolveToArray,
+    ideaPostQuery,
+    resourceQuery,
+} = require("../utils/gatsby-resolver-utils");
+
+const createIdeaPostResolver = (reporter) => ({
+    title: {
+        resolve: (source) =>
+            stringWithDefault(source.title, "No title provided."),
+    },
+    description: {
+        resolve: (source) =>
+            stringWithDefault(source.description, "No description provided."),
+    },
+    nextSteps: {
+        resolve: (source) => source.nextSteps ?? null,
+    },
+    relatedIdeas: {
+        resolve: async (source, _args, context) => {
+            const names = resolveToArray(source.related_ideas);
+            const results = await Promise.all(
+                names.map((name) =>
+                    context.nodeModel.findOne(ideaPostQuery(name)),
+                ),
+            );
+            results.forEach((result, i) => {
+                if (!result) {
+                    const msg = `Idea post "${names[i]}" not found for idea "${source.title}". Check for typos and ensure the idea post file exists with the correct templateKey.`;
+                    reporter.error(msg, new Error(msg));
+                }
+            });
+            return results.filter(Boolean);
+        },
+    },
+    authors: {
+        resolve: (source) => resolveToArray(source.authors),
+    },
+    tags: {
+        resolve: (source) => resolveToArray(source.tags),
+    },
+    program: {
+        resolve: (source) => resolveToArray(source.program),
+    },
+    resources: {
+        resolve: async (source, _args, context) => {
+            const names = resolveToArray(source.resources);
+            const results = await Promise.all(
+                names.map((name) =>
+                    context.nodeModel.findOne(resourceQuery(name)),
+                ),
+            );
+            results.forEach((result, i) => {
+                if (!result) {
+                    const msg = `Resource "${names[i]}" not found for idea "${source.title}". Check for typos and ensure the resource file exists with the correct templateKey.`;
+                    reporter.error(msg, new Error(msg));
+                }
+            });
+            return results.filter(Boolean);
+        },
+    },
+    preliminaryFindings: {
+        resolve: (source) => {
+            const raw = source.preliminaryFindings;
+            if (!raw || typeof raw !== "object") {
+                return { summary: "", figures: [] };
+            }
+            return {
+                summary: stringWithDefault(raw.summary, ""),
+                figures: resolveToArray(raw.figures),
+            };
+        },
+    },
+});
+
+module.exports = { createIdeaPostResolver };

gatsby/schema/base.gql

@@ -3,23 +3,16 @@ type MarkdownRemarkFields {
 }
 
 type MarkdownRemark implements Node {
-    frontmatter: Frontmatter!
     fields: MarkdownRemarkFields!
+    frontmatter: Frontmatter!
 }
 
-# Shared frontmatter fields for idea posts (and other markdown).
 type Frontmatter {
     date: Date @dateformat
-    title: String!
     description: String
     draft: Boolean
     tags: [String!]
-    authors: [String!]!
-    nextSteps: String
-    program: [String!]
-    publication: String
-    introduction: String
-    resources: [Resource!]!
+    title: String!
 }
 
 type ResourceLink {
@@ -29,15 +22,44 @@ type ResourceLink {
 }
 
 type Resource implements Node {
-    slug: String!
-    name: String
-    type: String
+    date: Date @dateformat
     description: String
+    draft: Boolean
+    file: String
+    name: String
     links: [ResourceLink!]
     readmeLink: String
-    file: String
+    slug: String!
     status: String
-    date: Date @dateformat
     tags: [String!]
+    type: String
+}
+
+type PreliminaryFindings {
+    figures: [ImgWithCaption!]!
+    summary: String!
+}
+
+type ImgWithCaption @dontInfer {
+    caption: String
+    file: File @fileByRelativePath
+    type: String!
+    url: String
+}
+
+type IdeaPost implements Node {
+    authors: [String!]!
+    date: Date @dateformat
+    description: String
     draft: Boolean
-}
+    introduction: String
+    nextSteps: String
+    preliminaryFindings: PreliminaryFindings
+    program: [String!]!
+    publication: String
+    relatedIdeas: [IdeaPost!]!
+    resources: [Resource!]!
+    slug: String!
+    tags: [String!]!
+    title: String!
+}

gatsby/utils/gatsby-resolver-utils.js

@@ -1,6 +1,8 @@
 const {
     RESOURCES_TEMPLATE_KEY,
     TEMPLATE_KEY_TO_TYPE,
+    IDEA_POST_TEMPLATE_KEY,
+    IDEAS_SLUG_DIRECTORY,
 } = require("../constants");
 const slugify = require("slugify");
 
@@ -61,9 +63,19 @@ const resourceQuery = (name) => {
     };
 };
 
+const ideaPostQuery = (name) => {
+    const slug = resolveSlug(name, IDEAS_SLUG_DIRECTORY);
+    if (!slug) return null;
+    return {
+        query: { filter: { slug: { eq: slug } } },
+        type: TEMPLATE_KEY_TO_TYPE[IDEA_POST_TEMPLATE_KEY],
+    };
+};
+
 module.exports = {
     stringWithDefault,
     resolveToArray,
     resolveSlug,
     resourceQuery,
+    ideaPostQuery,
 };