Updated docMapper logic (#263)

Author: riyaz-ghati

library/components/atomic-design/templates/Header/Header.cy.tsx

@@ -26,7 +26,7 @@ const runtimeConfig: IRuntimeConfig = {
     ADMIN: undefined,
   },
   API: {},
-  VERSIONS: { v: undefined },
+  VERSIONS: { v: undefined, orchestrator: "v3.1.0-dev-f478801" },
   DOCUMENTATION: [],
 };
 
@@ -87,7 +87,9 @@ describe("<Header/>", () => {
       OBSERVABILITY_URL: "",
       MFE: {},
       API: {},
-      VERSIONS: {},
+      VERSIONS: {
+        orchestrator: "v3.1.0-dev-f478801",
+      },
     };
     window.__RUNTIME_CONFIG__ = cfg;
     cy.mount(

library/components/atomic-design/templates/Header/docMapper.ts

@@ -5,16 +5,63 @@
 
 import { RuntimeConfig, stripTrailingSlash } from "@orch-ui/utils";
 
+/**
+ * Extracts major.minor version from orchestrator version string
+ * @param {string} version - Version string like "v3.0.1-dev-b21fb28"
+ * @returns {string} - Major.minor version like "3.0" or "main" if invalid
+ */
+function extractDocumentationVersion(version: string) {
+  let docVersion = "main";
+
+  if (!version) {
+    return docVersion;
+  }
+
+  // Remove "v" prefix if present
+  let cleanVersion = version;
+  if (version.startsWith("v")) {
+    cleanVersion = version.substring(1); // removes "v" prefix
+  } else {
+    // if orchestrator version is received other than "v" format return default
+    return docVersion;
+  }
+
+  // Split by "-" to separate version from metadata
+  const versionParts = cleanVersion.split("-"); //returns [3.0.1, dev, b21fb28]
+
+  if (versionParts.length > 0) {
+    // Split the version numbers by "."
+    const numbers = versionParts[0].split("."); //returns [3, 0, 1]
+
+    // Check if we have at least major and minor version
+    if (numbers.length >= 2) {
+      docVersion = `${numbers[0]}.${numbers[1]}`; // returns `3.0`
+    }
+  }
+
+  return docVersion;
+}
+
 /**
  * Method to transform from url to doc link
  * @param url - pathname without search params (location.pathname)
  */
 export const getDocsForUrl = (url: string) => {
+  // this is where documentation is hoisted and same value is received
+  // ...in documentationUrl but concatenated with `/main`
+  const docHost = "https://docs.openedgeplatform.intel.com/edge-manage-docs";
   const urlParts = url.substring(1).split("/");
-
-  const docsUrl = stripTrailingSlash(RuntimeConfig.documentationUrl);
+  let docVersion;
+  if (
+    window.__RUNTIME_CONFIG__?.VERSIONS.orchestrator &&
+    RuntimeConfig.getComponentVersion("orchestrator")
+  ) {
+    docVersion = extractDocumentationVersion(
+      RuntimeConfig.getComponentVersion("orchestrator"),
+    );
+  }
+  let docsUrl = stripTrailingSlash(RuntimeConfig.documentationUrl);
   let docsMapper = RuntimeConfig.documentation;
-
   // looking for matches part (url segment) by part
   // takes browser url, e.g. /test/aa/bb/cc and test against mapper values, segment by segment
   // if values from the same segment index from url and mapper key are different we dont grab this mapping
@@ -31,7 +78,6 @@ export const getDocsForUrl = (url: string) => {
           [urlParts[index], "*"].includes(part),
       ),
   );
-
   // if we get more than one match it means that we get match against static address and segment with path parameter
   // e.g. /test/aa/bb and /test/*/bb or /test/aa/*
   // then we need to pick key with the least number of path parameters (*)
@@ -56,11 +102,25 @@ export const getDocsForUrl = (url: string) => {
     ];
   }
 
-  // when mapper contains only one entry, we are ready to read the docs address
+  try {
+    const docsUrlObj = new URL(docsUrl);
+    const docHostObj = new URL(docHost);
+    // fail safe check to ensure documentation host
+    if (
+      docsUrlObj.host === docHostObj.host &&
+      docsUrlObj.protocol === docHostObj.protocol &&
+      docVersion
+    ) {
+      // concatenating the release version with docsUrl
+      docsUrl = `${docHost}/${docVersion}`;
+    }
+  } catch (e) {
+    // fallback: do nothing, keep docsUrl as is
+  }
+
   if (docsMapper.length === 1) {
     return `${docsUrl}${docsMapper[0].dest}`;
   }
-
   // default option
   const defaultDocsAddress =
     RuntimeConfig.documentation[0]?.dest ?? `${window.location.origin}/docs`;

library/components/atomic-design/templates/Header/docsMapper.cy.tsx

@@ -54,6 +54,32 @@ const testCases = [
   },
 ];
 
