You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by GitBox <gi...@apache.org> on 2022/03/31 10:58:18 UTC
[GitHub] [superset] villebro commented on a change in pull request #19446: feat(explore): Move chart actions into dropdown
villebro commented on a change in pull request #19446:
URL: https://github.com/apache/superset/pull/19446#discussion_r839468842
##########
File path: superset-frontend/src/explore/components/ExploreAdditionalActionsMenu/ExploreAdditionalActionsMenu.test.tsx
##########
@@ -18,11 +18,13 @@
*/
import React from 'react';
-import { render, screen, waitFor } from 'spec/helpers/testing-library';
+import fetchMock from 'fetch-mock';
+import sinon from 'sinon';
import userEvent from '@testing-library/user-event';
+import { render, screen, waitFor } from 'spec/helpers/testing-library';
import * as chartAction from 'src/components/Chart/chartAction';
import * as downloadAsImage from 'src/utils/downloadAsImage';
-import fetchMock from 'fetch-mock';
+import * as exploreUtils from 'src/explore/exploreUtils';
Review comment:
nit: importing `*` always makes me cringe, but in a test I guess it's acceptable 😛
##########
File path: superset-frontend/src/explore/components/ExploreAdditionalActionsMenu/index.jsx
##########
@@ -16,114 +16,430 @@
* specific language governing permissions and limitations
* under the License.
*/
-import React from 'react';
-import { connect } from 'react-redux';
-import { bindActionCreators } from 'redux';
+import React, { useCallback, useState } from 'react';
+import { useDispatch, useSelector } from 'react-redux';
import PropTypes from 'prop-types';
-import { t } from '@superset-ui/core';
+import { FileOutlined, FileImageOutlined } from '@ant-design/icons';
+import { css, styled, t, useTheme } from '@superset-ui/core';
import { AntdDropdown } from 'src/components';
import { Menu } from 'src/components/Menu';
-import downloadAsImage from 'src/utils/downloadAsImage';
+import Icons from 'src/components/Icons';
import ModalTrigger from 'src/components/ModalTrigger';
-import { sliceUpdated } from 'src/explore/actions/exploreActions';
+import Button from 'src/components/Button';
+import withToasts from 'src/components/MessageToasts/withToasts';
+import Checkbox from 'src/components/Checkbox';
+import { exportChart } from 'src/explore/exploreUtils';
+import downloadAsImage from 'src/utils/downloadAsImage';
+import { noOp } from 'src/utils/common';
+import { getChartPermalink } from 'src/utils/urlUtils';
+import { toggleActive } from 'src/reports/actions/reports';
import ViewQueryModal from '../controls/ViewQueryModal';
+import EmbedCodeContent from '../EmbedCodeContent';
+import { ExploreReport } from './ExploreReport';
+import copyTextToClipboard from '../../../utils/copy';
const propTypes = {
onOpenPropertiesModal: PropTypes.func,
onOpenInEditor: PropTypes.func,
- chartStatus: PropTypes.string,
latestQueryFormData: PropTypes.object.isRequired,
slice: PropTypes.object,
};
const MENU_KEYS = {
EDIT_PROPERTIES: 'edit_properties',
- RUN_IN_SQL_LAB: 'run_in_sql_lab',
+ DOWNLOAD_SUBMENU: 'download_submenu',
+ EXPORT_TO_CSV: 'export_to_csv',
+ EXPORT_TO_CSV_PIVOTED: 'export_to_csv_pivoted',
+ EXPORT_TO_JSON: 'export_to_json',
DOWNLOAD_AS_IMAGE: 'download_as_image',
+ SHARE_SUBMENU: 'share_submenu',
+ COPY_PERMALINK: 'copy_permalink',
+ EMBED_CODE: 'embed_code',
+ SHARE_BY_EMAIL: 'share_by_email',
+ REPORT_SUBMENU: 'report_submenu',
+ SET_UP_REPORT: 'set_up_report',
+ SET_REPORT_ACTIVE: 'set_report_active',
+ EDIT_REPORT: 'edit_report',
+ DELETE_REPORT: 'delete_report',
VIEW_QUERY: 'view_query',
+ RUN_IN_SQL_LAB: 'run_in_sql_lab',
};
-const ExploreAdditionalActionsMenu = props => {
- const { datasource } = props.latestQueryFormData;
+const VIZ_TYPES_PIVOTABLE = ['pivot_table', 'pivot_table_v2'];
+
+const MenuItemWithCheckboxContainer = styled.div`
+ ${({ theme }) => css`
+ display: flex;
+ align-items: center;
+
+ & svg {
+ width: ${theme.gridUnit * 3}px;
+ height: ${theme.gridUnit * 3}px;
+ }
+
+ & span[role='checkbox'] {
+ display: inline-flex;
+ margin-right: ${theme.gridUnit}px;
+ }
+ `}
+`;
+
+const MenuTrigger = styled(Button)`
+ ${({ theme }) => css`
+ width: ${theme.gridUnit * 6}px;
+ height: ${theme.gridUnit * 6}px;
+ padding: 0;
+ border: 1px solid ${theme.colors.primary.dark2};
+
+ &.ant-btn > span.anticon {
+ line-height: 0;
+ transition: inherit;
+ }
+
+ &:hover:not(:focus) > span.anticon {
+ color: ${theme.colors.primary.light1};
+ }
+ `}
+`;
+
+const ExploreAdditionalActionsMenu = ({
+ latestQueryFormData,
+ canDownloadCSV,
+ addDangerToast,
+ addSuccessToast,
+ slice,
+ onOpenInEditor,
+ onOpenPropertiesModal,
+ canAddReports,
+}) => {
+ const theme = useTheme();
+ const [isDropdownVisible, setIsDropdownVisible] = useState(false);
+ const [openSubmenus, setOpenSubmenus] = useState([]);
+ const [showReportModal, setShowReportModal] = useState(false);
+ const [showDeleteReportModal, setShowDeleteReportModal] = useState(false);
+ const dispatch = useDispatch();
+ const report = useSelector(state => {
+ if (!state.reports) {
+ return undefined;
+ }
+ const reports = Object.values(state?.reports);
+ if (reports.length > 0) {
+ return reports[0];
+ }
+ return undefined;
+ });
+ const isReportActive = report?.active;
+ const { datasource } = latestQueryFormData;
const sqlSupported = datasource && datasource.split('__')[1] === 'table';
- const handleMenuClick = ({ key, domEvent }) => {
- const { slice, onOpenInEditor, latestQueryFormData } = props;
- switch (key) {
- case MENU_KEYS.EDIT_PROPERTIES:
- props.onOpenPropertiesModal();
- break;
- case MENU_KEYS.RUN_IN_SQL_LAB:
- onOpenInEditor(latestQueryFormData);
- break;
- case MENU_KEYS.DOWNLOAD_AS_IMAGE:
- downloadAsImage(
- '.panel-body > .chart-container',
- // eslint-disable-next-line camelcase
- slice?.slice_name ?? t('New chart'),
- {},
- true,
- )(domEvent);
- break;
- default:
- break;
+
+ const shareByEmail = useCallback(async () => {
+ try {
+ const subject = t('Superset Chart');
+ const url = await getChartPermalink(latestQueryFormData);
+ const body = encodeURIComponent(t('%s%s', 'Check out this chart: ', url));
+ window.location.href = `mailto:?Subject=${subject}%20&Body=${body}`;
+ } catch (error) {
+ addDangerToast(t('Sorry, something went wrong. Try again later.'));
}
- };
+ }, [addDangerToast, latestQueryFormData]);
+
+ const exportCSV = useCallback(
+ () =>
+ canDownloadCSV
+ ? exportChart({
+ formData: latestQueryFormData,
+ resultType: 'full',
+ resultFormat: 'csv',
+ })
+ : null,
+ [canDownloadCSV, latestQueryFormData],
+ );
+
+ const exportCSVPivoted = useCallback(
+ () =>
+ canDownloadCSV
+ ? exportChart({
+ formData: latestQueryFormData,
+ resultType: 'post_processed',
+ resultFormat: 'csv',
+ })
+ : null,
+ [canDownloadCSV, latestQueryFormData],
+ );
+
+ const exportJson = useCallback(
+ () =>
+ exportChart({
+ formData: latestQueryFormData,
+ resultType: 'results',
+ resultFormat: 'json',
+ }),
+ [latestQueryFormData],
+ );
+
+ const copyLink = useCallback(async () => {
+ try {
+ if (!latestQueryFormData) {
+ throw new Error();
+ }
+ const url = await getChartPermalink(latestQueryFormData);
+ await copyTextToClipboard(url);
+ addSuccessToast(t('Copied to clipboard!'));
+ } catch (error) {
+ addDangerToast(t('Sorry, something went wrong. Try again later.'));
+ }
+ }, [addDangerToast, addSuccessToast, latestQueryFormData]);
+
+ const handleMenuClick = useCallback(
+ ({ key, domEvent }) => {
+ switch (key) {
+ case MENU_KEYS.EDIT_PROPERTIES:
+ onOpenPropertiesModal();
+ setIsDropdownVisible(false);
+ break;
+ case MENU_KEYS.EXPORT_TO_CSV:
+ exportCSV();
+ setIsDropdownVisible(false);
+ setOpenSubmenus([]);
+ break;
+ case MENU_KEYS.EXPORT_TO_CSV_PIVOTED:
+ exportCSVPivoted();
+ setIsDropdownVisible(false);
+ setOpenSubmenus([]);
+ break;
+ case MENU_KEYS.EXPORT_TO_JSON:
+ exportJson();
+ setIsDropdownVisible(false);
+ setOpenSubmenus([]);
+
+ break;
+ case MENU_KEYS.DOWNLOAD_AS_IMAGE:
+ downloadAsImage(
+ '.panel-body > .chart-container',
+ // eslint-disable-next-line camelcase
+ slice?.slice_name ?? t('New chart'),
+ {},
+ true,
+ )(domEvent);
+ setIsDropdownVisible(false);
+ setOpenSubmenus([]);
+ break;
+ case MENU_KEYS.COPY_PERMALINK:
+ copyLink();
+ setIsDropdownVisible(false);
+ setOpenSubmenus([]);
+ break;
+ case MENU_KEYS.EMBED_CODE:
+ setIsDropdownVisible(false);
+ setOpenSubmenus([]);
+ break;
+ case MENU_KEYS.SHARE_BY_EMAIL:
+ shareByEmail();
+ setIsDropdownVisible(false);
+ setOpenSubmenus([]);
+ break;
+ case MENU_KEYS.SET_UP_REPORT:
+ setShowReportModal(true);
+ setIsDropdownVisible(false);
+ break;
+ case MENU_KEYS.SET_REPORT_ACTIVE:
+ dispatch(toggleActive(report, !isReportActive));
+ break;
+ case MENU_KEYS.EDIT_REPORT:
+ setShowReportModal(true);
+ setIsDropdownVisible(false);
+ setOpenSubmenus([]);
+ break;
+ case MENU_KEYS.DELETE_REPORT:
+ setShowDeleteReportModal(true);
+ setIsDropdownVisible(false);
+ setOpenSubmenus([]);
+ break;
+ case MENU_KEYS.VIEW_QUERY:
+ setIsDropdownVisible(false);
+ break;
+ case MENU_KEYS.RUN_IN_SQL_LAB:
+ onOpenInEditor(latestQueryFormData);
+ setIsDropdownVisible(false);
+ break;
+ default:
+ break;
+ }
+ },
+ [
+ copyLink,
+ dispatch,
+ exportCSV,
+ exportCSVPivoted,
+ exportJson,
+ isReportActive,
+ latestQueryFormData,
+ onOpenInEditor,
+ onOpenPropertiesModal,
+ report,
+ shareByEmail,
+ slice?.slice_name,
+ ],
+ );
- const { slice } = props;
return (
- <AntdDropdown
- trigger="click"
- data-test="query-dropdown"
- overlay={
- <Menu onClick={handleMenuClick} selectable={false}>
- {slice && (
- <Menu.Item key={MENU_KEYS.EDIT_PROPERTIES}>
- {t('Edit properties')}
- </Menu.Item>
- )}
- <Menu.Item key={MENU_KEYS.VIEW_QUERY}>
- <ModalTrigger
- triggerNode={
- <span data-test="view-query-menu-item">{t('View query')}</span>
- }
- modalTitle={t('View query')}
- modalBody={
- <ViewQueryModal
- latestQueryFormData={props.latestQueryFormData}
+ <>
+ <AntdDropdown
+ trigger="click"
+ data-test="query-dropdown"
+ visible={isDropdownVisible}
+ onVisibleChange={setIsDropdownVisible}
+ overlay={
+ <Menu
+ onClick={handleMenuClick}
+ selectable={false}
+ openKeys={openSubmenus}
+ onOpenChange={setOpenSubmenus}
+ >
+ {slice && (
+ <>
+ <Menu.Item key={MENU_KEYS.EDIT_PROPERTIES}>
+ {t('Edit chart properties')}
+ </Menu.Item>
+ <Menu.Divider />
+ </>
+ )}
+ <Menu.SubMenu
+ title={t('Download')}
+ key={MENU_KEYS.DOWNLOAD_SUBMENU}
+ >
+ {VIZ_TYPES_PIVOTABLE.includes(latestQueryFormData.viz_type) ? (
+ <>
+ <Menu.Item
+ key={MENU_KEYS.EXPORT_TO_CSV}
+ icon={<FileOutlined />}
+ disabled={!canDownloadCSV}
+ >
+ {t('Export to original .CSV')}
+ </Menu.Item>
+ <Menu.Item
+ key={MENU_KEYS.EXPORT_TO_CSV_PIVOTED}
+ icon={<FileOutlined />}
+ disabled={!canDownloadCSV}
+ >
+ {t('Export to pivoted .CSV')}
+ </Menu.Item>
+ </>
+ ) : (
+ <Menu.Item
+ key={MENU_KEYS.EXPORT_TO_CSV}
+ icon={<FileOutlined />}
+ disabled={!canDownloadCSV}
+ >
+ {t('Export to .CSV')}
+ </Menu.Item>
+ )}
+ <Menu.Item key={MENU_KEYS.EXPORT_TO_JSON} icon={<FileOutlined />}>
+ {t('Export to .JSON')}
+ </Menu.Item>
+ <Menu.Item
+ key={MENU_KEYS.DOWNLOAD_AS_IMAGE}
+ icon={<FileImageOutlined />}
+ >
+ {t('Download as image')}
+ </Menu.Item>
+ </Menu.SubMenu>
+ <Menu.SubMenu title={t('Share')} key={MENU_KEYS.SHARE_SUBMENU}>
+ <Menu.Item key={MENU_KEYS.COPY_PERMALINK}>
+ {t('Copy permalink to clipboard')}
+ </Menu.Item>
+ <Menu.Item key={MENU_KEYS.EMBED_CODE}>
+ <ModalTrigger
+ triggerNode={
+ <span data-test="embed-code-button">{t('Embed code')}</span>
Review comment:
minor comment: I'd kinda prefer to see "Embed code" below "Share chart via email"
--
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-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org