@quillsql/node 0.5.9 → 0.6.1

package/src/db/Snowflake.ts

@@ -1,5 +1,4 @@
 import snowflake from "snowflake-sdk";
-import { Client } from "../models/Client";
 import { QuillQueryResults } from "./DatabaseHelper";
 import { capitalize, depluralize } from "../utils/textProcessing";
 
@@ -31,7 +30,7 @@ export type SnowflakeConnectionConfig = {
 
 export async function runQuerySnowflake(
   sql: string,
-  connection: snowflake.Connection
+  connection: snowflake.Connection,
 ): Promise<QuillQueryResults> {
   const results = await new Promise((resolve, reject) => {
     connection.execute({
@@ -56,7 +55,7 @@ export async function runQuerySnowflake(
 }
 
 export async function getSchemasSnowflake(
-  connection: snowflake.Connection
+  connection: snowflake.Connection,
 ): Promise<string[]> {
   const sql = `SELECT SCHEMA_NAME FROM INFORMATION_SCHEMA.SCHEMATA
     WHERE SCHEMA_NAME != 'INFORMATION_SCHEMA'`;
@@ -66,7 +65,7 @@ export async function getSchemasSnowflake(
 
 export async function getTablesBySchemaSnowflake(
   connection: snowflake.Connection,
-  schemaNames: string[]
+  schemaNames: string[],
 ): Promise<{ tableName: string; schemaName: string }[]> {
   const allColumns = await Promise.all(
     schemaNames.map(async (schema) => {
@@ -80,7 +79,7 @@ export async function getTablesBySchemaSnowflake(
       return results.rows.map((row) => {
         return { tableName: row.tableName, schemaName: row.schemaName };
       });
-    })
+    }),
   );
   return allColumns.flat();
 }
@@ -88,7 +87,7 @@ export async function getTablesBySchemaSnowflake(
 export async function getColumnsByTableSnowflake(
   connection: snowflake.Connection,
   schemaName: string,
-  tableName: string
+  tableName: string,
 ): Promise<string[]> {
   const sql = `SELECT COLUMN_NAME FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_SCHEMA = '${schemaName}' AND TABLE_NAME = '${tableName}'`;
   const results = await runQuerySnowflake(sql, connection);
@@ -96,7 +95,7 @@ export async function getColumnsByTableSnowflake(
 }
 
 export function formatSnowflakeConfig(
-  connectionString: string
+  connectionString: string,
 ): SnowflakeConnectionConfig {
   const parsed = new URL(connectionString);
   return {
@@ -109,7 +108,7 @@ export function formatSnowflakeConfig(
 }
 
 export function connectToSnowflake(
-  config: SnowflakeConnectionConfig
+  config: SnowflakeConnectionConfig,
 ): snowflake.Connection {
   const connection = snowflake.createConnection({
     ...config,
@@ -124,9 +123,9 @@ export function connectToSnowflake(
 }
 
 export async function disconnectFromSnowflake(
-  connection: snowflake.Connection
+  connection: snowflake.Connection,
 ) {
-  connection.destroy((err, conn) => {
+  connection.destroy((err) => {
     if (err) {
       console.error(`Failed to disconnect from Snowflake: ${err.message}`);
     }
@@ -137,9 +136,9 @@ export async function getForeignKeysSnowflake(
   connection: snowflake.Connection,
   schemaName: string,
   tableName: string,
-  primaryKey: string
+  primaryKey: string,
 ): Promise<string[]> {
-  let depluralizedTableName = depluralize(tableName);
+  const depluralizedTableName = depluralize(tableName);
   let sql = `SELECT COLUMN_NAME FROM INFORMATION_SCHEMA.COLUMNS 
     WHERE TABLE_SCHEMA = '${schemaName}' 
     AND TABLE_NAME = '${schemaName}' 
@@ -152,7 +151,7 @@ export async function getForeignKeysSnowflake(
     return key.COLUMN_NAME;
   });
   foreignKeysString = foreignKeysString.filter(
-    (key) => key !== "id" && key !== "_id_"
+    (key) => key !== "id" && key !== "_id_",
   );
   foreignKeysString = [...new Set(foreignKeysString)];
   if (foreignKeysString.length === 0) {
@@ -177,7 +176,7 @@ export async function getForeignKeysSnowflake(
 export async function getSchemaColumnInfoSnowflake(
   connection: snowflake.Connection,
   schemaName: string,
-  tableNames: { tableName: string; schemaName: string }[]
+  tableNames: { tableName: string; schemaName: string }[],
 ) {
   const allColumns = await Promise.all(
     tableNames.map(async (tableName) => {
@@ -200,7 +199,7 @@ export async function getSchemaColumnInfoSnowflake(
           };
         }),
       };
-    })
+    }),
   );
   return allColumns;
 }

package/src/index.ispec.ts

@@ -16,6 +16,10 @@
 //     );
 //   });
 
+// afterEach(async () => {
+//   await quill.close();
+// });
+
 //   afterAll(() => {
 //     jest.restoreAllMocks();
 //   });

package/src/index.ts

@@ -1,4 +1,3 @@
-import QuillServerClient from "./clients/QuillServerClient";
 import { CacheCredentials } from "./models/Cache";
 import {
   AdditionalProcessing,
@@ -10,7 +9,7 @@ import axios from "axios";
 import "dotenv/config";
 import { mapQueries, removeFields } from "./utils/RunQueryProcesses";
 import {
-  connectToDatabase,
+  connectAndRunQuery,
   getColumnInfoBySchemaByDatabase,
   getColumnsByTableByDatabase,
   getDatabaseCredentials,
@@ -18,6 +17,7 @@ import {
   getSchemasByDatabase,
   getTablesBySchemaByDatabase,
   runQueryByDatabase,
+  withConnection,
 } from "./db/DatabaseHelper";
 import { convertTypeToPostgres } from "./utils/schemaConversion";
 
@@ -44,9 +44,9 @@ export enum DatabaseType {
   mysql = "mysql",
 }
 
-export class Quill {
+export class Quill implements AsyncDisposable {
   // Configure cached connection pools with the given config.
-  public targetConnection;
+  private targetConnection;
   private baseUrl: string;
   private config: {
     headers: {
@@ -92,6 +92,11 @@ export class Quill {
   }: QuillQueryParams): Promise<QuillQueryResult> {
     this.targetConnection.orgId = orgId;
     let responseMetadata: any = {};
+
+    if (!metadata.task) {
+      return { error: "Missing task.", status: "error", data: {} };
+    }
+
     try {
       const preQueryResults = metadata.preQueries
         ? await this.runQueries(
@@ -114,7 +119,11 @@ export class Quill {
         viewQuery: metadata.preQueries ? metadata.preQueries[0] : undefined,
       });
       if (response.error) {
-        return { status: "error", error: response.error };
+        return {
+          status: "error",
+          error: response.error,
+          data: response.metadata || {},
+        };
       }
       // if there is no metadata object in the response, create one
       if (response.metadata) {
@@ -153,8 +162,8 @@ export class Quill {
     } catch (err) {
       return {
         status: "error",
-        error: (err as any).message,
-        data: responseMetadata,
+        error: (err as any).response?.data?.error ?? (err as any).message,
+        data: responseMetadata || {},
       };
     }
   }
@@ -177,6 +186,7 @@ export class Quill {
         queryResults: [],
       };
     }
+
     if (runQueryConfig?.arrayToMap) {
       const mappedArray = await mapQueries(queries, this.targetConnection);
       return { ...results, queryResults: [], mappedArray };
@@ -221,8 +231,13 @@ export class Quill {
               };
             });
             return { ...table, columns: columns, rows: queryResult.rows };
-          } catch (err) {
-            return { ...table, error: "Error fetching columns" };
+          } catch (err: any) {
+            return {
+              ...table,
+              error: err.message
+                ? `Error fetching columns: ${err.message}`
+                : "Error fetching columns",
+            };
           }
         }),
       );
@@ -250,7 +265,6 @@ export class Quill {
         runQueryConfig.schema!,
         queryResult!,
       );
-      this.targetConnection.close();
       return schemaInfo;
     } else {
       if (runQueryConfig?.limitThousand) {
@@ -309,6 +323,10 @@ export class Quill {
     return response.data;
   }
 
+  public async [Symbol.asyncDispose](): Promise<void> {
+    await this.close();
+  }
+
   public async close() {
     await this.targetConnection.close();
   }
@@ -341,6 +359,8 @@ const requireQuill = ({
 
 module.exports = requireQuill;
 module.exports.default = requireQuill;
+module.exports.withConnection = withConnection;
+module.exports.connectAndRunQuery = connectAndRunQuery;
 module.exports.Quill = Quill;
 module.exports.getTablesBySchemaByDatabase = getTablesBySchemaByDatabase;
 module.exports.getDatabaseCredentials = getDatabaseCredentials;
@@ -349,7 +369,6 @@ module.exports.getForiegnKeysByDatabase = getForiegnKeysByDatabase;
 module.exports.getSchemasByDatabase = getSchemasByDatabase;
 module.exports.getColumnInfoBySchemaByDatabase =
   getColumnInfoBySchemaByDatabase;
-module.exports.connectToDatabase = connectToDatabase;
 module.exports.runQueryByDatabase = runQueryByDatabase;
 module.exports.DatabaseType = DatabaseType;
 

package/src/index.uspec.ts

@@ -17,6 +17,10 @@
 //     quill.targetConnection.query = jest.fn().mockResolvedValue([]);
 //   });
 
+// afterEach(async () => {
+//   await quill.close();
+// });
+
 //   describe("query", () => {
 //     it("return nothing when suppling no queries", () => {
 //       const metadata = {

package/src/models/Cache.ts

@@ -1,10 +1,10 @@
-export interface Mapable {
+export interface Mappable {
   get(key: string): Promise<string | null>;
   set(
     key: string,
     value: string,
     type?: string,
-    ttl?: number
+    ttl?: number,
   ): Promise<string | null>;
 }
 
@@ -15,4 +15,4 @@ export interface CacheCredentials {
   port: string;
   cacheType: string;
   ttl?: number;
-}
+}

package/src/utils/Error.ts

@@ -4,18 +4,32 @@ export class PgError extends Error {
   hint?: string;
   position?: string;
   // Add other properties if needed
+  constructor(
+    message: string,
+    detail?: string,
+    hint?: string,
+    position?: string,
+    code?: string,
+  ) {
+    super(message);
+    this.code = code;
+    this.detail = detail;
+    this.hint = hint;
+    this.position = position;
+  }
 }
 
 export function isSuperset(obj: any, baseClass: any): boolean {
-  // Get the property names of the base class
-  const baseProps = Object.getOwnPropertyNames(baseClass.prototype);
+  // Get the property names of the base class instance
+  const baseInstance = new baseClass();
+  const baseProps = Object.keys(baseInstance);
 
   // Check if the object has all the properties of the base class
   for (const prop of baseProps) {
-    if (!obj.hasOwnProperty(prop)) {
+    if (!Object.prototype.hasOwnProperty.call(obj, prop)) {
       return false;
     }
   }
 
   return true;
-}
+}

package/src/utils/RunQueryProcesses.ts

@@ -1,6 +1,6 @@
 import { CachedConnection } from "../db/CachedConnection";
 
-interface TableSchemaInfo {
+export interface TableSchemaInfo {
   fieldType: string;
   name: string;
   displayName: string;
@@ -9,7 +9,7 @@ interface TableSchemaInfo {
 
 export function removeFields(queryResults: any, fieldsToRemove: string[]): any {
   const fields = queryResults.fields.filter(
-    (field: { name: any }) => !fieldsToRemove.includes(field.name)
+    (field: { name: any }) => !fieldsToRemove.includes(field.name),
   );
   const rows = queryResults.rows.map((row: any) => {
     fieldsToRemove.forEach((field) => {
@@ -22,7 +22,7 @@ export function removeFields(queryResults: any, fieldsToRemove: string[]): any {
 
 export async function mapQueries(
   queries: string[],
-  targetConnection: CachedConnection
+  targetConnection: CachedConnection,
 ): Promise<any[]> {
   const mappedArray = [];
   for (let i = 0; i < queries.length; i++) {

package/src/utils/textProcessing.ts

@@ -10,4 +10,4 @@ export function depluralize(text: string): string {
     return text.slice(0, -1);
   }
   return text;
-}
+}