feat(request): add flag to disable logging api warnings (#925)

* feat(request): add flag to disable logging api warnings

* feat(client): only log x-sanity-warnings once

src/defineCreateClient.ts

@@ -38,17 +38,19 @@ export default function defineCreateClientExports<
   // Set the http client to use for requests, and its environment specific middleware
   const defaultRequester = defineHttpRequest(envMiddleware)
 
-  const createClient = (config: ClientConfigType) =>
-    new ClassConstructor(
+  const createClient = (config: ClientConfigType) => {
+    const clientRequester = defineHttpRequest(envMiddleware)
+    return new ClassConstructor(
       (options, requester) =>
-        (requester || defaultRequester)({
+        (requester || clientRequester)({
           maxRedirects: 0,
           maxRetries: config.maxRetries,
           retryDelay: config.retryDelay,
           ...options,
         } as Any),
       config,
     )
+  }
 
   return {requester: defaultRequester, createClient}
 }

src/http/request.ts

@@ -17,21 +17,28 @@ const httpError = {
   },
 }
 
-const printWarnings = {
-  onResponse: (res: Any) => {
-    const warn = res.headers['x-sanity-warning']
-    const warnings = Array.isArray(warn) ? warn : [warn]
-    warnings.filter(Boolean).forEach((msg) => console.warn(msg)) // eslint-disable-line no-console
-    return res
-  },
+function printWarnings() {
+  const seen: Record<string, boolean> = {}
+  return {
+    onResponse: (res: Any) => {
+      const warn = res.headers['x-sanity-warning']
+      const warnings = Array.isArray(warn) ? warn : [warn]
+      for (const msg of warnings) {
+        if (!msg || seen[msg]) continue
+        seen[msg] = true
+        console.warn(msg) // eslint-disable-line no-console
+      }
+      return res
+    },
+  }
 }
 
 /** @internal */
 export function defineHttpRequest(envMiddleware: Middlewares): Requester {
   return getIt([
     retry({shouldRetry}),
     ...envMiddleware,
-    printWarnings,
+    printWarnings(),
     jsonRequest(),
     jsonResponse(),
     progress(),

test/warnings.test.ts

@@ -41,4 +41,27 @@ describe('Client config warnings', async () => {
     await createClient({projectId: 'abc123', useCdn: true, apiVersion: '1'}).users.getById('me')
     expect(warn).toHaveBeenCalledWith('Friction endures')
   })
+
+  test.skipIf(isEdge)('only warns once', async () => {
+    expect.assertions(2)
+
+    const {default: nock} = await import('nock')
+
+    nock('https://abc123.api.sanity.io')
+      .get('/v1/users/me')
+      .times(2)
+      .reply(200, {}, {'X-Sanity-Warning': 'Friction endures'})
+
+    const client = createClient({
+      projectId: 'abc123',
+      useCdn: true,
+      apiVersion: '1',
+    })
+
+    await client.users.getById('me')
+    await client.users.getById('me')
+
+    expect(warn).toHaveBeenCalledWith('Friction endures')
+    expect(warn).toHaveBeenCalledTimes(1)
+  })
 })