feat: Rate limit deletion (#3638)

Author: juliusgeo

api-contracts/openapi/paths/rate-limits/rate_limits.yaml

@@ -67,3 +67,41 @@ withTenant:
     summary: List rate limits
     tags:
       - Rate Limits
+  delete:
+    x-resources: ["tenant"]
+    description: Delete a rate limit for a tenant.
+    operationId: rate-limit:delete
+    parameters:
+      - description: The tenant id
+        in: path
+        name: tenant
+        required: true
+        schema:
+          type: string
+          format: uuid
+          minLength: 36
+          maxLength: 36
+      - description: The limit key
+        in: query
+        name: key
+        required: true
+        schema:
+          type: string
+    responses:
+      "204":
+        description: Successfully deleted the rate limit
+      "400":
+        content:
+          application/json:
+            schema:
+              $ref: "../../components/schemas/_index.yaml#/APIErrors"
+        description: A malformed or bad request
+      "403":
+        content:
+          application/json:
+            schema:
+              $ref: "../../components/schemas/_index.yaml#/APIErrors"
+        description: Forbidden
+    summary: Delete rate limit
+    tags:
+      - Rate Limits

api/v1/server/authz/rbac.yaml

@@ -66,6 +66,7 @@ roles:
       - SnsDelete
       - StepRunListEvents
       - RateLimitList
+      - RateLimitDelete
       - WorkflowVersionGet
       - TenantGetPrometheusMetrics
       - EventUpdateCancel

api/v1/server/handlers/rate-limits/delete.go

@@ -0,0 +1,25 @@
+package rate_limits
+
+import (
+	"context"
+	"time"
+
+	"github.com/labstack/echo/v4"
+
+	"github.com/hatchet-dev/hatchet/api/v1/server/oas/apierrors"
+	"github.com/hatchet-dev/hatchet/api/v1/server/oas/gen"
+	"github.com/hatchet-dev/hatchet/pkg/repository/sqlcv1"
+)
+
+func (t *RateLimitService) RateLimitDelete(ctx echo.Context, request gen.RateLimitDeleteRequestObject) (gen.RateLimitDeleteResponseObject, error) {
+	tenant := ctx.Get("tenant").(*sqlcv1.Tenant)
+	tenantId := tenant.ID
+	key := request.Params.Key
+	dbCtx, cancel := context.WithTimeout(ctx.Request().Context(), 30*time.Second)
+	defer cancel()
+	err := t.config.V1.RateLimit().DeleteRateLimits(dbCtx, tenantId, key)
+	if err != nil {
+		return gen.RateLimitDelete400JSONResponse(apierrors.NewAPIErrors("failed to delete rate-limit")), nil
+	}
+	return gen.RateLimitDelete204Response{}, nil
+}

api/v1/server/oas/gen/openapi.gen.go

@@ -2311,6 +2311,31 @@ export class Api<
       ...params,
       xResources: ["tenant"],
     }), { resources: new Set<string>(["tenant"]) });
