Skip to content

fix: Shared form for policy drawer #263

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

fix: Shared form for policy drawer #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac0ced9
init
adityachoudhari26 Dec 11, 2024
a75b838
changes
adityachoudhari26 Dec 12, 2024
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
234 changes: 99 additions & 135 deletions ...app/[workspaceSlug]/(app)/_components/environment-policy-drawer/ApprovalAndGovernance.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
import type * as SCHEMA from "@ctrlplane/db/schema";
import React from "react";
import { z } from "zod";

import { Button } from "@ctrlplane/ui/button";
import {
Form,
FormControl,
FormDescription,
FormField,
FormItem,
FormLabel,
useForm,
} from "@ctrlplane/ui/form";
import { Input } from "@ctrlplane/ui/input";
import { RadioGroup, RadioGroupItem } from "@ctrlplane/ui/radio-group";
Expand All @@ -22,143 +17,112 @@ import {
SelectValue,
} from "@ctrlplane/ui/select";

import { api } from "~/trpc/react";

const schema = z.object({
approvalRequirement: z.enum(["automatic", "manual"]),
successType: z.enum(["all", "some", "optional"]),
successMinimum: z.number().min(0, "Must be a positive number"),
});
import type { PolicyFormSchema } from "./PolicyFormSchema";

export const ApprovalAndGovernance: React.FC<{
environmentPolicy: SCHEMA.EnvironmentPolicy;
}> = ({ environmentPolicy }) => {
const form = useForm({ schema, defaultValues: { ...environmentPolicy } });
form: PolicyFormSchema;
}> = ({ form }) => {
const { successMinimum } = form.watch();

const updatePolicy = api.environment.policy.update.useMutation();
const utils = api.useUtils();

const { id, systemId } = environmentPolicy;
const onSubmit = form.handleSubmit((data) =>
updatePolicy
.mutateAsync({ id, data })
.then(() => form.reset(data))
.then(() => utils.environment.policy.byId.invalidate(id))
.then(() => utils.environment.policy.bySystemId.invalidate(systemId)),
);

return (
<Form {...form}>
<form onSubmit={onSubmit} className="space-y-10 p-2">
<div className="flex flex-col gap-1">
<h1 className="text-lg font-medium">Approval & Governance</h1>
<span className="text-sm text-muted-foreground">
This category defines policies that govern the oversight and
approval process for deployments. These policies ensure that
deployments meet specific criteria or gain necessary approvals
before proceeding, contributing to compliance, quality assurance,
and overall governance of the deployment process.
</span>
</div>

<FormField
control={form.control}
name="approvalRequirement"
render={({ field: { value, onChange } }) => (
<FormItem className="space-y-4">
<div className="flex flex-col gap-1">
<FormLabel>Approval gates</FormLabel>
<FormDescription>
If enabled, a release will require approval from an authorized
user before it can be deployed to any environment with this
policy.
</FormDescription>
</div>
<FormControl>
<div className="w-32">
<Select value={value} onValueChange={onChange}>
<SelectTrigger>
<SelectValue />
</SelectTrigger>
<SelectContent>
<SelectItem value="manual">Manual</SelectItem>
<SelectItem value="automatic">Automatic</SelectItem>
</SelectContent>
</Select>
</div>
</FormControl>
</FormItem>
)}
/>
<div className="space-y-10 p-2">
<div className="flex flex-col gap-1">
<h1 className="text-lg font-medium">Approval & Governance</h1>
<span className="text-sm text-muted-foreground">
This category defines policies that govern the oversight and approval
process for deployments. These policies ensure that deployments meet
specific criteria or gain necessary approvals before proceeding,
contributing to compliance, quality assurance, and overall governance
of the deployment process.
</span>
</div>

<FormField
control={form.control}
name="successType"
render={({ field: { value, onChange } }) => (
<FormItem className="space-y-4">
<div className="flex flex-col gap-1">
<FormLabel>Previous Deploy Status</FormLabel>
<FormDescription>
Specify a minimum number of resources in dependent
environments to successfully be deployed to before triggering
a release. For example, specifying that all resources in QA
must be deployed to before releasing to PROD.
</FormDescription>
<FormField
control={form.control}
name="approvalRequirement"
render={({ field: { value, onChange } }) => (
<FormItem className="space-y-4">
<div className="flex flex-col gap-1">
<FormLabel>Approval gates</FormLabel>
<FormDescription>
If enabled, a release will require approval from an authorized
user before it can be deployed to any environment with this
policy.
</FormDescription>
</div>
<FormControl>
<div className="w-32">
<Select value={value} onValueChange={onChange}>
<SelectTrigger>
<SelectValue />
</SelectTrigger>
<SelectContent>
<SelectItem value="manual">Manual</SelectItem>
<SelectItem value="automatic">Automatic</SelectItem>
</SelectContent>
</Select>
</div>
<FormControl>
<RadioGroup value={value} onValueChange={onChange}>
<FormItem className="flex items-center space-x-3 space-y-0">
<FormControl>
<RadioGroupItem value="all" />
</FormControl>
<FormLabel className="flex items-center gap-2 font-normal">
All resources in dependent environments must complete
successfully
</FormLabel>
</FormItem>
<FormItem className="flex items-center space-x-3 space-y-0">
<FormControl>
<RadioGroupItem value="some" />
</FormControl>
<FormLabel className="flex items-center gap-2 font-normal">
A minimum of{" "}
<Input
disabled={value !== "some"}
type="number"
value={successMinimum}
onChange={(e) =>
form.setValue(
"successMinimum",
e.target.valueAsNumber,
)
}
className="border-b-1 h-6 w-16 text-xs"
/>
resources must be successfully deployed to
</FormLabel>
</FormItem>
<FormItem className="flex items-center space-x-3 space-y-0">
<FormControl>
<RadioGroupItem value="optional" />
</FormControl>
<FormLabel className="flex items-center gap-2 font-normal">
No validation required
</FormLabel>
</FormItem>
</RadioGroup>
</FormControl>
</FormItem>
)}
/>
</FormControl>
</FormItem>
)}
/>

<Button
type="submit"
disabled={form.formState.isSubmitting || !form.formState.isDirty}
>
Save
</Button>
</form>
</Form>
<FormField
control={form.control}
name="successType"
render={({ field: { value, onChange } }) => (
<FormItem className="space-y-4">
<div className="flex flex-col gap-1">
<FormLabel>Previous Deploy Status</FormLabel>
<FormDescription>
Specify a minimum number of resources in dependent environments
to successfully be deployed to before triggering a release. For
example, specifying that all resources in QA must be deployed to
before releasing to PROD.
</FormDescription>
</div>
<FormControl>
<RadioGroup value={value} onValueChange={onChange}>
<FormItem className="flex items-center space-x-3 space-y-0">
<FormControl>
<RadioGroupItem value="all" />
</FormControl>
<FormLabel className="flex items-center gap-2 font-normal">
All resources in dependent environments must complete
successfully
</FormLabel>
</FormItem>
<FormItem className="flex items-center space-x-3 space-y-0">
<FormControl>
<RadioGroupItem value="some" />
</FormControl>
<FormLabel className="flex items-center gap-2 font-normal">
A minimum of{" "}
<Input
disabled={value !== "some"}
type="number"
value={successMinimum}
onChange={(e) =>
form.setValue("successMinimum", e.target.valueAsNumber)
}
className="border-b-1 h-6 w-16 text-xs"
/>
Comment on lines +101 to +109
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add validation for the success minimum input.

The number input directly sets the form value without any validation. Consider:

  1. Adding min/max constraints
  2. Handling invalid number inputs
  3. Using form's field registration instead of direct setValue
 <Input
   disabled={value !== "some"}
   type="number"
+  min={1}
   value={successMinimum}
-  onChange={(e) =>
-    form.setValue("successMinimum", e.target.valueAsNumber)
-  }
+  {...form.register("successMinimum", {
+    valueAsNumber: true,
+    min: { value: 1, message: "Minimum must be at least 1" }
+  })}
   className="border-b-1 h-6 w-16 text-xs"
 />
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<Input
disabled={value !== "some"}
type="number"
value={successMinimum}
onChange={(e) =>
form.setValue("successMinimum", e.target.valueAsNumber)
}
className="border-b-1 h-6 w-16 text-xs"
/>
<Input
disabled={value !== "some"}
type="number"
min={1}
value={successMinimum}
{...form.register("successMinimum", {
valueAsNumber: true,
min: { value: 1, message: "Minimum must be at least 1" }
})}
className="border-b-1 h-6 w-16 text-xs"
/>

resources must be successfully deployed to
</FormLabel>
</FormItem>
<FormItem className="flex items-center space-x-3 space-y-0">
<FormControl>
<RadioGroupItem value="optional" />
</FormControl>
<FormLabel className="flex items-center gap-2 font-normal">
No validation required
</FormLabel>
</FormItem>
</RadioGroup>
</FormControl>
</FormItem>
)}
/>
</div>
);
};
Loading
Loading