From 9f5bcca1eb6e7c5a94e5877f997216193a3eab7d Mon Sep 17 00:00:00 2001
From: WithoutPants <53250216+WithoutPants@users.noreply.github.com>
Date: Mon, 25 Sep 2023 09:35:55 +1000
Subject: [PATCH] Fix lightbox fullscreen issues (#4149)

* Improve lightbox context hook
* Prevent fullscreen drop while loading
* Fix close not working from fullscreen
---
 ui/v2.5/src/hooks/Lightbox/Lightbox.tsx | 468 ++++++++++++------------
 ui/v2.5/src/hooks/Lightbox/context.tsx  |  19 +-
 ui/v2.5/src/hooks/Lightbox/hooks.ts     |   8 +-
 3 files changed, 260 insertions(+), 235 deletions(-)

diff --git a/ui/v2.5/src/hooks/Lightbox/Lightbox.tsx b/ui/v2.5/src/hooks/Lightbox/Lightbox.tsx
index 9388061beb5..5430bede94a 100644
--- a/ui/v2.5/src/hooks/Lightbox/Lightbox.tsx
+++ b/ui/v2.5/src/hooks/Lightbox/Lightbox.tsx
@@ -319,12 +319,12 @@ export const LightboxComponent: React.FC<IProps> = ({
   });
 
   const close = useCallback(() => {
-    if (!isFullscreen) {
-      hide();
-      document.body.style.overflow = "auto";
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      (Mousetrap as any).unpause();
-    } else document.exitFullscreen();
+    if (isFullscreen) document.exitFullscreen();
+
+    hide();
+    document.body.style.overflow = "auto";
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (Mousetrap as any).unpause();
   }, [isFullscreen, hide]);
 
   const handleClose = (e: React.MouseEvent<HTMLDivElement>) => {
@@ -685,263 +685,277 @@ export const LightboxComponent: React.FC<IProps> = ({
     );
   }
 
-  if (!isVisible) {
-    return <></>;
-  }
-
-  if (images.length === 0 || isLoading || isSwitchingPage) {
-    return <LoadingIndicator />;
-  }
+  function renderBody() {
+    if (images.length === 0 || isLoading || isSwitchingPage) {
+      return <LoadingIndicator />;
+    }
 
-  const currentImage: ILightboxImage | undefined = images[currentIndex];
+    const currentImage: ILightboxImage | undefined = images[currentIndex];
 
-  function setRating(v: number | null) {
-    if (currentImage?.id) {
-      updateImage({
-        variables: {
-          input: {
-            id: currentImage.id,
-            rating100: v,
+    function setRating(v: number | null) {
+      if (currentImage?.id) {
+        updateImage({
+          variables: {
+            input: {
+              id: currentImage.id,
+              rating100: v,
+            },
           },
-        },
-      });
+        });
+      }
     }
-  }
 
-  async function onIncrementClick() {
-    if (currentImage?.id === undefined) return;
-    try {
-      await mutateImageIncrementO(currentImage.id);
-    } catch (e) {
-      Toast.error(e);
+    async function onIncrementClick() {
+      if (currentImage?.id === undefined) return;
+      try {
+        await mutateImageIncrementO(currentImage.id);
+      } catch (e) {
+        Toast.error(e);
+      }
     }
-  }
 
-  async function onDecrementClick() {
-    if (currentImage?.id === undefined) return;
-    try {
-      await mutateImageDecrementO(currentImage.id);
-    } catch (e) {
-      Toast.error(e);
+    async function onDecrementClick() {
+      if (currentImage?.id === undefined) return;
+      try {
+        await mutateImageDecrementO(currentImage.id);
+      } catch (e) {
+        Toast.error(e);
+      }
     }
-  }
 
-  async function onResetClick() {
-    if (currentImage?.id === undefined) return;
-    try {
-      await mutateImageResetO(currentImage?.id);
-    } catch (e) {
-      Toast.error(e);
+    async function onResetClick() {
+      if (currentImage?.id === undefined) return;
+      try {
+        await mutateImageResetO(currentImage?.id);
+      } catch (e) {
+        Toast.error(e);
+      }
     }
-  }
 
-  const pageHeader =
-    page && pages
-      ? intl.formatMessage(
-          { id: "dialogs.lightbox.page_header" },
-          { page, total: pages }
-        )
-      : "";
+    const pageHeader =
+      page && pages
+        ? intl.formatMessage(
+            { id: "dialogs.lightbox.page_header" },
+            { page, total: pages }
+          )
+        : "";
 
-  return (
-    <div
-      className={CLASSNAME}
-      role="presentation"
-      ref={containerRef}
-      onClick={handleClose}
-    >
-      <div className={CLASSNAME_HEADER}>
-        <div className={CLASSNAME_LEFT_SPACER}>{renderChapterMenu()}</div>
-        <div className={CLASSNAME_INDICATOR}>
-          <span>
-            {chapterHeader()} {pageHeader}
-          </span>
-          {images.length > 1 ? (
-            <b ref={indicatorRef}>{`${currentIndex + 1} / ${images.length}`}</b>
-          ) : undefined}
-        </div>
-        <div className={CLASSNAME_RIGHT}>
-          <div className={CLASSNAME_OPTIONS}>
-            <div className={CLASSNAME_OPTIONS_ICON}>
+    return (
+      <>
+        <div className={CLASSNAME_HEADER}>
+          <div className={CLASSNAME_LEFT_SPACER}>{renderChapterMenu()}</div>
+          <div className={CLASSNAME_INDICATOR}>
+            <span>
+              {chapterHeader()} {pageHeader}
+            </span>
+            {images.length > 1 ? (
+              <b ref={indicatorRef}>{`${currentIndex + 1} / ${
+                images.length
+              }`}</b>
+            ) : undefined}
+          </div>
+          <div className={CLASSNAME_RIGHT}>
+            <div className={CLASSNAME_OPTIONS}>
+              <div className={CLASSNAME_OPTIONS_ICON}>
+                <Button
+                  ref={overlayTarget}
+                  variant="link"
+                  title={intl.formatMessage({
+                    id: "dialogs.lightbox.options",
+                  })}
+                  onClick={() => setShowOptions(!showOptions)}
+                >
+                  <Icon icon={faCog} />
+                </Button>
+                <Overlay
+                  target={overlayTarget.current}
+                  show={showOptions}
+                  placement="bottom"
+                  container={containerRef}
+                  rootClose
+                  onHide={() => setShowOptions(false)}
+                >
+                  {({ placement, arrowProps, show: _show, ...props }) => (
+                    <div
+                      className="popover"
+                      {...props}
+                      style={{ ...props.style }}
+                    >
+                      <Popover.Title>
+                        {intl.formatMessage({
+                          id: "dialogs.lightbox.options",
+                        })}
+                      </Popover.Title>
+                      <Popover.Content>{renderOptionsForm()}</Popover.Content>
+                    </div>
+                  )}
+                </Overlay>
+              </div>
+              <InputGroup className={CLASSNAME_OPTIONS_INLINE}>
+                {renderOptionsForm()}
+              </InputGroup>
+            </div>
+            {slideshowEnabled && (
               <Button
-                ref={overlayTarget}
                 variant="link"
-                title={intl.formatMessage({
-                  id: "dialogs.lightbox.options",
-                })}
-                onClick={() => setShowOptions(!showOptions)}
+                onClick={toggleSlideshow}
+                title="Toggle Slideshow"
               >
-                <Icon icon={faCog} />
+                <Icon icon={slideshowInterval !== null ? faPause : faPlay} />
               </Button>
-              <Overlay
-                target={overlayTarget.current}
-                show={showOptions}
-                placement="bottom"
-                container={containerRef}
-                rootClose
-                onHide={() => setShowOptions(false)}
+            )}
+            {zoom !== 1 && (
+              <Button
+                variant="link"
+                onClick={() => {
+                  setResetPosition(!resetPosition);
+                  setZoom(1);
+                }}
+                title="Reset zoom"
               >
-                {({ placement, arrowProps, show: _show, ...props }) => (
-                  <div
-                    className="popover"
-                    {...props}
-                    style={{ ...props.style }}
-                  >
-                    <Popover.Title>
-                      {intl.formatMessage({
-                        id: "dialogs.lightbox.options",
-                      })}
-                    </Popover.Title>
-                    <Popover.Content>{renderOptionsForm()}</Popover.Content>
-                  </div>
-                )}
-              </Overlay>
-            </div>
-            <InputGroup className={CLASSNAME_OPTIONS_INLINE}>
-              {renderOptionsForm()}
-            </InputGroup>
-          </div>
-          {slideshowEnabled && (
+                <Icon icon={faSearchMinus} />
+              </Button>
+            )}
+            {document.fullscreenEnabled && (
+              <Button
+                variant="link"
+                onClick={toggleFullscreen}
+                title="Toggle Fullscreen"
+              >
+                <Icon icon={faExpand} />
+              </Button>
+            )}
             <Button
               variant="link"
-              onClick={toggleSlideshow}
-              title="Toggle Slideshow"
+              onClick={() => close()}
+              title="Close Lightbox"
             >
-              <Icon icon={slideshowInterval !== null ? faPause : faPlay} />
+              <Icon icon={faTimes} />
             </Button>
-          )}
-          {zoom !== 1 && (
+          </div>
+        </div>
+        <div className={CLASSNAME_DISPLAY}>
+          {allowNavigation && (
             <Button
               variant="link"
-              onClick={() => {
-                setResetPosition(!resetPosition);
-                setZoom(1);
-              }}
-              title="Reset zoom"
+              onClick={handleLeft}
+              className={`${CLASSNAME_NAVBUTTON} d-none d-lg-block`}
             >
-              <Icon icon={faSearchMinus} />
+              <Icon icon={faChevronLeft} />
             </Button>
           )}
-          {document.fullscreenEnabled && (
+
+          <div
+            className={cx(CLASSNAME_CAROUSEL, {
+              [CLASSNAME_INSTANT]: instantTransition,
+            })}
+            style={{ left: `${currentIndex * -100}vw` }}
+            ref={carouselRef}
+          >
+            {images.map((image, i) => (
+              <div className={`${CLASSNAME_IMAGE}`} key={image.paths.image}>
+                {i >= currentIndex - 1 && i <= currentIndex + 1 ? (
+                  <LightboxImage
+                    src={image.paths.image ?? ""}
+                    displayMode={displayMode}
+                    scaleUp={lightboxSettings?.scaleUp ?? false}
+                    scrollMode={
+                      lightboxSettings?.scrollMode ??
+                      GQL.ImageLightboxScrollMode.Zoom
+                    }
+                    resetPosition={resetPosition}
+                    zoom={i === currentIndex ? zoom : 1}
+                    scrollAttemptsBeforeChange={scrollAttemptsBeforeChange}
+                    firstScroll={firstScroll}
+                    inScrollGroup={inScrollGroup}
+                    current={i === currentIndex}
+                    alignBottom={movingLeft}
+                    setZoom={updateZoom}
+                    debouncedScrollReset={debouncedScrollReset}
+                    onLeft={handleLeft}
+                    onRight={handleRight}
+                    isVideo={isVideo(image.visual_files?.[0] ?? {})}
+                  />
+                ) : undefined}
+              </div>
+            ))}
+          </div>
+
+          {allowNavigation && (
             <Button
               variant="link"
-              onClick={toggleFullscreen}
-              title="Toggle Fullscreen"
+              onClick={handleRight}
+              className={`${CLASSNAME_NAVBUTTON} d-none d-lg-block`}
             >
-              <Icon icon={faExpand} />
+              <Icon icon={faChevronRight} />
             </Button>
           )}
-          <Button variant="link" onClick={() => close()} title="Close Lightbox">
-            <Icon icon={faTimes} />
-          </Button>
         </div>
-      </div>
-      <div className={CLASSNAME_DISPLAY}>
-        {allowNavigation && (
-          <Button
-            variant="link"
-            onClick={handleLeft}
-            className={`${CLASSNAME_NAVBUTTON} d-none d-lg-block`}
-          >
-            <Icon icon={faChevronLeft} />
-          </Button>
+        {showNavigation && !isFullscreen && images.length > 1 && (
+          <div className={CLASSNAME_NAV} style={navOffset} ref={navRef}>
+            <Button
+              variant="link"
+              onClick={() => setIndex(images.length - 1)}
+              className={CLASSNAME_NAVBUTTON}
+            >
+              <Icon icon={faArrowLeft} className="mr-4" />
+            </Button>
+            {navItems}
+            <Button
+              variant="link"
+              onClick={() => setIndex(0)}
+              className={CLASSNAME_NAVBUTTON}
+            >
+              <Icon icon={faArrowRight} className="ml-4" />
+            </Button>
+          </div>
         )}
-
-        <div
-          className={cx(CLASSNAME_CAROUSEL, {
-            [CLASSNAME_INSTANT]: instantTransition,
-          })}
-          style={{ left: `${currentIndex * -100}vw` }}
-          ref={carouselRef}
-        >
-          {images.map((image, i) => (
-            <div className={`${CLASSNAME_IMAGE}`} key={image.paths.image}>
-              {i >= currentIndex - 1 && i <= currentIndex + 1 ? (
-                <LightboxImage
-                  src={image.paths.image ?? ""}
-                  displayMode={displayMode}
-                  scaleUp={lightboxSettings?.scaleUp ?? false}
-                  scrollMode={
-                    lightboxSettings?.scrollMode ??
-                    GQL.ImageLightboxScrollMode.Zoom
-                  }
-                  resetPosition={resetPosition}
-                  zoom={i === currentIndex ? zoom : 1}
-                  scrollAttemptsBeforeChange={scrollAttemptsBeforeChange}
-                  firstScroll={firstScroll}
-                  inScrollGroup={inScrollGroup}
-                  current={i === currentIndex}
-                  alignBottom={movingLeft}
-                  setZoom={updateZoom}
-                  debouncedScrollReset={debouncedScrollReset}
-                  onLeft={handleLeft}
-                  onRight={handleRight}
-                  isVideo={isVideo(image.visual_files?.[0] ?? {})}
+        <div className={CLASSNAME_FOOTER}>
+          <div className={CLASSNAME_FOOTER_LEFT}>
+            {currentImage?.id !== undefined && (
+              <>
+                <div>
+                  <OCounterButton
+                    onDecrement={onDecrementClick}
+                    onIncrement={onIncrementClick}
+                    onReset={onResetClick}
+                    value={currentImage?.o_counter ?? 0}
+                  />
+                </div>
+                <RatingSystem
+                  value={currentImage?.rating100 ?? undefined}
+                  onSetRating={(v) => {
+                    setRating(v ?? null);
+                  }}
                 />
-              ) : undefined}
-            </div>
-          ))}
+              </>
+            )}
+          </div>
+          <div>
+            {currentImage?.title && (
+              <Link to={`/images/${currentImage.id}`} onClick={() => close()}>
+                {currentImage.title ?? ""}
+              </Link>
+            )}
+          </div>
+          <div></div>
         </div>
+      </>
+    );
+  }
 
-        {allowNavigation && (
-          <Button
-            variant="link"
-            onClick={handleRight}
-            className={`${CLASSNAME_NAVBUTTON} d-none d-lg-block`}
-          >
-            <Icon icon={faChevronRight} />
-          </Button>
-        )}
-      </div>
-      {showNavigation && !isFullscreen && images.length > 1 && (
-        <div className={CLASSNAME_NAV} style={navOffset} ref={navRef}>
-          <Button
-            variant="link"
-            onClick={() => setIndex(images.length - 1)}
-            className={CLASSNAME_NAVBUTTON}
-          >
-            <Icon icon={faArrowLeft} className="mr-4" />
-          </Button>
-          {navItems}
-          <Button
-            variant="link"
-            onClick={() => setIndex(0)}
-            className={CLASSNAME_NAVBUTTON}
-          >
-            <Icon icon={faArrowRight} className="ml-4" />
-          </Button>
-        </div>
-      )}
-      <div className={CLASSNAME_FOOTER}>
-        <div className={CLASSNAME_FOOTER_LEFT}>
-          {currentImage?.id !== undefined && (
-            <>
-              <div>
-                <OCounterButton
-                  onDecrement={onDecrementClick}
-                  onIncrement={onIncrementClick}
-                  onReset={onResetClick}
-                  value={currentImage?.o_counter ?? 0}
-                />
-              </div>
-              <RatingSystem
-                value={currentImage?.rating100 ?? undefined}
-                onSetRating={(v) => {
-                  setRating(v ?? null);
-                }}
-              />
-            </>
-          )}
-        </div>
-        <div>
-          {currentImage?.title && (
-            <Link to={`/images/${currentImage.id}`} onClick={() => close()}>
-              {currentImage.title ?? ""}
-            </Link>
-          )}
-        </div>
-        <div></div>
-      </div>
+  if (!isVisible) {
+    return <></>;
+  }
+
+  return (
+    <div
+      className={CLASSNAME}
+      role="presentation"
+      ref={containerRef}
+      onClick={handleClose}
+    >
+      {renderBody()}
     </div>
   );
 };
diff --git a/ui/v2.5/src/hooks/Lightbox/context.tsx b/ui/v2.5/src/hooks/Lightbox/context.tsx
index b44a1127d83..8bae11cffe1 100644
--- a/ui/v2.5/src/hooks/Lightbox/context.tsx
+++ b/ui/v2.5/src/hooks/Lightbox/context.tsx
@@ -19,12 +19,21 @@ export interface IState {
   onClose?: () => void;
 }
 interface IContext {
+  lightboxState: IState;
   setLightboxState: (state: Partial<IState>) => void;
 }
 
-export const LightboxContext = React.createContext<IContext>({
-  setLightboxState: () => {},
-});
+export const LightboxContext = React.createContext<IContext | null>(null);
+
+export function useLightboxContext() {
+  const context = React.useContext(LightboxContext);
+  if (!context) {
+    throw new Error(
+      "useLightboxContext must be used within a LightboxProvider"
+    );
+  }
+  return context;
+}
 
 export const LightboxProvider: React.FC = ({ children }) => {
   const [lightboxState, setLightboxState] = useState<IState>({
@@ -53,7 +62,9 @@ export const LightboxProvider: React.FC = ({ children }) => {
   };
 
   return (
-    <LightboxContext.Provider value={{ setLightboxState: setPartialState }}>
+    <LightboxContext.Provider
+      value={{ lightboxState, setLightboxState: setPartialState }}
+    >
       {children}
       <Suspense fallback={<></>}>
         {lightboxState.isVisible && (
diff --git a/ui/v2.5/src/hooks/Lightbox/hooks.ts b/ui/v2.5/src/hooks/Lightbox/hooks.ts
index 8ec511f52e2..a54de4c3095 100644
--- a/ui/v2.5/src/hooks/Lightbox/hooks.ts
+++ b/ui/v2.5/src/hooks/Lightbox/hooks.ts
@@ -1,13 +1,13 @@
-import { useCallback, useContext, useEffect, useMemo, useState } from "react";
+import { useCallback, useEffect, useMemo, useState } from "react";
 import * as GQL from "src/core/generated-graphql";
-import { LightboxContext, IState } from "./context";
+import { IState, useLightboxContext } from "./context";
 import { IChapter } from "./types";
 
 export const useLightbox = (
   state: Partial<Omit<IState, "isVisible">>,
   chapters: IChapter[] = []
 ) => {
-  const { setLightboxState } = useContext(LightboxContext);
+  const { setLightboxState } = useLightboxContext();
 
   useEffect(() => {
     setLightboxState({
@@ -50,7 +50,7 @@ export const useLightbox = (
 };
 
 export const useGalleryLightbox = (id: string, chapters: IChapter[] = []) => {
-  const { setLightboxState } = useContext(LightboxContext);
+  const { setLightboxState } = useLightboxContext();
 
   const pageSize = 40;
   const [page, setPage] = useState(1);