Skip to content

Latest commit

 

History

History
451 lines (384 loc) · 13.2 KB

README.md

File metadata and controls

451 lines (384 loc) · 13.2 KB
Raw

Example of Kotlin Spring Boot GraphQL Server with Spring Security authentication and authorization along with Kotlin GraphQL DSL Client generated by means of Kobby Maven Plugin from GraphQL Schema

This example uses Kotlinx Serialization engine. To see an example with Jackson serialization switch to branch jackson.

  1. See GraphQL schema here
  2. Start server: ./mvnw -pl kobby-maven-example-cinema-server -am spring-boot:run
  3. Try to execute GraphQL queries in console with login/password admin/admin (for example query { countries { id name } })
  4. Start client: ./mvnw -pl kobby-maven-example-cinema-kotlin-client -am spring-boot:run
  5. See queries, generated by Kobby DSL in client output
  6. See client source code here
  7. Just try to write your own query by means of Kobby DSL!

See Gradle example here

Spring Security authorization support

See example of GraphQL controller authorization here

See example of GraphQL server API tests here

See example of GraphQL subscription tests here

GraphQL query authorization example:

suspend fun country(id: Long): CountryDto? = hasAnyRole("USER", "ADMIN") {
    println("Query country by user [${authentication.name}] in thread [${Thread.currentThread().name}]")
    dslContext.selectFrom(COUNTRY)
        .where(COUNTRY.ID.eq(id))
        .fetchAny { it.toDto() }
}

GraphQL mutation authorization example:

override suspend fun createCountry(name: String): CountryDto = hasAnyRole("ADMIN") {
    println(
        "Mutation create country by user [${authentication.name}] " +
                "in thread [${Thread.currentThread().name}]"
    )
    val newCountry = dslContext.insertInto(COUNTRY)
        .set(COUNTRY.NAME, name)
        .returning()
        .fetchOne()!!
        .toDto()

    eventBus.fireCountryCreated(newCountry)
    newCountry
}

GraphQL subscription authorization example:

override suspend fun countryCreated(): Publisher<CountryDto> = hasAnyRole("USER", "ADMIN") {
    println(
        "Subscription on country created by user [${authentication.name}] " +
                "in thread [${Thread.currentThread().name}]"
    )
    eventBus.countryCreatedFlow().asPublisher()
}

Kotlin GraphQL Client DSL support

GraphQL Client DSL in this example is generated by means of Kobby Maven Plugin from GraphQL Schema. See source code here.

You can see more details about the generated GraphQL DSL here

You can see more details about the Kobby customization directives (@default, @required, @primaryKey and @selection) here

Simple GraphQL query example

GraphQL query:

{
  country(id: 1) {
    id
    name
  }
}

Kotlin DSL query:

context.query {
    country(1) {
        // id is primary key (see @primaryKey directive in schema)
        // name is default (see @default directive in schema)
    }
}

Complex GraphQL query example

GraphQL query:

{
  country(id: 7) {
    id
    name
    films(title: "d") {
      id
      title
      genre
      countryId
      actors(limit: -1) {
        id
        firstName
        lastName
        birthday
        gender
        countryId
        country {
          id
          name
        }
      }
    }
    actors(firstName: "d") {
      id
      fields(keys: ["birthday", "gender"])
      firstName
      lastName
      birthday
      gender
      countryId
      films(limit: -1) {
        id
        title
        countryId
      }
    }
  }
}

Kotlin DSL query:

context.query {
    country(7) {
        // id is primary key
        // name is default
        films {
            title = "d" // title is selection argument (see @selection directive in schema)

            // id is primary key
            // title is default
            genre()
            // countryId is required (see @required directive in schema)
            actors {
                limit = -1 // limit is selection argument (see @selection directive in schema)

                // id is primary key
                // firstName is default
                // lastName is default
                // birthday is required (see @required directive in schema)
                gender()
                // countryId is primary key
                country {
                    // id is primary key
                    // name is default
                }
            }
        }
        actors {
            firstName = "d" // firstName is selection argument (see @selection directive in schema)

            // id is primary key
            fields {
                keys = listOf(
                    "birthday",
                    "gender"
                ) // keys is selection argument (see @selection directive in schema)
            }
            // firstName is default
            // lastName is default
            // birthday is required
            gender()
            // countryId is primary key
            films {
                limit = -1 // limit is selection argument (see @selection directive in schema)

                // id is primary key
                // title is default
                // countryId is required
            }
        }
    }
}

GraphQL unions query example

GraphQL query:

