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

implement multipart streaming for PreloadQuery #389

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
2 changes: 1 addition & 1 deletion integration-test/experimental-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"test": "yarn playwright test"
},
"dependencies": {
"@apollo/client": "3.10.4",
"@apollo/client": "^3.11.10",
"@apollo/client-react-streaming": "*",
"compression": "^1.7.4",
"express": "^4.18.2",
Expand Down
1 change: 1 addition & 0 deletions integration-test/jest/jest.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
const config = {
testEnvironment: "jsdom",
transformIgnorePatterns: [],
setupFilesAfterEnv: ["<rootDir>/setupAfterEnv.jest.ts"],
};

module.exports = config;
5 changes: 3 additions & 2 deletions integration-test/jest/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"test": "jest"
},
"dependencies": {
"@apollo/client": "3.10.4",
"@apollo/client": "^3.11.10",
"@apollo/client-react-streaming": "workspace:*",
"@apollo/experimental-nextjs-app-support": "workspace:*",
"@graphql-tools/schema": "^10.0.3",
Expand All @@ -21,6 +21,7 @@
"@testing-library/user-event": "^14.5.2",
"babel-jest": "^29.7.0",
"jest": "^29.7.0",
"jest-environment-jsdom": "^29.7.0"
"jest-environment-jsdom": "^29.7.0",
"jest-fixed-jsdom": "^0.0.9"
}
}
3 changes: 3 additions & 0 deletions integration-test/jest/setupAfterEnv.jest.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { TransformStream } from "node:stream/web";

