feat(tree-shaking): add environment flags to disable modules

Add environment flags processing to opt-out feature modules from built bundles.
pubnub · May 17, 2024 · 6e7d05f · 6e7d05f
1 parent 5607747
commit 6e7d05f
Show file tree

Hide file tree

Showing 24 changed files with 1,934 additions and 1,349 deletions.
diff --git a/dist/web/pubnub.js b/dist/web/pubnub.js
diff --git a/dist/web/pubnub.min.js b/dist/web/pubnub.min.js
diff --git a/lib/core/pubnub-common.js b/lib/core/pubnub-common.js
diff --git a/lib/entities/Channel.js b/lib/entities/Channel.js
@@ -9,13 +9,17 @@ class Channel {
         this.name = channelName;
     }
     subscription(subscriptionOptions) {
-        return new Subscription_1.Subscription({
-            channels: (subscriptionOptions === null || subscriptionOptions === void 0 ? void 0 : subscriptionOptions.receivePresenceEvents) ? [this.name, `${this.name}-pnpres`] : [this.name],
-            channelGroups: [],
-            subscriptionOptions: subscriptionOptions,
-            eventEmitter: this.eventEmitter,
-            pubnub: this.pubnub,
-        });
+        if (process.env.SUBSCRIBE_MODULE !== 'disabled') {
+            return new Subscription_1.Subscription({
+                channels: (subscriptionOptions === null || subscriptionOptions === void 0 ? void 0 : subscriptionOptions.receivePresenceEvents) ? [this.name, `${this.name}-pnpres`] : [this.name],
+                channelGroups: [],
+                subscriptionOptions: subscriptionOptions,
+                eventEmitter: this.eventEmitter,
+                pubnub: this.pubnub,
+            });
+        }
+        else
+            throw new Error('Subscription error: subscription module disabled');
     }
 }
 exports.Channel = Channel;
diff --git a/lib/entities/ChannelGroup.js b/lib/entities/ChannelGroup.js
@@ -9,13 +9,17 @@ class ChannelGroup {
         this.name = channelGroup;
     }
     subscription(subscriptionOptions) {
-        return new Subscription_1.Subscription({
-            channels: [],
-            channelGroups: (subscriptionOptions === null || subscriptionOptions === void 0 ? void 0 : subscriptionOptions.receivePresenceEvents) ? [this.name, `${this.name}-pnpres`] : [this.name],
-            subscriptionOptions: subscriptionOptions,
-            eventEmitter: this.eventEmitter,
-            pubnub: this.pubnub,
-        });
+        if (process.env.SUBSCRIBE_MODULE !== 'disabled') {
+            return new Subscription_1.Subscription({
+                channels: [],
+                channelGroups: (subscriptionOptions === null || subscriptionOptions === void 0 ? void 0 : subscriptionOptions.receivePresenceEvents) ? [this.name, `${this.name}-pnpres`] : [this.name],
+                subscriptionOptions: subscriptionOptions,
+                eventEmitter: this.eventEmitter,
+                pubnub: this.pubnub,
+            });
+        }
+        else
+            throw new Error('Subscription error: subscription module disabled');
     }
 }
 exports.ChannelGroup = ChannelGroup;
diff --git a/lib/entities/ChannelMetadata.js b/lib/entities/ChannelMetadata.js
@@ -9,13 +9,17 @@ class ChannelMetadata {
         this.pubnub = pubnub;
     }
     subscription(subscriptionOptions) {
-        return new Subscription_1.Subscription({
-            channels: [this.id],
-            channelGroups: [],
-            subscriptionOptions: subscriptionOptions,
-            eventEmitter: this.eventEmitter,
-            pubnub: this.pubnub,
-        });
+        if (process.env.SUBSCRIBE_MODULE !== 'disabled') {
+            return new Subscription_1.Subscription({
+                channels: [this.id],
+                channelGroups: [],
+                subscriptionOptions: subscriptionOptions,
+                eventEmitter: this.eventEmitter,
+                pubnub: this.pubnub,
+            });
+        }
+        else
+            throw new Error('Subscription error: subscription module disabled');
     }
 }
 exports.ChannelMetadata = ChannelMetadata;
diff --git a/lib/entities/UserMetadata.js b/lib/entities/UserMetadata.js
@@ -9,13 +9,17 @@ class UserMetadata {
         this.pubnub = pubnub;
     }
     subscription(subscriptionOptions) {
-        return new Subscription_1.Subscription({
-            channels: [this.id],
-            channelGroups: [],
-            subscriptionOptions: subscriptionOptions,
-            eventEmitter: this.eventEmitter,
-            pubnub: this.pubnub,
-        });
+        if (process.env.SUBSCRIBE_MODULE !== 'disabled') {
+            return new Subscription_1.Subscription({
+                channels: [this.id],
+                channelGroups: [],
+                subscriptionOptions: subscriptionOptions,
+                eventEmitter: this.eventEmitter,
+                pubnub: this.pubnub,
+            });
+        }
+        else
+            throw new Error('Subscription error: subscription module disabled');
     }
 }
 exports.UserMetadata = UserMetadata;
