Skip to content
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

[UI v2] Fix tab order in variable create dialog #16014

Merged
merged 1 commit into from
Nov 15, 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
59 changes: 59 additions & 0 deletions ui-v2/src/components/ui/json-input.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
import React, { useRef, useEffect } from "react";

import { json } from "@codemirror/lang-json";
import { cn } from "@/lib/utils";
import { useCodeMirror } from "@uiw/react-codemirror";

const extensions = [json()];

type JsonInputProps = React.ComponentProps<"div"> & {
value?: string;
onChange?: (value: string) => void;
onBlur?: () => void;
disabled?: boolean;
className?: string;
};

export const JsonInput = React.forwardRef<HTMLDivElement, JsonInputProps>(
(
{ className, value, onChange, onBlur, disabled, ...props },
forwardedRef,
) => {
const editor = useRef<HTMLDivElement | null>(null);
const { setContainer } = useCodeMirror({
container: editor.current,
extensions,
value,
onChange,
onBlur,
indentWithTab: false,
editable: !disabled,
});

useEffect(() => {
if (editor.current) {
setContainer(editor.current);
}
}, [setContainer]);

return (
<div
className={cn(
"rounded-md border shadow-sm overflow-hidden focus-within:outline-none focus-within:ring-1 focus-within:ring-ring",
className,
)}
ref={(node) => {
editor.current = node;
if (typeof forwardedRef === "function") {
forwardedRef(node);
} else if (forwardedRef) {
forwardedRef.current = node;
}
}}
{...props}
/>
);
},
);

JsonInput.displayName = "JsonInput";
23 changes: 4 additions & 19 deletions ui-v2/src/components/variables/add-variable-dialog.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ import {
DialogTrigger,
} from "@/components/ui/dialog";
import { zodResolver } from "@hookform/resolvers/zod";
import CodeMirror, { EditorView } from "@uiw/react-codemirror";
import { json } from "@codemirror/lang-json";
import { useMutation } from "@tanstack/react-query";
import { useForm } from "react-hook-form";
import { z } from "zod";
Expand All @@ -30,6 +28,7 @@ import { Loader2 } from "lucide-react";
import { TagsInput } from "../ui/tags-input";
import { useToast } from "@/hooks/use-toast";
import { queryClient } from "@/router";
import { JsonInput } from "@/components/ui/json-input";

const formSchema = z.object({
name: z.string().min(2, { message: "Name must be at least 2 characters" }),
Expand Down Expand Up @@ -133,7 +132,7 @@ export const AddVariableDialog = ({
<FormItem>
<FormLabel>Name</FormLabel>
<FormControl>
<Input {...field} />
<Input autoComplete="off" {...field} />
</FormControl>
<FormMessage />
</FormItem>
Expand All @@ -144,23 +143,9 @@ export const AddVariableDialog = ({
name="value"
render={({ field }) => (
<FormItem>
<FormLabel id="value-label">Value</FormLabel>
<FormLabel>Value</FormLabel>
<FormControl>
<CodeMirror
aria-labelledby="value-label"
extensions={[json()]}
basicSetup={{
foldGutter: false,
history: false,
}}
theme={EditorView.theme({
"&.cm-editor.cm-focused": {
outline: "none",
},
})}
className="rounded-md border shadow-sm overflow-hidden"
{...field}
/>
<JsonInput {...field} />
</FormControl>
<FormMessage />
</FormItem>
Expand Down
17 changes: 8 additions & 9 deletions ui-v2/tests/variables/mocks.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
import { vi } from "vitest";
import React from "react";

export const MockCodeMirror = React.forwardRef<
// Mock out JsonInput because the underlying CodeMirror editor
// relies on browser APIs that are not available in JSDOM.
// TODO: Ensure input into JsonInput is covered by Playwright tests.
export const MockJsonInput = React.forwardRef<
HTMLTextAreaElement,
{
value: string;
Expand All @@ -15,17 +18,13 @@ export const MockCodeMirror = React.forwardRef<
onChange={(e) => {
props.onChange?.(e.target.value);
}}
data-testid="mock-codemirror"
data-testid="mock-json-input"
/>
);
});

MockCodeMirror.displayName = "MockCodemirror";
MockJsonInput.displayName = "MockJsonInput";

vi.mock("@uiw/react-codemirror", () => ({
default: MockCodeMirror,
json: () => ({}),
EditorView: {
theme: () => ({}),
},
vi.mock("@/components/ui/json-input", () => ({
JsonInput: MockJsonInput,
}));
12 changes: 6 additions & 6 deletions ui-v2/tests/variables/variables.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,14 @@ describe("Variables page", () => {

await user.click(screen.getByRole("button", { name: "Add Variable" }));
await user.type(screen.getByLabelText("Name"), "my-variable");
await userEvent.type(screen.getByTestId("mock-codemirror"), "123");
await userEvent.type(screen.getByTestId("mock-json-input"), "123");
await user.click(
screen.getByRole("button", { name: "Close", expanded: true }),
);
await user.click(screen.getByRole("button", { name: "Add Variable" }));

expect(screen.getByLabelText("Name")).toHaveValue("");
expect(screen.getByTestId("mock-codemirror")).toHaveValue("");
expect(screen.getByTestId("mock-json-input")).toHaveValue("");
});

it("should allow adding a variable", async () => {
Expand All @@ -98,7 +98,7 @@ describe("Variables page", () => {
await user.click(screen.getByRole("button", { name: "Add Variable" }));
expect(screen.getByText("New Variable")).toBeVisible();
await user.type(screen.getByLabelText("Name"), "my-variable");
await userEvent.type(screen.getByTestId("mock-codemirror"), "123");
await userEvent.type(screen.getByTestId("mock-json-input"), "123");
await userEvent.type(screen.getByLabelText("Tags"), "tag1");
await user.click(screen.getByRole("button", { name: "Create" }));

Expand Down Expand Up @@ -129,7 +129,7 @@ describe("Variables page", () => {
// Value validation error
await user.type(screen.getByLabelText("Name"), "my-variable");
await userEvent.type(
screen.getByTestId("mock-codemirror"),
screen.getByTestId("mock-json-input"),
"{{Invalid JSON",
);
await user.click(screen.getByRole("button", { name: "Create" }));
Expand Down Expand Up @@ -160,7 +160,7 @@ describe("Variables page", () => {

await user.click(screen.getByRole("button", { name: "Add Variable" }));
await user.type(screen.getByLabelText("Name"), "my-variable");
await userEvent.type(screen.getByTestId("mock-codemirror"), "123");
await userEvent.type(screen.getByTestId("mock-json-input"), "123");
await user.click(screen.getByRole("button", { name: "Create" }));
expect(screen.getByText("Failed to create variable")).toBeVisible();
});
Expand Down Expand Up @@ -189,7 +189,7 @@ describe("Variables page", () => {

await user.click(screen.getByRole("button", { name: "Add Variable" }));
await user.type(screen.getByLabelText("Name"), "my-variable");
await userEvent.type(screen.getByTestId("mock-codemirror"), "123");
await userEvent.type(screen.getByTestId("mock-json-input"), "123");
await user.click(screen.getByRole("button", { name: "Create" }));

expect(
Expand Down
Loading