Refactor feed iteration

Author: hasparus

packages/web/docs/src/app/blog/feed.xml/route.ts

@@ -2,9 +2,10 @@
 import RSS from 'rss';
 import { getPageMap } from '@theguild/components/server';
 import { AuthorId, authors } from '../../../authors';
-import { coerceCaseStudiesToBlogs } from '../../case-studies/coerce-case-studies-to-blogs';
+import { pagesDepthFirst } from '../../../mdx-types';
+import { coerceCaseStudyToBlog } from '../../case-studies/coerce-case-studies-to-blogs';
 import { isCaseStudy } from '../../case-studies/isCaseStudyFile';
-import { BlogFrontmatter, isBlogPost } from '../blog-types';
+import { BlogFrontmatter, BlogPostFile, isBlogPost } from '../blog-types';
 
 function getAuthor(frontmatterAuthors: BlogFrontmatter['authors']): string {
   const first = Array.isArray(frontmatterAuthors) ? frontmatterAuthors[0] : frontmatterAuthors;
@@ -17,32 +18,30 @@ function getAuthor(frontmatterAuthors: BlogFrontmatter['authors']): string {
   return first.name;
 }
 
+export const dynamic = 'force-static';
+export const config = { runtime: 'edge' };
+
 export async function GET() {
   let allPosts: RSS.ItemOptions[] = [];
 
-  // TODO: This needs a refactor: one `getPageMap` call,
-  // iterating over all items and pushing to `allPosts` in a coerced form.
-  const [, , ...blogs] = await getPageMap('/blog');
-  const [, , ...studies] = await getPageMap('/case-studies');
-  const [, , ...updates] = await getPageMap('/product-updates');
-
-  const studiesAsBlogs = coerceCaseStudiesToBlogs(studies.filter(isCaseStudy));
+  const [_meta, _indexPage, ...pages] = await getPageMap('/');
+  for (const page of pagesDepthFirst(pages)) {
+    const route = (page && 'route' in page && page.route) || '';
+    const [dir, name] = route.split('/').filter(Boolean);
+    if (!name) continue;
+    switch (dir) {
+      case 'blog':
+      case 'product-updates':
+        if (isBlogPost(page)) allPosts.push(toRssItem(page));
+        break;
+      case 'case-studies':
+        if (isCaseStudy(page)) allPosts.push(toRssItem(coerceCaseStudyToBlog(page)));
+        break;
+    }
+  }
 
-  for (const items of [blogs.filter(isBlogPost), updates.filter(isBlogPost), studiesAsBlogs]) {
-    allPosts = allPosts.concat(
-      items.map(
-        (item): RSS.ItemOptions => ({
-          title: item.frontMatter.title,
-          date: new Date(item.frontMatter.date),
-          url: `https://the-guild.dev/graphql/hive${item.route}`,
-          description: item.frontMatter.description ?? '',
-          author: getAuthor(item.frontMatter.authors),
-          categories: Array.isArray(item.frontMatter.tags)
-            ? item.frontMatter.tags
-            : [item.frontMatter.tags],
-        }),
-      ),
-    );
+  if (allPosts.length === 0) {
+    throw new Error('No blog posts found for RSS feed');
   }
 
   allPosts = allPosts.sort((a, b) => new Date(b.date).getTime() - new Date(a.date).getTime());
@@ -64,5 +63,15 @@ export async function GET() {
   });
 }
 
-export const dynamic = 'force-static';
-export const config = { runtime: 'edge' };
+function toRssItem(blogPost: BlogPostFile): RSS.ItemOptions {
+  return {
+    title: blogPost.frontMatter.title,
+    date: new Date(blogPost.frontMatter.date),
+    url: `https://the-guild.dev/graphql/hive${blogPost.route}`,
+    description: blogPost.frontMatter.description ?? '',
+    author: getAuthor(blogPost.frontMatter.authors),
+    categories: Array.isArray(blogPost.frontMatter.tags)
+      ? blogPost.frontMatter.tags
+      : [blogPost.frontMatter.tags],
+  };
+}

packages/web/docs/src/app/case-studies/coerce-case-studies-to-blogs.ts

@@ -3,7 +3,11 @@ import { BlogFrontmatter, BlogPostFile } from '../blog/blog-types';
 import { CaseStudyFile } from './case-study-types';
 
 export function coerceCaseStudiesToBlogs(caseStudies: CaseStudyFile[]): BlogPostFile[] {
-  return caseStudies.map(caseStudy => ({
+  return caseStudies.map(coerceCaseStudyToBlog);
+}
+
+export function coerceCaseStudyToBlog(caseStudy: CaseStudyFile): BlogPostFile {
+  return {
     ...caseStudy,
     frontMatter: {
       ...caseStudy.frontMatter,
@@ -17,5 +21,5 @@ export function coerceCaseStudiesToBlogs(caseStudies: CaseStudyFile[]): BlogPost
         }),
       ),
     } satisfies BlogFrontmatter,
-  }));
+  };
 }

packages/web/docs/src/mdx-types.ts

@@ -13,3 +13,19 @@ export type MdxFile<FrontMatterType> = {
  * TODO: This should be exported from `nextra` and `@theguild/components`
  */
 export type PageMapItem = Awaited<ReturnType<typeof getPageMap>>[number];
+
+export type FolderItem = Extract<PageMapItem, { children: PageMapItem[] }>;
+
+export function isFolder(item: PageMapItem): item is FolderItem {
+  return !!item && typeof item === 'object' && 'children' in item;
+}
+
+export function* pagesDepthFirst(items: PageMapItem[]): Generator<PageMapItem> {
+  for (const item of items) {
+    if (isFolder(item)) {
+      yield* pagesDepthFirst(item.children);
+    } else {
+      yield item;
+    }
+  }
+}