Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Simplify subscriptions. #860

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 18, 2017
Merged

Simplify subscriptions. #860

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Simplify subscriptions. 
There was a secondary function in subscribe.js which doesn't correspond to a spec function or provide much value. It was an artifact of an earlier implementation. Collapsing it into the defined createSourceEventStream makes the alignment to spec more clear. It also moves this function below `subscribe` in the file, making its purpose more clear.
  • Loading branch information
@leebyron
leebyron committed May 18, 2017
commit 4b534a2a4b547ad2c3098ea1df0e0b585767808c
95 changes: 43 additions & 52 deletions src/subscription/subscribe.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,51 +25,8 @@ import { GraphQLSchema } from '../type/schema';
import invariant from '../jsutils/invariant';
import mapAsyncIterator from './mapAsyncIterator';

import type {
ExecutionContext,
ExecutionResult,
} from '../execution/execute';
import type {
DocumentNode,
OperationDefinitionNode,
} from '../language/ast';

/**
* Implements the "CreateSourceEventStream" algorithm described in the
* GraphQL specification, resolving the subscription source event stream.
*
* Returns an AsyncIterable
*
* A Source Stream represents the sequence of events, each of which is
* expected to be used to trigger a GraphQL execution for that event.
*/
export function createSourceEventStream(
schema: GraphQLSchema,
document: DocumentNode,
rootValue?: mixed,
contextValue?: mixed,
variableValues?: ?{[key: string]: mixed},
operationName?: ?string,
): AsyncIterable<mixed> {
// If a valid context cannot be created due to incorrect arguments,
// this will throw an error.
const exeContext = buildExecutionContext(
schema,
document,
rootValue,
contextValue,
variableValues,
operationName
);

// Call the `subscribe()` resolver or the default resolver to produce an
// AsyncIterable yielding raw payloads.
return resolveSubscription(
exeContext,
exeContext.operation,
rootValue
);
}
import type { ExecutionResult } from '../execution/execute';
import type { DocumentNode } from '../language/ast';

/**
* Implements the "Subscribe" algorithm described in the GraphQL specification.
Expand Down Expand Up @@ -97,6 +54,10 @@ export function subscribe(

// For each payload yielded from a subscription, map it over the normal
// GraphQL `execute` function, with `payload` as the rootValue.
// This implements the "MapSourceToResponseEvent" algorithm described in
// the GraphQL specification. The `execute` function provides the
// "ExecuteSubscriptionEvent" algorithm, as it is nearly identical to the
// "ExecuteQuery" algorithm, for which `execute` is also used.
return mapAsyncIterator(
subscription,
payload => execute(
Expand All @@ -110,12 +71,40 @@ export function subscribe(
);
}

function resolveSubscription(
exeContext: ExecutionContext,
operation: OperationDefinitionNode,
rootValue: mixed
/**
* Implements the "CreateSourceEventStream" algorithm described in the
* GraphQL specification, resolving the subscription source event stream.
*
* Returns an AsyncIterable, may through a GraphQLError.
*
* A Source Stream represents the sequence of events, each of which is
* expected to be used to trigger a GraphQL execution for that event.
*
* This may be useful when hosting the stateful subscription service in a
* different process or machine than the stateless GraphQL execution engine,
* or otherwise separating these two steps. For more on this, see the
* "Supporting Subscriptions at Scale" information in the GraphQL specification.
*/
export function createSourceEventStream(
schema: GraphQLSchema,
document: DocumentNode,
rootValue?: mixed,
contextValue?: mixed,
variableValues?: ?{[key: string]: mixed},
operationName?: ?string,
): AsyncIterable<mixed> {
const type = getOperationRootType(exeContext.schema, exeContext.operation);
// If a valid context cannot be created due to incorrect arguments,
// this will throw an error.
const exeContext = buildExecutionContext(
schema,
document,
rootValue,
contextValue,
variableValues,
operationName
);

const type = getOperationRootType(schema, exeContext.operation);
const fields = collectFields(
exeContext,
type,
Expand All @@ -131,12 +120,14 @@ function resolveSubscription(
const responseName = responseNames[0];
const fieldNodes = fields[responseName];
const fieldNode = fieldNodes[0];
const fieldDef = getFieldDef(exeContext.schema, type, fieldNode.name.value);
const fieldDef = getFieldDef(schema, type, fieldNode.name.value);
invariant(
fieldDef,
'This subscription is not defined by the schema.'
);

// Call the `subscribe()` resolver or the default resolver to produce an
// AsyncIterable yielding raw payloads.
const resolveFn = fieldDef.subscribe || defaultFieldResolver;

const info = buildResolveInfo(
Expand All @@ -148,7 +139,7 @@ function resolveSubscription(
);

// resolveFieldValueOrError implements the "ResolveFieldEventStream"
// algorithm from GraphQL specification. It differs from
// algorithm from GraphQL specification. It differs from
// "ResolveFieldValue" due to providing a different `resolveFn`.
const subscription = resolveFieldValueOrError(
exeContext,
Expand Down