{
  country(id: 17) {
    id
    native {
      __typename
      ... on Film {
        id
        title
        genre
        countryId
      }
      ... on Actor {
        id
        firstName
        lastName
        birthday
        gender
        countryId
        country {
          id
          name
        }
      }
    }
  }
}

Kotlin DSL query:

context.query {
    country(17) {
        __minimize() // switch off defaults to minimize query
        // id is primary key
        native {
            // __typename generated by Kobby
            __onFilm {
                // id is primary key
                // title is default
                genre()
                // countryId is required
            }
            __onActor {
                // id is primary key
                // firstName is default
                // lastName is default
                // birthday is required
                gender()
                // countryId is primary key
                country {
                    // id is primary key
                    // name is default
                }
            }
        }
    }
}

GraphQL subscription example

GraphQL subscription:

subscription {
  filmCreated(countryId: 1) {
    id
    title
    countryId
    country {
      id
      name
    }
  }
}
context.subscription {
    filmCreated(countryId = 1) {
        // id is primary key (see @primaryKey directive in schema)
        // title is default (see @default directive in schema)
        // countryId is required (see @required directive in schema)
        country {
            // id is primary key (see @primaryKey directive in schema)
            // name is default (see @default directive in schema)
        }
    }
}.subscribe {
    while (true) {
        val newFilm = receive().filmCreated
        println("<< Film created: id=${newFilm.id} name=${newFilm.title} country=${newFilm.country.name}")
    }
}

API Customization

You can customize the generated GraphQL DSL by means of Kotlin extension functions. Note that all generated entities contains __context() function that returns instance of DSL Context interface. So each entity contains an entry point for executing GraphQL queries.

First, let extend our DSL Context (source code see here):

suspend fun CinemaContext.findCountry(
    id: Long, 
    __projection: CountryProjection.() -> Unit = {}
): Country? =
    query {
        country(id, __projection)
    }.country

suspend fun CinemaContext.fetchCountry(
    id: Long, 
    __projection: CountryProjection.() -> Unit = {}
): Country = 
    findCountry(id, __projection)!!

Second, let extend our Country entity (source code see here):

suspend fun Country.refresh(
    __projection: (CountryProjection.() -> Unit)? = null
): Country =
    __context().query {
        country(id) {
            __projection?.invoke(this) ?: __withCurrentProjection()
        }
    }.country!!

suspend fun Country.findFilms(
    __query: CountryFilmsQuery.() -> Unit = {}
): List<Film> =
    refresh {
        __minimize() // switch off all default fields to minimize GraphQL response
        films(__query)
    }.films

Ok, we are ready to use our customized API:

 // Fetch country by id
val country = context.fetchCountry(7)
println("Country: id=${country.id} name='${country.name}'")

//Find all country films
val films = country.findFilms {
    limit = -1
    genre()
}

films.forEach {
    println("Film: id=${it.id}, title='${it.title}' genre=${it.genre}")
}

This Kotlin DSL code will produce two GraphQL queries:

{
  country(id: 7) {
    id
    name
  }
}
{
  country(id: 7) {
    id
    films(limit: -1) {
      id
      title
      genre
      countryId
    }
  }
}

More sophisticated example of API customization see in API tests .

The tests createCountryWithFilmAndActorsByMeansOfGeneratedAPI and createCountryWithFilmAndActorsByMeansOfCustomizedAPI implements the same scenario by means of native generated API and by means of customized API. You can compare these two test cases to see that the customized API significantly improves the readability of your code.

Subscription API customization

You can customize subscriptions DSL too.

First, let extend our DSL Context (source code see here):

fun CinemaContext.onFilmCreated(
    countryId: Long?,
    __projection: FilmProjection.() -> Unit = {}
): CinemaSubscriber<Film> = CinemaSubscriber {
    subscription {
        filmCreated(countryId, __projection)
    }.subscribe {
        it(CinemaReceiver {
            receive().filmCreated
        })
    }
}

Second, extend our Country entity (source code see here):

fun Country.onFilmCreated(__projection: FilmProjection.() -> Unit = {}): CinemaSubscriber<Film> =
    __context().onFilmCreated(id, __projection)

Ok, we are ready to listen new films in country:

val australia = context.fetchCountry(1)
australia.onFilmCreated().subscribe {
    while (true) {
        val newFilm = receive()
        println("<< Film created: id=${newFilm.id} " +
                "name=${newFilm.title}")
    }
}

More examples of subscription customization see in Subscription Tests .

The tests subscriptionsByMeansOfGeneratedAPI and subscriptionsByMeansOfCustomizedAPI implements the same scenario by means of native generated subscription API and by means of customized API.