experiment(ui): show loader until studio init actions are complete

invokeai/frontend/web/src/app/components/App.tsx

@@ -1,13 +1,15 @@
 import { Box, useGlobalModifiersInit } from '@invoke-ai/ui-library';
+import { useStore } from '@nanostores/react';
 import { GlobalImageHotkeys } from 'app/components/GlobalImageHotkeys';
 import type { StudioInitAction } from 'app/hooks/useStudioInitAction';
-import { useStudioInitAction } from 'app/hooks/useStudioInitAction';
+import { $didStudioInit, useStudioInitAction } from 'app/hooks/useStudioInitAction';
 import { useSyncQueueStatus } from 'app/hooks/useSyncQueueStatus';
 import { useLogger } from 'app/logging/useLogger';
 import { useSyncLoggingConfig } from 'app/logging/useSyncLoggingConfig';
 import { appStarted } from 'app/store/middleware/listenerMiddleware/listeners/appStarted';
 import { useAppDispatch, useAppSelector } from 'app/store/storeHooks';
 import type { PartialAppConfig } from 'app/types/invokeai';
+import Loading from 'common/components/Loading/Loading';
 import { useFocusRegionWatcher } from 'common/hooks/focus';
 import { useClearStorage } from 'common/hooks/useClearStorage';
 import { useGlobalHotkeys } from 'common/hooks/useGlobalHotkeys';
