Merge pull request ZecHub#734 from dismad/main

Markdown parser fix

Author: dismad

src/app/[locale]/globals.css

@@ -1,6 +1,8 @@
 @import "tailwindcss";
 @import "nprogress/nprogress.css";
-@plugin "flowbite/plugin";
+@plugin "flowbite/plugin" {
+  charts: false;
+}
 @plugin "tailwindcss-animate";
 @import "../../components/Charts/index.css";
 @import "../../components/Sitemap/sitemap.css";

src/lib/__tests__/transformUri.test.ts

@@ -0,0 +1,92 @@
+/**
+ * Regression tests for content-path resolution via transformUri.
+ *
+ * The bug these guard against: uppercaseWords used a plain `.includes()` +
+ * `.replace()`, so the token "Zec" matched as a *prefix* of "Zecmap" /
+ * "ZecHub" and rewrote the content path to a non-existent file
+ * (`ZECmap.md` instead of `Zecmap.md`). The page then rendered the empty
+ * "Browse the articles…" placeholder at HTTP 200.
+ *
+ * Fix: only rewrite whole path segments (bounded by start/end, `/`, or `_`).
+ *
+ * helpers.ts imports getRootCached from authAndFetch (for firstFileForFolders),
+ * which pulls in next/cache. Mock that module so this pure unit test never
+ * loads the Next server runtime (TextEncoder / unstable_cache).
+ */
+
+jest.mock("../authAndFetch", () => ({
+  getRootCached: jest.fn(async () => []),
+}));
+
+import { transformUri, getDynamicRoute, resolveContentPath } from "../helpers";
+
+describe("transformUri — whole-segment uppercase/lowercase words", () => {
+  it("does not rewrite Zec inside Zecmap", () => {
+    expect(transformUri("/using-zcash/zecmap")).toBe("/Using_Zcash/Zecmap");
+  });
+
+  it("still uppercases a standalone Zec segment to ZEC", () => {
+    expect(transformUri("/using-zcash/buying-zec")).toBe(
+      "/Using_Zcash/Buying_ZEC",
+    );
+  });
+
+  it("uppercases Frost → FROST as a whole segment", () => {
+    expect(transformUri("/zcash-tech/frost")).toBe("/Zcash_Tech/FROST");
+  });
+
+  it("uppercases Nft → NFT as a whole segment", () => {
+    expect(transformUri("/zcash-community/cypherpunk-zero-nft")).toBe(
+      "/Zcash_Community/Cypherpunk_Zero_NFT",
+    );
+  });
+
+  it("maps Zechub → ZecHub via specialWordsMap (no greedy Zec prefix rewrite)", () => {
+    // Capitalize → What_Is_Zechub; lowercase Is → What_is_Zechub;
+    // whole-segment rules leave Zechub intact; specialWordsMap → ZecHub.
+    expect(transformUri("/start-here/what-is-zechub")).toBe(
+      "/Start_Here/What_is_ZecHub",
+    );
+  });
+
+  it("handles ZEC_Use_Cases (standalone Zec segment)", () => {
+    expect(transformUri("/start-here/zec-use-cases")).toBe(
+      "/Start_Here/ZEC_Use_Cases",
+    );
+  });
+
+  it("handles zk_SNARKS (Zk lowered + Snarks uppercased)", () => {
+    expect(transformUri("/zcash-tech/zk-snarks")).toBe(
+      "/Zcash_Tech/zk_SNARKS",
+    );
+  });
+
+  it("maps contribute/zechub-dao to ZecHub_DAO", () => {
+    expect(transformUri("/contribute/zechub-dao")).toBe(
+      "/contribute/ZecHub_DAO",
+    );
+  });
+
+  it("maps contribute/zecweekly-newsletter to ZecWeekly_Newsletter", () => {
+    expect(transformUri("/contribute/zecweekly-newsletter")).toBe(
+      "/contribute/ZecWeekly_Newsletter",
+    );
+  });
+});
+
+describe("getDynamicRoute / resolveContentPath", () => {
+  it("resolves zecmap to the real content filename", () => {
+    expect(getDynamicRoute(["using-zcash", "zecmap"])).toBe(
+      "/site/Using_Zcash/Zecmap.md",
+    );
+    expect(resolveContentPath(["using-zcash", "zecmap"])).toBe(
+      "/site/Using_Zcash/Zecmap.md",
+    );
+  });
+
+  it("resolves buying-zec to Buying_ZEC.md", () => {
+    expect(getDynamicRoute(["using-zcash", "buying-zec"])).toBe(
+      "/site/Using_Zcash/Buying_ZEC.md",
+    );
+  });
+});

src/lib/authAndFetch.ts

@@ -16,6 +16,35 @@ function cleanPath(path: string): string {
   return path.replace(/^\/+/, "");
 }
 
