[DE-509] Add allowRetry query option support

Author: pluma

CHANGELOG.md

@@ -51,6 +51,10 @@ This driver uses semantic versioning:
 
   This option was added in ArangoDB 3.11.
 
+- Added support for `allowRetry` option in `db.query`
+
+  This feature was added in ArangoDB 3.11.
+
 - Added `x-arango-driver` header
 
   The arangojs driver now correctly identifies itself to ArangoDB, allowing the

src/cursor.ts

@@ -158,6 +158,7 @@ export class BatchedArrayCursor<T = any> {
   protected _count?: number;
   protected _extra: CursorExtras;
   protected _hasMore: boolean;
+  protected _nextBatchId?: string;
   protected _id: string | undefined;
   protected _hostUrl?: string;
   protected _allowDirtyRead?: boolean;
@@ -172,6 +173,7 @@ export class BatchedArrayCursor<T = any> {
       extra: any;
       result: T[];
       hasMore: boolean;
+      nextBatchId?: string;
       id: string;
       count: number;
     },
@@ -185,6 +187,7 @@ export class BatchedArrayCursor<T = any> {
     this._batches = batches;
     this._id = body.id;
     this._hasMore = Boolean(body.id && body.hasMore);
+    this._nextBatchId = body.nextBatchId;
     this._hostUrl = hostUrl;
     this._count = body.count;
     this._extra = body.extra;
@@ -209,15 +212,25 @@ export class BatchedArrayCursor<T = any> {
   }
 
   protected async _more(): Promise<void> {
-    if (!this.hasMore) return;
+    if (!this._id || !this.hasMore) return;
     const body = await this._db.request({
-      method: "PUT",
-      path: `/_api/cursor/${encodeURIComponent(this._id!)}`,
+      ...(this._nextBatchId
+        ? {
+            method: "POST",
+            path: `/_api/cursor/${encodeURIComponent(this._id)}/${
+              this._nextBatchId
+            }`,
+          }
+        : {
+            method: "PUT",
+            path: `/_api/cursor/${encodeURIComponent(this._id)}`,
+          }),
       hostUrl: this._hostUrl,
       allowDirtyRead: this._allowDirtyRead,
     });
     this._batches.push(new LinkedList(body.result));
     this._hasMore = body.hasMore;
+    this._nextBatchId = body.nextBatchId;
   }
 
   /**

src/database.ts

@@ -189,6 +189,13 @@ export type QueryOptions = {
    * Default: `false`
    */
   allowDirtyRead?: boolean;
+  /**
+   * If set to `true`, cursor results will be stored by ArangoDB in such a way
+   * that batch reads can be retried in the case of a communication error.
+   *
+   * Default: `false`
+   */
+  allowRetry?: boolean;
   /**
    * Maximum time in milliseconds arangojs will wait for a server response.
    * Exceeding this value will result in the request being cancelled.