GET /w/contributions-sitemap.xml

Author: ZibanPirate

api/src/app/endpoints.ts

@@ -1,5 +1,6 @@
 import {
   GetContributionResponse,
+  GetContributionsForSitemapResponse,
   GetContributionsResponse,
   GetContributionTitleResponse,
 } from "src/contribution/types";
@@ -46,6 +47,9 @@ export interface Endpoints {
     response: GetContributionTitleResponse;
     params: { id: string };
   };
+  "api:contributions/for-sitemap": {
+    response: GetContributionsForSitemapResponse;
+  };
   "api:Contributors": {
     response: GetContributorsResponse;
   };

api/src/contribution/controller.ts

@@ -6,6 +6,7 @@ import {
   GetContributionTitleResponse,
   GetContributionResponse,
   GetContributionsResponse,
+  GetContributionsForSitemapResponse,
 } from "./types";
 
 @Service()
@@ -22,6 +23,16 @@ export class ContributionController {
     };
   }
 
+  @Get("/for-sitemap")
+  public async getContributionsForSitemap(): Promise<GetContributionsForSitemapResponse> {
+    // @TODO-ZM: title is a markdown, we should render it to plain text
+    const contributions = await this.contributionRepository.findForSitemap();
+
+    return {
+      contributions,
+    };
+  }
+
   @Get("/:id")
   public async getContribution(@Param("id") id: string): Promise<GetContributionResponse> {
     const contribution = await this.contributionRepository.findByIdWithStats(id);

api/src/contribution/repository.ts

@@ -79,6 +79,22 @@ export class ContributionRepository {
     return camelCased;
   }
 
+  public async findForSitemap() {
+    const statement = sql`
+    SELECT
+      ${contributionsTable.id},
+      ${contributionsTable.title}
+    FROM
+      ${contributionsTable}
+    `;
+
+    const raw = await this.postgresService.db.execute(statement);
+    const entries = Array.from(raw);
+    const unStringifiedRaw = unStringifyDeep(entries);
+    const camelCased = camelCaseObject(unStringifiedRaw);
+    return camelCased;
+  }
+
   public async upsert(contribution: ContributionRow) {
     return await this.postgresService.db
       .insert(contributionsTable)

api/src/contribution/types.ts

@@ -30,3 +30,7 @@ export interface GetContributionResponse extends GeneralResponse {
 export interface GetContributionTitleResponse extends GeneralResponse {
   contribution: Pick<ContributionEntity, "title">;
 }
+
+export interface GetContributionsForSitemapResponse extends GeneralResponse {
+  contributions: Array<Pick<ContributionEntity, "id" | "title">>;
+}

web/cloudflare/functions/w/contributions-sitemap.xml.ts

@@ -0,0 +1,49 @@
+import { Env } from "handler/contribution";
+import { environments } from "@dzcode.io/utils/dist/config/environment";
+import { allLanguages, LanguageEntity } from "@dzcode.io/models/dist/language";
+import { getContributionURL } from "@dzcode.io/web/dist/utils/contribution";
+import { fsConfig } from "@dzcode.io/utils/dist/config";
+import { fetchV2Factory } from "@dzcode.io/utils/dist/fetch/factory";
+import { Endpoints } from "@dzcode.io/api/dist/app/endpoints";
+
+export const onRequest: PagesFunction<Env> = async (context) => {
+  let stage = context.env.STAGE;
+  if (!environments.includes(stage)) {
+    console.log(`⚠️  No STAGE provided, falling back to "development"`);
+    stage = "development";
+  }
+  const fullstackConfig = fsConfig(stage);
+  const fetchV2 = fetchV2Factory<Endpoints>(fullstackConfig);
+
+  const { contributions } = await fetchV2("api:contributions/for-sitemap", {});
+
+  const hostname = "https://www.dzCode.io";
+  const links = contributions.reduce<{ url: string; lang: LanguageEntity["code"] }[]>((pV, cV) => {
+    return [
+      ...pV,
+      ...allLanguages.map(({ baseUrl, code }) => ({
+        url: `${baseUrl}${getContributionURL(cV)}`,
+        lang: code,
+      })),
+    ];
+  }, []);
+
+  const xml = `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
+    xmlns:news="http://www.google.com/schemas/sitemap-news/0.9"
+    xmlns:xhtml="http://www.w3.org/1999/xhtml"
+    xmlns:image="http://www.google.com/schemas/sitemap-image/1.1"
+    xmlns:video="http://www.google.com/schemas/sitemap-video/1.1">
+    ${links
+      .map(
+        (link) => `
+    <url>
+        <loc>${hostname}${link.url}</loc>
+        <xhtml:link rel="alternate" hreflang="${link.lang}" href="${hostname}${link.url}" />
+    </url>`,
+      )
+      .join("")}
+</urlset>`;
+
+  return new Response(xml, { headers: { "content-type": "application/xml; charset=utf-8" } });
+};