liveqa 1.8.3 → 1.9.0

data/lib/liveqa.rb

@@ -5,12 +5,11 @@ require 'ostruct'
 require 'json'
 require 'time'
 require 'cgi'
-
-# Async
-require 'liveqa/async_handlers/base'
+require 'logger'
 
 # Base
 require 'liveqa/version'
+require 'liveqa/formated_logger'
 require 'liveqa/library_name'
 require 'liveqa/util'
 require 'liveqa/config'
@@ -21,6 +20,11 @@ require 'liveqa/api_resource'
 require 'liveqa/store'
 require 'liveqa/message'
 
+# Processor
+require 'liveqa/processor/async'
+require 'liveqa/processor/worker'
+require 'liveqa/processor/batch'
+
 # Operations
 require 'liveqa/api_operation/save'
 require 'liveqa/api_operation/delete'
@@ -30,6 +34,7 @@ require 'liveqa/event'
 require 'liveqa/group'
 require 'liveqa/identity'
 require 'liveqa/watcher'
+require 'liveqa/batch'
 
 # Plugins
 require 'liveqa/plugins'
@@ -39,6 +44,11 @@ require 'liveqa/plugins'
 module LiveQA
   class << self
 
+    EVENTS_CREATE_ACTION = 'events:create'.freeze
+    GROUPS_UPDATE_ACTION = 'groups:update'.freeze
+    IDENTITIES_UPDATE_ACTION = 'identities:update'.freeze
+    WATCHERS_CREATE_ACTION = 'watchers:create'.freeze
+
     ##
     # @return [LiveQA::Config] configurations
     attr_reader :configurations
@@ -65,8 +75,8 @@ module LiveQA
     # @param [Hash] payload to be send
     # @param [Hash] options for the request
     #
-    # @return [LiveQA::Object] response from the server
-    def track(name, payload = {}, request_options = {})
+    # @return [Boolean] status of the request
+    def track(name, payload = {}, options = {})
       return true unless configurations.enabled
 
       payload[:type] = 'track'
@@ -75,12 +85,15 @@ module LiveQA
 
       payload = Message.extended.merge(payload)
 
-      if configurations.async_handler
-        return configurations.async_handler.enqueue('LiveQA::Event', 'create', payload, request_options)
+      if configurations.async
+        return processor.enqueue(
+          action: EVENTS_CREATE_ACTION,
+          payload: payload,
+          options: options.select { |k, _v| %i[space_name environment_name].include?(k) },
+        )
       end
 
-      event = Event.create(payload, request_options)
-
+      event = Event.create(payload, options)
       event.successful?
     end
 
@@ -91,8 +104,8 @@ module LiveQA
     # @param [Hash] payload to be send
     # @param [Hash] options for the request
     #
-    # @return [LiveQA::Object] response from the server
-    def identify(user_id, payload = {}, request_options = {})
+    # @return [Boolean] status of the request
+    def identify(user_id, payload = {}, options = {})
       return true unless configurations.enabled
 
       payload[:type]    = 'identify'
@@ -101,12 +114,15 @@ module LiveQA
 
       payload = Message.extended.merge(payload)
 
-      if configurations.async_handler
-        return configurations.async_handler.enqueue('LiveQA::Event', 'create', payload, request_options)
+      if configurations.async
+        return processor.enqueue(
+          action: EVENTS_CREATE_ACTION,
+          payload: payload,
+          options: options.select { |k, _v| %i[space_name environment_name].include?(k) },
+        )
       end
 
-      event = Event.create(payload, request_options)
-
+      event = Event.create(payload, options)
       event.successful?
     end
 
@@ -117,18 +133,22 @@ module LiveQA
     # @param [Hash] payload to be send
     # @param [Hash] options for the request
     #
-    # @return [LiveQA::Object] response from the server
-    def set_group(group_id, payload = {}, request_options = {})
+    # @return [Boolean] status of the request
+    def set_group(group_id, payload = {}, options = {})
       return true unless configurations.enabled
 
       payload = Message.base.merge(payload)
 
