dexiecable 2.0.0.alpha1 → 2.0.0.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5262c05d144bc7c002152fd8da1918e87421f4ec81a060100b71c57237c152be
-  data.tar.gz: 339cf7b68cd9923b0b20b4a74c0caf563699be7ff8fbaf32ace71728a87fc787
+  metadata.gz: 714562cd7c933eb48e81e9159acd326d77b6133a807cdd541000f350281c1c94
+  data.tar.gz: d3bcacdc18d5f9c7a8be970f9ede859be19e282e8ca35aa4d27c81e581310eb3
 SHA512:
-  metadata.gz: e315b48c4d222dd5c4fb04056dded3f61d9d76584dfc7ee02d1645b6d28521120130b945cda897ca6682b7d6483232a3f6b92a3220bc417dc9fb6d8718169416
-  data.tar.gz: a5c155688bd21d6970842b86f28d2f9e4d901561fb5e786a59ed3447ae7b96db083d5b63e1d724b7fc8c5b7c2428661d713b00a5dc41a5c5b0f2a0f62ca568cc
+  metadata.gz: ed0dbe4fdfade70f3300d9c2a61882f6a00320c384fe74ad76b6ba11ef0733a26b86f6949606117b4847efdd5221709bf1a091088a510a0155d6ff9f48a87774
+  data.tar.gz: d5cef46c7417c0e34ff4e08c08e0df846ff653f19ae0eeacbffe9de433a362c9ae9af60b32f669a6daa301b64a05d3844f227587cf20af4da23ecf149b39cfb9

data/README.md

@@ -85,7 +85,7 @@ For an ActiveRecord model it signs the record's GlobalID:
 
 ```ruby
 DexieChannel.stream_token_for(current_user)
-# => "eyJkYXRhIjoiZGV4aWVfY2FibGU6ZGV4aWVfY2hhbm5lbDpnaWQ6Ly9hcHAvVXNlci8xIn0=--signature"
+# => "signed token for gid://app/User/1"
 ```
 
 Send that token to the client (render it in a view, return it from an endpoint, etc.) and add it to the subscription:
@@ -107,6 +107,24 @@ subscription.removeStream(userStream);
 subscription.removeAllStreams();
 ```
 
+#### Initial data on subscribe
+
+To push a snapshot when a stream is added, set `DexieChannel.on_subscribe`. It receives the channel and the subscribed record (resolved from the signed GlobalID), so you can dispatch on the record type:
+
+```ruby
+# config/initializers/dexiecable.rb
+DexieChannel.on_subscribe = ->(channel, record) do
+  case record
+  when User
+    channel.table("notifications").bulkAdd(record.notifications.map(&:as_json_for_dexie))
+  when Conversation
+    channel.table("messages").bulkAdd(record.messages.map(&:as_json_for_dexie))
+  end
+end
+```
+
+The callback runs after the stream is opened, and `channel.table(...)` transmits to just this subscriber — so the snapshot arrives before any live mutation.
+
 #### Public streams
 
 For data that's public (a global feed, announcements, etc.), skip the signature. Use a string target — it's namespaced under `public:` automatically:

data/lib/dexiecable/dexie_channel.rb

@@ -13,9 +13,23 @@ module DexieCable
   #   # public (no signature, namespaced under "public:")
   #   subscription.addPublicStream("feed")
   #
+  # When a private stream is added, +on_subscribe+ is invoked with the
+  # channel and the subscribed record, so initial data can be pushed:
+  #
+  #   DexieChannel.on_subscribe = ->(channel, record) do
+  #     case record
+  #     when User
+  #       channel.table("notifications").bulkAdd(record.notifications.map(&:as_json_for_dexie))
+  #     when Conversation
+  #       channel.table("messages").bulkAdd(record.messages.map(&:as_json_for_dexie))
+  #     end
+  #   end
+  #
   class DexieChannel < ActionCable::Channel::Base
     PUBLIC_STREAM_PREFIX = "public:"
 
+    class_attribute :on_subscribe, instance_accessor: false, default: nil
+
     public :transmit
 
     # Open a scoped channel for broadcasting to a specific recipient.
@@ -40,11 +54,11 @@ module DexieCable
       Query.new(self, name)
     end
 
-    # Returns a signed token for the stream identifier of +target+ (private
-    # record-based streams). Send it to the client, which passes it to
+    # Returns a signed token for +target+ (a record or other private
+    # target). Send it to the client, which passes it to
     # +subscription.addStream+.
     def self.stream_token_for(target)
-      verifier.generate(broadcasting_for(target))
+      verifier.generate(target.respond_to?(:to_gid_param) ? target.to_gid_param : target.to_s)
     end
 
     def self.verifier
@@ -56,13 +70,18 @@ module DexieCable
     end
 
     def add_stream(data)
-      stream = verified_stream(data["stream"])
-      stream_from stream if stream
+      target = verified_target(data["stream"])
+      return unless target
+
+      stream_for target
+      self.class.on_subscribe&.call(self, resolve_subscribe_target(target))
     end
 
     def remove_stream(data)
-      stream = verified_stream(data["stream"])
-      stop_stream_from stream if stream
+      target = verified_target(data["stream"])
+      return unless target
+
+      stop_stream_from self.class.broadcasting_for(target)
     end
 
     def remove_all_streams(_data)
@@ -85,12 +104,16 @@ module DexieCable
       self.class.broadcasting_for("#{PUBLIC_STREAM_PREFIX}#{name}")
     end
 
-    def verified_stream(token)
+    def verified_target(token)
       return unless token.present?
 
       self.class.verifier.verify(token)
     rescue ActiveSupport::MessageVerifier::InvalidSignature
       nil
     end
+
+    def resolve_subscribe_target(target)
+      target.start_with?("gid://") ? GlobalID::Locator.locate(target) : target
+    end
   end
 end

data/lib/dexiecable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DexieCable
-  VERSION = "2.0.0.alpha1"
+  VERSION = "2.0.0.alpha2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dexiecable
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha1
+  version: 2.0.0.alpha2
 platform: ruby
 authors:
 - Stefan Buhrmester