feat(webhooks): make admin webhooks view-only via enable_actions flag#1754
Open
Shreyag02 wants to merge 1 commit into
Open
feat(webhooks): make admin webhooks view-only via enable_actions flag#1754Shreyag02 wants to merge 1 commit into
Shreyag02 wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📝 WalkthroughSummary by CodeRabbit
WalkthroughChangesWebhook action gating
Estimated code review effort: 3 (Moderate) | ~20 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 0445ed10-2956-4c1c-b75a-211d48b2d3bf
📒 Files selected for processing (7)
pkg/server/config.gopkg/server/server.goweb/apps/admin/configs.dev.jsonweb/apps/admin/src/pages/webhooks/WebhooksPage.tsxweb/apps/admin/src/utils/constants.tsweb/sdk/admin/views/webhooks/webhooks/columns.tsxweb/sdk/admin/views/webhooks/webhooks/index.tsx
Comment on lines
+30
to
+88
| const actionColumn: DataTableColumnDef<Webhook, unknown> = { | ||
| header: "Action", | ||
| accessorKey: "id", | ||
| classNames: { cell: styles.actionColumn, header: styles.actionColumn }, | ||
| cell: ({ getValue, row }) => { | ||
| const ActionCell = () => { | ||
| const [isDeleteDialogOpen, setIsDeleteDialogOpen] = useState(false); | ||
| const webhookId = getValue() as string; | ||
| const webhook = row.original; | ||
|
|
||
| return ( | ||
| <> | ||
| {/* @ts-ignore */} | ||
| <Menu style={{ padding: "0 !important" }}> | ||
| <Menu.Trigger | ||
| render={<DotsVerticalIcon style={{ cursor: "pointer" }} />} | ||
| /> | ||
| <Menu.Content> | ||
| <Menu.Group style={{ padding: 0 }}> | ||
| <Menu.Item style={{ padding: 0 }}> | ||
| <Flex | ||
| style={{ padding: "12px" }} | ||
| gap={3} | ||
| data-test-id="admin-webhook-update-btn" | ||
| onClick={() => openEditPage(webhookId)} | ||
| > | ||
| <UpdateIcon /> | ||
| Update | ||
| </Flex> | ||
| </Menu.Item> | ||
| <Menu.Item style={{ padding: 0 }}> | ||
| <Flex | ||
| className={styles.deleteMenuItem} | ||
| gap={3} | ||
| data-test-id="admin-webhook-delete-btn" | ||
| onClick={() => setIsDeleteDialogOpen(true)} | ||
| > | ||
| <TrashIcon /> | ||
| Delete | ||
| </Flex> | ||
| </Menu.Item> | ||
| </Menu.Group> | ||
| </Menu.Content> | ||
| </Menu> | ||
|
|
||
| <DeleteWebhookDialog | ||
| isOpen={isDeleteDialogOpen} | ||
| onOpenChange={setIsDeleteDialogOpen} | ||
| webhookId={webhookId} | ||
| webhookDescription={webhook.description} | ||
| deleteWebhookMutation={deleteWebhookMutation} | ||
| /> | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
| return <ActionCell />; | ||
| }, | ||
| }; |
Contributor
There was a problem hiding this comment.
🩺 Stability & Availability | 🟠 Major | ⚡ Quick win
ActionCell defined inside cell causes state loss on re-renders.
ActionCell is declared as a function component inside the cell callback. Every table re-render (data refetch, sort, filter) creates a new function reference, so React unmounts and remounts the component — discarding isDeleteDialogOpen and the Menu's open state. The delete dialog and action menu will close unexpectedly mid-interaction.
Extract ActionCell outside getColumns so its identity is stable:
♻️ Proposed fix
+interface ActionCellProps {
+ getValue: () => unknown;
+ row: { original: Webhook };
+ openEditPage: (id: string) => void;
+ deleteWebhookMutation: ReturnType<typeof useMutation>;
+}
+
+function ActionCell({
+ getValue,
+ row,
+ openEditPage,
+ deleteWebhookMutation,
+}: ActionCellProps) {
+ const [isDeleteDialogOpen, setIsDeleteDialogOpen] = useState(false);
+ const webhookId = getValue() as string;
+ const webhook = row.original;
+
+ return (
+ <>
+ {/* `@ts-ignore` */}
+ <Menu style={{ padding: "0 !important" }}>
+ <Menu.Trigger
+ render={<DotsVerticalIcon style={{ cursor: "pointer" }} />}
+ />
+ <Menu.Content>
+ <Menu.Group style={{ padding: 0 }}>
+ <Menu.Item style={{ padding: 0 }}>
+ <Flex
+ style={{ padding: "12px" }}
+ gap={3}
+ data-test-id="admin-webhook-update-btn"
+ onClick={() => openEditPage(webhookId)}
+ >
+ <UpdateIcon />
+ Update
+ </Flex>
+ </Menu.Item>
+ <Menu.Item style={{ padding: 0 }}>
+ <Flex
+ className={styles.deleteMenuItem}
+ gap={3}
+ data-test-id="admin-webhook-delete-btn"
+ onClick={() => setIsDeleteDialogOpen(true)}
+ >
+ <TrashIcon />
+ Delete
+ </Flex>
+ </Menu.Item>
+ </Menu.Group>
+ </Menu.Content>
+ </Menu>
+
+ <DeleteWebhookDialog
+ isOpen={isDeleteDialogOpen}
+ onOpenChange={setIsDeleteDialogOpen}
+ webhookId={webhookId}
+ webhookDescription={webhook.description}
+ deleteWebhookMutation={deleteWebhookMutation}
+ />
+ </>
+ );
+}
+
export const getColumns: (
opt: getColumnsOptions,
) => DataTableColumnDef<Webhook, unknown>[] = ({ openEditPage, deleteWebhookMutation, enableActions }) => {
const actionColumn: DataTableColumnDef<Webhook, unknown> = {
header: "Action",
accessorKey: "id",
classNames: { cell: styles.actionColumn, header: styles.actionColumn },
- cell: ({ getValue, row }) => {
- const ActionCell = () => {
- const [isDeleteDialogOpen, setIsDeleteDialogOpen] = useState(false);
- const webhookId = getValue() as string;
- const webhook = row.original;
-
- return (
- <>
- {/* `@ts-ignore` */}
- <Menu style={{ padding: "0 !important" }}>
- <Menu.Trigger
- render={<DotsVerticalIcon style={{ cursor: "pointer" }} />}
- />
- <Menu.Content>
- <Menu.Group style={{ padding: 0 }}>
- <Menu.Item style={{ padding: 0 }}>
- <Flex
- style={{ padding: "12px" }}
- gap={3}
- data-test-id="admin-webhook-update-btn"
- onClick={() => openEditPage(webhookId)}
- >
- <UpdateIcon />
- Update
- </Flex>
- </Menu.Item>
- <Menu.Item style={{ padding: 0 }}>
- <Flex
- className={styles.deleteMenuItem}
- gap={3}
- data-test-id="admin-webhook-delete-btn"
- onClick={() => setIsDeleteDialogOpen(true)}
- >
- <TrashIcon />
- Delete
- </Flex>
- </Menu.Item>
- </Menu.Group>
- </Menu.Content>
- </Menu>
-
- <DeleteWebhookDialog
- isOpen={isDeleteDialogOpen}
- onOpenChange={setIsDeleteDialogOpen}
- webhookId={webhookId}
- webhookDescription={webhook.description}
- deleteWebhookMutation={deleteWebhookMutation}
- />
- </>
- );
- };
-
- return <ActionCell />;
- },
+ cell: ({ getValue, row }) => (
+ <ActionCell
+ getValue={getValue}
+ row={row}
+ openEditPage={openEditPage}
+ deleteWebhookMutation={deleteWebhookMutation}
+ />
+ ),
};
return [📝 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
| const actionColumn: DataTableColumnDef<Webhook, unknown> = { | |
| header: "Action", | |
| accessorKey: "id", | |
| classNames: { cell: styles.actionColumn, header: styles.actionColumn }, | |
| cell: ({ getValue, row }) => { | |
| const ActionCell = () => { | |
| const [isDeleteDialogOpen, setIsDeleteDialogOpen] = useState(false); | |
| const webhookId = getValue() as string; | |
| const webhook = row.original; | |
| return ( | |
| <> | |
| {/* @ts-ignore */} | |
| <Menu style={{ padding: "0 !important" }}> | |
| <Menu.Trigger | |
| render={<DotsVerticalIcon style={{ cursor: "pointer" }} />} | |
| /> | |
| <Menu.Content> | |
| <Menu.Group style={{ padding: 0 }}> | |
| <Menu.Item style={{ padding: 0 }}> | |
| <Flex | |
| style={{ padding: "12px" }} | |
| gap={3} | |
| data-test-id="admin-webhook-update-btn" | |
| onClick={() => openEditPage(webhookId)} | |
| > | |
| <UpdateIcon /> | |
| Update | |
| </Flex> | |
| </Menu.Item> | |
| <Menu.Item style={{ padding: 0 }}> | |
| <Flex | |
| className={styles.deleteMenuItem} | |
| gap={3} | |
| data-test-id="admin-webhook-delete-btn" | |
| onClick={() => setIsDeleteDialogOpen(true)} | |
| > | |
| <TrashIcon /> | |
| Delete | |
| </Flex> | |
| </Menu.Item> | |
| </Menu.Group> | |
| </Menu.Content> | |
| </Menu> | |
| <DeleteWebhookDialog | |
| isOpen={isDeleteDialogOpen} | |
| onOpenChange={setIsDeleteDialogOpen} | |
| webhookId={webhookId} | |
| webhookDescription={webhook.description} | |
| deleteWebhookMutation={deleteWebhookMutation} | |
| /> | |
| </> | |
| ); | |
| }; | |
| return <ActionCell />; | |
| }, | |
| }; | |
| interface ActionCellProps { | |
| getValue: () => unknown; | |
| row: { original: Webhook }; | |
| openEditPage: (id: string) => void; | |
| deleteWebhookMutation: ReturnType<typeof useMutation>; | |
| } | |
| function ActionCell({ | |
| getValue, | |
| row, | |
| openEditPage, | |
| deleteWebhookMutation, | |
| }: ActionCellProps) { | |
| const [isDeleteDialogOpen, setIsDeleteDialogOpen] = useState(false); | |
| const webhookId = getValue() as string; | |
| const webhook = row.original; | |
| return ( | |
| <> | |
| {/* `@ts-ignore` */} | |
| <Menu style={{ padding: "0 !important" }}> | |
| <Menu.Trigger | |
| render={<DotsVerticalIcon style={{ cursor: "pointer" }} />} | |
| /> | |
| <Menu.Content> | |
| <Menu.Group style={{ padding: 0 }}> | |
| <Menu.Item style={{ padding: 0 }}> | |
| <Flex | |
| style={{ padding: "12px" }} | |
| gap={3} | |
| data-test-id="admin-webhook-update-btn" | |
| onClick={() => openEditPage(webhookId)} | |
| > | |
| <UpdateIcon /> | |
| Update | |
| </Flex> | |
| </Menu.Item> | |
| <Menu.Item style={{ padding: 0 }}> | |
| <Flex | |
| className={styles.deleteMenuItem} | |
| gap={3} | |
| data-test-id="admin-webhook-delete-btn" | |
| onClick={() => setIsDeleteDialogOpen(true)} | |
| > | |
| <TrashIcon /> | |
| Delete | |
| </Flex> | |
| </Menu.Item> | |
| </Menu.Group> | |
| </Menu.Content> | |
| </Menu> | |
| <DeleteWebhookDialog | |
| isOpen={isDeleteDialogOpen} | |
| onOpenChange={setIsDeleteDialogOpen} | |
| webhookId={webhookId} | |
| webhookDescription={webhook.description} | |
| deleteWebhookMutation={deleteWebhookMutation} | |
| /> | |
| </> | |
| ); | |
| } | |
| export const getColumns: ( | |
| opt: getColumnsOptions, | |
| ) => DataTableColumnDef<Webhook, unknown>[] = ({ | |
| openEditPage, | |
| deleteWebhookMutation, | |
| enableActions, | |
| }) => { | |
| const actionColumn: DataTableColumnDef<Webhook, unknown> = { | |
| header: "Action", | |
| accessorKey: "id", | |
| classNames: { cell: styles.actionColumn, header: styles.actionColumn }, | |
| cell: ({ getValue, row }) => ( | |
| <ActionCell | |
| getValue={getValue} | |
| row={row} | |
| openEditPage={openEditPage} | |
| deleteWebhookMutation={deleteWebhookMutation} | |
| /> | |
| ), | |
| }; |
Coverage Report for CI Build 29269745070Coverage decreased (-0.002%) to 44.874%Details
Uncovered Changes
Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Makes the admin console Webhooks page view-only by default. All write actions (create, update, delete) are now gated behind a single config flag, so full CRUD can be restored later by flipping one value — no code changes or redeploy of the app bundle required.
This addresses the decision to hide webhook editing in the admin UI rather than enable delete.
Changes
enable_actionsflag that gates all webhook write actions together (New Webhook button, create/update drawers, and the row Action menu with Update + Delete).enable_deletegate onWebhooksViewwith the broaderenableActionsprop./configsresponse; defaults tofalse(view-only).enable_deleteon both frontend and backend for backward compatibility — onlyenable_actionsis read now.Technical Details
web/sdk/admin/views/webhooks/webhooks/):WebhooksViewnow takesenableActions. Whenfalse, the New Webhook button, create/update drawers, and the Action column are not rendered (the column is simply omitted from the table).WebhooksPage.tsx): readsconfig?.webhooks?.enable_actions ?? false. The?? falseguard means an older backend (or missing config) safely falls back to view-only.constants.ts,configs.dev.json): addedenable_actions(defaultfalse) alongsideenable_delete.pkg/server/config.go,server.go): addedEnableActionstoWebhooksConfigand the/configsresponse.ui.webhooks.enable_actions: true(envFRONTIER_SERVICE_UI_WEBHOOKS_ENABLE_ACTIONS=true) in the deployment.Test Plan
enable_actions: true.tsc+ Vite production build, SDK build, andgo build/go vetall clean.SQL Safety (if your PR touches
*_repository.goorgoqu.*)N/A