Convert RestChannelMixin.history to use promises

ably · Dec 8, 2023 · 817ab7f · 817ab7f
1 parent c8a4497
commit 817ab7f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 26 deletions.
diff --git a/src/common/lib/client/realtimechannel.ts b/src/common/lib/client/realtimechannel.ts
@@ -881,9 +881,7 @@ class RealtimeChannel extends EventEmitter {
       params.from_serial = this.properties.attachSerial;
     }
 
-    return new Promise((resolve, reject) => {
-      restMixin.history(this, params, (err, result) => (err ? reject(err) : resolve(result)));
-    });
+    return restMixin.history(this, params);
   } as any;
 
   whenState = ((state: string, listener: ErrCallback) => {

diff --git a/src/common/lib/client/restchannel.ts b/src/common/lib/client/restchannel.ts
@@ -47,9 +47,7 @@ class RestChannel {
 
   async history(params: RestHistoryParams | null): Promise<PaginatedResult<Message>> {
     Logger.logAction(Logger.LOG_MICRO, 'RestChannel.history()', 'channel = ' + this.name);
-    return new Promise((resolve, reject) => {
-      this.client.rest.channelMixin.history(this, params, (err, result) => (err ? reject(err) : resolve(result)));
-    });
+    return this.client.rest.channelMixin.history(this, params);
   }
 
   async publish(...args: any[]): Promise<void> {

diff --git a/src/common/lib/client/restchannelmixin.ts b/src/common/lib/client/restchannelmixin.ts
@@ -2,10 +2,9 @@ import * as API from '../../../../ably';
 import RestChannel from './restchannel';
 import RealtimeChannel from './realtimechannel';
 import * as Utils from '../util/utils';
-import { PaginatedResultCallback } from '../../types/utils';
 import Message, { fromResponseBody as messageFromResponseBody } from '../types/message';
 import Defaults from '../util/defaults';
-import PaginatedResource from './paginatedresource';
+import PaginatedResource, { PaginatedResult } from './paginatedresource';
 import Resource from './resource';
 
 export interface RestHistoryParams {
@@ -22,9 +21,8 @@ export class RestChannelMixin {
 
   static history(
     channel: RestChannel | RealtimeChannel,
-    params: RestHistoryParams | null,
-    callback: PaginatedResultCallback<Message>
-  ): void {
+    params: RestHistoryParams | null
+  ): Promise<PaginatedResult<Message>> {
     const client = channel.client,
       format = client.options.useBinaryProtocol ? Utils.Format.msgpack : Utils.Format.json,
       envelope = channel.client.http.supportsLinkHeaders ? undefined : format,
@@ -33,21 +31,13 @@ export class RestChannelMixin {
     Utils.mixin(headers, client.options.headers);
 
     const options = channel.channelOptions;
-    Utils.whenPromiseSettles(
-      new PaginatedResource(client, this.basePath(channel) + '/messages', headers, envelope, async function (
-        body,
-        headers,
-        unpacked
-      ) {
-        return await messageFromResponseBody(
-          body as Message[],
-          options,
-          client._MsgPack,
-          unpacked ? undefined : format
-        );
-      }).get(params as Record<string, unknown>),
-      callback
-    );
+    return new PaginatedResource(client, this.basePath(channel) + '/messages', headers, envelope, async function (
+      body,
+      headers,
+      unpacked
+    ) {
+      return await messageFromResponseBody(body as Message[], options, client._MsgPack, unpacked ? undefined : format);
+    }).get(params as Record<string, unknown>);
   }
 
   static async status(channel: RestChannel | RealtimeChannel): Promise<API.Types.ChannelDetails> {