globalThis.TransformStream = TransformStream;
8 changes: 4 additions & 4 deletions integration-test/nextjs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@
"test": "yarn playwright test"
},
"dependencies": {
"@apollo/client": "3.10.4",
"@apollo/client": "^3.11.10",
"@apollo/experimental-nextjs-app-support": "workspace:*",
"@apollo/server": "^4.9.5",
"@as-integrations/next": "^3.0.0",
"@apollo/server": "^4.11.2",
"@as-integrations/next": "^3.2.0",
"@graphql-tools/schema": "^10.0.0",
"@types/node": "20.3.1",
"@types/react": "^19.0.0",
"@types/react-dom": "^19.0.0",
"graphql": "^16.7.1",
"graphql-tag": "^2.12.6",
"next": "^15.0.0",
"next": "^15.0.3",
"react": "^19.0.0",
"react-dom": "^19.0.0",
"react-error-boundary": "^4.0.13",
Expand Down
7 changes: 4 additions & 3 deletions integration-test/nextjs/src/app/cc/ApolloWrapper.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,14 @@ import {
ApolloClient,
} from "@apollo/experimental-nextjs-app-support";

import { SchemaLink } from "@apollo/client/link/schema";

import { loadErrorMessages, loadDevMessages } from "@apollo/client/dev";
import { setVerbosity } from "ts-invariant";
import { delayLink } from "@/shared/delayLink";
import { schema } from "../graphql/schema";

import { useSSROnlySecret } from "ssr-only-secrets";
import { errorLink } from "../../shared/errorLink";
import { IncrementalSchemaLink } from "../graphql/IncrementalSchemaLink";

setVerbosity("debug");
loadDevMessages();
Expand Down Expand Up @@ -47,7 +46,9 @@ export function ApolloWrapper({
link: delayLink
.concat(errorLink)
.concat(
typeof window === "undefined" ? new SchemaLink({ schema }) : httpLink
typeof window === "undefined"
? new IncrementalSchemaLink({ schema })
: httpLink
),
});
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
import {
ApolloLink,
FetchResult,
Observable,
Operation,
} from "@apollo/client/index.js";
import type { SchemaLink } from "@apollo/client/link/schema";
import {
experimentalExecuteIncrementally,
SubsequentIncrementalExecutionResult,
validate,
} from "graphql";
import { ObjMap } from "graphql/jsutils/ObjMap";

export class IncrementalSchemaLink extends ApolloLink {
Copy link
Member Author

Choose a reason for hiding this comment

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

For use in tests, essentially a SchemaLink with @defer support.

public schema: SchemaLink.Options["schema"];
public rootValue: SchemaLink.Options["rootValue"];
public context: SchemaLink.Options["context"];
public validate: boolean;

constructor(options: SchemaLink.Options) {
super();
this.schema = options.schema;
this.rootValue = options.rootValue;
this.context = options.context;
this.validate = !!options.validate;
}

public request(operation: Operation): Observable<FetchResult> {
return new Observable<FetchResult>((observer) => {
new Promise<SchemaLink.ResolverContext>((resolve) =>
resolve(
typeof this.context === "function"
? this.context(operation)
: this.context
)
)
.then((context) => {
if (this.validate) {
const validationErrors = validate(this.schema, operation.query);
if (validationErrors.length > 0) {
return { errors: validationErrors };
}
}

return experimentalExecuteIncrementally({
schema: this.schema,
document: operation.query,
rootValue: this.rootValue,
contextValue: context,
variableValues: operation.variables,
operationName: operation.operationName,
});
})
.then((data) => {
if (!observer.closed) {
if ("initialResult" in data) {
observer.next(data.initialResult);
return data.subsequentResults.next().then(function handleChunk(
next: IteratorResult<
SubsequentIncrementalExecutionResult<
ObjMap<unknown>,
ObjMap<unknown>
>,
void
>
): Promise<unknown> | void {
if (!observer.closed) {
if (next.value) {
observer.next(next.value);
}
if (next.done) {
observer.complete();
} else {
return data.subsequentResults.next().then(handleChunk);
}
}
});
} else {
observer.next(data);
observer.complete();
}
}
})
.catch((error) => {
if (!observer.closed) {
observer.error(error);
}
});
});
}
}
104 changes: 68 additions & 36 deletions integration-test/nextjs/src/app/graphql/schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,54 +4,86 @@ import * as entryPoint from "@apollo/client-react-streaming";
import type { IResolvers } from "@graphql-tools/utils";

const typeDefs = gql`
directive @defer(
if: Boolean! = true
label: String
) on FRAGMENT_SPREAD | INLINE_FRAGMENT

type RatingWithEnv {
value: String!
env: String!
}

type Product {
id: String!
title: String!
rating(delay: Int!): RatingWithEnv!
}

type Query {
products(someArgument: String): [Product!]!
env: String!
}
`;

const products = [
{
id: "product:5",
title: "Soft Warm Apollo Beanie",
rating: "5/5",
},
{
id: "product:2",
title: "Stainless Steel Water Bottle",
rating: "5/5",
},
{
id: "product:3",
title: "Athletic Baseball Cap",
rating: "5/5",
},
{
id: "product:4",
title: "Baby Onesies",
rating: "cuteness overload",
},
{
id: "product:1",
title: "The Apollo T-Shirt",
rating: "5/5",
},
{
id: "product:6",
title: "The Apollo Socks",
rating: "5/5",
},
];

function getEnv(context?: any) {
return context && context.from === "network"
? "browser"
: "built_for_ssr" in entryPoint
? "SSR"
: "built_for_browser" in entryPoint
? "Browser"
: "built_for_rsc" in entryPoint
? "RSC"
: "unknown";
}

const resolvers = {
Query: {
products: async () => [
{
id: "product:5",
title: "Soft Warm Apollo Beanie",
},
{
id: "product:2",
title: "Stainless Steel Water Bottle",
},
{
id: "product:3",
title: "Athletic Baseball Cap",
},
{
id: "product:4",
title: "Baby Onesies",
},
{
id: "product:1",
title: "The Apollo T-Shirt",
},
{
id: "product:6",
title: "The Apollo Socks",
},
],
env: (source, args, context) => {
return context && context.from === "network"
? "browser"
: "built_for_ssr" in entryPoint
? "SSR"
: "built_for_browser" in entryPoint
? "Browser"
: "built_for_rsc" in entryPoint
? "RSC"
: "unknown";
products: async () => products.map(({ id, title }) => ({ id, title })),
env: (source, args, context) => getEnv(context),
},
Product: {
rating: (source, args, context) => {
return new Promise((resolve) =>
setTimeout(resolve, Math.random() * 2 * args.delay, {
value: products.find((p) => p.id === source.id)?.rating,
env: getEnv(context),
})
);
Comment on lines +80 to +86
Copy link
Member Author

Choose a reason for hiding this comment

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

adding a slow field that can be used to test @defer

},
},
} satisfies IResolvers;
Expand Down
6 changes: 4 additions & 2 deletions integration-test/nextjs/src/app/rsc/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ import { loadErrorMessages, loadDevMessages } from "@apollo/client/dev";
import { setVerbosity } from "ts-invariant";
import { delayLink } from "@/shared/delayLink";
import { errorLink } from "@/shared/errorLink";
import { SchemaLink } from "@apollo/client/link/schema";

import { schema } from "../graphql/schema";
import { IncrementalSchemaLink } from "../graphql/IncrementalSchemaLink";

setVerbosity("debug");
loadDevMessages();
Expand All @@ -19,6 +19,8 @@ loadErrorMessages();
export const { getClient, PreloadQuery, query } = registerApolloClient(() => {
return new ApolloClient({
cache: new InMemoryCache(),
link: delayLink.concat(errorLink.concat(new SchemaLink({ schema }))),
link: delayLink.concat(
errorLink.concat(new IncrementalSchemaLink({ schema }))
),
});
});
Loading
Loading