gitlab-experiment 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45c95c2d6d85df98de92096ab00a7cb124ef3cf46f2dfa858465b3c43df8b22d
-  data.tar.gz: 17716054da0e7aff4c67ddea28c733ec275eaf95934d627bbea40856427ecb68
+  metadata.gz: 3305c24f350ec02a3ef81da742a6d108c7aef00623f8b2534f989f06ec4a2ba6
+  data.tar.gz: 5f9113235e1623a2012ea5e4c451ed41baeb847e5883951b95b44fd6d7fd40fa
 SHA512:
-  metadata.gz: a3549e9ec7f899a6994937545c1afcfaceac52efa373b3e7e594b4cd1a08e7df376d1bf79403704d681ea48a29362358ff36fd5cb0fdff6fca29c79c097c0fbb
-  data.tar.gz: 7da4141f53babfa226082190ef4c144900df52a8c1c35d03b1270dd4f3f8c2c1be16aad59a9d2da1e833d0a063177b4212744aad9e6a273637c265ea2148d317
+  metadata.gz: d7120d36eb59039dbe36eb728990b951b96b7aa118a0a73af32e18809eaed265d03dec4689b55c3118e14a252418c9c84c4e25f7c25573205c6ef5269e5f456f
+  data.tar.gz: 9233969833c74c432b187721a2b35a38e521fce3679bccf64f879b87c899e6202b0f60b047c5aa57aef10665816f3fd7b3d21f7e403b30424b1227017c9991b2

data/README.md

@@ -195,7 +195,9 @@ experiment(:pill_color, actor: User.first).run # => "red"
 
 ### Exclusion rules
 
-Exclusion rules let us determine if a context should even be considered as something to include in an experiment. If we're excluding something, it means that we don't want to run the experiment in that case. This can be useful if you only want to run experiments on new users for instance.
+Exclusion rules let us determine if a context should even be considered as something to include in an experiment. If
+we're excluding something, it means that we don't want to run the experiment in that case. This can be useful if you
+only want to run experiments on new users for instance.
 
 ```ruby
 class PillColorExperiment < Gitlab::Experiment # OR ApplicationExperiment
@@ -205,15 +207,40 @@ class PillColorExperiment < Gitlab::Experiment # OR ApplicationExperiment
 end
 ```
 
-In the previous example, we'll exclude all users named `'Richard'` as well as any account older than 2 weeks old. Not only will they be immediately given the control behavior, but no events will be tracked in these cases either.
+In the previous example, we'll exclude all users named `'Richard'` as well as any account older than 2 weeks old. Not
+only will they be immediately given the control behavior, but no events will be tracked in these cases either.
 
-Exclusion rules are executed in the order they're defined. The first exclusion rule to produce a truthy result will halt execution of further exclusion checks.
+Exclusion rules are executed in the order they're defined. The first exclusion rule to produce a truthy result will halt
+execution of further exclusion checks.
 
-Note: Although tracking calls will be ignored on all exclusions, you may want to check exclusion yourself in expensive custom logic by calling the `should_track?` or `excluded?` methods.
+#### Excluding from within the experiment block
 
-Note: When using exclusion rules it's important to understand that the control assignment is cached, which improves future experiment run performance but can be a gotcha around caching.
+You can also exclude contexts dynamically from within the experiment block using the `exclude!` method. This provides a
+convenient way to include exclusion logic directly within the experiment call:
 
