downloadable dataset context

src/client/components/share-menu/share-menu.tsx

@@ -15,17 +15,18 @@
  * limitations under the License.
  */
 
+import { Dataset } from "plywood";
 import * as React from "react";
 import { ClientCustomization } from "../../../common/models/customization/customization";
 import { Essence } from "../../../common/models/essence/essence";
 import { ExternalView } from "../../../common/models/external-view/external-view";
 import { Stage } from "../../../common/models/stage/stage";
 import { Timekeeper } from "../../../common/models/timekeeper/timekeeper";
-import { Binary } from "../../../common/utils/functional/functional";
+import { Binary, Nullary } from "../../../common/utils/functional/functional";
 import { Fn } from "../../../common/utils/general/general";
 import { exportOptions, STRINGS } from "../../config/constants";
 import { download, FileFormat, fileNameBase } from "../../utils/download/download";
-import { DataSetWithTabOptions } from "../../views/cube-view/cube-view";
+import { DownloadableDataset, DownloadableDatasetContext } from "../../views/cube-view/downloadable-dataset-context";
 import { BubbleMenu } from "../bubble-menu/bubble-menu";
 import { SafeCopyToClipboard } from "../safe-copy-to-clipboard/safe-copy-to-clipboard";
 
@@ -37,18 +38,23 @@ export interface ShareMenuProps {
   openUrlShortenerModal: Binary<string, string, void>;
   customization: ClientCustomization;
   urlForEssence: (essence: Essence) => string;
-  getDownloadableDataset?: () => DataSetWithTabOptions;
 }
 
-type ExportProps = Pick<ShareMenuProps, "timekeeper" | "essence" | "onClose" | "getDownloadableDataset" | "customization">;
+interface ExportProps {
+  getDataset: Nullary<Dataset | null>;
+  essence: Essence;
+  timekeeper: Timekeeper;
+  customization: ClientCustomization;
+  onClose: Fn;
+}
 
 function onExport(fileFormat: FileFormat, props: ExportProps) {
-  const { essence, timekeeper, onClose, getDownloadableDataset, customization: { locale: { exportEncoding } } } = props;
-  const dataSetWithTabOptions = getDownloadableDataset();
-  if (!dataSetWithTabOptions.dataset) return;
+  const { getDataset, essence, timekeeper, onClose, customization: { locale: { exportEncoding } } } = props;
+  const dataset = getDataset();
+  if (!dataset) return;
   const fileName = fileNameBase(essence, timekeeper);
 
-  download(dataSetWithTabOptions, fileFormat, `${fileName}_export`, exportEncoding);
+  download(dataset, essence, fileFormat, `${fileName}_export`, exportEncoding);
   onClose();
 }
 
@@ -112,20 +118,26 @@ function externalViewItems({ customization: { externalViews = [] }, essence }: E
   });
 }
 