@@ -55,6 +57,7 @@ interface Props {
 }
 
 const App = ({ config = DEFAULT_CONFIG, studioInitAction }: Props) => {
+  const didStudioInit = useStore($didStudioInit);
   const clearStorage = useClearStorage();
 
   const handleReset = useCallback(() => {
@@ -67,6 +70,7 @@ const App = ({ config = DEFAULT_CONFIG, studioInitAction }: Props) => {
     <ErrorBoundary onReset={handleReset} FallbackComponent={AppErrorBoundaryFallback}>
       <Box id="invoke-app-wrapper" w="100dvw" h="100dvh" position="relative" overflow="hidden">
         <AppContent />
+        {!didStudioInit && <Loading />}
       </Box>
       <HookIsolator config={config} studioInitAction={studioInitAction} />
       <DeleteImageModal />

invokeai/frontend/web/src/app/components/InvokeAIUI.tsx

@@ -1,7 +1,7 @@
 import 'i18n';
 
 import type { Middleware } from '@reduxjs/toolkit';
-import type { StudioInitAction } from 'app/hooks/useStudioInitAction';
+import { $didStudioInit, StudioInitAction } from 'app/hooks/useStudioInitAction';
 import type { LoggingOverrides } from 'app/logging/logger';
 import { $loggingOverrides, configureLogging } from 'app/logging/logger';
 import { $authToken } from 'app/store/nanostores/authToken';
@@ -87,6 +87,12 @@ const InvokeAIUI = ({
     );
   }, [loggingOverrides]);
 
+  useLayoutEffect(() => {
+    if (studioInitAction) {
+      $didStudioInit.set(false);
+    }
+  }, []);
+
   useEffect(() => {
     // configure API client token
     if (token) {

invokeai/frontend/web/src/app/hooks/useStudioInitAction.ts

@@ -16,7 +16,8 @@ import { $isStylePresetsMenuOpen, activeStylePresetIdChanged } from 'features/st
 import { toast } from 'features/toast/toast';
 import { activeTabCanvasRightPanelChanged, setActiveTab } from 'features/ui/store/uiSlice';
 import { useGetAndLoadLibraryWorkflow } from 'features/workflowLibrary/hooks/useGetAndLoadLibraryWorkflow';
-import { useCallback, useEffect, useRef } from 'react';
+import { atom } from 'nanostores';
+import { useCallback, useEffect } from 'react';
 import { useTranslation } from 'react-i18next';
 import { getImageDTO, getImageMetadata } from 'services/api/endpoints/images';
 import { getStylePreset } from 'services/api/endpoints/stylePresets';
@@ -32,6 +33,9 @@ type StudioDestinationAction = _StudioInitAction<
   { destination: 'generation' | 'canvas' | 'workflows' | 'upscaling' | 'viewAllWorkflows' | 'viewAllStylePresets' }
 >;
 
+// Use global state to show loader until we are ready to render the studio.
+export const $didStudioInit = atom(false);
+
 export type StudioInitAction =
   | LoadWorkflowAction
   | SelectStylePresetAction
@@ -51,8 +55,6 @@ export type StudioInitAction =
 export const useStudioInitAction = (action?: StudioInitAction) => {
   useAssertSingleton('useStudioInitAction');
   const { t } = useTranslation();
-  // Use a ref to ensure that we only perform the action once
-  const didInit = useRef(false);
   const didParseOpenAPISchema = useStore($hasTemplates);
   const store = useAppStore();
   const { getAndLoadWorkflow } = useGetAndLoadLibraryWorkflow();
@@ -102,16 +104,16 @@ export const useStudioInitAction = (action?: StudioInitAction) => {
       }
       const metadata = getImageMetadataResult.value;
       // This shows a toast
-      parseAndRecallAllMetadata(metadata, true);
+      await parseAndRecallAllMetadata(metadata, true);
       store.dispatch(setActiveTab('canvas'));
     },
     [store, t]
   );
 
   const handleLoadWorkflow = useCallback(
-    (workflowId: string) => {
+    async (workflowId: string) => {
       // This shows a toast
-      getAndLoadWorkflow(workflowId);
+      await getAndLoadWorkflow(workflowId);
       store.dispatch(setActiveTab('workflows'));
     },
     [getAndLoadWorkflow, store]
@@ -176,36 +178,48 @@ export const useStudioInitAction = (action?: StudioInitAction) => {
     [store]
   );
 
+  const handleStudioInitAction = useCallback(
+    async (action: StudioInitAction) => {
+      // This cannot be in the useEffect below because we need to await some of the actions before setting didStudioInit.
+      switch (action.type) {
+        case 'loadWorkflow':
+          await handleLoadWorkflow(action.data.workflowId);
+          break;
+        case 'selectStylePreset':
+          await handleSelectStylePreset(action.data.stylePresetId);
+          break;
+
+        case 'sendToCanvas':
+          await handleSendToCanvas(action.data.imageName);
+          break;
+
+        case 'useAllParameters':
+          await handleUseAllMetadata(action.data.imageName);
+          break;
+
+        case 'goToDestination':
+          handleGoToDestination(action.data.destination);
+          break;
+
+        default:
+          break;
+      }
+      $didStudioInit.set(true);
+    },
+    [handleGoToDestination, handleLoadWorkflow, handleSelectStylePreset, handleSendToCanvas, handleUseAllMetadata]
+  );
+
   useEffect(() => {
-    if (didInit.current || !action || !didParseOpenAPISchema) {
+    if ($didStudioInit.get() || !didParseOpenAPISchema) {
       return;
     }
 
-    didInit.current = true;
-
-    switch (action.type) {
-      case 'loadWorkflow':
-        handleLoadWorkflow(action.data.workflowId);
-        break;
-      case 'selectStylePreset':
-        handleSelectStylePreset(action.data.stylePresetId);
-        break;
-
-      case 'sendToCanvas':
-        handleSendToCanvas(action.data.imageName);
-        break;
-
-      case 'useAllParameters':
-        handleUseAllMetadata(action.data.imageName);
-        break;
-
-      case 'goToDestination':
-        handleGoToDestination(action.data.destination);
-        break;
-
-      default:
-        break;
+    if (!action) {
+      $didStudioInit.set(true);
+      return;
     }
+
+    handleStudioInitAction(action);
   }, [
     handleSendToCanvas,
     handleUseAllMetadata,
@@ -214,5 +228,6 @@ export const useStudioInitAction = (action?: StudioInitAction) => {
     handleGoToDestination,
     handleLoadWorkflow,
     didParseOpenAPISchema,
+    handleStudioInitAction,
   ]);
 };

invokeai/frontend/web/src/common/components/Loading/Loading.tsx

@@ -6,7 +6,18 @@ import { memo } from 'react';
 
 const Loading = () => {
   return (
-    <Flex position="relative" width="100dvw" height="100dvh" alignItems="center" justifyContent="center" bg="#151519">
+    <Flex
+      position="absolute"
+      width="100dvw"
+      height="100dvh"
+      alignItems="center"
+      justifyContent="center"
+      bg="#151519"
+      top={0}
+      right={0}
+      bottom={0}
+      left={0}
+    >
       <Image src={InvokeLogoWhite} w="8rem" h="8rem" />
       <Spinner
         label="Loading"