salesforce_streamer 2.0.0.rc2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62cda30f1dc4379de105485088cce3cb77a874c6b336465b05ebdc0976c46e60
-  data.tar.gz: 8c470f3301875a1926dfc68e8b40cc3862d8478bbd95c97fe4cdd154c0bd3c05
+  metadata.gz: 76475a30dc6515e8071504a9383c2811fa339f0885be703929008aaf2abbed8d
+  data.tar.gz: 927f5ff453fc8e51adaeae3915ee4ace4b0bcf11e355fc66c5aa32dbb5eec3aa
 SHA512:
-  metadata.gz: c8a7aee18710329e556852c68aeb626e587108f788acf880aa0810671b9c536517ee34798eb1e9a8fd03a67ff2e8171f59ddf1ab8da9b4f836f57b5cf3746015
-  data.tar.gz: 4c91a95c717ece055e22e05b487994293c2015f04633e0d46676f2a740986345762c8d263f40f57b981ebc18ab76553dbc7252ad2ebe95ea415ff6b533eba7f6
+  metadata.gz: cf695ae8cf24912b2ccb403b46b3151cc9ec988202ed9dd04857dab27cbef4d9afec3425898384649bc1c5bc84e5a68d515237b20f0b0a249ebe92251d51cebf
+  data.tar.gz: 0b36d256fdc82499c701aa619205c0dddf3d8837200c1e1575f144fd87caed132658e3137d3c3bc9d655157086a5e6fa2b805561729b7cef50e19a526265ef1d

data/.github/workflows/auto-approve.yml

@@ -1,7 +1,7 @@
-# automatically approve PRs submitted by Dependabot
+# automatically approve PRs submitted by Dependabot or Renofidev
 # this will allow Dependabot to automatically merge dependency update PRs where CI passes
 # from: https://github.com/hmarr/auto-approve-action
-name: Auto approve Dependabot PRs
+name: Auto approve dependency upgrades PRs
 
 on:
   pull_request
@@ -11,6 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: hmarr/auto-approve-action@v2.0.0
-      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]'
+      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]' || github.actor == 'renofidev'
       with:
         github-token: "${{ secrets.GITHUB_TOKEN }}"

data/.github/workflows/auto-merge.yml

@@ -0,0 +1,19 @@
+name: automerge
+on:
+  pull_request_review:
+    types:
+      - submitted
+  check_suite:
+    types:
+      - completed
+  status: {}
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    steps:
+      - name: automerge
+        uses: "pascalgn/automerge-action@v0.11.0"
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          MERGE_METHOD: squash
+          MERGE_DELETE_BRANCH: true

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.rc2)
+    salesforce_streamer (2.3.0)
       dry-initializer (~> 3.0)
       faye (~> 1.4)
       restforce (>= 4.2, < 6.0)
@@ -13,16 +13,14 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
     byebug (11.1.3)
-    codecov (0.2.3)
-      colorize
+    codecov (0.2.12)
       json
       simplecov
-    colorize (0.8.1)
     cookiejar (0.3.3)
     diff-lcs (1.4.4)
     docile (1.3.2)
-    dry-initializer (3.0.3)
-    em-http-request (1.1.6)
+    dry-initializer (3.0.4)
+    em-http-request (1.1.7)
       addressable (>= 2.3.4)
       cookiejar (!= 0.3.1)
       em-socksify (>= 0.3)
@@ -31,8 +29,9 @@ GEM
     em-socksify (0.3.2)
       eventmachine (>= 1.0.0.beta.4)
     eventmachine (1.2.7)
-    faraday (1.0.1)
+    faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     faye (1.4.0)
@@ -49,56 +48,59 @@ GEM
     hashie (4.1.0)
     http_parser.rb (0.6.0)
     json (2.3.1)
-    jwt (2.2.1)
+    jwt (2.2.2)
     multi_json (1.15.0)
     multipart-post (2.1.1)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.20.0)
