feat: FIR-46459 support Firebolt-Remove-Parameters header in node sdk

Author: bogdantruta-firebolt

src/connection/base.ts

@@ -22,9 +22,14 @@ export const defaultResponseSettings = {
 };
 
 const updateParametersHeader = "Firebolt-Update-Parameters";
-const allowedUpdateParameters = ["database"];
+const allowedUpdateParameters = [
+  "database",
+  "transaction_id",
+  "transaction_sequence_id"
+];
 const updateEndpointHeader = "Firebolt-Update-Endpoint";
 const resetSessionHeader = "Firebolt-Reset-Session";
+const removeParametersHeader = "Firebolt-Remove-Parameters";
 const immutableParameters = ["database", "account_id", "output_format"];
 const testConnectionQuery = "SELECT 1";
 
@@ -119,6 +124,14 @@ export abstract class Connection {
     };
   }
 
+  private handleRemoveParametersHeader(headerValue: string) {
+    const removeParameters = headerValue.split(",");
+
+    removeParameters.forEach(key => {
+      delete this.parameters[key.trim()];
+    });
+  }
+
   private handleResetSessionHeader() {
     const remainingParameters: Record<string, string> = {};
     for (const key in this.parameters) {
@@ -161,6 +174,11 @@ export abstract class Connection {
     if (updateEndpointValue) {
       await this.handleUpdateEndpointHeader(updateEndpointValue);
     }
+
+    const removeParametersValue = headers.get(removeParametersHeader);
+    if (removeParametersValue) {
+      this.handleRemoveParametersHeader(removeParametersValue);
+    }
   }
 
   abstract executeAsync(

src/connection/connection_v1.ts

@@ -103,4 +103,22 @@ export class ConnectionV1 extends BaseConnection {
       "Stream execution is not supported in this Firebolt version."
     );
   }
+
+  async begin(): Promise<void> {
+    throw new Error(
+      "Transaction management is not supported in this Firebolt version."
+    );
+  }
+
+  async commit(): Promise<void> {
+    throw new Error(
+      "Transaction management is not supported in this Firebolt version."
+    );
+  }
+
+  async rollback(): Promise<void> {
+    throw new Error(
+      "Transaction management is not supported in this Firebolt version."
+    );
+  }
 }

src/connection/connection_v2.ts

@@ -218,4 +218,16 @@ export class ConnectionV2 extends BaseConnection {
     const settings = { internal: [{ auto_start_stop_control: "ignore" }] };
     await this.execute("select 1", { settings });
   }
+
+  async begin(): Promise<void> {
+    await this.execute("BEGIN TRANSACTION");
+  }
+
+  async commit(): Promise<void> {
+    await this.execute("COMMIT");
+  }
+
+  async rollback(): Promise<void> {
+    await this.execute("ROLLBACK");
+  }
 }

src/http/node.ts

@@ -28,7 +28,7 @@ const DEFAULT_ERROR = "Server error";
 const DEFAULT_USER_AGENT = systemInfoString();
 
 const PROTOCOL_VERSION_HEADER = "Firebolt-Protocol-Version";
-const PROTOCOL_VERSION = "2.3";
+const PROTOCOL_VERSION = "2.4";
 const createSocket = HttpsAgent.prototype.createSocket;
 
 const agentOptions = {

test/integration/v1/index.test.ts

@@ -209,4 +209,42 @@ describe("integration test", () => {
 
     data.pipe(process.stdout);
   });
+
+  describe("Transaction methods", () => {
+    it("throws error for begin transaction", async () => {
+      const firebolt = Firebolt({
+        apiEndpoint: process.env.FIREBOLT_API_ENDPOINT as string
+      });
+
+      const connection = await firebolt.connect(connectionParams);
+
+      await expect(connection.begin()).rejects.toThrow(
+        "Transaction management is not supported in this Firebolt version."
+      );
+    });
+
+    it("throws error for commit", async () => {
+      const firebolt = Firebolt({
+        apiEndpoint: process.env.FIREBOLT_API_ENDPOINT as string
+      });
+
+      const connection = await firebolt.connect(connectionParams);
+
+      await expect(connection.commit()).rejects.toThrow(
+        "Transaction management is not supported in this Firebolt version."
+      );
+    });
+
+    it("throws error for rollback", async () => {
+      const firebolt = Firebolt({
+        apiEndpoint: process.env.FIREBOLT_API_ENDPOINT as string
+      });
+
+      const connection = await firebolt.connect(connectionParams);
+
+      await expect(connection.rollback()).rejects.toThrow(
+        "Transaction management is not supported in this Firebolt version."
+      );
+    });
+  });
 });