DOP-3500: Account for aliases and gitBranchName in merged ToC links (#765)

* DOP-3500: Add alias handling logic to urlify

* DOP-3500: Handle originalBranchName and nullish alias case

* fixup lint

* null safety

---------

Co-authored-by: Seung Park <[email protected]>

Author: casthewiz

modules/persistence/src/services/metadata/ToC/index.ts

@@ -119,14 +119,14 @@ export const traverseAndMerge = (
 
 // Create a deep copy of a ToC, converting all slugs present to absolute urls if project, prefix and url is provided.
 // Copy logic should be tightly coupled to the urlification logic here - we DON'T want to mutate the base ToC objects.
-export const copyToCTree = (toBeCopied: ToC, prefix?: string, url?: string): ToC => {
+export const copyToCTree = (toBeCopied: ToC, prefix?: string, url?: string, alias?: string): ToC => {
   const toctree = JSON.parse(JSON.stringify(toBeCopied));
   if (!prefix || !url) return toctree;
   let queue = [toctree];
   while (queue?.length) {
     const next = queue.shift();
     if (next && next.slug) {
-      next.url = convertSlugToUrl(next.slug, prefix, url);
+      next.url = convertSlugToUrl(next.slug, prefix, url, alias);
       delete next.slug;
     }
     if (next?.children) queue = [...queue, ...next.children];

modules/persistence/src/services/metadata/ToC/utils/convertSlugToUrl.ts

@@ -1,5 +1,7 @@
-export const convertSlugToUrl = (slug, prefix, url) => {
-  return ensureTrailingSlash(url) + prefix + ensureLeadingSlash(slug);
+export const convertSlugToUrl = (slug, prefix, url, alias) => {
+  const leading = ensureTrailingSlash(url) + prefix;
+  const trailing = alias ? ensureLeadingSlash(alias) + ensureLeadingSlash(slug) : ensureLeadingSlash(slug);
+  return leading + trailing;
 };
 
 const ensureTrailingSlash = (subpath: string) => {

modules/persistence/src/services/metadata/associated_products/index.ts

@@ -114,9 +114,11 @@ const shapeToCsCursor = async (
     // TODO: If we want staging builds with embedded versions, it needs to be added here
     if (repoBranchesEntry) {
       const { url, prefix } = prefixFromEnvironment(branches);
+      const { urlSlug, urlAliases = [], gitBranchName, publishOriginalBranchName } = repoBranchesEntry;
+      const alias = urlSlug || urlAliases[0] || (publishOriginalBranchName && gitBranchName);
       tocInsertions[project][branch] = {
         original: copyToCTree(metadata.toctree),
-        urlified: copyToCTree(metadata.toctree, prefix, url),
+        urlified: copyToCTree(metadata.toctree, prefix, url, alias),
       };
       // TODO: Can we urlify the order? SHOUD we urlify the order?
       tocOrderInsertions[project][branch] = metadata.toctreeOrder;

modules/persistence/tests/metadata/utils/convertSlugToUrl.test.ts

@@ -1,9 +1,15 @@
 import { convertSlugToUrl } from '../../../src/services/metadata/ToC/utils/convertSlugToUrl';
 
 describe('convertSlugToUrl', () => {
-  it("accepts a project's prefix, slug, and base url, and returns an absolute url for href usage", () => {
-    expect(convertSlugToUrl('get-started', 'docs/atlas/cli', 'www.mongodb.com')).toEqual(
-      'www.mongodb.com/docs/atlas/cli/get-started'
+  it("accepts a project's prefix, slug, alias and base url, and returns an absolute url for href usage", () => {
+    expect(convertSlugToUrl('get-started', 'docs/atlas/cli', 'www.mongodb.com', 'current')).toEqual(
+      'www.mongodb.com/docs/atlas/cli/current/get-started'
+    );
+  });
+
+  it('still returns a valid absolute url for href usage when alias is falsey', () => {
+    expect(convertSlugToUrl('get-started', 'docs/charts', 'www.mongodb.com', '')).toEqual(
+      'www.mongodb.com/docs/charts/get-started'
     );
   });
 });