Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

4.7 KB
Raw Blame
import fetchMock, { type RouteResponse } from "fetch-mock";

import type {
  DagTransform,
  Dataset,
  InspectorLensId,
  ListTransformGraphRunsResponse,
  ListTransformJobRunsResponse,
  ListTransformRunsResponse,
  RunTransformDagResponse,
  Transform,
  TransformDagRunId,
  TransformId,
  TransformJob,
  TransformJobId,
  TransformJobRunId,
  TransformRunForJobRun,
  TransformTag,
} from "metabase-types/api";

import type { MockResponse } from "./types";

export function setupListTransformRunsEndpoint(
  response: ListTransformRunsResponse,
) {
  fetchMock.get(`path:/api/transform/run`, response);
}

export function setupListTransformGraphRunsEndpoint(
  response: ListTransformGraphRunsResponse,
) {
  fetchMock.get(`path:/api/transform/runs`, response);
}

export function setupListTransformsEndpoint(transforms: Transform[]) {
  fetchMock.get(`path:/api/transform`, transforms);
}

export function setupGetTransformEndpoint(
  transform: Transform,
  response: MockResponse<Transform> = transform,
) {
  fetchMock.get(`path:/api/transform/${transform.id}`, response);
}

export function setupUpdateTransformEndpoint(
  transformId: TransformId,
  response: RouteResponse,
) {
  fetchMock.put(`path:/api/transform/${transformId}`, response);
}

export function setupDeleteTransformEndpoint(transformId: TransformId) {
  fetchMock.delete(`path:/api/transform/${transformId}`, 204);
}

export function setupListTransformTagsEndpoint(tags: TransformTag[]) {
  fetchMock.get(`path:/api/transform-tag`, tags);
}

export function setupCreateTransformTagEndpoint(tag: TransformTag) {
  fetchMock.post(`path:/api/transform-tag`, tag);
}

export function setupListTransformJobsEndpoint(jobs: TransformJob[]) {
  fetchMock.get(`path:/api/transform-job`, jobs);
}

export function setupListTransformJobTransformsEndpoint(
  jobId: TransformJobId,
  transforms: Transform[],
  options?: { delay?: number },
) {
  fetchMock.get(
    `path:/api/transform-job/${jobId}/transforms`,
    transforms,
    options,
  );
}

export function setupListTransformJobTransformsEndpointWithError(
  jobId: TransformJobId,
  error?: unknown,
) {
  fetchMock.get(`path:/api/transform-job/${jobId}/transforms`, {
    status: 500,
    body: error,
  });
}

export function setupGetTransformJobEndpoint(job: TransformJob) {
  fetchMock.get(`path:/api/transform-job/${job.id}`, job);
}

export function setupListTransformJobRunsEndpoint(
  jobId: TransformJobId,
  response: ListTransformJobRunsResponse | (() => ListTransformJobRunsResponse),
) {
  fetchMock.get(`path:/api/transform-job/${jobId}/runs`, response);
}

export function setupListJobRunTransformRunsEndpoint(
  jobId: TransformJobId,
  runId: TransformJobRunId,
  runs: TransformRunForJobRun[] | (() => TransformRunForJobRun[]),
) {
  fetchMock.get(
    `path:/api/transform-job/${jobId}/runs/${runId}/transform-runs`,
    runs,
  );
}

export function setupListDagTransformsEndpoint(
  transformId: TransformId,
  transforms: DagTransform[],
) {
  fetchMock.get(
    `path:/api/transform/${transformId}/dag-transforms`,
    transforms,
  );
}

export function setupRunTransformDagEndpoint(
  transformId: TransformId,
  response: RunTransformDagResponse = {
    message: "DAG run started",
    dag_run_id: 1,
  },
) {
  fetchMock.post(`path:/api/transform/${transformId}/run-dag`, response);
}

export function setupListDagRunTransformRunsEndpoint(
  dagRunId: TransformDagRunId,
  runs: TransformRunForJobRun[] | (() => TransformRunForJobRun[]),
) {
  fetchMock.get(`path:/api/transform-dag-run/${dagRunId}/transform-runs`, runs);
}

export function setupCancelJobRunEndpoint(
  jobId: TransformJobId,
  runId: TransformJobRunId,
) {
  fetchMock.post(`path:/api/transform-job/${jobId}/runs/${runId}/cancel`, 204);
}

export function setupCreateTransformJobEndpoint(job: TransformJob) {
  fetchMock.post("path:/api/transform-job", job);
}

export function setupUpdateTransformJobEndpoint(job: TransformJob) {
  fetchMock.put(`path:/api/transform-job/${job.id}`, job);
}

export function setupBulkUpdateTransformJobsActiveEndpoint(updated: number) {
  fetchMock.put("path:/api/transform-job/active", { updated });
}

export function setupRunTransformJobEndpoint(jobId: TransformJobId) {
  fetchMock.post(`path:/api/transform-job/${jobId}/run`, 200);
}

export function setupDeleteTransformJobEndpoint(jobId: TransformJobId) {
  fetchMock.delete(`path:/api/transform-job/${jobId}`, 200);
}

export function setupDeleteTransformJobEndpointWithError(
  jobId: TransformJobId,
) {
  fetchMock.delete(`path:/api/transform-job/${jobId}`, 500);
}

export function setupRunInspectorQueryEndpoint(
  transformId: TransformId,
  lensId: InspectorLensId,
  response: Dataset,
) {
  fetchMock.post(
    `path:/api/ee/transforms/${transformId}/inspect/${lensId}/query`,
    response,
  );
}