feature: cleanup SDK on navigation event

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pubnub",
-  "version": "8.3.1",
+  "version": "8.3.2",
   "author": "PubNub <[email protected]>",
   "description": "Publish & Subscribe Real-time Messaging with PubNub",
   "scripts": {

src/web/components/configuration.ts

@@ -18,6 +18,12 @@ import { ICryptoModule } from '../../core/interfaces/crypto-module';
  */
 const LISTEN_TO_BROWSER_NETWORK_EVENTS = true;
 
+/**
+ * If set to `true`, SDK will attempt to destroy itself when the browser begins navigation via the beforeunload event.
+ * Fixes issues with Safari memory leaks when refreshing, or navigating away and returning with the browser back button.
+ */
+const CLEANUP_ON_BROWSER_NAVIGATION = false;
+
 /**
  * Whether verbose logging should be enabled for `Subscription` worker to print debug messages or not.
  */
@@ -42,6 +48,16 @@ export type PubNubConfiguration = UserConfiguration & {
    */
   listenToBrowserNetworkEvents?: boolean;
 
+  /**
+   * If set to `true`, SDK will attempt to destroy itself when the browser begins navigation via the
+   * beforeunload event.
+   *
+   * This fixes issues with Safari memory leaks when refreshing, or navigating away and returning with the back button.
+   *
+   * @default `false`
+   */
+  cleanupOnNavigationEvent?: boolean;
+
   /**
    * Path to the hosted PubNub `Subscription` service worker.
    *
@@ -116,6 +132,7 @@ export const setDefaults = (configuration: PubNubConfiguration): PubNubConfigura
     ...setBaseDefaults(configuration),
     // Set platform-specific options.
     listenToBrowserNetworkEvents: configuration.listenToBrowserNetworkEvents ?? LISTEN_TO_BROWSER_NETWORK_EVENTS,
+    cleanupOnNavigationEvent: configuration.cleanupOnNavigationEvent ?? CLEANUP_ON_BROWSER_NAVIGATION,
     subscriptionWorkerUrl: configuration.subscriptionWorkerUrl,
     subscriptionWorkerLogVerbosity: configuration.subscriptionWorkerLogVerbosity ?? SUBSCRIPTION_WORKER_LOG_VERBOSITY,
     keepAlive: configuration.keepAlive ?? KEEP_ALIVE,

src/web/index.ts

@@ -136,6 +136,12 @@ export default class PubNub extends PubNubCore<ArrayBuffer | string, PubNubFileP
         this.networkUpDetected();
       });
     }
+
+    if (configuration.cleanupOnNavigationEvent ?? false) {
+      window.addEventListener('beforeunload', () => {
+        this.destroy(true);
+      });
+    }
   }
 
   private networkDownDetected() {