superset-frontend/plugins/legacy-plugin-chart-event-flow/src/transformProps.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 { ChartProps, TimeseriesDataRecord } from '@superset-ui/core';
import { cleanEvents, TS, EVENT_NAME, ENTITY_ID } from '@data-ui/event-flow';

export interface EventFlowFormData {
  allColumnsX: string;
  entity: string;
  minLeafNodeEventCount: number;
}

export interface EventFlowChartProps extends ChartProps {
  formData: EventFlowFormData;
  queriesData: {
    data: TimeseriesDataRecord[];
  }[];
}

export default function transformProps(chartProps: ChartProps) {
  const { formData, queriesData, width, height } = chartProps as EventFlowChartProps;
  const { allColumnsX, entity, minLeafNodeEventCount } = formData;
  const { data } = queriesData[0];

  const hasData = data && data.length > 0;
  if (hasData) {
    const userKey = entity;
    const eventNameKey = allColumnsX;

    // map from the Superset form fields to <EventFlow />'s expected data keys
    const accessorFunctions = {
      [ENTITY_ID]: (datum: TimeseriesDataRecord) => String(datum[userKey]),
      [EVENT_NAME]: (datum: TimeseriesDataRecord) => datum[eventNameKey] as string,
      [TS]: (datum: TimeseriesDataRecord): Date | null =>
        // eslint-disable-next-line no-underscore-dangle
        datum.__timestamp || datum.__timestamp === 0 ? new Date(datum.__timestamp) : null,
    };

    const cleanData = cleanEvents(data, accessorFunctions);

    return {
      data: cleanData,
      height,
      initialMinEventCount: minLeafNodeEventCount,
      width,
    };
  }

  return { data: null, height, width };
}