vendure/packages/core/e2e/utils/await-running-jobs.ts

import { SimpleGraphQLClient } from '@vendure/testing';

import { GetRunningJobsQuery, GetRunningJobsQueryVariables } from '../graphql/generated-e2e-admin-types';
import { getRunningJobsDocument } from '../graphql/shared-definitions';

/**
 * For mutation which trigger background jobs, this can be used to "pause" the execution of
 * the test until those jobs have completed;
 */
export async function awaitRunningJobs(
    adminClient: SimpleGraphQLClient,
    timeout: number = 5000,
    delay = 100,
) {
    let runningJobs = 0;
    const startTime = +new Date();
    let timedOut = false;
    // Allow a brief period for the jobs to start in the case that
    // e.g. event debouncing is used before triggering the job.
    await new Promise(resolve => setTimeout(resolve, delay));
    do {
        const { jobs } = await adminClient.query<GetRunningJobsQuery, GetRunningJobsQueryVariables>(
            getRunningJobsDocument,
            {
                options: {
                    filter: {
                        isSettled: {
                            eq: false,
                        },
                    },
                },
            },
        );
        runningJobs = jobs.totalItems;
        timedOut = timeout < +new Date() - startTime;
    } while (runningJobs > 0 && !timedOut);

    if (runningJobs > 0) {
        /* eslint-disable no-console */
        console.log(`awaitRunningJobs time out with ${runningJobs} jobs still running`);
    }
}