Make PaginatedResource’s bodyHandler async

Preparation for #1293 (making ICipher.decrypt asynchronous).
ably · Jun 1, 2023 · 096a948 · 096a948
1 parent 4e61b5e
commit 096a948
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 25 deletions.
diff --git a/src/common/lib/client/channel.ts b/src/common/lib/client/channel.ts
@@ -97,7 +97,7 @@ class Channel extends EventEmitter {
     Utils.mixin(headers, rest.options.headers);
 
     const options = this.channelOptions;
-    new PaginatedResource(rest, this.basePath + '/messages', headers, envelope, function (
+    new PaginatedResource(rest, this.basePath + '/messages', headers, envelope, async function (
       body: any,
       headers: Record<string, string>,
       unpacked?: boolean

diff --git a/src/common/lib/client/paginatedresource.ts b/src/common/lib/client/paginatedresource.ts
@@ -5,7 +5,7 @@ import ErrorInfo, { IPartialErrorInfo } from '../types/errorinfo';
 import { PaginatedResultCallback } from '../../types/utils';
 import Rest from './rest';
 
-export type BodyHandler = (body: unknown, headers: Record<string, string>, packed?: boolean) => any;
+export type BodyHandler = (body: unknown, headers: Record<string, string>, packed?: boolean) => Promise<any>;
 
 function getRelParams(linkUrl: string) {
   const urlMatch = linkUrl.match(/^\.\/(\w+)\?(.*)$/);
@@ -149,25 +149,32 @@ class PaginatedResource {
       callback?.(err);
       return;
     }
-    let items, linkHeader, relParams;
-    try {
-      items = this.bodyHandler(body, headers || {}, unpacked);
-    } catch (e) {
-      /* If we got an error, the failure to parse the body is almost certainly
-       * due to that, so callback with that in preference over the parse error */
-      callback?.(err || e);
-      return;
-    }
 
-    if (headers && (linkHeader = headers['Link'] || headers['link'])) {
-      relParams = parseRelLinks(linkHeader);
-    }
+    const handleBody = async () => {
+      let items, linkHeader, relParams;
 
-    if (this.useHttpPaginatedResponse) {
-      callback(null, new HttpPaginatedResponse(this, items, headers || {}, statusCode as number, relParams, err));
-    } else {
-      callback(null, new PaginatedResult(this, items, relParams));
-    }
+      try {
+        items = await this.bodyHandler(body, headers || {}, unpacked);
+      } catch (e) {
+        /* If we got an error, the failure to parse the body is almost certainly
+         * due to that, so throw that in preference over the parse error */
+        throw err || e;
+      }
+
+      if (headers && (linkHeader = headers['Link'] || headers['link'])) {
+        relParams = parseRelLinks(linkHeader);
+      }
+
+      if (this.useHttpPaginatedResponse) {
+        return new HttpPaginatedResponse(this, items, headers || {}, statusCode as number, relParams, err);
+      } else {
+        return new PaginatedResult(this, items, relParams);
+      }
+    };
+
+    handleBody()
+      .then((result) => callback(null, result))
+      .catch((err) => callback(err, null));
   }
 }
 

diff --git a/src/common/lib/client/presence.ts b/src/common/lib/client/presence.ts
@@ -42,7 +42,7 @@ class Presence extends EventEmitter {
     Utils.mixin(headers, rest.options.headers);
 
     const options = this.channel.channelOptions;
-    new PaginatedResource(rest, this.basePath, headers, envelope, function (
+    new PaginatedResource(rest, this.basePath, headers, envelope, async function (
       body: any,
       headers: Record<string, string>,
       unpacked?: boolean
@@ -84,7 +84,7 @@ class Presence extends EventEmitter {
     Utils.mixin(headers, rest.options.headers);
 
     const options = this.channel.channelOptions;
-    new PaginatedResource(rest, this.basePath + '/history', headers, envelope, function (
+    new PaginatedResource(rest, this.basePath + '/history', headers, envelope, async function (
       body: any,
       headers: Record<string, string>,
       unpacked?: boolean

diff --git a/src/common/lib/client/push.ts b/src/common/lib/client/push.ts
@@ -161,7 +161,7 @@ class DeviceRegistrations {
 
     Utils.mixin(headers, rest.options.headers);
 
-    new PaginatedResource(rest, '/push/deviceRegistrations', headers, envelope, function (
+    new PaginatedResource(rest, '/push/deviceRegistrations', headers, envelope, async function (
       body: any,
       headers: Record<string, string>,
       unpacked?: boolean
@@ -286,7 +286,7 @@ class ChannelSubscriptions {
 
     Utils.mixin(headers, rest.options.headers);
 
-    new PaginatedResource(rest, '/push/channelSubscriptions', headers, envelope, function (
+    new PaginatedResource(rest, '/push/channelSubscriptions', headers, envelope, async function (
       body: any,
       headers: Record<string, string>,
       unpacked?: boolean
@@ -334,7 +334,7 @@ class ChannelSubscriptions {
 
     if (rest.options.pushFullWait) Utils.mixin(params, { fullWait: 'true' });
 
-    new PaginatedResource(rest, '/push/channels', headers, envelope, function (
+    new PaginatedResource(rest, '/push/channels', headers, envelope, async function (
       body: unknown,
       headers: Record<string, string>,
       unpacked?: boolean

diff --git a/src/common/lib/client/rest.ts b/src/common/lib/client/rest.ts
@@ -207,7 +207,7 @@ class Rest {
       path,
       headers,
       envelope,
-      function (resbody: unknown, headers: Record<string, string>, unpacked?: boolean) {
+      async function (resbody: unknown, headers: Record<string, string>, unpacked?: boolean) {
         return Utils.ensureArray(unpacked ? resbody : decoder(resbody as string & Buffer));
       },
       /* useHttpPaginatedResponse: */ true