@gen3/workspaces 0.12.50 → 0.12.52

package/dist/index/esm/index.js

@@ -3,10 +3,10 @@ import React, { useCallback, useMemo, useState, useRef, useEffect, createContext
 import { mergeDefaultTailwindClassnames, ACTIVITY_CHANNEL, convertSecondsToMilliseconds, InfoRolloverButton, OverflowTooltippedLabel, PanelErrorBoundary, ProtectedContent, FixedNavPageLayout, ContentSource, getNavPageLayoutPropsFromConfig } from '@gen3/frontend';
 import { Card, Stack, Badge, Text, List, Group, Tooltip, Button, LoadingOverlay, Alert, Loader, Divider, Select, ActionIcon, TextInput, Textarea, Table, Scroller, Tabs, Center } from '@mantine/core';
 import { Icon } from '@iconify-icon/react';
+import { useInterval, useElementSize, useDisclosure, useResizeObserver } from '@mantine/hooks';
 import { GEN3_API, GEN3_WORKSPACE_API, gen3Api, useCoreSelector, selectJEGActiveWorkspaceStatus, useCoreDispatch, setJEGActiveWorkspaceStatus, WorkspaceStatus, setJEGRequestedWorkspaceStatus, RequestedWorkspaceStatus, setJEGActiveWorkspaceId, isFetchBaseQueryError, selectJEGRequestedWorkspaceStatus, selectJEGRequestedWorkspaceStatusTimestamp, isTimeGreaterThan, formatUptimeInMinutes, selectJEGKernelIds, removeManyJEGActiveKernels, upsertManyJEGActiveKernels, normalizeRtkError, selectAllJEGKernels, addJEGActiveKernel, selectWorkspaceTier, setWorkspaceTier, selectWorkspaceFullscreen, setWorkspaceFullscreen, useGetDictionaryFromUrlQuery, useUserAuth, GEN3_COMMONS_NAME } from '@gen3/core';
 import { useDeepCompareEffect } from 'use-deep-compare';
 import { notifications } from '@mantine/notifications';
-import { useElementSize, useDisclosure, useResizeObserver } from '@mantine/hooks';
 import { IoSettingsSharp } from 'react-icons/io5';
 import { BsFillInfoCircleFill } from 'react-icons/bs';
 import { MdKeyboardArrowDown, MdKeyboardArrowRight } from 'react-icons/md';
@@ -337,22 +337,34 @@ const HatcheryWithTags = gen3Api.enhanceEndpoints({
         'Hatchery'
     ]
 });