-Note: Exclusion rules aren't the best way to determine if an experiment is enabled. There's an `enabled?` method that can be overridden to have a high-level way of determining if an experiment should be running and tracking at all. This `enabled?` check should be as efficient as possible because it's the first early opt out path an experiment can implement. This can be seen in [How it works](#how-it-works).
+```ruby
+experiment(:pill_color, actor: current_user) do |e|
+  e.exclude! unless can?(current_user, :manage, project)
+
+  e.control { 'blue' }
+  e.candidate { 'red' }
+end
+```
+
+This approach keeps the experiment logic wrapped nicely within the experiment block, rather than requiring you to wrap
+the entire experiment call in conditional logic. When `exclude!` is called, the experiment will be excluded and return
+the control behavior without tracking any events.
+
+Note: Although tracking calls will be ignored on all exclusions, you may want to check exclusion yourself in expensive
+custom logic by calling the `should_track?` or `excluded?` methods.
+
+Note: When using exclusion rules it's important to understand that the control assignment is cached, which improves
+future experiment run performance but can be a gotcha around caching.
+
+Note: Exclusion rules aren't the best way to determine if an experiment is enabled. There's an `enabled?` method that
+can be overridden to have a high-level way of determining if an experiment should be running and tracking at all. This
+`enabled?` check should be as efficient as possible because it's the first early opt out path an experiment can
+implement. This can be seen in [How it works](#how-it-works).
 
 ### Segmentation rules
 
@@ -770,7 +797,14 @@ Each of these approaches could be desirable given the objectives of your experim
 
 After cloning the repo, run `bundle install` to install dependencies.
 
-Run `bundle exec rake` to run the tests. You can also run `bundle exec pry` for an interactive prompt that will allow you to experiment.
+## Running tests
+
+The test suite requires Redis to be running. [Install](https://redis.io/docs/latest/operate/oss_and_stack/install/archive/install-redis/) and start Redis (`redis-server`) before running tests. 
+
+Once Redis is running, execute the tests:
+`bundle exec rake`
+
+You can also run `bundle exec pry` for an interactive prompt that will allow you to experiment.
 
 ## Contributing
 

data/lib/generators/gitlab/experiment/install/templates/initializer.rb.tt

@@ -31,6 +31,14 @@ Gitlab::Experiment.configure do |config|
   #   nil, :all, or ['www.gitlab.com', '.gitlab.com']
   config.cookie_domain = :all
 
+  # Mark experiment cookies as secure (HTTPS only).
+  #
+  # When set to true, cookies will have the secure flag set, meaning they
+  # will only be sent over HTTPS connections. Defaults to true.
+  #
+  # Set to false in development/test environments if needed:
+  #   config.secure_cookie = Rails.env.production?
+
   # The default rollout strategy.
   #
   # The recommended default rollout strategy when not using caching would

data/lib/generators/rspec/experiment/templates/experiment_spec.rb.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rails_helper'
+require 'spec_helper'
 
 <% module_namespacing do -%>
 RSpec.describe <%= class_name %>Experiment do

data/lib/gitlab/experiment/configuration.rb

@@ -44,6 +44,15 @@ module Gitlab
         "#{experiment.name}_id"
       end
 
+      # Mark experiment cookies as secure (HTTPS only).
+      #
+      # When set to true, cookies will have the secure flag set, meaning they
+      # will only be sent over HTTPS connections. Defaults to true.
+      #
+      # Set to false in development/test environments if needed:
+      #   config.secure_cookie = Rails.env.production?
+      @secure_cookie = true
+
       # The default rollout strategy.
       #
       # The recommended default rollout strategy when not using caching would
@@ -177,6 +186,7 @@ module Gitlab
           :cache,
           :cookie_domain,
           :cookie_name,
+          :secure_cookie,
           :context_key_secret,
           :context_key_bit_length,
           :mount_at,

data/lib/gitlab/experiment/cookies.rb

@@ -32,7 +32,7 @@ module Gitlab
 
         cookie ||= SecureRandom.uuid
         cookie_jar.permanent.signed[cookie_name] = {
-          value: cookie, secure: true, domain: domain, httponly: true
+          value: cookie, secure: Configuration.secure_cookie, domain: domain, httponly: true
         }
 
         hash.merge(key => cookie)

data/lib/gitlab/experiment/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   class Experiment
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-experiment
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - GitLab
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-29 00:00:00.000000000 Z
+date: 2025-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport