FIR-16956: Add support for bytea (#39)

Author: aymeric-dispa

.github/workflows/integration-tests.yaml

@@ -33,5 +33,7 @@ jobs:
           FIREBOLT_ENGINE_NAME: ${{ steps.setup.outputs.engine_name }}
           FIREBOLT_ENGINE_ENDPOINT: ${{ steps.setup.outputs.engine_url }}
           FIREBOLT_API_ENDPOINT: ${{ secrets.FIREBOLT_API_ENDPOINT }}
+          FIREBOLT_CLIENT_ID: ${{ secrets.FIREBOLT_CLIENT_ID }}
+          FIREBOLT_CLIENT_SECRET: ${{ secrets.FIREBOLT_CLIENT_SECRET }}
         run: |
           npm run test:ci integration

src/formatter/index.ts

@@ -136,7 +136,7 @@ export class QueryFormatter {
   }
 
   private escapeBuffer(param: Buffer) {
-    return "X" + this.escapeString(param.toString("hex"));
+    return this.escapeString("\\x" + param.toString("hex"));
   }
 
   private escapeArray(param: unknown[], prefix = "[", suffix = "]") {

src/statement/dataTypes.ts

@@ -27,7 +27,8 @@ const typeMapping = {
   uint8: "int",
   uint16: "int",
   uint32: "int",
-  uint64: "long"
+  uint64: "long",
+  bytea: "bytea"
 };
 
 const getMappedType = (innerType: string) => {
@@ -76,6 +77,8 @@ export const INTEGER_TYPES = withNullableTypes(["int", "integer", "long"]);
 
 export const STRING_TYPES = withNullableTypes(["string", "text"]);
 
+export const BYTEA_TYPES = withNullableTypes(["bytea"]);
+
 export const getFireboltType = (type: string): string => {
   const key = type.toLowerCase();
   const match = key.match(COMPLEX_TYPE);
@@ -88,6 +91,10 @@ export const getFireboltType = (type: string): string => {
   return mappedType || key;
 };
 
+export const isByteAType = (type: string) => {
+  return BYTEA_TYPES.indexOf(type) !== -1;
+};
+
 export const isDateType = (type: string) => {
   return DATE_TYPES.indexOf(type) !== -1 || type.match(/datetime64(.+)/i);
 };

src/statement/hydrateResponse.ts

@@ -1,7 +1,7 @@
 import BigNumber from "bignumber.js";
 import { ExecuteQueryOptions, Row } from "../types";
 import { Meta } from "../meta";
-import { isDateType, isNumberType } from "./dataTypes";
+import { isByteAType, isDateType, isNumberType } from "./dataTypes";
 import { hydrateDate } from "./hydrateDate";
 
 const getHydratedValue = (
@@ -23,6 +23,10 @@ const getHydratedValue = (
     }
     return value;
   }
+  if (isByteAType(type) && value != null) {
+    const valueWithoutPrefix = (value as string).substring(2);
+    return Buffer.from(valueWithoutPrefix.toString(), "hex");
+  }
   return value;
 };
 

test/integration/bytea.test.ts

@@ -0,0 +1,48 @@
+import { Firebolt } from "../../src/index";
+
+const connectionParams = {
+  auth: {
+    username: process.env.FIREBOLT_USERNAME as string,
+    password: process.env.FIREBOLT_PASSWORD as string
+  },
+  database: process.env.FIREBOLT_DATABASE as string,
+  engineName: process.env.FIREBOLT_ENGINE_NAME as string
+};
+
+jest.setTimeout(100000);
+
+describe("bytea", () => {
+  it("handles select bytea", async () => {
+    const firebolt = Firebolt({
+      apiEndpoint: process.env.FIREBOLT_API_ENDPOINT as string
+    });
+
+    const connection = await firebolt.connect(connectionParams);
+
+    const statement = await connection.execute(
+      "SELECT 'hello_world_123ツ\n\u0048'::bytea"
+    );
+
+    const { data, meta } = await statement.fetchResult();
+    expect(meta[0].type).toEqual("bytea");
+    const row = data[0];
+    expect((row as unknown[])[0]).toEqual(
+      Buffer.from("hello_world_123ツ\n\u0048")
+    );
+  });
+
+  it("handles select null bytea", async () => {
+    const firebolt = Firebolt({
+      apiEndpoint: process.env.FIREBOLT_API_ENDPOINT as string
+    });
+
+    const connection = await firebolt.connect(connectionParams);
+
+    const statement = await connection.execute("SELECT null::bytea");
+
+    const { data, meta } = await statement.fetchResult();
+    expect(meta[0].type).toEqual("nullable(bytea)");
+    const row = data[0];
+    expect((row as unknown[])[0]).toEqual(null);
+  });
+});

test/unit/statement.test.ts

@@ -234,4 +234,14 @@ describe("format query", () => {
       `"select '123'::INT, 100, '2023-03-01'::DATE from table"`
     );
   });
+  it("format bytea", () => {
+    const queryFormatter = new QueryFormatter();
+    const query = "SELECT 'hello_world'::bytea == ?";
+    const buffer = Buffer.from("68656c6c6f5f776f726c64", "hex");
+    const formattedQuery = queryFormatter.formatQuery(query, [buffer]);
+    // Jest escaping rules are different, so we need to double the amount of quotes compared to .toEqual()
+    expect(formattedQuery).toMatchInlineSnapshot(
+      `"SELECT 'hello_world'::bytea == '\\\\\\\\x68656c6c6f5f776f726c64'"`
+    );
+  });
 });