-const StatusStringToHatcheryServiceStatus = {
-    running: [
+/*
+ *  Hatchery states:
+ *
+ * `Terminating` - The workspace is shutting down
+ * `Launching` - The workspace is starting up
+ * `Stopped` - The workspace is in a failed state and must be terminated
+ * `Running` - The workspace is running and ready to be used
+ * `Not Found` - The workspace could not be found
+ */ const StatusStringToHatcheryServiceStatus = {
+    launching: [
         'launching',
         'pending',
-        'starting',
+        'starting'
+    ],
+    running: [
         'running',
         'ready'
     ],
     stopped: [
-        'not-running',
-        'stopped',
-        'terminated'
+        'stopped'
     ],
-    terminated: [
+    terminating: [
         'terminating',
         'stopping'
+    ],
+    unknown: [
+        'not found',
+        'unknown'
     ]
 };
 const hatcheryApi = HatcheryWithTags.injectEndpoints({
@@ -395,17 +407,22 @@ const hatcheryApi = HatcheryWithTags.injectEndpoints({
                 transformResponse: (response)=>{
                     const results = (response.status || 'unknown').toLowerCase();
                     let hatcheryStatus = HatcheryServiceState.unknown;
-                    if (results === 'not found' || results === 'unknown') hatcheryStatus = HatcheryServiceState.unknown;
+                    if (StatusStringToHatcheryServiceStatus.unknown.includes(results)) {
+                        hatcheryStatus = HatcheryServiceState.unknown;
+                    }
+                    if (StatusStringToHatcheryServiceStatus.launching.includes(results)) {
+                        hatcheryStatus = HatcheryServiceState.launching;
+                    }
                     if (StatusStringToHatcheryServiceStatus.running.includes(results)) {
                         hatcheryStatus = HatcheryServiceState.running;
                     }
                     if (StatusStringToHatcheryServiceStatus.stopped.includes(results)) {
                         hatcheryStatus = HatcheryServiceState.stopped;
                     }
-                    if (StatusStringToHatcheryServiceStatus.terminated.includes(results)) {
+                    if (StatusStringToHatcheryServiceStatus.terminating.includes(results)) {
                         hatcheryStatus = HatcheryServiceState.terminating;
                     }
-                    // return other status
+                    // return other stats from the hatchery response
                     return {
                         status: hatcheryStatus,
                         idleTimeLimit: response.idleTimeLimit,
@@ -557,7 +574,7 @@ const { useDoesHatcheryOptionExistsQuery, useHatcheryOptionsQuery, useLazyHatche
     const workspaceContainerStatus = useCoreSelector(selectJEGActiveWorkspaceStatus);
     const [containerHash, setContainerHash] = useState(null);
     const coreDispatch = useCoreDispatch();
-    // get the options for the workspace could move to parent since
+    // get the options for the workspace could move to parent
     const { data: optionData, error: optionsError } = useDoesHatcheryOptionExistsQuery(tag, {
         skip: containerHash !== null
     });
@@ -595,7 +612,8 @@ const { useDoesHatcheryOptionExistsQuery, useHatcheryOptionsQuery, useLazyHatche
                 // launch error, will show error message and then reset
                 coreDispatch(setJEGActiveWorkspaceStatus(WorkspaceStatus.LaunchError));
             } else {
-                coreDispatch(setJEGActiveWorkspaceStatus(WorkspaceStatus.Running));
+                // Keep status as Launching — the monitor will promote to Running
+                // once the pod actually reports running status
                 coreDispatch(setJEGActiveWorkspaceId({
                     id: containerHash ?? 'default'
                 }));
@@ -614,18 +632,11 @@ const { useDoesHatcheryOptionExistsQuery, useHatcheryOptionsQuery, useLazyHatche
     ]);
     const terminate = useCallback(async ()=>{
         if (!enabled || workspaceContainerStatus === WorkspaceStatus.Terminating) return; // skip if already terminating
-        // coreDispatch(setJEGActiveWorkspaceStatus(WorkspaceStatus.Running));
         const containerId = containerHash ? encodeURIComponent(containerHash) : '';
-        try {
-            //
-            // const status = await terminateWorkspace(containerId).unwrap();
-            terminateWorkspace(containerId);
-            coreDispatch(setJEGRequestedWorkspaceStatus(RequestedWorkspaceStatus.Terminate));
-            coreDispatch(setJEGActiveWorkspaceStatus(WorkspaceStatus.Terminating));
-        } catch (_error) {
-            coreDispatch(setJEGRequestedWorkspaceStatus(RequestedWorkspaceStatus.Terminate));
-            coreDispatch(setJEGActiveWorkspaceStatus(WorkspaceStatus.Terminating));
-        }
+        // Fire-and-forget: errors are handled by the useDeepCompareEffect watching isTerminateError
+        terminateWorkspace(containerId);
+        coreDispatch(setJEGRequestedWorkspaceStatus(RequestedWorkspaceStatus.Terminate));
+        coreDispatch(setJEGActiveWorkspaceStatus(WorkspaceStatus.Terminating));
     }, [
         enabled,
         workspaceContainerStatus,
@@ -682,10 +693,10 @@ const notifyUser = (title, message, status = 0)=>{
 // TODO: convert to seconds/minutes for readability
 const WorkspacePollingInterval = {
     [WorkspaceStatus.NotFound]: 0,
-    [WorkspaceStatus.Launching]: convertSecondsToMilliseconds(1),
-    [WorkspaceStatus.Terminating]: convertSecondsToMilliseconds(1),
-    [WorkspaceStatus.Running]: convertSecondsToMilliseconds(300),
-    [WorkspaceStatus.Stopped]: convertSecondsToMilliseconds(5),
+    [WorkspaceStatus.Launching]: convertSecondsToMilliseconds(5),
+    [WorkspaceStatus.Terminating]: convertSecondsToMilliseconds(5),
+    [WorkspaceStatus.Running]: convertSecondsToMilliseconds(60),
+    [WorkspaceStatus.Stopped]: convertSecondsToMilliseconds(60),
     [WorkspaceStatus.Errored]: convertSecondsToMilliseconds(10),
     [WorkspaceStatus.LaunchError]: convertSecondsToMilliseconds(10),
     [WorkspaceStatus.TerminateError]: convertSecondsToMilliseconds(10),
@@ -696,7 +707,8 @@ const workspaceShutdownAlertLimit = 30000; // 5 minutes: 5 * 60 * 1000 TODO Figu
  *  Monitors resource usage.
  *  Handles state changes and polls for workspace status using the JEG APIs
  */ const useJEGWorkspaceResourceMonitor = (workspaceId = null, monitorWorkspace)=>{
-    const [pollingInterval, setPollingInterval] = useState(0);
+    // start with default polling interval of 1 second
+    const [pollingInterval, setPollingInterval] = useState(convertSecondsToMilliseconds(1));
     const [error, setError] = useState(null);
     const { data: workspaceStatusData, isError: isWorkspaceStatusError, error: workspaceStatusError } = useHatcheryStatusQuery(workspaceId, {
         pollingInterval: pollingInterval,
@@ -742,17 +754,37 @@ const workspaceShutdownAlertLimit = 30000; // 5 minutes: 5 * 60 * 1000 TODO Figu
         error
     ]);
     useDeepCompareEffect(()=>{
+        // No status data means we are not polling
         if (!workspaceStatusData) return;
-        // LaunchError is set client-side by the launch() call and cleared by the
+        // LaunchError is set client-side by the launch() call from useMicroContainerRedux and cleared by the
         // auto-reset timer in the panel.  Polling data must not override it or the
-        // timer will be cancelled before it fires.
+        // timer will be canceled before it fires.
         if (activeStatus === WorkspaceStatus.LaunchError) return;
         const workspaceQueryStatus = hatcheryStateToWorkspaceStatus(workspaceStatusData?.status);
+        // handle cases of unknown, running, terminating, or launching
+        if (workspaceStatusData.status === HatcheryServiceState.unknown) {
+            // check for unknown state
+            // NotFound means pod is not running
+            // either starting up
+            // or finally terminated.
+            if (requestedStatus === RequestedWorkspaceStatus.Launch) {
+                // if the workspace becomes idle too long after a Launch request, switch to
+                // Unset and NotFound.
+                console.warn("requested status is Launch, but workspace pod isn't running yet.");
+                return;
+            }
+            // both requested status and workspace pod status are the same, so stop all polling
+            setPollingInterval(WorkspacePollingInterval[WorkspaceStatus.NotFound]);
+            dispatch(setJEGActiveWorkspaceStatus(WorkspaceStatus.NotFound));
+            if (requestedStatus === RequestedWorkspaceStatus.Terminate) {
+                // Cleanup termination after terminated
+                dispatch(setJEGRequestedWorkspaceStatus(RequestedWorkspaceStatus.Unset));
+            }
+            return;
+        }
         // Check if the workspace is running.
         // If so: need to check workspace idle if set
-        // and ensure the pay model is queried
         if (workspaceStatusData.status === HatcheryServiceState.running) {
-            //  const { idleTimeLimit, lastActivityTime } = workspaceStatusData;
             // in some state other than idle
             if (!idleTimeLimit || idleTimeLimit <= 0) {
                 // Workspace is running, but no idle limit set.
@@ -762,6 +794,7 @@ const workspaceShutdownAlertLimit = 30000; // 5 minutes: 5 * 60 * 1000 TODO Figu
                 setPollingInterval(WorkspacePollingInterval[WorkspaceStatus.Running]);
                 return;
             }
+            // handle if idle time is defined
             if (idleTimeLimit && idleTimeLimit > 0 && lastActivityTime && lastActivityTime > 0) {
                 const remainingWorkspaceKernelLife = idleTimeLimit - (Date.now() - lastActivityTime);
                 if (remainingWorkspaceKernelLife <= 0) {
@@ -769,7 +802,7 @@ const workspaceShutdownAlertLimit = 30000; // 5 minutes: 5 * 60 * 1000 TODO Figu
                     // so terminate
                     (async ()=>{
                         try {
-                            if (workspaceId) await terminateWorkspace(workspaceId).unwrap();
+                            if (workspaceId) await terminateWorkspace(encodeURIComponent(workspaceId)).unwrap();
                         } catch (error) {
                             const errorMessage = error.message || 'Unknown error occurred';
                             console.error('Workspace termination failed: ', errorMessage);
@@ -786,44 +819,48 @@ const workspaceShutdownAlertLimit = 30000; // 5 minutes: 5 * 60 * 1000 TODO Figu
                     setError('Workspace has been idle for too long. Will shutdown soon');
                 }
             }
-            if (requestedStatus === RequestedWorkspaceStatus.Launch) {
-                // if we have a launch error then requested status has not been met
-                if (workspaceQueryStatus === WorkspaceStatus.LaunchError) {
-                    dispatch(setJEGRequestedWorkspaceStatus(RequestedWorkspaceStatus.Unset));
-                    dispatch(setJEGActiveWorkspaceStatus(WorkspaceStatus.NotFound));
-                    return;
+        }
+        // Stopped means the pod is in a failed state — auto-terminate it
+        if (workspaceStatusData.status === HatcheryServiceState.stopped) {
+            (async ()=>{
+                try {
+                    if (workspaceId) await terminateWorkspace(encodeURIComponent(workspaceId)).unwrap();
+                } catch (error) {
+                    const errorMessage = error.message || 'Unknown error occurred';
+                    console.error('Workspace termination of stopped pod failed: ', errorMessage);
+                    notifyUser('Workspace Error', `Failed to terminate stopped workspace: ${errorMessage}`, 2);
                 }
-                // if the workspace is running then requested status has been met
+            })();
+            dispatch(setJEGRequestedWorkspaceStatus(RequestedWorkspaceStatus.Terminate));
+            dispatch(setJEGActiveWorkspaceStatus(WorkspaceStatus.Terminating));
+            setPollingInterval(WorkspacePollingInterval[WorkspaceStatus.Terminating]);
+            notifyUser('Workspace Stopped', 'Workspace entered a failed state and is being terminated', 2);
+            return;
+        }
+        if (requestedStatus === RequestedWorkspaceStatus.Launch) {
+            // if we have a launch error then requested status has not been met
+            if (workspaceQueryStatus === WorkspaceStatus.LaunchError) {
                 dispatch(setJEGRequestedWorkspaceStatus(RequestedWorkspaceStatus.Unset));
+                dispatch(setJEGActiveWorkspaceStatus(WorkspaceStatus.LaunchError));
+                return;
             }
-            if (requestedStatus === RequestedWorkspaceStatus.Terminate) {
+            if (workspaceQueryStatus === WorkspaceStatus.NotFound) {
+                return; // pod not yet created, keep waiting
+            }
+            if (workspaceQueryStatus === WorkspaceStatus.Running) {
+                // workspace is running — requested status has been met
+                dispatch(setJEGRequestedWorkspaceStatus(RequestedWorkspaceStatus.Unset));
+                dispatch(setJEGActiveWorkspaceStatus(WorkspaceStatus.Running));
                 return;
             }
+            // still launching — update active status but keep requestedStatus as Launch
             dispatch(setJEGActiveWorkspaceStatus(workspaceQueryStatus));
-            setPollingInterval(WorkspacePollingInterval[workspaceQueryStatus]);
             return;
         }
-        if (workspaceStatusData.status === HatcheryServiceState.unknown) {
-            // NotFound means pod is not running
-            // either starting up
-            // or finally terminated.
-            if (requestedStatus === RequestedWorkspaceStatus.Launch) {
-                // if the workspace becomes idle too long after a Launch request, switch to
-                // Unset and NotFound.
-                console.warn("requested status is Launch, but workspace pod isn't running yet.");
-                return;
-            } else {
-                // both requested status and workspace pod status are the same, so stop all polling
-                setPollingInterval(WorkspacePollingInterval[WorkspaceStatus.NotFound]);
-                dispatch(setJEGActiveWorkspaceStatus(WorkspaceStatus.NotFound));
-                if (requestedStatus === RequestedWorkspaceStatus.Terminate) {
-                    // Cleanup termination after terminated
-                    dispatch(setJEGRequestedWorkspaceStatus(RequestedWorkspaceStatus.Unset));
-                }
-            }
+        if (requestedStatus === RequestedWorkspaceStatus.Terminate) {
             return;
         }
-        // if here, update active workspace status and polling interval
+        // if here, update active workspace status and polling for other states
         dispatch(setJEGActiveWorkspaceStatus(workspaceQueryStatus));
         setPollingInterval(WorkspacePollingInterval[workspaceQueryStatus]);
     }, [
@@ -833,8 +870,9 @@ const workspaceShutdownAlertLimit = 30000; // 5 minutes: 5 * 60 * 1000 TODO Figu
         activeStatus
     ]);
     useEffect(()=>{
+        // time out if exceeding maximum start timee
         if (requestedStatus === RequestedWorkspaceStatus.Launch && isTimeGreaterThan(requestedStatusTimestamp, MAXIMUM_START_TIME_IN_MINUTES)) {
-            if (workspaceId) terminateWorkspace(workspaceId);
+            if (workspaceId) terminateWorkspace(encodeURIComponent(workspaceId));
             dispatch(setJEGRequestedWorkspaceStatus(RequestedWorkspaceStatus.Terminate));
             setError('Workspace failed to start. Shutting down');
         }
@@ -898,21 +936,22 @@ const MicroContainerReduxPanel = ({ compact = false })=>{
         coreDispatch
     ]);
     /* ── Elapsed timer for launching state ── */ const [elapsedSec, setElapsedSec] = useState(0);
+    const interval = useInterval(()=>{
+        const elapsed = Math.floor((Date.now() - requestedStatusTimestamp) / 1000);
+        setElapsedSec(elapsed);
+    }, 1000);
     useEffect(()=>{
-        if (status !== WorkspaceStatus.Launching) {
+        if (status === WorkspaceStatus.Launching) {
+            interval.start();
+        } else {
             setElapsedSec(0);
-            return;
+            interval.stop();
         }
-        const interval = Math.floor((Date.now() - requestedStatusTimestamp) / 1000);
-        const t = setInterval(()=>{
-            setElapsedSec(interval);
-        }, 1000);
-        return ()=>clearInterval(t);
+        return interval.stop;
     }, [
-        requestedStatusTimestamp,
-        status
+        status,
+        interval
     ]);
-    console.log('MicroContainerReduxPanel: status', status);
     /* ── Auto-reset after 15 s in launch-error state ── */ useEffect(()=>{
         if (status !== WorkspaceStatus.LaunchError) return;
         const t = setTimeout(()=>resetStatus(), 6_000);
@@ -965,9 +1004,6 @@ const MicroContainerReduxPanel = ({ compact = false })=>{
         });
     }
     /* ── launching ── */ if (status === WorkspaceStatus.Launching) {
-        const mins = Math.floor(elapsedSec / 60);
-        const secs = elapsedSec % 60;
-        const elapsed = mins > 0 ? `${mins}m ${secs}s` : `${secs}s`;
         return /*#__PURE__*/ jsxs("div", {
             role: "status",
             className: PanelStyle$2,
@@ -990,7 +1026,9 @@ const MicroContainerReduxPanel = ({ compact = false })=>{
                             className: "mt-1 text-sm text-base-darker",
                             children: [
                                 "Elapsed: ",
-                                elapsed
+                                elapsedSec,
+                                " ",
+                                elapsedSec === 1 ? 'second' : 'seconds'
                             ]
                         }),
                         /*#__PURE__*/ jsx("p", {
@@ -1507,6 +1545,8 @@ const jegGatewayApi = GatewayWithTags.injectEndpoints({
     overrideExisting: true
 });
 const { useActiveKernelsQuery, useLaunchKernelMutation, useTerminateKernelMutation, useJegGatewayStatusQuery, useReapKernelsMutation } = jegGatewayApi;
+// select active kernels
+jegGatewayApi.endpoints.activeKernels.select();
 
 const ActiveKernelInfoPanel = ({ kernelId, kernelName, executionState, uptimeMinutes, onOpenNotebook, forceTerminate = false, rowSpec, connections = 0 })=>{
     const [terminateKernel, { isLoading: isTerminatingLoading, isError: isTerminatingError, error: terminatingError }] = useTerminateKernelMutation();
@@ -1651,6 +1691,8 @@ const PanelStyle$1 = 'min-w-0 rounded-sm border-2 border-base-lighter bg-base-ma
 const ActiveKernelsPanel = ()=>{
     const { data: kernels, isLoading, isError, error } = useActiveKernelsQuery(undefined, {
         pollingInterval: 10000,
+        refetchOnMountOrArgChange: 1800,
+        refetchOnFocus: true,
         selectFromResult: ({ data, isLoading, isError, error })=>({
                 data,
                 isLoading,
@@ -1949,7 +1991,11 @@ function useGatewayConnectionStatus() {
         setGatewayMessage(message ?? null);
     }, []);
     // get the status of the gateway
-    const { data: gatewayStatusData, isFetching: isGatewayFetching, isError } = useJegGatewayStatusQuery();
+    const { data: gatewayStatusData, isFetching: isGatewayFetching, isError } = useJegGatewayStatusQuery(undefined, {
+        pollingInterval: 10000,
+        refetchOnMountOrArgChange: 1800,
+        refetchOnFocus: true
+    });
     const gatewayServiceStatus = useMemo(()=>{
         if (isGatewayFetching) return 'fetching';
         if (!isError) return 'service_unavailable';
@@ -2194,7 +2240,7 @@ function HorizontalAccordion({ label, expanded, setExpanded, children, expandedW
     });
     const mergedClassNames = mergeDefaultTailwindClassnames(STYLING_DEFAULTS, classNames);
     return /*#__PURE__*/ jsx("div", {
-        className: `overflow-hidden shrink-0 ${mergedClassNames.root}`,
+        className: `${mergedClassNames.root}`,
         style: {
             width: expanded ? expandedWidth : collapsedWidth,
             transition: `width ${TRANSITION_MS}ms ease`
@@ -2229,7 +2275,7 @@ function HorizontalAccordion({ label, expanded, setExpanded, children, expandedW
                     ]
                 }),
                 /*#__PURE__*/ jsx("div", {
-                    className: "overflow-hidden h-full shrink-0 px-2",
+                    className: "overflow-hidden px-2",
                     style: {
                         opacity: expanded ? 1 : 0,
                         pointerEvents: expanded ? 'auto' : 'none',
@@ -2257,9 +2303,8 @@ const SettingsPanel = ({ showKernels, expanded, setExpanded, width = 380 })=>{
         setExpanded: setExpanded,
         rightSide: true,
         expandedWidth: width,
-        children: /*#__PURE__*/ jsxs(Stack, {
-            gap: "sm",
-            className: PanelStyle,
+        children: /*#__PURE__*/ jsxs("div", {
+            className: `${PanelStyle} overflow-y-scroll`,
             children: [
                 showKernels && /*#__PURE__*/ jsx(KernelLifecyclePanel, {}),
                 /*#__PURE__*/ jsx(UpgradeActionsPanel, {