commonMain.it.unibo.alchemist.boundary.graphql.client.SimulationHandler.kt Maven / Gradle / Ivy

Go to download

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

GraphQL API for Alchemist

The newest version!

/*
 * Copyright (C) 2010-2023, Danilo Pianini and contributors
 * listed, for each module, in the respective subproject's build.gradle.kts file.
 *
 * This file is part of Alchemist, and is distributed under the terms of the
 * GNU General Public License, with a linking exception,
 * as described in the file LICENSE in the Alchemist distribution's top directory.
 */

package it.unibo.alchemist.boundary.graphql.client

import com.apollographql.apollo3.api.Mutation

/**
 * Utility class to handle simulation lifecycle through GraphQL queries.
 *
 * @param graphqlClient the GraphQL client connected to the server
 */
class SimulationHandler(private val graphqlClient: GraphQLClient) {

    /**
     * Pauses the simulation.
     */
    suspend fun pause() =
        handleSimulation(
            PauseSimulationMutation(),
        ) as PauseSimulationMutation.Data

    /**
     * Terminates the simulation.
     */
    suspend fun terminate() =
        handleSimulation(
            TerminateSimulationMutation(),
        ) as TerminateSimulationMutation.Data

    /**
     * Plays the simulation.
     */
    suspend fun play(): PlaySimulationMutation.Data {
        val status = handleSimulation(
            PlaySimulationMutation(),
        ) as PlaySimulationMutation.Data

        check(status.play == "RUNNING") { status.play }
        return status
    }

    /**
     * Returns the status of the simulation.
     */
    suspend fun status() = graphqlClient.query(SimulationStatusQuery()).execute().data?.simulation?.status

    private suspend fun handleSimulation(action: Mutation<*>) =
        graphqlClient.mutation(action).execute().data!!
}