Apollo Server 2 how to setup subscriptions

JavaScript 3.16% TypeScript 96.84%

graphql mongodb mongoose apollo-server apollographql

apollo2-subscriptions-how-to's Introduction

Apollo server 2.0

This project is a good starting point for all the people that want to have apollo-server 2.0 ready to use. It integrates:

queries
mutations
subscriptions (real-time data)
authentication and authorisation (using google sign-on as provider server)
schema stitching
mongo db
logger (it will create a file error.log and write on it in case of error - to change the level edit common/util/logger.ts lines 12, 13, 14 )

Installation:

install mongodb - refer to mongodb guide
npm install

Environment

In the root folder is available a file called .env. It contains all the configuration environment for:

mongodb
google-sign-in as identity server for authentication and authorisation. More info available at http://www.dzurico.com/apollo-server-2-0-auth-with-google-signin/

available commands

test environment: npm run dev (it will automatically rerun your code all the time you save and will check for tslint errors and formatting style errors.)
production environment: npm run prod

How to configure prettier on your editor:

Webstorm

VS Code

prettier-vscode can be installed using the extension sidebar. Search for Prettier - Code formatter. It can also be installed using ext install prettier-vscode in the command palette.

Other editors

https://prettier.io/docs/en/editors.html

Playground

Open your browser to this address: http://localhost:4000 and run the available commands:

hello world

query {
  hello
}

fetch all the posts:

query {
  posts {
    author
    comment
  }
}

add a new post

mutation {
  addPost(author: "Daniele Zurico", comment: "www.dzurico.com") {
    author
    comment
  }
}

realtime data (Subscription) for post

subscription {
  postAdded {
    author
    comment
  }
}

fetch all the users (you need to be authenticated with google identity server): For more information how to setup: http://www.dzurico.com/apollo-server-2-0-auth-with-google-signin/

query{
  users {
    id
    name
    surname
  }
}

For a better explanation on how I setup this repo please refer to:

apollo2-subscriptions-how-to's People

Contributors

Stargazers

Watchers

apollo2-subscriptions-how-to's Issues

Link to subscriptions is broken...

Thank you for your efforts to clarify subscriptions in 2.0 - I am struggling with it myself.

The following link seems to be broken:
http://www.dzurico.com/apollo-server-2-0-real-time-data-with-subscriptions/

Complex Type example

Thanks for your work on this. Can you give an example of how you would accomplish in your app structure?

gql`Post {
    author: Author
}`

Session in webSocket subscriptions

I'm using Apollo Server 2 and Express.js vanilla (with apollo-server-express).

Everything works good also with Subscriptions except the Express session mechanism.

The problem:

I'm using cookie-session (https://github.com/expressjs/cookie-session, but I think this is the same for express-session middleware) and when my browser start a new connection with my server the ApolloServer onConnect hook doesn't have the req attribute and neither req.session and so on...

What I can do is to parse the cookies from webSocket.upgradeReq.headers.cookie in onConnect lifecycle hook, but it seems to me very hacky.

The code:

const { ApolloServer } = require('apollo-server-express')

const typeDefs = require('../src/graphql/types')
const resolvers = require('../src/graphql/resolvers')
const models = require('../src/models')

const apolloServer = new ApolloServer({
  typeDefs,
  resolvers,
  context: ({ req, connection }) => {
    // connection exists only on webSocket connection
    if (connection) {
      return {
        currentUser: connection.context.currentUser // <-- I NEED THIS!
      }
    }
    // if not a (webSocket) connection it is a "default" HTTP call
    return {
      models,
      currentUser: { id: req.user.id }
    }
  },
  subscriptions: {
    onConnect: (connectionParams, webSocket) => {
      // "connectionParams" is from the client but I cannot use it because cookies are HTTP-Only
      // I can retrieve cookies from here: "webSocket.upgradeReq.headers.cookie" but then I need to parse them which seems a bit hacky to me
      // return { currentUser: req.user.id } // <-- I NEED THIS (req.user.id doesn't exists)!
    }
  }
})

module.exports = apolloServer

I can't find anything on Apollo Server Docs site (for other topics very well documented!).

Where am I doing wrong?

StackOverflow question: https://stackoverflow.com/questions/52280481/graphql-subscription-websocket-nodejs-express-session-with-apollo-server-2

too many import errors in buildSchemaFromSDL

validateSDL , specifiedSDLRules , ValidationRule and many others

ApolloServer 2 production question

Is this subscriptions setup subject to the production notice given here?

"This is not suitable for running in a serious production app, because there is no way to share subscriptions and publishes across many running servers."

daniele-zurico / apollo2-subscriptions-how-to Goto Github PK