Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use ReadableStreamLinks for normal data transport, too #424

Open
wants to merge 20 commits into
base: next
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
894 changes: 0 additions & 894 deletions integration-test/.yarn/releases/yarn-4.2.2.cjs

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ const regex_connection_closed_early =
/streaming connection closed before server query could be fully transported, rerunning/i;
const regex_query_error_restart =
/query failed on server, rerunning in browser/i;
const reactErr419 = /(Minified React error #419|Switched to client rendering)/;

test.describe("CC dynamic", () => {
test.describe("useSuspenseQuery", () => {
Expand Down Expand Up @@ -40,7 +41,7 @@ test.describe("CC dynamic", () => {
return regex_query_error_restart.test(message.text());
});
await page.waitForEvent("pageerror", (error) => {
return error.message.includes("Minified React error #419");
return reactErr419.test(error.message);
});

await hydrationFinished;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import { expect } from "@playwright/test";
import { test } from "../../../../../fixture";

const reactErr419 = /(Minified React error #419|Switched to client rendering)/;

test.describe("PreloadQuery", () => {
for (const [description, path] of [
["with useSuspenseQuery", "useSuspenseQuery"],
Expand Down Expand Up @@ -37,10 +39,7 @@ test.describe("PreloadQuery", () => {
await expect(page).toBeInitiallyLoading(true);

await page.waitForEvent("pageerror", (error) => {
return (
/* prod */ error.message.includes("Minified React error #419") ||
/* dev */ error.message.includes("Query failed upstream.")
);
return reactErr419.test(error.message);
});

await expect(page.getByText("loading")).not.toBeVisible();
Expand Down Expand Up @@ -94,10 +93,7 @@ test.describe("PreloadQuery", () => {
await expect(page).toBeInitiallyLoading(true);

await page.waitForEvent("pageerror", (error) => {
return (
/* prod */ error.message.includes("Minified React error #419") ||
/* dev */ error.message.includes("Query failed upstream.")
);
return reactErr419.test(error.message);
});

await expect(page.getByText("loading")).not.toBeVisible();
Expand Down
2 changes: 1 addition & 1 deletion integration-test/react-router/app/routes/home.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { useTransition } from "react";

export const loader = apolloLoader<Route.LoaderArgs>()(({ preloadQuery }) => {
const queryRef = preloadQuery(DEFERRED_QUERY, {
variables: { delayDeferred: 500 },
variables: { delayDeferred: 1000 },
});
return {
queryRef,
Expand Down
7 changes: 4 additions & 3 deletions integration-test/tanstack-start/app/router.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,12 @@ export const delayLink = new ApolloLink((operation, forward) => {
});
});

const link = delayLink.concat(
const link = ApolloLink.from([
delayLink,
typeof window === "undefined"
? new IncrementalSchemaLink({ schema })
: new HttpLink({ uri: "/api/graphql" })
);
: new HttpLink({ uri: "/api/graphql" }),
]);

export function createRouter() {
const apolloClient = new ApolloClient({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export const Route = createFileRoute("/loader-defer")({
component: LoaderDeferPage,
loader: async ({ context: { preloadQuery } }) => {
const queryRef = preloadQuery(DEFERRED_QUERY, {
variables: { delayDeferred: 500 },
variables: { delayDeferred: 1000 },
});
return {
queryRef,
Expand Down
34 changes: 29 additions & 5 deletions integration-test/tanstack-start/app/routes/useSuspenseQuery.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { createFileRoute } from "@tanstack/react-router";
import { QUERY } from "@integration-test/shared/queries";
import { useSuspenseQuery } from "@apollo/client/index.js";
import { DEFERRED_QUERY } from "@integration-test/shared/queries";
import { useApolloClient, useSuspenseQuery } from "@apollo/client/index.js";
import { useTransition } from "react";

export const Route = createFileRoute("/useSuspenseQuery")({
Expand All @@ -9,19 +9,43 @@ export const Route = createFileRoute("/useSuspenseQuery")({

function RouteComponent() {
const [refetching, startTransition] = useTransition();
const { data, refetch } = useSuspenseQuery(QUERY);
const client = useApolloClient();
const { data, refetch } = useSuspenseQuery(DEFERRED_QUERY, {
variables: { delayDeferred: 1000 },
});

return (
<>
<ul>
{data.products.map(({ id, title }) => (
<li key={id}>{title}</li>
{data.products.map(({ id, title, rating }) => (
<li key={id}>
{title}
<br />
Rating:{" "}
<div style={{ display: "inline-block", verticalAlign: "text-top" }}>
{rating?.value || ""}
<br />
{rating ? `Queried in ${rating.env} environment` : "loading..."}
</div>
</li>
))}
</ul>
<p>Queried in {data.env} environment</p>
<button
disabled={refetching}
onClick={() => {
client.cache.batch({
update(cache) {
for (const product of data.products) {
cache.modify({
id: cache.identify(product),
fields: {
rating: () => null,
},
});
}
},
});
startTransition(() => {
refetch();
});
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
},
"resolutions": {
"@microsoft/api-documenter": "7.24.1",
"@apollo/client": "3.12.6",
"@apollo/client": "3.13.0-rc.0",
"graphql": "17.0.0-alpha.2",
"react-router": "patch:react-router@npm%3A7.0.2#~/.yarn/patches/react-router-npm-7.0.2-b96f2bd13c.patch",
"@tanstack/start": "1.99.6",
Expand Down
2 changes: 1 addition & 1 deletion packages/client-react-streaming/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@
"zen-observable-ts": "1.1.0"
},
"peerDependencies": {
"@apollo/client": "^3.10.4",
"@apollo/client": ">=3.13.0-rc.0",
"graphql": "^16 || >=17.0.0-alpha.2",
"react": "^18 || >=19.0.0-rc",
"react-dom": "^18 || >=19.0.0-rc"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import type React from "react";
import type { FetchResult, Observable } from "@apollo/client/index.js";
import type { Observable } from "@apollo/client/index.js";
import { createContext } from "react";
import type { TransportedOptions } from "./transportedOptions.js";
import type { ReadableStreamLinkEvent } from "../ReadableStreamLink.ts";

interface DataTransportAbstraction {
/**
Expand Down Expand Up @@ -74,20 +75,8 @@ export type QueryEvent =
options: TransportedOptions;
id: TransportIdentifier;
}
| {
type: "data";
id: TransportIdentifier;
result: FetchResult;
}
| {
type: "error";
id: TransportIdentifier;
// for now we don't transport the error itself, as it might leak some sensitive information
// this is similar to how React handles errors during SSR
}
| {
type: "complete";
| (ReadableStreamLinkEvent & {
id: TransportIdentifier;
};
});

export type ProgressEvent = Exclude<QueryEvent, { type: "started" }>;
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ describe(
};
const FIRST_RESULT = { me: "User" };
const EVENT_DATA: QueryEvent = {
type: "data",
type: "next",
id: "1" as any,
result: { data: FIRST_RESULT },
value: { data: FIRST_RESULT },
};
const EVENT_COMPLETE: QueryEvent = {
type: "complete",
type: "completed",
id: "1" as any,
};
const FIRST_HOOK_RESULT = {
Expand Down Expand Up @@ -127,7 +127,9 @@ describe(
)
);

assert.deepStrictEqual(events, [EVENT_STARTED]);
// these are an uuid, not just an incremental number, so we need to fix our EVENT_* constants with the real random uuid
const id = events[0].id;
assert.deepStrictEqual(events, [{ ...EVENT_STARTED, id }]);
assert.deepStrictEqual(staticData, []);

await act(async () =>
Expand All @@ -137,9 +139,9 @@ describe(
await findByText("User");

assert.deepStrictEqual(events, [
EVENT_STARTED,
EVENT_DATA,
EVENT_COMPLETE,
{ ...EVENT_STARTED, id },
{ ...EVENT_DATA, id },
{ ...EVENT_COMPLETE, id },
]);
assert.deepStrictEqual(
staticData,
Expand Down Expand Up @@ -313,6 +315,7 @@ describe(
appendToBody`<div hidden id="S:1"><div id="user">User</div></div>`;
$RS("S:1", "P:1");

await new Promise((resolve) => setTimeout(resolve, 10));
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arriving request data (simulateRequestData) now takes a tick as it goes through the link chain instead of directly being written to the store. Without this delay, this test would have written the query first and then the data from the link would have arrived.

// meanwhile, in the browser, the cache is modified
client.cache.writeQuery({
query: QUERY_ME,
Expand Down
Loading
Loading