Skip to content

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

2.8 KB
Raw Blame
import fetchMock from "fetch-mock";

import { getNextId } from "__support__/utils";
import type {
  Dashboard,
  DashboardId,
  DashboardQueryMetadata,
  FieldId,
  GetPublicDashboard,
} from "metabase-types/api";
import { createMockDashboard } from "metabase-types/api/mocks";

type SetupDashboardEndpointsOpts = {
  /** What PUT responds with. By default it echoes the request body back. */
  updatedDashboard?: Dashboard;
};

export function setupDashboardEndpoints(
  dashboard: Dashboard,
  { updatedDashboard }: SetupDashboardEndpointsOpts = {},
) {
  fetchMock.get(`path:/api/dashboard/${dashboard.id}`, dashboard);
  fetchMock.put(`path:/api/dashboard/${dashboard.id}`, async (call) => {
    if (updatedDashboard != null) {
      return updatedDashboard;
    }
    const lastCall = fetchMock.callHistory.lastCall(call.url);
    return createMockDashboard(await lastCall?.request?.json());
  });
}

export function setupUpdateDashboardEndpointWithError(
  dashboardId: DashboardId,
) {
  fetchMock.put(`path:/api/dashboard/${dashboardId}`, {
    status: 500,
    body: {},
  });
}

export function setupAutoDashboardEndpoints(
  dashboard: Dashboard,
  metadata: DashboardQueryMetadata,
) {
  fetchMock.get(
    `path:/api/automagic-dashboards/table/${dashboard.id}`,
    dashboard,
  );
  fetchMock.get(
    `path:/api/automagic-dashboards/table/${dashboard.id}/query_metadata`,
    metadata,
  );
  fetchMock.post(`path:/api/dashboard/save`, dashboard);
}

export function setupDashboardCreateEndpoint(dashboard: Partial<Dashboard>) {
  fetchMock.post(
    `path:/api/dashboard`,
    createMockDashboard({
      id: getNextId(),
      ...dashboard,
    }),
  );
}

export function setupDashboardQueryMetadataEndpoint(
  dashboard: Dashboard,
  metadata: DashboardQueryMetadata,
) {
  fetchMock.get(`path:/api/dashboard/${dashboard.id}/query_metadata`, metadata);
}

export function setupDashboardsEndpoints(dashboards: Dashboard[]) {
  fetchMock.get("path:/api/dashboard", dashboards);
  dashboards.forEach((dashboard) => setupDashboardEndpoints(dashboard));
}

export function setupDashboardNotFoundEndpoint(dashboard: Dashboard) {
  fetchMock.get(`path:/api/dashboard/${dashboard.id}`, 404);
}

export function setupDashboardPublicLinkEndpoints(dashboardId: DashboardId) {
  fetchMock.post(`path:/api/dashboard/${dashboardId}/public_link`, {
    id: dashboardId,
    uuid: "mock-uuid",
  });
  fetchMock.delete(`path:/api/dashboard/${dashboardId}/public_link`, {
    id: dashboardId,
  });
}

export function setupListPublicDashboardsEndpoint(
  publicDashboards: GetPublicDashboard[],
) {
  fetchMock.get("path:/api/dashboard/public", publicDashboards);
}

export function setupValidFilterFieldsEndpoint(
  filteringIdsByFilteredId: Record<FieldId, FieldId[]>,
) {
  fetchMock.get(
    "path:/api/dashboard/params/valid-filter-fields",
    filteringIdsByFilteredId,
  );
}