@sanity/client 6.20.1 → 6.20.2-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/client",
-  "version": "6.20.1",
+  "version": "6.20.2-beta.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
     "sanity",

package/src/data/listen.ts

@@ -1,5 +1,6 @@
 import {Observable} from 'rxjs'
 
+import {domainSharder as sharder} from '../http/domainSharding'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {Any, ListenEvent, ListenOptions, ListenParams, MutationEvent} from '../types'
 import defaults from '../util/defaults'
@@ -64,7 +65,11 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
   const listenOpts = pick(options, possibleOptions)
   const qs = encodeQueryString({query, params, options: {tag, ...listenOpts}})
 
-  const uri = `${url}${_getDataUrl(this, 'listen', qs)}`
+  let uri = `${url}${_getDataUrl(this, 'listen', qs)}`
+  if (this.config().useDomainSharding) {
+    uri = sharder.getShardedUrl(uri)
+  }
+
   if (uri.length > MAX_URL_LENGTH) {
     return new Observable((observer) => observer.error(new Error('Query too large for listener')))
   }
@@ -91,6 +96,12 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
     // Once it is`true`, it will never be `false` again.
     let unsubscribed = false
 
+    // We're about to connect, and will reuse the same shard/bucket for every reconnect henceforth.
+    // This may seem inoptimal, but once connected we should just consider this as a "permanent"
+    // connection, since we'll automatically retry on failures/disconnects. Once we explicitly
+    // unsubsccribe, we can decrement the bucket and free up the shard.
+    sharder.incrementBucketForUrl(uri)
+
     open()
 
     function onError() {
@@ -187,6 +198,7 @@ export function _listen<R extends Record<string, Any> = Record<string, Any>>(
       stopped = true
       unsubscribe()
       unsubscribed = true
+      sharder.decrementBucketForUrl(uri)
     }
 
     return stop

package/src/defineCreateClient.ts

@@ -33,6 +33,7 @@ export default function defineCreateClientExports<
           maxRedirects: 0,
           maxRetries: config.maxRetries,
           retryDelay: config.retryDelay,
+          useDomainSharding: config.useDomainSharding,
           ...options,
         } as Any),
       config,

package/src/http/browserMiddleware.ts

@@ -1 +1,3 @@
-export default []
+import {domainSharder} from './domainSharding'
+
+export default [domainSharder.middleware]

package/src/http/domainSharding.ts

@@ -0,0 +1,96 @@
+import type {Middleware, RequestOptions} from 'get-it'
+
+const UNSHARDED_URL_RE = /^https:\/\/([a-z0-9]+)\.api\.(sanity\..*)/
+const SHARDED_URL_RE = /^https:\/\/[a-z0-9]+\.api\.s(\d+)\.sanity\.(.*)/
+
+/**
+ * Get a default sharding implementation where buckets are reused across instances.
+ * Helps prevent the case when multiple clients are instantiated, each having their
+ * own state of which buckets are least used.
+ */
+export const domainSharder = getDomainSharder()
+
+/**
+ * @internal
+ */
+export function getDomainSharder(initialBuckets?: number[]) {
+  const buckets: number[] = initialBuckets || new Array(10).fill(0, 0)
+
+  function incrementBucketForUrl(url: string) {
+    const shard = getShardFromUrl(url)
+    if (shard !== null) {
+      buckets[shard]++
+    }
+  }
+
+  function decrementBucketForUrl(url: string) {
+    const shard = getShardFromUrl(url)
+    if (shard !== null) {
+      buckets[shard]--
+    }
+  }
+
+  function getShardedUrl(url: string): string {
+    const [isMatch, projectId, rest] = url.match(UNSHARDED_URL_RE) || []
+    if (!isMatch) {
+      return url
+    }
+
+    // Find index of bucket with fewest requests
+    const bucket = buckets.reduce(
+      (smallest, count, index) => (count < buckets[smallest] ? index : smallest),
+      0,
+    )
+
+    return `https://${projectId}.api.s${bucket}.${rest}`
+  }
+
+  function getShardFromUrl(url: string): number | null {
+    const [isMatch, shard] = url.match(SHARDED_URL_RE) || []
+    return isMatch ? parseInt(shard, 10) : null
+  }
+
+  const middleware = {
+    processOptions: (options: {useDomainSharding?: boolean; url: string}) => {
+      if (!useDomainSharding(options)) {
+        return options
+      }
+
+      const url = getShardedUrl(options.url)
+      options.url = url
+
+      return options
+    },
+
+    onRequest(req: {
+      options: Partial<RequestOptions> & {useDomainSharding?: boolean; url: string}
+    }) {
+      if (useDomainSharding(req.options)) {
+        incrementBucketForUrl(req.options.url)
+      }
+      return req
+    },
+
+    onResponse(
+      res,
+      context: {options: Partial<RequestOptions> & {useDomainSharding?: boolean; url: string}},
+    ) {
+      if (useDomainSharding(context.options)) {
+        decrementBucketForUrl(context.options.url)
+      }
+      return res
+    },
+  } satisfies Middleware
+
+  return {
+    middleware,
+    incrementBucketForUrl,
+    decrementBucketForUrl,
+    getShardedUrl,
+    getBuckets: () => buckets,
+  }
+}
+
+function useDomainSharding(options: RequestOptions | {useDomainSharding?: boolean}): boolean {
+  return 'useDomainSharding' in options && options.useDomainSharding === true
+}

