-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(4732): send Webhook request on create events
- Loading branch information
Showing
7 changed files
with
161 additions
and
105 deletions.
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
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
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,66 @@ | ||
| import { zodResolver } from '@hookform/resolvers/zod'; | ||
| import { Box, Button, LoadingOverlay } from '@mantine/core'; | ||
| import _get from 'lodash-es/get'; | ||
| import { useState } from 'react'; | ||
| import { FormProvider, useForm } from 'react-hook-form'; | ||
| import FormErrorNotification from '@/components/generic/FormErrorNotification'; | ||
| import { success, failure } from '@/components/notification'; | ||
| import { | ||
| getPrivateCloudProductWebhook, | ||
| upsertPrivateCloudProductWebhook, | ||
| } from '@/services/backend/private-cloud/webhooks'; | ||
| import { cn } from '@/utils/js'; | ||
| import { privateCloudProductWebhookBodySchema } from '@/validation-schemas'; | ||
| import Webhooks from './Webhooks'; | ||
|
|
||
| export default function FormWebhooks({ | ||
| disabled, | ||
| licencePlate, | ||
| className, | ||
| }: { | ||
| disabled: boolean; | ||
| licencePlate: string; | ||
| className?: string; | ||
| }) { | ||
| const [loading, setLoading] = useState(true); | ||
| const methods = useForm({ | ||
| resolver: zodResolver(privateCloudProductWebhookBodySchema), | ||
| defaultValues: async () => { | ||
| const result = await getPrivateCloudProductWebhook(licencePlate); | ||
| setLoading(false); | ||
| return result; | ||
| }, | ||
| }); | ||
|
|
||
| return ( | ||
| <div className={cn(className)}> | ||
| <Box pos={'relative'}> | ||
| <LoadingOverlay | ||
| visible={loading} | ||
| zIndex={1000} | ||
| overlayProps={{ radius: 'sm', blur: 2 }} | ||
| loaderProps={{ color: 'pink', type: 'bars' }} | ||
| /> | ||
| <FormProvider {...methods}> | ||
| <FormErrorNotification /> | ||
| <form | ||
| onSubmit={methods.handleSubmit(async (formData) => { | ||
| const result = await upsertPrivateCloudProductWebhook(licencePlate, formData); | ||
| if (result) { | ||
| success({ title: 'Webhook', message: 'Updated!' }); | ||
| } else { | ||
| failure({ title: 'Webhook', message: 'Failed to update!' }); | ||
| } | ||
| })} | ||
| autoComplete="off" | ||
| > | ||
| <Webhooks disabled={disabled} /> | ||
| <Button variant="success" type="submit" className="mt-1"> | ||
| Update | ||
| </Button> | ||
| </form> | ||
| </FormProvider> | ||
| </Box> | ||
| </div> | ||
| ); | ||
| } |
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 |
|---|---|---|
| @@ -1,116 +1,77 @@ | ||
| import { zodResolver } from '@hookform/resolvers/zod'; | ||
| import { Code, Button } from '@mantine/core'; | ||
| import { Code } from '@mantine/core'; | ||
| import { RequestType } from '@prisma/client'; | ||
| import _get from 'lodash-es/get'; | ||
| import { FormProvider, useForm } from 'react-hook-form'; | ||
| import ExternalLink from '@/components/generic/button/ExternalLink'; | ||
| import FormErrorNotification from '@/components/generic/FormErrorNotification'; | ||
| import HookFormTextInput from '@/components/generic/input/HookFormTextInput'; | ||
| import { success, failure } from '@/components/notification'; | ||
| import { | ||
| getPrivateCloudProductWebhook, | ||
| upsertPrivateCloudProductWebhook, | ||
| } from '@/services/backend/private-cloud/webhooks'; | ||
| import { cn } from '@/utils/js'; | ||
| import { privateCloudProductWebhookBodySchema } from '@/validation-schemas'; | ||
|
|
||
| export default function Webhooks({ | ||
| disabled, | ||
| licencePlate, | ||
| className, | ||
| }: { | ||
| disabled: boolean; | ||
| licencePlate: string; | ||
| className?: string; | ||
| }) { | ||
| const methods = useForm({ | ||
| resolver: zodResolver(privateCloudProductWebhookBodySchema), | ||
| defaultValues: async () => getPrivateCloudProductWebhook(licencePlate), | ||
| }); | ||
|
|
||
| export default function Webhooks({ disabled, className }: { disabled: boolean; className?: string }) { | ||
| return ( | ||
| <div className={cn(className)}> | ||
| <FormProvider {...methods}> | ||
| <FormErrorNotification /> | ||
| <form | ||
| onSubmit={methods.handleSubmit(async (formData) => { | ||
| const result = await upsertPrivateCloudProductWebhook(licencePlate, formData); | ||
| if (result) { | ||
| success({ title: 'Webhook', message: 'Updated!' }); | ||
| } else { | ||
| failure({ title: 'Webhook', message: 'Failed to update!' }); | ||
| } | ||
| })} | ||
| autoComplete="off" | ||
| > | ||
| <p> | ||
| We will send a <span className="font-semibold">POST</span> request to the URL below with the following data | ||
| in <span className="font-semibold">JSON</span> format when the requests are provisioned and completed. | ||
| </p> | ||
| <Code block>{`{ | ||
| "action": "<create | update | delete>", | ||
| <p> | ||
| We will send a <span className="font-semibold">POST</span> request to the URL below with the following data in{' '} | ||
| <span className="font-semibold">JSON</span> format when the requests are provisioned and completed. | ||
| </p> | ||
| <Code block>{`{ | ||
| "action": "<${RequestType.CREATE} | ${RequestType.EDIT} | ${RequestType.DELETE}>", | ||
| "product": { | ||
| "id": "<this product's ID>", | ||
| "licencePlate": "<this product's licencePlate>" | ||
| } | ||
| }`}</Code> | ||
| <h3 className="font-semibold mt-2">Validation Mechanism</h3> | ||
| <ul className="list-disc pl-8"> | ||
| <li> | ||
| <span className="font-semibold">x-hub-signature:</span> An HTTP header commonly used in webhook | ||
| implementations to ensure the authenticity and integrity of incoming requests. It is widely utilized in | ||
| webhooks provided by platforms like GitHub, GitLab, and others. Refer to{' '} | ||
| <ExternalLink href="https://docs.github.com/en/webhooks/using-webhooks/validating-webhook-deliveries"> | ||
| GitHub's documentation on validating webhook deliveries | ||
| </ExternalLink>{' '} | ||
| for details on validation logic. | ||
| <br />- Provide the <span className="font-semibold">Secret</span> below to use this mechanism. | ||
| </li> | ||
| <li> | ||
| <span className="font-semibold">Basic Authentication:</span> A simple and widely used method for a client | ||
| to authenticate itself to a server. It involves sending a username and password encoded in Base64 in the | ||
| <code>Authorization</code> header of an HTTP request. Ensure the use of HTTPS to securely transmit | ||
| credentials. | ||
| <br />- Provide the <span className="font-semibold">Username</span> and{' '} | ||
| <span className="font-semibold">Password</span> below to use this mechanism. | ||
| </li> | ||
| </ul> | ||
| <h3 className="font-semibold mt-2">Validation Mechanism</h3> | ||
| <ul className="list-disc pl-8"> | ||
| <li> | ||
| <span className="font-semibold">x-hub-signature:</span> An HTTP header commonly used in webhook | ||
| implementations to ensure the authenticity and integrity of incoming requests. It is widely utilized in | ||
| webhooks provided by platforms like GitHub, GitLab, and others. Refer to{' '} | ||
| <ExternalLink href="https://docs.github.com/en/webhooks/using-webhooks/validating-webhook-deliveries"> | ||
| GitHub's documentation on validating webhook deliveries | ||
| </ExternalLink>{' '} | ||
| for details on validation logic. | ||
| <br />- Provide the <span className="font-semibold">Secret</span> below to use this mechanism. | ||
| </li> | ||
| <li> | ||
| <span className="font-semibold">Basic Authentication:</span> A simple and widely used method for a client to | ||
| authenticate itself to a server. It involves sending a username and password encoded in Base64 in the | ||
| <code>Authorization</code> header of an HTTP request. Ensure the use of HTTPS to securely transmit | ||
| credentials. | ||
| <br />- Provide the <span className="font-semibold">Username</span> and{' '} | ||
| <span className="font-semibold">Password</span> below to use this mechanism. | ||
| </li> | ||
| </ul> | ||
|
|
||
| <HookFormTextInput | ||
| label="URL" | ||
| name="url" | ||
| placeholder="Enter Webhook URL" | ||
| disabled={disabled} | ||
| error="Please provide a valid HTTPS URL" | ||
| classNames={{ wrapper: 'col-span-full mt-2' }} | ||
| /> | ||
| <HookFormTextInput | ||
| label="Secret" | ||
| name="secret" | ||
| placeholder="Enter Webhook Secret" | ||
| disabled={disabled} | ||
| classNames={{ wrapper: 'col-span-full mt-2' }} | ||
| /> | ||
| <div className="flex justify-between gap-2 mt-2"> | ||
| <HookFormTextInput | ||
| label="Username" | ||
| name="username" | ||
| placeholder="Enter Webhook Username" | ||
| disabled={disabled} | ||
| classNames={{ wrapper: 'w-1/2' }} | ||
| /> | ||
| <HookFormTextInput | ||
| label="Password" | ||
| name="password" | ||
| placeholder="Enter Webhook Password" | ||
| disabled={disabled} | ||
| classNames={{ wrapper: 'w-1/2' }} | ||
| /> | ||
| </div> | ||
| <Button variant="success" type="submit" className="mt-1"> | ||
| Update | ||
| </Button> | ||
| </form> | ||
| </FormProvider> | ||
| <HookFormTextInput | ||
| label="URL" | ||
| name="url" | ||
| placeholder="Enter Webhook URL" | ||
| disabled={disabled} | ||
| error="Please provide a valid HTTPS URL" | ||
| classNames={{ wrapper: 'col-span-full mt-2' }} | ||
| /> | ||
| <HookFormTextInput | ||
| label="Secret" | ||
| name="secret" | ||
| placeholder="Enter Webhook Secret" | ||
| disabled={disabled} | ||
| classNames={{ wrapper: 'col-span-full mt-2' }} | ||
| /> | ||
| <div className="flex justify-between gap-2 mt-2"> | ||
| <HookFormTextInput | ||
| label="Username" | ||
| name="username" | ||
| placeholder="Enter Webhook Username" | ||
| disabled={disabled} | ||
| classNames={{ wrapper: 'w-1/2' }} | ||
| /> | ||
| <HookFormTextInput | ||
| label="Password" | ||
| name="password" | ||
| placeholder="Enter Webhook Password" | ||
| disabled={disabled} | ||
| classNames={{ wrapper: 'w-1/2' }} | ||
| /> | ||
| </div> | ||
| </div> | ||
| ); | ||
| } |
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