-export function ShareMenu(props: ShareMenuProps) {
-  const { openOn, onClose } = props;
-
-  return <BubbleMenu
-    className="header-menu"
-    direction="down"
-    stage={Stage.fromSize(230, 200)}
-    openOn={openOn}
-    onClose={onClose}
-  >
-    <ul className="bubble-list">
-      {linkItems(props)}
-      {exportItems(props)}
-      {externalViewItems(props)}
-    </ul>
-  </BubbleMenu>;
+export class ShareMenu extends React.Component<ShareMenuProps> {
+  static contextType = DownloadableDatasetContext;
+  context: DownloadableDataset;
+
+  render() {
+    const { getDataset } = this.context;
+    const { openOn, onClose } = this.props;
+
+    return <BubbleMenu
+      className="header-menu"
+      direction="down"
+      stage={Stage.fromSize(230, 200)}
+      openOn={openOn}
+      onClose={onClose}
+    >
+      <ul className="bubble-list">
+        {linkItems(this.props)}
+        {exportItems({ ...this.props, getDataset })}
+        {externalViewItems(this.props)}
+      </ul>
+    </BubbleMenu>;
+  }
 }

src/client/modals/raw-data-modal/raw-data-modal.tsx

@@ -36,7 +36,6 @@ import { exportOptions, STRINGS } from "../../config/constants";
 import { classNames } from "../../utils/dom/dom";
 import { download, FileFormat, fileNameBase } from "../../utils/download/download";
 import { getVisibleSegments } from "../../utils/sizing/sizing";
-import tabularOptions from "../../utils/tabular-options/tabular-options";
 import "./raw-data-modal.scss";
 
 const HEADER_HEIGHT = 30;
@@ -293,9 +292,8 @@ export class RawDataModal extends React.Component<RawDataModalProps, RawDataModa
     const { dataset } = this.state;
     const { essence, locale, timekeeper } = this.props;
 
-    const options = tabularOptions(essence);
     const fileName = fileNameBase(essence, timekeeper);
-    download({ dataset, options }, fileFormat, `${fileName}_raw_data`, locale.exportEncoding);
+    download(dataset, essence, fileFormat, `${fileName}_raw_data`, locale.exportEncoding);
   }
 
   render() {

src/client/utils/dataset/sparse-dataset/test-fixtures.ts

@@ -16,7 +16,6 @@
  */
 
 import { Dataset } from "plywood";
-import { DataSetWithTabOptions } from "../../../views/cube-view/cube-view";
 
 export const rawDataset = {
   data: [

src/client/utils/download/download.ts

@@ -20,7 +20,7 @@ import { Dataset, TabulatorOptions } from "plywood";
 import { Essence } from "../../../common/models/essence/essence";
 import { Timekeeper } from "../../../common/models/timekeeper/timekeeper";
 import { formatUrlSafeDateTime } from "../../../common/utils/time/time";
-import { DataSetWithTabOptions } from "../../views/cube-view/cube-view";
+import tabularOptions from "../tabular-options/tabular-options";
 
 export type FileFormat = "csv" | "tsv";
 
@@ -36,16 +36,16 @@ export function getMIMEType(fileType: FileFormat) {
 function saveFile(part: string | Buffer, fileName: string, fileFormat: FileFormat, fileEncoding: string) {
   const type = `${getMIMEType(fileFormat)};charset=${fileEncoding}`;
   const blob = new Blob([part], { type });
-  fileSaver.saveAs(blob, `${fileName}.${fileFormat}`, true); // true == disable auto BOM
+  fileSaver.saveAs(blob, `${fileName}.${fileFormat}`, true);
 }
 
 function encodeContent(content: string, encoding: string): Promise<string | Buffer> {
   if (encoding === "utf-8") return Promise.resolve(content);
   return import("iconv-lite").then(iconv => iconv.encode(content, encoding));
 }
 
-export function download({ dataset, options }: DataSetWithTabOptions, fileFormat: FileFormat, fileName: string, fileEncoding: string) {
-  const result = datasetToFileString(dataset, fileFormat, options);
+export function download(dataset: Dataset, essence: Essence, fileFormat: FileFormat, fileName: string, fileEncoding: string) {
+  const result = datasetToFileString(dataset, fileFormat, tabularOptions(essence));
   encodeContent(result, fileEncoding).then(content => {
     saveFile(content, fileName, fileFormat, fileEncoding);
   });

src/client/views/cube-view/cube-header-bar/cube-header-bar.tsx

@@ -31,7 +31,6 @@ import { ShareMenu } from "../../../components/share-menu/share-menu";
 import { SvgIcon } from "../../../components/svg-icon/svg-icon";
 import { TimezoneMenu } from "../../../components/timezone-menu/timezone-menu";
 import { classNames } from "../../../utils/dom/dom";
-import { DataSetWithTabOptions } from "../cube-view";
 import "./cube-header-bar.scss";
 
 export interface CubeHeaderBarProps {
@@ -47,7 +46,6 @@ export interface CubeHeaderBarProps {
   openDruidQueryModal?: Fn;
   openUrlShortenerModal?: Binary<string, string, void>;
   customization?: ClientCustomization;
-  getDownloadableDataset?: () => DataSetWithTabOptions;
   changeTimezone?: (timezone: Timezone) => void;
 }
 
@@ -128,7 +126,7 @@ export class CubeHeaderBar extends React.Component<CubeHeaderBarProps, CubeHeade
   closeShareMenu = () => this.setState({ shareMenuAnchor: null });
 
   renderShareMenu() {
-    const { customization, essence, timekeeper, openUrlShortenerModal, urlForEssence, getDownloadableDataset } = this.props;
+    const { customization, essence, timekeeper, openUrlShortenerModal, urlForEssence } = this.props;
     const { shareMenuAnchor } = this.state;
     if (!shareMenuAnchor) return null;
 
@@ -140,7 +138,6 @@ export class CubeHeaderBar extends React.Component<CubeHeaderBarProps, CubeHeade
       onClose={this.closeShareMenu}
       customization={customization}
       urlForEssence={urlForEssence}
-      getDownloadableDataset={getDownloadableDataset}
     />;
   }