superset2/superset-frontend/playwright/helpers/api/dataset.ts

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import { Page, APIResponse } from '@playwright/test';
import rison from 'rison';
import { apiGet, apiPost, apiDelete, ApiRequestOptions } from './requests';

export const ENDPOINTS = {
  DATASET: 'api/v1/dataset/',
} as const;

/**
 * TypeScript interface for physical dataset creation API payload
 * Provides compile-time safety for required fields
 */
export interface DatasetCreatePayload {
  database: number;
  catalog: string | null;
  schema: string;
  table_name: string;
}

/**
 * TypeScript interface for virtual dataset creation API payload
 * Virtual datasets are SQL-based and support the Duplicate action in UI
 */
export interface VirtualDatasetCreatePayload {
  database: number;
  schema: string;
  table_name: string;
  sql: string;
  owners?: number[];
}

/**
 * TypeScript interface for dataset API response
 * Represents the shape of dataset data returned from the API
 */
export interface DatasetResult {
  id: number;
  table_name: string;
  sql?: string;
  schema?: string;
  database: {
    id: number;
    database_name: string;
  };
  owners?: Array<{ id: number }>;
  dataset_type?: 'physical' | 'virtual';
}

/**
 * POST request to create a physical dataset
 * @param page - Playwright page instance (provides authentication context)
 * @param requestBody - Dataset configuration object (database, schema, table_name)
 * @returns API response from dataset creation
 */
export async function apiPostDataset(
  page: Page,
  requestBody: DatasetCreatePayload,
): Promise<APIResponse> {
  return apiPost(page, ENDPOINTS.DATASET, requestBody);
}

/**
 * POST request to create a virtual (SQL-based) dataset
 * Virtual datasets support the Duplicate action in the UI
 * @param page - Playwright page instance (provides authentication context)
 * @param requestBody - Virtual dataset config (database, schema, table_name, sql)
 * @returns API response from dataset creation
 */
export async function apiPostVirtualDataset(
  page: Page,
  requestBody: VirtualDatasetCreatePayload,
): Promise<APIResponse> {
  return apiPost(page, ENDPOINTS.DATASET, requestBody);
}

/**
 * Creates a simple virtual dataset for testing purposes
 * @param page - Playwright page instance
 * @param name - Name for the virtual dataset
 * @param databaseId - ID of the database to use (defaults to 1 for examples db)
 * @returns The created dataset ID, or null on failure
 */
export async function createTestVirtualDataset(
  page: Page,
  name: string,
  databaseId = 1,
): Promise<number | null> {
  const response = await apiPostVirtualDataset(page, {
    database: databaseId,
    schema: '',
    table_name: name,
    sql: "SELECT 1 as id, 'test' as name",
    owners: [],
  });

  if (!response.ok()) {
    console.warn(`Failed to create virtual dataset: ${response.status()}`);
    return null;
  }

  const body = await response.json();
  return body.id ?? null;
}

/**
 * Get a dataset by its table name
 * @param page - Playwright page instance (provides authentication context)
 * @param tableName - The table_name to search for
 * @returns Dataset object if found, null if not found
 */
export async function getDatasetByName(
  page: Page,
  tableName: string,
): Promise<DatasetResult | null> {
  // Use Superset's filter API to search by table_name
  const filter = {
    filters: [
      {
        col: 'table_name',
        opr: 'eq',
        value: tableName,
      },
    ],
  };
  const queryParam = rison.encode(filter);
  // Use failOnStatusCode: false so we return null instead of throwing on errors
  const response = await apiGet(page, `${ENDPOINTS.DATASET}?q=${queryParam}`, {
    failOnStatusCode: false,
  });

  if (!response.ok()) {
    return null;
  }

  const body = await response.json();
  if (body.result && body.result.length > 0) {
    return body.result[0] as DatasetResult;
  }

  return null;
}

/**
 * GET request to fetch a dataset's details
 * @param page - Playwright page instance (provides authentication context)
 * @param datasetId - ID of the dataset to fetch
 * @returns API response with dataset details
 */
export async function apiGetDataset(
  page: Page,
  datasetId: number,
  options?: ApiRequestOptions,
): Promise<APIResponse> {
  return apiGet(page, `${ENDPOINTS.DATASET}${datasetId}`, options);
}

/**
 * DELETE request to remove a dataset
 * @param page - Playwright page instance (provides authentication context)
 * @param datasetId - ID of the dataset to delete
 * @returns API response from dataset deletion
 */
export async function apiDeleteDataset(
  page: Page,
  datasetId: number,
  options?: ApiRequestOptions,
): Promise<APIResponse> {
  return apiDelete(page, `${ENDPOINTS.DATASET}${datasetId}`, options);
}