feat(webapp): admin editor for org batch rate limit

Author: isshaddad

.server-changes/admin-back-office-batch-rate-limit.md

@@ -0,0 +1,6 @@
+---
+area: webapp
+type: feature
+---
+
+Admin back office: edit an organization's batch rate limit (`batchRateLimitConfig`) from the org page, alongside the existing API rate limit editor. The rate-limit form UI is now shared between the API and batch sections.

apps/webapp/app/components/admin/backOffice/BatchRateLimitSection.server.ts

@@ -0,0 +1,55 @@
+import { prisma } from "~/db.server";
+import { env } from "~/env.server";
+import { logger } from "~/services/logger.server";
+import { type Duration } from "~/services/rateLimiter.server";
+import { BATCH_RATE_LIMIT_INTENT } from "./BatchRateLimitSection";
+import {
+  handleRateLimitAction,
+  resolveEffectiveRateLimit,
+  type RateLimitActionResult,
+  type RateLimitDomain,
+} from "./RateLimitSection.server";
+import type { EffectiveRateLimit } from "./RateLimitSection";
+
+export const batchRateLimitDomain: RateLimitDomain = {
+  intent: BATCH_RATE_LIMIT_INTENT,
+  systemDefault: () => ({
+    type: "tokenBucket",
+    refillRate: env.BATCH_RATE_LIMIT_REFILL_RATE,
+    interval: env.BATCH_RATE_LIMIT_REFILL_INTERVAL as Duration,
+    maxTokens: env.BATCH_RATE_LIMIT_MAX,
+  }),
+  apply: async (orgId, next, adminUserId) => {
+    const existing = await prisma.organization.findFirst({
+      where: { id: orgId },
+      select: { batchRateLimitConfig: true },
+    });
+    if (!existing) {
+      throw new Response(null, { status: 404 });
+    }
+    await prisma.organization.update({
+      where: { id: orgId },
+      data: { batchRateLimitConfig: next as any },
+    });
+    logger.info("admin.backOffice.batchRateLimit", {
+      adminUserId,
+      orgId,
+      previous: existing.batchRateLimitConfig,
+      next,
+    });
+  },
+};
+
+export function resolveEffectiveBatchRateLimit(
+  override: unknown
+): EffectiveRateLimit {
+  return resolveEffectiveRateLimit(override, batchRateLimitDomain);
+}
+
+export function handleBatchRateLimitAction(
+  formData: FormData,
+  orgId: string,
+  adminUserId: string
+): Promise<RateLimitActionResult> {
+  return handleRateLimitAction(formData, orgId, adminUserId, batchRateLimitDomain);
+}

apps/webapp/app/components/admin/backOffice/BatchRateLimitSection.tsx

@@ -0,0 +1,26 @@
+import {
+  RateLimitSection,
+  type EffectiveRateLimit,
+} from "./RateLimitSection";
+
+export const BATCH_RATE_LIMIT_INTENT = "set-batch-rate-limit";
+export const BATCH_RATE_LIMIT_SAVED_VALUE = "batch-rate-limit";
+
+type FieldErrors = Record<string, string[] | undefined> | null;
+
+type Props = {
+  effective: EffectiveRateLimit;
+  errors: FieldErrors;
+  savedJustNow: boolean;
+  isSubmitting: boolean;
+};
+
+export function BatchRateLimitSection(props: Props) {
+  return (
+    <RateLimitSection
+      title="Batch rate limit"
+      intent={BATCH_RATE_LIMIT_INTENT}
+      {...props}
+    />
+  );
+}

apps/webapp/app/routes/admin.back-office.orgs.$orgId.tsx

@@ -7,21 +7,30 @@ import {
   useTypedActionData,
   useTypedLoaderData,
 } from "remix-typedjson";
+import {
+  API_RATE_LIMIT_INTENT,
+  API_RATE_LIMIT_SAVED_VALUE,
+  ApiRateLimitSection,
+} from "~/components/admin/backOffice/ApiRateLimitSection";
+import {
+  handleApiRateLimitAction,
+  resolveEffectiveApiRateLimit,
+} from "~/components/admin/backOffice/ApiRateLimitSection.server";
+import {
+  BATCH_RATE_LIMIT_INTENT,
+  BATCH_RATE_LIMIT_SAVED_VALUE,
+  BatchRateLimitSection,
+} from "~/components/admin/backOffice/BatchRateLimitSection";
+import {
+  handleBatchRateLimitAction,
+  resolveEffectiveBatchRateLimit,
+} from "~/components/admin/backOffice/BatchRateLimitSection.server";
 import {
   MAX_PROJECTS_INTENT,
   MAX_PROJECTS_SAVED_VALUE,
   MaxProjectsSection,
 } from "~/components/admin/backOffice/MaxProjectsSection";
 import { handleMaxProjectsAction } from "~/components/admin/backOffice/MaxProjectsSection.server";
