salesforce_streamer 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10b71d8f30b4e9eedff2ecabc48ec52d71f276abec73808f80c87d810d3307bb
-  data.tar.gz: 377f0fcaf7ccf7c44d1eaf615c12fd9e9e6b5f0fb981cd3e8268db4190c7cb23
+  metadata.gz: b7aa51a1aab875d18d027a1686a598d795d30126cea6fc81f08e705911bdc92c
+  data.tar.gz: ce9f47fdc1f3c277347c684fc533e92e56e93779c3115a0894f8834c1196b795
 SHA512:
-  metadata.gz: 59b6418e352e58af09b4e7ba6068bebed370af67feb896d3f0bba73ca1a8741b0bf73d3e67f2ad5dfe0c846694de311e877f0732672d6525cc565b93ffe507c7
-  data.tar.gz: 6d4d7dfd2baeb69fb0e7c1487a6ded133a7ab9ec4bcbd6c43a4615ceadeadd2b52df780719bef5a7fa34d96d9fed962a8c2a8d916b1e558c62657c0c4948983e
+  metadata.gz: 6d7183472e280c49188c8f0a386ddf24e47ee99cd827b0e1b9bb3c22184136ef81694364020a4c6676f728317af530e5959908fe79d871ba065d43f29b0c5f97
+  data.tar.gz: 329f63f5ced7e03256761765e70a3d13107779fa895e249e69e07e98d148ed1142b0f23c9e8cc86d38faae92087af59080524cef60a70ba51619ab4ec9cdd36b

data/CHANGELOG.md

@@ -3,6 +3,38 @@
 Sorted so that the most recent change logs are near the top. Only significant
 changes are logged in the change log.
 
+## 2020-08-17 Scott Serok [scott@renofi.com](mailto:scott@renofi.com)
+
+v2.1 changes the expected interface of `Configuration#replay_adapter`.
+
+Normally this breaking change would require a major version bump, but since the
+functionality today is quiet broken we can call this a major bug fix.
+
+The `config.replay_adapter` should be an object that has an interface like Hash.
+It must respond to `[]` and `[]=`. By default the adapter is an empty hash.  If
+you want your push topic replayId to persist between restarts, then you should
+implement a class with an appropriate interface.
+
+```ruby
+class MyReplayAdapter
+  def [](channel)
+    MyPersistence.get(channel)
+  end
+
+  def []=(channel, replay_id)
+    MyPersistence.set(channel, replay_id)
+  end
+end
+```
+
+This change was sparked by a misunderstanding of the
+`Restforce::Concerns::Streaming::ReplayExtension` replay handlers.
+SalesforceStreamer can eliminate some complexity and fix a bug by delegating the
+responsibility of maintaining the current replayId to that ReplayExtension. The
+object will be used on each request/response cycle to record and read the latest
+replayId as long as the object assigned to `config.replay_adapter` responds to
+`[]` and `[]=`.
+
 ## 2020-08-04 Scott Serok [scott@renofi.com](mailto:scott@renofi.com)
 
 v2.0 is released as a major simplification of this library. There are 2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    salesforce_streamer (2.0.0)
+    salesforce_streamer (2.1.0)
       dry-initializer (~> 3.0)
       faye (~> 1.4)
       restforce (>= 4.2, < 6.0)

data/README.md

@@ -89,9 +89,7 @@ Configure the `SalesforceStreamer` module.
 SalesforceStreamer.configure do |config|
   config.logger = Logger.new(STDERR, level: 'INFO')
   config.exception_adapter = proc { |e| puts e }
-  config.replay_adapter = proc { |topic|
-    (ReplayStore.get(topic.name) || topic.replay).to_i
-  }
+  config.replay_adapter = MyReplayAdapter
   config.use_middleware AfterMessageReceived
   config.manage_topics = true
 end
@@ -153,6 +151,28 @@ end
 
 SalesforceStreamer.config.use_middleware MySimpleMiddleware
 ```
+
+### ReplayAdapter
+
+The `config.replay_adapter` should be an object that has an interface like Hash.
+It must respond to `[]` and `[]=`. By default the adapter is an empty hash.  If
+you want your push topic replayId to persist between restarts, then you should
+implement a class with an appropriate interface.
+
+```ruby
+class MyReplayAdapter
+  def [](channel)
+    Persistence.get(channel)
+  end
+
+  def []=(channel, replay_id)
+    Persistence.set(channel, replay_id)
+  end
+end
+```
+
+This adapter will be used directly by `Restforce::ReplayExtension`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/salesforce_streamer/cli.rb

@@ -32,7 +32,7 @@ module SalesforceStreamer
         end
 
         o.on '-v', '--verbose LEVEL', 'Set the log level (default no logging)' do |arg|
-          @config.logger = Logger.new(STDERR, level: arg)
+          @config.logger = Logger.new($stderr, level: arg)
         end
 
         o.on '-V', '--version', 'Print the version information' do

data/lib/salesforce_streamer/configuration.rb

@@ -21,7 +21,7 @@ module SalesforceStreamer
       @environment = ENV['RACK_ENV'] || :development
       @logger = Logger.new(IO::NULL)
       @exception_adapter = proc { |exc| fail(exc) }
-      @replay_adapter = proc { |topic| topic.id || topic.replay }
+      @replay_adapter = Hash.new { |hash, key| hash[key] = -1 }
       @manage_topics = false
       @config_file = './config/streamer.yml'
       @require_path = './config/environment'

data/lib/salesforce_streamer/push_topic.rb

@@ -34,7 +34,7 @@ module SalesforceStreamer
       @handler = Object.const_get(@handler)
       true
     rescue NameError, TypeError => e
-      message = 'handler=' + @handler.to_s + ' exception=' + e.to_s
+      message = "handler=#{@handler} exception=#{e}"
       raise(PushTopicHandlerMissingError, message)
     end
 

data/lib/salesforce_streamer/salesforce_client.rb

@@ -8,10 +8,8 @@ module SalesforceStreamer
       @client.authenticate!
     end
 
-    def subscribe(*args)
-      @client.subscribe(args) do
-        yield
-      end
+    def subscribe(*args, &block)
+      @client.subscribe(args, &block)
     end
 
     # Returns nil or an instance of Restforce::SObject

data/lib/salesforce_streamer/server.rb

@@ -34,12 +34,9 @@ module SalesforceStreamer
     def start_em
       EM.run do
         @push_topics.map do |topic|
-          replay_id = Configuration.instance.replay_adapter.call(topic)
-          client.subscribe topic.name, replay: replay_id.to_i do |message|
-            replay_id = message.dig('event', 'replayId')
-            Log.info "Message #{replay_id} received from topic #{topic.name}"
+          client.subscribe topic.name, replay: Configuration.instance.replay_adapter do |message|
+            Log.info "Message #{message.dig('event', 'replayId')} received from topic #{topic.name}"
             topic.handle message
-            topic.id = replay_id
           end
         end
       end

data/lib/salesforce_streamer/version.rb

@@ -1,3 +1,3 @@
 module SalesforceStreamer
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_streamer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Scott Serok
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-14 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer