diff --git a/client/src/components/entities/entities.types.ts b/client/src/components/entities/entities.types.ts index 23f4c121f4..528017b550 100644 --- a/client/src/components/entities/entities.types.ts +++ b/client/src/components/entities/entities.types.ts @@ -1,4 +1,5 @@ export type EntityTypes = | "code-repository" | "data-connector" + | "job-launcher" | "session-launcher"; diff --git a/client/src/components/offcanvas/OffcanvasHeaderWithType.tsx b/client/src/components/offcanvas/OffcanvasHeaderWithType.tsx index 0454511b50..3248f46312 100644 --- a/client/src/components/offcanvas/OffcanvasHeaderWithType.tsx +++ b/client/src/components/offcanvas/OffcanvasHeaderWithType.tsx @@ -2,6 +2,7 @@ import cx from "classnames"; import { Database, FileCode, + Gear, PlayCircle, QuestionCircle, } from "react-bootstrap-icons"; @@ -29,6 +30,8 @@ export default function OffcanvasHeaderWithType({ ) : entityType === "session-launcher" ? ( + ) : entityType === "job-launcher" ? ( + ) : entityType === "code-repository" ? ( ) : ( @@ -39,11 +42,13 @@ export default function OffcanvasHeaderWithType({ ? _entityName : entityType === "data-connector" ? "Data connector" - : entityType === "session-launcher" - ? "Session launcher" - : entityType === "code-repository" - ? "Code repository" - : "Unknown"; + : entityType === "job-launcher" + ? "Job launcher" + : entityType === "session-launcher" + ? "Session launcher" + : entityType === "code-repository" + ? "Code repository" + : "Unknown"; return (
diff --git a/client/src/features/ProjectPageV2/utils/useProjectPermissions.hook.ts b/client/src/features/ProjectPageV2/utils/useProjectPermissions.hook.ts index c74b374b3a..6407d0bf2f 100644 --- a/client/src/features/ProjectPageV2/utils/useProjectPermissions.hook.ts +++ b/client/src/features/ProjectPageV2/utils/useProjectPermissions.hook.ts @@ -20,7 +20,7 @@ import { skipToken } from "@reduxjs/toolkit/query"; import { useEffect } from "react"; import { DEFAULT_PERMISSIONS } from "../../permissionsV2/permissions.constants"; -import type { Permissions } from "../../permissionsV2/permissions.types"; +import type { PermissionsWithLoadingState } from "../../permissionsV2/permissions.types"; import { projectV2Api } from "../../projectsV2/api/projectV2.enhanced-api"; interface UseProjectPermissionsArgs { @@ -29,7 +29,7 @@ interface UseProjectPermissionsArgs { export default function useProjectPermissions({ projectId, -}: UseProjectPermissionsArgs): Permissions { +}: UseProjectPermissionsArgs): PermissionsWithLoadingState { const { currentData, isLoading, isError, isUninitialized } = projectV2Api.endpoints.getProjectsByProjectIdPermissions.useQueryState( projectId ? { projectId } : skipToken, @@ -43,13 +43,18 @@ export default function useProjectPermissions({ } }, [fetchPermissions, isUninitialized, projectId]); + const isLoadingPermissions = isLoading || !!(projectId && isUninitialized); + if (isLoading || isError || !currentData) { - return DEFAULT_PERMISSIONS; + return { + ...DEFAULT_PERMISSIONS, + isLoadingPermissions, + }; } - const permissions: Permissions = { + return { ...DEFAULT_PERMISSIONS, ...currentData, + isLoadingPermissions: false, }; - return permissions; } diff --git a/client/src/features/admin/SessionEnvironmentAdvancedFields.tsx b/client/src/features/admin/SessionEnvironmentAdvancedFields.tsx index d56bc897d8..5958e2852a 100644 --- a/client/src/features/admin/SessionEnvironmentAdvancedFields.tsx +++ b/client/src/features/admin/SessionEnvironmentAdvancedFields.tsx @@ -70,6 +70,7 @@ export default function SessionEnvironmentAdvancedFields({ control={control} errors={errors} + launcherCategory="session" /> diff --git a/client/src/features/admin/UpdateSessionEnvironmentButton.tsx b/client/src/features/admin/UpdateSessionEnvironmentButton.tsx index 3e61004583..2102fb5814 100644 --- a/client/src/features/admin/UpdateSessionEnvironmentButton.tsx +++ b/client/src/features/admin/UpdateSessionEnvironmentButton.tsx @@ -106,10 +106,8 @@ function UpdateSessionEnvironmentModal({ uid: data.uid ?? undefined, working_directory: data.working_directory?.trim() || undefined, strip_path_prefix: data.strip_path_prefix, - ...(commandParsed.data - ? { command: commandParsed.data } - : { command: null }), - ...(argsParsed.data ? { args: argsParsed.data } : { args: null }), + command: commandParsed.data ?? undefined, + args: argsParsed.data ?? undefined, }, }); }, diff --git a/client/src/features/permissionsV2/permissions.types.ts b/client/src/features/permissionsV2/permissions.types.ts index e8cd358fdb..ae9234206d 100644 --- a/client/src/features/permissionsV2/permissions.types.ts +++ b/client/src/features/permissionsV2/permissions.types.ts @@ -21,3 +21,7 @@ export type RequestedPermission = "write" | "delete" | "change_membership"; export type Permissions = { [key in RequestedPermission]: boolean; }; + +export type PermissionsWithLoadingState = Permissions & { + isLoadingPermissions: boolean; +}; diff --git a/client/src/features/sessionsV2/AddSessionLauncherButton.tsx b/client/src/features/sessionsV2/AddSessionLauncherButton.tsx index d71fafc823..f1d263fcfa 100644 --- a/client/src/features/sessionsV2/AddSessionLauncherButton.tsx +++ b/client/src/features/sessionsV2/AddSessionLauncherButton.tsx @@ -21,7 +21,7 @@ import { useCallback, useState } from "react"; import { PlusLg } from "react-bootstrap-icons"; import { Button } from "reactstrap"; -import NewSessionLauncherModal from "./components/SessionModals/NewSessionLauncherModal"; +import NewLauncherModal from "./components/SessionModals/NewLauncherModal"; export default function AddSessionLauncherButton({ "data-cy": dataCy, @@ -38,9 +38,9 @@ export default function AddSessionLauncherButton({ return ( <> {styleBtn === "iconTextBtn" ? ( - ) : ( )} - + ); } diff --git a/client/src/features/sessionsV2/DeleteSessionLauncherModal.tsx b/client/src/features/sessionsV2/DeleteSessionLauncherModal.tsx index 2e542853f6..728dccd057 100644 --- a/client/src/features/sessionsV2/DeleteSessionLauncherModal.tsx +++ b/client/src/features/sessionsV2/DeleteSessionLauncherModal.tsx @@ -25,6 +25,10 @@ import { WarnAlert } from "../../components/Alert"; import RtkOrDataServicesError from "../../components/errors/RtkOrDataServicesError"; import type { SessionLauncher } from "./api/sessionLaunchersV2.api"; import { useDeleteSessionLaunchersByLauncherIdMutation as useDeleteSessionLauncherMutation } from "./api/sessionLaunchersV2.api"; +import { + getLauncherCategory, + getLauncherCategoryDefinition, +} from "./session.utils"; interface DeleteSessionLauncherModalProps { isOpen: boolean; @@ -40,6 +44,8 @@ export default function DeleteSessionLauncherModal({ sessionsLength, }: DeleteSessionLauncherModalProps) { const [deleteSessionLauncher, result] = useDeleteSessionLauncherMutation(); + const launcherCategory = getLauncherCategory(launcher); + const launcherDefinition = getLauncherCategoryDefinition(launcherCategory); const onDelete = useCallback(() => { deleteSessionLauncher({ @@ -75,32 +81,37 @@ export default function DeleteSessionLauncherModal({ tag="h2" toggle={toggle} > - Delete session launcher + Delete {launcherDefinition.text.inline} launcher {result.error && }

- Are you sure you want to delete the {launcher.name} session - launcher? + Are you sure you want to delete the {launcher.name}{" "} + {launcherDefinition.text.inline} launcher?

{sessionsLength > 0 && (

- You have a session running from this launcher. If you delete this - session launcher, that session will continue running, but it - become an orphan session and will not be able to be launched again - once stopped. If other RenkuLab users are running sessions from - this launcher, their sessions will become orphan sessions as well. + You have a {launcherDefinition.text.inline} running from this + launcher. If you delete this launcher, that{" "} + {launcherDefinition.text.inline} will continue running, but it + become an orphan {launcherDefinition.text.inline} and will not be + able to be launched again once stopped. If other RenkuLab users + are running {launcherDefinition.text.inline}s from this launcher, + their {launcherDefinition.text.inline}s will become orphan{" "} + {launcherDefinition.text.inline}s as well.

)} {sessionsLength === 0 && (

- If other RenkuLab users are running sessions from this launcher, - their sessions will become orphan sessions. This means that their - sessions will continue running, but will not be able to be - launched again once stopped. + If other RenkuLab users are running{" "} + {launcherDefinition.text.inline}s from this launcher, their{" "} + {launcherDefinition.text.inline}s will become orphan{" "} + {launcherDefinition.text.inline}s. This means that their{" "} + {launcherDefinition.text.inline}s will continue running, but will + not be able to be launched again once stopped.

)} @@ -119,7 +130,7 @@ export default function DeleteSessionLauncherModal({ role="button" > - Delete Session launcher + Delete {launcherDefinition.text.inline} launcher diff --git a/client/src/features/sessionsV2/SessionList/SessionLauncherCard.tsx b/client/src/features/sessionsV2/SessionList/SessionLauncherCard.tsx index 42587c0165..8bc0d08585 100644 --- a/client/src/features/sessionsV2/SessionList/SessionLauncherCard.tsx +++ b/client/src/features/sessionsV2/SessionList/SessionLauncherCard.tsx @@ -18,36 +18,41 @@ import { skipToken } from "@reduxjs/toolkit/query"; import cx from "classnames"; -import { useContext, useMemo } from "react"; -import { CircleFill, Link45deg, Pencil, Trash } from "react-bootstrap-icons"; +import { useMemo } from "react"; +import { + CircleFill, + Link45deg, + Pencil, + PlayCircle, + Trash, +} from "react-bootstrap-icons"; import { Card, CardBody, Col, DropdownItem, Row } from "reactstrap"; import SessionEnvironmentGitLabWarningBadge from "~/features/legacy/SessionEnvironmentGitLabWarnBadge"; import { Loader } from "../../../components/Loader"; -import AppContext from "../../../utils/context/appContext"; -import { DEFAULT_APP_PARAMS } from "../../../utils/context/appParams.constants"; import PermissionsGuard from "../../permissionsV2/PermissionsGuard"; import useProjectPermissions from "../../ProjectPageV2/utils/useProjectPermissions.hook"; import { Project } from "../../projectsV2/api/projectV2.api"; import { computeResourcesApi } from "../api/computeResources.api"; import type { SessionLauncher } from "../api/sessionLaunchersV2.api"; -import { - sessionLaunchersV2Api, - useGetEnvironmentsByEnvironmentIdBuildsQuery as useGetBuildsQuery, -} from "../api/sessionLaunchersV2.api"; -import { useGetSessionsImagesQuery } from "../api/sessionsV2.api"; +import { sessionLaunchersV2Api } from "../api/sessionLaunchersV2.api"; import { BuildStatusBadge, BuildStatusDescription, } from "../components/BuildStatusComponents"; +import { LauncherActions } from "../components/launcherActions/LauncherActions"; import { EnvironmentIcon, LauncherEnvironmentIcon, } from "../components/SessionForm/LauncherEnvironmentIcon"; -import { SessionLauncherButtons } from "../components/SessionLauncherButtons"; import SessionImageBadge from "../components/SessionStatus/SessionImageBadge"; import { SessionBadge } from "../components/SessionStatus/SessionStatus"; +import { + getLauncherCategory, + getLauncherCategoryDefinitionByLauncher, +} from "../session.utils"; import { SessionV2 } from "../sessionsV2.types"; +import useLauncherEnvironmentReadiness from "../useLauncherEnvironmentReadiness.hook"; import SessionCard from "./SessionCard"; import styles from "./Session.module.scss"; @@ -74,30 +79,29 @@ export default function SessionLauncherCard({ toggleSessionView, toggleShareLink, }: SessionLauncherCardProps) { - const { params } = useContext(AppContext); - const environment = launcher?.environment; - const imageBuildersEnabled = - params?.IMAGE_BUILDERS_ENABLED ?? DEFAULT_APP_PARAMS.IMAGE_BUILDERS_ENABLED; - const isCodeEnvironment = environment?.environment_image_source === "build"; - const isExternalImageEnvironment = - environment?.environment_kind === "CUSTOM" && - environment?.environment_image_source === "image"; - - const { data: builds, isLoading } = useGetBuildsQuery( - imageBuildersEnabled && isCodeEnvironment - ? { environmentId: environment.id } - : skipToken, - ); + const { + builds, + isBuildInProgress, + isCodeEnvironment, + isCustomImageEnvironment, + isGlobalEnvironment, + isLoadingBuilds, + isLoadingContainerImage, + lastBuild, + lastSuccessfulBuild, + useOldImage, + containerImage, + } = useLauncherEnvironmentReadiness({ launcher }); - const lastBuild = builds?.at(0); - const lastSuccessfulBuild = builds?.find( - (build) => build.status === "succeeded" && build.id !== lastBuild?.id, - ); const hasSession = !!sessions?.length; + const launcherDefinition = + launcher && getLauncherCategoryDefinitionByLauncher(launcher); + const LauncherTypeIcon = launcherDefinition?.icon || PlayCircle; + const launcherTypeLabel = launcherDefinition?.text.display || null; sessionLaunchersV2Api.endpoints.getEnvironmentsByEnvironmentIdBuilds.useQuerySubscription( - isCodeEnvironment && lastBuild?.status === "in_progress" - ? { environmentId: environment.id } + launcher && isBuildInProgress + ? { environmentId: launcher.environment.id } : skipToken, { pollingInterval: 1_000, @@ -105,11 +109,11 @@ export default function SessionLauncherCard({ ); const otherLauncherActions = launcher && - toggleUpdate && - toggleDelete && - toggleShareLink && - toggleUpdateEnvironment && ( - - - - - Session Launcher - - - - {environment?.environment_kind === "GLOBAL" ? ( - - - Global environment - - ) : isCodeEnvironment ? ( - - - Code based environment - - ) : isExternalImageEnvironment ? ( - - - External image environment + {launcher && ( + + + + + {launcherTypeLabel}{" "} + Launcher - ) : null} - - + + + {isGlobalEnvironment ? ( + + + Global environment + + ) : isCodeEnvironment ? ( + + + Code based environment + + ) : isCustomImageEnvironment ? ( + + + External image environment + + ) : null} + + + )} {isCodeEnvironment && - (isLoading || + (isLoadingBuilds || isLoadingContainerImage || isLoadingResourcePools) ? ( - - {isCodeEnvironment && - lastBuild?.status !== "succeeded" && - lastSuccessfulBuild && ( - - )} + {useOldImage && lastSuccessfulBuild && ( + + )}
)} @@ -345,62 +354,72 @@ export default function SessionLauncherCard({ ); } -interface SessionLauncherDropdownActionsProps { +interface LauncherDropdownActionsProps { launcher: SessionLauncher; - toggleUpdate: () => void; - toggleDelete: () => void; - toggleUpdateEnvironment: () => void; - toggleShareLink: () => void; + toggleUpdate?: () => void; + toggleDelete?: () => void; + toggleUpdateEnvironment?: () => void; + toggleShareLink?: () => void; project: Project; } -function SessionLauncherDropdownActions({ +function LauncherDropdownActions({ launcher, toggleDelete, toggleUpdate, toggleUpdateEnvironment, toggleShareLink, -}: SessionLauncherDropdownActionsProps) { +}: LauncherDropdownActionsProps) { const { project_id: projectId } = launcher; const permissions = useProjectPermissions({ projectId }); - + const launcherCategory = getLauncherCategory(launcher); return ( <> - - - Edit environment - - - - Edit launcher - - - - Share session launch link - - - - - Delete launcher - + {toggleUpdateEnvironment && ( + + + Edit environment + + )} + {toggleUpdate && ( + + + Edit launcher + + )} + {toggleShareLink && launcherCategory === "session" && ( + + + Share session launch link + + )} + {toggleDelete && ( + <> + + + + Delete launcher + + + )} } requestedPermission="write" diff --git a/client/src/features/sessionsV2/SessionList/SessionLauncherDisplay.tsx b/client/src/features/sessionsV2/SessionList/SessionLauncherDisplay.tsx index 394b14c278..8c32ca0204 100644 --- a/client/src/features/sessionsV2/SessionList/SessionLauncherDisplay.tsx +++ b/client/src/features/sessionsV2/SessionList/SessionLauncherDisplay.tsx @@ -94,7 +94,9 @@ export function SessionLauncherDisplay({ toggleUpdate={toggleUpdate} toggleUpdateEnvironment={toggleUpdateEnvironment} toggleDelete={toggleDelete} - toggleShareLink={toggleShareLink} + toggleShareLink={ + launcher.launcher_type === "interactive" ? toggleShareLink : undefined + } toggleSessionView={toggleSessionView} /> - - - - - - + {launcherCategory === "session" && ( + <> + + + + + + + + )} - + {launcherCategory === "session" && ( + + )} ); } @@ -444,7 +451,8 @@ function CustomBuildEnvironmentValues({ return null; } - const { build_parameters } = environment; + const launcherCategory = getLauncherCategory(launcher); + const { build_parameters, command, args } = environment; const { builder_variant, context_dir, @@ -547,6 +555,21 @@ function CustomBuildEnvironmentValues({ label="User interface" value={frontend_variant || ""} /> + {launcherCategory === "job" && + environment.container_image === BUILDER_IMAGE_NOT_READY_VALUE && ( + <> + + + + )} {environment.container_image !== BUILDER_IMAGE_NOT_READY_VALUE && ( diff --git a/client/src/features/sessionsV2/SessionView/SessionView.tsx b/client/src/features/sessionsV2/SessionView/SessionView.tsx index cbffbe5a84..77f87ba592 100644 --- a/client/src/features/sessionsV2/SessionView/SessionView.tsx +++ b/client/src/features/sessionsV2/SessionView/SessionView.tsx @@ -63,6 +63,7 @@ import { useGetResourcePoolsQuery, } from "../api/computeResources.api"; import type { SessionLauncher } from "../api/sessionLaunchersV2.api"; +import { LauncherActions } from "../components/launcherActions/LauncherActions"; import ActiveSessionButton from "../components/SessionButton/ActiveSessionButton"; import { ModifyResourcesLauncherModal } from "../components/SessionModals/ModifyResourcesLauncher"; import UpdateSessionLauncherEnvironmentModal from "../components/SessionModals/UpdateSessionLauncherModal"; @@ -74,9 +75,12 @@ import { SessionStatusV2Title, } from "../components/SessionStatus/SessionStatus"; import { DEFAULT_URL } from "../session.constants"; +import { + getLauncherCategory, + getLauncherCategoryDefinition, +} from "../session.utils"; import { getShowSessionUrlByProject, SessionV2Actions } from "../SessionsV2"; -import { SessionV2 } from "../sessionsV2.types"; -import StartSessionButton from "../StartSessionButton"; +import { LauncherCategory, SessionV2 } from "../sessionsV2.types"; import EnvironmentItem from "./EnvironmentItem"; import EnvVariablesCard from "./EnvVariablesCard"; import EnvVariablesModal from "./EnvVariablesModal"; @@ -120,13 +124,15 @@ function SessionCardContent({ function SessionCard({ session, project, + launcherCategory, }: { session: SessionV2; project: Project; + launcherCategory: LauncherCategory; }) { return ( } contentLabel={} contentSession={ @@ -145,9 +151,11 @@ function SessionCard({ } function SessionCardNotRunning({ + hasSession, launcher, project, }: { + hasSession?: boolean; launcher: SessionLauncher; project: Project; }) { @@ -176,7 +184,9 @@ function SessionCardNotRunning({ } contentSession={
- = 1 + ? sessions[0].session_type + : null; + const orphanCategory = orphanType === "non-interactive" ? "job" : "session"; + + const launcherCategory = launcher && getLauncherCategory(launcher); + const launcherDefinition = getLauncherCategoryDefinition( + launcherCategory || orphanCategory, + ); + const { data: dataConnectorLinks } = useGetProjectsByProjectIdDataConnectorLinksQuery({ projectId: project.id, @@ -262,7 +288,9 @@ export function SessionView({ ); const totalSession = sessions ? Object.keys(sessions).length : 0; - const title = launcher ? launcher.name : "Orphan Session"; + const title = launcher + ? launcher.name + : `Orphan ${launcherDefinition?.text.inline} without launcher`; const launcherMenu = launcher && ( {launcherMenu} @@ -342,7 +372,7 @@ export function SessionView({ - Launched Session + Launched {launcherDefinition?.text.display} {totalSession > 0 ? ( @@ -353,16 +383,22 @@ export function SessionView({ session={session} launcher={launcher} /> - +
)) ) : (

- No session is running from this launcher. + No {launcherDefinition?.text.inline} is running from this + launcher.

{launcher && ( 0} project={project} launcher={launcher} /> @@ -384,7 +420,7 @@ export function SessionView({ >

- Session Environment + {launcherDefinition?.text.display} Environment

- Modify session environment + Modify {launcherDefinition?.text.inline} environment } @@ -485,13 +521,14 @@ export function SessionView({ ({launcherResourceClass.max_storage} GB).

)} - {launcher && ( + {launcher && launcherCategory && ( )} @@ -504,8 +541,8 @@ export function SessionView({

- The default URL specifies the URL pathname on the session to go - to upon launch + The default URL specifies the URL pathname on the{" "} + {launcherDefinition?.text.inline} to go to upon launch

{launcher && launcher.environment?.default_url ? ( diff --git a/client/src/features/sessionsV2/SessionsV2.tsx b/client/src/features/sessionsV2/SessionsV2.tsx index 7d7981d7ad..b0bd45f894 100644 --- a/client/src/features/sessionsV2/SessionsV2.tsx +++ b/client/src/features/sessionsV2/SessionsV2.tsx @@ -18,7 +18,7 @@ import cx from "classnames"; import { useCallback, useMemo } from "react"; -import { Pencil, PlayCircle, Trash } from "react-bootstrap-icons"; +import { Pencil, RocketTakeoff, Trash } from "react-bootstrap-icons"; import { generatePath } from "react-router"; import { Badge, @@ -109,7 +109,7 @@ export default function SessionsV2({ project }: SessionsV2Props) { <>

{totalSessions > 0 - ? "Session launchers are available to everyone who can see the project. Running sessions are only accessible to you." + ? "Launchers are available to everyone who can see the project. Only you can see your running sessions and jobs." : "Define interactive environments in which to do your work and share it with others."}

{loading} @@ -145,8 +145,8 @@ export default function SessionsV2({ project }: SessionsV2Props) { >

- - Sessions + + Launchers

{totalSessions}
@@ -155,7 +155,7 @@ export default function SessionsV2({ project }: SessionsV2Props) { enabled={
diff --git a/client/src/features/sessionsV2/StartSessionButton.tsx b/client/src/features/sessionsV2/StartSessionButton.tsx deleted file mode 100644 index 7e24b34507..0000000000 --- a/client/src/features/sessionsV2/StartSessionButton.tsx +++ /dev/null @@ -1,145 +0,0 @@ -/*! - * Copyright 2024 - Swiss Data Science Center (SDSC) - * A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and - * Eidgenössische Technische Hochschule Zürich (ETHZ). - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import { skipToken } from "@reduxjs/toolkit/query/react"; -import cx from "classnames"; -import { ReactNode, useContext } from "react"; -import { PlayCircle } from "react-bootstrap-icons"; -import { generatePath, Link } from "react-router"; -import { UncontrolledTooltip } from "reactstrap"; - -import { useGetEnvironmentsByEnvironmentIdBuildsQuery as useGetBuildsQuery } from "~/features/sessionsV2/api/sessionLaunchersV2.api"; -import AppContext from "~/utils/context/appContext"; -import { DEFAULT_APP_PARAMS } from "~/utils/context/appParams.constants"; -import { ButtonWithMenuV2 } from "../../components/buttons/Button"; -import { ABSOLUTE_ROUTES } from "../../routing/routes.constants"; -import { SessionLauncher } from "./api/sessionLaunchersV2.generated-api"; -import { useGetSessionsImagesQuery } from "./api/sessionsV2.api"; -import { CUSTOM_LAUNCH_SEARCH_PARAM } from "./session.constants"; - -interface StartSessionButtonProps { - namespace: string; - slug: string; - launcher: SessionLauncher; - disabled?: boolean; - useOldImage?: boolean; - otherActions?: ReactNode; - isDisabledDropdownToggle?: boolean; -} - -export default function StartSessionButton({ - launcher, - namespace, - slug, -}: StartSessionButtonProps) { - const startUrl = generatePath( - ABSOLUTE_ROUTES.v2.projects.show.sessions.start, - { - launcherId: launcher.id, - namespace, - slug, - }, - ); - const environment = launcher?.environment; - const isExternalImageEnvironment = - environment?.environment_kind === "CUSTOM" && - environment?.environment_image_source === "image"; - const { data, isLoading } = useGetSessionsImagesQuery( - environment && - environment.environment_kind === "CUSTOM" && - environment.container_image - ? { imageUrl: environment.container_image } - : skipToken, - ); - const { params } = useContext(AppContext); - const imageBuildersEnabled = - params?.IMAGE_BUILDERS_ENABLED ?? DEFAULT_APP_PARAMS.IMAGE_BUILDERS_ENABLED; - const { data: builds } = useGetBuildsQuery( - imageBuildersEnabled && environment.environment_image_source === "build" - ? { environmentId: environment.id } - : skipToken, - ); - - const hasSuccessfulBuild = builds?.find( - (build) => build.status === "succeeded", - ); - - const force = isExternalImageEnvironment && !isLoading && !data?.accessible; - - const isLaunchButtonDisabled = - environment.environment_image_source === "build" && !hasSuccessfulBuild; - const launchButtonDisableReason = - "No image available. Run the Build action to generate an image."; - - const launchAction = ( - - - - {force ? "Force launch" : "Launch"} - - {isLaunchButtonDisabled && ( - - {launchButtonDisableReason} - - )} - - ); - - const customizeLaunch = ( - - - {force ? "Force custom launch" : "Custom launch"} - - ); - - return ( - <> - - {customizeLaunch} - - - ); -} diff --git a/client/src/features/sessionsV2/api/sessionLaunchersV2.generated-api.ts b/client/src/features/sessionsV2/api/sessionLaunchersV2.generated-api.ts index 25b44f4247..0ed1e84513 100644 --- a/client/src/features/sessionsV2/api/sessionLaunchersV2.generated-api.ts +++ b/client/src/features/sessionsV2/api/sessionLaunchersV2.generated-api.ts @@ -8,9 +8,7 @@ const injectedRtkApi = api.injectEndpoints({ >({ query: (queryArg) => ({ url: `/environments`, - params: { - get_environment_params: queryArg.getEnvironmentParams, - }, + params: { get_environment_params: queryArg.getEnvironmentParams }, }), }), postEnvironments: build.mutation< @@ -121,9 +119,7 @@ const injectedRtkApi = api.injectEndpoints({ >({ query: (queryArg) => ({ url: `/builds/${queryArg.buildId}/logs`, - params: { - max_lines: queryArg.maxLines, - }, + params: { max_lines: queryArg.maxLines }, }), }), getEnvironmentsByEnvironmentIdBuilds: build.query< @@ -171,7 +167,8 @@ export type PatchEnvironmentsByEnvironmentIdApiArg = { environmentId: Ulid; environmentPatch: EnvironmentPatch; }; -export type DeleteEnvironmentsByEnvironmentIdApiResponse = unknown; +export type DeleteEnvironmentsByEnvironmentIdApiResponse = + /** status 204 The session environment was removed or did not exist in the first place */ void; export type DeleteEnvironmentsByEnvironmentIdApiArg = { environmentId: Ulid; }; @@ -194,7 +191,8 @@ export type PatchSessionLaunchersByLauncherIdApiArg = { launcherId: Ulid; sessionLauncherPatch: SessionLauncherPatch; }; -export type DeleteSessionLaunchersByLauncherIdApiResponse = unknown; +export type DeleteSessionLaunchersByLauncherIdApiResponse = + /** status 204 The session was removed or did not exist in the first place */ void; export type DeleteSessionLaunchersByLauncherIdApiArg = { launcherId: Ulid; }; @@ -275,8 +273,12 @@ export type ErrorResponse = { trace_id?: string; }; }; +export type CommandAndArgs = { + command?: EnvironmentCommand; + args?: EnvironmentArgs; +}; export type EnvironmentImageSourceImage = "image"; -export type EnvironmentPost = { +export type EnvironmentPost = CommandAndArgs & { name: SessionName; description?: Description; container_image: ContainerImage; @@ -286,19 +288,15 @@ export type EnvironmentPost = { working_directory?: EnvironmentWorkingDirectory; mount_directory?: EnvironmentMountDirectory; port?: EnvironmentPort; - command?: EnvironmentCommand; - args?: EnvironmentArgs; is_archived?: IsArchived; environment_image_source: EnvironmentImageSourceImage; strip_path_prefix?: StripPathPrefix; }; export type EnvironmentWorkingDirectoryPatch = string; export type EnvironmentMountDirectoryPatch = string; -export type EnvironmentPatchCommand = string[] | null; -export type EnvironmentPatchArgs = string[] | null; export type IsArchivedPatch = boolean; export type StripPathPrefixPatch = boolean; -export type EnvironmentPatch = { +export type EnvironmentPatch = CommandAndArgs & { name?: SessionName; description?: Description; container_image?: ContainerImage; @@ -308,8 +306,6 @@ export type EnvironmentPatch = { working_directory?: EnvironmentWorkingDirectoryPatch; mount_directory?: EnvironmentMountDirectoryPatch; port?: EnvironmentPort; - command?: EnvironmentPatchCommand; - args?: EnvironmentPatchArgs; is_archived?: IsArchivedPatch; strip_path_prefix?: StripPathPrefixPatch; }; @@ -325,7 +321,7 @@ export type BuilderVariant = string; export type FrontendVariant = string; export type RepositoryRevision = string; export type BuildContextDir = string; -export type BuildParameters = { +export type BuildParameters = any & { repository: Repository; platforms?: BuildPlatforms; builder_variant: BuilderVariant; @@ -350,7 +346,7 @@ export type EnvVar = { value?: string; }; export type EnvVariables = EnvVar[]; -export type LauncherType = "interactive" | "non_interactive"; +export type LauncherType = "interactive" | "non-interactive"; export type SessionLauncher = { id: Ulid; project_id: Ulid; @@ -367,9 +363,10 @@ export type SessionLaunchersList = SessionLauncher[]; export type EnvironmentPostInLauncherHelper = EnvironmentPost & { environment_kind: EnvironmentKind; }; -export type BuildParametersPost = BuildParameters & { - environment_image_source: EnvironmentImageSourceBuild; -}; +export type BuildParametersPost = BuildParameters & + CommandAndArgs & { + environment_image_source: EnvironmentImageSourceBuild; + }; export type EnvironmentPostInLauncher = | EnvironmentPostInLauncherHelper | BuildParametersPost; diff --git a/client/src/features/sessionsV2/api/sessionLaunchersV2.openapi.json b/client/src/features/sessionsV2/api/sessionLaunchersV2.openapi.json index 39d098d68d..a2acf3abd2 100644 --- a/client/src/features/sessionsV2/api/sessionLaunchersV2.openapi.json +++ b/client/src/features/sessionsV2/api/sessionLaunchersV2.openapi.json @@ -724,82 +724,83 @@ }, "EnvironmentPost": { "description": "Data required to create a session environment", - "type": "object", - "properties": { - "name": { - "$ref": "#/components/schemas/SessionName" - }, - "description": { - "$ref": "#/components/schemas/Description" - }, - "container_image": { - "$ref": "#/components/schemas/ContainerImage" - }, - "default_url": { - "allOf": [ - { - "$ref": "#/components/schemas/DefaultUrl" - } - ], - "default": "/lab" - }, - "uid": { - "allOf": [ - { - "$ref": "#/components/schemas/EnvironmentUid" - } - ], - "default": 1000 - }, - "gid": { - "allOf": [ - { - "$ref": "#/components/schemas/EnvironmentGid" - } - ], - "default": 1000 - }, - "working_directory": { - "$ref": "#/components/schemas/EnvironmentWorkingDirectory" - }, - "mount_directory": { - "$ref": "#/components/schemas/EnvironmentMountDirectory" - }, - "port": { - "allOf": [ - { - "$ref": "#/components/schemas/EnvironmentPort" - } - ], - "default": 8080 - }, - "command": { - "$ref": "#/components/schemas/EnvironmentCommand" - }, - "args": { - "$ref": "#/components/schemas/EnvironmentArgs" - }, - "is_archived": { - "allOf": [ - { - "$ref": "#/components/schemas/IsArchived" - } - ], - "default": false - }, - "environment_image_source": { - "$ref": "#/components/schemas/EnvironmentImageSourceImage" + "allOf": [ + { + "$ref": "#/components/schemas/CommandAndArgs" }, - "strip_path_prefix": { - "allOf": [ - { - "$ref": "#/components/schemas/StripPathPrefix" + { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/SessionName" + }, + "description": { + "$ref": "#/components/schemas/Description" + }, + "container_image": { + "$ref": "#/components/schemas/ContainerImage" + }, + "default_url": { + "allOf": [ + { + "$ref": "#/components/schemas/DefaultUrl" + } + ], + "default": "/lab" + }, + "uid": { + "allOf": [ + { + "$ref": "#/components/schemas/EnvironmentUid" + } + ], + "default": 1000 + }, + "gid": { + "allOf": [ + { + "$ref": "#/components/schemas/EnvironmentGid" + } + ], + "default": 1000 + }, + "working_directory": { + "$ref": "#/components/schemas/EnvironmentWorkingDirectory" + }, + "mount_directory": { + "$ref": "#/components/schemas/EnvironmentMountDirectory" + }, + "port": { + "allOf": [ + { + "$ref": "#/components/schemas/EnvironmentPort" + } + ], + "default": 8080 + }, + "is_archived": { + "allOf": [ + { + "$ref": "#/components/schemas/IsArchived" + } + ], + "default": false + }, + "environment_image_source": { + "$ref": "#/components/schemas/EnvironmentImageSourceImage" + }, + "strip_path_prefix": { + "allOf": [ + { + "$ref": "#/components/schemas/StripPathPrefix" + } + ], + "default": false } - ], - "default": false + }, + "required": ["name", "container_image", "environment_image_source"] } - }, - "required": ["name", "container_image", "environment_image_source"] + ] }, "EnvironmentPatchInLauncher": { "allOf": [ @@ -823,54 +824,55 @@ ] }, "EnvironmentPatch": { - "type": "object", - "description": "Update a session environment", - "additionalProperties": false, - "properties": { - "name": { - "$ref": "#/components/schemas/SessionName" - }, - "description": { - "$ref": "#/components/schemas/Description" - }, - "container_image": { - "$ref": "#/components/schemas/ContainerImage" - }, - "default_url": { - "$ref": "#/components/schemas/DefaultUrl" - }, - "uid": { - "$ref": "#/components/schemas/EnvironmentUid" - }, - "gid": { - "$ref": "#/components/schemas/EnvironmentGid" - }, - "working_directory": { - "$ref": "#/components/schemas/EnvironmentWorkingDirectoryPatch" - }, - "mount_directory": { - "$ref": "#/components/schemas/EnvironmentMountDirectoryPatch" - }, - "port": { - "$ref": "#/components/schemas/EnvironmentPort" - }, - "command": { - "$ref": "#/components/schemas/EnvironmentPatchCommand" - }, - "args": { - "$ref": "#/components/schemas/EnvironmentPatchArgs" - }, - "is_archived": { - "$ref": "#/components/schemas/IsArchivedPatch" + "allOf": [ + { + "$ref": "#/components/schemas/CommandAndArgs" }, - "strip_path_prefix": { - "$ref": "#/components/schemas/StripPathPrefixPatch" + { + "type": "object", + "description": "Update a session environment", + "additionalProperties": false, + "properties": { + "name": { + "$ref": "#/components/schemas/SessionName" + }, + "description": { + "$ref": "#/components/schemas/Description" + }, + "container_image": { + "$ref": "#/components/schemas/ContainerImage" + }, + "default_url": { + "$ref": "#/components/schemas/DefaultUrl" + }, + "uid": { + "$ref": "#/components/schemas/EnvironmentUid" + }, + "gid": { + "$ref": "#/components/schemas/EnvironmentGid" + }, + "working_directory": { + "$ref": "#/components/schemas/EnvironmentWorkingDirectoryPatch" + }, + "mount_directory": { + "$ref": "#/components/schemas/EnvironmentMountDirectoryPatch" + }, + "port": { + "$ref": "#/components/schemas/EnvironmentPort" + }, + "is_archived": { + "$ref": "#/components/schemas/IsArchivedPatch" + }, + "strip_path_prefix": { + "$ref": "#/components/schemas/StripPathPrefixPatch" + } + } } - } + ] }, "LauncherType": { "type": "string", - "enum": ["interactive", "non_interactive"] + "enum": ["interactive", "non-interactive"] }, "SessionLaunchersList": { "description": "A list of Renku session launchers", @@ -974,7 +976,7 @@ }, "SessionLauncherPatch": { "type": "object", - "description": "Update a session launcher", + "description": "Update a session launcher. For non-interactive launchers, a `command` is required.", "additionalProperties": false, "properties": { "name": { @@ -1124,35 +1126,45 @@ }, "BuildParameters": { "description": "Build parameters", - "type": "object", - "additionalProperties": false, - "properties": { - "repository": { - "$ref": "#/components/schemas/Repository" - }, - "platforms": { - "$ref": "#/components/schemas/BuildPlatforms" - }, - "builder_variant": { - "$ref": "#/components/schemas/BuilderVariant" - }, - "frontend_variant": { - "$ref": "#/components/schemas/FrontendVariant" - }, - "repository_revision": { - "$ref": "#/components/schemas/RepositoryRevision" + "allOf": [ + { + "ref": "#/components/schemas/CommandAndArgs" }, - "context_dir": { - "$ref": "#/components/schemas/BuildContextDir" + { + "type": "object", + "additionalProperties": false, + "properties": { + "repository": { + "$ref": "#/components/schemas/Repository" + }, + "platforms": { + "$ref": "#/components/schemas/BuildPlatforms" + }, + "builder_variant": { + "$ref": "#/components/schemas/BuilderVariant" + }, + "frontend_variant": { + "$ref": "#/components/schemas/FrontendVariant" + }, + "repository_revision": { + "$ref": "#/components/schemas/RepositoryRevision" + }, + "context_dir": { + "$ref": "#/components/schemas/BuildContextDir" + } + }, + "required": ["repository", "builder_variant", "frontend_variant"] } - }, - "required": ["repository", "builder_variant", "frontend_variant"] + ] }, "BuildParametersPost": { "allOf": [ { "$ref": "#/components/schemas/BuildParameters" }, + { + "$ref": "#/components/schemas/CommandAndArgs" + }, { "type": "object", "properties": { @@ -1188,6 +1200,18 @@ } } }, + "CommandAndArgs": { + "description": "The command and arguments.", + "type": "object", + "properties": { + "command": { + "$ref": "#/components/schemas/EnvironmentCommand" + }, + "args": { + "$ref": "#/components/schemas/EnvironmentArgs" + } + } + }, "ContainerImage": { "description": "A container image", "type": "string", diff --git a/client/src/features/sessionsV2/api/sessionsV2.generated-api.ts b/client/src/features/sessionsV2/api/sessionsV2.generated-api.ts index b021e16c95..f378c90814 100644 --- a/client/src/features/sessionsV2/api/sessionsV2.generated-api.ts +++ b/client/src/features/sessionsV2/api/sessionsV2.generated-api.ts @@ -12,9 +12,7 @@ const injectedRtkApi = api.injectEndpoints({ getSessions: build.query({ query: (queryArg) => ({ url: `/sessions`, - params: { - session_type: queryArg.sessionType, - }, + params: { session_type: queryArg.sessionType }, }), }), getSessionsBySessionId: build.query< @@ -48,9 +46,7 @@ const injectedRtkApi = api.injectEndpoints({ >({ query: (queryArg) => ({ url: `/sessions/${queryArg.sessionId}/logs`, - params: { - max_lines: queryArg.maxLines, - }, + params: { max_lines: queryArg.maxLines }, }), }), getSessionsImages: build.query< @@ -59,9 +55,7 @@ const injectedRtkApi = api.injectEndpoints({ >({ query: (queryArg) => ({ url: `/sessions/images`, - params: { - image_url: queryArg.imageUrl, - }, + params: { image_url: queryArg.imageUrl }, }), }), }), @@ -86,7 +80,8 @@ export type GetSessionsBySessionIdApiArg = { /** The id of the session */ sessionId: string; }; -export type DeleteSessionsBySessionIdApiResponse = unknown; +export type DeleteSessionsBySessionIdApiResponse = + /** status 204 The session was deleted or it never existed in the first place */ void; export type DeleteSessionsBySessionIdApiArg = { /** The id of the session that should be deleted */ sessionId: string; @@ -141,17 +136,23 @@ export type SessionStatus = { total_containers: number; }; export type Ulid = string; +export type SessionType = "interactive" | "non-interactive"; +export type SubmissionId = string; export type SessionResponse = { image: string; name: ServerName; resources: SessionResources; started: string | null; + job_completed_at?: string | null; lastInteraction?: string | null; status: SessionStatus; url: string; project_id: Ulid; launcher_id: Ulid; resource_class_id: number; + session_type: SessionType; + submission_id?: SubmissionId; + command_args?: string[] | null; }; export type ErrorResponse = { error: { @@ -188,11 +189,13 @@ export type SessionPostRequest = { /** The size of disk storage for the session, in gigabytes */ disk_storage?: number; resource_class_id?: number | null; + submission_id?: SubmissionId; data_connectors_overrides?: SessionDataConnectorsOverrideList; env_variable_overrides?: EnvVariableOverrides; + job_command_override?: string[] | null; + job_args_override?: string[] | null; }; export type SessionListResponse = SessionResponse[]; -export type SessionType = "interactive" | "non-interactive"; export type CurrentTime = "now"; export type SessionPatchRequest = { resource_class_id?: number; diff --git a/client/src/features/sessionsV2/api/sessionsV2.openapi.json b/client/src/features/sessionsV2/api/sessionsV2.openapi.json index 8dc9bde5cd..fe04e30b83 100644 --- a/client/src/features/sessionsV2/api/sessionsV2.openapi.json +++ b/client/src/features/sessionsV2/api/sessionsV2.openapi.json @@ -335,11 +335,28 @@ "nullable": true, "type": "integer" }, + "submission_id": { + "$ref": "#/components/schemas/SubmissionId" + }, "data_connectors_overrides": { "$ref": "#/components/schemas/SessionDataConnectorsOverrideList" }, "env_variable_overrides": { "$ref": "#/components/schemas/EnvVariableOverrides" + }, + "job_command_override": { + "nullable": true, + "type": "array", + "items": { + "type": "string" + } + }, + "job_args_override": { + "nullable": true, + "type": "array", + "items": { + "type": "string" + } } }, "required": ["launcher_id"], @@ -361,6 +378,11 @@ "nullable": true, "type": "string" }, + "job_completed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, "lastInteraction": { "type": "string", "format": "date-time", @@ -380,6 +402,20 @@ }, "resource_class_id": { "type": "integer" + }, + "session_type": { + "$ref": "#/components/schemas/SessionType" + }, + "submission_id": { + "$ref": "#/components/schemas/SubmissionId", + "nullable": true + }, + "command_args": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true } }, "required": [ @@ -391,7 +427,8 @@ "url", "project_id", "launcher_id", - "resource_class_id" + "resource_class_id", + "session_type" ], "type": "object" }, @@ -599,6 +636,11 @@ "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "example": "d185e68d-d43-renku-2-b9ac279a4e8a85ac28d08" }, + "SubmissionId": { + "type": "string", + "pattern": "^[a-z][-0-9a-z]{3,19}$", + "description": "When submitting a job, i.e. the launcher used is a job\nlauncher, the submission id is required to deduplicate\nsame job submissions and allows retries.\n" + }, "ImageCheckResponse": { "type": "object", "properties": { diff --git a/client/src/features/sessionsV2/components/SessionForm/AdvancedSettingsFields.tsx b/client/src/features/sessionsV2/components/SessionForm/AdvancedSettingsFields.tsx index 60a5c269fe..cb3aaf5b2e 100644 --- a/client/src/features/sessionsV2/components/SessionForm/AdvancedSettingsFields.tsx +++ b/client/src/features/sessionsV2/components/SessionForm/AdvancedSettingsFields.tsx @@ -35,9 +35,16 @@ import { SessionEnvironmentForm } from "../../../admin/SessionEnvironmentFormCon import { DEFAULT_URL, ENVIRONMENT_VALUES_DESCRIPTION, + JOB_COMMAND_VALIDATION_MESSAGE, } from "../../session.constants"; -import { isValidJSONStringArray } from "../../session.utils"; -import { SessionLauncherForm } from "../../sessionsV2.types"; +import { + isValidJSONStringArray, + isValidRequiredJSONStringArray, +} from "../../session.utils"; +import { + SessionLauncherForm, + type LauncherCategory, +} from "../../sessionsV2.types"; function OptionalLabel() { return (Optional); @@ -48,6 +55,7 @@ interface FormFieldLabelProps { isOptional?: boolean; label: ReactNode; name: Path; + id?: string; } function FormFieldLabel({ @@ -85,6 +93,7 @@ function FormField({ rules, type = "text", isOptional, + id, }: FormFieldLabelProps & { control: Control; errors?: FieldErrors; @@ -104,6 +113,7 @@ function FormField({ rules={rules} type={type} isOptional={isOptional} + id={id} /> ); } @@ -124,7 +134,7 @@ function FormField({ ({ rules, type = "text", isOptional, + id, }: { control: Control; errors?: FieldErrors; @@ -163,6 +174,7 @@ function CheckboxOrRadioFormField({ rules?: ControllerProps["rules"]; type: InputType; isOptional?: boolean; + id?: string; }) { return (
@@ -174,7 +186,7 @@ function CheckboxOrRadioFormField({ ({ ); } -interface JsonFieldProps { +export interface JsonFieldProps { control: Control; name: Path; label: string; @@ -214,17 +226,34 @@ interface JsonFieldProps { errors?: FieldErrors; helpText: string; isOptional?: boolean; + dataCy?: string; + id?: string; } -function JsonField({ +export function JsonField({ control, name, label, info, errors, helpText, - isOptional, + isOptional = true, + dataCy, + id, }: JsonFieldProps) { + const rules = isOptional + ? { + validate: (value: string) => isValidJSONStringArray(value?.toString()), + } + : { + validate: (value: string) => + isValidRequiredJSONStringArray( + value?.toString(), + JOB_COMMAND_VALIDATION_MESSAGE.required, + JOB_COMMAND_VALIDATION_MESSAGE.empty, + ), + }; + return ( <> ({ isValidJSONStringArray(value?.toString()), + rules={rules} + render={({ field, fieldState: { error: fieldError } }) => { + const error = errors?.[name] ?? fieldError; + return ( + <> +