Skip to content
Merged
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
34 changes: 29 additions & 5 deletions types/relay-test-utils/lib/RelayMockPayloadGenerator.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { GraphQLSingularResponse, OperationDescriptor } from "relay-runtime";
import { GraphQLResponse, GraphQLSingularResponse, OperationDescriptor } from "relay-runtime";

export interface MockResolverContext {
readonly parentType: string | null | undefined;
Expand All @@ -8,14 +8,38 @@ export interface MockResolverContext {
readonly args: Record<string, unknown> | null | undefined;
}

export type MockResolver = (context: MockResolverContext, generateId: () => number) => unknown;
export type DeepPartial<T> = T extends object ? {
[P in keyof T]?: DeepPartial<T[P]>;
}
: T;

export interface MockResolvers {
[typeName: string]: MockResolver;
}
export type MockResolver<T = unknown> = (
context: MockResolverContext,
generateId: () => number,
) => DeepPartial<T> | undefined;

export type DefaultMockResolvers = Partial<{
ID: string;
Boolean: boolean;
Int: number;
Float: number;
[key: string]: unknown;
}>;

export type MockResolvers<
TypeMap extends DefaultMockResolvers = DefaultMockResolvers,
> = {
[K in keyof TypeMap]?: MockResolver<TypeMap[K]>;
};

export function generate(
operation: OperationDescriptor,
mockResolvers?: MockResolvers | null,
options?: { mockClientData?: boolean } | null,
): GraphQLSingularResponse;

export function generateWithDefer(
operation: OperationDescriptor,
mockResolvers?: MockResolvers | null,
options?: { mockClientData?: boolean; generateDeferredPayload?: boolean } | null,
): GraphQLResponse;
5 changes: 4 additions & 1 deletion types/relay-test-utils/lib/RelayModernMockEnvironment.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@ export interface MockFunctions {
reject: (request: ConcreteRequest | OperationDescriptor, error: Error | string) => void;
nextValue: (request: ConcreteRequest | OperationDescriptor, payload: GraphQLSingularResponse) => void;
complete: (request: ConcreteRequest | OperationDescriptor) => void;
resolve: (request: ConcreteRequest | OperationDescriptor, payload: GraphQLSingularResponse) => void;
resolve: (
request: ConcreteRequest | OperationDescriptor,
payload: GraphQLSingularResponse | readonly GraphQLSingularResponse[],
) => void;
getAllOperations: () => readonly OperationDescriptor[];
findOperation: (findFn: (operation: OperationDescriptor) => boolean) => OperationDescriptor;
queuePendingOperation: (query: GraphQLTaggedNode, variables: Variables) => void;
Expand Down
1 change: 1 addition & 0 deletions types/relay-test-utils/lib/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import * as MockPayloadGenerator from "./RelayMockPayloadGenerator";
export { DefaultMockResolvers, MockResolver, MockResolvers } from "./RelayMockPayloadGenerator";
export { RelayMockEnvironment as MockEnvironment } from "./RelayModernMockEnvironment";
export { MockPayloadGenerator };
export { createMockEnvironment } from "./RelayModernMockEnvironment";
Expand Down
2 changes: 1 addition & 1 deletion types/relay-test-utils/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"private": true,
"name": "@types/relay-test-utils",
"version": "14.1.9999",
"version": "17.0.9999",
"projects": [
"https://relay.dev"
],
Expand Down
44 changes: 44 additions & 0 deletions types/relay-test-utils/test/classical.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,47 @@ function TestQueryRenderer() {
/>
);
}

// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
type User = {
__typename?: "User";
id: string;
displayName?: string;
};

// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
type TypeMap = {
ID: string;
Boolean: boolean;
Int: number;
Float: number;
User: User;
};

type MockResolvers = MockPayloadGenerator.MockResolvers<TypeMap>;
type UserMockResolver = MockResolvers["User"];

const userResolver: UserMockResolver = (context, generateId) => {
const id = generateId();

return {
id: (context.name || "") + String(id),
displayName: "User " + id,
};
};

const mockResolvers: MockResolvers = {
User: userResolver,
};

const rawMockResolvers: MockPayloadGenerator.MockResolvers = {
Int: () => 42,
};

environment.mock.resolveMostRecentOperation(operation =>
MockPayloadGenerator.generate(operation, mockResolvers, { mockClientData: true })
);

environment.mock.resolveMostRecentOperation(operation =>
MockPayloadGenerator.generate(operation, rawMockResolvers, { mockClientData: true })
);
11 changes: 11 additions & 0 deletions types/relay-test-utils/test/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,17 @@ function environmentTests() {
environment.mock.nextValue(operation, { data: {} });
environment.mock.resolve(operation, { data: {} });
environment.mock.queuePendingOperation(userQuery, {});

// @ExpectType OperationDescriptor
const newOperation = environment.mock.getMostRecentOperation();

environment.mock.resolve(
operation,
MockPayloadGenerator.generateWithDefer(newOperation, null, {
generateDeferredPayload: true,
mockClientData: true,
}),
);
}

function testResolverTests() {
Expand Down