fix: prevent logging the retry message many times

Author: angeloashmore

src/Client.ts

@@ -8,6 +8,7 @@ import { findRefByLabel } from "./lib/findRefByLabel"
 import { getPreviewCookie } from "./lib/getPreviewCookie"
 import { minifyGraphQLQuery } from "./lib/minifyGraphQLQuery"
 import { someTagsFilter } from "./lib/someTagsFilter"
+import { throttledLog } from "./lib/throttledLog"
 import { typeFilter } from "./lib/typeFilter"
 
 import type { Query } from "./types/api/query"
@@ -1737,8 +1738,9 @@ export class Client<
 
 			const badRef = new URL(url).searchParams.get("ref")
 			const issue = error instanceof RefNotFoundError ? "invalid" : "expired"
-			console.warn(
-				`The ref (${badRef}) was ${issue}. Now retrying with the latest master ref (${masterRef}). If you were previewing content, the response will not include draft content.`,
+			throttledLog(
+				`[@prismicio/client] The ref (${badRef}) was ${issue}. Now retrying with the latest master ref (${masterRef}). If you were previewing content, the response will not include draft content.`,
+				{ level: "warn" },
 			)
 
 			return await this._get({ ...params, ref: masterRef }, attemptCount + 1)

src/lib/throttledLog.ts

@@ -0,0 +1,39 @@
+const THROTTLE_THRESHOLD_MS = 5000
+
+let lastMessage: string | undefined
+let lastCalledAt = 0
+
+/**
+ * Logs a message. If the message is identical the immediate previous logged
+ * message and that message was logged within 5 seconds of the current call, the
+ * log is ignored. This throttle behavior prevents identical messages from
+ * flodding the console.
+ *
+ * @param message - A message to log.
+ * @param config - Configuration for the log.
+ */
+export const throttledLog = (
+	message: string,
+	config: {
+		/**
+		 * The log level. Matches the global `console` log levels.
+		 */
+		level?: "log" | "warn" | "error"
+	} = {},
+): void => {
+	const { level = "log" } = config
+
+	lastCalledAt = Date.now()
+
+	if (
+		message === lastMessage &&
+		Date.now() - lastCalledAt < THROTTLE_THRESHOLD_MS
+	) {
+		return
+	}
+
+	lastMessage = message
+
+	// eslint-disable-next-line no-console
+	console[level](message)
+}

test/__testutils__/testInvalidRefRetry.ts

@@ -167,4 +167,45 @@ export const testInvalidRefRetry = (args: TestInvalidRefRetryArgs): void => {
 
 		expect(triedRefs.size).toBe(3)
 	})
+
+	it("throttles log", async (ctx) => {
+		const client = createTestClient({ ctx })
+		const badRef = ctx.mock.api.ref().ref
+
+		mockPrismicRestAPIV2({ ctx })
+
+		const endpoint = new URL(
+			"documents/search",
+			`${client.documentAPIEndpoint}/`,
+		).toString()
+		let attempts = 0
+		ctx.server.use(
+			rest.get(endpoint, (_req, res, ctx) => {
+				if (attempts < 2) {
+					attempts++
+
+					// We purposely return the bad ref again
+					// to force a loop.
+					return res(
+						ctx.json({
+							type: "api_notfound_error",
+							message: `Master ref is: ${badRef}`,
+						}),
+						ctx.status(404),
+					)
+				}
+			}),
+		)
+
+		const consoleWarnSpy = vi
+			.spyOn(console, "warn")
+			.mockImplementation(() => void 0)
+		await args.run(client, { ref: badRef })
+
+		// The client should make two attemps but only log once.
+		expect(attempts).toBe(2)
+		expect(consoleWarnSpy).toHaveBeenCalledTimes(1)
+
+		consoleWarnSpy.mockRestore()
+	})
 }