diff --git a/lib/node/index.js b/lib/node/index.js
@@ -23,38 +23,53 @@ const common_1 = __importDefault(require("../cbor/common"));
 class PubNub extends pubnub_common_1.PubNubCore {
     constructor(configuration) {
         const configurationCopy = (0, configuration_2.setDefaults)(configuration);
-        const platformConfiguration = Object.assign(Object.assign({}, configurationCopy), { sdkFamily: 'Nodejs', PubNubFile: node_1.default });
+        const platformConfiguration = Object.assign(Object.assign({}, configurationCopy), { sdkFamily: 'Nodejs' });
+        if (process.env.FILE_SHARING_MODULE !== 'disabled')
+            platformConfiguration.PubNubFile = node_1.default;
         // Prepare full client configuration.
         const clientConfiguration = (0, configuration_1.makeConfiguration)(platformConfiguration, (cryptoConfiguration) => {
             if (!cryptoConfiguration.cipherKey)
                 return undefined;
-            return new nodeCryptoModule_1.CryptoModule({
-                default: new nodeCryptoModule_1.LegacyCryptor(Object.assign({}, cryptoConfiguration)),
-                cryptors: [new nodeCryptoModule_1.AesCbcCryptor({ cipherKey: cryptoConfiguration.cipherKey })],
-            });
+            if (process.env.CRYPTO_MODULE !== 'disabled') {
+                return new nodeCryptoModule_1.CryptoModule({
+                    default: new nodeCryptoModule_1.LegacyCryptor(Object.assign({}, cryptoConfiguration)),
+                    cryptors: [new nodeCryptoModule_1.AesCbcCryptor({ cipherKey: cryptoConfiguration.cipherKey })],
+                });
+            }
+            else
+                return undefined;
         });
         // Prepare Token manager.
-        const tokenManager = new token_manager_1.TokenManager(new common_1.default((buffer) => cbor_sync_1.default.decode(buffer_1.Buffer.from(buffer)), base64_codec_1.decode));
+        let tokenManager;
+        if (process.env.CRYPTO_MODULE !== 'disabled') {
+            tokenManager = new token_manager_1.TokenManager(new common_1.default((buffer) => cbor_sync_1.default.decode(buffer_1.Buffer.from(buffer)), base64_codec_1.decode));
+        }
         // Legacy crypto (legacy data encryption / decryption and request signature support).
-        const crypto = new cryptography_1.default({
-            secretKey: clientConfiguration.secretKey,
-            cipherKey: clientConfiguration.getCipherKey(),
-            useRandomIVs: clientConfiguration.getUseRandomIVs(),
-            customEncrypt: clientConfiguration.getCustomEncrypt(),
-            customDecrypt: clientConfiguration.getCustomDecrypt(),
-        });
+        let crypto;
+        if (process.env.CRYPTO_MODULE !== 'disabled') {
+            crypto = new cryptography_1.default({
+                secretKey: clientConfiguration.secretKey,
+                cipherKey: clientConfiguration.getCipherKey(),
+                useRandomIVs: clientConfiguration.getUseRandomIVs(),
+                customEncrypt: clientConfiguration.getCustomEncrypt(),
+                customDecrypt: clientConfiguration.getCustomDecrypt(),
+            });
+        }
+        let cryptography;
+        if (process.env.CRYPTO_MODULE !== 'disabled')
+            cryptography = new node_2.default();
         // Setup transport provider.
         const transport = new node_transport_1.NodeTransport(configuration.keepAlive, configuration.keepAliveSettings);
         const transportMiddleware = new middleware_1.PubNubMiddleware({
             clientConfiguration,
             tokenManager,
             transport,
-            shaHMAC: crypto === null || crypto === void 0 ? void 0 : crypto.HMACSHA256.bind(crypto),
+            shaHMAC: process.env.CRYPTO_MODULE !== 'disabled' ? crypto === null || crypto === void 0 ? void 0 : crypto.HMACSHA256.bind(crypto) : undefined,
         });
         super({
             configuration: clientConfiguration,
             transport: transportMiddleware,
-            cryptography: new node_2.default(),
+            cryptography,
             tokenManager,
             crypto,
         });
@@ -83,5 +98,6 @@ class PubNub extends pubnub_common_1.PubNubCore {
 /**
  * Data encryption / decryption module constructor.
  */
-PubNub.CryptoModule = nodeCryptoModule_1.CryptoModule;
+// @ts-expect-error Allowed to simplify interface when module can be disabled.
+PubNub.CryptoModule = process.env.CRYPTO_MODULE !== 'disabled' ? nodeCryptoModule_1.CryptoModule : undefined;
 module.exports = PubNub;
diff --git a/lib/react_native/index.js b/lib/react_native/index.js
@@ -28,21 +28,28 @@ global.Buffer = global.Buffer || buffer_1.Buffer;
 class PubNub extends pubnub_common_1.PubNubCore {
     constructor(configuration) {
         const configurationCopy = (0, configuration_2.setDefaults)(configuration);
-        const platformConfiguration = Object.assign(Object.assign({}, configurationCopy), { sdkFamily: 'ReactNative', PubNubFile: react_native_1.default });
+        const platformConfiguration = Object.assign(Object.assign({}, configurationCopy), { sdkFamily: 'ReactNative' });
+        if (process.env.FILE_SHARING_MODULE !== 'disabled')
+            platformConfiguration.PubNubFile = react_native_1.default;
         // Prepare full client configuration.
         const clientConfiguration = (0, configuration_1.makeConfiguration)(platformConfiguration);
         // Prepare Token manager.
-        const tokenManager = new token_manager_1.TokenManager(new common_1.default((arrayBuffer) => (0, stringify_buffer_keys_1.stringifyBufferKeys)(cbor_js_1.default.decode(arrayBuffer)), base64_codec_1.decode));
+        let tokenManager;
+        if (process.env.CRYPTO_MODULE !== 'disabled') {
+            tokenManager = new token_manager_1.TokenManager(new common_1.default((arrayBuffer) => (0, stringify_buffer_keys_1.stringifyBufferKeys)(cbor_js_1.default.decode(arrayBuffer)), base64_codec_1.decode));
+        }
         // Legacy crypto (legacy data encryption / decryption and request signature support).
         let crypto;
-        if (clientConfiguration.getCipherKey() || clientConfiguration.secretKey) {
-            crypto = new cryptography_1.default({
-                secretKey: clientConfiguration.secretKey,
-                cipherKey: clientConfiguration.getCipherKey(),
-                useRandomIVs: clientConfiguration.getUseRandomIVs(),
-                customEncrypt: clientConfiguration.getCustomEncrypt(),
-                customDecrypt: clientConfiguration.getCustomDecrypt(),
-            });
+        if (process.env.CRYPTO_MODULE !== 'disabled') {
+            if (clientConfiguration.getCipherKey() || clientConfiguration.secretKey) {
+                crypto = new cryptography_1.default({
+                    secretKey: clientConfiguration.secretKey,
+                    cipherKey: clientConfiguration.getCipherKey(),
+                    useRandomIVs: clientConfiguration.getUseRandomIVs(),
+                    customEncrypt: clientConfiguration.getCustomEncrypt(),
+                    customDecrypt: clientConfiguration.getCustomDecrypt(),
+                });
+            }
         }
         // Setup transport layer.
         const transportMiddleware = new middleware_1.PubNubMiddleware({

diff --git a/lib/transport/middleware.js b/lib/transport/middleware.js
@@ -96,7 +96,7 @@ class PubNubMiddleware {
         if (req.path.startsWith('/v2/auth/') || req.path.startsWith('/v3/pam/') || req.path.startsWith('/time'))
             return;
         const { clientConfiguration, tokenManager } = this.configuration;
-        const accessKey = (_a = tokenManager.getToken()) !== null && _a !== void 0 ? _a : clientConfiguration.authKey;
+        const accessKey = (_a = (tokenManager && tokenManager.getToken())) !== null && _a !== void 0 ? _a : clientConfiguration.authKey;
         if (accessKey)
             req.queryParameters['auth'] = accessKey;
     }

diff --git a/lib/types/core/pubnub-common.d.ts b/lib/types/core/pubnub-common.d.ts
@@ -41,7 +41,7 @@ type ClientInstanceConfiguration<CryptographyTypes> = {
     /**
      * REST API endpoints access tokens manager.
      */
-    tokenManager: TokenManager;
+    tokenManager?: TokenManager;
     /**
      * Legacy crypto module implementation.
      */

diff --git a/lib/types/node/index.d.ts b/lib/types/node/index.d.ts
@@ -3,7 +3,7 @@
 import { ProxyAgentOptions } from 'proxy-agent';
 import { Readable } from 'stream';
 import { Buffer } from 'buffer';
-import { CryptoModule } from '../crypto/modules/NodeCryptoModule/nodeCryptoModule';
+import type { CryptoModule as CryptoModuleType } from '../crypto/modules/NodeCryptoModule/nodeCryptoModule';
 import PubNubFile, { PubNubFileParameters } from '../file/modules/node';
 import { PubNubConfiguration } from './configuration';
 import { PubNubFileConstructor } from '../core/types/file';
@@ -15,7 +15,7 @@ declare class PubNub extends PubNubCore<string | ArrayBuffer | Buffer | Readable
     /**
      * Data encryption / decryption module constructor.
      */
-    static CryptoModule: typeof CryptoModule;
+    static CryptoModule: typeof CryptoModuleType;
     /**
      * PubNub File constructor.
      */

diff --git a/lib/types/transport/middleware.d.ts b/lib/types/transport/middleware.d.ts
@@ -13,7 +13,7 @@ type PubNubMiddlewareConfiguration = {
     /**
      * REST API endpoints access tokens manager.
      */
-    tokenManager: TokenManager;
+    tokenManager?: TokenManager;
     /**
      * HMAC-SHA256 hash generator from provided `data`.
      */