+    parser (2.7.2.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.5)
+    public_suffix (4.0.6)
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
-    restforce (5.0.0)
+    regexp_parser (1.8.2)
+    restforce (5.0.3)
       faraday (>= 0.9.0, <= 2.0)
       faraday_middleware (>= 0.8.8, <= 2.0)
       hashie (>= 1.2.0, < 5.0)
       jwt (>= 1.5.6)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.88.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.2.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      rubocop-ast (>= 1.0.1)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
-      parser (>= 2.7.1.4)
-    rubocop-performance (1.7.1)
-      rubocop (>= 0.82.0)
-    rubocop-rspec (1.42.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.8.1)
       rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.0.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
+    ruby2_keywords (0.0.2)
+    simplecov (0.19.1)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+    simplecov-html (0.12.3)
     unicode-display_width (1.7.0)
     websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)

data/README.md

@@ -20,33 +20,11 @@ And then execute:
 
 ## Usage
 
-### Middleware
-
-You can initialize the streamer server with any number of middleware classes.
-When a message is received by a PushTopic subscription, the chain of middleware
-classes are executed before the message handler is called.
-
-```ruby
-# config/initializers/streamer.rb
-class MySimpleMiddleware
-  def initialize(handler)
-    @handler = handler
-  end
-  def call(message)
-    @handler.call(message)
-  end
-end
-
-SalesforceStreamer.config.use_middleware MySimpleMiddleware
-```
-
 ### Configure Push Topics
 
-Create a YAML file to configure your server subscriptions.  The configuration
-for each subscription must have a nested `salesforce:` key. These settings will
-be synced to your Salesforce instance when the `-x` flag is set on the command
-line. For more information about the `replay:` and `notify_fields_for` options
-please see the Salesforce Streaming API reference documentation.
+Create a YAML file to configure your PushTopic subscriptions. When streamer
+starts up it will check for any differences between Salesforce PushTopics and
+this yaml and update any differences when `config.manage_topics = true`.
 
 ```yaml
 # config/streamer.yml
@@ -71,14 +49,6 @@ production:
   <<: *DEFAULT
 ```
 
-It's important to note that the way push topics are managed is by the Salesforce
-name attribute.  This should uniquely identify each push topic.  It is not
-recommended to change the name of your push topic definitions; otherwise, the
-push topic manager will not find a push topic in Salesforce resulting in the
-creation of a brand new push topic. If the push topic manager identifies a
-difference in any of the other Salesforce attributes, then it will update the
-push topic in Salesforce before starting the streaming server.
-
 ### Define Message Handlers
 
 Define your handlers somewhere in your project. They must respond to either
@@ -88,14 +58,17 @@ Define your handlers somewhere in your project. They must respond to either
 # lib/account_change_handler.rb
 # Handle account changes inline
 class AccountChangeHandler
-  def self.call(message)
-    puts message
+  class << self
+    def call(message)
+      puts message
+    end
   end
 end
 
 # Handle account changes asynchronously
 class AccountChangeHandler
   include Sidekiq::Worker
+
   def perform(message)
     puts message
   end
@@ -116,10 +89,9 @@ 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|
-    (Store.get(topic.name) || topic.replay).to_i
-  }
+  config.replay_adapter = MyReplayAdapter
   config.use_middleware AfterMessageReceived
