@deephaven/iris-grid 0.22.3-embed-pandas.11 → 0.23.0

package/dist/sidebar/TableSaver.js

@@ -1,87 +1,58 @@
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
 import { PureComponent } from 'react';
 import { WritableStream as ponyfillWritableStream } from 'web-streams-polyfill/ponyfill';
 import dh from '@deephaven/jsapi-shim';
 import Log from '@deephaven/log';
 import { memoizeClear } from '@deephaven/grid';
-import { FormatterUtils } from '@deephaven/jsapi-utils';
+import { FormatterUtils, TableUtils } from '@deephaven/jsapi-utils';
 import { PromiseUtils, assertNotNull } from '@deephaven/utils';
 import IrisGridUtils from "../IrisGridUtils.js";
 var log = Log.module('TableSaver');
-
+var UNFORMATTED_DATE_PATTERN = "yyyy-MM-dd'T'HH:mm:ss.SSSSSSSSS z";
 function isUpdateEventData(data) {
   return data.added !== undefined;
 }
-
 function assertIsUpdateEventData(data) {
   if (!isUpdateEventData(data)) {
     throw new Error('event is not UpdateEventData');
   }
 }
-
 export default class TableSaver extends PureComponent {
   static csvEscapeString(str) {
     return "\"".concat(str.replace(/"/g, '""'), "\"");
   }
-
   constructor(props) {
     var _window$WritableStrea, _window$WritableStrea2;
-
     super(props);
-
     _defineProperty(this, "sw", void 0);
-
     _defineProperty(this, "port", void 0);
-
     _defineProperty(this, "fileWriter", void 0);
-
     _defineProperty(this, "table", void 0);
-
     _defineProperty(this, "tableSubscription", void 0);
-
     _defineProperty(this, "columns", void 0);
-
     _defineProperty(this, "fileName", void 0);
-
+    _defineProperty(this, "includeColumnHeaders", void 0);
+    _defineProperty(this, "useUnformattedValues", void 0);
     _defineProperty(this, "chunkRows", void 0);
-
     _defineProperty(this, "gridRanges", void 0);
-
     _defineProperty(this, "gridRangeCounter", void 0);
-
     _defineProperty(this, "rangedSnapshotsTotal", void 0);
-
     _defineProperty(this, "rangedSnapshotCounter", void 0);
-
     _defineProperty(this, "snapshotsTotal", void 0);
-
     _defineProperty(this, "snapshotCounter", void 0);
-
     _defineProperty(this, "snapshotsBuffer", void 0);
-
     _defineProperty(this, "currentSnapshotIndex", void 0);
-
     _defineProperty(this, "snapshotPending", void 0);
-
     _defineProperty(this, "cancelableSnapshots", void 0);
-
     _defineProperty(this, "WritableStream", (_window$WritableStrea = window.WritableStream) !== null && _window$WritableStrea !== void 0 ? _window$WritableStrea : ponyfillWritableStream);
-
     _defineProperty(this, "streamTimeout", void 0);
-
     _defineProperty(this, "snapshotHandlerTimeout", void 0);
-
     _defineProperty(this, "downloadStartTime", void 0);
-
     _defineProperty(this, "iframes", void 0);
-
     _defineProperty(this, "useBlobFallback", void 0);
-
     _defineProperty(this, "getCachedCustomColumnFormatFlag", memoizeClear(FormatterUtils.isCustomColumnFormatDefined, {
       max: 10000
     }));
-
     this.handlePortMessage = this.handlePortMessage.bind(this);
     this.handleSnapshotResolved = this.handleSnapshotResolved.bind(this);
     this.handleDownloadTimeout = this.handleDownloadTimeout.bind(this);
@@ -90,14 +61,19 @@ export default class TableSaver extends PureComponent {
     this.gridRangeCounter = 0;
     this.rangedSnapshotsTotal = [];
     this.rangedSnapshotCounter = 0;
+    this.includeColumnHeaders = true;
+    this.useUnformattedValues = false;
     this.snapshotsTotal = 0;
     this.snapshotCounter = 0;
     this.snapshotsBuffer = new Map();
     this.currentSnapshotIndex = 0;
     this.snapshotPending = 0;
-    this.cancelableSnapshots = []; // WritableStream is not supported in Firefox (also IE) yet. use ponyfillWritableStream instead
+    this.cancelableSnapshots = [];
+
+    // WritableStream is not supported in Firefox (also IE) yet. use ponyfillWritableStream instead
+    this.WritableStream = (_window$WritableStrea2 = window.WritableStream) !== null && _window$WritableStrea2 !== void 0 ? _window$WritableStrea2 : ponyfillWritableStream;
 
-    this.WritableStream = (_window$WritableStrea2 = window.WritableStream) !== null && _window$WritableStrea2 !== void 0 ? _window$WritableStrea2 : ponyfillWritableStream; // Due to an open issue in Chromium, readableStream.cancel() is never called when a user cancel the stream from Chromium's UI and the stream goes on even it's canceled.
+    // Due to an open issue in Chromium, readableStream.cancel() is never called when a user cancel the stream from Chromium's UI and the stream goes on even it's canceled.
     // Instead, we  monitor the pull() behavior from the readableStream called when the stream wants more data to write.
     // If the stream doesn't pull for long enough time, chances are the stream is already canceled, so we stop the stream.
     // Issue ticket on Chromium: https://bugs.chromium.org/p/chromium/issues/detail?id=638494
@@ -105,7 +81,6 @@ export default class TableSaver extends PureComponent {
     this.iframes = [];
     this.useBlobFallback = false;
   }
-
   componentDidMount() {
     var {
       getDownloadWorker
@@ -120,46 +95,37 @@ export default class TableSaver extends PureComponent {
       this.useBlobFallback = true;
     });
   }
-
   componentWillUnmount() {
     if (this.iframes.length > 0) {
       this.iframes.forEach(iframe => {
         iframe.remove();
       });
     }
-
     if (this.streamTimeout) clearTimeout(this.streamTimeout);
     if (this.snapshotHandlerTimeout) clearTimeout(this.snapshotHandlerTimeout);
   }
-
   createWriterStream(port) {
     // use blob fall back if it's safari
     var useBlob = this.useBlobFallback;
     var chunks = [];
     var encode = null;
-
     if (useBlob) {
       encode = TextEncoder.prototype.encode.bind(new TextEncoder());
     }
-
     var {
       fileName
     } = this;
     var streamConfig = {};
-
     if (useBlob) {
       streamConfig.write = chunk => {
         assertNotNull(encode);
-
         if (chunk.header !== undefined) {
           chunks.push(encode(chunk.header));
         }
-
         if (chunk.rows !== undefined) {
           chunks.push(encode(chunk.rows));
         }
       };
-
       streamConfig.close = () => {
         assertNotNull(fileName);
         var blob = new Blob(chunks, {
@@ -170,7 +136,6 @@ export default class TableSaver extends PureComponent {
         link.download = fileName;
         link.click();
       };
-
       streamConfig.abort = () => {
         port.postMessage({
           cancel: true
@@ -181,14 +146,12 @@ export default class TableSaver extends PureComponent {
       streamConfig.write = chunk => {
         port.postMessage(chunk);
       };
-
       streamConfig.close = () => {
         port.postMessage({
           end: true
         });
         port.close();
       };
-
       streamConfig.abort = () => {
         port.postMessage({
           cancel: true
@@ -196,85 +159,74 @@ export default class TableSaver extends PureComponent {
         port.close();
       };
     }
-
     return new this.WritableStream(streamConfig);
   }
-
-  startDownload(fileName, frozenTable, tableSubscription, snapshotRanges, modelRanges) {
+  startDownload(fileName, frozenTable, tableSubscription, snapshotRanges, modelRanges, includeColumnHeaders, useUnformattedValues) {
     // don't trigger another download when a download is ongoing
     var {
       isDownloading
     } = this.props;
-
     if (isDownloading) {
       return;
     }
-
     this.downloadStartTime = Date.now();
     log.info("start downloading ".concat(fileName));
     this.table = frozenTable;
     this.columns = IrisGridUtils.columnsFromRanges(modelRanges, frozenTable.columns);
     this.tableSubscription = tableSubscription;
-    this.gridRanges = snapshotRanges; // Make filename RFC5987 compatible
+    this.gridRanges = snapshotRanges;
+    this.includeColumnHeaders = includeColumnHeaders;
+    this.useUnformattedValues = useUnformattedValues;
 
+    // Make filename RFC5987 compatible
     var encodedFileName = encodeURIComponent(fileName.replace(/\//g, ':')).replace(/['()]/g, escape).replace(/\*/g, '%2A');
     var messageChannel = new MessageChannel();
     this.port = messageChannel.port1;
     this.fileName = fileName;
-    this.fileWriter = this.createWriterStream(this.port).getWriter(); // if the browser doesn't support stream or there's no active service worker, use blobs for table download
+    this.fileWriter = this.createWriterStream(this.port).getWriter();
 
+    // if the browser doesn't support stream or there's no active service worker, use blobs for table download
     if (this.useBlobFallback) {
-      this.writeCsvTable();
+      this.writeCsvTable(includeColumnHeaders);
       return;
     }
-
     if (this.sw) {
       // send file name and port to service worker
       this.sw.postMessage({
         encodedFileName
       }, [messageChannel.port2]);
     }
-
     this.port.onmessage = this.handlePortMessage;
   }
-
   finishDownload() {
     if (this.table) {
       this.table.close();
     }
-
     if (this.tableSubscription) {
       this.tableSubscription.close();
     }
-
     if (this.fileWriter) {
       this.fileWriter.close();
     }
-
     var {
       onDownloadCompleted
     } = this.props;
     onDownloadCompleted();
     this.resetTableSaver();
-
     if (this.downloadStartTime !== undefined) {
       log.info("download finished, total elapsed time ".concat((Date.now() - this.downloadStartTime) / 1000, " seconds"));
     }
   }
-
   cancelDownload() {
     if (this.table) {
       this.table.close();
     }
-
     if (this.tableSubscription) {
       this.tableSubscription.close();
     }
-
     if (this.fileWriter) {
       this.fileWriter.abort();
     }
-
     this.cancelableSnapshots.forEach(cancelable => {
       if (cancelable) {
         cancelable.catch(() => null);
@@ -287,7 +239,6 @@ export default class TableSaver extends PureComponent {
     onDownloadCanceled();
     this.resetTableSaver();
   }
-
   resetTableSaver() {
     this.table = undefined;
     this.tableSubscription = undefined;
@@ -297,47 +248,40 @@ export default class TableSaver extends PureComponent {
     this.gridRangeCounter = 0;
     this.rangedSnapshotsTotal = [];
     this.rangedSnapshotCounter = 0;
+    this.includeColumnHeaders = true;
+    this.useUnformattedValues = false;
     this.snapshotsTotal = 0;
     this.snapshotCounter = 0;
     this.snapshotsBuffer = new Map();
     this.currentSnapshotIndex = 0;
     this.snapshotPending = 0;
     this.cancelableSnapshots = [];
-
     if (this.streamTimeout != null) {
       clearTimeout(this.streamTimeout);
     }
-
     if (this.snapshotHandlerTimeout != null) {
       clearTimeout(this.snapshotHandlerTimeout);
     }
-
     this.streamTimeout = undefined;
     this.snapshotHandlerTimeout = undefined;
   }
-
   handleDownloadTimeout() {
     log.info('download canceled');
     this.cancelDownload();
   }
-
   writeTableHeader() {
     var _this$fileWriter;
-
     var headerString = '';
-
     if (this.columns) {
       for (var i = 0; i < this.columns.length; i += 1) {
         headerString += this.columns[i].name;
         headerString += i === this.columns.length - 1 ? '\n' : ',';
       }
     }
-
     (_this$fileWriter = this.fileWriter) === null || _this$fileWriter === void 0 ? void 0 : _this$fileWriter.write({
       header: headerString
     }).then(() => null);
   }
-
   startWriteTableBody() {
     if (this.columns && this.gridRanges != null) {
       this.chunkRows = Math.floor(TableSaver.DOWNLOAD_CELL_CHUNK / this.columns.length);
@@ -352,12 +296,12 @@ export default class TableSaver extends PureComponent {
       this.makeSnapshot(Math.min(TableSaver.SNAPSHOT_BUFFER_SIZE, this.snapshotsTotal));
     }
   }
-
-  writeCsvTable() {
-    this.writeTableHeader();
+  writeCsvTable(includeColumnHeaders) {
+    if (includeColumnHeaders) {
+      this.writeTableHeader();
+    }
     this.startWriteTableBody();
   }
-
   writeSnapshot(snapshotIndex, snapshotStartRow, snapshotEndRow) {
     if (this.currentSnapshotIndex === snapshotIndex && this.fileWriter) {
       while (this.snapshotsBuffer.has(this.currentSnapshotIndex)) {
@@ -370,19 +314,16 @@ export default class TableSaver extends PureComponent {
         this.currentSnapshotIndex += 1;
         this.updateDownloadProgress(snapshotIndex);
       }
-
       if (this.snapshotsTotal && this.currentSnapshotIndex >= this.snapshotsTotal) {
         this.finishDownload();
         return;
       }
     }
-
     if (this.snapshotCounter && this.snapshotsTotal && this.snapshotCounter < this.snapshotsTotal) {
       log.debug2("\n        current range index: ".concat(this.gridRangeCounter, ", \n        snapshotIndexCounter: ").concat(this.snapshotCounter, ", \n        currentRangedSnapshotIndex : ").concat(this.rangedSnapshotCounter, ", \n        snapshotpending: ").concat(this.snapshotPending, ", \n        buffered ").concat(this.snapshotsBuffer.size, "\n        making ").concat(Math.min(TableSaver.SNAPSHOT_BUFFER_SIZE - this.snapshotsBuffer.size - this.snapshotPending, this.snapshotsTotal - this.snapshotCounter), " more snapshots\n        "));
       this.makeSnapshot(Math.min(TableSaver.SNAPSHOT_BUFFER_SIZE - this.snapshotsBuffer.size - this.snapshotPending, this.snapshotsTotal - this.snapshotCounter));
     }
   }
-
   updateDownloadProgress(snapshotIndex) {
     if (snapshotIndex != null && this.snapshotsTotal != null && this.downloadStartTime != null) {
       var {
@@ -393,7 +334,6 @@ export default class TableSaver extends PureComponent {
       onDownloadProgressUpdate(downloadProgress, estimateTime);
     }
   }
-
   convertSnapshotIntoCsv(snapshot) {
     var csvString = '';
     var snapshotIterator = snapshot.added.iterator();
@@ -401,60 +341,58 @@ export default class TableSaver extends PureComponent {
       formatter
     } = this.props;
     var rows = [];
-
     while (snapshotIterator.hasNext()) {
       rows.push(snapshotIterator.next().value);
     }
-
     assertNotNull(this.columns);
-
+    var {
+      useUnformattedValues
+    } = this;
     for (var i = 0; i < rows.length; i += 1) {
       var rowIdx = rows[i];
-
       for (var j = 0; j < this.columns.length; j += 1) {
-        var _this$columns;
-
         var {
           type,
           name
         } = this.columns[j];
-        var hasCustomColumnFormat = this.getCachedCustomColumnFormatFlag(formatter, name, type);
-        var formatOverride = null;
-
-        if (!hasCustomColumnFormat) {
-          var cellFormat = snapshot.getFormat(rowIdx, this.columns[j]);
-          formatOverride = (cellFormat === null || cellFormat === void 0 ? void 0 : cellFormat.formatString) != null ? cellFormat : null;
-        }
-
         var cellData = null;
-
-        if (formatOverride) {
-          cellData = formatter.getFormattedString(snapshot.getData(rowIdx, this.columns[j]), type, name, formatOverride);
+        if (useUnformattedValues) {
+          var _snapshot$getData;
+          var value = (_snapshot$getData = snapshot.getData(rowIdx, this.columns[j])) !== null && _snapshot$getData !== void 0 ? _snapshot$getData : '';
+          if (value !== '' && TableUtils.isDateType(type)) {
+            // value is just a long value, we should return the value formatted as a full date string
+            value = dh.i18n.DateTimeFormat.format(UNFORMATTED_DATE_PATTERN, value, dh.i18n.TimeZone.getTimeZone(formatter.timeZone));
+          }
+          cellData = value.toString();
         } else {
-          cellData = formatter.getFormattedString(snapshot.getData(rowIdx, this.columns[j]), type, name);
+          var hasCustomColumnFormat = this.getCachedCustomColumnFormatFlag(formatter, name, type);
+          var formatOverride = null;
+          if (!hasCustomColumnFormat) {
+            var cellFormat = snapshot.getFormat(rowIdx, this.columns[j]);
+            formatOverride = (cellFormat === null || cellFormat === void 0 ? void 0 : cellFormat.formatString) != null ? cellFormat : null;
+          }
+          if (formatOverride) {
+            cellData = formatter.getFormattedString(snapshot.getData(rowIdx, this.columns[j]), type, name, formatOverride);
+          } else {
+            cellData = formatter.getFormattedString(snapshot.getData(rowIdx, this.columns[j]), type, name);
+          }
         }
-
         csvString += TableSaver.csvEscapeString(cellData);
-        csvString += j === ((_this$columns = this.columns) === null || _this$columns === void 0 ? void 0 : _this$columns.length) - 1 ? '\n' : ',';
+        csvString += j === this.columns.length - 1 ? '\n' : ',';
       }
     }
-
     return csvString;
   }
-
   makeSnapshot(n) {
     var _this = this;
-
     if (n <= 0) {
       return;
     }
-
     assertNotNull(this.gridRangeCounter);
     var i = 0;
     var currentGridRange = this.gridRanges[this.gridRangeCounter];
     assertNotNull(this.tableSubscription);
     assertNotNull(this.columns);
-
     var _loop = function _loop() {
       assertNotNull(currentGridRange);
       assertNotNull(currentGridRange.startRow);
@@ -464,37 +402,29 @@ export default class TableSaver extends PureComponent {
       var snapshotStartRow = currentGridRange.startRow + _this.rangedSnapshotCounter * _this.chunkRows;
       var snapshotEndRow = Math.min(snapshotStartRow + _this.chunkRows - 1, currentGridRange.endRow);
       var snapshotIndex = _this.snapshotCounter;
-
       _this.cancelableSnapshots.push(PromiseUtils.makeCancelable(_this.tableSubscription.snapshot(dh.RangeSet.ofRange(snapshotStartRow, snapshotEndRow), _this.columns).then(snapshot => {
         assertIsUpdateEventData(snapshot);
-
         _this.handleSnapshotResolved(snapshot, snapshotIndex, snapshotStartRow, snapshotEndRow);
-
         return snapshotIndex;
       }).catch(err => {
         log.error(err);
       }), val => {
         log.info("snapshot ".concat(val, " has been canceled"));
       }));
-
       _this.rangedSnapshotCounter += 1;
       _this.snapshotCounter += 1;
       _this.snapshotPending += 1;
-
       if (_this.rangedSnapshotCounter >= _this.rangedSnapshotsTotal[_this.gridRangeCounter]) {
         _this.gridRangeCounter += 1;
         _this.rangedSnapshotCounter = 0;
         currentGridRange = _this.gridRanges[_this.gridRangeCounter];
       }
-
       i += 1;
     };
-
     while (i < n) {
       _loop();
     }
   }
-
   handlePortMessage(_ref) {
     var {
       data
@@ -503,27 +433,25 @@ export default class TableSaver extends PureComponent {
       download,
       readableStreamPulling
     } = data;
-
     if (this.useBlobFallback) {
       return;
     }
-
     if (download != null) {
+      var {
+        includeColumnHeaders
+      } = this;
       this.makeIframe("".concat(download));
-      this.writeCsvTable();
+      this.writeCsvTable(includeColumnHeaders);
     }
-
     if (readableStreamPulling != null) {
       if (!this.useBlobFallback) {
         if (this.streamTimeout != null) {
           clearTimeout(this.streamTimeout);
         }
-
         this.streamTimeout = setTimeout(this.handleDownloadTimeout, TableSaver.STREAM_TIMEOUT);
       }
     }
   }
-
   handleSnapshotResolved(snapshot, snapshotIndex, snapshotStartRow, snapshotEndRow) {
     // use time out to break writeSnapshot into an individual task in browser with timeout, so there's window for the browser to update table in needed.
     this.snapshotHandlerTimeout = setTimeout(() => {
@@ -533,7 +461,6 @@ export default class TableSaver extends PureComponent {
       this.cancelableSnapshots[snapshotIndex] = null;
     }, TableSaver.SNAPSHOT_HANDLER_TIMEOUT);
   }
-
   makeIframe(src) {
     // make a return value and make it static method
     var iframe = document.createElement('iframe');
@@ -543,21 +470,14 @@ export default class TableSaver extends PureComponent {
     document.body.appendChild(iframe);
     this.iframes.push(iframe);
   }
-
   render() {
     return null;
   }
-
 }
-
 _defineProperty(TableSaver, "DOWNLOAD_CELL_CHUNK", 6000);
-
 _defineProperty(TableSaver, "SNAPSHOT_BUFFER_SIZE", 5);
-
 _defineProperty(TableSaver, "STREAM_TIMEOUT", 8000);
-
 _defineProperty(TableSaver, "SNAPSHOT_HANDLER_TIMEOUT", 5);
-
 _defineProperty(TableSaver, "defaultProps", {
   getDownloadWorker: () => Promise.reject(new Error('Download worker not provided')),
   isDownloading: false,