fix: isolate batch requests per actor scope

Two actor scopes reusing a batch name shared the module-level pending and active maps, so their same-revision requests merged into one call the server rejects for mixing actors, and overlapping requests aborted each other. Key both maps by scope and batch. Also expose the batch keyword in the generated RBS signatures, which the annotations had omitted, and pin the new JavaScript job's actions to commit SHAs now that the release job depends on it.

Author: cardmagic

.github/workflows/ci.yml

@@ -19,8 +19,8 @@ jobs:
   javascript:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v7
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: "22"
       - run: npm ci

app/assets/javascripts/solid_objects/component_batch_refresh.js

@@ -16,9 +16,13 @@ class SolidObjectsBatchRefreshElement extends HTMLElement {
     const batch = this.dataset.batch
     const revision = this.dataset.revision
     const source = this.dataset.source
-    if (!batch || !revision || !source) return this.remove()
+    const scope = this.closest("[id]")?.id
+    if (!batch || !revision || !source || !scope) return this.remove()
 
-    const key = `${batch}:${revision}`
+    // Two actor scopes may reuse a batch name on one page. Keying by scope
+    // keeps their requests from merging or cancelling each other.
+    const group = `${scope}:${batch}`
+    const key = `${group}:${revision}`
     const pending = pendingBatches.get(key)
     if (pending) {
       pending.sources.add(source)
@@ -30,18 +34,18 @@ class SolidObjectsBatchRefreshElement extends HTMLElement {
     pendingBatches.set(key, merged)
     queueMicrotask(() => {
       pendingBatches.delete(key)
-      requestBatch(batch, revision, merged.sources)
+      requestBatch(group, batch, merged.sources)
     })
     this.remove()
   }
 }
 
-async function requestBatch(batch, revision, sources) {
-  const previous = activeBatches.get(batch)
+async function requestBatch(group, batch, sources) {
+  const previous = activeBatches.get(group)
   previous?.abort()
 
   const controller = new AbortController()
-  activeBatches.set(batch, controller)
+  activeBatches.set(group, controller)
 
   try {
     const url = mergedUrl(sources)
@@ -64,7 +68,7 @@ async function requestBatch(batch, revision, sources) {
   } catch (error) {
     if (error.name !== "AbortError") dispatchBatchError(batch, "request_failed")
   } finally {
-    if (activeBatches.get(batch) === controller) activeBatches.delete(batch)
+    if (activeBatches.get(group) === controller) activeBatches.delete(group)
   }
 }
 

lib/solid_objects/component_registration.rb

@@ -28,7 +28,7 @@ class ComponentRegistration
       :refresh_path,
       :token
 
-    # @rbs (reference: Reference, component_name: String, component_key: String | Integer?, dependencies: Array[String], locals: Hash[String, untyped], refresh_method: String, instance_id: Integer, revision: Integer, refresh_path: String, token: String) -> void
+    # @rbs (reference: Reference, component_name: String, component_key: String | Integer?, dependencies: Array[String], locals: Hash[String, untyped], refresh_method: String, instance_id: Integer, revision: Integer, refresh_path: String, token: String, ?batch: String?) -> void
     def initialize(
       reference:,
       component_name:,
@@ -56,7 +56,7 @@ def initialize(
     end
 
     class << self
-      # @rbs (reference: Reference, component_name: String, component_key: untyped, dependencies: Array[String], locals: Hash[untyped, untyped], refresh_method: String | Symbol, snapshot: ActorSnapshot, refresh_path: String) -> ComponentRegistration
+      # @rbs (reference: Reference, component_name: String, component_key: untyped, dependencies: Array[String], locals: Hash[untyped, untyped], refresh_method: String | Symbol, snapshot: ActorSnapshot, refresh_path: String, ?batch: String?) -> ComponentRegistration
       def issue(
         reference:,
         component_name:,

lib/solid_objects/component_token.rb

@@ -20,7 +20,7 @@ module ComponentToken
 
     module_function
 
-    # @rbs (reference: Reference, component_name: String, dependencies: Array[String], instance_id: Integer, revision: Integer, refresh_path: String, ?component_key: untyped, ?locals: Hash[untyped, untyped], ?refresh_method: String | Symbol) -> String
+    # @rbs (reference: Reference, component_name: String, dependencies: Array[String], instance_id: Integer, revision: Integer, refresh_path: String, ?component_key: untyped, ?locals: Hash[untyped, untyped], ?refresh_method: String | Symbol, ?batch: untyped) -> String
     def generate(
       reference:,
       component_name:,

sig/generated/lib/solid_objects/component_registration.rbs

@@ -46,11 +46,11 @@ module SolidObjects
 
     attr_reader token: untyped
 
-    # @rbs (reference: Reference, component_name: String, component_key: String | Integer?, dependencies: Array[String], locals: Hash[String, untyped], refresh_method: String, instance_id: Integer, revision: Integer, refresh_path: String, token: String) -> void
-    def initialize: (reference: Reference, component_name: String, component_key: String | Integer?, dependencies: Array[String], locals: Hash[String, untyped], refresh_method: String, instance_id: Integer, revision: Integer, refresh_path: String, token: String) -> void
+    # @rbs (reference: Reference, component_name: String, component_key: String | Integer?, dependencies: Array[String], locals: Hash[String, untyped], refresh_method: String, instance_id: Integer, revision: Integer, refresh_path: String, token: String, ?batch: String?) -> void
+    def initialize: (reference: Reference, component_name: String, component_key: String | Integer?, dependencies: Array[String], locals: Hash[String, untyped], refresh_method: String, instance_id: Integer, revision: Integer, refresh_path: String, token: String, ?batch: String?) -> void
 
-    # @rbs (reference: Reference, component_name: String, component_key: untyped, dependencies: Array[String], locals: Hash[untyped, untyped], refresh_method: String | Symbol, snapshot: ActorSnapshot, refresh_path: String) -> ComponentRegistration
-    def self.issue: (reference: Reference, component_name: String, component_key: untyped, dependencies: Array[String], locals: Hash[untyped, untyped], refresh_method: String | Symbol, snapshot: ActorSnapshot, refresh_path: String) -> ComponentRegistration
+    # @rbs (reference: Reference, component_name: String, component_key: untyped, dependencies: Array[String], locals: Hash[untyped, untyped], refresh_method: String | Symbol, snapshot: ActorSnapshot, refresh_path: String, ?batch: String?) -> ComponentRegistration
+    def self.issue: (reference: Reference, component_name: String, component_key: untyped, dependencies: Array[String], locals: Hash[untyped, untyped], refresh_method: String | Symbol, snapshot: ActorSnapshot, refresh_path: String, ?batch: String?) -> ComponentRegistration
 
     # @rbs (String) -> ComponentRegistration
     def self.from_token: (String) -> ComponentRegistration

sig/generated/lib/solid_objects/component_token.rbs

@@ -20,8 +20,8 @@ module SolidObjects
 
     RUBY_KEYWORDS: untyped
 
-    # @rbs (reference: Reference, component_name: String, dependencies: Array[String], instance_id: Integer, revision: Integer, refresh_path: String, ?component_key: untyped, ?locals: Hash[untyped, untyped], ?refresh_method: String | Symbol) -> String
-    def self?.generate: (reference: Reference, component_name: String, dependencies: Array[String], instance_id: Integer, revision: Integer, refresh_path: String, ?component_key: untyped, ?locals: Hash[untyped, untyped], ?refresh_method: String | Symbol) -> String
+    # @rbs (reference: Reference, component_name: String, dependencies: Array[String], instance_id: Integer, revision: Integer, refresh_path: String, ?component_key: untyped, ?locals: Hash[untyped, untyped], ?refresh_method: String | Symbol, ?batch: untyped) -> String
+    def self?.generate: (reference: Reference, component_name: String, dependencies: Array[String], instance_id: Integer, revision: Integer, refresh_path: String, ?component_key: untyped, ?locals: Hash[untyped, untyped], ?refresh_method: String | Symbol, ?batch: untyped) -> String
 
     # @rbs (String) -> Hash[String, untyped]
     def self?.verify: (String) -> Hash[String, untyped]

test/javascript/component_batch_refresh.test.mjs

@@ -6,6 +6,8 @@ const ENDPOINT = "/solid_objects/components/batch"
 
 let requests
 let responder
+let defaultScope
+let scopeCount = 0
 
 before(async () => {
   const dom = openDocument()
@@ -23,6 +25,7 @@ beforeEach(() => {
   document.querySelectorAll("turbo-stream").forEach((stream) => stream.remove())
   requests = []
   responder = async () => jsonResponse({ frames: [] })
+  defaultScope = scopeNamed(`solid-objects-scope-${(scopeCount += 1)}`)
 })
 
 function jsonResponse(body, { ok = true, status = 200 } = {}) {
@@ -46,14 +49,21 @@ function addTarget(target, revision) {
   return frame
 }
 
-function notify({ batch, revision, targets, tokens }) {
+function scopeNamed(id) {
+  const scope = document.createElement("div")
+  scope.id = id
+  document.body.append(scope)
+  return scope
+}
+
+function notify({ batch, revision, targets, tokens, scope }) {
   const element = document.createElement("solid-objects-batch-refresh")
   element.dataset.batch = batch
   element.dataset.revision = revision
   element.dataset.targets = targets.join(" ")
   const query = tokens.map((token) => `tokens[]=${token}`).join("&")
   element.dataset.source = `${ENDPOINT}?instance_id=1&revision=9&${query}`
-  document.body.append(element)
+  ;(scope ?? defaultScope).append(element)
   return element
 }
 
@@ -169,3 +179,34 @@ test("the notification element removes itself", async () => {
 
   assert.equal(element.isConnected, false)
 })
+
+test("two scopes sharing a batch name do not merge requests", async () => {
+  const first = scopeNamed("solid-objects-scope-table-1")
+  const second = scopeNamed("solid-objects-scope-table-2")
+  notify({ batch: "playmat", revision: "1:9", targets: [ "a" ], tokens: [ "t1" ], scope: first })
+  notify({ batch: "playmat", revision: "1:9", targets: [ "b" ], tokens: [ "t2" ], scope: second })
+  await nextTick()
+
+  assert.equal(requests.length, 2)
+  const tokens = requests.map(
+    (request) => new URL(request, "https://example.test/").searchParams.getAll("tokens[]")
+  )
+  assert.deepEqual(tokens, [ [ "t1" ], [ "t2" ] ])
+})
+
+test("one scope does not abort another scope's request", async () => {
+  const first = scopeNamed("solid-objects-scope-table-3")
+  const second = scopeNamed("solid-objects-scope-table-4")
+  const aborted = []
+  responder = async (url) => {
+    await new Promise((resolve) => setTimeout(resolve, 5))
+    return jsonResponse({ frames: [] })
+  }
+  notify({ batch: "playmat", revision: "1:9", targets: [ "a" ], tokens: [ "t1" ], scope: first })
+  await nextTick()
+  notify({ batch: "playmat", revision: "1:10", targets: [ "b" ], tokens: [ "t2" ], scope: second })
+  await new Promise((resolve) => setTimeout(resolve, 20))
+
+  assert.equal(requests.length, 2)
+  assert.deepEqual(aborted, [])
+})