Save data in a csv file (#4)

Author: brichet

package.json

@@ -56,10 +56,18 @@
         "watch:labextension": "jupyter labextension watch ."
     },
     "dependencies": {
+        "@json2csv/plainjs": "^7.0.0",
         "@jupyterlab/application": "^4.0.0",
+        "@jupyterlab/apputils": "^4.0.0",
+        "@jupyterlab/cells": "^4.0.0",
         "@jupyterlab/coreutils": "^6.0.0",
+        "@jupyterlab/notebook": "^4.0.0",
         "@jupyterlab/services": "^7.0.0",
-        "@jupyterlab/settingregistry": "^4.0.0"
+        "@jupyterlab/settingregistry": "^4.0.0",
+        "@jupyterlab/ui-components": "^4.0.0",
+        "@lumino/commands": "^2.0.0",
+        "@lumino/signaling": "^2.0.0",
+        "react": "^18.2.0"
     },
     "devDependencies": {
         "@jupyterlab/builder": "^4.0.0",

src/index.ts

@@ -1,9 +1,11 @@
+import { Parser } from '@json2csv/plainjs';
 import {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
 } from '@jupyterlab/application';
 import { ICommandPalette, IToolbarWidgetRegistry } from '@jupyterlab/apputils';
 import { INotebookTracker, NotebookPanel } from '@jupyterlab/notebook';
+import { Contents, ContentsManager } from '@jupyterlab/services';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { runIcon } from '@jupyterlab/ui-components';
 
@@ -34,20 +36,24 @@ const plugin: JupyterFrontEndPlugin<void> = {
       label: 'Run SQL',
       caption: 'Run SQL',
       icon: runIcon,
-      execute: () => {
+      execute: async args => {
+        const path = (args?.path || '_sql_output') as string;
+
         const activeCell = tracker.activeCell;
 
         if (!(activeCell?.model.type === 'raw')) {
           return;
         }
-
+        const date = new Date();
         const source = activeCell?.model.sharedModel.getSource();
         requestAPI<any>('execute', {
           method: 'POST',
           body: JSON.stringify({ query: source })
         })
           .then(data => {
-            console.log(data);
+            saveData(path, data.data, date)
+              .then(dataPath => console.log(`Data saved ${dataPath}`))
+              .catch(undefined);
           })
           .catch(reason => {
             console.error(
@@ -100,3 +106,52 @@ const plugin: JupyterFrontEndPlugin<void> = {
 };
 
 export default plugin;
+
+/**
+ * Save data in a CSV file.
+ *
+ * @param path - the path to the directory where to save data.
+ * @param data - the data to parse as CSV.
+ * @param date - the query date.
+ */
+async function saveData(
+  path: string,
+  data: any,
+  date: Date
+): Promise<string | undefined> {
+  const contentsManager = new ContentsManager();
+  const parser = new Parser();
+  const csv = parser.parse(data);
+
+  const dateText = date
+    .toLocaleString()
+    .replace(/[/:]/g, '-')
+    .replace(/\s/g, '')
+    .replace(',', '_');
+
+  const filename = `${dateText}.csv`;
+  const fileModel = {
+    name: filename,
+    path: `${path}/${filename}`,
+    format: 'text' as Contents.FileFormat,
+    content: csv
+  };
+
+  let currentPath = '';
+  for (const directory of path.split('/')) {
+    currentPath = `${currentPath}${directory}/`;
+    await contentsManager
+      .get(currentPath, { content: false })
+      .catch(() => contentsManager.save(currentPath, { type: 'directory' }));
+  }
+
+  return contentsManager
+    .save(fileModel.path, fileModel)
+    .then(() => {
+      return fileModel.path;
+    })
+    .catch(e => {
+      console.error(e);
+      return undefined;
+    });
+}

yarn.lock

@@ -2039,16 +2039,41 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@json2csv/formatters@npm:^7.0.3":
+  version: 7.0.3
+  resolution: "@json2csv/formatters@npm:7.0.3"
+  checksum: 283ae93eda527a25f0dedbfe3350f06a2c35c925da293e92a54b31fba979fa9afc39de2b3766012e52f8f8539bfa0468eb25081370d8728f93bf5cb8d08a9a8f
+  languageName: node
+  linkType: hard
+
+"@json2csv/plainjs@npm:^7.0.0":
+  version: 7.0.3
+  resolution: "@json2csv/plainjs@npm:7.0.3"
+  dependencies:
+    "@json2csv/formatters": ^7.0.3
+    "@streamparser/json": ^0.0.17
+    lodash.get: ^4.4.2
+  checksum: 34d0d9558494f530938bf4a259c65413bb069bd4ab66f6c56e1e46e02c20d35f68b3c994e2784aeae81dc365e59b22be2d2d88a11a0777b168a76ebf68f350f7
+  languageName: node
+  linkType: hard
+
 "@jupyter/sql-cell@workspace:.":
   version: 0.0.0-use.local
   resolution: "@jupyter/sql-cell@workspace:."
   dependencies:
+    "@json2csv/plainjs": ^7.0.0
     "@jupyterlab/application": ^4.0.0
+    "@jupyterlab/apputils": ^4.0.0
     "@jupyterlab/builder": ^4.0.0
+    "@jupyterlab/cells": ^4.0.0
     "@jupyterlab/coreutils": ^6.0.0
+    "@jupyterlab/notebook": ^4.0.0
     "@jupyterlab/services": ^7.0.0
     "@jupyterlab/settingregistry": ^4.0.0
     "@jupyterlab/testutils": ^4.0.0
+    "@jupyterlab/ui-components": ^4.0.0
+    "@lumino/commands": ^2.0.0
+    "@lumino/signaling": ^2.0.0
     "@types/jest": ^29.2.0
     "@types/json-schema": ^7.0.11
     "@types/react": ^18.0.26
@@ -2063,6 +2088,7 @@ __metadata:
     mkdirp: ^1.0.3
     npm-run-all: ^4.1.5
     prettier: ^3.0.0
+    react: ^18.2.0
     rimraf: ^5.0.1
     source-map-loader: ^1.0.2
     style-loader: ^3.3.1
@@ -2118,7 +2144,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@jupyterlab/apputils@npm:^4.1.6":
+"@jupyterlab/apputils@npm:^4.0.0, @jupyterlab/apputils@npm:^4.1.6":
   version: 4.1.6
   resolution: "@jupyterlab/apputils@npm:4.1.6"
   dependencies:
@@ -2202,7 +2228,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@jupyterlab/cells@npm:^4.0.6":
+"@jupyterlab/cells@npm:^4.0.0, @jupyterlab/cells@npm:^4.0.6":
   version: 4.0.6
   resolution: "@jupyterlab/cells@npm:4.0.6"
   dependencies:
@@ -2441,7 +2467,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@jupyterlab/notebook@npm:^4.0.6":
+"@jupyterlab/notebook@npm:^4.0.0, @jupyterlab/notebook@npm:^4.0.6":
   version: 4.0.6
   resolution: "@jupyterlab/notebook@npm:4.0.6"
   dependencies:
@@ -2681,7 +2707,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@jupyterlab/ui-components@npm:^4.0.6":
+"@jupyterlab/ui-components@npm:^4.0.0, @jupyterlab/ui-components@npm:^4.0.6":
   version: 4.0.6
   resolution: "@jupyterlab/ui-components@npm:4.0.6"
   dependencies:
@@ -2885,7 +2911,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@lumino/commands@npm:^2.1.3":
+"@lumino/commands@npm:^2.0.0, @lumino/commands@npm:^2.1.3":
   version: 2.1.3
   resolution: "@lumino/commands@npm:2.1.3"
   dependencies:
@@ -2968,7 +2994,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@lumino/signaling@npm:^1.10.0 || ^2.0.0, @lumino/signaling@npm:^2.1.2":
+"@lumino/signaling@npm:^1.10.0 || ^2.0.0, @lumino/signaling@npm:^2.0.0, @lumino/signaling@npm:^2.1.2":
   version: 2.1.2
   resolution: "@lumino/signaling@npm:2.1.2"
   dependencies:
@@ -3119,6 +3145,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@streamparser/json@npm:^0.0.17":
+  version: 0.0.17
+  resolution: "@streamparser/json@npm:0.0.17"
+  checksum: 5e1cb2113d3393b5858a2d32133ba9efed2ea732100f9967c50ec6104bc4d4948546d3263cbdb6b69185a49420dc216fb5f341b38eaad57293d6693357036c46
+  languageName: node
+  linkType: hard
+
 "@tootallnate/once@npm:2":
   version: 2.0.0
   resolution: "@tootallnate/once@npm:2.0.0"
@@ -7357,6 +7390,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"lodash.get@npm:^4.4.2":
+  version: 4.4.2
+  resolution: "lodash.get@npm:4.4.2"
+  checksum: e403047ddb03181c9d0e92df9556570e2b67e0f0a930fcbbbd779370972368f5568e914f913e93f3b08f6d492abc71e14d4e9b7a18916c31fa04bd2306efe545
+  languageName: node
+  linkType: hard
+
 "lodash.memoize@npm:4.x":
   version: 4.1.2
   resolution: "lodash.memoize@npm:4.1.2"