Merge pull request #5109 from rmosolgo/relay-action-cable-unsubscribe…

…-once Make sure ActionCableHandler only unsubscribes once
rmosolgo · Nov 5, 2024 · 9ab852f · 9ab852f
2 parents f788527 + f27004a
commit 9ab852f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/javascript_client/src/subscriptions/__tests__/createActionCableHandlerTest.ts b/javascript_client/src/subscriptions/__tests__/createActionCableHandlerTest.ts
@@ -3,10 +3,10 @@ import type { Consumer } from "@rails/actioncable"
 
 describe("createActionCableHandler", () => {
   it("returns a function producing a disposable subscription", () => {
-    var wasDisposed = false
+    var wasDisposedCount = 0
 
     var subscription = {
-      unsubscribe: () => (wasDisposed = true)
+      unsubscribe: () => (wasDisposedCount += 1)
     }
     var dummyActionCableConsumer = {
       subscriptions: {
@@ -18,9 +18,12 @@ describe("createActionCableHandler", () => {
       cable: (dummyActionCableConsumer as unknown) as Consumer
     }
     var producer = createActionCableHandler(options)
-    producer({text: "", name: ""}, {}, {}, { onError: () => {}, onNext: () => {}, onCompleted: () => {} }).dispose()
+    var relaySubscription = producer({text: "", name: ""}, {}, {}, { onError: () => {}, onNext: () => {}, onCompleted: () => {} })
 
-    expect(wasDisposed).toEqual(true)
+    relaySubscription.dispose()
+    relaySubscription.dispose()
+
+    expect(wasDisposedCount).toEqual(1)
   })
 
   it("uses a provided clientName and operation.id", () => {

diff --git a/javascript_client/src/subscriptions/createActionCableHandler.ts b/javascript_client/src/subscriptions/createActionCableHandler.ts
@@ -20,6 +20,7 @@ function createActionCableHandler(options: ActionCableHandlerOptions) {
     var channelId = Math.round(Date.now() + Math.random() * 100000).toString(16)
     var cable = options.cable
     var operations = options.operations
+    var subscribed = true
 
     // Register the subscription by subscribing to the channel
     const channel = cable.subscriptions.create({
@@ -66,7 +67,10 @@ function createActionCableHandler(options: ActionCableHandlerOptions) {
     // Return an object for Relay to unsubscribe with
     return {
       dispose: function() {
-        channel.unsubscribe()
+        if (subscribed) {
+          subscribed = false
+          channel.unsubscribe()
+        }
       }
     }
   }