eschutho commented on code in PR #27840: URL: https://github.com/apache/superset/pull/27840#discussion_r1554025634
########## superset-frontend/src/features/databases/CSVUploadModal/index.tsx: ########## @@ -0,0 +1,805 @@ +/** + * 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 React, { FunctionComponent, useEffect, useMemo, useState } from 'react'; +import { + getClientErrorObject, + SupersetClient, + SupersetTheme, + t, +} from '@superset-ui/core'; +import Modal from 'src/components/Modal'; +import Collapse from 'src/components/Collapse'; +import { + Upload, + AntdForm, + Col, + Row, + AntdButton as Button, + AsyncSelect, + Select, + Typography, +} from 'src/components'; +import { Divider, Switch } from 'antd'; +import { UploadOutlined } from '@ant-design/icons'; +import { Input, InputNumber } from 'src/components/Input'; +import rison from 'rison'; +import { UploadChangeParam, UploadFile } from 'antd/lib/upload/interface'; +import withToasts from 'src/components/MessageToasts/withToasts'; +import { + antDModalStyles, + antDModalNoPaddingStyles, + antdCollapseStyles, + StyledFormItem, +} from './styles'; + +interface CSVUploadModalProps { + addDangerToast: (msg: string) => void; + addSuccessToast: (msg: string) => void; + onHide: () => void; + show: boolean; +} + +interface UploadInfo { + database_id: number; + table_name: string; + schema: string; + delimiter: string; + already_exists: string; + skip_initial_space: boolean; + skip_blank_lines: boolean; + day_first: boolean; + decimal_character: string; + null_values: Array<string>; + header_row: string; + rows_to_read: string | null; + skip_rows: string; + column_dates: Array<string>; + index_column: string | null; + dataframe_index: boolean; + column_labels: string; + columns_read: Array<string>; + overwrite_duplicates: boolean; + column_data_types: string; +} + +const defaultUploadInfo: UploadInfo = { + database_id: 0, + table_name: '', + schema: '', + delimiter: ',', + already_exists: 'fail', + skip_initial_space: false, + skip_blank_lines: false, + day_first: false, + decimal_character: '.', + null_values: [], + header_row: '0', + rows_to_read: null, + skip_rows: '0', + column_dates: [], + index_column: null, + dataframe_index: false, + column_labels: '', + columns_read: [], + overwrite_duplicates: false, + column_data_types: '', +}; + +const CSVUploadModal: FunctionComponent<CSVUploadModalProps> = ({ + addDangerToast, + addSuccessToast, + onHide, + show, +}) => { + const [form] = AntdForm.useForm(); + // Declare states here + const [currentDatabaseId, setCurrentDatabaseId] = useState<number>(0); + const [fileList, setFileList] = useState<UploadFile[]>([]); + const [columns, setColumns] = React.useState<string[]>([]); + const [delimiter, setDelimiter] = useState<string>(','); + const [isLoading, setIsLoading] = useState<boolean>(false); + const [currentSchema, setCurrentSchema] = useState<String>(''); + + const nullValuesOptions = [ + { + value: '""', + label: 'Empty Strings ""', + }, + { + value: 'None', + label: 'None', + }, + { + value: 'nan', + label: 'nan', + }, + { + value: 'null', + label: 'null', + }, + { + value: 'N/A', + label: 'N/A', + }, + ]; + + const delimiterOptions = [ + { + value: ',', + label: 'Comma ","', + }, + { + value: ';', + label: 'Semicolon ";"', + }, + { + value: '\t', + label: 'Tab "\\t"', + }, + { + value: '|', + label: 'Pipe', + }, + ]; + + const tableAlreadyExistsOptions = [ + { + value: 'fail', + label: 'Fail', + }, + { + value: 'replace', + label: 'Replace', + }, + { + value: 'append', + label: 'Append', + }, + ]; + + const onChangeDatabase = (database: { value: number; label: string }) => { + setCurrentDatabaseId(database?.value); + }; + + const onChangeSchema = (schema: { value: string; label: string }) => { + setCurrentSchema(schema?.value); + }; + + const onChangeDelimiter = (value: string) => { + setDelimiter(value); + }; + + const clearModal = () => { + setFileList([]); + setColumns([]); + setCurrentSchema(''); + setCurrentDatabaseId(0); + setIsLoading(false); + form.resetFields(); + }; + + const loadDatabaseOptions = useMemo( + () => + (input = '', page: number, pageSize: number) => { + const query = rison.encode_uri({ + filters: [ + { + col: 'allow_file_upload', + opr: 'eq', + value: true, + }, + ], + page, + page_size: pageSize, + }); + return SupersetClient.get({ + endpoint: `/api/v1/database/?q=${query}`, + }).then(response => { + const list = response.json.result.map( + (item: { id: number; database_name: string }) => ({ + value: item.id, + label: item.database_name, + }), + ); + return { data: list, totalCount: response.json.count }; + }); + }, + [], + ); + + const loadSchemaOptions = useMemo( + () => + (input = '', page: number, pageSize: number) => { + if (!currentDatabaseId) { + return Promise.resolve({ data: [], totalCount: 0 }); + } + return SupersetClient.get({ + endpoint: `/api/v1/database/${currentDatabaseId}/schemas/`, + }).then(response => { + const list = response.json.result.map((item: string) => ({ + value: item, + label: item, + })); + return { data: list, totalCount: response.json.count }; + }); + }, + [currentDatabaseId], + ); + + const onClose = () => { + clearModal(); + onHide(); + }; + + const onFinish = () => { + const fields = form.getFieldsValue(); + fields.database_id = currentDatabaseId; + fields.schema = currentSchema; + const mergedValues = { ...defaultUploadInfo, ...fields }; + const formData = new FormData(); + const file = fileList[0]?.originFileObj; + if (file) { + formData.append('file', file); + } + formData.append('delimiter', mergedValues.delimiter); + formData.append('table_name', mergedValues.table_name); + formData.append('schema', mergedValues.schema); + formData.append('already_exists', mergedValues.already_exists); + formData.append('skip_initial_space', mergedValues.skip_initial_space); + formData.append('skip_blank_lines', mergedValues.skip_blank_lines); + formData.append('day_first', mergedValues.day_first); + formData.append('decimal_character', mergedValues.decimal_character); + formData.append('null_values', mergedValues.null_values); + formData.append('header_row', mergedValues.header_row); + if (mergedValues.rows_to_read != null) { + formData.append('rows_to_read', mergedValues.rows_to_read); + } + formData.append('skip_rows', mergedValues.skip_rows); + formData.append('column_dates', mergedValues.column_dates); + if (mergedValues.index_column != null) { + formData.append('index_column', mergedValues.index_column); + } + formData.append('dataframe_index', mergedValues.dataframe_index); + formData.append('column_labels', mergedValues.column_labels); + formData.append('columns_read', mergedValues.columns_read); + formData.append('overwrite_duplicates', mergedValues.overwrite_duplicates); + formData.append('column_data_types', mergedValues.column_data_types); + setIsLoading(true); + return SupersetClient.post({ + endpoint: `/api/v1/database/${currentDatabaseId}/csv_upload/`, + body: formData, + headers: { Accept: 'application/json' }, + }) + .then(() => { + addSuccessToast(t('CSV Imported')); + setIsLoading(false); + onClose(); + }) + .catch(response => + getClientErrorObject(response).then(error => { + addDangerToast(error.error || 'Error'); + }), + ) + .finally(() => { + setIsLoading(false); + }); + }; + + const onRemoveFile = (removedFile: UploadFile) => { + setFileList(fileList.filter(file => file.uid !== removedFile.uid)); + setColumns([]); + return false; + }; + + const columnsToOptions = () => + columns.map(column => ({ + value: column, + label: column, + })); + + const readFileContent = (file: File) => + new Promise<string>((resolve, reject) => { + const reader = new FileReader(); + reader.onload = event => { + if (event.target) { + const text = event.target.result as string; + resolve(text); + } else { + reject(new Error('Failed to read file content')); + } + }; + reader.onerror = () => { + reject(new Error('Failed to read file content')); + }; + reader.readAsText(file.slice(0, 10000)); // Read only first 10000 bytes to get the first line + }); + + const processFileContent = async (file: File) => { + try { + const text = await readFileContent(file); + const firstLine = text.split('\n')[0].trim(); + const firstRow = firstLine + .split(delimiter) + .map(column => column.replace(/^"(.*)"$/, '$1')); + setColumns(firstRow); + } catch (error) { + addDangerToast('Failed to process file content'); + } + }; + + const onChangeFile = async (info: UploadChangeParam<any>) => { + setFileList([ + { + ...info.file, + status: 'done', + }, + ]); + await processFileContent(info.file.originFileObj); + }; + + useEffect(() => { + if ( + columns.length > 0 && + fileList[0].originFileObj && + fileList[0].originFileObj instanceof File + ) { + processFileContent(fileList[0].originFileObj); + } + }, [delimiter]); + + const validateUpload = (_: any, value: string) => { + if (fileList.length === 0) { + return Promise.reject(t('Uploading a file is required')); + } + return Promise.resolve(); + }; + + const validateDatabase = (_: any, value: string) => { + if (!currentDatabaseId) { + return Promise.reject(t('Selecting a database is required')); + } + return Promise.resolve(); + }; + + return ( + <Modal + css={(theme: SupersetTheme) => [ + antDModalNoPaddingStyles, + antDModalStyles(theme), + ]} + primaryButtonLoading={isLoading} + name="database" + data-test="csvupload-modal" + onHandledPrimaryAction={form.submit} + onHide={onClose} + primaryButtonName="Upload" + centered + show={show} + title={<h4>CSV Upload</h4>} + > + <AntdForm + form={form} + onFinish={onFinish} + data-test="dashboard-edit-properties-form" + layout="vertical" + initialValues={defaultUploadInfo} + > + <Collapse + expandIconPosition="right" + accordion + defaultActiveKey="general" + css={(theme: SupersetTheme) => antdCollapseStyles(theme)} + > + <Collapse.Panel + header={ + <div> + <h4>{t('General information')}</h4> + <p className="helper"> + {t('Upload a CSV file to a database.')} + </p> + </div> + } + key="general" + > + <Row> + <Col> + <StyledFormItem + label={t('CSV File')} + name="upload" + required + rules={[{ validator: validateUpload }]} + > + <Upload + name="modelFile" + id="modelFile" + data-test="model-file-input" + accept=".csv" + fileList={fileList} + onChange={onChangeFile} + onRemove={onRemoveFile} + // upload is handled by hook + customRequest={() => {}} + > + <Button aria-label={t('Select')} icon={<UploadOutlined />}> + {t('Select')} + </Button> + </Upload> + </StyledFormItem> + </Col> + <Col> + {columns.length > 0 && ( + <> + <Typography.Text type="success"> + Loaded {columns.length} column(s): + </Typography.Text> + {columns.map((column, index) => ( + <Typography.Text key={index} code type="success"> + {column} + </Typography.Text> + ))} + </> + )} + </Col> + </Row> + <Divider orientation="left">Basic</Divider> Review Comment: t('Basic') -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@superset.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: notifications-unsubscr...@superset.apache.org For additional commands, e-mail: notifications-h...@superset.apache.org
