refactor: replace query-string pkg, remove unused <ShareButton> (#1676)

Author: bradenmacdonald

package-lock.json

@@ -59,7 +59,6 @@
     "lodash.camelcase": "4.3.0",
     "postcss-loader": "^8.1.1",
     "prop-types": "15.8.1",
-    "query-string": "^7.1.3",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-helmet": "6.1.0",

package.json

@@ -16,6 +16,7 @@ jest.mock('react-router-dom', () => ({
   useLocation: () => ({
     search: '?consentPath=/some-path',
   }),
+  useSearchParams: () => [new URLSearchParams('?consentPath=/some-path'), () => {}],
 }));
 
 describe('RedirectPage component', () => {

src/courseware/RedirectPage.test.jsx

@@ -1,18 +1,20 @@
-import PropTypes from 'prop-types';
 import {
-  generatePath, useParams, useLocation,
+  generatePath, useParams, useLocation, useSearchParams,
 } from 'react-router-dom';
 import { getConfig } from '@edx/frontend-platform';
 
-import queryString from 'query-string';
 import { REDIRECT_MODES } from '../constants';
 
-const RedirectPage = ({
-  pattern, mode,
-}) => {
+interface Props {
+  pattern: string;
+  mode: string;
+}
+
+const RedirectPage = ({ pattern = '', mode }: Props) => {
   const { courseId } = useParams();
   const location = useLocation();
-  const { consentPath } = queryString.parse(location?.search);
+  const [searchParams] = useSearchParams();
+  const consentPath = searchParams.get('consentPath') ?? '';
 
   const {
     LMS_BASE_URL,
@@ -39,13 +41,4 @@ const RedirectPage = ({
   return null;
 };
 
-RedirectPage.propTypes = {
-  pattern: PropTypes.string,
-  mode: PropTypes.string.isRequired,
-};
-
-RedirectPage.defaultProps = {
-  pattern: null,
-};
-
 export default RedirectPage;

src/courseware/RedirectPage.jsx renamed to src/courseware/RedirectPage.tsx

@@ -0,0 +1,42 @@
+import { getConfig } from '@edx/frontend-platform';
+import { getIFrameUrl } from './urls';
+
+jest.mock('@edx/frontend-platform', () => ({
+  getConfig: jest.fn(),
+}));
+const config = { LMS_BASE_URL: 'https://test-lms-url' };
+getConfig.mockReturnValue(config);
+
+const props = {
+  id: 'test-id',
+  view: 'test-view',
+  format: 'test-format',
+  examAccess: { blockAccess: false, accessToken: 'test-access-token' },
+  preview: false,
+};
+
+describe('urls module getIFrameUrl', () => {
+  test('format provided, exam access and token available', () => {
+    expect(getIFrameUrl(props)).toEqual('https://test-lms-url/xblock/test-id?exam_access=test-access-token&format=test-format&preview=false&recheck_access=1&show_bookmark=0&show_title=0&view=test-view');
+  });
+  test('no format provided, exam access blocked', () => {
+    expect(getIFrameUrl({
+      id: props.id,
+      view: props.view,
+      preview: props.preview,
+      examAccess: { blockAccess: true },
+    })).toEqual('https://test-lms-url/xblock/test-id?preview=false&recheck_access=1&show_bookmark=0&show_title=0&view=test-view');
+  });
+  test('jumpToId and fragmentIdentifier is added to url', () => {
+    expect(getIFrameUrl({
+      ...props,
+      jumpToId: 'some-xblock-id',
+    })).toEqual('https://test-lms-url/xblock/test-id?exam_access=test-access-token&format=test-format&jumpToId=some-xblock-id&preview=false&recheck_access=1&show_bookmark=0&show_title=0&view=test-view#some-xblock-id');
+  });
+  test('preview is true and url param equals 1', () => {
+    expect(getIFrameUrl({
+      ...props,
+      preview: true,
+    })).toEqual('https://test-lms-url/xblock/test-id?exam_access=test-access-token&format=test-format&preview=true&recheck_access=1&show_bookmark=0&show_title=0&view=test-view');
+  });
+});

src/courseware/course/sequence/Unit/urls.js

@@ -0,0 +1,49 @@
+import { getConfig } from '@edx/frontend-platform';
+
+export const iframeParams = {
+  show_title: 0,
+  show_bookmark: 0,
+  recheck_access: 1,
+};
+
+interface Props {
+  id: string;
+  view: string;
+  format?: string | null;
+  examAccess: { blockAccess: boolean, accessToken?: string };
+  jumpToId?: string;
+  preview: boolean;
+}
+
+export const getIFrameUrl = ({
+  id,
+  view,
+  format = null,
+  examAccess,
+  jumpToId,
+  preview,
+}: Props) => {
+  const xblockUrl = new URL(`${getConfig().LMS_BASE_URL}/xblock/${id}`);
+  for (const [key, value] of Object.entries(iframeParams)) {
+    xblockUrl.searchParams.set(key, String(value));
+  }
+  xblockUrl.searchParams.set('view', view);
+  xblockUrl.searchParams.set('preview', String(preview));
+  if (format) {
+    xblockUrl.searchParams.set('format', format);
+  }
+  if (!examAccess.blockAccess) {
+    xblockUrl.searchParams.set('exam_access', examAccess.accessToken!);
+  }
+  // Pass jumpToId as query param as fragmentIdentifier is not passed to server.
+  if (jumpToId) {
+    xblockUrl.searchParams.set('jumpToId', jumpToId);
+    xblockUrl.hash = `#${jumpToId}`; // this is used by browser to scroll to correct block.
+  }
+  xblockUrl.searchParams.sort();
+  return xblockUrl.toString();
+};
+
+export default {
+  getIFrameUrl,
+};