+/**
+ * Normalize a path for the GitHub contents API under the content repo.
+ *
+ * Callers pass mixed forms:
+ *   - wiki slug roots like `/site/using-zcash` (need transformUri)
+ *   - already-transformed content paths like `site/Using_Zcash` (must NOT
+ *     re-run transformUri — that would turn `site/` into `Site/` and break
+ *     the case-insensitive file fallback folder listing)
+ *
+ * Detection: content-repo paths contain uppercase letters (e.g. Using_Zcash).
+ * Wiki slug paths are lowercase with hyphens (e.g. using-zcash). Only the
+ * latter go through transformUri.
+ */
+function toGithubPath(path: string): string {
+  const p = cleanPath(path);
+  const hasSitePrefix = /^site\//i.test(p);
+  const rest = hasSitePrefix ? p.slice(p.indexOf("/") + 1) : p;
+
+  // Already a content-repo path (Capitalized_Underscore segments).
+  if (hasSitePrefix && /[A-Z]/.test(rest)) {
+    return "site/" + rest;
+  }
+
+  // Wiki slug path — run transformUri on the slug portion.
+  const withSlash = rest.startsWith("/") ? rest : `/${rest}`;
+  const transformed = transformUri(withSlash); // e.g. "/Using_Zcash"
+  return cleanPath("site" + transformed);
+}
+
 function assertRepoConfig(): boolean {
   if (!owner || !repo) {
     console.error(
@@ -306,7 +335,7 @@ export const getRootCached = unstable_cache(
     const res = await octokit.rest.repos.getContent({
       owner,
       repo,
-      path: cleanPath(transformUri(path).replace("/Site", "/site")),
+      path: toGithubPath(path),
       ref: branch,
     });
     const data = res.data;
@@ -338,7 +367,7 @@ export async function getRootFileName(path: string) {
     const res = await octokit.rest.repos.getContent({
       owner,
       repo,
-      path: cleanPath(transformUri(path).replace("/Site", "/site")),
+      path: toGithubPath(path),
       ref: branch,
     });
     const data = res.data;
@@ -358,7 +387,7 @@ export const getAllMarkdownRecursively = unstable_cache(
     const walk = async (currentPath: string, isInitial: boolean) => {
       try {
         const apiPath = isInitial
-          ? cleanPath(transformUri(currentPath).replace("/Site", "/site"))
+          ? toGithubPath(currentPath)
           : cleanPath(currentPath);
         const res = await octokit.rest.repos.getContent({
           owner,

src/lib/helpers.ts

@@ -357,6 +357,10 @@ const specialWordsMap = {
   Faq: "FAQ",
   ZECHub: "ZecHub",
   ZEChub: "ZecHub",
+  // After whole-segment rules, "Zec" no longer rewrites inside ZecHub /
+  // ZecWeekly. Map the remaining mixed-case forms to the on-disk names.
+  Zechub: "ZecHub",
+  Zecweekly: "ZecWeekly",
   Av_Club: "AV_Club",
   guides_For_Creators: "Guides_for_Creators",
   Grapheneos: "GrapheneOS",
@@ -381,19 +385,34 @@ const specialWordsMap = {
   zkav: "ZKAV",
 };
 
+/**
+ * Apply a word list only to whole path segments.
+ *
+ * Segments are bounded by start/end of string, `/`, or `_`. This prevents
+ * prefix collisions such as "Zec" matching inside "Zecmap" / "ZecHub" (which
+ * previously rewrote Zecmap → ZECmap and 404'd the content lookup).
+ */
+function replaceWholeSegments(
+  input: string,
+  word: string,
+  replacement: string,
+): string {
+  const re = new RegExp(`(^|[_/])${word}(?=[_/]|$)`, "g");
+  return input.replace(re, (_m, boundary: string) => boundary + replacement);
+}
+
 export const transformUri = (uri: string, ignoreLowerCase = false) => {
   let transformed = uri
     .replace(/\b\w/g, (l) => l.toUpperCase())
     .replace(/-/g, "_");
 
-  if (!ignoreLowerCase)
+  if (!ignoreLowerCase) {
     lowercaseWords.forEach((word) => {
-      if (transformed.includes(word))
-        transformed = transformed.replace(word, word.toLowerCase());
+      transformed = replaceWholeSegments(transformed, word, word.toLowerCase());
     });
+  }
   uppercaseWords.forEach((word) => {
-    if (transformed.includes(word))
-      transformed = transformed.replace(word, word.toUpperCase());
+    transformed = replaceWholeSegments(transformed, word, word.toUpperCase());
   });
   Object.entries(specialWordsMap).forEach(([word, targetWord]) => {
     if (transformed.includes(word))