+  /**
+   * @description Delete a rate limit for a tenant.
+   *
+   * @tags Rate Limits
+   * @name RateLimitDelete
+   * @summary Delete rate limit
+   * @request DELETE:/api/v1/tenants/{tenant}/rate-limits
+   * @secure
+   */
+  rateLimitDelete = Object.assign((
+    tenant: string,
+    query: {
+      /** The limit key */
+      key: string;
+    },
+    params: RequestParams = {},
+  ) =>
+    this.request<void, APIErrors>({
+      path: `/api/v1/tenants/${tenant}/rate-limits`,
+      method: "DELETE",
+      query: query,
+      secure: true,
+      ...params,
+      xResources: ["tenant"],
+    }), { resources: new Set<string>(["tenant"]) });
   /**
    * @description Gets a list of tenant members
    *

frontend/app/src/lib/api/generated/Api.ts

@@ -1,6 +1,7 @@
 import { LimitIndicator } from '../../tenant-settings/resource-limits/components/resource-limit-columns';
 import { RateLimitWithMetadata } from '../hooks/use-rate-limits';
 import { DataTableColumnHeader } from '@/components/v1/molecules/data-table/data-table-column-header';
+import { TableRowActions } from '@/components/v1/molecules/data-table/data-table-row-actions';
 import RelativeDate from '@/components/v1/molecules/relative-date';
 import { capitalize } from '@/lib/utils';
 import { ColumnDef } from '@tanstack/react-table';
@@ -11,6 +12,7 @@ export const RateLimitColumn = {
   limit: 'Limit',
   lastRefill: 'Last Refill',
   window: 'Window',
+  actions: 'Actions',
 };
 
 type RateLimitColumnKeys = keyof typeof RateLimitColumn;
@@ -20,8 +22,13 @@ const valueKey: RateLimitColumnKeys = 'value';
 const limitKey: RateLimitColumnKeys = 'limit';
 const lastRefillKey: RateLimitColumnKeys = 'lastRefill';
 const windowKey: RateLimitColumnKeys = 'window';
+const actionsKey: RateLimitColumnKeys = 'actions';
 
-export const columns: ColumnDef<RateLimitWithMetadata>[] = [
+export const columns = ({
+  onDeleteClick,
+}: {
+  onDeleteClick: (row: RateLimitWithMetadata) => void;
+}): ColumnDef<RateLimitWithMetadata>[] => [
   {
     accessorKey: keyKey,
     header: ({ column }) => (
@@ -87,4 +94,25 @@ export const columns: ColumnDef<RateLimitWithMetadata>[] = [
     },
     enableSorting: false,
   },
+  {
+    accessorKey: actionsKey,
+    header: ({ column }) => (
+      <DataTableColumnHeader column={column} title={RateLimitColumn.actions} />
+    ),
+    cell: ({ row }) => (
+      <div className="flex flex-row justify-center">
+        <TableRowActions
+          row={row.original}
+          actions={[
+            {
+              label: 'Delete',
+              onClick: () => onDeleteClick(row.original),
+            },
+          ]}
+        />
+      </div>
+    ),
+    enableSorting: false,
+    enableHiding: false,
+  },
 ];

frontend/app/src/pages/main/v1/rate-limits/components/rate-limit-columns.tsx

@@ -4,19 +4,26 @@ import {
   RateLimitColumn,
 } from './components/rate-limit-columns';
 import { useRateLimits } from './hooks/use-rate-limits';
+import { RateLimitWithMetadata } from './hooks/use-rate-limits';
 import { DocsButton } from '@/components/v1/docs/docs-button';
 import { DataTable } from '@/components/v1/molecules/data-table/data-table';
 import { ToolbarType } from '@/components/v1/molecules/data-table/data-table-toolbar';
+import { useCurrentTenantId } from '@/hooks/use-tenant';
+import api from '@/lib/api';
 import { docsPages } from '@/lib/generated/docs';
+import { useApiError } from '@/lib/hooks';
+import { useMutation } from '@tanstack/react-query';
 import { VisibilityState } from '@tanstack/react-table';
-import { useState } from 'react';
+import { useMemo, useState } from 'react';
 
 export default function RateLimits() {
   return <RateLimitsTable />;
 }
 
 function RateLimitsTable() {
   const [columnVisibility, setColumnVisibility] = useState<VisibilityState>({});
+  const { tenantId } = useCurrentTenantId();
+  const { handleApiError } = useApiError({});
 
   const {
     data,
@@ -33,11 +40,25 @@ function RateLimitsTable() {
     resetFilters,
   } = useRateLimits({ key: 'rate-limits-table' });
 
+  const deleteMutation = useMutation({
+    mutationKey: ['rate-limit:delete', tenantId],
+    mutationFn: async (row: RateLimitWithMetadata) => {
+      await api.rateLimitDelete(tenantId, { key: row.key });
+    },
+    onSuccess: () => refetch(),
+    onError: handleApiError,
+  });
+
+  const tableColumns = useMemo(
+    () => columns({ onDeleteClick: (row) => deleteMutation.mutate(row) }),
+    [deleteMutation],
+  );
+
   return (
     <DataTable
       error={error}
       isLoading={isLoading}
-      columns={columns}
+      columns={tableColumns}
       data={data}
       filters={[
         {