pusher-fake 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d87ee628168fd524b482569791802df7bb50695dc7cfc4f74164587b3a195df
-  data.tar.gz: dec3b6f7071488cf6add4418fe6e9a8a18c0b778edcc2298b22e529e9f3ad3eb
+  metadata.gz: '039808605b16ad3d4532da9fc4041f4f2cba3f783e4ec63729f5bc5b024565eb'
+  data.tar.gz: 4ff72ecce469d90b48892ae1fe0f677806a9aa8b8a3b0ff5a33c7105da3585b3
 SHA512:
-  metadata.gz: f2ca4fc45b9710725d542a7c73324b7a995b36d896c72fb7561f5cd3544b548a26f07438896530ce60e4a1689be4bbe99cc77361747f4779b3f77b38900f9ad3
-  data.tar.gz: fc90fef11fb8d9d0838f3597521610a77822f3ebd84ed82554ac8dbe3098f91b6c94afdb699c8c41e47d758ecac1ea38abdb1a1a89a26e56a8753a1758bb7aff
+  metadata.gz: 7036cbe9c7d805d193ccbb6492a58ef102e793218907787df1a8a2155a828e10aab13483ec6d783a65a1b11dc8936e73f8d3f55735cf64bb948a590dfe4e238a
+  data.tar.gz: ecf4faa213465f21879a0926c9e2adf8d1b80e515eff2a2192c8033e998bcbaca044e770c54652d6a31c4f967cc88f4c7c4a9cb3b04c601eb68016a964140c84

data/lib/pusher-fake/channel/public.rb

@@ -4,6 +4,8 @@ module PusherFake
   module Channel
     # A public channel.
     class Public
+      CACHE_CHANNEL_PREFIX = /^(private-|presence-){0,1}cache-/.freeze
+
       # @return [Array] Connections in this channel.
       attr_reader :connections
 
@@ -15,6 +17,7 @@ module PusherFake
       # @param [String] name The channel name.
       def initialize(name)
         @name        = name
+        @last_event  = nil
         @connections = []
       end
 
@@ -24,6 +27,7 @@ module PusherFake
       # @param [Hash] options The options for the channel.
       def add(connection, options = {})
         subscription_succeeded(connection, options)
+        emit_last_event(connection)
       end
 
       # Emit an event to the channel.
@@ -31,6 +35,10 @@ module PusherFake
       # @param [String] event The event name.
       # @param [Hash] data The event data.
       def emit(event, data, options = {})
+        if cache_channel?
+          @last_event = [event, data]
+        end
+
         connections.each do |connection|
           unless connection.id == options[:socket_id]
             connection.emit(event, data, name)
@@ -71,6 +79,30 @@ module PusherFake
 
       private
 
+      # @return [Array] Arguments for the last event emitted.
+      attr_reader :last_event
+
+      # Whether or not the channel is a cache channel.
+      #
+      # @return [Boolean]
+      def cache_channel?
+        @cache_channel ||= name.match?(CACHE_CHANNEL_PREFIX)
+      end
+
+      # Emit the last event if present and a cache channel.
+      #
+      # @param [Connection] connection The connection to emit to.
+      def emit_last_event(connection)
+        return unless cache_channel?
+
+        if last_event
+          connection.emit(*last_event, name)
+        else
+          connection.emit("pusher:cache_miss", nil, name)
+          trigger("cache_miss", channel: name)
+        end
+      end
+
       # Notify the +connection+ of the successful subscription and add the
       # connection to the channel.
       #

data/lib/pusher-fake.rb

@@ -9,7 +9,7 @@ require "thin"
 # A Pusher fake.
 module PusherFake
   # The current version string.
-  VERSION = "4.0.0"
+  VERSION = "4.1.0"
 
   autoload :Channel,       "pusher-fake/channel"
   autoload :Configuration, "pusher-fake/configuration"

data/spec/features/client/subscribe_spec.rb

@@ -3,6 +3,10 @@
 require "spec_helper"
 
 feature "Client subscribing to a channel" do
+  let(:cache_event)   { "command" }
+  let(:cache_channel) { "cache-last-command" }
+  let(:other_user)    { "Bob" }
+
   before do
     connect
   end
@@ -49,16 +53,27 @@ feature "Client subscribing to a channel" do
     expect(page).not_to have_content("Subscribed to presence-game-1.")
   end
 