package/src/http/nodeMiddleware.ts

@@ -1,8 +1,11 @@
 import {agent, debug, headers} from 'get-it/middleware'
 
 import {name, version} from '../../package.json'
+import {domainSharder} from './domainSharding'
 
 const middleware = [
+  domainSharder.middleware,
+
   debug({verbose: true, namespace: 'sanity:client'}),
   headers({'User-Agent': `${name} ${version}`}),
 

package/src/types.ts

@@ -46,6 +46,14 @@ export interface ClientConfig {
   apiVersion?: string
   proxy?: string
 
+  /**
+   * Spread the requests over a number of hostnames to work around HTTP/1.1 limitations.
+   * Only applicable in browsers, and for certain allowed projects.
+   *
+   * @alpha
+   */
+  useDomainSharding?: boolean
+
   /**
    * Optional request tag prefix for all request tags
    */

package/umd/sanityClient.js

@@ -2662,6 +2662,55 @@ ${selectionOpts}`);
       opts
     );
   }
+  const UNSHARDED_URL_RE = /^https:\/\/([a-z0-9]+)\.api\.(sanity\..*)/, SHARDED_URL_RE = /^https:\/\/[a-z0-9]+\.api\.s(\d+)\.sanity\.(.*)/, domainSharder = getDomainSharder();
+  function getDomainSharder(initialBuckets) {
+    const buckets = new Array(10).fill(0, 0);
+    function incrementBucketForUrl(url) {
+      const shard = getShardFromUrl(url);
+      shard !== null && buckets[shard]++;
+    }
+    function decrementBucketForUrl(url) {
+      const shard = getShardFromUrl(url);
+      shard !== null && buckets[shard]--;
+    }
+    function getShardedUrl(url) {
+      const [isMatch, projectId2, rest] = url.match(UNSHARDED_URL_RE) || [];
+      if (!isMatch)
+        return url;
+      const bucket = buckets.reduce(
+        (smallest, count, index) => count < buckets[smallest] ? index : smallest,
+        0
+      );
+      return `https://${projectId2}.api.s${bucket}.${rest}`;
+    }
+    function getShardFromUrl(url) {
+      const [isMatch, shard] = url.match(SHARDED_URL_RE) || [];
+      return isMatch ? parseInt(shard, 10) : null;
+    }
+    return {
+      middleware: {
+        processOptions: (options) => {
+          if (!useDomainSharding(options))
+            return options;
+          const url = getShardedUrl(options.url);
+          return options.url = url, options;
+        },
+        onRequest(req) {
+          return useDomainSharding(req.options) && incrementBucketForUrl(req.options.url), req;
+        },
+        onResponse(res, context) {
+          return useDomainSharding(context.options) && decrementBucketForUrl(context.options.url), res;
+        }
+      },
+      incrementBucketForUrl,
+      decrementBucketForUrl,
+      getShardedUrl,
+      getBuckets: () => buckets
+    };
+  }
+  function useDomainSharding(options) {
+    return "useDomainSharding" in options && options.useDomainSharding === !0;
+  }
   var defaults = (obj, defaults2) => Object.keys(defaults2).concat(Object.keys(obj)).reduce((target, prop) => (target[prop] = typeof obj[prop] > "u" ? defaults2[prop] : obj[prop], target), {});
   const pick = (obj, props) => props.reduce((selection, prop) => (typeof obj[prop] > "u" || (selection[prop] = obj[prop]), selection), {}), MAX_URL_LENGTH = 14800, possibleOptions = [
     "includePreviousRevision",
@@ -2673,15 +2722,16 @@ ${selectionOpts}`);
     includeResult: !0
   };
   function _listen(query, params, opts = {}) {
-    const { url, token, withCredentials, requestTagPrefix } = this.config(), tag = opts.tag && requestTagPrefix ? [requestTagPrefix, opts.tag].join(".") : opts.tag, options = { ...defaults(opts, defaultOptions), tag }, listenOpts = pick(options, possibleOptions), qs = encodeQueryString({ query, params, options: { tag, ...listenOpts } }), uri = `${url}${_getDataUrl(this, "listen", qs)}`;
-    if (uri.length > MAX_URL_LENGTH)
+    const { url, token, withCredentials, requestTagPrefix } = this.config(), tag = opts.tag && requestTagPrefix ? [requestTagPrefix, opts.tag].join(".") : opts.tag, options = { ...defaults(opts, defaultOptions), tag }, listenOpts = pick(options, possibleOptions), qs = encodeQueryString({ query, params, options: { tag, ...listenOpts } });
+    let uri = `${url}${_getDataUrl(this, "listen", qs)}`;
+    if (this.config().useDomainSharding && (uri = domainSharder.getShardedUrl(uri)), uri.length > MAX_URL_LENGTH)
       return new Observable((observer) => observer.error(new Error("Query too large for listener")));
     const listenFor = options.events ? options.events : ["mutation"], shouldEmitReconnect = listenFor.indexOf("reconnect") !== -1, esOptions = {};
     return (token || withCredentials) && (esOptions.withCredentials = !0), token && (esOptions.headers = {
       Authorization: `Bearer ${token}`
     }), new Observable((observer) => {
       let es, reconnectTimer, stopped = !1, unsubscribed = !1;
-      open();
+      domainSharder.incrementBucketForUrl(uri), open();
       function onError() {
         stopped || (emitReconnect(), !stopped && es.readyState === es.CLOSED && (unsubscribe(), clearTimeout(reconnectTimer), reconnectTimer = setTimeout(open, 100)));
       }
@@ -2716,7 +2766,7 @@ ${selectionOpts}`);
         });
       }
       function stop() {
-        stopped = !0, unsubscribe(), unsubscribed = !0;
+        stopped = !0, unsubscribe(), unsubscribed = !0, domainSharder.decrementBucketForUrl(uri);
       }
       return stop;
     });
@@ -3327,6 +3377,7 @@ ${selectionOpts}`);
         maxRedirects: 0,
         maxRetries: config.maxRetries,
         retryDelay: config.retryDelay,
+        useDomainSharding: config.useDomainSharding,
         ...options
       }),
       config
@@ -3337,7 +3388,7 @@ ${selectionOpts}`);
       return printNoDefaultExport(), createClient2(config);
     };
   }
-  var envMiddleware = [];
+  var envMiddleware = [domainSharder.middleware];
   const exp = defineCreateClientExports(envMiddleware, SanityClient), requester = exp.requester, createClient = exp.createClient, deprecatedCreateClient = defineDeprecatedCreateClient(createClient);
 
   const reKeySegment = /_key\s*==\s*['"](.*)['"]/;