Skip to content

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

8.6 KB
Raw Blame
import type { MatcherOptions } from "@testing-library/cypress";

import type {
  MeasureId,
  SegmentId,
  TableId,
  TransformId,
} from "metabase-types/api";

import { codeMirrorHelpers } from "./e2e-codemirror-helpers";
import { MetricPage } from "./e2e-metric-page-helpers";
import { popover } from "./e2e-ui-elements-helpers";

const { H } = cy;

const libraryPage = () => cy.findByTestId("library-page");
const newSnippetPage = () => cy.findByTestId("new-snippet-page");
const archivedSnippetsPage = () => cy.findByTestId("archived-snippets-page");
const editSnippetPage = () => cy.findByTestId("edit-snippet-page");

export const DataStudio = {
  nav: () => cy.findByTestId("data-studio-nav"),
  breadcrumbs: () => cy.findByTestId("data-studio-breadcrumbs"),
  visit: () => {
    cy.visit("/data-studio");
    // The target is only known once the `hasSeenGuide` request comes back.
    cy.location("pathname").should("match", /^\/data-studio\/.+/);
    DataStudio.nav().should("be.visible");
  },
  Transforms: {
    // The transform page shows a loader until the transform, databases and the
    // lazy editor chunk have loaded, which can take longer than the default 4s
    header: (options: MatcherOptions = {}) =>
      cy.findByTestId("transforms-header", { timeout: 10_000, ...options }),
    sectionHeader: () => cy.findByTestId("transforms-section-header"),
    transformsTab: () =>
      DataStudio.Transforms.sectionHeader().findByText("Transforms"),
    jobsTab: () => DataStudio.Transforms.sectionHeader().findByText("Jobs"),
    runsTab: () => DataStudio.Transforms.sectionHeader().findByText("Runs"),
    list: () => cy.findByTestId("transforms-list"),
    saveChangesButton: () => DataStudio.Transforms.queryEditor().button("Save"),
    editTransform: () => cy.findByRole("button", { name: "Edit" }),
    editDefinitionButton: () => cy.findByTestId("edit-definition-button"),
    getEditDefinitionLink: () => DataStudio.Transforms.editDefinitionButton(),
    clickEditDefinition: () => {
      DataStudio.Transforms.getEditDefinitionLink().click();
    },
    queryEditor: () => cy.findByTestId("transform-query-editor"),
    definitionTab: () =>
      DataStudio.Transforms.header().findByText("Definition"),
    runTab: () => DataStudio.Transforms.header().findByText("Run"),
    inspectTab: () => DataStudio.Transforms.header().findByText("Inspect"),
    targetTab: () => DataStudio.Transforms.header().findByText("Target"),
    settingsTab: () => DataStudio.Transforms.header().findByText("Settings"),
    indexesTab: () => DataStudio.Transforms.header().findByText("Indexes"),
    dependenciesTab: () =>
      DataStudio.Transforms.header().findByText("Dependencies"),
    visit: () => {
      cy.visit("/data-studio/transforms");
      DataStudio.Transforms.list().should("be.visible");
    },
    visitTransform: (transformId: TransformId) => {
      cy.visit(`/data-studio/transforms/${transformId}`);
    },
    visitInspect: (transformId: TransformId) => {
      cy.visit(`/data-studio/transforms/${transformId}/inspect`);
    },
    visitSettingsTab: (transformId: TransformId) =>
      cy.visit(`/data-studio/transforms/${transformId}/settings`),
    visitIndexes: (transformId: TransformId) =>
      cy.visit(`/data-studio/transforms/${transformId}/indexes`),
    runButton: () => cy.findAllByTestId("run-button").eq(0),
    pythonResults: () => cy.findByTestId("python-results"),
    enableTransformPage: () => cy.findByTestId("enable-transform-page"),
  },
  Jobs: {
    header: () => cy.findByTestId("jobs-header"),
    list: () => cy.findByTestId("transforms-job-list"),
    editor: () => cy.findByTestId("transforms-job-editor"),
  },
  Runs: {
    list: () => cy.findByTestId("transforms-run-list"),
    content: () => cy.findByTestId("transforms-run-content"),
    sidebar: () => cy.findByTestId("run-list-sidebar"),
  },
  Dependencies: {
    content: () => cy.findByTestId("transforms-dependencies-content"),
    graph: () => cy.findByTestId("dependency-graph"),
  },
  PythonLibrary: {
    header: () => cy.findByTestId("python-library-header"),
    editor: () => cy.findByTestId("python-editor"),
  },
  Snippets: {
    visitList: () => {
      cy.visit("/data-studio/snippets");
      libraryPage().should("be.visible");
    },
    newPage: newSnippetPage,
    editPage: editSnippetPage,
    archivedPage: archivedSnippetsPage,
    nameInput: () => newSnippetPage().findByDisplayValue("New SQL snippet"),
    descriptionInput: () => cy.findByPlaceholderText("No description"),
    saveButton: () => cy.findByRole("button", { name: "Save" }),
    cancelButton: () => cy.findByRole("button", { name: "Cancel" }),
    editor: codeMirrorHelpers("snippet-editor", {}),
    visitSnippet: (snippetId: number) =>
      cy.visit(`/data-studio/snippets/${snippetId}`),
  },
  Metrics: MetricPage,
  Tables: {
    overviewPage: () => cy.findByTestId("table-overview-page"),
    fieldsPage: () => cy.findByTestId("table-fields-page"),
    dependenciesPage: () => cy.findByTestId("table-dependencies-page"),
    segmentsPage: () => cy.findByTestId("table-segments-page"),
    measuresPage: () => cy.findByTestId("table-measures-page"),
    header: () => cy.findByTestId("table-pane-header"),
    nameInput: () => cy.findByTestId("table-name-input"),
    moreMenu: () => DataStudio.Tables.header().icon("ellipsis"),
    overviewTab: () => DataStudio.Tables.header().findByText("Overview"),
    fieldsTab: () => DataStudio.Tables.header().findByText("Fields"),
    segmentsTab: () => DataStudio.Tables.header().findByText("Segments"),
    measuresTab: () => DataStudio.Tables.header().findByText("Measures"),
    dependenciesTab: () =>
      DataStudio.Tables.header().findByText("Dependencies"),
    visitOverviewPage: (tableId: TableId) =>
      cy.visit(`/data-studio/library/tables/${tableId}`),
    visitFieldsPage: (tableId: TableId) =>
      cy.visit(`/data-studio/library/tables/${tableId}/fields`),
    visitSegmentsPage: (tableId: TableId) =>
      cy.visit(`/data-studio/library/tables/${tableId}/segments`),
    visitSegmentPage: (tableId: TableId, segmentId: SegmentId) =>
      cy.visit(`/data-studio/library/tables/${tableId}/segments/${segmentId}`),
    visitNewSegmentPage: (tableId: TableId) =>
      cy.visit(`/data-studio/library/tables/${tableId}/segments/new`),
    visitMeasuresPage: (tableId: TableId) =>
      cy.visit(`/data-studio/library/tables/${tableId}/measures`),
    visitMeasurePage: (tableId: TableId, measureId: MeasureId) =>
      cy.visit(`/data-studio/library/tables/${tableId}/measures/${measureId}`),
    visitNewMeasurePage: (tableId: TableId) =>
      cy.visit(`/data-studio/library/tables/${tableId}/measures/new`),
    moreMenuViewTable: () =>
      popover()
        .findByRole("menuitem", { name: /View/ })
        .invoke("removeAttr", "target")
        .click(),

    Overview: {
      descriptionSidebar: () => cy.findByTestId("table-description-sidebar"),

      descriptionText: () =>
        cy
          .findByTestId("table-description-section")
          .findByTestId("editable-text"),
      descriptionInput: () =>
        cy
          .findByTestId("table-description-section")
          .findByPlaceholderText("No description"),
    },
    openFilterPopover: () => {
      cy.findByRole("button", { name: "Filter" }).click();
      H.popover();
    },
  },
  Actions: {
    visitList: () => {
      cy.visit("/data-studio/actions");
      libraryPage().should("be.visible");
    },
  },
  Library: {
    visit: () => {
      cy.visit("/data-studio/library");
      DataStudio.Library.libraryPage().should("be.visible");
      DataStudio.Library.collectionItem("Data").should("be.visible");
      DataStudio.Library.collectionItem("Metrics").should("be.visible");
    },
    libraryPage,
    allTableItems: () => libraryPage().findAllByTestId("table-name"),
    tableItem: (name: string) =>
      DataStudio.Library.allTableItems().contains(name),
    result: (name: string) =>
      libraryPage().findByText(name).closest('[role="row"]'),
    rowCheckbox: (name: string) =>
      DataStudio.Library.result(name).findByRole("checkbox"),
    selectRow: (name: string) => DataStudio.Library.rowCheckbox(name).check(),
    newButton: () => libraryPage().findByRole("button", { name: /New/ }),
    collectionItem: (name: string | RegExp) =>
      libraryPage().findAllByTestId("collection-name").contains(name),
    expandCollection: (name: string) =>
      DataStudio.Library.result(name)
        .findByRole("button", { name: "Expand" })
        .click(),
    collapseCollection: (name: string) =>
      DataStudio.Library.result(name)
        .findByRole("button", { name: "Collapse" })
        .click(),
    emptyStateRow: (description: string | RegExp) =>
      libraryPage().contains('[data-testid="empty-state-row"]', description),
  },
};