blitz-rpc: Cleanup Method for Event Listeners (#4173)

* feat: logic to cleanup potential memory leak

* styling: add space

* Create poor-crabs-drum.md

.changeset/poor-crabs-drum.md

@@ -0,0 +1,5 @@
+---
+"blitz": patch
+---
+
+blitz-rpc: Cleanup Event Listeners - Fix potential memory leak by cleaning up any residual event listeners set by blitz.

packages/blitz/src/global.ts

@@ -5,4 +5,5 @@ declare global {
     beforeHttpRequest: BeforeHttpRequest
     beforeHttpResponse: BeforeHttpResponse
   }
+  var __BLITZ_CLEAN_UP_LISTENERS: () => void
 }

packages/blitz/src/plugin.ts

@@ -89,13 +89,23 @@ export function reduceBlitzClientPlugins<TPlugins extends readonly ClientPlugin<
   globalThis.__BLITZ_MIDDLEWARE_HOOKS = middleware
 
   if (isClient) {
-    document.addEventListener("blitz:session-created", async () => {
+    if (globalThis.__BLITZ_CLEAN_UP_LISTENERS) {
+      globalThis.__BLITZ_CLEAN_UP_LISTENERS()
+    }
+    const onSessionCreated = async () => {
       await Promise.all(events.onSessionCreated())
-    })
-    document.addEventListener("blitz:rpc-error", async (e) => {
+    }
+    const onRpcError = async (e: Event): Promise<void> => {
       const customEvent = e as CustomEvent<Error>
       await Promise.all(events.onRpcError(customEvent.detail))
-    })
+    }
+    document.addEventListener("blitz:session-created", onSessionCreated)
+    document.addEventListener("blitz:rpc-error", onRpcError)
+
+    globalThis.__BLITZ_CLEAN_UP_LISTENERS = () => {
+      document.removeEventListener("blitz:session-created", onSessionCreated)
+      document.removeEventListener("blitz:rpc-error", onRpcError)
+    }
   }
 
   const withPlugins = compose(...providers)