GraphQL-RxJS Integration package for Meteor
This package is used along with meteor-rxjs to enable reactive graphql experiance for meteor.
Mongo Collections:
Mongo Collections needs to be initialized using meteor-rxjs
wrapper,
this way Collection.find
will return an RxJs Observable:
import { MongoObservable } from 'meteor-rxjs';
export interface Message {
from: String
content: String
}
export const Messages = new MongoObservable.Collection<Message>('messages');
Schema:
GraphQL-RxJS adds Observable
support for graphql resolvers,
also, resolvers are running under meteor invocation.
import { makeExecutableSchema } from 'graphql-tools';
export const schema = makeExecutableSchema({
typeDefs: `
type Message {
content: String
}
type Query {
allMessages: [Message]
}
type Mutation {
addMessage(content: String!): Boolean
}
`,
resolvers: {
Query: {
allMessages: (root, args, ctx) => {
return ctx.Messages.find({});
},
},
Mutation: {
addMessage: (root, args, ctx) => {
if ( !this.userId ) {
throw new Error('Not logged in');
}
ctx.Messages.collection.insert({
from: this.userId,
content: args.content,
});
return true;
},
},
},
});
Server Side:
Server side needs to be initialized by just providing a schema and a context:
import { runGraphQLServer } from 'meteor-graphql-rxjs';
import { schema } from './schema';
import { Messages } from './collections/messages';
Meteor.startup(() => {
const sub = runGraphQLServer(Npm.require, {
schema,
createContext: (payload) => ({
Messages,
}),
})
.subscribe(undefined, (error) => {
console.error('GraphQL Server Failed:', error);
});
});
at this point, you should have 2 new endpoints in your graphql server:
/graphql
- websocket graphql endpoint./graphiql
- GraphiQL Interface connected to that endpoint. (Only if graphiql
option = true)Client Side:
Client can just import a connected network interface:
import { getNetworkInterface } from 'meteor-graphql-rxjs';
const networkInterface = getNetworkInterface();
// ...
// you can now use this networkInterface to send graphql requests,
// or provide it for apollo client for example.
function getNetworkInterface(params?: ClientOptions): SubscriptionsClient
- This function will return aparams
-> optional extra params for SubscriptionsClient
runGraphQLServer(mRequire: MeteorRequire, options: GraphQLServerOptions): Observable<GraphQLServerRuntime>
- This function will return an Observable. subscribing on this observable will start the server.
mRequire
-> Meteor's Npm.Require
function.options
-> actual server options:
schema
-> Required Parameter with GraphQLSchema to execute.createContext: (initPayload: any)
-> Optional callback to provide context per session.connect
payload.quiet
-> Optional boolean to disable info prints.graphiql
-> Optional boolean to enable graphiql.graphiqlQuery
-> Optional string containing default document for GraphiQL.this package works with Meteor's settings
all you need to do is add meteor-graphql-rxjs
key, for example:
{
"meteor-graphql-rxjs": {
"graphqlEndpoint": "/graphql",
"graphiqlEndpoint": "/graphiql"
}
}
Available options:
graphqlEndpoint
: path for graphql websocket endpointgraphiqlEndpoint
: path for graphiql interface (incase graphiql
= true)resolvers will be executed under Meteor's invocation, which means you can use:
this.userId
=> Same as this.userId inside any other invocation.this.call(methodName, ...args)
=> invoke Meteor method and return promise for the result.this.userId$
=> Observable with userId, for example:import { makeExecutableSchema } from 'graphql-tools';
export const schema = makeExecutableSchema({
typeDefs: `
type Message {
content: String
}
type Query {
myMessage: [Message]
}
`,
resolvers: {
Query: {
myMessage: (root, args, ctx) => {
return this.userId$.switchMap((userId) => {
if ( !userId ) {
return Observable.of(null);
}
return ctx.Messages.find({ from: userId });
});
},
},
},
});
This package also bring extentions with it, the extentions should connect between Meteor's world into GraphQL's.
at the moment there is only basic functionality, but we can extend in the future:
accounts-base
):
type Mutation {
loginWithToken(token: String!): ID!
logout: ID
}
TODO
Contributions, issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR!