splitclient-rb 6.3.0 → 8.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 155d0661d53fb4c60d68bd8e03a31bf925a3afbfc2ff3bf08283d45ea1ec655e
-  data.tar.gz: 5242be792ab0dd2eaa54f191821ae9b3356a171f70c1cbcb549abc66e858c6e8
+  metadata.gz: 41d269b5dc5e38906001aefe42cb60bb4ef8de5376b9d71c613b5c8345cc9451
+  data.tar.gz: 6d66df400c0e2279ac23250dc22540135bd4e358467b5ba17ade47f8efdc6be9
 SHA512:
-  metadata.gz: 10263a795124c996f120177474e397224a42216a326bb9358e7f4bd69d86d409c4ab69fa0f2f71db1f6f375ac79828f20c4d4d369bf27bab500f44759e2c778e
-  data.tar.gz: 2298f840ae08656c85cea605eea58ef5b7e755ccf78d08a65b61366e54d745be646738cfa4e772196cd538ff70613771c712f0eaba4a3622d71d6478ed44ac0b
+  metadata.gz: 1fd4c042221d85b902894870073ec8dda740807f59348c83ce470e5571d929b6e4ca88d19e014c597a91841464a89b4f3c558b35993f091b2d5bc142dc0bfb0e
+  data.tar.gz: b1bb37265463a9a8023f70cce31dbc880a2a84c0618b3defc4e0bef9075bb62cc558f68f212e9ea1b4310be51d180a1f5538333b6b30a2e079ce704fd4da638d

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @splitio/sdk

data/.github/pull_request_template.md

@@ -0,0 +1,9 @@
+# Ruby SDK
+
+## What did you accomplish?
+
+
+## How to test new changes?
+
+
+## Extra Notes

data/.github/workflows/ci.yml

@@ -0,0 +1,90 @@
+name: ci
+on:
+  pull_request:
+    branches:
+      - development
+      - master
+  push:
+    branches:
+      - development
+      - master
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '2.5.0'
+          - '3.2.2'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Java
+        uses: actions/setup-java@v2
+        with:
+          java-version: 17
+          distribution: "temurin"
+
+      - name: Setup Ruby ${{ matrix.version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.version }}
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rake
+
+      - name: Fix code coverage paths
+        working-directory: coverage
+        run: |
+          sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' .resultset.json
+          ruby -rjson -e 'sqube = JSON.load(File.read(".resultset.json"))["RSpec"]["coverage"].transform_values {|lines| lines["lines"]}; total = { "RSpec" => { "coverage" => sqube, "timestamp" => Time.now.to_i }}; puts JSON.dump(total)' > .resultset.sonarqube.json
+
+      - name: Set VERSION env
+        run: echo "VERSION=$(cat lib/splitclient-rb/version.rb | grep VERSION | awk -F "'" '{print $2}')" >> $GITHUB_ENV
+
+      - name: SonarQube Scan (Push)
+        if: matrix.version == '3.2.2' && github.event_name == 'push'
+        uses: SonarSource/sonarcloud-github-action@v5.0.0
+        env:
+          SONAR_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          projectBaseDir: .
+          args: >
+            -Dsonar.host.url=${{ secrets.SONARQUBE_HOST }}
+            -Dsonar.projectVersion=${{ env.VERSION }}
+
+      - name: SonarQube Scan (Pull Request)
+        if: matrix.version == '3.2.2' && github.event_name == 'pull_request'
+        uses: SonarSource/sonarcloud-github-action@v5.0.0
+        env:
+          SONAR_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          projectBaseDir: .
+          args: >
+            -Dsonar.java.source=17
+            -Dsonar.host.url=${{ secrets.SONARQUBE_HOST }}
+            -Dsonar.projectVersion=${{ env.VERSION }}
+            -Dsonar.pullrequest.key=${{ github.event.pull_request.number }}
+            -Dsonar.pullrequest.branch=${{ github.event.pull_request.head.ref }}
+            -Dsonar.pullrequest.base=${{ github.event.pull_request.base.ref }}

data/.github/workflows/update-license-year.yml

