Add ability to star and unstar query history

Signed-off-by: worksofliam <[email protected]>

Author: worksofliam

package.json

@@ -310,7 +310,7 @@
           "id": "queryHistory",
           "name": "Statement History",
           "visibility": "visible",
-          "when": "code-for-ibmi:connected == true && vscode-db2i:jobManager"
+          "when": "code-for-ibmi:connected == true && vscode-db2i:jobManager.hasJob"
         },
         {
           "id": "jobManager",
@@ -587,6 +587,12 @@
         "category": "Db2 for i",
         "icon": "$(search)"
       },
+      {
+        "command": "vscode-db2i.queryHistory.toggleStar",
+        "title": "Star statement",
+        "category": "Db2 for i",
+        "icon": "$(star)"
+      },
       {
         "command": "vscode-db2i.openSqlDocument",
         "title": "Open SQL Document",
@@ -870,6 +876,10 @@
           "command": "vscode-db2i.queryHistory.find",
           "when": "never"
         },
+        {
+          "command": "vscode-db2i.queryHistory.toggleStar",
+          "when": "never"
+        },
         {
           "command": "vscode-db2i.jobManager.closeJob",
           "when": "never"
@@ -1159,6 +1169,11 @@
           "when": "view == queryHistory && viewItem == query",
           "group": "inline"
         },
+        {
+          "command": "vscode-db2i.queryHistory.toggleStar",
+          "when": "view == queryHistory && viewItem == query",
+          "group": "inline"
+        },
         {
           "command": "vscode-db2i.jobManager.closeJob",
           "when": "view == jobManager && viewItem == sqlJob",

src/Storage.ts

@@ -6,6 +6,7 @@ const SERVERCOMPONENT_KEY = `serverVersion`
 export interface QueryHistoryItem {
   query: string;
   unix: number;
+  starred?: boolean;
 }
 
 export type QueryList = QueryHistoryItem[];

src/views/queryHistoryView/contributes.json

@@ -6,7 +6,7 @@
           "id": "queryHistory",
           "name": "Statement History",
           "visibility": "visible",
-          "when": "code-for-ibmi:connected == true && vscode-db2i:jobManager"
+          "when": "code-for-ibmi:connected == true && vscode-db2i:jobManager.hasJob"
         }
       ]
     },
@@ -34,6 +34,12 @@
         "title": "Search query history",
         "category": "Db2 for i",
         "icon": "$(search)"
+      },
+      {
+        "command": "vscode-db2i.queryHistory.toggleStar",
+        "title": "Star statement",
+        "category": "Db2 for i",
+        "icon": "$(star)"
       }
     ],
     "menus": {
@@ -45,6 +51,10 @@
         {
           "command": "vscode-db2i.queryHistory.find",
           "when": "never"
+        },
+        {
+          "command": "vscode-db2i.queryHistory.toggleStar",
+          "when": "never"
         }
       ],
       "view/title": [
@@ -64,6 +74,11 @@
           "command": "vscode-db2i.queryHistory.remove",
           "when": "view == queryHistory && viewItem == query",
           "group": "inline"
+        },
+        {
+          "command": "vscode-db2i.queryHistory.toggleStar",
+          "when": "view == queryHistory && viewItem == query",
+          "group": "inline"
         }
       ]
     }

src/views/queryHistoryView/index.ts

@@ -1,6 +1,7 @@
 import { commands, EventEmitter, ExtensionContext, MarkdownString, ThemeIcon, TreeItem, TreeItemCollapsibleState, window, workspace, Event } from "vscode";
 import { TreeDataProvider } from "vscode";
 import { Config } from "../../config";
+import { QueryHistoryItem } from "../../Storage";
 
 const openSqlDocumentCommand = `vscode-db2i.openSqlDocument`;
 
@@ -47,12 +48,28 @@ export class queryHistory implements TreeDataProvider<any> {
         }
       }),
 
+      commands.registerCommand(`vscode-db2i.queryHistory.toggleStar`, async (node: PastQueryNode) => {
+        if (node && Config.ready) {
+          let currentList = Config.getPastQueries();
+          const existingQuery = currentList.findIndex(queryItem => 
+            queryItem.unix === node.item.unix
+          );
+      
+          // If it exists, remove it
+          if (existingQuery >= 0) {
+            // Toggle the starred status
+            currentList[existingQuery].starred = !(currentList[existingQuery].starred === true);
+            await Config.setPastQueries(currentList);
+            this.refresh();
+          }
+        }
+      }),
+
       commands.registerCommand(`vscode-db2i.queryHistory.remove`, async (node: PastQueryNode) => {
         if (node && Config.ready) {
           let currentList = Config.getPastQueries();
-          const chosenQuery = node.query;
           const existingQuery = currentList.findIndex(queryItem => 
-            queryItem.query.trim() === chosenQuery.trim()
+            queryItem.unix === node.item.unix
           );
 
           // If it exists, remove it
@@ -65,10 +82,11 @@ export class queryHistory implements TreeDataProvider<any> {
       }),
 
       commands.registerCommand(`vscode-db2i.queryHistory.clear`, async () => {
-        window.showInformationMessage(`Statement history`, {detail: `Are you sure you want to clear your statement history?`, modal: true}, `Clear`).then(async (result) => {
+        window.showInformationMessage(`Statement history`, {detail: `Are you sure you want to clear your statement history? This will not remove starred items.`, modal: true}, `Clear`).then(async (result) => {
           if (result) {
             if (Config.ready) {
-              await Config.setPastQueries([]);
+              const starredItems = Config.getPastQueries().filter(queryItem => queryItem.starred === true);
+              await Config.setPastQueries(starredItems);
               this.refresh();
             }
           }
@@ -110,13 +128,13 @@ export class queryHistory implements TreeDataProvider<any> {
         currentList.forEach(queryItem => {
           // The smaller the unix value, the older it is
           if (queryItem.unix < monthAgo) {
-             olderQueries.push(new PastQueryNode(queryItem.query));
+             olderQueries.push(new PastQueryNode(queryItem));
           } else if (queryItem.unix < weekAgo) {
-            pastMonthQueries.push(new PastQueryNode(queryItem.query));
+            pastMonthQueries.push(new PastQueryNode(queryItem));
          } else if (queryItem.unix < dayAgo) {
-            pastWeekQueries.push(new PastQueryNode(queryItem.query));
+            pastWeekQueries.push(new PastQueryNode(queryItem));
          } else {
-            pastDayQueries.push(new PastQueryNode(queryItem.query));
+            pastDayQueries.push(new PastQueryNode(queryItem));
          }
         });
 
@@ -158,19 +176,19 @@ class TimePeriodNode extends TreeItem {
 }
 
 class PastQueryNode extends TreeItem {
-  constructor(public query: string) {
-    super(query);
+  constructor(public item: QueryHistoryItem) {
+    super(item.query);
 
     this.contextValue = `query`;
 
-    this.tooltip = new MarkdownString(['```sql', query, '```'].join(`\n`));
+    this.tooltip = new MarkdownString(['```sql', item.query, '```'].join(`\n`));
 
     this.command = {
       command: openSqlDocumentCommand,
-      arguments: [query],
+      arguments: [item.query],
       title: `Open into new document`
     };
 
-    this.iconPath = new ThemeIcon(`go-to-file`);
+    this.iconPath = new ThemeIcon(item.starred ? `star` : `go-to-file`);
   }
 }