-      if configurations.async_handler
-        return configurations.async_handler.enqueue('LiveQA::Group', 'update', group_id, payload, request_options)
+      if configurations.async
+        return processor.enqueue(
+          action: GROUPS_UPDATE_ACTION,
+          id: group_id,
+          payload: payload,
+          options: options.select { |k, _v| %i[space_name environment_name].include?(k) },
+        )
       end
 
-      group = Group.update(group_id, payload, request_options)
-
+      group = Group.update(group_id, payload, options)
       group.successful?
     end
 
@@ -139,18 +159,22 @@ module LiveQA
     # @param [Hash] payload to be send
     # @param [Hash] options for the request
     #
-    # @return [LiveQA::Object] response from the server
-    def set_identity(user_id, payload = {}, request_options = {})
+    # @return [Boolean] status of the request
+    def set_identity(user_id, payload = {}, options = {})
       return true unless configurations.enabled
 
       payload = Message.base.merge(payload)
 
-      if configurations.async_handler
-        return configurations.async_handler.enqueue('LiveQA::Identity', 'update', user_id, payload, request_options)
+      if configurations.async
+        return processor.enqueue(
+          action: IDENTITIES_UPDATE_ACTION,
+          id: user_id,
+          payload: payload,
+          options: options.select { |k, _v| %i[space_name environment_name].include?(k) },
+        )
       end
 
-      identity = Identity.update(user_id, payload, request_options)
-
+      identity = Identity.update(user_id, payload, options)
       identity.successful?
     end
 
@@ -161,8 +185,8 @@ module LiveQA
     # @param [Hash] payload to be send
     # @param [Hash] options for the request
     #
-    # @return [LiveQA::Object] response from the server
-    def watch(id_or_name, payload = {}, request_options = {})
+    # @return [Boolean] status of the request
+    def watch(id_or_name, payload = {}, options = {})
       return true unless configurations.enabled
 
       payload[:template_flow] = id_or_name
@@ -170,14 +194,23 @@ module LiveQA
 
       payload.delete(:session_tracker_id) if payload.delete(:without_session)
 
-      if configurations.async_handler
-        return configurations.async_handler.enqueue('LiveQA::Watcher', 'create', payload, request_options)
+      if configurations.async
+        return processor.enqueue(
+          action: WATCHERS_CREATE_ACTION,
+          payload: payload,
+          options: options.select { |k, _v| %i[space_name environment_name].include?(k) },
+        )
       end
 
-      watcher = Watcher.create(payload, request_options)
-
+      watcher = Watcher.create(payload, options)
       watcher.successful?
     end
 
+    private
+
+    def processor
+      @processor ||= Processor::Async.new
+    end
+
   end
 end

data/liveqa.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'liveqa/version'
 require 'liveqa/library_name'