@@ -0,0 +1,45 @@
+name: Update License Year
+
+on:
+  schedule:
+    - cron: "0 3 1 1 *" # 03:00 AM on January 1
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Set Current year
+        run: "echo CURRENT=$(date +%Y) >> $GITHUB_ENV"
+
+      - name: Set Previous Year
+        run: "echo PREVIOUS=$(($CURRENT-1)) >> $GITHUB_ENV"
+
+      - name: Update LICENSE
+        uses: jacobtomlinson/gha-find-replace@v2
+        with:
+          find: ${{ env.PREVIOUS }}
+          replace: ${{ env.CURRENT }}
+          include: "LICENSE"
+          regex: false
+
+      - name: Commit files
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+          git commit -m "Updated License Year" -a
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          title: Update License Year
+          branch: update-license

data/.gitignore

@@ -52,3 +52,7 @@ dump.rdb
 
 # Ignore Appraisal gemfile.lock files
 /gemfiles/*.gemfile.lock
+
+release.sh
+
+.scannerwork

data/.rubocop.yml

@@ -1,11 +1,32 @@
 Documentation:
     Enabled: false
 
+Metrics/AbcSize:
+  Max: 26
+  Exclude:
+    - lib/splitclient-rb/telemetry/memory/memory_synchronizer.rb
+
 Metrics/MethodLength:
-  Max: 15
+  Max: 20
+  Exclude:
+    - lib/splitclient-rb/telemetry/memory/memory_synchronizer.rb
+    - lib/splitclient-rb/engine/sync_manager.rb
+
+Metrics/ClassLength:
+  Max: 150
+  Exclude:
+    - lib/splitclient-rb/telemetry/memory/memory_synchronizer.rb
+
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+Metrics/ParameterLists:
+  Max: 8
+  Exclude:
+    - lib/splitclient-rb/engine/sync_manager.rb
 
 Metrics/LineLength:
-  Max: 121
+  Max: 135
 
 Metrics/BlockLength:
   Exclude:
@@ -16,8 +37,24 @@ Naming/FileName:
   Exclude:
     - splitclient-rb.gemspec
 
+Style/OptionalBooleanParameter:
+  Exclude:
+    - lib/splitclient-rb/engine/matchers/between_matcher.rb
+    - lib/splitclient-rb/engine/matchers/combining_matcher.rb
+    - lib/splitclient-rb/engine/matchers/equal_to_matcher.rb
+    - lib/splitclient-rb/engine/matchers/less_than_or_equal_to_matcher.rb
+    - lib/splitclient-rb/engine/matchers/greater_than_or_equal_to_matcher.rb
+
+Style/HashTransformKeys:
+  Exclude:
+    - lib/splitclient-rb/engine/matchers/combining_matcher.rb
+
+Style/RedundantReturn:
+  Exclude:
+    - lib/splitclient-rb/engine/common/impressions_manager.rb
+
 AllCops:
-  TargetRubyVersion: 2.3.6
+  TargetRubyVersion: 2.5
   Exclude:
     - gemfiles/* # excluded as appraisal generates them with errors
     - lib/*
@@ -31,3 +68,9 @@ AllCops:
     - lib/splitclient-rb/engine/metrics/**/*
     - lib/splitclient-rb/engine/models/**/*
     - lib/splitclient-rb/engine/parser/**/*
+    - spec/telemetry/synchronizer_spec.rb
+    - lib/splitclient-rb/engine/synchronizer.rb
+    - tmp/**/*
+    - lib/splitclient-rb/sse/event_source/client.rb
+    - spec/**/*
+    - .simplecov

data/CHANGES.txt

