fix: Settings page runbooks #242
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| "use client"; | ||
|
|
||
| import type { UseFormReturn } from "react-hook-form"; | ||
| import { z } from "zod"; | ||
|
|
||
| import * as SCHEMA from "@ctrlplane/db/schema"; | ||
| import { Button } from "@ctrlplane/ui/button"; | ||
| import { | ||
| Form, | ||
| FormControl, | ||
| FormField, | ||
| FormItem, | ||
| FormLabel, | ||
| FormMessage, | ||
| FormRootError, | ||
| } from "@ctrlplane/ui/form"; | ||
| import { Input } from "@ctrlplane/ui/input"; | ||
| import { Textarea } from "@ctrlplane/ui/textarea"; | ||
|
|
||
| import { JobAgentConfig } from "~/components/form/job-agent/JobAgentConfig"; | ||
| import { JobAgentSelector } from "~/components/form/job-agent/JobAgentSelector"; | ||
| import { RunbookVariablesEditor } from "./create/RunbookVariableEditor"; | ||
|
|
||
| export const updateRunbookSchema = z.object({ | ||
| name: z.string().min(1), | ||
| description: z.string(), | ||
| variables: z.array(SCHEMA.createRunbookVariable), | ||
| jobAgentId: z.string().uuid({ message: "Must be a valid job agent ID" }), | ||
| jobAgentConfig: z.record(z.any()), | ||
| }); | ||
|
Comment on lines
+24
to
+30
There was a problem hiding this comment. 🛠️ Refactor suggestion Strengthen type safety for jobAgentConfig validation The current schema uses Example improvement: - jobAgentConfig: z.record(z.any()),
+ jobAgentConfig: z.record(z.union([
+ z.string(),
+ z.number(),
+ z.boolean(),
+ z.array(z.string()),
+ // Add other specific types based on your agent configurations
+ ])),
|
||
|
|
||
| export type EditRunbookFormSchema = z.infer<typeof updateRunbookSchema>; | ||
|
|
||
| export type EditRunbookFormProps = { | ||
| form: UseFormReturn<EditRunbookFormSchema>; | ||
| jobAgents: SCHEMA.JobAgent[]; | ||
| jobAgent?: SCHEMA.JobAgent; | ||
| workspace: SCHEMA.Workspace; | ||
| onSubmit: (data: EditRunbookFormSchema) => void; | ||
| }; | ||
|
|
||
| export const EditRunbookForm: React.FC<EditRunbookFormProps> = ({ | ||
| form, | ||
| jobAgents, | ||
| jobAgent, | ||
| workspace, | ||
| onSubmit, | ||
| }) => ( | ||
| <Form {...form}> | ||
| <form onSubmit={form.handleSubmit(onSubmit)} className="space-y-8"> | ||
| <div className="space-y-3"> | ||
| <div>General</div> | ||
| <FormField | ||
| control={form.control} | ||
| name="name" | ||
| render={({ field }) => ( | ||
| <FormItem> | ||
| <FormLabel>Name</FormLabel> | ||
| <FormControl> | ||
| <Input | ||
| placeholder="Deploy Hotfix, Rollback Release, Scale Service..." | ||
| {...field} | ||
| /> | ||
| </FormControl> | ||
| <FormMessage /> | ||
| </FormItem> | ||
| )} | ||
| /> | ||
| <FormField | ||
| control={form.control} | ||
| name="description" | ||
| render={({ field }) => ( | ||
| <FormItem> | ||
| <FormLabel>Description</FormLabel> | ||
| <FormControl> | ||
| <Textarea | ||
| placeholder="Describe the purpose of this runbook..." | ||
| {...field} | ||
| /> | ||
| </FormControl> | ||
| <FormMessage /> | ||
| </FormItem> | ||
| )} | ||
| /> | ||
| </div> | ||
|
|
||
| <div className="space-y-3"> | ||
| <div>Variables</div> | ||
|
|
||
| <div className="text-sm text-muted-foreground"> | ||
| Variables in runbooks make automation flexible and reusable. They let | ||
| you customize runbooks with user inputs and use environment-specific | ||
| values without hardcoding. This allows runbooks to adapt to different | ||
| scenarios without changing their core logic. | ||
| </div> | ||
|
|
||
| <FormField | ||
| control={form.control} | ||
| name="variables" | ||
| render={({ field }) => ( | ||
| <FormItem> | ||
| <FormControl> | ||
| <RunbookVariablesEditor | ||
| value={field.value} | ||
| onChange={field.onChange} | ||
| /> | ||
| </FormControl> | ||
| <FormMessage /> | ||
| </FormItem> | ||
| )} | ||
| /> | ||
| </div> | ||
|
|
||
| <div className="space-y-3"> | ||
| <div>Agent</div> | ||
|
|
||
| <FormField | ||
| control={form.control} | ||
| name="jobAgentId" | ||
| render={({ field: { value, onChange } }) => ( | ||
| <FormItem> | ||
| <FormLabel>Job Agent</FormLabel> | ||
| <FormControl> | ||
| <JobAgentSelector | ||
| jobAgents={jobAgents} | ||
| workspace={workspace} | ||
| value={value} | ||
| onChange={onChange} | ||
| /> | ||
| </FormControl> | ||
| <FormMessage /> | ||
| </FormItem> | ||
| )} | ||
| /> | ||
|
|
||
| <FormField | ||
| control={form.control} | ||
| name="jobAgentConfig" | ||
| render={({ field: { value, onChange } }) => ( | ||
| <FormItem> | ||
| <FormLabel>Config</FormLabel> | ||
| <FormControl> | ||
| <JobAgentConfig | ||
| jobAgent={jobAgent} | ||
| workspace={workspace} | ||
| value={value} | ||
| onChange={onChange} | ||
| /> | ||
| </FormControl> | ||
| <FormMessage /> | ||
| </FormItem> | ||
| )} | ||
| /> | ||
| </div> | ||
|
|
||
| <Button type="submit">Save</Button> | ||
| <FormRootError /> | ||
| </form> | ||
| </Form> | ||
| ); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Add error handling to the form submission
The promise chain should include error handling and user feedback for a better user experience.
Consider this improvement:
const onSubmit = (data: EditRunbookFormSchema) => update .mutateAsync({ id: runbook.id, data }) .then(() => router.refresh()) - .then(() => setOpen(false)); + .then(() => { + setOpen(false); + // Consider adding a success toast/notification here + }) + .catch((error) => { + console.error('Failed to update runbook:', error); + // Consider adding an error toast/notification here + });