-import {
-  RATE_LIMIT_INTENT,
-  RATE_LIMIT_SAVED_VALUE,
-  RateLimitSection,
-} from "~/components/admin/backOffice/RateLimitSection";
-import {
-  handleRateLimitAction,
-  resolveEffectiveRateLimit,
-} from "~/components/admin/backOffice/RateLimitSection.server";
 import { LinkButton } from "~/components/primitives/Buttons";
 import { CopyableText } from "~/components/primitives/CopyableText";
 import { Header1 } from "~/components/primitives/Headers";
@@ -50,6 +59,7 @@ export async function loader({ request, params }: LoaderFunctionArgs) {
       title: true,
       createdAt: true,
       apiRateLimiterConfig: true,
+      batchRateLimitConfig: true,
       maximumProjectCount: true,
     },
   });
@@ -58,9 +68,12 @@ export async function loader({ request, params }: LoaderFunctionArgs) {
     throw new Response(null, { status: 404 });
   }
 
-  const effective = resolveEffectiveRateLimit(org.apiRateLimiterConfig);
+  const apiEffective = resolveEffectiveApiRateLimit(org.apiRateLimiterConfig);
+  const batchEffective = resolveEffectiveBatchRateLimit(
+    org.batchRateLimitConfig
+  );
 
-  return typedjson({ org, effective });
+  return typedjson({ org, apiEffective, batchEffective });
 }
 
 export async function action({ request, params }: ActionFunctionArgs) {
@@ -90,16 +103,29 @@ export async function action({ request, params }: ActionFunctionArgs) {
     );
   }
 
-  if (intent === RATE_LIMIT_INTENT) {
-    const result = await handleRateLimitAction(formData, orgId, user.id);
+  if (intent === API_RATE_LIMIT_INTENT) {
+    const result = await handleApiRateLimitAction(formData, orgId, user.id);
     if (!result.ok) {
       return typedjson(
-        { section: RATE_LIMIT_SAVED_VALUE, errors: result.errors },
+        { section: API_RATE_LIMIT_SAVED_VALUE, errors: result.errors },
         { status: 400 }
       );
     }
     return redirect(
-      `/admin/back-office/orgs/${orgId}?${SAVED_QUERY_KEY}=${RATE_LIMIT_SAVED_VALUE}`
+      `/admin/back-office/orgs/${orgId}?${SAVED_QUERY_KEY}=${API_RATE_LIMIT_SAVED_VALUE}`
+    );
+  }
+
+  if (intent === BATCH_RATE_LIMIT_INTENT) {
+    const result = await handleBatchRateLimitAction(formData, orgId, user.id);
+    if (!result.ok) {
+      return typedjson(
+        { section: BATCH_RATE_LIMIT_SAVED_VALUE, errors: result.errors },
+        { status: 400 }
+      );
+    }
+    return redirect(
+      `/admin/back-office/orgs/${orgId}?${SAVED_QUERY_KEY}=${BATCH_RATE_LIMIT_SAVED_VALUE}`
     );
   }
 
@@ -110,7 +136,8 @@ export async function action({ request, params }: ActionFunctionArgs) {
 }
 
 export default function BackOfficeOrgPage() {
-  const { org, effective } = useTypedLoaderData<typeof loader>();
+  const { org, apiEffective, batchEffective } =
+    useTypedLoaderData<typeof loader>();
   const actionData = useTypedActionData<typeof action>();
   const navigation = useNavigation();
   const isSubmitting = navigation.state !== "idle";
@@ -154,10 +181,17 @@ export default function BackOfficeOrgPage() {
         </LinkButton>
       </div>
 
-      <RateLimitSection
-        effective={effective}
-        errors={errorSection === RATE_LIMIT_SAVED_VALUE ? errors : null}
-        savedJustNow={savedSection === RATE_LIMIT_SAVED_VALUE}
+      <ApiRateLimitSection
+        effective={apiEffective}
+        errors={errorSection === API_RATE_LIMIT_SAVED_VALUE ? errors : null}
+        savedJustNow={savedSection === API_RATE_LIMIT_SAVED_VALUE}
+        isSubmitting={isSubmitting}
+      />
+
+      <BatchRateLimitSection
+        effective={batchEffective}
+        errors={errorSection === BATCH_RATE_LIMIT_SAVED_VALUE ? errors : null}
+        savedJustNow={savedSection === BATCH_RATE_LIMIT_SAVED_VALUE}
         isSubmitting={isSubmitting}
       />