feat: redirect to unit page if the hit or its parent is a unit (open…

…edx#957)

This change adds the feature to redirect from a search result to a Unit, in case the hit parent is a Unit, or the hit is a unit itself.

src/course-outline/CourseOutline.scss

@@ -9,18 +9,3 @@
 @import "./publish-modal/PublishModal";
 @import "./drag-helper/SortableItem";
 @import "./xblock-status/XBlockStatus";
-
-div.row:has(> div > div.highlight) {
-  animation: 5s glow;
-  animation-timing-function: cubic-bezier(1, 0, .72, .04);
-}
-
-@keyframes glow {
-  0% {
-    box-shadow: 0 0 5px 5px $primary-500;
-  }
-
-  100% {
-    box-shadow: unset;
-  }
-}

src/course-unit/course-xblock/CourseXBlock.jsx

@@ -1,12 +1,12 @@
 import { useEffect, useRef } from 'react';
 import PropTypes from 'prop-types';
 import { useDispatch, useSelector } from 'react-redux';
-import { useNavigate } from 'react-router-dom';
 import {
   ActionRow, Card, Dropdown, Icon, IconButton, useToggle,
 } from '@openedx/paragon';
 import { EditOutline as EditIcon, MoreVert as MoveVertIcon } from '@openedx/paragon/icons';
 import { useIntl } from '@edx/frontend-platform/i18n';
+import { useNavigate, useSearchParams } from 'react-router-dom';
 
 import { getCanEdit, getCourseId } from 'CourseAuthoring/course-unit/data/selectors';
 import DeleteModal from '../../generic/delete-modal/DeleteModal';
@@ -31,6 +31,10 @@ const CourseXBlock = ({
   const courseId = useSelector(getCourseId);
   const intl = useIntl();
 
+  const [searchParams] = useSearchParams();
+  const locatorId = searchParams.get('show');
+  const isScrolledToElement = locatorId === id;
+
   const visibilityMessage = userPartitionInfo.selectedGroupsLabel
     ? intl.formatMessage(messages.visibilityMessage, { selectedGroupsLabel: userPartitionInfo.selectedGroupsLabel })
     : null;
@@ -64,13 +68,17 @@ const CourseXBlock = ({
 
   useEffect(() => {
     // if this item has been newly added, scroll to it.
-    if (courseXBlockElementRef.current && shouldScroll) {
+    if (courseXBlockElementRef.current && (shouldScroll || isScrolledToElement)) {
       scrollToElement(courseXBlockElementRef.current);
     }
-  }, []);
+  }, [isScrolledToElement]);
 
   return (
-    <div ref={courseXBlockElementRef} {...props}>
+    <div
+      ref={courseXBlockElementRef}
+      {...props}
+      className={isScrolledToElement ? 'xblock-highlight' : undefined}
+    >
       <Card className="mb-1">
         <Card.Header
           title={title}

src/course-unit/hooks.jsx

@@ -1,6 +1,6 @@
 import { useEffect, useState } from 'react';
 import { useDispatch, useSelector } from 'react-redux';
-import { useNavigate } from 'react-router-dom';
+import { useNavigate, useSearchParams } from 'react-router-dom';
 
 import { RequestStatus } from '../data/constants';
 import {
@@ -31,6 +31,7 @@ import { useCopyToClipboard } from '../generic/clipboard';
 // eslint-disable-next-line import/prefer-default-export
 export const useCourseUnit = ({ courseId, blockId }) => {
   const dispatch = useDispatch();
+  const [searchParams] = useSearchParams();
 
   const [isErrorAlert, toggleErrorAlert] = useState(false);
   const [hasInternetConnectionError, setInternetConnectionError] = useState(false);
@@ -84,7 +85,16 @@ export const useCourseUnit = ({ courseId, blockId }) => {
 
   const handleNavigate = (id) => {
     if (sequenceId) {
-      navigate(`/course/${courseId}/container/${blockId}/${id}`, { replace: true });
+      const path = `/course/${courseId}/container/${blockId}/${id}`;
+      const options = { replace: true };
+      if (searchParams.size) {
+        navigate({
+          pathname: path,
+          search: `?${searchParams}`,
+        }, options);
+      } else {
+        navigate(path, options);
+      }
     }
   };
 

src/custom.d.ts

@@ -2,3 +2,8 @@ declare module '*.svg' {
   const content: string;
   export default content;
 }
+
+declare module '*.json' {
+  const value: any;
+  export default value;
+}

src/index.scss

@@ -28,3 +28,25 @@
 @import "search-modal/SearchModal";
 @import "certificates/scss/Certificates";
 @import "group-configurations/GroupConfigurations";
+
+// To apply the glow effect to the selected Section/Subsection, in the Course Outline
+div.row:has(> div > div.highlight) {
+  animation: 5s glow;
+  animation-timing-function: cubic-bezier(1, 0, .72, .04);
+}
+
+// To apply the glow effect to the selected xblock, in the Unit Outline
+div.xblock-highlight {
+  animation: 5s glow;
+  animation-timing-function: cubic-bezier(1, 0, .72, .04);
+}
+
+@keyframes glow {
+  0% {
+    box-shadow: 0 0 5px 5px $primary-500;
+  }
+
+  100% {
+    box-shadow: unset;
+  }
+}

src/search-modal/SearchResult.jsx

@@ -33,6 +33,81 @@ function getItemIcon(blockType) {
   return STRUCTURAL_TYPE_ICONS[blockType] ?? COMPONENT_TYPE_ICON_MAP[blockType] ?? Article;
 }
 
+/**
+ * Returns the URL Suffix for library/library component hit
+ * @param {import('./data/api').ContentHit} hit
+ * @param {string} libraryAuthoringMfeUrl
+ * @returns string
+*/
+function getLibraryHitUrl(hit, libraryAuthoringMfeUrl) {
+  const { contextKey } = hit;
+  return `${libraryAuthoringMfeUrl}/library/${contextKey}`;
+}
+
+/**
+ * Returns the URL Suffix for a unit hit
+ * @param {import('./data/api').ContentHit} hit
+ * @returns string
+*/
+function getUnitUrlSuffix(hit) {
+  const { contextKey, usageKey } = hit;
+  return `course/${contextKey}/container/${usageKey}`;
+}
+
+/**
+ * Returns the URL Suffix for a unit component hit
+ * @param {import('./data/api').ContentHit} hit
+ * @returns string
+*/
+function getUnitComponentUrlSuffix(hit) {
+  const { breadcrumbs, contextKey, usageKey } = hit;
+  if (breadcrumbs.length > 1) {
+    const parent = breadcrumbs[breadcrumbs.length - 1];
+
+    if ('usageKey' in parent) {
+      return `course/${contextKey}/container/${parent.usageKey}?show=${encodeURIComponent(usageKey)}`;
+    }
+  }
+
+  // istanbul ignore next - This case should never be reached
+  return `course/${contextKey}`;
+}
+
+/**
+ * Returns the URL Suffix for a course component hit
+ * @param {import('./data/api').ContentHit} hit
+ * @returns string
+*/
+function getCourseComponentUrlSuffix(hit) {
+  const { contextKey, usageKey } = hit;
+  return `course/${contextKey}?show=${encodeURIComponent(usageKey)}`;
+}
+
+/**
+ * Returns the URL Suffix for the search hit param
+ * @param {import('./data/api').ContentHit} hit
+ * @returns string
+*/
+function getUrlSuffix(hit) {
+  const { blockType, breadcrumbs } = hit;
+
+  // Check if is a unit
+  if (blockType === 'vertical') {
+    return getUnitUrlSuffix(hit);
+  }
+
+  // Check if the parent is a unit
+  if (breadcrumbs.length > 1) {
+    const parent = breadcrumbs[breadcrumbs.length - 1];
+
+    if ('usageKey' in parent && parent.usageKey.includes('type@vertical')) {
+      return getUnitComponentUrlSuffix(hit);
+    }
+  }
+
+  return getCourseComponentUrlSuffix(hit);
+}
+
 /**
  * A single search result (row), usually represents an XBlock/Component
  * @type {React.FC<{hit: import('./data/api').ContentHit}>}
@@ -43,33 +118,34 @@ const SearchResult = ({ hit }) => {
   const { closeSearchModal } = useSearchContext();
   const { libraryAuthoringMfeUrl, redirectToLibraryAuthoringMfe } = useSelector(getStudioHomeData);
 
+  const { usageKey } = hit;
+
+  const noRedirectUrl = usageKey.startsWith('lb:') && !redirectToLibraryAuthoringMfe;
+
   /**
    * Returns the URL for the context of the hit
    */
   const getContextUrl = React.useCallback((newWindow = false) => {
-    const { contextKey, usageKey } = hit;
+    const { contextKey } = hit;
+
     if (contextKey.startsWith('course-v1:')) {
-      const courseSufix = `course/${contextKey}?show=${encodeURIComponent(usageKey)}`;
+      const urlSuffix = getUrlSuffix(hit);
+
       if (newWindow) {
-        return `${getPath(getConfig().PUBLIC_PATH)}${courseSufix}`;
+        return `${getPath(getConfig().PUBLIC_PATH)}${urlSuffix}`;
       }
-      return `/${courseSufix}`;
+      return `/${urlSuffix}`;
     }
+
     if (usageKey.startsWith('lb:')) {
       if (redirectToLibraryAuthoringMfe) {
-        return `${libraryAuthoringMfeUrl}library/${contextKey}`;
+        return getLibraryHitUrl(hit, libraryAuthoringMfeUrl);
       }
     }
 
-    // No context URL for this hit
+    // No context URL for this hit (e.g. a library without library authoring mfe)
     return undefined;
-  }, [libraryAuthoringMfeUrl, redirectToLibraryAuthoringMfe]);
-
-  const redirectUrl = React.useMemo(() => getContextUrl(), [libraryAuthoringMfeUrl, redirectToLibraryAuthoringMfe]);
-  const newWindowUrl = React.useMemo(
-    () => getContextUrl(true),
-    [libraryAuthoringMfeUrl, redirectToLibraryAuthoringMfe],
-  );
+  }, [libraryAuthoringMfeUrl, redirectToLibraryAuthoringMfe, hit]);
 
   /**
    * Opens the context of the hit in a new window
@@ -78,6 +154,7 @@ const SearchResult = ({ hit }) => {
    */
   const openContextInNewWindow = (e) => {
     e.stopPropagation();
+    const newWindowUrl = getContextUrl(true);
     /* istanbul ignore next */
     if (!newWindowUrl) {
       return;
@@ -90,8 +167,9 @@ const SearchResult = ({ hit }) => {
    * @param {(React.MouseEvent | React.KeyboardEvent)} e
    * @returns {void}
    */
-  const navigateToContext = (e) => {
+  const navigateToContext = React.useCallback((e) => {
     e.stopPropagation();
+    const redirectUrl = getContextUrl();
 
     /* istanbul ignore next */
     if (!redirectUrl) {
@@ -112,16 +190,16 @@ const SearchResult = ({ hit }) => {
 
     navigate(redirectUrl);
     closeSearchModal();
-  };
+  }, [getContextUrl]);
 
   return (
     <Stack
-      className={`border-bottom search-result p-2 align-items-start ${!redirectUrl ? 'text-muted' : ''}`}
+      className={`border-bottom search-result p-2 align-items-start ${noRedirectUrl ? 'text-muted' : ''}`}
       direction="horizontal"
       gap={3}
       onClick={navigateToContext}
       onKeyDown={navigateToContext}
-      tabIndex={redirectUrl ? 0 : undefined}
+      tabIndex={noRedirectUrl ? undefined : 0}
       role="button"
     >
       <Icon className="text-muted" src={getItemIcon(hit.blockType)} />
@@ -140,7 +218,7 @@ const SearchResult = ({ hit }) => {
       <IconButton
         src={OpenInNew}
         iconAs={Icon}
-        disabled={!newWindowUrl}
+        disabled={noRedirectUrl ? true : undefined}
         onClick={openContextInNewWindow}
         alt={intl.formatMessage(messages.openInNewWindow)}
       />