From 82becf48892ead8a7a2e7757becb8873fa337e5b Mon Sep 17 00:00:00 2001 From: Andrea Cordoba <43388408+andre-code@users.noreply.github.com> Date: Wed, 24 Jun 2026 19:32:42 +0200 Subject: [PATCH 1/3] feat: add job launcher (#4209) * feat: add job launcher * fix: show the popover position correctly (#4223) --------- Co-authored-by: Lorenzo Cavazzi <43481553+lorenzo-cavazzi@users.noreply.github.com> --- .../src/components/entities/entities.types.ts | 1 + .../offcanvas/OffcanvasHeaderWithType.tsx | 15 +- .../SessionEnvironmentAdvancedFields.tsx | 1 + .../admin/UpdateSessionEnvironmentButton.tsx | 6 +- .../sessionsV2/AddSessionLauncherButton.tsx | 8 +- .../sessionsV2/DeleteSessionLauncherModal.tsx | 37 +- .../SessionList/SessionLauncherCard.tsx | 189 +++++++---- .../SessionList/SessionLauncherDisplay.tsx | 4 +- .../SessionView/EnvironmentItem.tsx | 95 ++++-- .../sessionsV2/SessionView/SessionView.tsx | 79 +++-- client/src/features/sessionsV2/SessionsV2.tsx | 10 +- .../sessionsV2/StartSessionButton.tsx | 44 ++- .../api/sessionLaunchersV2.generated-api.ts | 39 +-- .../api/sessionLaunchersV2.openapi.json | 300 +++++++++-------- .../api/sessionsV2.generated-api.ts | 25 +- .../sessionsV2/api/sessionsV2.openapi.json | 44 ++- .../SessionForm/AdvancedSettingsFields.tsx | 275 ++++++++------- .../SessionForm/BuilderEnvironmentFields.tsx | 62 +++- .../SessionForm/CustomEnvironmentFields.tsx | 44 +-- .../SessionForm/EditLauncherFormContent.tsx | 66 ++-- .../SessionForm/EnvironmentField.tsx | 22 +- .../SessionForm/EnvironmentKindField.tsx | 317 +++++++++--------- .../SessionForm/LauncherCategoryIcon.tsx | 124 +++++++ .../SessionForm/LauncherDetailsFields.tsx | 19 +- .../SessionForm/LauncherEnvironmentIcon.tsx | 7 +- .../components/SessionLauncherButtons.tsx | 155 +++++---- .../SessionModals/ModifyResourcesLauncher.tsx | 25 +- ...erModal.tsx => NewLauncherCreateModal.tsx} | 203 +++++++---- .../NewLauncherModal.module.scss | 10 + .../SessionModals/NewLauncherModal.tsx | 159 +++++++++ .../UpdateSessionLauncherMetadataModal.tsx | 37 +- .../UpdateSessionLauncherModal.tsx | 34 +- .../components/SubmitJobLauncherAction.tsx | 52 +++ .../features/sessionsV2/session.constants.tsx | 45 ++- .../src/features/sessionsV2/session.utils.ts | 173 +++++++++- .../features/sessionsV2/sessionsV2.types.ts | 40 ++- tests/cypress/e2e/projectV2.spec.ts | 4 +- tests/cypress/e2e/projectV2Session.spec.ts | 6 +- tests/cypress/e2e/projectV2setup.spec.ts | 37 +- .../projectV2/session-launchers-global.json | 3 +- .../projectV2/session-launchers-job.json | 24 ++ ...ession-launchers-with-renkulab-gitlab.json | 6 +- .../session-launchers-without-env-vars.json | 3 +- .../fixtures/projectV2/session-launchers.json | 3 +- tests/cypress/support/commands/sessions.ts | 67 ++++ tests/cypress/support/e2e.ts | 2 + .../support/renkulab-fixtures/projectV2.ts | 2 +- 47 files changed, 2054 insertions(+), 869 deletions(-) create mode 100644 client/src/features/sessionsV2/components/SessionForm/LauncherCategoryIcon.tsx rename client/src/features/sessionsV2/components/SessionModals/{NewSessionLauncherModal.tsx => NewLauncherCreateModal.tsx} (62%) create mode 100644 client/src/features/sessionsV2/components/SessionModals/NewLauncherModal.module.scss create mode 100644 client/src/features/sessionsV2/components/SessionModals/NewLauncherModal.tsx create mode 100644 client/src/features/sessionsV2/components/SubmitJobLauncherAction.tsx create mode 100644 tests/cypress/fixtures/projectV2/session-launchers-job.json create mode 100644 tests/cypress/support/commands/sessions.ts 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/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/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 9bb1125470..a128a061cf 100644 --- a/client/src/features/sessionsV2/SessionList/SessionLauncherCard.tsx +++ b/client/src/features/sessionsV2/SessionList/SessionLauncherCard.tsx @@ -19,7 +19,13 @@ import { skipToken } from "@reduxjs/toolkit/query"; import cx from "classnames"; import { useContext, useMemo } from "react"; -import { Link45deg, Pencil, Trash } from "react-bootstrap-icons"; +import { + CircleFill, + Link45deg, + Pencil, + PlayCircle, + Trash, +} from "react-bootstrap-icons"; import { Card, CardBody, Col, DropdownItem, Row } from "reactstrap"; import SessionEnvironmentGitLabWarningBadge from "~/features/legacy/SessionEnvironmentGitLabWarnBadge"; @@ -48,6 +54,10 @@ import { 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 SessionCard from "./SessionCard"; @@ -95,6 +105,10 @@ export default function SessionLauncherCard({ (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" @@ -106,11 +120,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} - - + + + {environment?.environment_kind === "GLOBAL" ? ( + + + Global environment + + ) : isCodeEnvironment ? ( + + + Code based environment + + ) : isExternalImageEnvironment ? ( + + + External image environment + + ) : null} + + + )} 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" && ( + + )} ); } @@ -462,7 +469,8 @@ function CustomBuildEnvironmentValues({ return null; } - const { build_parameters } = environment; + const launcherCategory = getLauncherCategory(launcher); + const { build_parameters, command, args } = environment; const { builder_variant, context_dir, @@ -565,6 +573,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..ddbf5cc7d1 100644 --- a/client/src/features/sessionsV2/SessionView/SessionView.tsx +++ b/client/src/features/sessionsV2/SessionView/SessionView.tsx @@ -74,8 +74,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 { LauncherCategory, SessionV2 } from "../sessionsV2.types"; import StartSessionButton from "../StartSessionButton"; import EnvironmentItem from "./EnvironmentItem"; import EnvVariablesCard from "./EnvVariablesCard"; @@ -120,13 +124,15 @@ function SessionCardContent({ function SessionCard({ session, project, + launcherCategory, }: { session: SessionV2; project: Project; + launcherCategory: LauncherCategory; }) { return ( } contentLabel={} contentSession={ @@ -151,6 +157,7 @@ function SessionCardNotRunning({ launcher: SessionLauncher; project: Project; }) { + const launcherCategory = getLauncherCategory(launcher); return (
} @@ -187,18 +196,22 @@ function SessionCardNotRunning({ ); } -function getSessionColor(state: string) { - return state === "running" +function getSessionColor(state: string, launcherCategory: LauncherCategory) { + return state === "running" && launcherCategory === "session" ? "success" - : state === "starting" + : state === "running" && launcherCategory === "job" ? "warning" - : state === "stopping" + : state === "starting" ? "warning" - : state === "hibernated" - ? "dark" - : state === "failed" - ? "danger" - : "dark"; + : state === "succeeded" + ? "success" + : state === "stopping" + ? "warning" + : state === "hibernated" + ? "dark" + : state === "failed" + ? "danger" + : "dark"; } interface SessionViewProps { @@ -238,6 +251,18 @@ export function SessionView({ const permissions = useProjectPermissions({ projectId: project.id }); const environment = launcher?.environment; + // for orphan session/jobs in case can't find the type we assume is a session + const orphanType = + !launcher && sessions && sessions?.length >= 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 +287,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 +371,7 @@ export function SessionView({ - Launched Session + Launched {launcherDefinition?.text.display} {totalSession > 0 ? ( @@ -353,13 +382,18 @@ export function SessionView({ session={session} launcher={launcher} /> - + )) ) : (

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

{launcher && (

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

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

)} - {launcher && ( + {launcher && launcherCategory && ( )} @@ -504,8 +539,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 index 7e24b34507..2d365ceb12 100644 --- a/client/src/features/sessionsV2/StartSessionButton.tsx +++ b/client/src/features/sessionsV2/StartSessionButton.tsx @@ -24,6 +24,8 @@ import { generatePath, Link } from "react-router"; import { UncontrolledTooltip } from "reactstrap"; import { useGetEnvironmentsByEnvironmentIdBuildsQuery as useGetBuildsQuery } from "~/features/sessionsV2/api/sessionLaunchersV2.api"; +import SubmitJobLauncherAction from "~/features/sessionsV2/components/SubmitJobLauncherAction"; +import { LauncherCategory } from "~/features/sessionsV2/sessionsV2.types"; import AppContext from "~/utils/context/appContext"; import { DEFAULT_APP_PARAMS } from "~/utils/context/appParams.constants"; import { ButtonWithMenuV2 } from "../../components/buttons/Button"; @@ -40,12 +42,15 @@ interface StartSessionButtonProps { useOldImage?: boolean; otherActions?: ReactNode; isDisabledDropdownToggle?: boolean; + launcherCategory: LauncherCategory; } export default function StartSessionButton({ launcher, namespace, slug, + launcherCategory, + isDisabledDropdownToggle, }: StartSessionButtonProps) { const startUrl = generatePath( ABSOLUTE_ROUTES.v2.projects.show.sessions.start, @@ -88,20 +93,28 @@ export default function StartSessionButton({ const launchAction = ( - - - {force ? "Force launch" : "Launch"} - + {launcherCategory === "session" ? ( + + + {force ? "Force launch" : "Launch"} + + ) : ( + + )} {isLaunchButtonDisabled && ( ); + if (launcherCategory === "job" && isDisabledDropdownToggle) + return launchAction; + return ( <> ({ 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..3756a3e38a 100644 --- a/client/src/features/sessionsV2/components/SessionForm/AdvancedSettingsFields.tsx +++ b/client/src/features/sessionsV2/components/SessionForm/AdvancedSettingsFields.tsx @@ -30,14 +30,22 @@ import { FormText, Input, Label } from "reactstrap"; import { InputType } from "reactstrap/types/lib/Input"; import LazyMarkdown from "~/components/markdown/LazyMarkdown"; +import Markdown from "~/components/markdown/Markdown"; import { MoreInfo } from "../../../../components/MoreInfo"; import { SessionEnvironmentForm } from "../../../admin/SessionEnvironmentFormContent"; 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 +56,7 @@ interface FormFieldLabelProps { isOptional?: boolean; label: ReactNode; name: Path; + id?: string; } function FormFieldLabel({ @@ -67,7 +76,7 @@ function FormFieldLabel({ {info && ( - {info} + {info} )} {isOptional && } @@ -85,6 +94,7 @@ function FormField({ rules, type = "text", isOptional, + id, }: FormFieldLabelProps & { control: Control; errors?: FieldErrors; @@ -104,6 +114,7 @@ function FormField({ rules={rules} type={type} isOptional={isOptional} + id={id} /> ); } @@ -124,7 +135,7 @@ function FormField({ ({ rules, type = "text", isOptional, + id, }: { control: Control; errors?: FieldErrors; @@ -163,6 +175,7 @@ function CheckboxOrRadioFormField({ rules?: ControllerProps["rules"]; type: InputType; isOptional?: boolean; + id?: string; }) { return (
@@ -174,7 +187,7 @@ function CheckboxOrRadioFormField({ ({ ); } -interface JsonFieldProps { +export interface JsonFieldProps { control: Control; name: Path; label: string; @@ -214,17 +227,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 ( + <> +