gitlab-experiment 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a26425622afb7aa3f341ff403192963e276876b65902237018f852117168a19a
-  data.tar.gz: 0a5238c73a4b0217810b4f8161df6452b683b21a6573f1b657517302cef9cef0
+  metadata.gz: cf6802aee233e6124ae21b95a164a92be868f5c5eda19e9560a813ac9f0ade0a
+  data.tar.gz: e8691d32ae73422e172176477c54966edc187ec72a43030070b3412e9f15d346
 SHA512:
-  metadata.gz: 567ca93e3f931c167bc1766490b07e1535db72e3b5da5986715412746354945ed799dab4c075e91c5015aa922bf5d7e5a82bdc940808aa8100c8897d5ee623b7
-  data.tar.gz: 3f053ed2ad8bdfc2201aacaef9c723332fba260f4f4cb54c65a92539d74ec100297540c34c97579c99723f0d98e98dc57cbe383a0731128d623b0a58b4786d7c
+  metadata.gz: 0a9eded639610b17e6b0cccbd17a232d187fd9bddc68047cfa14a01500e17f0f6ba78e93e7cd08d87a0cdce6e15e31198d00b0976bb72ff7de5115be15c50859
+  data.tar.gz: a6cdae13a053ab7c2e0ae8cdb6934db927a856263a8759499f072c9364be6f6ca6ac8bc5e279f4512e04fc930d2491fe09a72909a949ce57ff64c4971ab43a65

data/lib/gitlab/experiment.rb

@@ -66,6 +66,10 @@ module Gitlab
       yield self if block_given?
     end
 
+    def inspect
+      "#<#{self.class.name || 'AnonymousClass'}:#{format('0x%016X', __id__)} @name=#{name} @signature=#{signature}>"
+    end
+
     def context(value = nil)
       return @context if value.blank?
 

data/lib/gitlab/experiment/rspec.rb

@@ -9,14 +9,32 @@ module Gitlab
           raise ArgumentError, 'variant must be a symbol or false' unless variant.is_a?(Symbol)
 
           klass = Gitlab::Experiment.send(:constantize, name) # rubocop:disable GitlabSecurity/PublicSend
-          allow(klass).to receive(:new).and_wrap_original do |new, *args, &block|
-            new.call(*args).tap do |instance|
-              allow(instance).to receive(:enabled?).and_return(true)
-              allow(instance).to receive(:resolve_variant_name).and_return(variant.to_s)
 
-              block.call(instance) if block.present?
-            end
-          end
+          # We have to use this high level any_instance behavior as there's
+          # not an alternative that allows multiple wrappings of `new`.
+          allow_any_instance_of(klass).to receive(:enabled?).and_return(true)
+          allow_any_instance_of(klass).to receive(:resolve_variant_name).and_return(variant.to_s)
+        end
+      end
+
+      def wrapped_experiment(experiment, shallow: false, failure: nil, &block)
+        if shallow
+          yield experiment if block.present?
+          return experiment
+        end
+
+        receive_wrapped_new = receive(:new).and_wrap_original do |new, *new_args, &new_block|
+          instance = new.call(*new_args)
+          instance.tap(&block) if block.present?
+          instance.tap(&new_block) if new_block.present?
+          instance
+        end
+
+        klass = experiment.class == Class ? experiment : experiment.class
+        if failure
+          expect(klass).to receive_wrapped_new, failure
+        else
+          allow(klass).to receive_wrapped_new
         end
       end
     end
@@ -24,10 +42,27 @@ module Gitlab
     module RSpecMatchers
       extend RSpec::Matchers::DSL
 
+      def require_experiment(experiment, matcher_name, classes: false)
+        klass = experiment.class == Class ? experiment : experiment.class
+        unless klass <= Gitlab::Experiment
+          raise(
+            ArgumentError,
+            "#{matcher_name} matcher is limited to experiment instances#{classes ? ' and classes' : ''}"
+          )
+        end
+
+        if experiment == klass && !classes
+          raise ArgumentError, "#{matcher_name} matcher requires an instance of an experiment"
+        end
+
+        experiment != klass
+      end
+
       matcher :exclude do |context|
         ivar = :'@excluded'
 
         match do |experiment|
