added csv and json output for run query on instnace

yunchengyang515 · yunchengyang515 · commit a93a532b2f04 · 2023-12-03T23:12:57.000+11:00
diff --git a/src/stackql.test.ts b/src/stackql.test.ts
@@ -1,6 +1,10 @@
 import { assertStringIncludes } from "https://deno.land/std@0.206.0/assert/mod.ts";
 import { StackQL } from "./stackql.ts";
-import { startStackQLServer } from "../testing/utils.ts";
+import {
+  isCsvString,
+  isJsonString,
+  startStackQLServer,
+} from "../testing/utils.ts";
 import {
   assertEquals,
   assertExists,
@@ -117,6 +121,49 @@ Deno.test("Set proxy properties from configs", async () => {
   runCommandSpy.restore();
 });
 
+Deno.test("run query Output: json", async () => {
+  await setupStackQL();
+  const stackQL = new StackQL();
+  await stackQL.initialize({
+    serverMode: false,
+    outputFormat: "json",
+  });
+  const githubTestQuery =
+    `SELECT id, name from github.repos.repos where org='stackql'`;
+
+  const result = await stackQL.runQuery(githubTestQuery);
+
+  const params = stackQL.getParams();
+
+  assertEquals(params, [
+    "--output",
+    "json",
+  ]);
+  assert(isJsonString(result));
+  assert(!(await isCsvString(result)));
+});
+
+Deno.test("run query Output: csv", async () => {
+  await setupStackQL();
+  const stackQL = new StackQL();
+  await stackQL.initialize({
+    serverMode: false,
+    outputFormat: "csv",
+  });
+  const githubTestQuery =
+    `SELECT id, name from github.repos.repos where org='stackql'`;
+
+  const result = await stackQL.runQuery(githubTestQuery);
+  const params = stackQL.getParams();
+
+  assertEquals(params, [
+    "--output",
+    "csv",
+  ]);
+  assert(!isJsonString(result));
+  assert(await isCsvString(result));
+});
+
 Deno.test("StackQL runServerQuery", async () => {
   const { closeProcess } = await startStackQLServer();
   const stackQL = new StackQL();
diff --git a/src/stackql.ts b/src/stackql.ts
@@ -17,14 +17,15 @@ export interface StackQLConfig {
   proxyUser?: string;
   proxyPassword?: string;
   proxyScheme?: "http" | "https";
+  outputFormat?: "csv" | "json";
 }
 
 export class StackQL {
   private binaryPath?: string; //The full path of the `stackql` executable (not supported in `server_mode`).
   private downloader: Downloader = new Downloader();
   private serverMode = false;
   private connection?: Client;
-  private format: "object" = "object";
+  private outputFormat: "csv" | "json" = "json";
   private params: string[] = [];
   private version: string | undefined; // The version number of the `stackql` executable (not supported in `server_mode`)
   private sha: string | undefined; // The commit (short) sha for the installed `stackql` binary build  (not supported in `server_mode`).
@@ -47,6 +48,13 @@ export class StackQL {
     return { version: this.version, sha: this.sha };
   }
 
+  async execute(query: string) {
+    if (this.serverMode) {
+      const result = await this.runServerQuery(query);
+    }
+    return await this.runQuery(query);
+  }
+
   private async updateVersion() {
     if (!this.binaryPath) {
       throw new Error("Binary path not found");
@@ -61,12 +69,22 @@ export class StackQL {
       this.sha = sha;
     }
   }
+
+  /**
+   * Upgrade the `stackql` executable to the latest version
+   * @returns The version number of the `stackql` executable (not supported in `server_mode`)
+   */
   async upgrade() {
     this.binaryPath = await this.downloader.upgradeStackQL();
     await this.updateVersion();
     return this.getVersion();
   }
 
+  /**
+   * Initialize the `stackql` executable
+   * @param config The configuration object
+   * @returns The binary path of the `stackql` executable if `server_mode` is `false`, otherwise `undefined`
+   */
   public async initialize(config: StackQLConfig) {
     this.binaryPath = config.binaryPath;
     this.serverMode = config.serverMode || false;
@@ -80,6 +98,7 @@ export class StackQL {
     this.binaryPath = await this.downloader.setupStackQL();
     this.setProperties(config);
   }
+
   private binaryExist() {
     return !!this.binaryPath && osUtils.fileExists(this.binaryPath);
   }
@@ -139,8 +158,24 @@ export class StackQL {
     if (config.proxyHost !== undefined) {
       this.setProxyProperties(config);
     }
+
+    if (config.outputFormat !== undefined) {
+      if (!["csv", "json"].includes(config.outputFormat)) {
+        throw new Error(
+          `Invalid outputFormat. Expected one of ['csv', 'json'], got ${config.outputFormat}.`,
+        );
+      }
+      this.params.push("--output");
+      this.params.push(config.outputFormat);
+      this.outputFormat = config.outputFormat;
+    }
   }
 
+  /**
+   * Run a StackQL query
+   * @param query The StackQL query
+   * @returns The result of the query
+   */
   public async runQuery(query: string) {
     assertExists(this.binaryPath);
     const args = ["exec", query].concat(this.params);
@@ -165,15 +200,23 @@ export class StackQL {
     this.connection = await server.connect(connectionString);
   }
 
+  /**
+   * Close the connection to the stackql server
+   */
   public async closeConnection() {
     if (this.connection) {
       await this.connection.end();
     }
   }
 
+  /**
+   * Run a StackQL query on the server
+   * @param query The StackQL query
+   * @returns The result of the query
+   */
   public async runServerQuery(query: string) {
     try {
-      if (this.format === "object") {
+      if (this.outputFormat === "json") {
         const result = await this.queryObjectFormat(query);
         return result;
       }
diff --git a/testing/utils.ts b/testing/utils.ts
@@ -1,5 +1,6 @@
 import { existsSync } from "https://deno.land/std/fs/mod.ts";
 import { join } from "https://deno.land/std@0.133.0/path/mod.ts";
+import { parse } from "https://deno.land/std@0.134.0/encoding/csv.ts";
 
 export const removeStackQLDownload = async () => {
   const projectDir = Deno.cwd();
@@ -42,3 +43,21 @@ export const startStackQLServer = async (port = 5444) => {
   };
   return { closeProcess };
 };
+
+export const isJsonString = (str: string) => {
+  try {
+    JSON.parse(str);
+  } catch (_error) {
+    return false;
+  }
+  return true;
+};
+
+export const isCsvString = async (str: string) => {
+  try {
+    await parse(str);
+  } catch (_error) {
+    return false;
+  }
+  return true;
+};
