com.manywho.sdk.client.entities.FlowState Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-client Show documentation
There is a newer version: 2.0.1
package com.manywho.sdk.client.entities;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.manywho.sdk.client.raw.RawRunClient;
import com.manywho.sdk.client.utils.PageComponentUtils;
import com.manywho.sdk.entities.run.EngineInvokeRequest;
import com.manywho.sdk.entities.run.EngineInvokeResponse;
import com.manywho.sdk.entities.run.elements.map.MapElementInvokeRequest;
import com.manywho.sdk.entities.run.elements.map.MapElementInvokeResponse;
import com.manywho.sdk.entities.run.elements.ui.PageRequest;
import com.manywho.sdk.entities.run.elements.ui.PageResponse;
import com.manywho.sdk.enums.InvokeType;
import org.apache.commons.collections4.CollectionUtils;

import java.util.List;
import java.util.Optional;
import java.util.UUID;
import java.util.stream.Collectors;

public class FlowState {
    private RawRunClient rawRunClient;
    @JsonProperty
    private UUID tenant;
    @JsonProperty
    private EngineInvokeResponse invokeResponse;

    public FlowState() {
    }

    public FlowState(RawRunClient rawRunClient, UUID tenant, EngineInvokeResponse invokeResponse) {
        this.tenant = tenant;
        this.rawRunClient = rawRunClient;
        this.invokeResponse = invokeResponse;
    }

    /**
     * Get the raw EngineInvokeResponse object for the current State
     *
     * @return the raw EngineInvokeResponse for the current State
     */
    public EngineInvokeResponse getInvokeResponse() {
        return invokeResponse;
    }

    /**
     * Get the Invoke Type of the current State
     *
     * @return the Invoke Type of the current State
     */
    public InvokeType getInvokeType() {
        return invokeResponse.getInvokeType();
    }

    /**
     * Get the State ID of the running Flow
     *
     * @return the State ID of the running Flow
     */
    public UUID getState() {
        return UUID.fromString(invokeResponse.getStateId());
    }

    /**
     * Get the Tenant ID of the running Flow
     *
     * @return the Tenant ID of the running Flow
     */
    public UUID getTenant() {
        return tenant;
    }

    /**
     * Check if the current step in the Flow has any components
     *
     * @return if the current step has any components
     */
    public boolean hasPageComponents() {
        return CollectionUtils.isNotEmpty(getPageResponse().getPageComponentResponses());
    }

    /**
     * Get a list of the components in the current step
     *
     * @return a list of the components in the current step
     */
    public List getPageComponents() {
        return getPageResponse().getPageComponentResponses().stream()
                .map(componentResponse -> PageComponentUtils.createPageComponent(componentResponse, getPageResponse().getPageComponentDataResponses()))
                .collect(Collectors.toList());
    }

    /**
     * Check if the current step in the Flow has any outcomes
     *
     * @return if the current step has any outcomes
     */
    public boolean hasOutcomes() {
        return CollectionUtils.isNotEmpty(getMapElementInvokeResponse().getOutcomeResponses());
    }

    /**
     * Get a list of the outcomes on the current step in the Flow
     *
     * @return a list of the outcomes for the current step
     */
    public List getOutcomes() {
        return getMapElementInvokeResponse().getOutcomeResponses().stream()
                .map(Outcome::new)
                .collect(Collectors.toList());
    }

    /**
     * Select an outcome by it's name, then progress the Flow
     *
     * @param name the name of the outcome to select
     * @return the updated state of the Flow, after selecting the desired outcome
     */
    public FlowState selectOutcomeByName(String name) {
        Optional outcomeOptional = this.getOutcomes().stream()
                .filter(outcome -> outcome.getName().equals(name))
                .findFirst();

        if (!outcomeOptional.isPresent()) {
            throw new RuntimeException("An outcome with the name " + name + " could not be found");
        }

        return selectOutcome(outcomeOptional.get());
    }

    /**
     * Select a specific outcome in the current Flow's state, send any inputs, then progress
     *
     * @param outcome the outcome to select in the Flow
     * @param pageRequest an object that contains the inputs that you wish to send to the Flow
     * @return the updated state of the Flow, after selecting the outcome and sending any inputs
     */
    public FlowState selectOutcome(Outcome outcome, PageRequest pageRequest) {
        EngineInvokeRequest invokeRequest = new EngineInvokeRequest();
        invokeRequest.setCurrentMapElementId(invokeResponse.getCurrentMapElementId());
        invokeRequest.setInvokeType(InvokeType.Forward);
        invokeRequest.setMapElementInvokeRequest(new MapElementInvokeRequest(outcome.getId(), pageRequest));
        invokeRequest.setStateId(invokeResponse.getStateId());
        invokeRequest.setStateToken(invokeResponse.getStateToken());

        invokeResponse = rawRunClient.execute(this.tenant, null, invokeRequest);

        return this;
    }

    /**
     * Select a specific outcome in the current Flow's state, and progress
     *
     * @param outcome the outcome to select in the Flow
     * @return the updated state of the flow, after selecting the outcome
     */
    public FlowState selectOutcome(Outcome outcome) {
        return this.selectOutcome(outcome, null);
    }

    /**
     * Tell the running state to SYNC, which synchronises the page metadata and state with this object again
     *
     * @return the updated state of the flow, after SYNCing
     */
    public FlowState sync() {
        EngineInvokeRequest invokeRequest = new EngineInvokeRequest();
        invokeRequest.setCurrentMapElementId(invokeResponse.getCurrentMapElementId());
        invokeRequest.setInvokeType(InvokeType.Sync);
        invokeRequest.setMapElementInvokeRequest(new MapElementInvokeRequest());
        invokeRequest.setStateId(invokeResponse.getStateId());
        invokeRequest.setStateToken(invokeResponse.getStateToken());

        PageResponse previousPageResponse = getPageResponse();

        invokeResponse = rawRunClient.execute(this.tenant, null, invokeRequest);

        // When SYNCing, ManyWho won't return the scaffolding, so we need to get it from the previous response if they exist
        if (previousPageResponse != null) {
            getPageResponse().setPageComponentResponses(previousPageResponse.getPageComponentResponses());
            getPageResponse().setPageContainerResponses(previousPageResponse.getPageContainerResponses());
        }

        return this;
    }

    private PageResponse getPageResponse() {
        return getMapElementInvokeResponse().getPageResponse();
    }

    private MapElementInvokeResponse getMapElementInvokeResponse() {
        return invokeResponse.getMapElementInvokeResponses().get(0);
    }
}