AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.
fix(frontend): log a repeating client request failure once per 10 seconds (#14761)
Reinier van der Leer8b948201b789
diff --git a/autogpt_platform/frontend/src/app/api/mutators/__tests__/request-failure-log.test.ts b/autogpt_platform/frontend/src/app/api/mutators/__tests__/request-failure-log.test.tsnew file mode 100644index 0000000000..693f26d56b--- /dev/null+++ b/autogpt_platform/frontend/src/app/api/mutators/__tests__/request-failure-log.test.ts@@ -0,0 +1,106 @@+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";++import {+ logClientRequestFailure,+ resetClientRequestFailureLog,+} from "../request-failure-log";++const base = {+ method: "GET",+ url: "/api/credits/subscription",+ errorMessage: "Backend sent no response within 30000ms",+ responseData: null,+};++describe("logClientRequestFailure", () => {+ beforeEach(() => {+ vi.useFakeTimers();+ vi.spyOn(console, "error").mockImplementation(() => {});+ vi.spyOn(console, "warn").mockImplementation(() => {});+ });++ afterEach(() => {+ resetClientRequestFailureLog();+ vi.useRealTimers();+ vi.restoreAllMocks();+ });++ it("logs the first failure and suppresses repeats of the same method, url and status", () => {+ for (let i = 0; i < 12; i++) {+ logClientRequestFailure({ ...base, status: 504 });+ }++ expect(console.error).toHaveBeenCalledTimes(1);+ expect(console.error).toHaveBeenCalledWith(+ "Request failed on client",+ expect.objectContaining({ status: 504, url: base.url }),+ );+ });++ it("reports how many were suppressed once the window closes", () => {+ logClientRequestFailure({ ...base, status: 504 });+ logClientRequestFailure({ ...base, status: 504 });+ logClientRequestFailure({ ...base, status: 504 });++ expect(console.error).toHaveBeenCalledTimes(1);+ vi.advanceTimersByTime(10_000);++ expect(console.error).toHaveBeenCalledTimes(2);+ expect(console.error).toHaveBeenLastCalledWith(+ "Request failed on client ×3 in the last 10s",+ expect.objectContaining({ status: 504, url: base.url }),+ );+ expect(console.warn).not.toHaveBeenCalled();+ });++ it("reports suppressed expected failures at warn", () => {+ logClientRequestFailure({ ...base, status: 404 });+ logClientRequestFailure({ ...base, status: 404 });+ vi.advanceTimersByTime(10_000);++ expect(console.warn).toHaveBeenLastCalledWith(+ "Request failed on client ×2 in the last 10s",+ expect.objectContaining({ status: 404, url: base.url }),+ );+ expect(console.error).not.toHaveBeenCalled();+ });++ it("says nothing extra when the failure happened once", () => {+ logClientRequestFailure({ ...base, status: 504 });+ vi.advanceTimersByTime(10_000);++ expect(console.warn).not.toHaveBeenCalled();+ });++ it("logs again once the window has passed", () => {+ logClientRequestFailure({ ...base, status: 504 });+ vi.advanceTimersByTime(10_001);+ logClientRequestFailure({ ...base, status: 504 });++ expect(console.error).toHaveBeenCalledTimes(2);+ });++ it("keeps a different status, url or method visible", () => {+ logClientRequestFailure({ ...base, status: 504 });+ logClientRequestFailure({ ...base, status: 500 });+ logClientRequestFailure({ ...base, status: 504, url: "/api/other" });+ logClientRequestFailure({ ...base, status: 504, method: "POST" });++ expect(console.error).toHaveBeenCalledTimes(4);+ });++ it("warns rather than errors on the statuses the app asks for and handles", () => {+ logClientRequestFailure({ ...base, status: 401 });+ logClientRequestFailure({ ...base, status: 403 });+ logClientRequestFailure({ ...base, status: 404 });++ expect(console.error).not.toHaveBeenCalled();+ expect(console.warn).toHaveBeenCalledTimes(3);+ });++ it("keeps a malformed request an error", () => {+ logClientRequestFailure({ ...base, status: 422 });++ expect(console.error).toHaveBeenCalledTimes(1);+ });+});diff --git a/autogpt_platform/frontend/src/app/api/mutators/custom-mutator.ts b/autogpt_platform/frontend/src/app/api/mutators/custom-mutator.tsindex ca3de60ce5..f22bc0d386 100644--- a/autogpt_platform/frontend/src/app/api/mutators/custom-mutator.ts+++ b/autogpt_platform/frontend/src/app/api/mutators/custom-mutator.ts@@ -9,6 +9,7 @@ import { getSystemHeaders } from "@/lib/impersonation";import { getDatafastAttribution } from "@/services/analytics/datafast-attribution";import { environment } from "@/services/environment";import { transformDates } from "./date-transformer";+import { logClientRequestFailure } from "./request-failure-log";function getBaseURL(): string {if (!environment.isServerSide()) {@@ -158,16 +159,24 @@ export const customMutator = async <response.statusText ||`HTTP ${response.status}`;- console.error(- `Request failed ${environment.isServerSide() ? "on server" : "on client"}`,- {- status: response.status,- method,- url: fullUrl.replace(baseUrl, ""), // Show relative URL for cleaner logs- errorMessage,+ const failure = {+ status: response.status,+ method,+ url: fullUrl.replace(baseUrl, ""), // Show relative URL for cleaner logs+ errorMessage,+ responseData,+ };++ if (environment.isServerSide()) {+ // Server-side module state is shared across every user's request, so+ // collapsing there would hide one user's failure behind another's.+ console.error("Request failed on server", {+ ...failure,responseData: responseData || "No response data",- },- );+ });+ } else {+ logClientRequestFailure(failure);+ }throw new ApiError(errorMessage, response.status, responseData);}diff --git a/autogpt_platform/frontend/src/app/api/mutators/request-failure-log.ts b/autogpt_platform/frontend/src/app/api/mutators/request-failure-log.tsnew file mode 100644index 0000000000..2c58bed92a--- /dev/null+++ b/autogpt_platform/frontend/src/app/api/mutators/request-failure-log.ts@@ -0,0 +1,79 @@+interface RequestFailure {+ status: number;+ method: string;+ url: string;+ errorMessage: string;+ responseData: unknown;+}++// A failing endpoint is usually polled or retried, so the same failure lands in+// the console many times a minute on top of the browser's own network line.+const DEDUPE_WINDOW_MS = 10_000;++/**+ * Log one client-side request failure, collapsing repeats of the same+ * (method, url, status) into a single line plus a count.+ */+export function logClientRequestFailure(failure: RequestFailure) {+ const key = `${failure.method} ${failure.url} ${failure.status}`;+ const open = openWindows.get(key);++ if (open) {+ open.suppressed += 1;+ return;+ }++ emit(failure);+ openWindows.set(key, {+ suppressed: 0,+ timer: setTimeout(() => {+ const closed = openWindows.get(key);+ openWindows.delete(key);+ if (closed?.suppressed) {+ logAtSeverityOf(failure.status)(+ `Request failed on client ×${closed.suppressed + 1} in the last ${DEDUPE_WINDOW_MS / 1000}s`,+ { status: failure.status, method: failure.method, url: failure.url },+ );+ }+ }, DEDUPE_WINDOW_MS),+ });+}++// The open windows outlive a test file; reset them between cases.+export function resetClientRequestFailureLog() {+ openWindows.forEach(({ timer }) => clearTimeout(timer));+ openWindows.clear();+}++interface OpenWindow {+ suppressed: number;+ timer: ReturnType<typeof setTimeout>;+}++const openWindows = new Map<string, OpenWindow>();++// Statuses the app asks for and handles: an unauthenticated read of a gated+// resource, a permission the user does not have, an optional resource that is+// absent. A 4xx that means the request itself was wrong (400, 422) and every+// 5xx stay errors.+const EXPECTED_STATUSES = new Set([401, 403, 404]);++function emit({+ status,+ method,+ url,+ errorMessage,+ responseData,+}: RequestFailure) {+ logAtSeverityOf(status)("Request failed on client", {+ status,+ method,+ url,+ errorMessage,+ responseData: responseData || "No response data",+ });+}++function logAtSeverityOf(status: number) {+ return EXPECTED_STATUSES.has(status) ? console.warn : console.error;+}