Skip to content

fix: validate container images #3438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions client/src/features/admin/SessionEnvironmentFormContent.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
import cx from "classnames";
import { Control, Controller, FieldErrors } from "react-hook-form";
import { Input, Label } from "reactstrap";

import { CONTAINER_IMAGE_PATTERN } from "../sessionsV2/session.constants";
import SessionEnvironmentAdvancedFields from "./SessionEnvironmentAdvancedFields";

export interface SessionEnvironmentForm {
Expand Down Expand Up @@ -105,9 +107,18 @@ export default function SessionEnvironmentFormContent({
{...field}
/>
)}
rules={{ required: true }}
rules={{
required: "Please provide a container image.",
pattern: {
value: CONTAINER_IMAGE_PATTERN,
message: "Please provide a valid container image.",
},
}}
/>
<div className="invalid-feedback">Please provide a container image</div>
<div className="invalid-feedback">
{errors.container_image?.message ??
"Please provide a valid container image."}
</div>
</div>
<SessionEnvironmentAdvancedFields control={control} errors={errors} />
</>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,15 @@
*/

import cx from "classnames";
import { useState, useCallback } from "react";
import { useCallback, useState } from "react";
import { Controller } from "react-hook-form";
import { Label, Input, Collapse } from "reactstrap";
import { Collapse, Input, Label } from "reactstrap";

import ChevronFlippedIcon from "../../../../components/icons/ChevronFlippedIcon";
import { EnvironmentFieldsProps } from "./EnvironmentField";
import { AdvancedSettingsFields } from "./AdvancedSettingsFields";
import { CONTAINER_IMAGE_PATTERN } from "../../session.constants";
import { SessionLauncherForm } from "../../sessionsV2.types";
import { AdvancedSettingsFields } from "./AdvancedSettingsFields";
import { EnvironmentFieldsProps } from "./EnvironmentField";

export function CustomEnvironmentFields({
watch,
Expand Down Expand Up @@ -65,9 +67,21 @@ export function CustomEnvironmentFields({
{...field}
/>
)}
rules={{ required: watchEnvironmentKind === "CUSTOM" }}
rules={{
required: {
value: watchEnvironmentKind === "CUSTOM",
message: "Please provide a container image.",
},
pattern: {
value: CONTAINER_IMAGE_PATTERN,
message: "Please provide a valid container image.",
},
}}
/>
<div className="invalid-feedback">Please provide a container image</div>
<div className="invalid-feedback">
{errors.container_image?.message ??
"Please provide a valid container image."}
</div>
</div>
<div>
<span
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ import {
UseFormWatch,
} from "react-hook-form";
import { Collapse, Input, Label, ListGroup } from "reactstrap";

import { RtkErrorAlert } from "../../../../components/errors/RtkErrorAlert";
import ChevronFlippedIcon from "../../../../components/icons/ChevronFlippedIcon";
import { Loader } from "../../../../components/Loader";
import { CONTAINER_IMAGE_PATTERN } from "../../session.constants";
import { prioritizeSelectedEnvironment } from "../../session.utils";
import { useGetSessionEnvironmentsQuery } from "../../sessionsV2.api";
import { SessionLauncherForm } from "../../sessionsV2.types";
Expand Down Expand Up @@ -137,7 +139,6 @@ export default function EditLauncherFormContent({
<Controller
control={control}
name="container_image"
rules={{ required: environmentKind === "CUSTOM" }}
render={({ field }) => (
<Input
id="addSessionLauncherContainerImage"
Expand All @@ -146,8 +147,21 @@ export default function EditLauncherFormContent({
className={cx(errors.container_image && "is-invalid")}
/>
)}
rules={{
required: {
value: environmentKind === "CUSTOM",
message: "Please provide a container image.",
},
pattern: {
value: CONTAINER_IMAGE_PATTERN,
message: "Please provide a valid container image.",
},
}}
/>
<div className="invalid-feedback">Please provide a container image</div>
<div className="invalid-feedback">
{errors.container_image?.message ??
"Please provide a valid container image."}
</div>
<div>
<span
className={cx("fw-bold", "cursor-pointer")}
Expand Down
3 changes: 3 additions & 0 deletions client/src/features/sessionsV2/session.constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,6 @@ Default: \`1000\`.`,
command: `The command that will be run i.e. will overwrite the image Dockerfile \`ENTRYPOINT\`.`,
args: `The arguments that will follow the command, i.e. will overwrite the image Dockerfile \`CMD\`.`,
};

export const CONTAINER_IMAGE_PATTERN =
/^[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*(\/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*(:[a-zA-Z0-9_][a-zA-Z0-9._-]{0,127}|@sha256:[a-fA-F0-9]{64}){0,1}$/;
Loading