Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(import): Add the error alert on failed database import #19673

Merged
merged 3 commits into from
Apr 18, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 45 additions & 4 deletions superset-frontend/src/components/ImportModal/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,20 @@
*/
import React, { FunctionComponent, useEffect, useState } from 'react';
import { UploadChangeParam, UploadFile } from 'antd/lib/upload/interface';
import { styled, t } from '@superset-ui/core';
import { styled, t, SupersetTheme } from '@superset-ui/core';

import Alert from 'src/components/Alert';
import Button from 'src/components/Button';
import Modal from 'src/components/Modal';
import { Upload } from 'src/components';
import { useImportResource } from 'src/views/CRUD/hooks';
import {
useImportResource,
getDatabaseDocumentationLinks,
} from 'src/views/CRUD/hooks';
import { ImportResourceName } from 'src/views/CRUD/types';

import { antdWarningAlertStyles } from './styles';

const HelperMessage = styled.div`
display: block;
color: ${({ theme }) => theme.colors.grayscale.base};
Expand Down Expand Up @@ -97,6 +103,12 @@ const StyledInputContainer = styled.div`
}
`;

const supersetTextDocs = getDatabaseDocumentationLinks();

export const DOCUMENTATION_LINK = supersetTextDocs
? supersetTextDocs.support
: 'https://superset.apache.org/docs/databases/installing-database-drivers';

export interface ImportModelsModalProps {
resourceName: ImportResourceName;
resourceLabel: string;
Expand All @@ -116,7 +128,6 @@ const ImportModelsModal: FunctionComponent<ImportModelsModalProps> = ({
resourceLabel,
passwordsNeededMessage,
confirmOverwriteMessage,
addDangerToast,
onModelImport,
show,
onHide,
Expand All @@ -130,6 +141,7 @@ const ImportModelsModal: FunctionComponent<ImportModelsModalProps> = ({
const [confirmedOverwrite, setConfirmedOverwrite] = useState<boolean>(false);
const [fileList, setFileList] = useState<UploadFile[]>([]);
const [importingModel, setImportingModel] = useState<boolean>(false);
const [errMsg, setErrMsg] = useState<string>();
rusackas marked this conversation as resolved.
Show resolved Hide resolved

const clearModal = () => {
setFileList([]);
Expand All @@ -142,7 +154,7 @@ const ImportModelsModal: FunctionComponent<ImportModelsModalProps> = ({

const handleErrorMsg = (msg: string) => {
clearModal();
addDangerToast(msg);
setErrMsg(msg);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should clear it when attempting a new upload right?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, as far as I can see, the modal now is not closed, so if we can make a new upload with the same modal, we should clear previous error there

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay agree.

};

const {
Expand Down Expand Up @@ -261,6 +273,34 @@ const ImportModelsModal: FunctionComponent<ImportModelsModalProps> = ({
);
};

const renderErrMsg = () => (
rusackas marked this conversation as resolved.
Show resolved Hide resolved
<Alert
closable={false}
css={(theme: SupersetTheme) => antdWarningAlertStyles(theme)}
type="error"
showIcon
message=""
description={
<>
{errMsg}.
<br />
{t(
'Database driver for importing maybe not installed. Visit the Superset documentation page for installation instructions:',
)}
<a
href={DOCUMENTATION_LINK}
target="_blank"
rel="noopener noreferrer"
className="additional-fields-alert-description"
>
{t('here')}
</a>
.
</>
}
/>
);

// Show/hide
if (isHidden && show) {
setIsHidden(false);
Expand Down Expand Up @@ -298,6 +338,7 @@ const ImportModelsModal: FunctionComponent<ImportModelsModalProps> = ({
<Button loading={importingModel}>Select file</Button>
</Upload>
</StyledInputContainer>
{errMsg && renderErrMsg()}
{renderPasswordFields()}
{renderOverwriteConfirmation()}
</Modal>
Expand Down
43 changes: 43 additions & 0 deletions superset-frontend/src/components/ImportModal/styles.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/**
* 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 { css, SupersetTheme } from '@superset-ui/core';

export const antdWarningAlertStyles = (theme: SupersetTheme) => css`
border: 1px solid ${theme.colors.warning.light1};
padding: ${theme.gridUnit * 4}px;
margin: ${theme.gridUnit * 4}px 0;
color: ${theme.colors.warning.dark2};

.ant-alert-message {
margin: 0;
}

.ant-alert-description {
font-size: ${theme.typography.sizes.s + 1}px;
line-height: ${theme.gridUnit * 4}px;

.ant-alert-icon {
margin-right: ${theme.gridUnit * 2.5}px;
font-size: ${theme.typography.sizes.l + 1}px;
position: relative;
top: ${theme.gridUnit / 4}px;
}
}
`;