Skip to content

Latest commit

 

History

History
32 lines (18 loc) · 3.11 KB

README.md

File metadata and controls

32 lines (18 loc) · 3.11 KB
Raw

Realities Back-end

The Realities back-end is a simple Node.js service that exposes a GraphQL API via a /graphql endpoint. It primarily reads and stores data in a Neo4j graph database, but also interacts with the Plato Core mongodb server.

Core concepts

Authentication with Keycloak

When the user is logged in, they send a Json Web Token (JWT) in an authentication header with every request. The JWT is validated and parsed using some middleware. When we set up the GraphQL endpoint, the parsed JWT is made available to our GraphQL resolvers in a user property on their context argument. The user's info can be used in the resolver to determine whether they have access to do whatever they're trying to do. If they don't, an error with a message should be thrown and GraphQL will take care of sending an appropriate error response to the front-end.

Neo4j/GraphQL schema

Neo4j doesn't really have a fixed schema, but we have an implicit schema that is also codified in the GraphQL schema.

We have three main types in our schema, namely Org, Person, Need and Responsibliity. Each of these have their own properties that are somewhat self-explanatory. Some notable properties that might not be self-explanatory are:

  • nodeId: Neo4j's native ID's are semantic. They're basically just an integer that gets incremented every time you create a node. They start counting from the highest current ID number. This creates a few problems if we try to use Neo4j's native IDs as UUIDs throughout the system. For example, we use a need's UUID in the URL on the front-end to keep track of which need is selected in the UI. That means that people can send each other links to a specific need. If you remove a need in Neo4j and create a new one, the new need might end up getting the same ID as the old one you created. That's not ideal. Instead of using Neo4j's native ID to identify nodes, we generate our own UUID v4 using a library whenever we create a node and save it in a property named nodeId.
  • orgId: Acting a bit like nodeId, but sits on Orgs instead. We don't generate it as a uuid, it instead is the same as the corresponding org's _id in plato core.
  • created: The timestamp when the node was created.
  • deleted: The timestamp when the node was soft-deleted. We don't actually delete nodes permanently in Realities. Instead we set the deleted property on the node, and whenever nodes are fetched we filter out anything where the deleted property is set.

graphql-tools

The GraphQL schema is defined using a set of tools from Apollo named graphql-tools. The tools are built around a backend architecture that Apollo recommends when building a GraphQL API, but they are functional and modular enough that we can swap out pieces in the future if it proves useful.

Inspect the GraphQL API easily

When the back-end is running, explore the API at http://localhost:3100/graphql.

Interaction with Plato Core

TODO: explain