Make MessagePack functionality tree-shakable

We move the MessagePack functionality into a tree-shakable MsgPack
module.

Resolves #1375.

scripts/moduleReport.js

@@ -1,7 +1,7 @@
 const esbuild = require('esbuild');
 
 // List of all modules accepted in ModulesMap
-const moduleNames = ['Rest', 'Crypto'];
+const moduleNames = ['Rest', 'Crypto', 'MsgPack'];
 
 // List of all free-standing functions exported by the library along with the
 // ModulesMap entries that we expect them to transitively import

src/common/lib/client/baseclient.ts

@@ -14,6 +14,7 @@ import { ModulesMap } from './modulesmap';
 import { Rest } from './rest';
 import { IUntypedCryptoStatic } from 'common/types/ICryptoStatic';
 import { throwMissingModuleError } from '../util/utils';
+import { MsgPack } from 'common/types/msgpack';
 
 /**
  `BaseClient` acts as the base class for all of the client classes exported by the SDK. It is an implementation detail and this class is not advertised publicly.
@@ -30,7 +31,7 @@ class BaseClient {
 
   private readonly _rest: Rest | null;
   readonly _Crypto: IUntypedCryptoStatic | null;
-  readonly _MsgPack = Platform.Config.msgpack;
+  readonly _MsgPack: MsgPack | null;
 
   constructor(options: ClientOptions | string, modules: ModulesMap) {
     if (!options) {
@@ -47,7 +48,8 @@ class BaseClient {
       'initialized with clientOptions ' + Platform.Config.inspect(options)
     );
 
-    const normalOptions = (this.options = Defaults.normaliseOptions(optionsObj));
+    this._MsgPack = modules.MsgPack ?? null;
+    const normalOptions = (this.options = Defaults.normaliseOptions(optionsObj, this._MsgPack));
 
     /* process options */
     if (normalOptions.key) {

src/common/lib/client/defaultrealtime.ts

@@ -6,13 +6,19 @@ import ConnectionManager from '../transport/connectionmanager';
 import ProtocolMessage from '../types/protocolmessage';
 import Platform from 'common/platform';
 import { DefaultMessage } from '../types/defaultmessage';
+import { MsgPack } from 'common/types/msgpack';
 
 /**
  `DefaultRealtime` is the class that the non tree-shakable version of the SDK exports as `Realtime`. It ensures that this version of the SDK includes all of the functionality which is optionally available in the tree-shakable version.
  */
 export class DefaultRealtime extends BaseRealtime {
   constructor(options: ClientOptions) {
-    super(options, { ...allCommonModules, Crypto: DefaultRealtime.Crypto ?? undefined });
+    const MsgPack = DefaultRealtime._MsgPack;
+    if (!MsgPack) {
+      throw new Error('Expected DefaultRealtime._MsgPack to have been set');
+    }
+
+    super(options, { ...allCommonModules, Crypto: DefaultRealtime.Crypto ?? undefined, MsgPack });
   }
 
   static Utils = Utils;
@@ -32,4 +38,6 @@ export class DefaultRealtime extends BaseRealtime {
   }
 
   static Message = DefaultMessage;
+
+  static _MsgPack: MsgPack | null = null;
 }

src/common/lib/client/defaultrest.ts

@@ -3,13 +3,23 @@ import ClientOptions from '../../types/ClientOptions';
 import { allCommonModules } from './modulesmap';
 import Platform from 'common/platform';
 import { DefaultMessage } from '../types/defaultmessage';
+import { MsgPack } from 'common/types/msgpack';
 
 /**
  `DefaultRest` is the class that the non tree-shakable version of the SDK exports as `Rest`. It ensures that this version of the SDK includes all of the functionality which is optionally available in the tree-shakable version.
  */
 export class DefaultRest extends BaseRest {
   constructor(options: ClientOptions | string) {
-    super(options, { ...allCommonModules, Crypto: DefaultRest.Crypto ?? undefined });
+    const MsgPack = DefaultRest._MsgPack;
+    if (!MsgPack) {
+      throw new Error('Expected DefaultRest._MsgPack to have been set');
+    }
+
+    super(options, {
+      ...allCommonModules,
+      Crypto: DefaultRest.Crypto ?? undefined,
+      MsgPack: DefaultRest._MsgPack ?? undefined,
+    });
   }
 
   private static _Crypto: typeof Platform.Crypto = null;
@@ -25,4 +35,6 @@ export class DefaultRest extends BaseRest {
   }
 
   static Message = DefaultMessage;
+
+  static _MsgPack: MsgPack | null = null;
 }

src/common/lib/client/modulesmap.ts

@@ -1,9 +1,11 @@
 import { Rest } from './rest';
 import { IUntypedCryptoStatic } from '../../types/ICryptoStatic';
+import { MsgPack } from 'common/types/msgpack';
 
 export interface ModulesMap {
   Rest?: typeof Rest;
   Crypto?: IUntypedCryptoStatic;
+  MsgPack?: MsgPack;
 }
 
 export const allCommonModules: ModulesMap = { Rest };

src/common/lib/client/resource.ts

@@ -30,7 +30,7 @@ function withAuthDetails(
 
 function unenvelope<T>(
   callback: ResourceCallback<T>,
-  MsgPack: MsgPack,
+  MsgPack: MsgPack | null,
   format: Utils.Format | null
 ): ResourceCallback<T> {
   return (err, body, outerHeaders, unpacked, outerStatusCode) => {
@@ -226,6 +226,9 @@ class Resource {
         let decodedBody = body;
         if (headers['content-type']?.indexOf('msgpack') > 0) {
           try {
+            if (!client._MsgPack) {
+              Utils.throwMissingModuleError('MsgPack');
+            }
             decodedBody = client._MsgPack.decode(body as Buffer);
           } catch (decodeErr) {
             Logger.logAction(

src/common/lib/client/rest.ts

@@ -113,11 +113,17 @@ export class Rest {
     customHeaders: Record<string, string>,
     callback: StandardCallback<HttpPaginatedResponse<unknown>>
   ): Promise<HttpPaginatedResponse<unknown>> | void {
-    const useBinary = this.client.options.useBinaryProtocol,
-      encoder = useBinary ? this.client._MsgPack.encode : JSON.stringify,
-      decoder = useBinary ? this.client._MsgPack.decode : JSON.parse,
-      format = useBinary ? Utils.Format.msgpack : Utils.Format.json,
-      envelope = this.client.http.supportsLinkHeaders ? undefined : format;
+    const [encoder, decoder, format] = (() => {
+      if (this.client.options.useBinaryProtocol) {
+        if (!this.client._MsgPack) {
+          Utils.throwMissingModuleError('MsgPack');
+        }
+        return [this.client._MsgPack.encode, this.client._MsgPack.decode, Utils.Format.msgpack];
+      } else {
+        return [JSON.stringify, JSON.parse, Utils.Format.json];
+      }
+    })();
+    const envelope = this.client.http.supportsLinkHeaders ? undefined : format;
     params = params || {};
     const _method = method.toLowerCase() as HttpMethods;
     const headers =

src/common/lib/types/devicedetails.ts

@@ -75,7 +75,7 @@ class DeviceDetails {
 
   static fromResponseBody(
     body: Array<Record<string, unknown>> | Record<string, unknown>,
-    MsgPack: MsgPack,
+    MsgPack: MsgPack | null,
     format?: Utils.Format
   ): DeviceDetails | DeviceDetails[] {
     if (format) {

src/common/lib/types/message.ts

@@ -336,7 +336,7 @@ class Message {
   static async fromResponseBody(
     body: Array<Message>,
     options: ChannelOptions | EncodingDecodingContext,
-    MsgPack: MsgPack,
+    MsgPack: MsgPack | null,
     format?: Utils.Format
   ): Promise<Message[]> {
     if (format) {

src/common/lib/types/presencemessage.ts

@@ -106,7 +106,7 @@ class PresenceMessage {
   static async fromResponseBody(
     body: Record<string, unknown>[],
     options: CipherOptions,
-    MsgPack: MsgPack,
+    MsgPack: MsgPack | null,
     format?: Utils.Format
   ): Promise<PresenceMessage[]> {
     const messages: PresenceMessage[] = [];

src/common/lib/types/pushchannelsubscription.ts

@@ -37,7 +37,7 @@ class PushChannelSubscription {
 
   static fromResponseBody(
     body: Array<Record<string, unknown>> | Record<string, unknown>,
-    MsgPack: MsgPack,
+    MsgPack: MsgPack | null,
     format?: Utils.Format
   ): PushChannelSubscription | PushChannelSubscription[] {
     if (format) {

src/common/lib/util/defaults.ts

@@ -5,6 +5,7 @@ import ErrorInfo from 'common/lib/types/errorinfo';
 import { version } from '../../../../package.json';
 import ClientOptions, { InternalClientOptions, NormalisedClientOptions } from 'common/types/ClientOptions';
 import IDefaults from '../../types/IDefaults';
+import { MsgPack } from 'common/types/msgpack';
 
 let agent = 'ably-js/' + version;
 
@@ -41,7 +42,7 @@ type CompleteDefaults = IDefaults & {
   checkHost(host: string): void;
   getRealtimeHost(options: ClientOptions, production: boolean, environment: string): string;
   objectifyOptions(options: ClientOptions | string): ClientOptions;
-  normaliseOptions(options: InternalClientOptions): NormalisedClientOptions;
+  normaliseOptions(options: InternalClientOptions, MsgPack: MsgPack | null): NormalisedClientOptions;
   defaultGetHeaders(options: NormalisedClientOptions, headersOptions?: HeadersOptions): Record<string, string>;
   defaultPostHeaders(options: NormalisedClientOptions, headersOptions?: HeadersOptions): Record<string, string>;
 };
@@ -185,7 +186,7 @@ export function objectifyOptions(options: ClientOptions | string): ClientOptions
   return options;
 }
 
-export function normaliseOptions(options: InternalClientOptions): NormalisedClientOptions {
+export function normaliseOptions(options: InternalClientOptions, MsgPack: MsgPack | null): NormalisedClientOptions {
   if (typeof options.recover === 'function' && options.closeOnUnload === true) {
     Logger.logAction(
       Logger.LOG_ERROR,
@@ -222,10 +223,14 @@ export function normaliseOptions(options: InternalClientOptions): NormalisedClie
 
   const timeouts = getTimeouts(options);
 
-  if ('useBinaryProtocol' in options) {
-    options.useBinaryProtocol = Platform.Config.supportsBinary && options.useBinaryProtocol;
+  if (MsgPack) {
+    if ('useBinaryProtocol' in options) {
+      options.useBinaryProtocol = Platform.Config.supportsBinary && options.useBinaryProtocol;
+    } else {
+      options.useBinaryProtocol = Platform.Config.preferBinary;
+    }
   } else {
-    options.useBinaryProtocol = Platform.Config.preferBinary;
+    options.useBinaryProtocol = false;
   }
 
   const headers: Record<string, string> = {};

src/common/lib/util/utils.ts

@@ -452,12 +452,26 @@ export function promisify<T>(ob: Record<string, any>, fnName: string, args: IArg
   });
 }
 
-export function decodeBody<T>(body: unknown, MsgPack: MsgPack, format?: Format | null): T {
-  return format == 'msgpack' ? MsgPack.decode(body as Buffer) : JSON.parse(String(body));
+export function decodeBody<T>(body: unknown, MsgPack: MsgPack | null, format?: Format | null): T {
+  if (format == 'msgpack') {
+    if (!MsgPack) {
+      throwMissingModuleError('MsgPack');
+    }
+    return MsgPack.decode(body as Buffer);
+  }
+
+  return JSON.parse(String(body));
 }
 
-export function encodeBody(body: unknown, MsgPack: MsgPack, format?: Format): string | Buffer {
-  return format == 'msgpack' ? (MsgPack.encode(body, true) as Buffer) : JSON.stringify(body);
+export function encodeBody(body: unknown, MsgPack: MsgPack | null, format?: Format): string | Buffer {
+  if (format == 'msgpack') {
+    if (!MsgPack) {
+      throwMissingModuleError('MsgPack');
+    }
+    return MsgPack.encode(body, true) as Buffer;
+  }
+
+  return JSON.stringify(body);
 }
 
 export function allToLowerCase(arr: Array<string>): Array<string> {

src/common/types/IPlatformConfig.d.ts

@@ -1,12 +1,9 @@
-import { MsgPack } from './msgpack';
-
 export interface IPlatformConfig {
   agent: string;
   logTimestamps: boolean;
   binaryType: BinaryType;
   WebSocket: typeof WebSocket | typeof import('ws');
   useProtocolHeartbeats: boolean;
-  msgpack: MsgPack;
   supportsBinary: boolean;
   preferBinary: boolean;
   nextTick: process.nextTick;

src/platform/nativescript/config.js

@@ -1,5 +1,4 @@
 /* eslint-disable no-undef */
-import msgpack from '../web/lib/util/msgpack';
 require('nativescript-websockets');
 
 var randomBytes;
@@ -28,7 +27,6 @@ var Config = {
   allowComet: true,
   streamingSupported: false,
   useProtocolHeartbeats: true,
-  msgpack: msgpack,
   supportsBinary: typeof TextDecoder !== 'undefined' && TextDecoder,
   preferBinary: false,
   ArrayBuffer: ArrayBuffer,

src/platform/nativescript/index.ts

@@ -30,6 +30,7 @@ Platform.WebStorage = WebStorage;
 
 for (const clientClass of [DefaultRest, DefaultRealtime]) {
   clientClass.Crypto = Crypto;
+  clientClass._MsgPack = msgpack;
 }
 
 Logger.initLogHandlers();

src/platform/nodejs/config.ts

@@ -10,7 +10,6 @@ const Config: IPlatformConfig = {
   binaryType: 'nodebuffer' as BinaryType,
   WebSocket,
   useProtocolHeartbeats: false,
-  msgpack: require('@ably/msgpack-js'),
   supportsBinary: true,
   preferBinary: true,
   nextTick: process.nextTick,

src/platform/nodejs/index.ts

@@ -14,6 +14,7 @@ import Transports from './lib/transport';
 import Logger from '../../common/lib/util/logger';
 import { getDefaults } from '../../common/lib/util/defaults';
 import PlatformDefaults from './lib/util/defaults';
+import msgpack = require('@ably/msgpack-js');
 
 const Crypto = createCryptoClass(BufferUtils);
 
@@ -26,6 +27,7 @@ Platform.WebStorage = null;
 
 for (const clientClass of [DefaultRest, DefaultRealtime]) {
   clientClass.Crypto = Crypto;
+  clientClass._MsgPack = msgpack;
 }
 
 Logger.initLogHandlers();

src/platform/nodejs/lib/util/http.ts

@@ -10,7 +10,7 @@ import BaseClient from 'common/lib/client/baseclient';
 import BaseRealtime from 'common/lib/client/baserealtime';
 import { NormalisedClientOptions, RestAgentOptions } from 'common/types/ClientOptions';
 import { isSuccessCode } from 'common/constants/HttpStatusCodes';
-import { shallowEquals } from 'common/lib/util/utils';
+import { shallowEquals, throwMissingModuleError } from 'common/lib/util/utils';
 
 /***************************************************
  *
@@ -42,8 +42,8 @@ const handler = function (uri: string, params: unknown, client: BaseClient | nul
           body = JSON.parse(body as string);
           break;
         case 'application/x-msgpack':
-          if (!client) {
-            throw new ErrorInfo('Cannot use MessagePack without a client', 400, 40000);
+          if (!client?._MsgPack) {
+            throwMissingModuleError('MsgPack');
           }
           body = client._MsgPack.decode(body as Buffer);
       }

src/platform/react-native/config.ts

@@ -1,4 +1,3 @@
-import msgpack from '../web/lib/util/msgpack';
 import { IPlatformConfig } from '../../common/types/IPlatformConfig';
 import BufferUtils from '../web/lib/util/bufferutils';
 
@@ -13,7 +12,6 @@ export default function (bufferUtils: typeof BufferUtils): IPlatformConfig {
     allowComet: true,
     streamingSupported: true,
     useProtocolHeartbeats: true,
-    msgpack: msgpack,
     supportsBinary: !!(typeof TextDecoder !== 'undefined' && TextDecoder),
     preferBinary: false,
     ArrayBuffer: typeof ArrayBuffer !== 'undefined' && ArrayBuffer,

src/platform/react-native/index.ts

@@ -30,6 +30,7 @@ Platform.WebStorage = WebStorage;
 
 for (const clientClass of [DefaultRest, DefaultRealtime]) {
   clientClass.Crypto = Crypto;
+  clientClass._MsgPack = msgpack;
 }
 
 Logger.initLogHandlers();

src/platform/web-noencryption/index.ts

@@ -23,6 +23,10 @@ Platform.Config = Config;
 Platform.Transports = Transports;
 Platform.WebStorage = WebStorage;
 
+for (const clientClass of [DefaultRest, DefaultRealtime]) {
+  clientClass._MsgPack = msgpack;
+}
+
 Logger.initLogHandlers();
 
 Platform.Defaults = getDefaults(PlatformDefaults);

src/platform/web/config.ts

@@ -1,4 +1,3 @@
-import msgpack from './lib/util/msgpack';
 import { IPlatformConfig } from '../../common/types/IPlatformConfig';
 import * as Utils from 'common/lib/util/utils';
 
@@ -37,7 +36,6 @@ const Config: IPlatformConfig = {
   allowComet: allowComet(),
   streamingSupported: true,
   useProtocolHeartbeats: true,
-  msgpack: msgpack,
   supportsBinary: !!globalObject.TextDecoder,
   preferBinary: false,
   ArrayBuffer: globalObject.ArrayBuffer,

src/platform/web/index.ts

@@ -28,6 +28,7 @@ Platform.WebStorage = WebStorage;
 
 for (const clientClass of [DefaultRest, DefaultRealtime]) {
   clientClass.Crypto = Crypto;
+  clientClass._MsgPack = msgpack;
 }
 
 Logger.initLogHandlers();

src/platform/web/modules.ts

@@ -40,5 +40,6 @@ if (Platform.Config.noUpgrade) {
 
 export * from './modules/crypto';
 export * from './modules/message';
+export * from './modules/msgpack';
 export { Rest } from '../../common/lib/client/rest';
 export { BaseRest, BaseRealtime };