+  config.use_faye_extension ErrorLoggingExtension.new
   config.manage_topics = true
 end
 ```
@@ -160,6 +132,74 @@ By default, the executable will load the YAML based on the `RACK_ENV` environmen
 variable, or default to `:development` if not set. You can override this by
 setting the `config.environment = :integration`
 
+### Message Handling Middleware
+
+You can initialize the streamer server with any number of middleware classes.
+When a message is received by a PushTopic subscription, the chain of middleware
+classes are executed before the message handler is called.
+
+```ruby
+# config/initializers/streamer.rb
+class MySimpleMiddleware
+  def initialize(handler)
+    @handler = handler
+  end
+
+  def call(message)
+    @handler.call(message)
+  end
+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`.
+
+### Use Faye Extension
+
+The `config.use_faye_extension` should be given an object that responds to
+`.incoming(message, callback)` or `.outgoing(message, callback)` or both. Find
+out more about extensions from
+[Faye](https://github.com/faye/faye/blob/master/spec/ruby/server/extensions_spec.rb)
+specs.
+
+Any configured extensions are added to the Faye client used by the Restforce
+client when starting up the server. If the extension responds to `.server=` then
+the instance of `SalesforceStreamer::Server` is assigned. This may be convenient
+to restart the server subscriptions if an error requires a reset.
+
+```ruby
+class MyRestartFayeExtension
+  attr_accessor :server
+
+  def incoming(message, callback)
+    callback.call(message).tap |message|
+      server.restart if message['error'] == 'tragic'
+    end
+  end
+end
+
+SalesforceStreamer.config.use_faye_extension MyRestartFayeExtension.new
+```
 ## 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

@@ -3,7 +3,7 @@ module SalesforceStreamer
   class Configuration
     attr_accessor :environment, :logger, :require_path, :config_file,
       :manage_topics, :exception_adapter, :replay_adapter
-    attr_reader :middleware
+    attr_reader :middleware, :faye_extensions
 
     class << self
       attr_writer :instance
@@ -21,11 +21,12 @@ 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'
       @middleware = []
+      @faye_extensions = [ReplayIdErrorExtension.new]
     end
 
     def manage_topics?
@@ -37,6 +38,11 @@ module SalesforceStreamer
       @middleware << [klass, args, block]
     end
 
+    # adds a Faye extension
+    def use_faye_extension(extension)
+      @faye_extensions << extension
+    end
+
     # returns a ready to use chain of middleware
     def middleware_runner(last_handler)
       @middleware.reduce(last_handler) do |next_handler, current_handler|

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

@@ -1,15 +1,23 @@
 module SalesforceStreamer
   class Server
     attr_writer :push_topics
+    attr_reader :client
 
     def initialize(push_topics: [])
       @push_topics = push_topics
     end
 
     def run
-      Log.info 'Starting Server'
+      Log.info 'Starting server'
       catch_signals
-      start_em
+      reset_client
+      EM.run { subscribe }
+    end
+
+    def restart
+      Log.info 'Restarting server'
+      reset_client
+      EM.next_tick { subscribe }
     end
 
     private
@@ -23,24 +31,21 @@ module SalesforceStreamer
       end
     end
 
-    def client
-      return @client if @client
+    def reset_client
       @client = Restforce.new
-      @client.authenticate!
-      @client.faye.add_extension ReplayIdErrorExtension.new
-      @client
+      client.authenticate!
+      Configuration.instance.faye_extensions.each do |extension|
+        Log.debug %(adding Faye extension #{extension})
+        extension.server = self if extension.respond_to?(:server=)
+        client.faye.add_extension extension
+      end
     end
 
-    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}"
-            topic.handle message
-            topic.id = replay_id
-          end
+    def subscribe
+      @push_topics.each do |topic|
+        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
         end
       end
     end

data/lib/salesforce_streamer/version.rb

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

data/salesforce_streamer.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['documentation_uri'] = 'https://www.rubydoc.info/gems/salesforce_streamer'
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin/|spec/|\.rub)}) }

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_streamer
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc2
+  version: 2.3.0
 platform: ruby
 authors:
 - Scott Serok
 - RenoFi Engineering Team
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer
@@ -157,7 +157,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - scott@renofi.com
 - engineering@renofi.com
@@ -172,6 +172,7 @@ files:
 - ".github/ISSUE_TEMPLATE/story.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/auto-approve.yml"
+- ".github/workflows/auto-merge.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -202,7 +203,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/renofi/salesforce_streamer
   source_code_uri: https://github.com/renofi/salesforce_streamer
-post_install_message: 
+  documentation_uri: https://www.rubydoc.info/gems/salesforce_streamer
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -213,12 +215,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A wrapper around the Restforce Streaming API with a built-in PushTopic manager.
 test_files: []