From 6f70f40eecbfcba7d3149231ff8f16ca5c5121ae Mon Sep 17 00:00:00 2001
From: Eugene Dyudyunov <evgen.dyudyunov@raccoongang.com>
Date: Fri, 29 Mar 2024 13:46:50 +0200
Subject: [PATCH] fix: internal routing ignores public path (#312)

* fix: internal routing ignores public path

Add a new util function for constructing the correct
internal route URL.

* test: add tests for createCorrectInternalRoute
---
 .../ProgramRecord/ProgramRecord.jsx           |  3 +-
 .../ProgramRecordsList/ProgramRecordsList.jsx |  3 +-
 src/utils.js                                  | 20 ++++++++
 src/utils.test.js                             | 48 +++++++++++++++++++
 4 files changed, 72 insertions(+), 2 deletions(-)
 create mode 100644 src/utils.js
 create mode 100644 src/utils.test.js

diff --git a/src/components/ProgramRecord/ProgramRecord.jsx b/src/components/ProgramRecord/ProgramRecord.jsx
index 4a9069b..698aadb 100644
--- a/src/components/ProgramRecord/ProgramRecord.jsx
+++ b/src/components/ProgramRecord/ProgramRecord.jsx
@@ -21,6 +21,7 @@ import ProgramRecordTable from './ProgramRecordTable';
 import RecordsHelp from './RecordsHelp';
 import ProgramRecordAlert from '../ProgramRecordAlert';
 import SendLearnerRecordModal from '../ProgramRecordSendModal';
+import createCorrectInternalRoute from '../../utils';
 
 import getProgramDetails from './data/service';
 
@@ -81,7 +82,7 @@ function ProgramRecord({ isPublic }) {
       className="back-to-records"
     >
       <Hyperlink
-        destination="/"
+        destination={createCorrectInternalRoute('/')}
         variant="muted"
       >
         <FormattedMessage
diff --git a/src/components/ProgramRecordsList/ProgramRecordsList.jsx b/src/components/ProgramRecordsList/ProgramRecordsList.jsx
index 1195482..a8529d3 100644
--- a/src/components/ProgramRecordsList/ProgramRecordsList.jsx
+++ b/src/components/ProgramRecordsList/ProgramRecordsList.jsx
@@ -12,6 +12,7 @@ import _ from 'lodash';
 
 import NavigationBar from '../NavigationBar';
 
+import createCorrectInternalRoute from '../../utils';
 import getProgramRecords from './data/service';
 
 function ProgramRecordsList() {
@@ -115,7 +116,7 @@ function ProgramRecordsList() {
             <div className="d-flex align-items-center pt-3 pt-lg-0">
               <Hyperlink
                 variant="muted"
-                destination={`/${record.uuid}`}
+                destination={createCorrectInternalRoute(`/${record.uuid}`)}
               >
                 <Button variant="outline-primary">
                   <FormattedMessage
diff --git a/src/utils.js b/src/utils.js
new file mode 100644
index 0000000..3d02321
--- /dev/null
+++ b/src/utils.js
@@ -0,0 +1,20 @@
+import { getConfig, getPath } from '@edx/frontend-platform';
+
+/**
+ * Create a correct inner path depend on config PUBLIC_PATH.
+ * @param {string} checkPath - the internal route path that is validated
+ * @returns {string} - the correct internal route path
+ */
+export default function createCorrectInternalRoute(checkPath) {
+  let basePath = getPath(getConfig().PUBLIC_PATH);
+
+  if (basePath.endsWith('/')) {
+    basePath = basePath.slice(0, -1);
+  }
+
+  if (!checkPath.startsWith(basePath)) {
+    return `${basePath}${checkPath}`;
+  }
+
+  return checkPath;
+}
diff --git a/src/utils.test.js b/src/utils.test.js
new file mode 100644
index 0000000..0283842
--- /dev/null
+++ b/src/utils.test.js
@@ -0,0 +1,48 @@
+import { getConfig, getPath } from '@edx/frontend-platform';
+
+import createCorrectInternalRoute from './utils';
+
+jest.mock('@edx/frontend-platform', () => ({
+  getConfig: jest.fn(),
+  ensureConfig: jest.fn(),
+  getPath: jest.fn(),
+}));
+
+describe('LearnerRecord utils', () => {
+  describe('createCorrectInternalRoute', () => {
+    beforeEach(() => {
+      getConfig.mockReset();
+      getPath.mockReset();
+    });
+
+    it('returns the correct internal route when checkPath is not prefixed with basePath', () => {
+      getConfig.mockReturnValue({ PUBLIC_PATH: 'example.com' });
+      getPath.mockReturnValue('/');
+
+      const checkPath = '/some/path';
+      const result = createCorrectInternalRoute(checkPath);
+
+      expect(result).toBe('/some/path');
+    });
+
+    it('returns the input checkPath when it is already prefixed with basePath', () => {
+      getConfig.mockReturnValue({ PUBLIC_PATH: 'example.com' });
+      getPath.mockReturnValue('/learner-record');
+
+      const checkPath = '/learner-record/some/path';
+      const result = createCorrectInternalRoute(checkPath);
+
+      expect(result).toBe('/learner-record/some/path');
+    });
+
+    it('handles basePath ending with a slash correctly', () => {
+      getConfig.mockReturnValue({ PUBLIC_PATH: 'example.com/' });
+      getPath.mockReturnValue('/learner-record/');
+
+      const checkPath = '/some/path';
+      const result = createCorrectInternalRoute(checkPath);
+
+      expect(result).toBe('/learner-record/some/path');
+    });
+  });
+});