+          require_experiment(experiment, 'exclude')
           experiment.context(context)
 
           experiment.instance_variable_set(ivar, nil)
@@ -47,6 +82,7 @@ module Gitlab
         ivar = :'@variant_name'
 
         match do |experiment|
+          require_experiment(experiment, 'segment')
           experiment.context(context)
 
           experiment.instance_variable_set(ivar, nil)
@@ -72,29 +108,74 @@ module Gitlab
 
         def message_details
           message = ''
-          message += %(\n    into: #{@expected}) if @expected
-          message += %(\n  actual: #{@actual}) if @actual
+          message += %( into variant\n    expected variant: #{@expected}) if @expected
+          message += %(\n      actual variant: #{@actual}) if @actual
           message
         end
       end
 
       matcher :track do |event, *event_args|
         match do |experiment|
-          wrapped(experiment) { |instance| expect(instance).to receive_with(event, *event_args) }
+          expect_tracking_on(experiment, event, *event_args)
         end
 
         match_when_negated do |experiment|
-          wrapped(experiment) { |instance| expect(instance).not_to receive_with(event, *event_args) }
+          expect_tracking_on(experiment, event, *event_args, negated: true)
         end
 
-        def wrapped(experiment, &block)
-          allow(experiment.class).to receive(:new).and_wrap_original do |new, *new_args|
-            new.call(*new_args).tap(&block)
+        chain :for do |expected_variant|
+          raise ArgumentError, 'variant name must be provided' if expected.blank?
+
+          @expected_variant = expected_variant.to_s
+        end
+
+        chain(:with_context) { |expected_context| @expected_context = expected_context }
+        chain(:on_any_instance) { @on_self = false }
+
+        def expect_tracking_on(experiment, event, *event_args, negated: false)
+          @experiment = experiment
+          @on_self = true if require_experiment(experiment, 'track', classes: !@on_self) && @on_self.nil?
+          wrapped_experiment(experiment, shallow: @on_self, failure: failure_message(:no_new, event)) do |instance|
+            @experiment = instance
+            allow(@experiment).to receive(:track)
+
+            if negated
+              expect(@experiment).not_to receive_tracking_call_for(event, *event_args)
+            else
+              expect(@experiment).to receive_tracking_call_for(event, *event_args)
+            end
           end
         end
 
-        def receive_with(*args)
-          receive(:track).with(*args) # rubocop:disable CodeReuse/ActiveRecord
+        def receive_tracking_call_for(event, *event_args)
+          receive(:track).with(*[event, *event_args]) do # rubocop:disable CodeReuse/ActiveRecord
+            if @expected_variant
+              expect(@experiment.variant.name).to eq(@expected_variant), failure_message(:variant, event)
+            end
+
+            if @expected_context
+              expect(@experiment.context.value).to include(@expected_context), failure_message(:context, event)
+            end
+          end
+        end
+
+        def failure_message(failure_type, event)
+          case failure_type
+          when :variant
+            <<~MESSAGE.strip
+              expected #{@experiment.inspect} to have tracked #{event.inspect} for variant
+                  expected variant: #{@expected_variant}
+                    actual variant: #{@experiment.variant.name}
+            MESSAGE
+          when :context
+            <<~MESSAGE.strip
+              expected #{@experiment.inspect} to have tracked #{event.inspect} with context
+                  expected context: #{@expected_context}
+                    actual context: #{@experiment.context.value}
+            MESSAGE
+          when :no_new
+            %(expected #{@experiment.inspect} to have tracked #{event.inspect}, but no new instances were created)
+          end
         end
       end
     end
@@ -103,9 +184,10 @@ end
 
 RSpec.configure do |config|
   config.include Gitlab::Experiment::RSpecHelpers
+  config.include Gitlab::Experiment::Dsl
 
   config.include Gitlab::Experiment::RSpecMatchers, :experiment
-  config.define_derived_metadata(file_path: %r{/spec/experiments/}) do |metadata|
+  config.define_derived_metadata(file_path: Regexp.new('/spec/experiments/')) do |metadata|
     metadata[:type] = :experiment
   end
 end

data/lib/gitlab/experiment/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   class Experiment
-    VERSION = '0.4.7'
+    VERSION = '0.4.8'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-experiment
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport