@orchestrator-ui/orchestrator-ui-components/src/rtk/endpoints/metadata/workflows.ts

Library of UI Components used to display the workflow orchestrator frontend

import { METADATA_WORKFLOWS_ENDPOINT } from '@/configuration';
import { BaseQueryTypes, orchestratorApi } from '@/rtk';
import {
    BaseGraphQlResult,
    GraphqlQueryVariables,
    MetadataDescriptionParams,
    WorkflowDefinition,
    WorkflowDefinitionsResult,
} from '@/types';

export const workflowsDescription = `
query MetadataWorkflowsDescription(
    $workflowName: String!
) {
    workflows(
        filterBy: [{ field: "name", value: $workflowName }]
    ) {
        page {
            name
            description
        }
    }
}
`;

export const workflowsQuery = `
query MetadataWorkflows(
    $first: Int!
    $after: Int!
    $sortBy: [GraphqlSort!]
    $query: String
) {
    workflows(
        first: $first
        after: $after
        sortBy: $sortBy
        query: $query
        filterBy: { field: "target", value: "CREATE|MODIFY|TERMINATE" }
    ) {
        page {
            workflowId
            name
            description
            target
            isTask
            products {
                tag
            }
            createdAt
        }
        pageInfo {
            endCursor
            hasNextPage
            hasPreviousPage
            startCursor
            totalItems
            sortFields
            filterFields
        }
    }
}
`;

export type WorkflowsDescriptionQueryVariables = {
    workflowName: string;
};

export type WorkflowsDescriptionResponse = Pick<
    WorkflowDefinition,
    'name' | 'description'
>;

export type WorkflowsResponse = {
    workflows: WorkflowDefinition[];
} & BaseGraphQlResult;

const workflowsApi = orchestratorApi.injectEndpoints({
    endpoints: (builder) => ({
        getWorkflows: builder.query<
            WorkflowsResponse | undefined,
            GraphqlQueryVariables<WorkflowDefinition>
        >({
            query: (variables) => ({
                document: workflowsQuery,
                variables,
            }),
            transformResponse: (
                response: WorkflowDefinitionsResult | undefined,
            ): WorkflowsResponse | undefined => {
                if (!response) {
                    return undefined;
                }

                const workflows = response?.workflows.page || [];
                const pageInfo = response?.workflows.pageInfo || {};

                return {
                    workflows,
                    pageInfo,
                };
            },
        }),
        getDescriptionForWorkflowName: builder.query<
            WorkflowsDescriptionResponse,
            WorkflowsDescriptionQueryVariables
        >({
            query: (variables) => ({
                document: workflowsDescription,
                variables,
            }),
            transformResponse: (
                response: WorkflowDefinitionsResult<
                    Pick<WorkflowDefinition, 'name' | 'description'>
                >,
                _,
                variables,
            ): WorkflowsDescriptionResponse => {
                const workflows = response.workflows.page || [];
                const workflow = workflows.find(
                    ({ name }) => name === variables.workflowName,
                );

                if (!workflow) {
                    throw new Error(
                        `No workflow found with name ${variables.workflowName}`,
                    );
                }

                const { name, description } = workflow;
                return {
                    name,
                    description,
                };
            },
        }),
    }),
});

export const {
    useGetWorkflowsQuery,
    useLazyGetWorkflowsQuery,
    useGetDescriptionForWorkflowNameQuery,
} = workflowsApi;

const workflowsRestApi = orchestratorApi.injectEndpoints({
    endpoints: (build) => ({
        updateWorkflow: build.mutation<null, MetadataDescriptionParams>({
            query: (workflow) => ({
                url: `${METADATA_WORKFLOWS_ENDPOINT}/${workflow.id}`,
                method: 'PATCH',
                headers: {
                    'Content-Type': 'application/json',
                },
                body: {
                    description: workflow.description,
                },
            }),
            extraOptions: {
                baseQueryType: BaseQueryTypes.fetch,
            },
        }),
    }),
});

export const { useUpdateWorkflowMutation } = workflowsRestApi;