Merge pull request #31 from RelationalAI/dg-txn-cancel

Transaction cancellation

Author: Denis Gursky

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@relationalai/rai-sdk-javascript",
   "description": "RelationalAI SDK for JavaScript",
-  "version": "0.5.11",
+  "version": "0.6.0",
   "author": {
     "name": "RelationalAI",
     "url": "https://relational.ai"

src/errors.ts

@@ -59,11 +59,12 @@ export function makeError(body: any, response: Response) {
     return new TransactionError(body, response);
   }
 
-  if (body?.message) {
-    return new ApiError(body.message, body.status, body.details, response);
-  }
-
-  return new Error(response.statusText);
+  return new ApiError(
+    body?.message || response.statusText || response.status,
+    body?.status || response.status,
+    body?.details,
+    response,
+  );
 }
 
 export type SdkError = ApiError | TransactionError | Error;

src/query/execAsyncApi.ts

@@ -66,12 +66,21 @@ export class ExecAsyncApi extends TransactionAsyncApi {
       readonly,
     );
     const txnId = result.transaction.id;
-    const startedAt = Date.now();
 
     if ('results' in result) {
       return result;
     }
 
+    return await this.pollTransaction(txnId, interval, timeout);
+  }
+
+  async pollTransaction(
+    txnId: string,
+    interval = 3 * 1000,
+    timeout = Number.POSITIVE_INFINITY,
+  ) {
+    const startedAt = Date.now();
+
     let transaction: TransactionAsyncCompact;
 
     await new Promise<void>((resolve, reject) => {

src/transaction/transactionAsyncApi.test.ts

@@ -170,10 +170,10 @@ describe('TransactionAsyncApi', () => {
     expect(result).toEqual(response);
   });
 
-  it('should delete transaction', async () => {
-    const response = { txn_id: 'id1', message: 'deleted' };
-    const scope = nock(baseUrl).delete(`${path}/id1`).reply(200, response);
-    const result = await api.deleteTransaction('id1');
+  it('should cancel transaction', async () => {
+    const response = {};
+    const scope = nock(baseUrl).post(`${path}/id1/cancel`).reply(200, response);
+    const result = await api.cancelTransaction('id1');
 
     scope.done();
 

src/transaction/transactionAsyncApi.ts

@@ -29,9 +29,8 @@ const ENDPOINT = 'transactions';
 
 type ListResponse = { transactions: TransactionAsync[] };
 type SingleResponse = { transaction: TransactionAsync };
-type DeleteResponse = {
-  txn_id: string;
-  message: string;
+type CancelResponse = {
+  message?: string;
 };
 
 export class TransactionAsyncApi extends Base {
@@ -89,12 +88,12 @@ export class TransactionAsyncApi extends Base {
     return result;
   }
 
-  async deleteTransaction(transactionId: string) {
-    const result = await this.delete<DeleteResponse>(
-      `${ENDPOINT}/${transactionId}`,
+  async cancelTransaction(transactionId: string) {
+    const result = await this.post<CancelResponse>(
+      `${ENDPOINT}/${transactionId}/cancel`,
       {},
     );
 
-    return result;
+    return result || {};
   }
 }

src/transaction/types.ts

@@ -167,6 +167,7 @@ export type TransactionResult = {
 export enum TransactionAsyncState {
   CREATED = 'CREATED',
   RUNNING = 'RUNNING',
+  CANCELLING = 'CANCELLING',
   ABORTED = 'ABORTED',
   COMPLETED = 'COMPLETED',
 }