chore: teak 2 update (#10)

* refactor: remove custom order function from course libraries list (openedx#1865) (openedx#1888)

(cherry picked from commit bc18fff)

* perf: use Library search results to populate container card preview [FC-0083] [TEAK] (openedx#1889)

* fix: several library unit page UX bugs (openedx#1868)

* fix: rename "Organize" tab to "Manage"

* fix: duplicate key warnings

* fix: uniform messages while adding to collection

* fix: do not allow units be added to a unit

(cherry picked from commit 0fdc460)

* perf: use Library search results to populate container card preview (openedx#1820)

* fix: use Library search results to populate container card preview

* feat: show published children when showing only published Unit content

* fix: nits

(cherry picked from commit 24e4695)

---------

Co-authored-by: Rômulo Penido <romulo.penido@gmail.com>

* fix: manage access modal on duplicated xblock (openedx#1874)

* fix: unit pages ux bugs [FC-0083] (openedx#1884) (openedx#1916)

This PR fixes some UX bugs related to the unit pages:

* Sort for "recently modified" on unit tab does not update after adding new components to units
* Change component delete warning message

It's a backport of openedx#1884

* fix: UX issues in unit page (openedx#1913) (openedx#1923)

Fixes the following issues:

* Selection behavior
* Component selection is by header click only
* Newly created blocks within a unit should be selected on creation/save, appear selected, and have their sidebar open
* Some long text components seem to display at the default height rather than a longer height
* Within the full-page unit view, the "add to collection" overflow menu item on components does not seem to work/only opens the sidebar.
* Draft status indicator text is not vertically centered with icon
* When reordering, dragging a short component past a long component often causes a strange stutter effect.
* When dragging to reorder a component, moving quickly or scrolling often causes the drag handle to be lost / causes the block to jump somewhere else
* Reordering may not consistently support a keyboard-accessible option to change order, like in course authoring
* Tag button on component header opens the old tag side pane

(cherry picked from commit 8c3fab3)

* fix: invalidate search results when publishing all changes in library (openedx#1925) (openedx#1927)

(cherry picked from commit cdb8016)

Co-authored-by: Braden MacDonald <braden@opencraft.com>

* fix: improve focus/selected style on library authoring (openedx#1918) (openedx#1930)

Improves the focus and selected styles from the LibraryPage and UnitPage.

* fix: review/sync bugs [FC-0083] (openedx#1905) (openedx#1941)

Fixes issues related to component libraries' review/sync flow

* Inconsistent sync pane title versions
* Library content shown in preview warning only appears in review changes modal when that modal is opened from the review tab
* Some new changes only appear within library review tab on scroll at top of list
* Vertically misaligned sync icon in review changes message on course outline
* Show available updates whenever content is updated, regardless of number of updates available

* fix: Issue with read-only units in libraries & published version of units in library units picker (openedx#1940)

Fixes the issues from openedx#1633 (comment)

* In successfully added units, the "add new component" widget appears sometimes
* In the "add existing unit" modal, the preview shows draft versions of units

* fix: search modal refresh on typing (openedx#1938) (openedx#1948)

* [Teak] backport openedx#1949, openedx#1999 and openedx#2002 (openedx#2006)

* feat: select component and show sidebar on edit  (openedx#1949)

Select component that is being edited in library and show its sidebar. Also fixes issue with children component listing in library unit page

(cherry picked from commit 08ac1c0)

* fix: search text flickering (openedx#1999)

Fix flickering issue in search field.

(cherry picked from commit 6f3b7ab)

* feat: open collection or unit page on double click only (openedx#2002)

Opens collection or unit page only on double click.

(cherry picked from commit 503642b)

* fix: change InplaceTextEditor style and add optimistic update (openedx#1953) (openedx#2014)

* Optimistic update for renaming Components, Collections and Containers
* Change the InplaceTextEditor to show the new text until the onSave promise resolves
* Change the InplaceTextEditor style to: Always show the rename button

* fix: rename library publish button (openedx#2015)

* fix: do open editor of new xblock when duplicating (openedx#2017)

* feat: display editors as modals  (openedx#1838)

* fix: do open editor of new xblock when duplicating (openedx#1887)

Fixes bug where after duplicating an xblock, the editor modal of the old xblock is being open instead of the new copied xblock.

* [Teak] fix: Inconsistent publish status filter menu placement & fix: Remove never published filter from component picker (openedx#2021)

* fix: Inconsistent publish status filter menu placement (openedx#1966)

* fix: Remove never published filter from component picker (openedx#1947)

Removes the never-published filter option from the component picker and unit picker.

* fix: refresh xblock inline after accepting/rejecting library sync (openedx#2022) (openedx#2028)

Instead of reloading the entire Unit after syncing changes from the
library, just reload the xblock that was changed.

(cherry picked from commit ac5574d)

* fix: set maxHeight on TextEditor TinyMce widget [FC-0090] (openedx#2024) (openedx#2030)

Sets a max_height=500px for the TinyMCE editor when editing a Text/Html component.
This prevents the autoresize plugin from expanding the editor textarea beyond the bounds of the editor modal.

⚠️ Because the max height can only be a numeric pixel value, we can't use clever settings like vh or %, and so we're forced to limit the height of the editor to a fixed size for all screen sizes in order to address this issue.

(cherry picked from commit c5f7d0c)

* fix: upstreamInfo is not always provided (openedx#2041) (openedx#2042)

(cherry picked from commit 3fc0f27)

* fix: selection card wiggle (openedx#2047)

* fix: set unit preview readonly on sidebar (openedx#2008) (openedx#2059)

Make the unit preview on the sidebar read-only and add `Truncate` to the `InplaceTextEditor`

* fix: backport changes for html button in text component markdown editor (openedx#2065)

* fix: markdown editor issues in modal (openedx#2076)

This PR resolves rendering issues with the Markdown editor inside the modal.
The problem began after a PR [1] introduced the use of modals for the editor.
The EditorPage [2] component expects a `isMarkdownEditorEnabledForCourse` prop,
which was missing in that implementation.

[1] openedx#1838 
[2] https://github.com/openedx/frontend-app-authoring/pull/1838/files#diff-147218ef88726880178ea895988a5d3feaf2c0c4459086a8de7a4080cbe37de7R226

Backports openedx#2074

* fix: Expand all now expands subsections (openedx#2085)

* fix: files & uploads menu was truncated due to overflow-x (openedx#2071) (openedx#2077)

* fix: (backport) remove an extra editing xblock modal on unit page (openedx#2111) (openedx#2130)

* fix: (backport) enable markdown editor in libraries (openedx#2098)

* fix: enable markdown editor for problems in libraries too

This fix is also achieved on master via 5991fd3 / openedx#2068 but this is a simpler fix, not a direct backport of that refactor.

* fix: remove duplicate markdown_edited save request (openedx#2127)

Removes the unnecessary duplicate save  request of markdown_edited
value to the backend.

Part of: openedx#2099
Backports: 62589ae

---------

Co-authored-by: Muhammad Anas <88967643+Anas12091101@users.noreply.github.com>

* fix: remove icon and empty breadcrumb from libraries (openedx#2129) (openedx#2133)

* fix: (backport) text truncate issue in the search modal (openedx#2151)

* [Teak] fix: published name in unit sidebar in container picker & Issues on Inplace Editor (openedx#2140)

Backport of fix: show unit published name in sidebar on content picker [FC-0090] openedx#2100 
Backport of fix: Issue on the Inplace editor [FC-0090] openedx#2101

* feat: add `v2` `CourseAuthoringUnitSidebarSlot` (openedx#2000)

* fix: advanced-settings api should not camel-case return value (backport) (openedx#2087)

* fix: advanced-settings api should not camel-case return value (openedx#1581)

* fix: update advanced module list not working (openedx#2189)

Backend was still expecting `{'advanced_modules', {'value': ['poll', 'problem-builder', 'h5pxblock']}}` but without this change, it was receiving `{'advancedModules', ['poll', 'problem-builder', 'h5pxblock']}`

Follow up to openedx#1581

---------

Co-authored-by: Muhammad Faraz Maqsood <fmaqsood@2u.com>

* fix: clear selection on files & uploads page after deleting (backport) (openedx#2228)

* refactor: remove selected rows when deleting or adding elements

* refactor: ensure unique asset IDs when adding new ones

* refactor: remove unnecessary loading checks in mockStore function

* test: add unit tests for TableActions component

* fix: loading unit page directly from link after logging in in Teak (openedx#2246)

This is a simple version of the fix for Teak; on master it was fixed with openedx#1867

* fix: pages and resources plugins not rendered (openedx#1885)

* docs: (backport) adding comprehensive readme documentation for plugin slots (openedx#2340)

* fix: publish btn doesn't show after component edit

When we edit & save the component, publish button doesn't show up until we refresh the page manualy or open this unit by opening previous unit and coming back to this unit again.
In this commit, we are dispatching a storage event whenever we edit the component, it'll refresh the page & show the publish button as expected.

---------

Co-authored-by: Navin Karkera <navin@opencraft.com>
Co-authored-by: Jillian <jill@opencraft.com>
Co-authored-by: Rômulo Penido <romulo.penido@gmail.com>
Co-authored-by: Ihor Romaniuk <ihor.romaniuk@raccoongang.com>
Co-authored-by: Braden MacDonald <braden@opencraft.com>
Co-authored-by: Chris Chávez <xnpiochv@gmail.com>
Co-authored-by: Daniel Valenzuela <dsvalenzuela@uc.cl>
Co-authored-by: Tony Busa <70979397+tonybusa@users.noreply.github.com>
Co-authored-by: Muhammad Anas <88967643+Anas12091101@users.noreply.github.com>
Co-authored-by: Victor Navarro <vm.navarro94@gmail.com>
Co-authored-by: diana-villalvazo-wgu <diana.villalvazo@wgu.edu>
Co-authored-by: bydawen <oleksandr.buhaienko@raccoongang.com>
Co-authored-by: Arunmozhi <tecoholic@users.noreply.github.com>
Co-authored-by: José Ignacio Palma <jignaciopm13@gmail.com>
Co-authored-by: Muhammad Faraz Maqsood <fmaqsood@2u.com>
Co-authored-by: Brayan Cerón <86393372+bra-i-am@users.noreply.github.com>
Co-authored-by: Jansen Kantor <jkantor@edx.org>
Co-authored-by: Jacobo Dominguez <jacobo.dominguez@wgu.edu>
Co-authored-by: Muhammad Faraz  Maqsood <faraz.maqsood@A006-01130.local>

Author: 20 people

src/course-unit/CourseUnit.jsx

@@ -41,6 +41,7 @@ const CourseUnit = ({ courseId }) => {
     courseUnit,
     isLoading,
     sequenceId,
+    courseUnitLoadingStatus,
     unitTitle,
     unitCategory,
     errorMessage,
@@ -210,6 +211,7 @@ const CourseUnit = ({ courseId }) => {
                 courseId={courseId}
                 blockId={blockId}
                 isUnitVerticalType={isUnitVerticalType}
+                courseUnitLoadingStatus={courseUnitLoadingStatus}
                 unitXBlockActions={unitXBlockActions}
                 courseVerticalChildren={courseVerticalChildren.children}
                 handleConfigureSubmit={handleConfigureSubmit}

src/course-unit/course-sequence/hooks.js

@@ -12,16 +12,19 @@ export function useSequenceNavigationMetadata(courseId, currentSequenceId, curre
   const isLastUnit = !nextUrl;
   const sequenceIds = useSelector(getSequenceIds);
   const sequenceIndex = sequenceIds.indexOf(currentSequenceId);
-  const unitIndex = sequence.unitIds.indexOf(currentUnitId);
+  let unitIndex = sequence?.unitIds.indexOf(currentUnitId);
 
   const nextSequenceId = sequenceIndex < sequenceIds.length - 1 ? sequenceIds[sequenceIndex + 1] : null;
   const previousSequenceId = sequenceIndex > 0 ? sequenceIds[sequenceIndex - 1] : null;
-
+  if (!unitIndex) {
+    // Handle case where unitIndex is not found
+    unitIndex = 0;
+  }
   let nextLink;
   const nextIndex = unitIndex + 1;
 
-  if (nextIndex < sequence.unitIds.length) {
-    const nextUnitId = sequence.unitIds[nextIndex];
+  if (nextIndex < sequence?.unitIds.length) {
+    const nextUnitId = sequence?.unitIds[nextIndex];
     nextLink = `/course/${courseId}/container/${nextUnitId}/${currentSequenceId}`;
   } else if (nextSequenceId) {
     const pathToNextUnit = decodeURIComponent(nextUrl);
@@ -32,7 +35,7 @@ export function useSequenceNavigationMetadata(courseId, currentSequenceId, curre
   const previousIndex = unitIndex - 1;
 
   if (previousIndex >= 0) {
-    const previousUnitId = sequence.unitIds[previousIndex];
+    const previousUnitId = sequence?.unitIds[previousIndex];
     previousLink = `/course/${courseId}/container/${previousUnitId}/${currentSequenceId}`;
   } else if (previousSequenceId) {
     const pathToPreviousUnit = decodeURIComponent(prevUrl);

src/course-unit/course-sequence/sequence-navigation/SequenceNavigation.jsx

@@ -35,15 +35,15 @@ const SequenceNavigation = ({
 
   const shouldDisplayNotificationTriggerInSequence = useWindowSize().width < breakpoints.small.minWidth;
   const renderUnitButtons = () => {
-    if (sequence.unitIds?.length === 0 || unitId === null) {
+    if (sequence?.unitIds?.length === 0 || unitId === null) {
       return (
         <div style={{ flexBasis: '100%', minWidth: 0, borderBottom: 'solid 1px #EAEAEA' }} />
       );
     }
 
     return (
       <SequenceNavigationTabs
-        unitIds={sequence.unitIds || []}
+        unitIds={sequence?.unitIds || []}
         unitId={unitId}
         handleCreateNewCourseXBlock={handleCreateNewCourseXBlock}
         showPasteUnit={showPasteUnit}

src/course-unit/data/selectors.js

@@ -16,7 +16,7 @@ export const getCourseVerticalChildren = (state) => state.courseUnit.courseVerti
 export const getCourseOutlineInfo = (state) => state.courseUnit.courseOutlineInfo;
 export const getCourseOutlineInfoLoadingStatus = (state) => state.courseUnit.courseOutlineInfoLoadingStatus;
 export const getMovedXBlockParams = (state) => state.courseUnit.movedXBlockParams;
-const getLoadingStatuses = (state) => state.courseUnit.loadingStatus;
+export const getLoadingStatuses = (state) => state.courseUnit.loadingStatus;
 export const getIsLoading = createSelector(
   [getLoadingStatuses],
   loadingStatus => Object.values(loadingStatus)

src/course-unit/hooks.jsx

@@ -35,6 +35,7 @@ import {
   getSavingStatus,
   getSequenceStatus,
   getStaticFileNotices,
+  getLoadingStatuses,
 } from './data/selectors';
 import {
   changeEditTitleFormOpen,
@@ -51,6 +52,7 @@ export const useCourseUnit = ({ courseId, blockId }) => {
   const [isMoveModalOpen, openMoveModal, closeMoveModal] = useToggle(false);
 
   const courseUnit = useSelector(getCourseUnitData);
+  const courseUnitLoadingStatus = useSelector(getLoadingStatuses);
   const savingStatus = useSelector(getSavingStatus);
   const isLoading = useSelector(getIsLoading);
   const errorMessage = useSelector(getErrorMessage);
@@ -215,9 +217,28 @@ export const useCourseUnit = ({ courseId, blockId }) => {
     }
   }, [isMoveModalOpen]);
 
+  useEffect(() => {
+    const handlePageRefreshUsingStorage = (event) => {
+      // ignoring tests for if block, because it triggers when someone
+      // edits the component using editor which has a separate store
+      /* istanbul ignore next */
+      if (event.key === 'courseRefreshTriggerOnComponentEditSave') {
+        dispatch(fetchCourseSectionVerticalData(blockId, sequenceId));
+        dispatch(fetchCourseVerticalChildrenData(blockId, isSplitTestType));
+        localStorage.removeItem(event.key);
+      }
+    };
+
+    window.addEventListener('storage', handlePageRefreshUsingStorage);
+    return () => {
+      window.removeEventListener('storage', handlePageRefreshUsingStorage);
+    };
+  }, [blockId, sequenceId, isSplitTestType]);
+
   return {
     sequenceId,
     courseUnit,
+    courseUnitLoadingStatus,
     unitTitle,
     unitCategory,
     errorMessage,

src/course-unit/sidebar/utils.js

@@ -99,4 +99,4 @@ export const getIconVariant = (visibilityState, published, hasChanges) => {
  * @param {string} id - The course unit ID.
  * @returns {string} The clear course unit ID extracted from the provided data.
  */
-export const extractCourseUnitId = (id) => id.match(/block@(.+)$/)[1];
+export const extractCourseUnitId = (id) => id?.match(/block@(.+)$/)[1];

src/course-unit/xblock-container-iframe/index.tsx

@@ -37,9 +37,16 @@ import { useIframeContent } from '../../generic/hooks/useIframeContent';
 import { useIframeMessages } from '../../generic/hooks/useIframeMessages';
 import VideoSelectorPage from '../../editors/VideoSelectorPage';
 import EditorPage from '../../editors/EditorPage';
+import { RequestStatus } from '../../data/constants';
 
 const XBlockContainerIframe: FC<XBlockContainerIframeProps> = ({
-  courseId, blockId, unitXBlockActions, courseVerticalChildren, handleConfigureSubmit, isUnitVerticalType,
+  courseId,
+  blockId,
+  unitXBlockActions,
+  courseVerticalChildren,
+  handleConfigureSubmit,
+  isUnitVerticalType,
+  courseUnitLoadingStatus,
 }) => {
   const intl = useIntl();
   const dispatch = useDispatch();
@@ -70,6 +77,23 @@ const XBlockContainerIframe: FC<XBlockContainerIframeProps> = ({
     setIframeRef(iframeRef);
   }, [setIframeRef]);
 
+  useEffect(() => {
+    const iframe = iframeRef?.current;
+    if (!iframe) { return undefined; }
+
+    const handleIframeLoad = () => {
+      if (courseUnitLoadingStatus.fetchUnitLoadingStatus === RequestStatus.FAILED) {
+        window.location.reload();
+      }
+    };
+
+    iframe.addEventListener('load', handleIframeLoad);
+
+    return () => {
+      iframe.removeEventListener('load', handleIframeLoad);
+    };
+  }, [iframeRef]);
+
   const onXBlockSave = useCallback(/* istanbul ignore next */ () => {
     closeXBlockEditorModal();
     closeVideoSelectorModal();

src/course-unit/xblock-container-iframe/types.ts

@@ -42,6 +42,11 @@ export interface XBlockContainerIframeProps {
   courseId: string;
   blockId: string;
   isUnitVerticalType: boolean,
+  courseUnitLoadingStatus: {
+    fetchUnitLoadingStatus: string;
+    fetchVerticalChildrenLoadingStatus: string;
+    fetchXBlockDataLoadingStatus: string;
+  };
   unitXBlockActions: {
     handleDelete: (XBlockId: string | null) => void;
     handleDuplicate: (XBlockId: string | null) => void;

src/editors/data/redux/thunkActions/app.js

@@ -125,6 +125,16 @@ export const saveBlock = (content, returnToUnit) => (dispatch) => {
     content,
     onSuccess: (response) => {
       dispatch(actions.app.setSaveResponse(response));
+      const parsedData = JSON.parse(response.config.data);
+      if (parsedData?.has_changes) {
+        const storageKey = 'courseRefreshTriggerOnComponentEditSave';
+        localStorage.setItem(storageKey, Date.now());
+
+        window.dispatchEvent(new StorageEvent('storage', {
+          key: storageKey,
+          newValue: Date.now().toString(),
+        }));
+      }
       returnToUnit(response.data);
     },
   }));

src/editors/data/redux/thunkActions/app.test.js

@@ -352,7 +352,11 @@ describe('app thunkActions', () => {
     });
     it('dispatches actions.app.setSaveResponse with response and then calls returnToUnit', () => {
       dispatch.mockClear();
-      const response = 'testRESPONSE';
+      const mockParsedData = { has_changes: true };
+      const response = {
+        config: { data: JSON.stringify(mockParsedData) },
+        data: {},
+      };
       calls[1][0].saveBlock.onSuccess(response);
       expect(dispatch).toHaveBeenCalledWith(actions.app.setSaveResponse(response));
       expect(returnToUnit).toHaveBeenCalled();