@@ -19,8 +19,8 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- spec/*`.split("\n")
 
   s.add_development_dependency 'faker', '~> 1.8.4'
-  s.add_development_dependency 'rake', '>= 0.9.0'
   s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake', '>= 0.9.0'
   s.add_development_dependency 'rspec', '~> 3.5'
-  s.add_development_dependency 'rubocop', '= 0.49.1'
+  s.add_development_dependency 'rubocop', '= 0.58.2'
 end

data/spec/lib/liveqa/api_resource_spec.rb

@@ -12,7 +12,7 @@ describe LiveQA::APIResource do
         let(:expected_payload) {{
           method:  :post,
           url:     'http://localhost:4003/test',
-          payload: '{}',
+          payload: match(''),
           use_ssl: false,
           headers: {
             accept:             'application/json',
@@ -20,7 +20,7 @@ describe LiveQA::APIResource do
             x_account_token:    'acc_xx',
             x_space_name:       'LiveQA',
             x_environment_name: 'test'
-          }
+          },
         }}
 
         after { resource }
@@ -32,7 +32,7 @@ describe LiveQA::APIResource do
         let(:expected_payload) {{
           method:  :post,
           url:     'http://localhost:4003/test',
-          payload: "{\"test\":true}",
+          payload: match("\"test\":true"),
           use_ssl: false,
           headers: {
             accept:             'application/json',
@@ -51,8 +51,8 @@ describe LiveQA::APIResource do
       context 'with body and get' do
         let(:expected_payload) {{
           method:  :get,
-          url:     'http://localhost:4003/test?test=true',
-          payload: "{\"test\":true}",
+          url:     match("http://localhost:4003/test\\?test=true"),
+          payload: match("\"test\":true"),
           use_ssl: false,
           headers: {
             accept:             'application/json',
@@ -71,8 +71,8 @@ describe LiveQA::APIResource do
       context 'with overwrite headers tokens' do
         let(:expected_payload) {{
           method:  :post,
-          url:     'http://localhost:4003/test',
-          payload: '{}',
+          url:     match('http://localhost:4003/test'),
+          payload: match(''),
           use_ssl: false,
           headers: {
             accept:             'application/json',
@@ -101,7 +101,7 @@ describe LiveQA::APIResource do
       context 'with Net::HTTPBadRequest' do
         let(:response) { double('response', code: '400', code_type: Net::HTTPBadRequest, body: {}.to_json, message: 'failed') }
 
-        it { expect { resource }.to_not raise_error }
+        it { expect { resource }.to raise_error(LiveQA::RequestError) }
       end
     end
   end

data/spec/lib/liveqa/batch_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe LiveQA::Batch do
+
+  describe '.create' do
+    let(:response) { double('LiveQA::Request', body:  "{\"object\":\"event\",\"id\":41}") }
+    before { allow(LiveQA::Request).to receive(:execute).and_return(response) }
+
+    subject(:create) { LiveQA::Batch.create(data: []) }
+
+    it { is_expected.to be_successful }
+  end
+
+end

data/spec/lib/liveqa/config_spec.rb

@@ -10,7 +10,15 @@ describe LiveQA::Config do
 
     %i[account_token environment_name api_host api_version].each do |field|
       context "validate #{field}" do
-        let(:params) {{ account_token: 'acc_xx', space_name: 'LiveQA', environment_name: 'test', api_host: 'host', api_version: 'v1'  }.merge(field => '')}
+        let(:params) {
+          {
+            account_token: 'acc_xx',
+            space_name: 'LiveQA',
+            environment_name: 'test',
+            api_host: 'host',
+            api_version: 'v1',
+          }.merge(field => '')
+        }
 
         it { expect { config.valid! }.to raise_error(LiveQA::ConfigurationError, "#{field} can't be blank") }
       end
@@ -24,19 +32,5 @@ describe LiveQA::Config do
       it { expect(config.obfuscated_fields).to match_array(%w[another_password password_confirmation password access_token api_key authenticity_token ccv credit_card_number cvv secret secret_token token]) }
     end
 
-    context 'async_handler' do
-      context 'sidekiq' do
-        let(:params) {{
-          account_token: 'acc_xx',
-          space_name: 'LiveQA',
-          environment_name: 'test',
-          async_handler: :sidekiq
-        }}
-        before { config.valid! }
-
-        it { expect(config.async_handler).to be_a(LiveQA::AsyncHandlers::Sidekiq) }
-      end
-    end
-
   end
 end

data/spec/lib/liveqa/formated_logger_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe LiveQA::FormatedLogger do
+  let(:default_logger) { Logger.new(STDOUT) }
+  let(:logger) { LiveQA::FormatedLogger.build(default_logger) }
+
+  describe 'debug' do
+
+    context 'active' do
+      before do
+        allow(default_logger).to receive(:debug)
+        logger.debug('test')
+      end
+
+      it { expect(default_logger).to have_received(:debug).with('[LiveQA] test') }
+    end
+
+    context 'inactive' do
+      before do
+        LiveQA.configurations.log = false
+        allow(default_logger).to receive(:debug)
+        logger.debug('test')
+      end
+
+      it { expect(default_logger).to_not have_received(:debug) }
+    end
+
+  end
+
+  describe 'info' do
+
+    context 'active' do
+      before do
+        allow(default_logger).to receive(:info)
+        logger.info('test')
+      end
+
+      it { expect(default_logger).to have_received(:info).with('[LiveQA] test') }
+    end
+
+    context 'inactive' do
+      before do
+        LiveQA.configurations.log = false
+        allow(default_logger).to receive(:info)
+        logger.info('test')
+      end
+
+      it { expect(default_logger).to_not have_received(:info) }
+    end
+
+  end
+
+  describe 'info' do
+
+    context 'active' do
+      before do
+        allow(default_logger).to receive(:info)
+        logger.info('test')
+      end
+
+      it { expect(default_logger).to have_received(:info).with('[LiveQA] test') }
+    end
+
+    context 'inactive' do
+      before do
+        LiveQA.configurations.log = false
+        allow(default_logger).to receive(:info)
+        logger.info('test')
+      end
+
+      it { expect(default_logger).to_not have_received(:info) }
+    end
+
+  end
+
+  describe 'error' do
+
+    context 'active' do
+      before do
+        allow(default_logger).to receive(:error)
+        logger.error('test')
+      end
+
+      it { expect(default_logger).to have_received(:error).with('[LiveQA] test') }
+    end
+
+    context 'inactive' do
+      before do
+        LiveQA.configurations.log = false
+        allow(default_logger).to receive(:error)
+        logger.error('test')
+      end
+
+      it { expect(default_logger).to_not have_received(:error) }
+    end
+
+  end
+
+end

data/spec/lib/liveqa/processor/async_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe LiveQA::Processor::Async do
+
+  let(:processor) { LiveQA::Processor::Async.new }
+
+  context 'enqueue a message' do
+
+    before do
+      allow(processor).to receive(:ensure_worker_running)
+      processor.enqueue({ test: 'hello' })
+    end
+
+    it { expect(processor).to have_received(:ensure_worker_running) }
+    it { expect(processor.instance_variable_get(:@queue).length).to eq(1) }
+  end
+
+
+end

data/spec/lib/liveqa/processor/batch_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe LiveQA::Processor::Batch do
+  let(:batch) { LiveQA::Processor::Batch.new }
+
+  context 'set defaults' do
+    it { expect(batch.messages).to eq([]) }
+    it { expect(batch.can_run?).to be_truthy }
+    it { expect(batch.can_retry?).to be_truthy }
+    it { expect(batch.full?).to be_falsey }
+  end
+
+  context 'add message' do
+    before { batch << { test: 'hello' }}
+
+    it { expect(batch.messages).to eq([{ test: 'hello' }]) }
+    it { expect(batch.full?).to be_falsey }
+  end
+
+  context 'with extended task' do
+    before { batch.update_retry }
+
+    it { expect(batch.can_run?).to be_falsey }
+    it { expect(batch.can_retry?).to be_truthy }
+  end
+
+  context 'with extended task' do
+    before do
+      11.times { batch.update_retry }
+    end
+
+    it { expect(batch.can_run?).to be_falsey }
+    it { expect(batch.can_retry?).to be_falsey }
+  end
+
+  context 'with max number of messages reached' do
+    before { 100.times { batch << { test: 'hello' }}}
+
+    it { expect(batch.full?).to be_truthy }
+  end
+
+  context 'with max size reached' do
+    before { 20.times { batch << 1000.times.map {{ test: 'hello' }}}}
+
+    it { expect(batch.full?).to be_truthy }
+  end
+
+end

data/spec/lib/liveqa/processor/worker_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe LiveQA::Processor::Worker do
+  let(:queue) { Queue.new }
+  let(:worker) { LiveQA::Processor::Worker.new(queue) }
+
+  context 'do nothing' do
+    before do
+      allow(worker).to receive(:send_batches)
+      worker.run
+    end
+
+    it { expect(worker).not_to have_received(:send_batches) }
+  end
+
+  context 'with something in the queue' do
+    before do
+      queue << { test: true }
+      allow(LiveQA::Batch).to receive(:create)
+      worker.run
+    end
+
+    it { expect(LiveQA::Batch).to have_received(:create) }
+  end
+end