houdini-react 1.2.24 → 1.2.26

package/build/runtime-esm/index.js

@@ -13,7 +13,8 @@ function Router({
   pending_cache,
   last_variables,
   session,
-  assetPrefix
+  assetPrefix,
+  injectToStream
 }) {
   return /* @__PURE__ */ jsx(
     RouterContextProvider,
@@ -26,7 +27,15 @@ function Router({
       pending_cache,
       last_variables,
       session,
-      children: /* @__PURE__ */ jsx(RouterImpl, { initialURL, manifest, assetPrefix })
+      children: /* @__PURE__ */ jsx(
+        RouterImpl,
+        {
+          initialURL,
+          manifest,
+          assetPrefix,
+          injectToStream
+        }
+      )
     }
   );
 }

package/build/runtime-esm/routing/Router.d.ts

@@ -12,10 +12,11 @@ type ComponentType = any;
  * It is responsible for loading various page sources (including API fetches) and
  * then rendering when appropriate.
  */
-export declare function Router({ manifest, initialURL, assetPrefix, }: {
+export declare function Router({ manifest, initialURL, assetPrefix, injectToStream, }: {
     manifest: RouterManifest<ComponentType>;
     initialURL?: string;
     assetPrefix: string;
+    injectToStream?: undefined | ((chunk: string) => void);
 }): JSX.Element;
 export declare function RouterContextProvider({ children, client, cache, artifact_cache, component_cache, data_cache, pending_cache, last_variables, session: ssrSession, }: {
     children: React.ReactElement;

package/build/runtime-esm/routing/Router.js

@@ -2,7 +2,6 @@ import { jsx } from "react/jsx-runtime";
 import { deepEquals } from "$houdini/runtime/lib/deepEquals";
 import { find_match } from "$houdini/runtime/router/match";
 import React from "react";
-import { useStream } from "react-streaming";
 import { useDocumentStore } from "../hooks/useDocumentStore";
 import { suspense_cache } from "./cache";
 const PreloadWhich = {
@@ -13,7 +12,8 @@ const PreloadWhich = {
 function Router({
   manifest,
   initialURL,
-  assetPrefix
+  assetPrefix,
+  injectToStream
 }) {
   const [current, setCurrent] = React.useState(() => {
     return initialURL || window.location.pathname;
@@ -22,7 +22,8 @@ function Router({
   const { loadData, loadComponent } = usePageData({
     page,
     variables,
-    assetPrefix
+    assetPrefix,
+    injectToStream
   });
   const { component_cache } = useRouterContext();
   const PageComponent = component_cache.get(page.id);
@@ -60,7 +61,8 @@ function Router({
 function usePageData({
   page,
   variables,
-  assetPrefix
+  assetPrefix,
+  injectToStream
 }) {
   const {
     client,
@@ -71,7 +73,6 @@ function usePageData({
     pending_cache,
     last_variables
   } = useRouterContext();
-  const stream = useStream();
   const session = useSession();
   function load_query({ id, artifact }) {
     last_variables.set(page.id, variables);
@@ -92,7 +93,7 @@ function usePageData({
         session
       }).then(() => {
         data_cache.set(id, observer);
-        stream?.injectToStream(`
+        injectToStream?.(`
 						<script>
 							window.__houdini__cache__?.hydrate(${cache.serialize()}, window.__houdini__hydration__layer)
 
@@ -165,7 +166,7 @@ function usePageData({
       targetPage.documents[artifact_id].artifact().then((mod) => {
         const artifact = mod.default;
         artifact_cache.set(artifact_id, artifact);
-        stream?.injectToStream(`
+        injectToStream?.(`
 						<script type="module" src="${assetPrefix}/artifacts/${artifact.name}.js" async=""><\/script>
 					`);
         load_query({ id: artifact.name, artifact });

package/build/runtime-esm/server/index.d.ts

@@ -0,0 +1,17 @@
+/**
+This directory is largely copied from https://github.com/brillout/react-streaming and adapted to fit the needs of this project. It is subject to the MIT license, found [here](https://github.com/brillout/react-streaming/blob/main/LICENSE.md). Duplicated below for reference:
+
+MIT License
+
+Copyright (c) 2022-present Romuald Brillout
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+import { renderToStream } from './renderToStream';
+import type { InjectToStream } from './renderToStream/createBuffer';
+export { renderToStream };
+export type { InjectToStream };

package/build/runtime-esm/server/index.js

@@ -0,0 +1,4 @@
+import { renderToStream } from "./renderToStream";
+export {
+  renderToStream
+};

package/build/runtime-esm/server/renderToStream/createBuffer.d.ts

@@ -0,0 +1,17 @@
+export { createBuffer };
+export type { InjectToStream };
+export type { StreamOperations };
+type InjectToStream = (chunk: unknown, options?: {
+    flush?: boolean;
+}) => void;
+type StreamOperations = {
+    operations: null | {
+        writeChunk: (chunk: unknown) => void;
+        flush: null | (() => void);
+    };
+};
+declare function createBuffer(streamOperations: StreamOperations): {
+    injectToStream: InjectToStream;
+    onBeforeWrite: (chunk: unknown) => void;
+    onBeforeEnd: () => void;
+};

package/build/runtime-esm/server/renderToStream/createBuffer.js

@@ -0,0 +1,77 @@
+import { assert, assertUsage, createDebugger } from "../utils";
+const debug = createDebugger("react-streaming:buffer");
+function createBuffer(streamOperations) {
+  const buffer = [];
+  let state = "UNSTARTED";
+  let writePermission = null;
+  return { injectToStream, onBeforeWrite, onBeforeEnd };
+  function injectToStream(chunk, options) {
+    assertUsage(
+      state !== "ENDED",
+      `Cannot inject following chunk after stream has ended: \`${chunk}\``
+    );
+    if (debug.isEnabled) {
+      debug("injectToStream()", String(chunk));
+    }
+    buffer.push({ chunk, flush: options?.flush });
+    flushBuffer();
+  }
+  function flushBuffer() {
+    if (!writePermission) {
+      return;
+    }
+    if (buffer.length === 0) {
+      return;
+    }
+    if (state !== "STREAMING") {
+      assert(state === "UNSTARTED");
+      return;
+    }
+    let flushStream = false;
+    buffer.forEach((bufferEntry) => {
+      assert(streamOperations.operations);
+      const { writeChunk } = streamOperations.operations;
+      writeChunk(bufferEntry.chunk);
+      if (bufferEntry.flush) {
+        flushStream = true;
+      }
+    });
+    buffer.length = 0;
+    assert(streamOperations.operations);
+    if (flushStream && streamOperations.operations.flush !== null) {
+      streamOperations.operations.flush();
+      debug("stream flushed");
+    }
+  }
+  function onBeforeWrite(chunk) {
+    state === "UNSTARTED" && debug(">>> START");
+    if (debug.isEnabled) {
+      debug(`react write${!writePermission ? "" : " (allowed)"}`, String(chunk));
+    }
+    state = "STREAMING";
+    if (writePermission) {
+      flushBuffer();
+    }
+    if (writePermission == true || writePermission === null) {
+      writePermission = false;
+      debug("writePermission =", writePermission);
+      setTimeout(() => {
+        debug(">>> setTimeout()");
+        writePermission = true;
+        debug("writePermission =", writePermission);
+        flushBuffer();
+      });
+    }
+  }
+  function onBeforeEnd() {
+    writePermission = true;
+    debug("writePermission =", writePermission);
+    flushBuffer();
+    assert(buffer.length === 0);
+    state = "ENDED";
+    debug(">>> END");
+  }
+}
+export {
+  createBuffer
+};

package/build/runtime-esm/server/renderToStream/createPipeWrapper.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+import type { Writable as StreamNodeWritable } from 'stream';
+export { createPipeWrapper };
+export type { Pipe };
+type Pipe = (writable: StreamNodeWritable) => void;
+declare function createPipeWrapper(pipeFromReact: Pipe, { onReactBug }: {
+    onReactBug: (err: unknown) => void;
+}): Promise<{
+    pipeForUser: Pipe;
+    streamEnd: Promise<void>;
+    injectToStream: import("./createBuffer").InjectToStream;
+}>;

package/build/runtime-esm/server/renderToStream/createPipeWrapper.js

@@ -0,0 +1,66 @@
+import { createDebugger } from "../utils";
+import { createBuffer } from "./createBuffer";
+import { loadNodeStreamModule } from "./loadNodeStreamModule";
+const debug = createDebugger("react-streaming:createPipeWrapper");
+async function createPipeWrapper(pipeFromReact, { onReactBug }) {
+  const { Writable } = await loadNodeStreamModule();
+  const { pipeForUser, streamEnd } = createPipeForUser();
+  const streamOperations = {
+    operations: null
+  };
+  const { injectToStream, onBeforeWrite, onBeforeEnd } = createBuffer(streamOperations);
+  return { pipeForUser, streamEnd, injectToStream };
+  function createPipeForUser() {
+    debug("createPipeForUser()");
+    let onEnded;
+    const streamEnd2 = new Promise((r) => {
+      onEnded = () => r();
+    });
+    const pipeForUser2 = (writableFromUser) => {
+      const writableForReact = new Writable({
+        write(chunk, encoding, callback) {
+          debug("write");
+          onBeforeWrite(chunk);
+          if (!writableFromUser.destroyed) {
+            writableFromUser.write(chunk, encoding, callback);
+          } else {
+            writableForReact.destroy();
+          }
+        },
+        final(callback) {
+          debug("final");
+          onBeforeEnd();
+          writableFromUser.end();
+          onEnded();
+          callback();
+        },
+        destroy(err) {
+          debug(`destroy (\`!!err === ${!!err}\`)`);
+          if (err)
+            onReactBug(err);
+          writableFromUser.destroy(err ?? void 0);
+          onEnded();
+        }
+      });
+      const flush = () => {
+        if (typeof writableFromUser.flush === "function") {
+          ;
+          writableFromUser.flush();
+          debug("stream flushed (Node.js Writable)");
+        }
+      };
+      streamOperations.operations = {
+        flush,
+        writeChunk(chunk) {
+          writableFromUser.write(chunk);
+        }
+      };
+      writableForReact.flush = flush;
+      pipeFromReact(writableForReact);
+    };
+    return { pipeForUser: pipeForUser2, streamEnd: streamEnd2 };
+  }
+}
+export {
+  createPipeWrapper
+};

package/build/runtime-esm/server/renderToStream/createReadableWrapper.d.ts

@@ -0,0 +1,6 @@
+export { createReadableWrapper };
+declare function createReadableWrapper(readableFromReact: ReadableStream): {
+    readableForUser: ReadableStream<any>;
+    streamEnd: Promise<void>;
+    injectToStream: import("./createBuffer").InjectToStream;
+};

package/build/runtime-esm/server/renderToStream/createReadableWrapper.js

@@ -0,0 +1,61 @@
+import { createBuffer } from "./createBuffer";
+function createReadableWrapper(readableFromReact) {
+  const streamOperations = {
+    operations: null
+  };
+  let controllerOfUserStream;
+  let onEnded;
+  const streamEnd = new Promise((r) => {
+    onEnded = () => r();
+  });
+  const readableForUser = new ReadableStream({
+    start(controller) {
+      controllerOfUserStream = controller;
+      onReady(onEnded);
+    }
+  });
+  const { injectToStream, onBeforeWrite, onBeforeEnd } = createBuffer(streamOperations);
+  return { readableForUser, streamEnd, injectToStream };
+  async function onReady(onEnded2) {
+    streamOperations.operations = {
+      writeChunk(chunk) {
+        controllerOfUserStream.enqueue(encodeForWebStream(chunk));
+      },
+      flush: null
+    };
+    const reader = readableFromReact.getReader();
+    while (true) {
+      let result;
+      try {
+        result = await reader.read();
+      } catch (err) {
+        controllerOfUserStream.close();
+        throw err;
+      }
+      const { value, done } = result;
+      if (done) {
+        break;
+      }
+      onBeforeWrite(value);
+      streamOperations.operations.writeChunk(value);
+    }
+    setTimeout(() => {
+      onBeforeEnd();
+      controllerOfUserStream.close();
+      onEnded2();
+    }, 0);
+  }
+}
+let encoder;
+function encodeForWebStream(thing) {
+  if (!encoder) {
+    encoder = new TextEncoder();
+  }
+  if (typeof thing === "string") {
+    return encoder.encode(thing);
+  }
+  return thing;
+}
+export {
+  createReadableWrapper
+};

package/build/runtime-esm/server/renderToStream/loadNodeStreamModule.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+import type { Readable as StreamNodeReadable, Writable as StreamNodeWritable } from 'stream';
+export { loadNodeStreamModule };
+export { nodeStreamModuleIsAvailable };
+type StreamModule = {
+    Readable: typeof StreamNodeReadable;
+    Writable: typeof StreamNodeWritable;
+};
+declare function loadNodeStreamModule(): Promise<StreamModule>;
+declare function nodeStreamModuleIsAvailable(): Promise<boolean>;

package/build/runtime-esm/server/renderToStream/loadNodeStreamModule.js

@@ -0,0 +1,20 @@
+async function loadNodeStreamModule() {
+  const streamModule = await loadModule();
+  const { Readable, Writable } = streamModule;
+  return { Readable, Writable };
+}
+async function nodeStreamModuleIsAvailable() {
+  try {
+    await loadModule();
+    return true;
+  } catch (err) {
+    return false;
+  }
+}
+function loadModule() {
+  return import("stream");
+}
+export {
+  loadNodeStreamModule,
+  nodeStreamModuleIsAvailable
+};

package/build/runtime-esm/server/renderToStream/resolveSeoStrategy.d.ts

@@ -0,0 +1,9 @@
+export { resolveSeoStrategy };
+export type { SeoStrategy };
+type SeoStrategy = 'conservative' | 'google-speed';
+declare function resolveSeoStrategy(options?: {
+    seoStrategy?: SeoStrategy;
+    userAgent?: string;
+}): {
+    disableStream: boolean;
+};

package/build/runtime-esm/server/renderToStream/resolveSeoStrategy.js

@@ -0,0 +1,20 @@
+import { assertWarning } from "../utils";
+function resolveSeoStrategy(options = {}) {
+  const seoStrategy = options.seoStrategy || "conservative";
+  if (!options.userAgent) {
+    assertWarning(
+      false,
+      "Streaming disabled. Provide `options.userAgent` to enable streaming. (react-streaming needs the User Agent string in order to be able to disable streaming for bots, e.g. for Google Bot.) Or set `options.disable` to `true` to get rid of this warning.",
+      { onlyOnce: true }
+    );
+    return { disableStream: true };
+  }
+  const isGoogleBot = options.userAgent.toLowerCase().includes("googlebot");
+  if (seoStrategy === "google-speed" && isGoogleBot) {
+    return { disableStream: false };
+  }
+  return { disableStream: true };
+}
+export {
+  resolveSeoStrategy
+};

package/build/runtime-esm/server/renderToStream.d.ts

@@ -0,0 +1,28 @@
+import React from 'react';
+import type { renderToPipeableStream as RenderToPipeableStream, renderToReadableStream as RenderToReadableStream } from 'react-dom/server';
+import { Pipe } from './renderToStream/createPipeWrapper';
+import { SeoStrategy } from './renderToStream/resolveSeoStrategy';
+export { renderToStream };
+export { disable };
+type Options = {
+    webStream?: boolean;
+    disable?: boolean;
+    seoStrategy?: SeoStrategy;
+    userAgent?: string;
+    onBoundaryError?: (err: unknown) => void;
+    renderToReadableStream?: typeof RenderToReadableStream;
+    renderToPipeableStream?: typeof RenderToPipeableStream;
+};
+type Result = ({
+    pipe: Pipe;
+    readable: null;
+} | {
+    pipe: null;
+    readable: ReadableStream;
+}) & {
+    streamEnd: Promise<boolean>;
+    disabled: boolean;
+    injectToStream: (chunk: unknown) => void;
+};
+declare function disable(): void;
+declare function renderToStream(element: React.ReactNode, options?: Options): Promise<Result>;

package/build/runtime-esm/server/renderToStream.js

@@ -0,0 +1,152 @@
+import React from "react";
+import { createPipeWrapper } from "./renderToStream/createPipeWrapper";
+import { createReadableWrapper } from "./renderToStream/createReadableWrapper";
+import { nodeStreamModuleIsAvailable } from "./renderToStream/loadNodeStreamModule";
+import { resolveSeoStrategy } from "./renderToStream/resolveSeoStrategy";
+import { createDebugger } from "./utils";
+const debug = createDebugger("react-streaming:flow");
+const globalConfig = globalThis.__react_streaming = globalThis.__react_streaming || {
+  disable: false
+};
+function disable() {
+  globalConfig.disable = true;
+}
+async function renderToStream(element, options = {}) {
+  const buffer = [];
+  let injectToStream = (chunk) => buffer.push(chunk);
+  element = React.cloneElement(element, { injectToStream });
+  const disable2 = globalConfig.disable || (options.disable ?? resolveSeoStrategy(options).disableStream);
+  const webStream = options.webStream ?? !await nodeStreamModuleIsAvailable();
+  debug(`disable === ${disable2} && webStream === ${webStream}`);
+  let result;
+  const resultPartial = { disabled: disable2 };
+  if (!webStream) {
+    result = { ...resultPartial, ...await renderToNodeStream(element, disable2, options) };
+  } else {
+    result = { ...resultPartial, ...await renderToWebStream(element, disable2, options) };
+  }
+  injectToStream = result.injectToStream;
+  buffer.forEach((chunk) => injectToStream(chunk));
+  buffer.length = 0;
+  debug("promise `await renderToStream()` resolved");
+  return result;
+}
+async function renderToNodeStream(element, disable2, options) {
+  debug("creating Node.js Stream Pipe");
+  let onAllReady;
+  const allReady = new Promise((r) => {
+    onAllReady = () => r();
+  });
+  let onShellReady;
+  const shellReady = new Promise((r) => {
+    onShellReady = () => r();
+  });
+  let didError = false;
+  let firstErr = null;
+  let reactBug = null;
+  const onError = (err) => {
+    debug("[react] onError() / onShellError()");
+    didError = true;
+    firstErr ??= err;
+    onShellReady();
+    afterReactBugCatch(() => {
+      if (err !== reactBug) {
+        options.onBoundaryError?.(err);
+      }
+    });
+  };
+  const renderToPipeableStream = options.renderToPipeableStream ?? (await import("react-dom/server.node")).renderToPipeableStream;
+  const { pipe: pipeOriginal } = renderToPipeableStream(element, {
+    onShellReady() {
+      debug("[react] onShellReady()");
+      onShellReady();
+    },
+    onAllReady() {
+      debug("[react] onAllReady()");
+      onShellReady();
+      onAllReady();
+    },
+    onShellError: onError,
+    onError
+  });
+  let promiseResolved = false;
+  const { pipeForUser, injectToStream, streamEnd } = await createPipeWrapper(pipeOriginal, {
+    onReactBug(err) {
+      debug("react bug");
+      didError = true;
+      firstErr ??= err;
+      reactBug = err;
+      if (reactBug !== firstErr || promiseResolved) {
+        console.error(reactBug);
+      }
+    }
+  });
+  await shellReady;
+  if (didError)
+    throw firstErr;
+  if (disable2)
+    await allReady;
+  if (didError)
+    throw firstErr;
+  promiseResolved = true;
+  return {
+    pipe: pipeForUser,
+    readable: null,
+    streamEnd: wrapStreamEnd(streamEnd, didError),
+    injectToStream
+  };
+}
+async function renderToWebStream(element, disable2, options) {
+  debug("creating Web Stream Pipe");
+  let didError = false;
+  let firstErr = null;
+  let reactBug = null;
+  const onError = (err) => {
+    didError = true;
+    firstErr = firstErr || err;
+    afterReactBugCatch(() => {
+      if (err !== reactBug) {
+        options.onBoundaryError?.(err);
+      }
+    });
+  };
+  const renderToReadableStream = options.renderToReadableStream ?? (await import("react-dom/server.browser")).renderToReadableStream;
+  const readableOriginal = await renderToReadableStream(element, { onError });
+  const { allReady } = readableOriginal;
+  let promiseResolved = false;
+  allReady.catch((err) => {
+    debug("react bug");
+    didError = true;
+    firstErr = firstErr || err;
+    reactBug = err;
+    if (reactBug !== firstErr || promiseResolved) {
+      console.error(reactBug);
+    }
+  });
+  if (didError)
+    throw firstErr;
+  if (disable2)
+    await allReady;
+  if (didError)
+    throw firstErr;
+  const { readableForUser, streamEnd, injectToStream } = createReadableWrapper(readableOriginal);
+  promiseResolved = true;
+  return {
+    readable: readableForUser,
+    pipe: null,
+    streamEnd: wrapStreamEnd(streamEnd, didError),
+    injectToStream
+  };
+}
+function afterReactBugCatch(fn) {
+  setTimeout(() => {
+    fn();
+  }, 0);
+}
+function wrapStreamEnd(streamEnd, didError) {
+  return streamEnd.then(() => new Promise((r) => setTimeout(r, 0))).then(() => !didError);
+}
+export {
+  disable,
+  renderToStream
+};

package/build/runtime-esm/server/shared/initData.d.ts

@@ -0,0 +1,8 @@
+export type { InitData };
+export { initDataHtmlClass };
+type InitData = {
+    value: unknown;
+    key: string;
+    elementId: string;
+};
+declare const initDataHtmlClass = "react-streaming_initData";

package/build/runtime-esm/server/shared/initData.js

@@ -0,0 +1,4 @@
+const initDataHtmlClass = "react-streaming_initData";
+export {
+  initDataHtmlClass
+};

package/build/runtime-esm/server/shared/key.d.ts

@@ -0,0 +1,4 @@
+export { stringifyKey };
+export { assertKey };
+declare function stringifyKey(key: unknown): string;
+declare function assertKey(keyValue: unknown): void;

package/build/runtime-esm/server/shared/key.js

@@ -0,0 +1,20 @@
+import { isCallable } from "../utils/isCallable";
+import { assertUsage } from "./utils";
+function stringifyKey(key) {
+  const keyString = JSON.stringify(key);
+  return keyString;
+}
+function assertKey(keyValue) {
+  assertUsage(
+    keyValue,
+    `[useAsync(key, asyncFn)] You provided a \`key\` with the value \`${keyValue}\` which is forbidden.`
+  );
+  assertUsage(
+    !isCallable(keyValue),
+    `[useAsync(key, asyncFn)] You provided a \`key\` that is a function which is forbidden.`
+  );
+}
+export {
+  assertKey,
+  stringifyKey
+};

package/build/runtime-esm/server/shared/utils.d.ts

@@ -0,0 +1,3 @@
+export * from '../utils/assert';
+export * from '../utils/getGlobalVariable';
+export * from '../utils/isPromise';

package/build/runtime-esm/server/shared/utils.js

@@ -0,0 +1,3 @@
+export * from "../utils/assert";
+export * from "../utils/getGlobalVariable";
+export * from "../utils/isPromise";