From dd0165ce81ecc032aef54d0630d61bf91b7d4641 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=9B=A7=E5=9B=A7?= <liuc223@gmail.com>
Date: Tue, 13 Feb 2024 21:17:57 +0800
Subject: [PATCH] Persist query history (#81)

---
 src/components/ShellView/CypherEditor.vue  | 11 +++-
 src/components/ShellView/ShellCell.vue     | 13 +++-
 src/components/ShellView/ShellMainView.vue | 42 +++++++++++++
 src/server/Cypher.js                       | 22 +++++--
 src/server/Gpt.js                          | 14 ++++-
 src/server/Session.js                      | 18 ++++++
 src/server/utils/SessionDatabase.js        | 70 ++++++++++++++++++++--
 7 files changed, 177 insertions(+), 13 deletions(-)

diff --git a/src/components/ShellView/CypherEditor.vue b/src/components/ShellView/CypherEditor.vue
index 9fc30d7..13a394f 100644
--- a/src/components/ShellView/CypherEditor.vue
+++ b/src/components/ShellView/CypherEditor.vue
@@ -108,7 +108,7 @@ export default {
       default: false,
     },
   },
-emits: ['remove', 'evaluateCypher', 'toggleMaximize', 'generateAndEvaluateQuery'],
+  emits: ['remove', 'evaluateCypher', 'toggleMaximize', 'generateAndEvaluateQuery'],
   data: () => {
     return {
       name: "CypherEditor",
@@ -229,10 +229,15 @@ emits: ['remove', 'evaluateCypher', 'toggleMaximize', 'generateAndEvaluateQuery'
     removeCell() {
       this.$emit("remove");
     },
-    isActive(){
+    isActive() {
       return (this.isQueryGenerationMode && this.$refs.gptQuestionTextArea === document.activeElement) ||
         (!this.isQueryGenerationMode && this.editor && this.editor.hasTextFocus());
-    }
+    },
+    loadFromHistory(history) {
+      this.isQueryGenerationMode = history.isQueryGenerationMode;
+      this.gptQuestion = history.gptQuestion;
+      this.setEditorContent(history.cypherQuery);
+    },
   },
 }
 </script>
diff --git a/src/components/ShellView/ShellCell.vue b/src/components/ShellView/ShellCell.vue
index c314e27..981d3b2 100644
--- a/src/components/ShellView/ShellCell.vue
+++ b/src/components/ShellView/ShellCell.vue
@@ -85,12 +85,21 @@ export default {
     isActive() {
       return this.$refs.editor.isActive();
     },
+    loadEditorFromHistory(history) {
+      this.isEvaluated = true;
+      this.$refs.editor.loadFromHistory(history);
+    },
     evaluateCypher(query) {
       this.queryResult = null;
       this.errorMessage = "";
       this.isLoading = true;
       this.loadingText = "Evaluating query...";
-      Axios.post("/api/cypher", { query })
+      Axios.post("/api/cypher",
+        {
+          query,
+          uuid: this.cellId,
+          isQueryGenerationMode: this.$refs.editor.isQueryGenerationMode
+        })
         .then((res) => {
           this.queryResult = res.data;
           this.queryString = query;
@@ -158,6 +167,8 @@ export default {
         question,
         token,
         model,
+        uuid: this.cellId,
+        isQueryGenerationMode: this.$refs.editor.isQueryGenerationMode
       };
       Axios.post(url, data)
         .then((res) => {
diff --git a/src/components/ShellView/ShellMainView.vue b/src/components/ShellView/ShellMainView.vue
index d6a6bdc..2bce1d1 100644
--- a/src/components/ShellView/ShellMainView.vue
+++ b/src/components/ShellView/ShellMainView.vue
@@ -23,6 +23,7 @@
 <script lang="js">
 import ShellCell from "./ShellCell.vue";
 import { v4 as uuidv4 } from 'uuid';
+import Axios from "axios";
 export default {
   name: "ShellMainView",
   components: {
@@ -58,6 +59,7 @@ export default {
     });
     window.addEventListener("resize", this.updateContainerHeight);
     document.addEventListener("keydown", this.handleKeyDown);
+    this.loadCellsFromHistory();
   },
 
   beforeUnmount() {
@@ -75,12 +77,49 @@ export default {
       this.containerHeight = window.innerHeight - this.navbarHeight;
     },
     removeCell(index) {
+      const uuid = this.shellCell[index].cellId;
       this.shellCell.splice(index, 1);
       this.$nextTick(() => {
         if (this.shellCell.length === 0) {
           this.shellCell.push(this.createCell());
         }
       });
+      if (!uuid) {
+        return;
+      }
+      try {
+        this.removeCellFromHistory(uuid);
+      } catch (e) {
+        // Ignore
+      }
+    },
+    removeCellFromHistory(uuid) {
+      return Axios.delete(`/api/session/history/${uuid}`);
+    },
+    loadCellHistoryFromServer() {
+      return Axios.get("/api/session/history").then(res => res.data);
+    },
+    async loadCellsFromHistory() {
+      const history = await this.loadCellHistoryFromServer();
+      history.map(cell => {
+        return {
+          cellId: cell.uuid,
+        };
+      }).forEach(cell => {
+        if (this.isCellAddedToTheEnd) {
+          this.shellCell.unshift(cell);
+        }
+        else {
+          this.shellCell.push(cell);
+        }
+      });
+      this.$nextTick(() => {
+        history.forEach((cell) => {
+          const uuid = cell.uuid;
+          const cellRef = this.$refs[this.getCellRefById(uuid)][0];
+          cellRef.loadEditorFromHistory(cell);
+        });
+      });
     },
     addCell() {
       const cell = this.createCell();
@@ -103,6 +142,9 @@ export default {
     getCellRef(index) {
       return `shell-cell-${this.shellCell[index].cellId}`;
     },
+    getCellRefById(uuid) {
+      return `shell-cell-${uuid}`;
+    },
     handleKeyDown(event) {
       if (event.shiftKey && event.key === "Enter") {
         event.preventDefault();
diff --git a/src/server/Cypher.js b/src/server/Cypher.js
index 612255a..3edeb5c 100644
--- a/src/server/Cypher.js
+++ b/src/server/Cypher.js
@@ -1,8 +1,9 @@
-const database = require("./utils/Database");
 const express = require("express");
 const router = express.Router();
 const logger = require("./utils/Logger");
 const MODES = require("./utils/Constants").MODES;
+const database = require("./utils/Database");
+const sessionDb = require("./utils/SessionDatabase");
 
 const DEMO_MODE = MODES.DEMO;
 
@@ -67,16 +68,29 @@ router.post("/", async (req, res) => {
     if (mode === MODES.READ_WRITE) {
       const currentSchema = await database.getSchema();
       isSchemaChanged =
-          JSON.stringify(schema) !== JSON.stringify(currentSchema);
+        JSON.stringify(schema) !== JSON.stringify(currentSchema);
     }
     // This is a workaround for the JSON stringify issue with INT128 values
     const replacer = (key, value) => {
-      if (typeof value === 'bigint') {
+      if (typeof value === "bigint") {
         return value.toString();
       }
       return value;
     };
-    const responseBody = JSON.stringify({ rows, dataTypes, isSchemaChanged }, replacer);
+    const responseBody = JSON.stringify(
+      { rows, dataTypes, isSchemaChanged },
+      replacer
+    );
+    try {
+      await sessionDb.upsertHistoryItem({
+        uuid: req.body.uuid,
+        isQueryGenerationMode: Boolean(req.body.isQueryGenerationMode),
+        cypherQuery: query,
+      });
+    } catch (err) {
+      // Ignore the error. It fails to record the history, but the query is
+      // still executed.
+    }
     return res.send(responseBody);
   } catch (err) {
     return res.status(400).send({ error: err.message });
diff --git a/src/server/Gpt.js b/src/server/Gpt.js
index d0a02e9..96e7dc5 100644
--- a/src/server/Gpt.js
+++ b/src/server/Gpt.js
@@ -2,6 +2,7 @@ const openai = require("openai").OpenAI;
 const express = require("express");
 const router = express.Router();
 const database = require("./utils/Database");
+const sessionDb = require("./utils/SessionDatabase");
 
 const getPrompt = (question, schema) => {
   const prompt = `Task:Generate Cypher statement for Kùzu Graph Database Mangagement System to query a graph database.
@@ -61,7 +62,18 @@ router.post("/", async (req, res) => {
   let query;
   try {
     query = chatCompletion.choices[0].message.content;
-    query  = query.split("\n").join(" ");
+    query = query.split("\n").join(" ");
+    try {
+      await sessionDb.upsertHistoryItem({
+        uuid: req.body.uuid,
+        isQueryGenerationMode: Boolean(req.body.isQueryGenerationMode),
+        gptQuestion: question,
+        cypherQuery: query,
+      });
+    } catch (err) {
+      // Ignore the error. It fails to record the history, but the query is
+      // still executed.
+    }
     res.send({ query, prompt, schema, model });
   } catch (err) {
     return res
diff --git a/src/server/Session.js b/src/server/Session.js
index eaba130..b134d6f 100644
--- a/src/server/Session.js
+++ b/src/server/Session.js
@@ -21,4 +21,22 @@ router.post("/settings", async (req, res) => {
   }
 });
 
+router.get("/history", async (_, res) => {
+  try {
+    const history = await sessionDb.getHistoryItems();
+    res.send(history);
+  } catch (err) {
+    return res.status(400).send({ error: err.message });
+  }
+});
+
+router.delete("/history/:uuid", async (req, res) => {
+  try {
+    await sessionDb.deleteHistoryItem(req.params.uuid);
+    res.send({ success: true });
+  } catch (err) {
+    return res.status(400).send({ error: err.message });
+  }
+});
+
 module.exports = router;
diff --git a/src/server/utils/SessionDatabase.js b/src/server/utils/SessionDatabase.js
index bc92f6e..01f3c71 100644
--- a/src/server/utils/SessionDatabase.js
+++ b/src/server/utils/SessionDatabase.js
@@ -87,6 +87,10 @@ class SessionDatabase {
     return this.sqlInitPromise;
   }
 
+  isWritable() {
+    return this.isInitialized && !this.isReadOnly;
+  }
+
   async createDbSchema() {
     await this.db.exec(`
       CREATE TABLE settings (
@@ -118,10 +122,7 @@ class SessionDatabase {
 
   async setSetting(value, key = "allSettings") {
     await this.initSqlite();
-    if (!this.isInitialized) {
-      return;
-    }
-    if (this.isReadOnly) {
+    if (!this.isWritable()) {
       return;
     }
     await this.db.run(
@@ -130,6 +131,67 @@ class SessionDatabase {
       JSON.stringify(value)
     );
   }
+
+  async upsertHistoryItem(historyItem) {
+    await this.initSqlite();
+    if (!this.isWritable()) {
+      return;
+    }
+    await this.db.run("BEGIN TRANSACTION;");
+    try {
+      let { uuid, isQueryGenerationMode, gptQuestion, cypherQuery } =
+        historyItem;
+      const currentRow = await this.db.get(
+        "SELECT * FROM history WHERE uuid = ?",
+        uuid
+      );
+      if (!currentRow) {
+        await this.db.run(
+          "INSERT INTO history (uuid, isQueryGenerationMode, gptQuestion, cypherQuery) VALUES (?, ?, ?, ?)",
+          uuid,
+          isQueryGenerationMode,
+          gptQuestion,
+          cypherQuery
+        );
+      } else {
+        if (!gptQuestion) {
+          gptQuestion = currentRow.gptQuestion;
+        }
+        if (!cypherQuery) {
+          cypherQuery = currentRow.cypherQuery;
+        }
+        await this.db.run(
+          "UPDATE history SET isQueryGenerationMode = ?, gptQuestion = ?, cypherQuery = ? WHERE uuid = ?",
+          isQueryGenerationMode,
+          gptQuestion,
+          cypherQuery,
+          uuid
+        );
+      }
+      await this.db.run("COMMIT;");
+    } catch (err) {
+      await this.db.run("ROLLBACK;");
+    }
+  }
+
+  async deleteHistoryItem(uuid) {
+    await this.initSqlite();
+    if (!this.isWritable()) {
+      return;
+    }
+    await this.db.run("DELETE FROM history WHERE uuid = ?", uuid);
+  }
+
+  async getHistoryItems() {
+    await this.initSqlite();
+    if (!this.isInitialized) {
+      return [];
+    }
+    const historyItems = await this.db.all(
+      "SELECT *, rowid FROM history ORDER BY rowid DESC"
+    );
+    return historyItems;
+  }
 }
 
 module.exports = new SessionDatabase();