+const createTestConfig = (
+  overrides: Partial<IRuntimeConfig> = {},
+): IRuntimeConfig => ({
+  DOCUMENTATION_URL:
+    "https://docs.openedgeplatform.intel.com/edge-manage-docs/main",
+  DOCUMENTATION: [
+    {
+      src: "/dashboard",
+      dest: "/user_guide/monitor_deployments/index.html",
+    },
+  ],
+  AUTH: "false",
+  KC_URL: "",
+  KC_REALM: "",
+  KC_CLIENT_ID: "",
+  TITLE: "",
+  SESSION_TIMEOUT: 1800,
+  OBSERVABILITY_URL: "",
+  MFE: {},
+  API: {},
+  VERSIONS: {
+    orchestrator: "v3.1.0-dev-f478801",
+  },
+  ...overrides,
+});
+
 describe("test mapping url to docs link", () => {
   beforeEach(() => {
     const cfg: IRuntimeConfig = {
@@ -101,7 +127,9 @@ describe("test mapping url to docs link", () => {
       OBSERVABILITY_URL: "",
       MFE: {},
       API: {},
-      VERSIONS: {},
+      VERSIONS: {
+        orchestrator: "v3.1.0-dev-f478801",
+      },
     };
     window.__RUNTIME_CONFIG__ = cfg;
   });
@@ -127,9 +155,55 @@ describe("test no mapping", () => {
       OBSERVABILITY_URL: "",
       MFE: {},
       API: {},
-      VERSIONS: {},
+      VERSIONS: {
+        orchestrator: "v3.1.0-dev-f478801",
+      },
     };
     window.__RUNTIME_CONFIG__ = cfg;
     expect(getDocsForUrl("/random")).to.equal("http://localhost:8000/docs");
   });
 });
+
+describe("doc URL tests for orchestrator versions", () => {
+  it("Should construct URL with release version 3.1", () => {
+    window.__RUNTIME_CONFIG__ = createTestConfig({
+      VERSIONS: {
+        orchestrator: "v3.1.0-dev-f478801",
+      },
+    });
+    expect(getDocsForUrl("/dashboard")).to.equal(
+      "https://docs.openedgeplatform.intel.com/edge-manage-docs/3.1/user_guide/monitor_deployments/index.html",
+    );
+  });
+
+  it("Should construct URL with release version 3.0", () => {
+    window.__RUNTIME_CONFIG__ = createTestConfig({
+      VERSIONS: {
+        orchestrator: "v3.0.0-dev-f478801",
+      },
+    });
+    expect(getDocsForUrl("/dashboard")).to.equal(
+      "https://docs.openedgeplatform.intel.com/edge-manage-docs/3.0/user_guide/monitor_deployments/index.html",
+    );
+  });
+
+  it("Should construct URL with mainline doc version if orchestrator version is not available", () => {
+    window.__RUNTIME_CONFIG__ = createTestConfig({
+      VERSIONS: {},
+    });
+    expect(getDocsForUrl("/dashboard")).to.equal(
+      "https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/monitor_deployments/index.html",
+    );
+  });
+
+  it("Should construct URL with mainline doc version if orchestrator version is received in unknown format", () => {
+    window.__RUNTIME_CONFIG__ = createTestConfig({
+      VERSIONS: {
+        orchestrator: "3.0.0",
+      },
+    });
+    expect(getDocsForUrl("/dashboard")).to.equal(
+      "https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/monitor_deployments/index.html",
+    );
+  });
+});