Create GraphQL endpoint, leveraging neo4j graphql library v3

[halcyondude]

GraphQL schema --> source of truth

Tasks

• Create GraphQL API endpoint #52

• MVP CNCF Schema

  • export data model from arrows.app --> landscape.graphql
  • generate full schema from types
  • srg-xyz type heirarchy
  • LandscapeEntity (base type)
    • Card (base)
      • Member
      • Project
      • TAG
      • TOC
      • EUG
      • Person

• use schema to drive data model instantiation --> neo

Moved to new/other issue(s):

• create apps/landscape-introspector (introspector docs, example) #51
• feat: authentication and authorization (JWT support) in GraphQL model. #96
• constraints and indexes, full text where it makes sense(Relationship Indexes - assess and implement as necessary #73, Create full-text indices (Lucene) for relationships' properties #20)
• use graphql to load data via mutations. (Load data via GraphQL Mutations endpoint (JSON/CSV --> GraphQL --> neo4j-graphql --> OpenCypher) #63)

More Info

• https://neo4j.com/docs/graphql-manual/current/type-definitions/autogeneration
• https://neo4j.com/docs/graphql-manual/current/type-definitions/database-mapping/#_plural
• https://neo4j.com/docs/graphql-manual/current/type-definitions/database-mapping/#_using_jwt_and_context

---

resources

• https://neo4j.com/developer-blog/announcing-the-release-of-the-neo4j-graphql-library-3-0-0
• https://youtu.be/8Le6MeTvCAg
• https://github.com/johnymontana/neo4j-graphql-3.0-livestream

[halcyondude]

after doing a bit of research, a few things are clear.

• the data model is best described via GraphQL
• data is likely best loaded via GraphQL mutations
• graphql type definitions generated using the Introspector nicely handle constraint and index declarations
• a VERY nice workflow using arrows.app exists.
  • generate data model (as we've done) using arrows.app
  • export as .graphql
  • write the schema --> Neo4j DB using the neo graphql v3 library

Game Changer

https://neo4j.com/docs/graphql-manual/current/type-definitions/interfaces/#_directive_inheritance

Any directives present on an interface or its fields will be "inherited" by any object types implementing it. For example, the type definitions above could be refactored to have the @relationship directive on the actors field in the Production interface instead of on each implementing type as it is currently:

interface Production {
    title: String!
    actors: [Actor!]! @relationship(type: "ACTED_IN", direction: IN, properties: "ActedIn")
}

type Movie implements Production {
    title: String!
    actors: [Actor!]!
    runtime: Int!
}

type Series implements Production {
    title: String!
    actors: [Actor!]!
    episodes: Int!
}

interface ActedIn @relationshipProperties {
    role: String!
}

type Actor {
    name: String!
    actedIn: [Production!]! @relationship(type: "ACTED_IN", direction: OUT, properties: "ActedIn")
}

https://neo4j.com/docs/graphql-manual/current/type-definitions/interfaces/#_overriding

In addition to inheritance, directives can be overridden on a per-implementation basis. Say you had an interface defining some Content, with some basic authorization rules:

interface Content
    @auth(rules: [{ operations: [CREATE, UPDATE, DELETE], allow: { author: { username: "$jwt.sub" } } }]) {
    title: String!
    author: [Author!]! @relationship(type: "HAS_CONTENT", direction: IN)
}

type User {
    username: String!
    content: [Content!]! @relationship(type: "HAS_CONTENT", direction: OUT)
}

type PublicContent implements Content {
    title: String!
    author: [Author!]!
}

type PrivateContent implements Content
    @auth(rules: [{ operations: [CREATE, READ, UPDATE, DELETE], allow: { author: { username: "$jwt.sub" } } }]) {
    title: String!
    author: [Author!]!
}

[halcyondude]

https://github.com/cncf/landscape-graph/blob/4-graphql-endpoint-v1/db/cncf/cncf.graphql

https://github.com/cncf/landscape-graph/tree/4-graphql-endpoint-v1/db/cncf

@AlexxNica FYI (WIP - but progress all the same :))