@@ -1,5 +1,161 @@
-6.3.0 (Apr 30, 2019)
+CHANGES
+
+8.10.1 (Jan 28, 2025)
+- Fixed rule-based segment matcher to exit when a conition is met.
+- Fixed impressions properties format in redis mode. 
+
+8.10.0 (Nov 28, 2025)
+- Updated socketry gem used in streaming feature with built-in socket lib.  
+
+8.9.0 (Oct 8, 2025)
+- Added new configuration for Fallback Treatments, which allows setting a treatment value and optional config to be returned in place of "control", either globally or by flag. Read more in our docs.
+
+8.8.0 (Sep 26, 2025)
+- Added a maximum size payload when posting unique keys telemetry in batches
+
+8.7.0 (Aug 1, 2025)
+- Added a new optional argument to the client `getTreatment` methods to allow passing additional evaluation options, such as a map of properties to append to the generated impressions sent to Split backend. Read more in our docs.
+
+8.6.0 (Jun 17, 2025)
+- Added support for rule-based segments. These segments determine membership at runtime by evaluating their configured rules against the user attributes provided to the SDK.
+- Added support for feature flag prerequisites. This allows customers to define dependency conditions between flags, which are evaluated before any allowlists or targeting rules.
+
+8.5.0 (Jan 17, 2025)
+- Fixed high cpu usage when unique keys are cleared every 24 hours.
+- Added support for the new impressions tracking toggle available on feature flags, both respecting the setting and including the new field being returned on SplitView type objects. Read more in our docs.
+
+8.4.0 (May 3, 2024)
+- Fixed issue preventing Impressopns and Events posting if client.destroy is called before the post threads started
+- Added support for targeting rules based on semantic versions (https://semver.org/).
+
+8.3.1 (Mar 22, 2024)
+- Fixed ruby process hanging due to failed thread.join command, when calling destroy and a http request still active.
+- Fixed streaming notification parser. Issue ref: https://github.com/splitio/ruby-client/issues/511
+
+8.3.0 (Dec 11, 2023)
+- Added support for Flag Sets on the SDK, which enables grouping feature flags and interacting with the group rather than individually (more details in our documentation):
+  - Added new variations of the get treatment methods to support evaluating flags in given flag set/s.
+    - get_treatments_by_flag_set and get_treatments_by_flag_sets
+    - get_treatments_with_config_by_flag_set and get_treatments_with_config_by_flag_sets
+- Added a new optional Split Filter configuration option. This allows the SDK and Split services to only synchronize the flags in the specified flag sets, avoiding unused or unwanted flags from being synced on the SDK instance, bringing all the benefits from a reduced payload.
+   - Note: Only applicable when the SDK is in charge of the rollout data synchronization. When not applicable, the SDK will log a warning on init.
+- Added `default_treatment` and `sets` property to the `split_view` object returned by the `split` and `splits` methods of the SDK manager.
+
+8.2.0 (Jul 18, 2023)
+- Improved streaming architecture implementation to apply feature flag updates from the notification received which is now enhanced, improving efficiency and reliability of the whole update system.
+
+8.1.2 (May 15, 2023)
+- Updated terminology on the SDKs codebase to be more aligned with current standard without causing a breaking change. The core change is the term split for feature flag on things like logs and IntelliSense comments.
+
+8.1.1 (Mar 17, 2023)
+- Added retries with backoff when the sdk tries to connect to the Streaming service and it is not available.
+- Updated the way that the sdk write mtks in redis.
+- Fixed calculation of timeUntilReady in telemetry.
+
+8.1.0 (Oct 5, 2022)
+- Added a new impressions mode for the SDK called NONE , to be used in factory when there is no desire to capture impressions on an SDK factory to feed Split's analytics engine. Running NONE mode, the SDK will only capture unique keys evaluated for a particular feature flag instead of full blown impressions.
+
+8.0.1 (Jul 20, 2022)
+- Updated dependencies to support faraday > 2.0
+
+8.0.0 (May 10, 2022)
+- BREAKING CHANGE: Deprecated support for ruby 2.3 and 2.4 versions. The minimum ruby version required is 2.5 now.
+- Updated redis command for config telemetry, using hset instead of rpush now.
+- Updated dependencies:
+  - rake to ~> 13.0
+  - faraday to >= 1.1, < 2.0
+
+7.3.4 (Feb 21, 2022)
+- Updated streaming events architecture with a new queue logic.
+- Fixed redis integration Pipelining command deprecation warning.
+
+7.3.3 (Jan 28, 2022)
+- Fixed edge cases where the sdk lost streaming connection.
+- Updated default auth service url to https://auth.split.io/api/v2/auth
+- Updated dependencies:
+  - faraday to  >= 0.8, < 2.0
+  - net-http-persistent to >= 2.9, < 5.0
+  - redis to >= 4.0.0, < 5.0
+  - socketry to >= 0.4, < 1.0
+  - thread_safe to ~> 0.3
+
+7.3.2 (Dec 10, 2021)
+- Updated the readiness flow to be more consistent with the other sdks and improve the readiness time.
+- Updated the name of telemety key latencies in Redis.
+
+7.3.1 (Jul 26, 2021)
+- Updated the synchronization flow to be more reliable in the event of an edge case generating delay in cache purge propagation, keeping the SDK cache properly synced.
+
+7.3.0 (Jul 12, 2021)
+- Updated SDK telemetry storage, metrics and updater to be more effective and send less often.
+- Fixed high cpu usage when api key is wrong.
+
+7.2.3 (Feb 24, 2021)
+- Fixed missing segment fetch after an SPLIT_UPDATE.
+- Updated streaming logic to support multiregion.
+- Updated sse client connection logic to read confirmation event.
+- Updated naming of retryable erros.
+
+7.2.2 (Dec 18, 2020)
+- Fixed issue: undefined local variable or method post_impressions_count
+
+7.2.1 (Oct 23, 2020)
+- Updated redis dependency to >= 4.2.2.
+- Updated ably error handling.
+
+7.2.0 (Sep 25, 2020)
+- Added impressions dedupe logic to avoid sending duplicated impressions:
+  - Added `OPTIMIZED` and `DEBUG` modes in order to enabling/disabling how impressions are going to be sent into Split servers,
+    - `OPTIMIZED`: will send unique impressions in a timeframe in order to reduce how many times impressions are posted to Split.
+    - `DEBUG`: will send every impression generated to Split.
+
+7.1.3 (Jul 31, 2020)
+- Updated rake development dependency to ~> 12.3.3.
+
+7.1.2 (Jun 15, 2020)
+- Fixed uninitialized constant LocalhostSplitStore::YAML for console apps.
+- Updated default_streaming_enabled to true.
+
+7.1.1 (May 19, 2020)
+- Updated streaming domain.
+
+7.1.0 (Apr 30, 2020)
+- Added support for the new Split streaming architecture. When enabled, the SDK will not poll for updates but instead receive notifications every time there's a change in your environments, allowing to process those much quicker. If disabled (default) or in the event of an issue, the SDK will fallback to the known polling mechanism to provide a seamless experience.
+
+7.0.3 (Jan 20, 2020)
+- Added integration tests.
+- Fixed impressions labels.
+
+7.0.2 (Nov 11, 2019)
+- Fixed an issue about empty logs.
+- Fixed an issue about reducing scan commands in redis.
+
+7.0.1 (Oct 31, 2019)
+- Updated localhost mode so that parsing of test files results in JSON data for splits analogous to that returned by the Split backend.
+- Updated localhost mode to parse the mock data into Split objects to keep differences in operation to a minimum.
+- Removed specific spare code dealing with localhost operations.
+- Removed the disable_impressions configuration param.
+- Fixed an issue about Event properties were not sent to be.
+- Added ip_addresses_enabled to enable/disable sending MachineName and MachineIP headers when data is posted to Split Servers.
+- Fixed an issue about attributes in matchers.
+- Fixed an issue about trying to access a nil property when sending telemetry metrics.
+
+7.0.0 (Aug 23, 2019)
+- BREAKING CHANGE: block_until_ready is now a method in both split_client and split_manager that needs to be explicitly called. The block_until_ready parameter is now ignored if passed in the configuration, and defaults to 15s unless passed as a parameter of the block_until_ready method.
+- Added warning to track calls when traffic type does not belong to an existing split (only issued in the online client and when SDK is ready).
+- Added warning to the get_treatment's method family when split does not exist in the current environment (only issued by online client and when SDK is ready).
+- Added warning to the split_manager's split method when split does not exist in the current environment (only issued by online client and when SDK is ready).
+- Added ability to create multiple split_factory instances. Added factory counts and warnings.
+- Added SDK not ready impressions label.
+- Changed the splits method implementation in the splits_repository to make use of get_splits, which outperforms the current implementation.
+
+6.4.1 (Jul 26, 2019)
+- Fixed an issue in the latency metrics format preventing the synchronizer from correctly picking them up (consumer mode only). Old keys will be deleted on SDK startup.
+
+6.4.0 (Jul 05, 2019)
+- Added properties to track method.
 
+6.3.0 (Apr 30, 2019)
 - Added Dynamic Configurations support through two new methods that mimick the regular ones, changing the type of what is returned.
   - get_treatment_with_config: Same as get_treatment but returning the treatment with it's config.
   - get_treatments_with_config: Same as get_treatments, but instead of a map of string it returns a map of treatments with config.
@@ -8,7 +164,7 @@
   define configurations for your treatments and also whitelisted keys. Read more in our docs!
 
 6.2.0 (Mar 7th, 2019)
-- Reworked SplitClient#destroy to ensure events, impressions and metrics are sent to Split backend when called
+- Reworked SplitClient#destroy to ensure events, impressions and metrics are sent to Split backend when called.
 - Ensured destroy is called when keyboard interrupts are sent to the application
 - Changed SDK blocker (and block_until_ready) to have no effect in consumer mode
 - Added support for applications tied to Faraday < 0.13 and net-http-persistent 3 using a patched Faraday adapter
@@ -163,34 +319,27 @@
 - Detach implementation for local factory and regular one.
 
 3.0.3
-
 - Fix nil ref in manager
 
 3.0.2
-
 - add ability to provide different bucketing/matching keys
 
 3.0.1
-
 - fix segments not deleting from the cache
 
 3.0.0
-
 - add new caching interface
 - add replaceable adapters to store cache in
 - add first cache adapter: MemoryAdapter
 - refactoring
 
 2.0.1
-
 - Supress warnings cause by Net::HTTP when it already exists.
 
 2.0.0
-
 - Add Factory for creation of Client and Manager interface.
 
 1.0.4
-
 - added support for AND combiner on conditions
 - added events_uri as config param which defines the metrics post url
 - updated metrics post default endpoint to be https://events.split.io/api/
@@ -206,10 +355,8 @@
 - added condition to return CONTROL on the deleted features
 
 1.0.1
-
 - .splits to .split for local env
 - isTreatment was removed from the API.
 
 1.0.0
-
 - Support multivariate treatment

data/CONTRIBUTORS-GUIDE.md

@@ -0,0 +1,49 @@
+# Contributing to the Split Ruby SDK
+ 
+Split SDK is an open source project and we welcome feedback and contribution. The information below describes how to build the project with your changes, run the tests, and send the Pull Request(PR).
+ 
+## Development
+
+### Development process
+ 
+1. Fork the repository and create a topic branch from `development` branch. Please use a descriptive name for your branch.
+2. While developing, use descriptive messages in your commits. Avoid short or meaningless sentences like "fix bug".
+3. Make sure to add tests for both positive and negative cases.
+4. Run the linter script of the project and fix any issues you find.
+5. Run the build script and make sure it runs with no errors.
+6. Run all tests and make sure there are no failures.
+7. `git push` your changes to GitHub within your topic branch.
+8. Open a Pull Request(PR) from your forked repo and into the `development` branch of the original repository.
+9. When creating your PR, please fill out all the fields of the PR template, as applicable, for the project.
+10. Check for conflicts once the pull request is created to make sure your PR can be merged cleanly into `development`.
+11. Keep an eye out for any feedback or comments from Split's SDK team.
+
+### Building the SDK
+To install this gem dependencies onto your local machine, run `bundle exec rake install`.
+
+Then you can build the gem using `gem build splitclient-rb.gemspec` and install on your Ruby version with `gem install splitclient-rb-X.X.X.gem` (_the version number should match what you just built_).
+
+### Running tests
+The gem uses `rspec` for unit testing. You can find the files for the unit tests and the specs helper file (`spec_helper.rb`) under the default `/spec` folder.
+
+To run all the specs in the `spec` folder, use the provided rake task (_make sure Redis is running in localhost_):
+
+```bash
+  bundle exec rspec
+```
+
+`Simplecov` is used for coverage reporting. Upon executing the rake task it will store the reports in the `/coverage` folder.
+
+### Linting and other useful checks
+To run the static code analysis using Rubocop run:
+```bash
+bundle exec rubocop
+```
+
+If you want to benchmark the hashing algorithm (MurmurHash) run:
+```bash
+bundle exec rake compile:murmurhash
+```
+ 
+# Contact
+If you have any other questions or need to contact us directly in a private manner send us a note at developers@split.io