@solidjs/web 2.0.0-rc.4 → 2.0.0-rc.6

package/server-functions/dist/client.js

@@ -66,17 +66,30 @@ function configureServerFunctionsCodec(codec) {
 function getServerFunctionsCodec() {
   return codecConfig.codec;
 }
+const UNNAMED_FLIGHT_SOURCE = "true";
 const flightConfig = {
-  consumer: undefined
+  consumers: new Map()
 };
-function subscribeFlightData(consumer) {
-  flightConfig.consumer = consumer;
+function assertFlightSource(source) {
+  if (source === UNNAMED_FLIGHT_SOURCE || source === "" || source.includes(",")) {
+    throw new TypeError(`Invalid flight data source id "${source}": ids ride the ` + `${SINGLE_FLIGHT_HEADER} header as a comma-separated list, and "true" is ` + `reserved for the unnamed registration (the bare consumer/hook signatures).`);
+  }
+}
+function subscribeFlightData(sourceOrConsumer, maybeConsumer) {
+  const named = typeof sourceOrConsumer === "string";
+  if (named) assertFlightSource(sourceOrConsumer);
+  const source = named ? sourceOrConsumer : UNNAMED_FLIGHT_SOURCE;
+  const consumer = named ? maybeConsumer : sourceOrConsumer;
+  flightConfig.consumers.set(source, consumer);
   return () => {
-    if (flightConfig.consumer === consumer) flightConfig.consumer = undefined;
+    if (flightConfig.consumers.get(source) === consumer) flightConfig.consumers.delete(source);
   };
 }
-function getFlightDataConsumer() {
-  return flightConfig.consumer;
+function getFlightDataConsumer(source) {
+  return flightConfig.consumers.get(source === undefined ? UNNAMED_FLIGHT_SOURCE : source);
+}
+function getFlightDataSourceIds() {
+  return [...flightConfig.consumers.keys()];
 }
 function frameAddress(id, args) {
   return args && args.length ? id + ":" + hashArguments(args) : id;
@@ -126,15 +139,27 @@ function serverFunctionAddress(endpoint, id) {
   const mount = endpoint.endsWith("/") ? endpoint.slice(0, -1) : endpoint;
   return `${mount}/${encodeURIComponent(id)}`;
 }
+function serverFunctionDataAddress(endpoint, id) {
+  const mount = endpoint.endsWith("/") ? endpoint.slice(0, -1) : endpoint;
+  return `${mount}/data/${encodeURIComponent(id)}`;
+}
 function parseServerFunctionAddress(pathname, endpoint) {
   const mount = endpoint.endsWith("/") ? endpoint.slice(0, -1) : endpoint;
   if (!pathname.startsWith(mount)) return null;
   const rest = pathname.slice(mount.length);
   if (!rest.startsWith("/")) return null;
-  const segment = rest.slice(1);
+  let segment = rest.slice(1);
+  let data = false;
+  if (segment.startsWith("data/")) {
+    segment = segment.slice(5);
+    data = true;
+  }
   if (!segment || segment.includes("/")) return null;
   try {
-    return decodeURIComponent(segment);
+    return {
+      id: decodeURIComponent(segment),
+      data
+    };
   } catch {
     return null;
   }
@@ -166,6 +191,28 @@ function decodeErrorHeaderValue(value) {
 }
 const INSTANCE_HEADER = "X-Server-Function-Instance";
 const BODY_FORMAT_HEADER = "X-Server-Function-Format";
+const UNKNOWN_HEADER = "X-Server-Function-Unknown";
+const REDIRECT_HEADER = "X-Server-Function-Redirect";
+function decodeRedirectHeaderValue(value) {
+  if (typeof value !== "string") return undefined;
+  const at = value.indexOf(" ");
+  if (at < 0) return undefined;
+  const status = Number(value.slice(0, at));
+  const url = value.slice(at + 1);
+  if (!Number.isInteger(status) || !url) return undefined;
+  if (status !== 301 && status !== 302 && status !== 303 && status !== 307 && status !== 308) return undefined;
+  let parsed;
+  try {
+    parsed = new URL(url);
+  } catch {
+    return undefined;
+  }
+  if (parsed.protocol !== "http:" && parsed.protocol !== "https:") return undefined;
+  return {
+    status,
+    url
+  };
+}
 const SINGLE_FLIGHT_HEADER = "X-Single-Flight";
 const FILE_FORM_KEY = "__server_function_file__";
 const BodyFormat = {
@@ -208,7 +255,11 @@ function isJSONSafe(value) {
       const proto = Object.getPrototypeOf(v);
       if (proto !== Object.prototype && proto !== null) return false;
       if (Symbol.asyncIterator in v || Symbol.iterator in v) return false;
-      for (const k in v) stack.push(v[k]);
+      for (const k in v) {
+        const descriptor = Object.getOwnPropertyDescriptor(v, k);
+        if (descriptor === undefined || !("value" in descriptor)) return false;
+        stack.push(descriptor.value);
+      }
     }
   }
   return true;
@@ -317,18 +368,34 @@ function createChunk(data) {
 class ChunkReader {
   constructor(stream) {
     this.reader = stream.getReader();
-    this.buffer = new Uint8Array(0);
+    this.store = new Uint8Array(0);
+    this.buffer = this.store;
     this.done = false;
   }
   async readChunk() {
     const chunk = await this.reader.read();
-    if (!chunk.done) {
-      const newBuffer = new Uint8Array(this.buffer.length + chunk.value.length);
-      newBuffer.set(this.buffer);
-      newBuffer.set(chunk.value, this.buffer.length);
-      this.buffer = newBuffer;
-    } else {
+    if (chunk.done) {
       this.done = true;
+      return;
+    }
+    const incoming = chunk.value;
+    const store = this.store;
+    const start = this.buffer.byteOffset;
+    const end = start + this.buffer.length;
+    const needed = this.buffer.length + incoming.length;
+    if (end + incoming.length <= store.length) {
+      store.set(incoming, end);
+      this.buffer = store.subarray(start, end + incoming.length);
+    } else if (needed <= store.length) {
+      store.copyWithin(0, start, end);
+      store.set(incoming, this.buffer.length);
+      this.buffer = store.subarray(0, needed);
+    } else {
+      const grown = new Uint8Array(Math.max(needed, store.length * 2));
+      grown.set(this.buffer);
+      grown.set(incoming, this.buffer.length);
+      this.store = grown;
+      this.buffer = grown.subarray(0, needed);
     }
   }
   async next() {
@@ -370,6 +437,18 @@ class ChunkReader {
     }
   }
 }
+const ERROR_TRAILER_PREFIX = "!";
+function errorFromTrailer(payload) {
+  let shape;
+  try {
+    shape = JSON.parse(payload.slice(1));
+  } catch {
+    shape = null;
+  }
+  const error = new Error(shape && typeof shape.message === "string" ? shape.message : "Server function result could not be delivered.");
+  if (shape && typeof shape.name === "string") error.name = shape.name;
+  return error;
+}
 function serializeStream(value, codecOptions) {
   return new ReadableStream({
     async start(controller) {
@@ -402,11 +481,17 @@ async function deserializeStream(source, codecOptions) {
   const reader = new ChunkReader(source.body);
   const result = await reader.next();
   if (!result.done) {
+    if (result.value.startsWith(ERROR_TRAILER_PREFIX)) {
+      throw errorFromTrailer(result.value);
+    }
     const {
       createJSONDeserializer
     } = await import('@solidjs/web/serialization/decode');
     const deserializeChunk = createJSONDeserializer(codecOptions);
     function interpretChunk(chunk) {
+      if (chunk.startsWith(ERROR_TRAILER_PREFIX)) {
+        throw errorFromTrailer(chunk);
+      }
       return deserializeChunk(JSON.parse(chunk));
     }
     reader.drain(interpretChunk).then(() => deserializeChunk.abort(new Error("Server function stream ended unexpectedly.")), error => deserializeChunk.abort(error));
@@ -471,7 +556,8 @@ function serverFunctionUrl(id, boundArgs) {
   return `${address}?args=${encodeURIComponent(JSON.stringify(boundArgs))}`;
 }
 function parseServerFunctionUrl(url) {
-  return parseServerFunctionAddress(new URL(url, globalThis.location?.href || "http://localhost").pathname, config.endpoint);
+  const parsed = parseServerFunctionAddress(new URL(url, globalThis.location?.href || "http://localhost").pathname, config.endpoint);
+  return parsed && parsed.id;
 }
 function serializeArguments(args) {
   if (!config.serializeArgs) {
@@ -505,18 +591,41 @@ function provideRPC() {
     decodeResponse
   });
 }
+function dataAddressFor(base) {
+  const splitAt = base.search(/[?#]/);
+  const path = splitAt < 0 ? base : base.slice(0, splitAt);
+  const rest = splitAt < 0 ? "" : base.slice(splitAt);
+  const slash = path.lastIndexOf("/");
+  if (path.endsWith("/data/", slash + 1)) return base;
+  return `${path.slice(0, slash + 1)}data/${path.slice(slash + 1)}${rest}`;
+}
 function serverFunctionFailure(response, value) {
-  const error = value ?? new Error(`Server function call failed with status ${response.status}`);
-  if (error instanceof Error && !("status" in error)) error.status = response.status;
+  const unknown = response.headers.get(UNKNOWN_HEADER) !== null;
+  const error = value ?? new Error(unknown ? "Server function is not part of the deployment that answered (version skew or removed function)" : `Server function call failed with status ${response.status}`);
+  if (error instanceof Error && !("status" in error)) {
+    error.status = response.status;
+    const retryAfter = parseRetryAfter(response.headers.get("Retry-After"));
+    if (retryAfter !== undefined) error.retryAfter = retryAfter;
+  }
+  if (unknown && error instanceof Error) error.unknownFunction = true;
   return error;
 }
+function parseRetryAfter(header) {
+  if (!header) return undefined;
+  const trimmed = header.trim();
+  if (/^\d+$/.test(trimmed)) return Number(trimmed);
+  const date = Date.parse(trimmed);
+  if (!Number.isNaN(date)) return Math.max(0, Math.ceil((date - Date.now()) / 1000));
+  return undefined;
+}
 async function createRequest(base, id, instance, options, meta) {
   const headers = {
     ...options.headers,
     [INSTANCE_HEADER]: instance
   };
-  if (getFlightDataConsumer() && !options.read && (!options.method || options.method.toUpperCase() !== "GET")) {
-    headers[SINGLE_FLIGHT_HEADER] = "true";
+  const flightSources = getFlightDataSourceIds();
+  if (flightSources.length > 0 && !options.read && (!options.method || options.method.toUpperCase() !== "GET")) {
+    headers[SINGLE_FLIGHT_HEADER] = flightSources.join(",");
   }
   let init = {
     method: "POST",
@@ -524,10 +633,19 @@ async function createRequest(base, id, instance, options, meta) {
     headers
   };
   if (config.prepareRequest) {
-    init = (await config.prepareRequest(init, {
+    const prepared = await config.prepareRequest(init, {
       id,
       meta
-    })) || init;
+    });
+    if (prepared && prepared !== init) {
+      if (typeof prepared !== "object") {
+        throw new Error("prepareRequest must return (or mutate and return) the RequestInit it received; " + `it returned a ${typeof prepared}. Spread the init: ` + "init => ({ ...init, headers: { ...init.headers, ... } })");
+      }
+      if (!new Headers(prepared.headers).has(INSTANCE_HEADER)) {
+        throw new Error("prepareRequest returned an init without the transport headers " + `(${INSTANCE_HEADER}), which would send the call without its payload or ` + "protocol. Spread the init it received: " + "init => ({ ...init, headers: { ...init.headers, ... } })");
+      }
+    }
+    init = prepared || init;
   }
   const send = config.fetch || fetch;
   if (CALL_OBSERVERS.size === 0) return send(base, init);
@@ -624,23 +742,29 @@ async function fetchServerFunction(base, id, options, args, meta, callArgs = arg
   if (response.status >= 400 && !response.headers.has(BODY_FORMAT_HEADER)) {
     throw serverFunctionFailure(response, undefined);
   }
-  const failed = response.headers.has(ERROR_HEADER) || response.status >= 500;
+  const failed = response.headers.has(ERROR_HEADER);
   if (response.headers.has(SINGLE_FLIGHT_HEADER)) {
-    const consumer = getFlightDataConsumer();
-    if (consumer) {
+    const folded = response.headers.get(SINGLE_FLIGHT_HEADER).split(",");
+    const consumers = folded.map(source => [source, getFlightDataConsumer(source)]).filter(([, consumer]) => consumer);
+    if (consumers.length > 0) {
       const payload = await decodeResponse(response);
-      await consumer(payload.data, {
-        response
-      });
-      if (failed && !response.headers.has("Location") && !response.headers.has(REVALIDATE_HEADER)) {
+      for (const [source, consumer] of consumers) {
+        await consumer(payload.data[source], {
+          response
+        });
+      }
+      if (failed && !response.headers.has(REDIRECT_HEADER) && !response.headers.has(REVALIDATE_HEADER)) {
         throw serverFunctionFailure(response, payload.value);
       }
       return payload.value;
     }
   }
-  if (response.headers.has("Location") || response.headers.has(REVALIDATE_HEADER) || response.headers.has(SINGLE_FLIGHT_HEADER)) {
+  if (response.headers.has(REDIRECT_HEADER) || response.headers.has(REVALIDATE_HEADER) || response.headers.has(SINGLE_FLIGHT_HEADER) || response.status >= 300 && response.status < 400 && response.status !== 304) {
     return response;
   }
+  if (response.status < 300 && !response.headers.has(BODY_FORMAT_HEADER) && !response.headers.has("X-Content-Raw")) {
+    throw serverFunctionFailure(response, new Error(`Server function response carries no recognized encoding (status ${response.status}` + `${response.headers.get("Content-Type") ? `, content-type ${response.headers.get("Content-Type")}` : ""}): answered by something other than the server function runtime`));
+  }
   const result = await decodeResponse(response.clone());
   if (failed) {
     throw serverFunctionFailure(response, result);
@@ -676,7 +800,7 @@ function createServerReference(id, name, base) {
       });
       if (hit !== undefined) return hit;
     }
-    return fetchServerFunction(base || serverFunctionAddress(config.endpoint, id), id, invokeOptions ? {
+    return fetchServerFunction(base ? dataAddressFor(base) : serverFunctionDataAddress(config.endpoint, id), id, invokeOptions ? {
       ...invokeOptions
     } : {}, args, metadata);
   };
@@ -713,7 +837,7 @@ function GET(fn) {
       if (hit !== undefined) return hit;
     }
     const opts = invokeOptions || {};
-    const address = serverFunctionAddress(config.endpoint, id);
+    const address = serverFunctionDataAddress(config.endpoint, id);
     if (!args.length) {
       return fetchServerFunction(address, id, {
         ...opts,
@@ -843,7 +967,7 @@ function live(fn) {
                 emitClosed(error);
                 throw error;
               }
-              if (error !== null && typeof error === "object" && typeof error.status === "number" && error.status >= 400 && error.status < 500) {
+              if (error !== null && typeof error === "object" && typeof error.status === "number" && error.status >= 400 && error.status < 500 && error.status !== 408 && error.status !== 425 && error.status !== 429 && typeof error.retryAfter !== "number") {
                 stopped = true;
                 emitClosed(error);
                 throw error;
@@ -852,7 +976,8 @@ function live(fn) {
               emit("reconnecting", error);
               await new Promise(resolve => {
                 wake = resolve;
-                timer = setTimeout(resolve, Math.min(500 * 2 ** attempts++, 10000));
+                const named = error !== null && typeof error === "object" && typeof error.retryAfter === "number" ? Math.min(error.retryAfter * 1000, 60000) : undefined;
+                timer = setTimeout(resolve, named ?? Math.min(500 * 2 ** attempts++, 10000));
                 if (typeof addEventListener === "function") addEventListener("online", resolve, {
                   once: true
                 });
@@ -904,4 +1029,4 @@ function getServerFunctionInvocation() {
   return undefined;
 }
 
-export { ChunkReader, ERROR_HEADER, FLASH_COOKIE, GET, INSTANCE_HEADER, REVALIDATE_HEADER, SERVER_FUNCTION_INVOKE, SINGLE_FLIGHT_HEADER, clearFlashCookie, configureServerFunctionsClient, createChunk, createServerReference, decodeErrorHeaderValue, decodeResponse, decodeResponsePayload, deserializeStream, encodeErrorHeaderValue, frameAddress, getFlightDataConsumer, getServerFunctionInvocation, getServerFunctionMetadata, getServerFunctionsCodec, hasFlashCookie, invoke, isServerFunction, live, observeServerFunctionCalls, parseServerFunctionUrl, registerServerReference, serializeString, serverFunctionUrl, subscribeFlightData, withMeta };
+export { ChunkReader, ERROR_HEADER, FLASH_COOKIE, GET, INSTANCE_HEADER, REDIRECT_HEADER, REVALIDATE_HEADER, SERVER_FUNCTION_INVOKE, SINGLE_FLIGHT_HEADER, UNKNOWN_HEADER, clearFlashCookie, configureServerFunctionsClient, createChunk, createServerReference, decodeErrorHeaderValue, decodeRedirectHeaderValue, decodeResponse, decodeResponsePayload, deserializeStream, encodeErrorHeaderValue, frameAddress, getFlightDataConsumer, getFlightDataSourceIds, getServerFunctionInvocation, getServerFunctionMetadata, getServerFunctionsCodec, hasFlashCookie, invoke, isServerFunction, live, observeServerFunctionCalls, parseServerFunctionUrl, registerServerReference, serializeString, serverFunctionUrl, subscribeFlightData, withMeta };