com.expediagroup.graphql.server.execution.subscription.GraphQLSubscriptionHooks.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of graphql-kotlin-server Show documentation

Common code for running a GraphQL server in any HTTP server framework

The newest version!

/*
 * Copyright 2023 Expedia, Inc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.expediagroup.graphql.server.execution.subscription

import com.expediagroup.graphql.server.types.GraphQLRequest
import graphql.GraphQLContext

/**
 * GraphQL WS subscription lifecycle hooks.
 * Allows API user to add custom callbacks on subscription events, e.g. to add validation, context tracking etc.
 *
 * Inspired by Apollo Subscription Server Lifecycle Events.
 * https://www.apollographql.com/docs/graphql-subscriptions/lifecycle-events/
 */
interface GraphQLSubscriptionHooks {

    /**
     * Allows validation of connectionParams prior to starting the connection.
     * You can reject the connection by throwing an exception.
     */
    fun onConnect(
        connectionParams: Any?,
        session: T,
        graphQLContext: GraphQLContext
    ): GraphQLContext = graphQLContext

    /**
     * Called when the client executes a GraphQL operation.
     * The context here is what returned from [onConnect] earlier.
     */
    fun onOperation(
        operationId: String,
        payload: GraphQLRequest,
        session: T,
        graphQLContext: GraphQLContext,
    ): Unit = Unit

    /**
     * Called when client unsubscribes
     */
    fun onOperationComplete(
        operationId: String,
        session: T,
        graphQLContext: GraphQLContext?,
    ): Unit = Unit

    /**
     * Called when the client disconnects
     */
    fun onDisconnect(
        session: T,
        graphQLContext: GraphQLContext?
    ): Unit = Unit
}