-  protected
+  scenario "successfully subscribes to a cache channel, with no cached event" do
+    subscribe_to(cache_channel)
 
-  def attempt_to_subscribe_to(channel)
-    page.execute_script("Helpers.subscribe(#{MultiJson.dump(channel)})")
+    expect(page).to have_content("No cached event for cache-last-command.")
   end
 
-  def connect
-    visit "/"
+  scenario "successfully subscribes to a cache channel, with cached event" do
+    subscribe_to(cache_channel)
+    Pusher.trigger(cache_channel, cache_event, {}, {})
+
+    connect_as(other_user, channel: cache_channel)
 
-    expect(page).to have_content("Client connected.")
+    using_session(other_user) do
+      expect(page).to have_content("Channel #{cache_channel} received #{cache_event} event.")
+    end
+  end
+
+  protected
+
+  def attempt_to_subscribe_to(channel)
+    page.execute_script("Helpers.subscribe(#{MultiJson.dump(channel)})")
   end
 
   def override_socket_id(value)

data/spec/features/server/webhooks_spec.rb

@@ -5,6 +5,7 @@ require "spec_helper"
 feature "Receiving event webhooks" do
   let(:channel)          { "room-1" }
   let(:other_user)       { "Bob" }
+  let(:cache_channel)    { "cache-last-command" }
   let(:presence_channel) { "presence-room-1" }
 
   before do
@@ -72,6 +73,24 @@ feature "Receiving event webhooks" do
                                     "user_id" => user_id(other_user))
   end
 
+  scenario "subscribing to a cache channel with no event" do
+    subscribe_to(cache_channel)
+
+    expect(events).to include_event("cache_miss",
+                                    "channel" => cache_channel)
+  end
+
+  scenario "subscribing to a cache channel with an event" do
+    subscribe_to(cache_channel)
+    events.clear
+    Pusher.trigger(cache_channel, "an event", {}, {})
+
+    subscribe_to_as(cache_channel, other_user)
+
+    expect(events).not_to include_event("cache_miss",
+                                        "channel" => cache_channel)
+  end
+
   protected
 
   def events

data/spec/lib/pusher-fake/channel/public_spec.rb

@@ -53,6 +53,64 @@ describe PusherFake::Channel, "#add" do
     expect(PusherFake::Webhook).to have_received(:trigger)
       .with("channel_occupied", channel: name).once
   end
+
+  context "when a cached channel" do
+    let(:name) { "cache-name" }
+
+    before do
+      allow(subject).to receive(:connections).and_call_original
+    end
+
+    context "with a cached event" do
+      before do
+        subject.emit("example-cache-event", example: true)
+      end
+
+      it "triggers the cached event to the connection added" do
+        subject.add(connection)
+
+        expect(connection).to have_received(:emit)
+          .with("example-cache-event", { example: true }, name).once
+      end
+
+      it "does not trigger cache miss event" do
+        subject.add(connection)
+
+        expect(connection).not_to have_received(:emit)
+          .with("pusher:cache-miss", nil, name)
+      end
+
+      it "does not trigger cache miss webhook" do
+        subject.add(connection)
+
+        expect(PusherFake::Webhook).not_to have_received(:trigger)
+          .with("cache_miss", channel: name)
+      end
+    end
+
+    context "without a cached event" do
+      it "triggers cache miss event" do
+        subject.add(connection)
+
+        expect(connection).to have_received(:emit)
+          .with("pusher:cache_miss", nil, name).once
+      end
+
+      it "triggers cache miss webhook" do
+        subject.add(connection)
+
+        expect(PusherFake::Webhook).to have_received(:trigger)
+          .with("cache_miss", channel: name).once
+      end
+
+      it "does not trigger event" do
+        subject.add(connection)
+
+        expect(connection).not_to have_received(:emit)
+          .with("example-cache-event", { example: true }, name)
+      end
+    end
+  end
 end
 
 describe PusherFake::Channel, "#emit" do

data/spec/support/application/views/index.erb

@@ -65,6 +65,9 @@
 
           list.removeChild(item);
         })
+        .bind("pusher:cache_miss", function(client) {
+          Helpers.log("No cached event for " + name + ".");
+        })
         .bind_global(function(event, message) {
           Helpers.log("Channel " + name + " received " + event + " event.");
         });

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pusher-fake
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Tristan Dunn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2022-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request