Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add autoloadability via Bundler.require #137

Merged
merged 3 commits into from
Jul 23, 2019
Merged

Add autoloadability via Bundler.require #137

merged 3 commits into from
Jul 23, 2019

Conversation

tonyta
Copy link
Contributor

@tonyta tonyta commented Jul 19, 2019 •
edited
Loading

Problem

I gotta say, it's not ideal that this repo, the gem name, and the require statement are all different. Currently, we have to do one of the following to load the gem:

Explicitly require the gem where we need it:

# Gemfile
gem "launchdarkly-server-sdk"

# Usage
Bundler.require(:development)
LaunchDarkly::LDClient  # 💣

require "ldclient-rb"   # 😕
LaunchDarkly::LDClient  # ✅

Or, tell Bundler how to require it (if we are using Bundler.require or Rails):

# Gemfile
gem "launchdarkly-server-sdk", require: "ldclient-rb" # 😕

# Usage
Bundler.require(:development)
LaunchDarkly::LDClient  # ✅

But what if there is a better way?...

Solution

Bundler can automatically load gems if there is a conventionally named. First, it will try to load a file matching the name of the gem. Then, it will rely on its naming conventions.

This commit adds a file named launchdarkly-server-sdk.rb that simply requires ldclient-rb.rb, allowing for this feature to be used. This allows Rails to automatically load the gem via Bundler.require. Hooray!!! 🍻

This allows Rails projects to simply add the following to their Gemfile:

# Gemfile
gem "launchdarkly-server-sdk" # 😄

# Usage
Bundler.require(:development)
LaunchDarkly::LDClient  # ✅ 🎉🎉🎉

Hope this is helpful! 💜❤️🧡💛💚💙

@tonyta
Add autoloadability via Bundler.require
a814fcc 
Bundler can automatically load gems if there is a conventionally named.
First, it will try to load a file matching the name of the gem:

  https://github.com/bundler/bundler/blob/v2.0.2/lib/bundler/runtime.rb#L76-L87

Then, it will rely on Bundler's naming conventions:

  https://guides.rubygems.org/name-your-gem/

This commit adds a file named `launchdarkly-server-sdk.rb` that simply
requires `ldclient-rb.rb`, allowing for this feature to be used.

This allows Rails to automatically load the gem via Bundler.require:

  https://github.com/rails/rails/blob/v5.2.3/railties/lib/rails/generators/rails/app/templates/config/application.rb.tt#L20-L22
@eli-darkly
Copy link
Contributor

One question: you said "it's not ideal that this repo, the gem name, and the require statement are all different". Why does the name of the repo matter?

The repo name has always been different from the gem name, the reason being that we have SDKs for many different languages so the repo name has to include "ruby" (but does not need to include "launchdarkly", since all of our Github projects are already in "launchdarkly"), whereas for a Ruby gem name it doesn't make sense to mention "ruby" but we do need to mention "launchdarkly".

@eli-darkly
Copy link
Contributor

But, to your main point, indeed it's inconvenient that the require statement uses a different name. That is for historical reasons: the gem used to be named "ldclient-rb" too, until we did a general rename of all of our SDK packages just for clarity, but we did not want to break existing code. Your solution seems good.

eli-darkly
eli-darkly reviewed Jul 19, 2019
View reviewed changes
spec/launchdarkly-server-sdk_spec.rb
Bundler.require(:development)
abort unless $LOADED_FEATURES.any?(/ldclient-rb\.rb/)
RUBY
end
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this test mechanism is going to work in every version of Ruby that we support. It may need to be conditionally executed. Our CI build runs the tests in all supported versions, but it doesn't run on branches of forks.

What version(s) have you tested in?

Copy link
Contributor Author

@tonyta tonyta Jul 20, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't quite work with Ruby < 2.5.0 because a pattern argument is passed to Enumerable#any? instead of a block. I'll change this example to ensure it can be run in earlier versions of Ruby.

Edit: I've made changes to ensure this works with Ruby versions 2.3, 2.4, 2.5, 2.6, and 2.7.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I copied your branch into a branch of our private mirror so I could run our own CI (I do think we will enable it for forks as you suggested, but in the meantime this is pretty easy for me to do). It's fine for 2.3-2.7, but we also support 2.2 and it doesn't work there because of the heredoc usage (<<~RUBY).

You could build a multi-line string in other ways, but it might be simpler to just break out the test script into a separate file, like launchdarkly-server-sdk_spec_autoloadtest.rb, and then have the test just do Kernel.system("ruby", "./spec/launchdarkly-server-sdk_spec_autoloadtest.rb"). I verified that this works in all of our supported versions (including JRuby).

@tonyta
Add test compatibility for in Ruby 2.3 and 2.4
d63def2 
Support for pattern arguments to Enumerable#any? wasn't added until
Ruby 2.5.0.

  https://bugs.ruby-lang.org/issues/11286
@tonyta
Copy link
Contributor Author

tonyta commented Jul 20, 2019 •
edited
Loading

I've made changes to the test and ensured that it run in the following versions of Ruby and Bundler:

Bundler 1.7.3 Bundler 2.0.2 Bundler 2.1.0.pre.1
Ruby 2.3.8 ✅ ✅
Ruby 2.4.6 ✅ ✅
Ruby 2.5.5 ✅ ✅
Ruby 2.6.3 ✅ ✅
Ruby 2.7.0-preview1 ✅ ✅ ✅

Why does the name of the repo matter?

It's small, but as an open source contributor, it's ideal for the repo and gem name to be consistent-ish. This makes it easier to Google for the project Github page and know what the project is after I've cloned it since git clone will put it into a directory with repo's name.

I understand that you have many repos for your SDKs in different languages, so one suggestion might be to name the repo using the gem's name with a -ruby suffix as Stripe, Bugsnag, and Twilio does.

Another suggestion is to run CI tests that run on all PRs, even those from forked repos. These are all just my personal preferences, but I think they are convenient and encouraging to contributors wishing to donate to your open source project.

@eli-darkly
Copy link
Contributor

This makes it easier to Google for the project Github page and know what the project is after I've cloned it since git clone will put it into a directory with repo's name.

I'm sorry but I don't understand what you mean by "know what the project is after I've cloned it." If you cloned it, then you cloned it from Github, so why would you need to Google for the project Github page? If you already have a checkout or fork of the repo, then you have all of the identifying information about the project. If you have the gem name but not the repo, there is a link to the Github page from the Rubygems page. And if you're just randomly looking for "LaunchDarkly Ruby SDK" then our documentation is the source of truth. I've never worked on an open-source project where I had to assume that the repo name was exactly the same as whatever the published build product is.

Another suggestion is to run CI tests that run on all PRs, even those from forked repos.

I actually wasn't aware it is possible to do that in CircleCI. I'm not sure if that capability was added after we started using CircleCI, or if there is any other reason why we weren't doing it, but I'll look into it; it'd certainly be useful.

@tonyta
Copy link
Contributor Author

tonyta commented Jul 22, 2019

And if you're just randomly looking for "LaunchDarkly Ruby SDK" then our documentation is the source of truth.

Fair enough. Originally, it was because of my unfamiliarity with the differences between the ruby-server-sdk and the api-client-ruby projects. Now that I understand it more, it makes sense. Thanks for the clarification. 😄

I actually wasn't aware it is possible to do that in CircleCI.

Me neither. I'm more used to seeing builds on TravisCI for open source projects. Here's a blog post about building from forks on CircleCI. I hadn't considered the security implications of running untrusted code, however. 😬

Anyway, I hope this tiny PR is helpful. We are super excited about using LaunchDarkly at Reflektive!

eli-darkly
eli-darkly suggested changes Jul 22, 2019
View reviewed changes
Copy link
Contributor

@eli-darkly eli-darkly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment about Ruby 2.2 compatibility.

@tonyta
Copy link
Contributor Author

tonyta commented Jul 23, 2019

Cool. I've made the changes you've suggested and confirmed that it works for Ruby 2.2 👍

Bundler 1.7.3 Bundler 2.0.2 Bundler 2.1.0.pre.1
Ruby 2.2.9 ✅
Ruby 2.3.8 ✅ ✅
Ruby 2.4.6 ✅ ✅
Ruby 2.5.5 ✅ ✅
Ruby 2.6.3 ✅ ✅
Ruby 2.7.0-preview1 ✅ ✅ ✅

eli-darkly
eli-darkly approved these changes Jul 23, 2019
View reviewed changes
Copy link
Contributor

@eli-darkly eli-darkly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! We should have a release out pretty soon - we try to expedite them when it's something like this that's an obvious usability issue.

@eli-darkly eli-darkly merged commit d2a02cc into launchdarkly:master Jul 23, 2019
@eli-darkly eli-darkly mentioned this pull request Jul 23, 2019
Merged
@eli-darkly
Copy link
Contributor

OK, 5.5.9 has been released with this fix.

LaunchDarklyCI pushed a commit that referenced this pull request May 4, 2020
@eli-darkly
tolerate nil value for user.custom (#137)
ad7cd7f
LaunchDarklyReleaseBot added a commit that referenced this pull request Mar 18, 2022
@LaunchDarklyReleaseBot @LaunchDarklyCI
@eli-darkly @hroederld @bwoskow-ld @jacobthemyth @apache-hb @ld-kyee @pellyg-ld @samstokes @ember-stevens @louis-launchdarkly @keelerm84 @belevy
prepare 6.3.2 release (#198)
f0a536c 
* fix doc comments

* add YARD config so our docs show up correctly everywhere

* don't need markup-provider option

* rm obsolete proxy param

* remove net-http-persistent

* fix concurrent-ruby usage that breaks on Windows

* add pipeline and clean up with with rm_rf instead of rm

* fix highlight blocks

* Hr/azure3 (#103)

* Add Consul and Redis services to Windows.
* Enable Consul and Redis testing

* add dynamo (#104)

* add experimentation event overrides for rules and fallthrough

* warn & don't send event if identify or track has no valid user

* include user in prereq flag events

* rm unnecessary logic

* more factory methods

* update readme to refer to docs

* add Ruby 2.6.2 to CI

* fix missing require for net/http

* stringify built-in user attributes in events, and secondary key for evals

* make const names consistent

* support metric value with track()

* update method description

* applying markdown templates and updating repository url references

* Cleaning up markdown files

* allow skipping database tests

* Updating the package name (#115)

* update package name

* missed one

* revert module entry point name change

* bump ld-eventsource version for stream logging fix

* use YAML.safe_load

* add unit test and temporarily revert fix to demonstrate failure

* restore fix

* add comment about not using FileDataSource in production

* drop events if inbox is full

* update doc comment for track with metric_value

* don't let user fall outside of last bucket in rollout

* refactor evaluation logic and move it out of the main namespace

* comments

* fix type coercion behavior

* make type coercion behavior consistent with earlier versions for now

* whitespace

* break up Evaluator tests further

* make EvaluationReason an immutable class

* FrozenError doesn't exist in older Ruby, use more general RuntimeError

* precompute evaluation reasons when we receive a flag

* rm unused

* rename FeatureStore to DataStore

* remove references to UpdateProcessor (now DataSource)

* add event payload ID header

* (6.0) drop support for old Ruby versions

* add Ruby version constraint to gemspec

* remove Rake dependency

* update ld-eventsource to 1.0.2 which doesn't have Rake dependency

* implement diagnostic events in Ruby (#130)

* update ruby-eventsource to 1.0.3 for backoff bug

* fix incorrect initialization of EventProcessor

* remove install-time openssl check that breaks if you don't have rake

* treat comparison with wrong data type as a non-match, not an exception (#134)

* fail fast for nil SDK key when appropriate

* tolerate nil value for user.custom (#137)

* Only shutdown the Redis pool if it is owned by the SDK (#158)

* Only shutdown a Redis pool created by SDK

* Make pool shutdown behavior an option

* improve doc comment

* remove support for indirect/patch and indirect/put (#138)

* update to json 2.3.1 (#139)

* update json dep to 2.3.x to fix CVE

* add publication of API docs on GitHub Pages (#143)

* try fixing release metadata

* update the default base url (#144)

* revert renames of feature_store & update_processor

* [ch92483] Use http gem and add socket factory support (#142)

* update dependencies and add CI for ruby 3 (#141)

* reference eventsource 2.0 in gemspec

* add 5.x releasable branch for releaser

* use Ruby 2.6.6 in releases

* Removed the guides link

* [ch99757] add alias method (#147)

* don't send event for nil user evaluation

* remove lockfile (#148)

* rm redundant nil check

* Experiment Allocation Changes (#150)

* WIP - from sam's pairing session

* starting sdk changes

* adding tests and making sure everything works

* adding more tests

* removing the singleton for fallthrough

* Revert "removing the singleton for fallthrough"

This reverts commit dff7adbb809ecc63118d0fbff9742a88a039c679.

* taking a different approach to keep things immutable

* adding tests for untracked

* remove unnecessary comment

* making sure to return two values in all code paths

Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>

* Use camelCase for JSON property names (#151)

The in_experiment attribute was added to reasons as part of #150 but it doesn't appear to be received in events. I think that's because it's sending it in JSON as "in_experiment" rather than "inExperiment" as we expect to parse it.

* fixing ruby logic causing ih failures (#152)

* fixing ruby logic

* adding missing spec

* Apply suggestions from code review

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* pr tweaks

* making spec language consistent

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* add log warning for missing user key (#153)

* add log warnings for nil/empty user key

* rm warning for empty string key

* fix test

* diagnostic events should respect HTTPS_PROXY (#154)

* minor test simplification (#155)

* allow higher minor versions of json and http gems

* allow v5.x of http gem (#157)

* use Bundler 2.2.10 + modernize CI config (#158)

* enable verbose rspec output

* fix socket factory tests

* restore log suppression

* Replacing deprecated circleci image usage (#159)

* use Releaser v2 config (#161)

* Updates docs URLs

* Update lib/ldclient-rb/ldclient.rb

Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>

* remove reliance on git in gemspec (#163)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504 (#164)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504

* comment phrasing

* Start work on flag builder.

* Add user targeting and rule builder

* Add datasource implementation

* Convert the current_flags hash to use symbols instead of strings as keys

* Fix typo on FlagRuleBuilder copy constructor

* minor refactoring of impl; Added use of new Clause struct instead of Hash in FlagRuleBuilder; Moved TestData.factory out of Impl namespace and renamed Impl to TestDataImpl

* Add the doc comments

* (big segments 1) add public config/interface/reason types (#167)

* Cleanup docstrings to be YARD docs

* Added Util.is_bool helper function to clean up the check for whether an object is a boolean; Removed the DeepCopyHash/DeepCopyArray objects in favor of deep_copy_hash and deep_copy_array functions

* Move public classes out of Impl namespace. Most of it is in public namespace except for the data source now.

* Move require of concurrent/atomics to the correct module

* (big segments 2) implement Big Segments evaluation & status APIs (#168)

* improve CONTRIBUTING.md with notes on code organization

* add note about doc comments

* Cleanup YARD warnings and cleanup docs

* Address PR feedback: Move is_bool back to Impl namespace to avoid confusion; Remove unnecessary nil check on variations in build function; fixup comments

* (big segments 3) implement Redis & DynamoDB big segment stores (#169)

* add missing import

* fix stale calculation

* fix big segments user hash algorithm to use SHA256

* improve & refactor client/evaluation tests

* more cleanup/DRY

* add use_preconfigured_flag and use_preconfigured_segment to TestData (#173)

* always cache big segment query result even if it's nil

* comments

* add test for cache expiration

* use TestData in our own tests (#174)

* use TestData in our own tests

* fix test

* replace LaunchDarkly::FileDataSource with LaunchDarkly::Integrations::FileData

* update ruby-eventsource version for recent SSE fixes

* Bump bundler version (#184)

* Add ability to to set initial reconnect delay (#183)

* Treat secondary as a built-in attribute (#180)

* all_flags_state is invalid if store isn't initialized (#182)

* identify should not emit events if user key is "" (#181)

* Account for traffic allocation on all flags (#185)

* Add contract tests (#178)

* Fix string interpolation in log message (#187)

* Default opts to empty hash when creating persistent feature store (#186)

* Remove Hakiri badge from README (#188)

Hakiri was sunset on January 31st, 2022 at which time our badge stopped
working.

* detect http/https proxy env vars when creating HTTP clients

* rever accidental change

Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com>
Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: Harpo roeder <hroeder@launchdarkly.com>
Co-authored-by: hroederld <46500128+hroederld@users.noreply.github.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: Jacob Smith <jacob@jacobsmith.io>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Kerrie Martinez <kyee@launchdarkly.com>
Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>
Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Ember Stevens <ember.stevens@launchdarkly.com>
Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Matthew M. Keeler <keelerm84@gmail.com>
Co-authored-by: Ben Levy <benjaminlevy007@gmail.com>
Co-authored-by: Ben Levy <ben@foxhound.systems>
Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>
LaunchDarklyReleaseBot added a commit that referenced this pull request Jun 15, 2022
@LaunchDarklyReleaseBot @eli-darkly
@hroederld @bwoskow-ld @LaunchDarklyCI @jacobthemyth @apache-hb @ld-kyee @pellyg-ld @samstokes @ember-stevens @louis-launchdarkly @keelerm84 @belevy
prepare 6.3.3 release (#201)
dc9510d 
* rm obsolete proxy param

* remove net-http-persistent

* fix concurrent-ruby usage that breaks on Windows

* add pipeline and clean up with with rm_rf instead of rm

* fix highlight blocks

* Hr/azure3 (#103)

* Add Consul and Redis services to Windows.
* Enable Consul and Redis testing

* add dynamo (#104)

* add experimentation event overrides for rules and fallthrough

* warn & don't send event if identify or track has no valid user

* include user in prereq flag events

* rm unnecessary logic

* more factory methods

* update readme to refer to docs

* add Ruby 2.6.2 to CI

* fix missing require for net/http

* stringify built-in user attributes in events, and secondary key for evals

* make const names consistent

* support metric value with track()

* update method description

* applying markdown templates and updating repository url references

* Cleaning up markdown files

* allow skipping database tests

* Updating the package name (#115)

* update package name

* missed one

* revert module entry point name change

* bump ld-eventsource version for stream logging fix

* use YAML.safe_load

* add unit test and temporarily revert fix to demonstrate failure

* restore fix

* add comment about not using FileDataSource in production

* drop events if inbox is full

* update doc comment for track with metric_value

* don't let user fall outside of last bucket in rollout

* refactor evaluation logic and move it out of the main namespace

* comments

* fix type coercion behavior

* make type coercion behavior consistent with earlier versions for now

* whitespace

* break up Evaluator tests further

* make EvaluationReason an immutable class

* FrozenError doesn't exist in older Ruby, use more general RuntimeError

* precompute evaluation reasons when we receive a flag

* rm unused

* rename FeatureStore to DataStore

* remove references to UpdateProcessor (now DataSource)

* add event payload ID header

* (6.0) drop support for old Ruby versions

* add Ruby version constraint to gemspec

* remove Rake dependency

* update ld-eventsource to 1.0.2 which doesn't have Rake dependency

* implement diagnostic events in Ruby (#130)

* update ruby-eventsource to 1.0.3 for backoff bug

* fix incorrect initialization of EventProcessor

* remove install-time openssl check that breaks if you don't have rake

* treat comparison with wrong data type as a non-match, not an exception (#134)

* fail fast for nil SDK key when appropriate

* tolerate nil value for user.custom (#137)

* Only shutdown the Redis pool if it is owned by the SDK (#158)

* Only shutdown a Redis pool created by SDK

* Make pool shutdown behavior an option

* improve doc comment

* remove support for indirect/patch and indirect/put (#138)

* update to json 2.3.1 (#139)

* update json dep to 2.3.x to fix CVE

* add publication of API docs on GitHub Pages (#143)

* try fixing release metadata

* update the default base url (#144)

* revert renames of feature_store & update_processor

* [ch92483] Use http gem and add socket factory support (#142)

* update dependencies and add CI for ruby 3 (#141)

* reference eventsource 2.0 in gemspec

* add 5.x releasable branch for releaser

* use Ruby 2.6.6 in releases

* Removed the guides link

* [ch99757] add alias method (#147)

* don't send event for nil user evaluation

* remove lockfile (#148)

* rm redundant nil check

* Experiment Allocation Changes (#150)

* WIP - from sam's pairing session

* starting sdk changes

* adding tests and making sure everything works

* adding more tests

* removing the singleton for fallthrough

* Revert "removing the singleton for fallthrough"

This reverts commit dff7adbb809ecc63118d0fbff9742a88a039c679.

* taking a different approach to keep things immutable

* adding tests for untracked

* remove unnecessary comment

* making sure to return two values in all code paths

Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>

* Use camelCase for JSON property names (#151)

The in_experiment attribute was added to reasons as part of #150 but it doesn't appear to be received in events. I think that's because it's sending it in JSON as "in_experiment" rather than "inExperiment" as we expect to parse it.

* fixing ruby logic causing ih failures (#152)

* fixing ruby logic

* adding missing spec

* Apply suggestions from code review

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* pr tweaks

* making spec language consistent

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* add log warning for missing user key (#153)

* add log warnings for nil/empty user key

* rm warning for empty string key

* fix test

* diagnostic events should respect HTTPS_PROXY (#154)

* minor test simplification (#155)

* allow higher minor versions of json and http gems

* allow v5.x of http gem (#157)

* use Bundler 2.2.10 + modernize CI config (#158)

* enable verbose rspec output

* fix socket factory tests

* restore log suppression

* Replacing deprecated circleci image usage (#159)

* use Releaser v2 config (#161)

* Updates docs URLs

* Update lib/ldclient-rb/ldclient.rb

Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>

* remove reliance on git in gemspec (#163)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504 (#164)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504

* comment phrasing

* Start work on flag builder.

* Add user targeting and rule builder

* Add datasource implementation

* Convert the current_flags hash to use symbols instead of strings as keys

* Fix typo on FlagRuleBuilder copy constructor

* minor refactoring of impl; Added use of new Clause struct instead of Hash in FlagRuleBuilder; Moved TestData.factory out of Impl namespace and renamed Impl to TestDataImpl

* Add the doc comments

* (big segments 1) add public config/interface/reason types (#167)

* Cleanup docstrings to be YARD docs

* Added Util.is_bool helper function to clean up the check for whether an object is a boolean; Removed the DeepCopyHash/DeepCopyArray objects in favor of deep_copy_hash and deep_copy_array functions

* Move public classes out of Impl namespace. Most of it is in public namespace except for the data source now.

* Move require of concurrent/atomics to the correct module

* (big segments 2) implement Big Segments evaluation & status APIs (#168)

* improve CONTRIBUTING.md with notes on code organization

* add note about doc comments

* Cleanup YARD warnings and cleanup docs

* Address PR feedback: Move is_bool back to Impl namespace to avoid confusion; Remove unnecessary nil check on variations in build function; fixup comments

* (big segments 3) implement Redis & DynamoDB big segment stores (#169)

* add missing import

* fix stale calculation

* fix big segments user hash algorithm to use SHA256

* improve & refactor client/evaluation tests

* more cleanup/DRY

* add use_preconfigured_flag and use_preconfigured_segment to TestData (#173)

* always cache big segment query result even if it's nil

* comments

* add test for cache expiration

* use TestData in our own tests (#174)

* use TestData in our own tests

* fix test

* replace LaunchDarkly::FileDataSource with LaunchDarkly::Integrations::FileData

* update ruby-eventsource version for recent SSE fixes

* Bump bundler version (#184)

* Add ability to to set initial reconnect delay (#183)

* Treat secondary as a built-in attribute (#180)

* all_flags_state is invalid if store isn't initialized (#182)

* identify should not emit events if user key is "" (#181)

* Account for traffic allocation on all flags (#185)

* Add contract tests (#178)

* Fix string interpolation in log message (#187)

* Default opts to empty hash when creating persistent feature store (#186)

* Remove Hakiri badge from README (#188)

Hakiri was sunset on January 31st, 2022 at which time our badge stopped
working.

* detect http/https proxy env vars when creating HTTP clients

* rever accidental change

* fix nil safety in test service config

* master -> main (#190)

* master -> main

* update ruby-eventsource version for parsing efficiency fix

Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: Harpo roeder <hroeder@launchdarkly.com>
Co-authored-by: hroederld <46500128+hroederld@users.noreply.github.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com>
Co-authored-by: Jacob Smith <jacob@jacobsmith.io>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Kerrie Martinez <kyee@launchdarkly.com>
Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>
Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Ember Stevens <ember.stevens@launchdarkly.com>
Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Matthew M. Keeler <keelerm84@gmail.com>
Co-authored-by: Ben Levy <benjaminlevy007@gmail.com>
Co-authored-by: Ben Levy <ben@foxhound.systems>
Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>
LaunchDarklyReleaseBot added a commit that referenced this pull request Jun 30, 2022
@LaunchDarklyReleaseBot @eli-darkly
@hroederld @bwoskow-ld @LaunchDarklyCI @jacobthemyth @apache-hb @ld-kyee @pellyg-ld @samstokes @ember-stevens @louis-launchdarkly @keelerm84 @belevy
prepare 6.3.4 release (#203)
bacde03 
* remove net-http-persistent

* fix concurrent-ruby usage that breaks on Windows

* add pipeline and clean up with with rm_rf instead of rm

* fix highlight blocks

* Hr/azure3 (#103)

* Add Consul and Redis services to Windows.
* Enable Consul and Redis testing

* add dynamo (#104)

* add experimentation event overrides for rules and fallthrough

* warn & don't send event if identify or track has no valid user

* include user in prereq flag events

* rm unnecessary logic

* more factory methods

* update readme to refer to docs

* add Ruby 2.6.2 to CI

* fix missing require for net/http

* stringify built-in user attributes in events, and secondary key for evals

* make const names consistent

* support metric value with track()

* update method description

* applying markdown templates and updating repository url references

* Cleaning up markdown files

* allow skipping database tests

* Updating the package name (#115)

* update package name

* missed one

* revert module entry point name change

* bump ld-eventsource version for stream logging fix

* use YAML.safe_load

* add unit test and temporarily revert fix to demonstrate failure

* restore fix

* add comment about not using FileDataSource in production

* drop events if inbox is full

* update doc comment for track with metric_value

* don't let user fall outside of last bucket in rollout

* refactor evaluation logic and move it out of the main namespace

* comments

* fix type coercion behavior

* make type coercion behavior consistent with earlier versions for now

* whitespace

* break up Evaluator tests further

* make EvaluationReason an immutable class

* FrozenError doesn't exist in older Ruby, use more general RuntimeError

* precompute evaluation reasons when we receive a flag

* rm unused

* rename FeatureStore to DataStore

* remove references to UpdateProcessor (now DataSource)

* add event payload ID header

* (6.0) drop support for old Ruby versions

* add Ruby version constraint to gemspec

* remove Rake dependency

* update ld-eventsource to 1.0.2 which doesn't have Rake dependency

* implement diagnostic events in Ruby (#130)

* update ruby-eventsource to 1.0.3 for backoff bug

* fix incorrect initialization of EventProcessor

* remove install-time openssl check that breaks if you don't have rake

* treat comparison with wrong data type as a non-match, not an exception (#134)

* fail fast for nil SDK key when appropriate

* tolerate nil value for user.custom (#137)

* Only shutdown the Redis pool if it is owned by the SDK (#158)

* Only shutdown a Redis pool created by SDK

* Make pool shutdown behavior an option

* improve doc comment

* remove support for indirect/patch and indirect/put (#138)

* update to json 2.3.1 (#139)

* update json dep to 2.3.x to fix CVE

* add publication of API docs on GitHub Pages (#143)

* try fixing release metadata

* update the default base url (#144)

* revert renames of feature_store & update_processor

* [ch92483] Use http gem and add socket factory support (#142)

* update dependencies and add CI for ruby 3 (#141)

* reference eventsource 2.0 in gemspec

* add 5.x releasable branch for releaser

* use Ruby 2.6.6 in releases

* Removed the guides link

* [ch99757] add alias method (#147)

* don't send event for nil user evaluation

* remove lockfile (#148)

* rm redundant nil check

* Experiment Allocation Changes (#150)

* WIP - from sam's pairing session

* starting sdk changes

* adding tests and making sure everything works

* adding more tests

* removing the singleton for fallthrough

* Revert "removing the singleton for fallthrough"

This reverts commit dff7adbb809ecc63118d0fbff9742a88a039c679.

* taking a different approach to keep things immutable

* adding tests for untracked

* remove unnecessary comment

* making sure to return two values in all code paths

Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>

* Use camelCase for JSON property names (#151)

The in_experiment attribute was added to reasons as part of #150 but it doesn't appear to be received in events. I think that's because it's sending it in JSON as "in_experiment" rather than "inExperiment" as we expect to parse it.

* fixing ruby logic causing ih failures (#152)

* fixing ruby logic

* adding missing spec

* Apply suggestions from code review

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* pr tweaks

* making spec language consistent

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* add log warning for missing user key (#153)

* add log warnings for nil/empty user key

* rm warning for empty string key

* fix test

* diagnostic events should respect HTTPS_PROXY (#154)

* minor test simplification (#155)

* allow higher minor versions of json and http gems

* allow v5.x of http gem (#157)

* use Bundler 2.2.10 + modernize CI config (#158)

* enable verbose rspec output

* fix socket factory tests

* restore log suppression

* Replacing deprecated circleci image usage (#159)

* use Releaser v2 config (#161)

* Updates docs URLs

* Update lib/ldclient-rb/ldclient.rb

Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>

* remove reliance on git in gemspec (#163)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504 (#164)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504

* comment phrasing

* Start work on flag builder.

* Add user targeting and rule builder

* Add datasource implementation

* Convert the current_flags hash to use symbols instead of strings as keys

* Fix typo on FlagRuleBuilder copy constructor

* minor refactoring of impl; Added use of new Clause struct instead of Hash in FlagRuleBuilder; Moved TestData.factory out of Impl namespace and renamed Impl to TestDataImpl

* Add the doc comments

* (big segments 1) add public config/interface/reason types (#167)

* Cleanup docstrings to be YARD docs

* Added Util.is_bool helper function to clean up the check for whether an object is a boolean; Removed the DeepCopyHash/DeepCopyArray objects in favor of deep_copy_hash and deep_copy_array functions

* Move public classes out of Impl namespace. Most of it is in public namespace except for the data source now.

* Move require of concurrent/atomics to the correct module

* (big segments 2) implement Big Segments evaluation & status APIs (#168)

* improve CONTRIBUTING.md with notes on code organization

* add note about doc comments

* Cleanup YARD warnings and cleanup docs

* Address PR feedback: Move is_bool back to Impl namespace to avoid confusion; Remove unnecessary nil check on variations in build function; fixup comments

* (big segments 3) implement Redis & DynamoDB big segment stores (#169)

* add missing import

* fix stale calculation

* fix big segments user hash algorithm to use SHA256

* improve & refactor client/evaluation tests

* more cleanup/DRY

* add use_preconfigured_flag and use_preconfigured_segment to TestData (#173)

* always cache big segment query result even if it's nil

* comments

* add test for cache expiration

* use TestData in our own tests (#174)

* use TestData in our own tests

* fix test

* replace LaunchDarkly::FileDataSource with LaunchDarkly::Integrations::FileData

* update ruby-eventsource version for recent SSE fixes

* Bump bundler version (#184)

* Add ability to to set initial reconnect delay (#183)

* Treat secondary as a built-in attribute (#180)

* all_flags_state is invalid if store isn't initialized (#182)

* identify should not emit events if user key is "" (#181)

* Account for traffic allocation on all flags (#185)

* Add contract tests (#178)

* Fix string interpolation in log message (#187)

* Default opts to empty hash when creating persistent feature store (#186)

* Remove Hakiri badge from README (#188)

Hakiri was sunset on January 31st, 2022 at which time our badge stopped
working.

* detect http/https proxy env vars when creating HTTP clients

* rever accidental change

* fix nil safety in test service config

* master -> main (#190)

* master -> main

* update ruby-eventsource version for parsing efficiency fix

* miscellaneous optimizations for event processing (#193)

Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: Harpo roeder <hroeder@launchdarkly.com>
Co-authored-by: hroederld <46500128+hroederld@users.noreply.github.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com>
Co-authored-by: Jacob Smith <jacob@jacobsmith.io>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Kerrie Martinez <kyee@launchdarkly.com>
Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>
Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Ember Stevens <ember.stevens@launchdarkly.com>
Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Matthew M. Keeler <keelerm84@gmail.com>
Co-authored-by: Ben Levy <benjaminlevy007@gmail.com>
Co-authored-by: Ben Levy <ben@foxhound.systems>
Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>
eli-darkly added a commit that referenced this pull request Sep 7, 2022
@LaunchDarklyReleaseBot @hroederld
@eli-darkly @bwoskow-ld @LaunchDarklyCI @jacobthemyth @apache-hb @ld-kyee @pellyg-ld @samstokes @ember-stevens @louis-launchdarkly @keelerm84 @belevy
prepare 6.4.0 release (#205)
aa266b6 
* Hr/azure3 (#103)

* Add Consul and Redis services to Windows.
* Enable Consul and Redis testing

* add dynamo (#104)

* add experimentation event overrides for rules and fallthrough

* warn & don't send event if identify or track has no valid user

* include user in prereq flag events

* rm unnecessary logic

* more factory methods

* update readme to refer to docs

* add Ruby 2.6.2 to CI

* fix missing require for net/http

* stringify built-in user attributes in events, and secondary key for evals

* make const names consistent

* support metric value with track()

* update method description

* applying markdown templates and updating repository url references

* Cleaning up markdown files

* allow skipping database tests

* Updating the package name (#115)

* update package name

* missed one

* revert module entry point name change

* bump ld-eventsource version for stream logging fix

* use YAML.safe_load

* add unit test and temporarily revert fix to demonstrate failure

* restore fix

* add comment about not using FileDataSource in production

* drop events if inbox is full

* update doc comment for track with metric_value

* don't let user fall outside of last bucket in rollout

* refactor evaluation logic and move it out of the main namespace

* comments

* fix type coercion behavior

* make type coercion behavior consistent with earlier versions for now

* whitespace

* break up Evaluator tests further

* make EvaluationReason an immutable class

* FrozenError doesn't exist in older Ruby, use more general RuntimeError

* precompute evaluation reasons when we receive a flag

* rm unused

* rename FeatureStore to DataStore

* remove references to UpdateProcessor (now DataSource)

* add event payload ID header

* (6.0) drop support for old Ruby versions

* add Ruby version constraint to gemspec

* remove Rake dependency

* update ld-eventsource to 1.0.2 which doesn't have Rake dependency

* implement diagnostic events in Ruby (#130)

* update ruby-eventsource to 1.0.3 for backoff bug

* fix incorrect initialization of EventProcessor

* remove install-time openssl check that breaks if you don't have rake

* treat comparison with wrong data type as a non-match, not an exception (#134)

* fail fast for nil SDK key when appropriate

* tolerate nil value for user.custom (#137)

* Only shutdown the Redis pool if it is owned by the SDK (#158)

* Only shutdown a Redis pool created by SDK

* Make pool shutdown behavior an option

* improve doc comment

* remove support for indirect/patch and indirect/put (#138)

* update to json 2.3.1 (#139)

* update json dep to 2.3.x to fix CVE

* add publication of API docs on GitHub Pages (#143)

* try fixing release metadata

* update the default base url (#144)

* revert renames of feature_store & update_processor

* [ch92483] Use http gem and add socket factory support (#142)

* update dependencies and add CI for ruby 3 (#141)

* reference eventsource 2.0 in gemspec

* add 5.x releasable branch for releaser

* use Ruby 2.6.6 in releases

* Removed the guides link

* [ch99757] add alias method (#147)

* don't send event for nil user evaluation

* remove lockfile (#148)

* rm redundant nil check

* Experiment Allocation Changes (#150)

* WIP - from sam's pairing session

* starting sdk changes

* adding tests and making sure everything works

* adding more tests

* removing the singleton for fallthrough

* Revert "removing the singleton for fallthrough"

This reverts commit dff7adbb809ecc63118d0fbff9742a88a039c679.

* taking a different approach to keep things immutable

* adding tests for untracked

* remove unnecessary comment

* making sure to return two values in all code paths

Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>

* Use camelCase for JSON property names (#151)

The in_experiment attribute was added to reasons as part of #150 but it doesn't appear to be received in events. I think that's because it's sending it in JSON as "in_experiment" rather than "inExperiment" as we expect to parse it.

* fixing ruby logic causing ih failures (#152)

* fixing ruby logic

* adding missing spec

* Apply suggestions from code review

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* pr tweaks

* making spec language consistent

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* add log warning for missing user key (#153)

* add log warnings for nil/empty user key

* rm warning for empty string key

* fix test

* diagnostic events should respect HTTPS_PROXY (#154)

* minor test simplification (#155)

* allow higher minor versions of json and http gems

* allow v5.x of http gem (#157)

* use Bundler 2.2.10 + modernize CI config (#158)

* enable verbose rspec output

* fix socket factory tests

* restore log suppression

* Replacing deprecated circleci image usage (#159)

* use Releaser v2 config (#161)

* Updates docs URLs

* Update lib/ldclient-rb/ldclient.rb

Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>

* remove reliance on git in gemspec (#163)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504 (#164)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504

* comment phrasing

* Start work on flag builder.

* Add user targeting and rule builder

* Add datasource implementation

* Convert the current_flags hash to use symbols instead of strings as keys

* Fix typo on FlagRuleBuilder copy constructor

* minor refactoring of impl; Added use of new Clause struct instead of Hash in FlagRuleBuilder; Moved TestData.factory out of Impl namespace and renamed Impl to TestDataImpl

* Add the doc comments

* (big segments 1) add public config/interface/reason types (#167)

* Cleanup docstrings to be YARD docs

* Added Util.is_bool helper function to clean up the check for whether an object is a boolean; Removed the DeepCopyHash/DeepCopyArray objects in favor of deep_copy_hash and deep_copy_array functions

* Move public classes out of Impl namespace. Most of it is in public namespace except for the data source now.

* Move require of concurrent/atomics to the correct module

* (big segments 2) implement Big Segments evaluation & status APIs (#168)

* improve CONTRIBUTING.md with notes on code organization

* add note about doc comments

* Cleanup YARD warnings and cleanup docs

* Address PR feedback: Move is_bool back to Impl namespace to avoid confusion; Remove unnecessary nil check on variations in build function; fixup comments

* (big segments 3) implement Redis & DynamoDB big segment stores (#169)

* add missing import

* fix stale calculation

* fix big segments user hash algorithm to use SHA256

* improve & refactor client/evaluation tests

* more cleanup/DRY

* add use_preconfigured_flag and use_preconfigured_segment to TestData (#173)

* always cache big segment query result even if it's nil

* comments

* add test for cache expiration

* use TestData in our own tests (#174)

* use TestData in our own tests

* fix test

* replace LaunchDarkly::FileDataSource with LaunchDarkly::Integrations::FileData

* update ruby-eventsource version for recent SSE fixes

* Bump bundler version (#184)

* Add ability to to set initial reconnect delay (#183)

* Treat secondary as a built-in attribute (#180)

* all_flags_state is invalid if store isn't initialized (#182)

* identify should not emit events if user key is "" (#181)

* Account for traffic allocation on all flags (#185)

* Add contract tests (#178)

* Fix string interpolation in log message (#187)

* Default opts to empty hash when creating persistent feature store (#186)

* Remove Hakiri badge from README (#188)

Hakiri was sunset on January 31st, 2022 at which time our badge stopped
working.

* detect http/https proxy env vars when creating HTTP clients

* rever accidental change

* fix nil safety in test service config

* master -> main (#190)

* master -> main

* update ruby-eventsource version for parsing efficiency fix

* miscellaneous optimizations for event processing (#193)

* Add polling support for contract test service (#198)

* Add windows tests in circleci (#199)

At some point in the past, we were experimenting with using Azure to
verify Window builds. Now that CircleCI supports Windows, we should keep
everything on a single CI provider.

* Add application info support (#194)

* reuse EvaluationDetail instances by precomputing results

Co-authored-by: hroederld <46500128+hroederld@users.noreply.github.com>
Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com>
Co-authored-by: Jacob Smith <jacob@jacobsmith.io>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: hroederld <hroeder@launchdarkly.com>
Co-authored-by: Kerrie Martinez <kyee@launchdarkly.com>
Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>
Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Ember Stevens <ember.stevens@launchdarkly.com>
Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Matthew M. Keeler <keelerm84@gmail.com>
Co-authored-by: Ben Levy <benjaminlevy007@gmail.com>
Co-authored-by: Ben Levy <ben@foxhound.systems>
Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
LaunchDarklyReleaseBot added a commit that referenced this pull request Dec 30, 2022
@LaunchDarklyReleaseBot @eli-darkly
@bwoskow-ld @LaunchDarklyCI @jacobthemyth @apache-hb @hroederld @ld-kyee @pellyg-ld @samstokes @ember-stevens @louis-launchdarkly @keelerm84 @belevy
prepare 7.0.0 release (#207)
010e258 
* don't let user fall outside of last bucket in rollout

* refactor evaluation logic and move it out of the main namespace

* comments

* fix type coercion behavior

* make type coercion behavior consistent with earlier versions for now

* whitespace

* break up Evaluator tests further

* make EvaluationReason an immutable class

* FrozenError doesn't exist in older Ruby, use more general RuntimeError

* precompute evaluation reasons when we receive a flag

* rm unused

* rename FeatureStore to DataStore

* remove references to UpdateProcessor (now DataSource)

* add event payload ID header

* (6.0) drop support for old Ruby versions

* add Ruby version constraint to gemspec

* remove Rake dependency

* update ld-eventsource to 1.0.2 which doesn't have Rake dependency

* implement diagnostic events in Ruby (#130)

* update ruby-eventsource to 1.0.3 for backoff bug

* fix incorrect initialization of EventProcessor

* remove install-time openssl check that breaks if you don't have rake

* treat comparison with wrong data type as a non-match, not an exception (#134)

* fail fast for nil SDK key when appropriate

* tolerate nil value for user.custom (#137)

* Only shutdown the Redis pool if it is owned by the SDK (#158)

* Only shutdown a Redis pool created by SDK

* Make pool shutdown behavior an option

* improve doc comment

* remove support for indirect/patch and indirect/put (#138)

* update to json 2.3.1 (#139)

* update json dep to 2.3.x to fix CVE

* add publication of API docs on GitHub Pages (#143)

* try fixing release metadata

* update the default base url (#144)

* revert renames of feature_store & update_processor

* [ch92483] Use http gem and add socket factory support (#142)

* update dependencies and add CI for ruby 3 (#141)

* reference eventsource 2.0 in gemspec

* add 5.x releasable branch for releaser

* use Ruby 2.6.6 in releases

* Removed the guides link

* [ch99757] add alias method (#147)

* don't send event for nil user evaluation

* remove lockfile (#148)

* rm redundant nil check

* Experiment Allocation Changes (#150)

* WIP - from sam's pairing session

* starting sdk changes

* adding tests and making sure everything works

* adding more tests

* removing the singleton for fallthrough

* Revert "removing the singleton for fallthrough"

This reverts commit dff7adbb809ecc63118d0fbff9742a88a039c679.

* taking a different approach to keep things immutable

* adding tests for untracked

* remove unnecessary comment

* making sure to return two values in all code paths

Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>

* Use camelCase for JSON property names (#151)

The in_experiment attribute was added to reasons as part of #150 but it doesn't appear to be received in events. I think that's because it's sending it in JSON as "in_experiment" rather than "inExperiment" as we expect to parse it.

* fixing ruby logic causing ih failures (#152)

* fixing ruby logic

* adding missing spec

* Apply suggestions from code review

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* pr tweaks

* making spec language consistent

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* add log warning for missing user key (#153)

* add log warnings for nil/empty user key

* rm warning for empty string key

* fix test

* diagnostic events should respect HTTPS_PROXY (#154)

* minor test simplification (#155)

* allow higher minor versions of json and http gems

* allow v5.x of http gem (#157)

* use Bundler 2.2.10 + modernize CI config (#158)

* enable verbose rspec output

* fix socket factory tests

* restore log suppression

* Replacing deprecated circleci image usage (#159)

* use Releaser v2 config (#161)

* Updates docs URLs

* Update lib/ldclient-rb/ldclient.rb

Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>

* remove reliance on git in gemspec (#163)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504 (#164)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504

* comment phrasing

* Start work on flag builder.

* Add user targeting and rule builder

* Add datasource implementation

* Convert the current_flags hash to use symbols instead of strings as keys

* Fix typo on FlagRuleBuilder copy constructor

* minor refactoring of impl; Added use of new Clause struct instead of Hash in FlagRuleBuilder; Moved TestData.factory out of Impl namespace and renamed Impl to TestDataImpl

* Add the doc comments

* (big segments 1) add public config/interface/reason types (#167)

* Cleanup docstrings to be YARD docs

* Added Util.is_bool helper function to clean up the check for whether an object is a boolean; Removed the DeepCopyHash/DeepCopyArray objects in favor of deep_copy_hash and deep_copy_array functions

* Move public classes out of Impl namespace. Most of it is in public namespace except for the data source now.

* Move require of concurrent/atomics to the correct module

* (big segments 2) implement Big Segments evaluation & status APIs (#168)

* improve CONTRIBUTING.md with notes on code organization

* add note about doc comments

* Cleanup YARD warnings and cleanup docs

* Address PR feedback: Move is_bool back to Impl namespace to avoid confusion; Remove unnecessary nil check on variations in build function; fixup comments

* (big segments 3) implement Redis & DynamoDB big segment stores (#169)

* add missing import

* fix stale calculation

* fix big segments user hash algorithm to use SHA256

* improve & refactor client/evaluation tests

* more cleanup/DRY

* add use_preconfigured_flag and use_preconfigured_segment to TestData (#173)

* always cache big segment query result even if it's nil

* comments

* add test for cache expiration

* use TestData in our own tests (#174)

* use TestData in our own tests

* fix test

* replace LaunchDarkly::FileDataSource with LaunchDarkly::Integrations::FileData

* update ruby-eventsource version for recent SSE fixes

* Bump bundler version (#184)

* Add ability to to set initial reconnect delay (#183)

* Treat secondary as a built-in attribute (#180)

* all_flags_state is invalid if store isn't initialized (#182)

* identify should not emit events if user key is "" (#181)

* Account for traffic allocation on all flags (#185)

* Add contract tests (#178)

* Fix string interpolation in log message (#187)

* Default opts to empty hash when creating persistent feature store (#186)

* Remove Hakiri badge from README (#188)

Hakiri was sunset on January 31st, 2022 at which time our badge stopped
working.

* detect http/https proxy env vars when creating HTTP clients

* rever accidental change

* fix nil safety in test service config

* master -> main (#190)

* master -> main

* update ruby-eventsource version for parsing efficiency fix

* miscellaneous optimizations for event processing (#193)

* Drop support for EOL ruby versions (#196)

Ruby 2.5 was EOL 2021-04-05

As of June 27th, 2022, the latest jRuby is Ruby 2.6 compatible.

* Remove alias support (#195)

* Add polling support for contract test service (#198)

* Update rubocop and enable in CI (#197)

Several of the Rubocop cop definitions have been renamed or moved to
entirely other gems. This brings the configuration up to date with the
latest naming conventions.

* Add windows tests in circleci (#199)

At some point in the past, we were experimenting with using Azure to
verify Window builds. Now that CircleCI supports Windows, we should keep
everything on a single CI provider.

* Add application info support (#194)

* reuse EvaluationDetail instances by precomputing results

* rubocop reformatting

* add super constructor calls

* disable rubocop Rails rules and fix some remaining syntax offenses

* fix super calls

* Add big segment support to contract tests (#201)

* Initial creation of LDContext (#206)

This introduces the initial structure and usage of the LDContext class.

Instances of this class are expected to be created through static
factory methods:

```ruby
LaunchDarkly::LDContext.create({...})
LaunchDarkly::LDContext.create_multi([...])
```

This class is not completed yet. Rather, this initial commit is focused
on the creation patterns and the most basic operations. Subsequent
commits will continue fleshing out this class and its operation.

The `get_value` method will see significant changes as we introduce
attribute reference support. Its current more simplistic implementation
exists only to serve some interim unit tests.

* Add reference based value retrieval (#207)

This commit introduces the References type used for targeting complex
attributes in the new LDContexts.

References are expected to be created through static factory methods:

```ruby
LaunchDarkly::Reference.create("/a/b")
LaunchDarkly::Reference.create_literal("/a/b")
```

These references can be used to retrieve values from an existing
LDContext

```ruby
ref = LaunchDarkly::Reference.create("/a/b")
result = context.get_value_for_reference(ref)
```

* Basic changes to use contexts in evaluations instead of users (#208)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

This replaces `LDUser` with `LDContext` in the parameters for
evaluations, and makes the minimum necessary adjustments to allow
evaluations to keep working as before as long as the context kind is
"user". None of the new behavior defined in the U2C spec is implemented
yet.

Generation of evaluation events is temporarily disabled because the
event logic hasn't been updated yet.

U2C contract tests for evaluations are partially enabled; a lot of
functionality is still missing, but all the tests that only cover
previously-existing evaluation behavior are passing.

[pr]: launchdarkly/php-server-sdk-private#103

* Support ContextKind in Clauses (#209)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

The main features of this commit are:

- introduction of `individual_context` and `individual_context_count`
  methods 
- context kind matching in clauses

[pr]: launchdarkly/php-server-sdk-private#108

* Support included / excluded contexts in segments (#210)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

Segments are now able to provide `includedContext` and `excludedContext`
properties which can target values within a specific context kind.

```json
{
    "includedContexts": [
        {
            "contextKind": "org",
            "values": ["orgkey1", "orgkey2"]
        }
    ]
}
```

[pr]: launchdarkly/php-server-sdk-private#111

* Add contextKind support for rollouts & experiements (#211)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

[pr]: launchdarkly/php-server-sdk-private#110

* Style and test matcher improvements (#212)

This commit enables several rubocop rules that were previously disabled.
Once enabled, `rubocop -A` was run to automatically apply these fixes.

There are a couple of additional changes that were made by hand:

- I added the rubocop and rubocop-performance gems as dev packages. This
  should help address the original installation issue we ran into when I
  introduced these tools.

- By default, new rubocop rules are disabled. This was the default
  before, but if you don't explicitly set this value, each run generates
  a ton of warning noise. This quiets that down.

- Updates some LDContext tests to be more strict in their expectations
  of truth.

* Remove support for secondary attribute (#213)

As decided in the [spec], we are removing the special behavior of the
secondary attribute. Going forward, secondary will be treated like any
other attribute, and will no longer be included when determining the
bucket for a context.

[spec]:
https://launchdarkly.atlassian.net/wiki/spaces/ENG/pages/2165212563/Consistent+and+Transparent+Rollout+Behavior+Unifying+Percent+Rollout+and+Traffic+Allocation

* Remove deprecated APIs (#214)

Since the users to context change requires a version break, this is the
perfect time to remove previously deprecated bits of functionality. This
includes:

- Removing `update_processor*` config entries
- `FileDataSource` entry point
- `RedisFeatureStore` entry point
- `Redis::sadd?` warning in unit tests

* store data model with classes that aren't Hash

* lint

* remove [] override methods in places where we don't need them

* comments

* migrate some more of the model to be non-hash classes

* lint

* Anonymous cannot be nil in new context format (#216)

The legacy user format allowed anonymous to be missing or explicitly
provided but set to nil.

The new context format requires anonymous to either not be set, or if it
is explicitly set, it must be a boolean value.

* Tweak error message language and style (#217)

Our previous error messages suffered from a couple drawbacks:

- The messages were complete sentences, limiting our ability to compose
  error messages
- The messages were overly broad in many cases
- The messages unnecessarily required string interpolation that rarely
  provided much value

These new messages are more succinct and are written as small clauses
which can be used in conjunction with other error messages more easily.

* copyedit

Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>

* Implement prerequisite cycle detection (#219)

* Support attribute reference lookups (#215)

This adds support for slash-delimited paths in clause attributes,
bucketBy, etc. It does not do anything related to private attribute
redaction because none of the U2C event logic is implemented yet.

* Implement segment recursion and cycle detection (#220)

Clauses in segment rules are now allowed to reference segments. To
prevent an infinite recursion edge case, we implement a similar cycle
detection mechanism as used on prerequisites.

* Update event logic to support users to context change (#221)

* Add legacy user-type support to the contract tests (#222)

* Remove inline user configuration option (#223)

* Add context_ configuration options (#224)

These new context_ configuration options are meant to replace the
historic user_ options. If both are provided, the context_ variant will
take precedence.

* Add support for flag context targets (#225)

* Bump diplomat

* Bump redis

* Remove oga

* Bump connection_pool

* Favor set for faster target lookups (#228)

A few of our internal models maintain arrays of values. These arrays can
frequently be checked to see if they contain specific values.

Since set lookups are much faster than array lookups, this commit
changes the internal structure to a set for the values stored in Target
and SegmentTarget.

* Add secure mode hash to contract tests (#229)

* Update big segment support for users to context (#226)

To support the users to context change for big segments, this commit
makes the following changes:

- Introduces a new `Segment.unboundedContextKind` attribute. This will
default to `LDContext::KIND_DEFAULT` and is only referenced when
`Segment.unbounded` is true.

- With the creation of multi-kind contexts, a single evaluation may
result in multiple queries to the big segment store. This is reflected
in the changes to the `EvalResult` processing.

* Drop support for ruby 2.6 (#227)

Ruby 2.6 went EOL in March 2022. We originally didn't drop support for
it as doing so would require dropping support for jRuby as well.
However, jRuby recently released 9.4 which is Ruby 2.7+ compatible.

* Update remaining references from user to contexts (#231)

There are multiple places throughout the code where we are still
referencing users. I have tried to update all the places where a rename
seems reasonable or appropriate. There is still some work to do in the
test flag builders, but that will be done in a subsequent commit.

* Remove new relic integration (#233)

The new relic integration was removed many versions ago but a small
trace remained behind.

* Rename config option private_attribute_names (#234)

Co-authored-by: Eli Bishop <eli@launchdarkly.com>

* Update test data integration to support contexts (#232)

Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com>
Co-authored-by: Jacob Smith <jacob@jacobsmith.io>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: hroederld <hroeder@launchdarkly.com>
Co-authored-by: Kerrie Martinez <kyee@launchdarkly.com>
Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>
Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Ember Stevens <ember.stevens@launchdarkly.com>
Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Matthew M. Keeler <keelerm84@gmail.com>
Co-authored-by: Ben Levy <benjaminlevy007@gmail.com>
Co-authored-by: Ben Levy <ben@foxhound.systems>
Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
LaunchDarklyReleaseBot added a commit that referenced this pull request Jan 19, 2023
@LaunchDarklyReleaseBot @eli-darkly
@bwoskow-ld @LaunchDarklyCI @jacobthemyth @apache-hb @hroederld @ld-kyee @pellyg-ld @samstokes @ember-stevens @louis-launchdarkly @keelerm84 @belevy
prepare 7.0.1 release (#208)
25299b7 
* don't let user fall outside of last bucket in rollout

* refactor evaluation logic and move it out of the main namespace

* comments

* fix type coercion behavior

* make type coercion behavior consistent with earlier versions for now

* whitespace

* break up Evaluator tests further

* make EvaluationReason an immutable class

* FrozenError doesn't exist in older Ruby, use more general RuntimeError

* precompute evaluation reasons when we receive a flag

* rm unused

* rename FeatureStore to DataStore

* remove references to UpdateProcessor (now DataSource)

* add event payload ID header

* (6.0) drop support for old Ruby versions

* add Ruby version constraint to gemspec

* remove Rake dependency

* update ld-eventsource to 1.0.2 which doesn't have Rake dependency

* implement diagnostic events in Ruby (#130)

* update ruby-eventsource to 1.0.3 for backoff bug

* fix incorrect initialization of EventProcessor

* remove install-time openssl check that breaks if you don't have rake

* treat comparison with wrong data type as a non-match, not an exception (#134)

* fail fast for nil SDK key when appropriate

* tolerate nil value for user.custom (#137)

* Only shutdown the Redis pool if it is owned by the SDK (#158)

* Only shutdown a Redis pool created by SDK

* Make pool shutdown behavior an option

* improve doc comment

* remove support for indirect/patch and indirect/put (#138)

* update to json 2.3.1 (#139)

* update json dep to 2.3.x to fix CVE

* add publication of API docs on GitHub Pages (#143)

* try fixing release metadata

* update the default base url (#144)

* revert renames of feature_store & update_processor

* [ch92483] Use http gem and add socket factory support (#142)

* update dependencies and add CI for ruby 3 (#141)

* reference eventsource 2.0 in gemspec

* add 5.x releasable branch for releaser

* use Ruby 2.6.6 in releases

* Removed the guides link

* [ch99757] add alias method (#147)

* don't send event for nil user evaluation

* remove lockfile (#148)

* rm redundant nil check

* Experiment Allocation Changes (#150)

* WIP - from sam's pairing session

* starting sdk changes

* adding tests and making sure everything works

* adding more tests

* removing the singleton for fallthrough

* Revert "removing the singleton for fallthrough"

This reverts commit dff7adbb809ecc63118d0fbff9742a88a039c679.

* taking a different approach to keep things immutable

* adding tests for untracked

* remove unnecessary comment

* making sure to return two values in all code paths

Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>

* Use camelCase for JSON property names (#151)

The in_experiment attribute was added to reasons as part of #150 but it doesn't appear to be received in events. I think that's because it's sending it in JSON as "in_experiment" rather than "inExperiment" as we expect to parse it.

* fixing ruby logic causing ih failures (#152)

* fixing ruby logic

* adding missing spec

* Apply suggestions from code review

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* pr tweaks

* making spec language consistent

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* add log warning for missing user key (#153)

* add log warnings for nil/empty user key

* rm warning for empty string key

* fix test

* diagnostic events should respect HTTPS_PROXY (#154)

* minor test simplification (#155)

* allow higher minor versions of json and http gems

* allow v5.x of http gem (#157)

* use Bundler 2.2.10 + modernize CI config (#158)

* enable verbose rspec output

* fix socket factory tests

* restore log suppression

* Replacing deprecated circleci image usage (#159)

* use Releaser v2 config (#161)

* Updates docs URLs

* Update lib/ldclient-rb/ldclient.rb

Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>

* remove reliance on git in gemspec (#163)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504 (#164)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504

* comment phrasing

* Start work on flag builder.

* Add user targeting and rule builder

* Add datasource implementation

* Convert the current_flags hash to use symbols instead of strings as keys

* Fix typo on FlagRuleBuilder copy constructor

* minor refactoring of impl; Added use of new Clause struct instead of Hash in FlagRuleBuilder; Moved TestData.factory out of Impl namespace and renamed Impl to TestDataImpl

* Add the doc comments

* (big segments 1) add public config/interface/reason types (#167)

* Cleanup docstrings to be YARD docs

* Added Util.is_bool helper function to clean up the check for whether an object is a boolean; Removed the DeepCopyHash/DeepCopyArray objects in favor of deep_copy_hash and deep_copy_array functions

* Move public classes out of Impl namespace. Most of it is in public namespace except for the data source now.

* Move require of concurrent/atomics to the correct module

* (big segments 2) implement Big Segments evaluation & status APIs (#168)

* improve CONTRIBUTING.md with notes on code organization

* add note about doc comments

* Cleanup YARD warnings and cleanup docs

* Address PR feedback: Move is_bool back to Impl namespace to avoid confusion; Remove unnecessary nil check on variations in build function; fixup comments

* (big segments 3) implement Redis & DynamoDB big segment stores (#169)

* add missing import

* fix stale calculation

* fix big segments user hash algorithm to use SHA256

* improve & refactor client/evaluation tests

* more cleanup/DRY

* add use_preconfigured_flag and use_preconfigured_segment to TestData (#173)

* always cache big segment query result even if it's nil

* comments

* add test for cache expiration

* use TestData in our own tests (#174)

* use TestData in our own tests

* fix test

* replace LaunchDarkly::FileDataSource with LaunchDarkly::Integrations::FileData

* update ruby-eventsource version for recent SSE fixes

* Bump bundler version (#184)

* Add ability to to set initial reconnect delay (#183)

* Treat secondary as a built-in attribute (#180)

* all_flags_state is invalid if store isn't initialized (#182)

* identify should not emit events if user key is "" (#181)

* Account for traffic allocation on all flags (#185)

* Add contract tests (#178)

* Fix string interpolation in log message (#187)

* Default opts to empty hash when creating persistent feature store (#186)

* Remove Hakiri badge from README (#188)

Hakiri was sunset on January 31st, 2022 at which time our badge stopped
working.

* detect http/https proxy env vars when creating HTTP clients

* rever accidental change

* fix nil safety in test service config

* master -> main (#190)

* master -> main

* update ruby-eventsource version for parsing efficiency fix

* miscellaneous optimizations for event processing (#193)

* Drop support for EOL ruby versions (#196)

Ruby 2.5 was EOL 2021-04-05

As of June 27th, 2022, the latest jRuby is Ruby 2.6 compatible.

* Remove alias support (#195)

* Add polling support for contract test service (#198)

* Update rubocop and enable in CI (#197)

Several of the Rubocop cop definitions have been renamed or moved to
entirely other gems. This brings the configuration up to date with the
latest naming conventions.

* Add windows tests in circleci (#199)

At some point in the past, we were experimenting with using Azure to
verify Window builds. Now that CircleCI supports Windows, we should keep
everything on a single CI provider.

* Add application info support (#194)

* reuse EvaluationDetail instances by precomputing results

* rubocop reformatting

* add super constructor calls

* disable rubocop Rails rules and fix some remaining syntax offenses

* fix super calls

* Add big segment support to contract tests (#201)

* Initial creation of LDContext (#206)

This introduces the initial structure and usage of the LDContext class.

Instances of this class are expected to be created through static
factory methods:

```ruby
LaunchDarkly::LDContext.create({...})
LaunchDarkly::LDContext.create_multi([...])
```

This class is not completed yet. Rather, this initial commit is focused
on the creation patterns and the most basic operations. Subsequent
commits will continue fleshing out this class and its operation.

The `get_value` method will see significant changes as we introduce
attribute reference support. Its current more simplistic implementation
exists only to serve some interim unit tests.

* Add reference based value retrieval (#207)

This commit introduces the References type used for targeting complex
attributes in the new LDContexts.

References are expected to be created through static factory methods:

```ruby
LaunchDarkly::Reference.create("/a/b")
LaunchDarkly::Reference.create_literal("/a/b")
```

These references can be used to retrieve values from an existing
LDContext

```ruby
ref = LaunchDarkly::Reference.create("/a/b")
result = context.get_value_for_reference(ref)
```

* Basic changes to use contexts in evaluations instead of users (#208)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

This replaces `LDUser` with `LDContext` in the parameters for
evaluations, and makes the minimum necessary adjustments to allow
evaluations to keep working as before as long as the context kind is
"user". None of the new behavior defined in the U2C spec is implemented
yet.

Generation of evaluation events is temporarily disabled because the
event logic hasn't been updated yet.

U2C contract tests for evaluations are partially enabled; a lot of
functionality is still missing, but all the tests that only cover
previously-existing evaluation behavior are passing.

[pr]: launchdarkly/php-server-sdk-private#103

* Support ContextKind in Clauses (#209)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

The main features of this commit are:

- introduction of `individual_context` and `individual_context_count`
  methods 
- context kind matching in clauses

[pr]: launchdarkly/php-server-sdk-private#108

* Support included / excluded contexts in segments (#210)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

Segments are now able to provide `includedContext` and `excludedContext`
properties which can target values within a specific context kind.

```json
{
    "includedContexts": [
        {
            "contextKind": "org",
            "values": ["orgkey1", "orgkey2"]
        }
    ]
}
```

[pr]: launchdarkly/php-server-sdk-private#111

* Add contextKind support for rollouts & experiements (#211)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

[pr]: launchdarkly/php-server-sdk-private#110

* Style and test matcher improvements (#212)

This commit enables several rubocop rules that were previously disabled.
Once enabled, `rubocop -A` was run to automatically apply these fixes.

There are a couple of additional changes that were made by hand:

- I added the rubocop and rubocop-performance gems as dev packages. This
  should help address the original installation issue we ran into when I
  introduced these tools.

- By default, new rubocop rules are disabled. This was the default
  before, but if you don't explicitly set this value, each run generates
  a ton of warning noise. This quiets that down.

- Updates some LDContext tests to be more strict in their expectations
  of truth.

* Remove support for secondary attribute (#213)

As decided in the [spec], we are removing the special behavior of the
secondary attribute. Going forward, secondary will be treated like any
other attribute, and will no longer be included when determining the
bucket for a context.

[spec]:
https://launchdarkly.atlassian.net/wiki/spaces/ENG/pages/2165212563/Consistent+and+Transparent+Rollout+Behavior+Unifying+Percent+Rollout+and+Traffic+Allocation

* Remove deprecated APIs (#214)

Since the users to context change requires a version break, this is the
perfect time to remove previously deprecated bits of functionality. This
includes:

- Removing `update_processor*` config entries
- `FileDataSource` entry point
- `RedisFeatureStore` entry point
- `Redis::sadd?` warning in unit tests

* store data model with classes that aren't Hash

* lint

* remove [] override methods in places where we don't need them

* comments

* migrate some more of the model to be non-hash classes

* lint

* Anonymous cannot be nil in new context format (#216)

The legacy user format allowed anonymous to be missing or explicitly
provided but set to nil.

The new context format requires anonymous to either not be set, or if it
is explicitly set, it must be a boolean value.

* Tweak error message language and style (#217)

Our previous error messages suffered from a couple drawbacks:

- The messages were complete sentences, limiting our ability to compose
  error messages
- The messages were overly broad in many cases
- The messages unnecessarily required string interpolation that rarely
  provided much value

These new messages are more succinct and are written as small clauses
which can be used in conjunction with other error messages more easily.

* copyedit

Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>

* Implement prerequisite cycle detection (#219)

* Support attribute reference lookups (#215)

This adds support for slash-delimited paths in clause attributes,
bucketBy, etc. It does not do anything related to private attribute
redaction because none of the U2C event logic is implemented yet.

* Implement segment recursion and cycle detection (#220)

Clauses in segment rules are now allowed to reference segments. To
prevent an infinite recursion edge case, we implement a similar cycle
detection mechanism as used on prerequisites.

* Update event logic to support users to context change (#221)

* Add legacy user-type support to the contract tests (#222)

* Remove inline user configuration option (#223)

* Add context_ configuration options (#224)

These new context_ configuration options are meant to replace the
historic user_ options. If both are provided, the context_ variant will
take precedence.

* Add support for flag context targets (#225)

* Bump diplomat

* Bump redis

* Remove oga

* Bump connection_pool

* Favor set for faster target lookups (#228)

A few of our internal models maintain arrays of values. These arrays can
frequently be checked to see if they contain specific values.

Since set lookups are much faster than array lookups, this commit
changes the internal structure to a set for the values stored in Target
and SegmentTarget.

* Add secure mode hash to contract tests (#229)

* Update big segment support for users to context (#226)

To support the users to context change for big segments, this commit
makes the following changes:

- Introduces a new `Segment.unboundedContextKind` attribute. This will
default to `LDContext::KIND_DEFAULT` and is only referenced when
`Segment.unbounded` is true.

- With the creation of multi-kind contexts, a single evaluation may
result in multiple queries to the big segment store. This is reflected
in the changes to the `EvalResult` processing.

* Drop support for ruby 2.6 (#227)

Ruby 2.6 went EOL in March 2022. We originally didn't drop support for
it as doing so would require dropping support for jRuby as well.
However, jRuby recently released 9.4 which is Ruby 2.7+ compatible.

* Update remaining references from user to contexts (#231)

There are multiple places throughout the code where we are still
referencing users. I have tried to update all the places where a rename
seems reasonable or appropriate. There is still some work to do in the
test flag builders, but that will be done in a subsequent commit.

* Remove new relic integration (#233)

The new relic integration was removed many versions ago but a small
trace remained behind.

* Rename config option private_attribute_names (#234)

Co-authored-by: Eli Bishop <eli@launchdarkly.com>

* Update test data integration to support contexts (#232)

* improve data model validation logging; allow missing/empty attribute for segmentMatch (#236)

Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com>
Co-authored-by: Jacob Smith <jacob@jacobsmith.io>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: hroederld <hroeder@launchdarkly.com>
Co-authored-by: Kerrie Martinez <kyee@launchdarkly.com>
Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>
Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Ember Stevens <ember.stevens@launchdarkly.com>
Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Matthew M. Keeler <keelerm84@gmail.com>
Co-authored-by: Ben Levy <benjaminlevy007@gmail.com>
Co-authored-by: Ben Levy <ben@foxhound.systems>
Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
LaunchDarklyReleaseBot added a commit that referenced this pull request Jan 27, 2023
@LaunchDarklyReleaseBot @eli-darkly
@bwoskow-ld @LaunchDarklyCI @jacobthemyth @apache-hb @hroederld @ld-kyee @pellyg-ld @samstokes @ember-stevens @louis-launchdarkly @keelerm84 @belevy
prepare 7.0.2 release (#209)
8937c86 
* don't let user fall outside of last bucket in rollout

* refactor evaluation logic and move it out of the main namespace

* comments

* fix type coercion behavior

* make type coercion behavior consistent with earlier versions for now

* whitespace

* break up Evaluator tests further

* make EvaluationReason an immutable class

* FrozenError doesn't exist in older Ruby, use more general RuntimeError

* precompute evaluation reasons when we receive a flag

* rm unused

* rename FeatureStore to DataStore

* remove references to UpdateProcessor (now DataSource)

* add event payload ID header

* (6.0) drop support for old Ruby versions

* add Ruby version constraint to gemspec

* remove Rake dependency

* update ld-eventsource to 1.0.2 which doesn't have Rake dependency

* implement diagnostic events in Ruby (#130)

* update ruby-eventsource to 1.0.3 for backoff bug

* fix incorrect initialization of EventProcessor

* remove install-time openssl check that breaks if you don't have rake

* treat comparison with wrong data type as a non-match, not an exception (#134)

* fail fast for nil SDK key when appropriate

* tolerate nil value for user.custom (#137)

* Only shutdown the Redis pool if it is owned by the SDK (#158)

* Only shutdown a Redis pool created by SDK

* Make pool shutdown behavior an option

* improve doc comment

* remove support for indirect/patch and indirect/put (#138)

* update to json 2.3.1 (#139)

* update json dep to 2.3.x to fix CVE

* add publication of API docs on GitHub Pages (#143)

* try fixing release metadata

* update the default base url (#144)

* revert renames of feature_store & update_processor

* [ch92483] Use http gem and add socket factory support (#142)

* update dependencies and add CI for ruby 3 (#141)

* reference eventsource 2.0 in gemspec

* add 5.x releasable branch for releaser

* use Ruby 2.6.6 in releases

* Removed the guides link

* [ch99757] add alias method (#147)

* don't send event for nil user evaluation

* remove lockfile (#148)

* rm redundant nil check

* Experiment Allocation Changes (#150)

* WIP - from sam's pairing session

* starting sdk changes

* adding tests and making sure everything works

* adding more tests

* removing the singleton for fallthrough

* Revert "removing the singleton for fallthrough"

This reverts commit dff7adbb809ecc63118d0fbff9742a88a039c679.

* taking a different approach to keep things immutable

* adding tests for untracked

* remove unnecessary comment

* making sure to return two values in all code paths

Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>

* Use camelCase for JSON property names (#151)

The in_experiment attribute was added to reasons as part of #150 but it doesn't appear to be received in events. I think that's because it's sending it in JSON as "in_experiment" rather than "inExperiment" as we expect to parse it.

* fixing ruby logic causing ih failures (#152)

* fixing ruby logic

* adding missing spec

* Apply suggestions from code review

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* pr tweaks

* making spec language consistent

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* add log warning for missing user key (#153)

* add log warnings for nil/empty user key

* rm warning for empty string key

* fix test

* diagnostic events should respect HTTPS_PROXY (#154)

* minor test simplification (#155)

* allow higher minor versions of json and http gems

* allow v5.x of http gem (#157)

* use Bundler 2.2.10 + modernize CI config (#158)

* enable verbose rspec output

* fix socket factory tests

* restore log suppression

* Replacing deprecated circleci image usage (#159)

* use Releaser v2 config (#161)

* Updates docs URLs

* Update lib/ldclient-rb/ldclient.rb

Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>

* remove reliance on git in gemspec (#163)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504 (#164)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504

* comment phrasing

* Start work on flag builder.

* Add user targeting and rule builder

* Add datasource implementation

* Convert the current_flags hash to use symbols instead of strings as keys

* Fix typo on FlagRuleBuilder copy constructor

* minor refactoring of impl; Added use of new Clause struct instead of Hash in FlagRuleBuilder; Moved TestData.factory out of Impl namespace and renamed Impl to TestDataImpl

* Add the doc comments

* (big segments 1) add public config/interface/reason types (#167)

* Cleanup docstrings to be YARD docs

* Added Util.is_bool helper function to clean up the check for whether an object is a boolean; Removed the DeepCopyHash/DeepCopyArray objects in favor of deep_copy_hash and deep_copy_array functions

* Move public classes out of Impl namespace. Most of it is in public namespace except for the data source now.

* Move require of concurrent/atomics to the correct module

* (big segments 2) implement Big Segments evaluation & status APIs (#168)

* improve CONTRIBUTING.md with notes on code organization

* add note about doc comments

* Cleanup YARD warnings and cleanup docs

* Address PR feedback: Move is_bool back to Impl namespace to avoid confusion; Remove unnecessary nil check on variations in build function; fixup comments

* (big segments 3) implement Redis & DynamoDB big segment stores (#169)

* add missing import

* fix stale calculation

* fix big segments user hash algorithm to use SHA256

* improve & refactor client/evaluation tests

* more cleanup/DRY

* add use_preconfigured_flag and use_preconfigured_segment to TestData (#173)

* always cache big segment query result even if it's nil

* comments

* add test for cache expiration

* use TestData in our own tests (#174)

* use TestData in our own tests

* fix test

* replace LaunchDarkly::FileDataSource with LaunchDarkly::Integrations::FileData

* update ruby-eventsource version for recent SSE fixes

* Bump bundler version (#184)

* Add ability to to set initial reconnect delay (#183)

* Treat secondary as a built-in attribute (#180)

* all_flags_state is invalid if store isn't initialized (#182)

* identify should not emit events if user key is "" (#181)

* Account for traffic allocation on all flags (#185)

* Add contract tests (#178)

* Fix string interpolation in log message (#187)

* Default opts to empty hash when creating persistent feature store (#186)

* Remove Hakiri badge from README (#188)

Hakiri was sunset on January 31st, 2022 at which time our badge stopped
working.

* detect http/https proxy env vars when creating HTTP clients

* rever accidental change

* fix nil safety in test service config

* master -> main (#190)

* master -> main

* update ruby-eventsource version for parsing efficiency fix

* miscellaneous optimizations for event processing (#193)

* Drop support for EOL ruby versions (#196)

Ruby 2.5 was EOL 2021-04-05

As of June 27th, 2022, the latest jRuby is Ruby 2.6 compatible.

* Remove alias support (#195)

* Add polling support for contract test service (#198)

* Update rubocop and enable in CI (#197)

Several of the Rubocop cop definitions have been renamed or moved to
entirely other gems. This brings the configuration up to date with the
latest naming conventions.

* Add windows tests in circleci (#199)

At some point in the past, we were experimenting with using Azure to
verify Window builds. Now that CircleCI supports Windows, we should keep
everything on a single CI provider.

* Add application info support (#194)

* reuse EvaluationDetail instances by precomputing results

* rubocop reformatting

* add super constructor calls

* disable rubocop Rails rules and fix some remaining syntax offenses

* fix super calls

* Add big segment support to contract tests (#201)

* Initial creation of LDContext (#206)

This introduces the initial structure and usage of the LDContext class.

Instances of this class are expected to be created through static
factory methods:

```ruby
LaunchDarkly::LDContext.create({...})
LaunchDarkly::LDContext.create_multi([...])
```

This class is not completed yet. Rather, this initial commit is focused
on the creation patterns and the most basic operations. Subsequent
commits will continue fleshing out this class and its operation.

The `get_value` method will see significant changes as we introduce
attribute reference support. Its current more simplistic implementation
exists only to serve some interim unit tests.

* Add reference based value retrieval (#207)

This commit introduces the References type used for targeting complex
attributes in the new LDContexts.

References are expected to be created through static factory methods:

```ruby
LaunchDarkly::Reference.create("/a/b")
LaunchDarkly::Reference.create_literal("/a/b")
```

These references can be used to retrieve values from an existing
LDContext

```ruby
ref = LaunchDarkly::Reference.create("/a/b")
result = context.get_value_for_reference(ref)
```

* Basic changes to use contexts in evaluations instead of users (#208)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

This replaces `LDUser` with `LDContext` in the parameters for
evaluations, and makes the minimum necessary adjustments to allow
evaluations to keep working as before as long as the context kind is
"user". None of the new behavior defined in the U2C spec is implemented
yet.

Generation of evaluation events is temporarily disabled because the
event logic hasn't been updated yet.

U2C contract tests for evaluations are partially enabled; a lot of
functionality is still missing, but all the tests that only cover
previously-existing evaluation behavior are passing.

[pr]: launchdarkly/php-server-sdk-private#103

* Support ContextKind in Clauses (#209)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

The main features of this commit are:

- introduction of `individual_context` and `individual_context_count`
  methods 
- context kind matching in clauses

[pr]: launchdarkly/php-server-sdk-private#108

* Support included / excluded contexts in segments (#210)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

Segments are now able to provide `includedContext` and `excludedContext`
properties which can target values within a specific context kind.

```json
{
    "includedContexts": [
        {
            "contextKind": "org",
            "values": ["orgkey1", "orgkey2"]
        }
    ]
}
```

[pr]: launchdarkly/php-server-sdk-private#111

* Add contextKind support for rollouts & experiements (#211)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

[pr]: launchdarkly/php-server-sdk-private#110

* Style and test matcher improvements (#212)

This commit enables several rubocop rules that were previously disabled.
Once enabled, `rubocop -A` was run to automatically apply these fixes.

There are a couple of additional changes that were made by hand:

- I added the rubocop and rubocop-performance gems as dev packages. This
  should help address the original installation issue we ran into when I
  introduced these tools.

- By default, new rubocop rules are disabled. This was the default
  before, but if you don't explicitly set this value, each run generates
  a ton of warning noise. This quiets that down.

- Updates some LDContext tests to be more strict in their expectations
  of truth.

* Remove support for secondary attribute (#213)

As decided in the [spec], we are removing the special behavior of the
secondary attribute. Going forward, secondary will be treated like any
other attribute, and will no longer be included when determining the
bucket for a context.

[spec]:
https://launchdarkly.atlassian.net/wiki/spaces/ENG/pages/2165212563/Consistent+and+Transparent+Rollout+Behavior+Unifying+Percent+Rollout+and+Traffic+Allocation

* Remove deprecated APIs (#214)

Since the users to context change requires a version break, this is the
perfect time to remove previously deprecated bits of functionality. This
includes:

- Removing `update_processor*` config entries
- `FileDataSource` entry point
- `RedisFeatureStore` entry point
- `Redis::sadd?` warning in unit tests

* store data model with classes that aren't Hash

* lint

* remove [] override methods in places where we don't need them

* comments

* migrate some more of the model to be non-hash classes

* lint

* Anonymous cannot be nil in new context format (#216)

The legacy user format allowed anonymous to be missing or explicitly
provided but set to nil.

The new context format requires anonymous to either not be set, or if it
is explicitly set, it must be a boolean value.

* Tweak error message language and style (#217)

Our previous error messages suffered from a couple drawbacks:

- The messages were complete sentences, limiting our ability to compose
  error messages
- The messages were overly broad in many cases
- The messages unnecessarily required string interpolation that rarely
  provided much value

These new messages are more succinct and are written as small clauses
which can be used in conjunction with other error messages more easily.

* copyedit

Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>

* Implement prerequisite cycle detection (#219)

* Support attribute reference lookups (#215)

This adds support for slash-delimited paths in clause attributes,
bucketBy, etc. It does not do anything related to private attribute
redaction because none of the U2C event logic is implemented yet.

* Implement segment recursion and cycle detection (#220)

Clauses in segment rules are now allowed to reference segments. To
prevent an infinite recursion edge case, we implement a similar cycle
detection mechanism as used on prerequisites.

* Update event logic to support users to context change (#221)

* Add legacy user-type support to the contract tests (#222)

* Remove inline user configuration option (#223)

* Add context_ configuration options (#224)

These new context_ configuration options are meant to replace the
historic user_ options. If both are provided, the context_ variant will
take precedence.

* Add support for flag context targets (#225)

* Bump diplomat

* Bump redis

* Remove oga

* Bump connection_pool

* Favor set for faster target lookups (#228)

A few of our internal models maintain arrays of values. These arrays can
frequently be checked to see if they contain specific values.

Since set lookups are much faster than array lookups, this commit
changes the internal structure to a set for the values stored in Target
and SegmentTarget.

* Add secure mode hash to contract tests (#229)

* Update big segment support for users to context (#226)

To support the users to context change for big segments, this commit
makes the following changes:

- Introduces a new `Segment.unboundedContextKind` attribute. This will
default to `LDContext::KIND_DEFAULT` and is only referenced when
`Segment.unbounded` is true.

- With the creation of multi-kind contexts, a single evaluation may
result in multiple queries to the big segment store. This is reflected
in the changes to the `EvalResult` processing.

* Drop support for ruby 2.6 (#227)

Ruby 2.6 went EOL in March 2022. We originally didn't drop support for
it as doing so would require dropping support for jRuby as well.
However, jRuby recently released 9.4 which is Ruby 2.7+ compatible.

* Update remaining references from user to contexts (#231)

There are multiple places throughout the code where we are still
referencing users. I have tried to update all the places where a rename
seems reasonable or appropriate. There is still some work to do in the
test flag builders, but that will be done in a subsequent commit.

* Remove new relic integration (#233)

The new relic integration was removed many versions ago but a small
trace remained behind.

* Rename config option private_attribute_names (#234)

Co-authored-by: Eli Bishop <eli@launchdarkly.com>

* Update test data integration to support contexts (#232)

* improve data model validation logging; allow missing/empty attribute for segmentMatch (#236)

* Fix JSON serialization failure (#237)

When we introduced models for the flag and segment data, we added
to_json methods which proxy to the underlying to_json method provided by
the `json` gem.

We defined the method with a variadic parameter, but we failed to unpack
it when passing it on to the underlying implementation. This resulted in
a serialization failure which prevented the redis data store from
initializing.

---------

Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com>
Co-authored-by: Jacob Smith <jacob@jacobsmith.io>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: hroederld <hroeder@launchdarkly.com>
Co-authored-by: Kerrie Martinez <kyee@launchdarkly.com>
Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>
Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Ember Stevens <ember.stevens@launchdarkly.com>
Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Matthew M. Keeler <keelerm84@gmail.com>
Co-authored-by: Ben Levy <benjaminlevy007@gmail.com>
Co-authored-by: Ben Levy <ben@foxhound.systems>
Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
LaunchDarklyReleaseBot added a commit that referenced this pull request Mar 17, 2023
@LaunchDarklyReleaseBot @eli-darkly
@LaunchDarklyCI @jacobthemyth @apache-hb @bwoskow-ld @hroederld @ld-kyee @pellyg-ld @samstokes @ember-stevens @louis-launchdarkly @keelerm84 @belevy
prepare 7.0.3 release (#211)
96bb73b 
* don't let user fall outside of last bucket in rollout

* refactor evaluation logic and move it out of the main namespace

* comments

* fix type coercion behavior

* make type coercion behavior consistent with earlier versions for now

* whitespace

* break up Evaluator tests further

* make EvaluationReason an immutable class

* FrozenError doesn't exist in older Ruby, use more general RuntimeError

* precompute evaluation reasons when we receive a flag

* rm unused

* rename FeatureStore to DataStore

* remove references to UpdateProcessor (now DataSource)

* add event payload ID header

* (6.0) drop support for old Ruby versions

* add Ruby version constraint to gemspec

* remove Rake dependency

* update ld-eventsource to 1.0.2 which doesn't have Rake dependency

* implement diagnostic events in Ruby (#130)

* update ruby-eventsource to 1.0.3 for backoff bug

* fix incorrect initialization of EventProcessor

* remove install-time openssl check that breaks if you don't have rake

* treat comparison with wrong data type as a non-match, not an exception (#134)

* fail fast for nil SDK key when appropriate

* tolerate nil value for user.custom (#137)

* Only shutdown the Redis pool if it is owned by the SDK (#158)

* Only shutdown a Redis pool created by SDK

* Make pool shutdown behavior an option

* improve doc comment

* remove support for indirect/patch and indirect/put (#138)

* update to json 2.3.1 (#139)

* update json dep to 2.3.x to fix CVE

* add publication of API docs on GitHub Pages (#143)

* try fixing release metadata

* update the default base url (#144)

* revert renames of feature_store & update_processor

* [ch92483] Use http gem and add socket factory support (#142)

* update dependencies and add CI for ruby 3 (#141)

* reference eventsource 2.0 in gemspec

* add 5.x releasable branch for releaser

* use Ruby 2.6.6 in releases

* Removed the guides link

* [ch99757] add alias method (#147)

* don't send event for nil user evaluation

* remove lockfile (#148)

* rm redundant nil check

* Experiment Allocation Changes (#150)

* WIP - from sam's pairing session

* starting sdk changes

* adding tests and making sure everything works

* adding more tests

* removing the singleton for fallthrough

* Revert "removing the singleton for fallthrough"

This reverts commit dff7adbb809ecc63118d0fbff9742a88a039c679.

* taking a different approach to keep things immutable

* adding tests for untracked

* remove unnecessary comment

* making sure to return two values in all code paths

Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>

* Use camelCase for JSON property names (#151)

The in_experiment attribute was added to reasons as part of #150 but it doesn't appear to be received in events. I think that's because it's sending it in JSON as "in_experiment" rather than "inExperiment" as we expect to parse it.

* fixing ruby logic causing ih failures (#152)

* fixing ruby logic

* adding missing spec

* Apply suggestions from code review

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* pr tweaks

* making spec language consistent

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* add log warning for missing user key (#153)

* add log warnings for nil/empty user key

* rm warning for empty string key

* fix test

* diagnostic events should respect HTTPS_PROXY (#154)

* minor test simplification (#155)

* allow higher minor versions of json and http gems

* allow v5.x of http gem (#157)

* use Bundler 2.2.10 + modernize CI config (#158)

* enable verbose rspec output

* fix socket factory tests

* restore log suppression

* Replacing deprecated circleci image usage (#159)

* use Releaser v2 config (#161)

* Updates docs URLs

* Update lib/ldclient-rb/ldclient.rb

Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>

* remove reliance on git in gemspec (#163)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504 (#164)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504

* comment phrasing

* Start work on flag builder.

* Add user targeting and rule builder

* Add datasource implementation

* Convert the current_flags hash to use symbols instead of strings as keys

* Fix typo on FlagRuleBuilder copy constructor

* minor refactoring of impl; Added use of new Clause struct instead of Hash in FlagRuleBuilder; Moved TestData.factory out of Impl namespace and renamed Impl to TestDataImpl

* Add the doc comments

* (big segments 1) add public config/interface/reason types (#167)

* Cleanup docstrings to be YARD docs

* Added Util.is_bool helper function to clean up the check for whether an object is a boolean; Removed the DeepCopyHash/DeepCopyArray objects in favor of deep_copy_hash and deep_copy_array functions

* Move public classes out of Impl namespace. Most of it is in public namespace except for the data source now.

* Move require of concurrent/atomics to the correct module

* (big segments 2) implement Big Segments evaluation & status APIs (#168)

* improve CONTRIBUTING.md with notes on code organization

* add note about doc comments

* Cleanup YARD warnings and cleanup docs

* Address PR feedback: Move is_bool back to Impl namespace to avoid confusion; Remove unnecessary nil check on variations in build function; fixup comments

* (big segments 3) implement Redis & DynamoDB big segment stores (#169)

* add missing import

* fix stale calculation

* fix big segments user hash algorithm to use SHA256

* improve & refactor client/evaluation tests

* more cleanup/DRY

* add use_preconfigured_flag and use_preconfigured_segment to TestData (#173)

* always cache big segment query result even if it's nil

* comments

* add test for cache expiration

* use TestData in our own tests (#174)

* use TestData in our own tests

* fix test

* replace LaunchDarkly::FileDataSource with LaunchDarkly::Integrations::FileData

* update ruby-eventsource version for recent SSE fixes

* Bump bundler version (#184)

* Add ability to to set initial reconnect delay (#183)

* Treat secondary as a built-in attribute (#180)

* all_flags_state is invalid if store isn't initialized (#182)

* identify should not emit events if user key is "" (#181)

* Account for traffic allocation on all flags (#185)

* Add contract tests (#178)

* Fix string interpolation in log message (#187)

* Default opts to empty hash when creating persistent feature store (#186)

* Remove Hakiri badge from README (#188)

Hakiri was sunset on January 31st, 2022 at which time our badge stopped
working.

* detect http/https proxy env vars when creating HTTP clients

* rever accidental change

* fix nil safety in test service config

* master -> main (#190)

* master -> main

* update ruby-eventsource version for parsing efficiency fix

* miscellaneous optimizations for event processing (#193)

* Drop support for EOL ruby versions (#196)

Ruby 2.5 was EOL 2021-04-05

As of June 27th, 2022, the latest jRuby is Ruby 2.6 compatible.

* Remove alias support (#195)

* Add polling support for contract test service (#198)

* Update rubocop and enable in CI (#197)

Several of the Rubocop cop definitions have been renamed or moved to
entirely other gems. This brings the configuration up to date with the
latest naming conventions.

* Add windows tests in circleci (#199)

At some point in the past, we were experimenting with using Azure to
verify Window builds. Now that CircleCI supports Windows, we should keep
everything on a single CI provider.

* Add application info support (#194)

* reuse EvaluationDetail instances by precomputing results

* rubocop reformatting

* add super constructor calls

* disable rubocop Rails rules and fix some remaining syntax offenses

* fix super calls

* Add big segment support to contract tests (#201)

* Initial creation of LDContext (#206)

This introduces the initial structure and usage of the LDContext class.

Instances of this class are expected to be created through static
factory methods:

```ruby
LaunchDarkly::LDContext.create({...})
LaunchDarkly::LDContext.create_multi([...])
```

This class is not completed yet. Rather, this initial commit is focused
on the creation patterns and the most basic operations. Subsequent
commits will continue fleshing out this class and its operation.

The `get_value` method will see significant changes as we introduce
attribute reference support. Its current more simplistic implementation
exists only to serve some interim unit tests.

* Add reference based value retrieval (#207)

This commit introduces the References type used for targeting complex
attributes in the new LDContexts.

References are expected to be created through static factory methods:

```ruby
LaunchDarkly::Reference.create("/a/b")
LaunchDarkly::Reference.create_literal("/a/b")
```

These references can be used to retrieve values from an existing
LDContext

```ruby
ref = LaunchDarkly::Reference.create("/a/b")
result = context.get_value_for_reference(ref)
```

* Basic changes to use contexts in evaluations instead of users (#208)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

This replaces `LDUser` with `LDContext` in the parameters for
evaluations, and makes the minimum necessary adjustments to allow
evaluations to keep working as before as long as the context kind is
"user". None of the new behavior defined in the U2C spec is implemented
yet.

Generation of evaluation events is temporarily disabled because the
event logic hasn't been updated yet.

U2C contract tests for evaluations are partially enabled; a lot of
functionality is still missing, but all the tests that only cover
previously-existing evaluation behavior are passing.

[pr]: launchdarkly/php-server-sdk-private#103

* Support ContextKind in Clauses (#209)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

The main features of this commit are:

- introduction of `individual_context` and `individual_context_count`
  methods 
- context kind matching in clauses

[pr]: launchdarkly/php-server-sdk-private#108

* Support included / excluded contexts in segments (#210)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

Segments are now able to provide `includedContext` and `excludedContext`
properties which can target values within a specific context kind.

```json
{
    "includedContexts": [
        {
            "contextKind": "org",
            "values": ["orgkey1", "orgkey2"]
        }
    ]
}
```

[pr]: launchdarkly/php-server-sdk-private#111

* Add contextKind support for rollouts & experiements (#211)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

[pr]: launchdarkly/php-server-sdk-private#110

* Style and test matcher improvements (#212)

This commit enables several rubocop rules that were previously disabled.
Once enabled, `rubocop -A` was run to automatically apply these fixes.

There are a couple of additional changes that were made by hand:

- I added the rubocop and rubocop-performance gems as dev packages. This
  should help address the original installation issue we ran into when I
  introduced these tools.

- By default, new rubocop rules are disabled. This was the default
  before, but if you don't explicitly set this value, each run generates
  a ton of warning noise. This quiets that down.

- Updates some LDContext tests to be more strict in their expectations
  of truth.

* Remove support for secondary attribute (#213)

As decided in the [spec], we are removing the special behavior of the
secondary attribute. Going forward, secondary will be treated like any
other attribute, and will no longer be included when determining the
bucket for a context.

[spec]:
https://launchdarkly.atlassian.net/wiki/spaces/ENG/pages/2165212563/Consistent+and+Transparent+Rollout+Behavior+Unifying+Percent+Rollout+and+Traffic+Allocation

* Remove deprecated APIs (#214)

Since the users to context change requires a version break, this is the
perfect time to remove previously deprecated bits of functionality. This
includes:

- Removing `update_processor*` config entries
- `FileDataSource` entry point
- `RedisFeatureStore` entry point
- `Redis::sadd?` warning in unit tests

* store data model with classes that aren't Hash

* lint

* remove [] override methods in places where we don't need them

* comments

* migrate some more of the model to be non-hash classes

* lint

* Anonymous cannot be nil in new context format (#216)

The legacy user format allowed anonymous to be missing or explicitly
provided but set to nil.

The new context format requires anonymous to either not be set, or if it
is explicitly set, it must be a boolean value.

* Tweak error message language and style (#217)

Our previous error messages suffered from a couple drawbacks:

- The messages were complete sentences, limiting our ability to compose
  error messages
- The messages were overly broad in many cases
- The messages unnecessarily required string interpolation that rarely
  provided much value

These new messages are more succinct and are written as small clauses
which can be used in conjunction with other error messages more easily.

* copyedit

Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>

* Implement prerequisite cycle detection (#219)

* Support attribute reference lookups (#215)

This adds support for slash-delimited paths in clause attributes,
bucketBy, etc. It does not do anything related to private attribute
redaction because none of the U2C event logic is implemented yet.

* Implement segment recursion and cycle detection (#220)

Clauses in segment rules are now allowed to reference segments. To
prevent an infinite recursion edge case, we implement a similar cycle
detection mechanism as used on prerequisites.

* Update event logic to support users to context change (#221)

* Add legacy user-type support to the contract tests (#222)

* Remove inline user configuration option (#223)

* Add context_ configuration options (#224)

These new context_ configuration options are meant to replace the
historic user_ options. If both are provided, the context_ variant will
take precedence.

* Add support for flag context targets (#225)

* Bump diplomat

* Bump redis

* Remove oga

* Bump connection_pool

* Favor set for faster target lookups (#228)

A few of our internal models maintain arrays of values. These arrays can
frequently be checked to see if they contain specific values.

Since set lookups are much faster than array lookups, this commit
changes the internal structure to a set for the values stored in Target
and SegmentTarget.

* Add secure mode hash to contract tests (#229)

* Update big segment support for users to context (#226)

To support the users to context change for big segments, this commit
makes the following changes:

- Introduces a new `Segment.unboundedContextKind` attribute. This will
default to `LDContext::KIND_DEFAULT` and is only referenced when
`Segment.unbounded` is true.

- With the creation of multi-kind contexts, a single evaluation may
result in multiple queries to the big segment store. This is reflected
in the changes to the `EvalResult` processing.

* Drop support for ruby 2.6 (#227)

Ruby 2.6 went EOL in March 2022. We originally didn't drop support for
it as doing so would require dropping support for jRuby as well.
However, jRuby recently released 9.4 which is Ruby 2.7+ compatible.

* Update remaining references from user to contexts (#231)

There are multiple places throughout the code where we are still
referencing users. I have tried to update all the places where a rename
seems reasonable or appropriate. There is still some work to do in the
test flag builders, but that will be done in a subsequent commit.

* Remove new relic integration (#233)

The new relic integration was removed many versions ago but a small
trace remained behind.

* Rename config option private_attribute_names (#234)

Co-authored-by: Eli Bishop <eli@launchdarkly.com>

* Update test data integration to support contexts (#232)

* improve data model validation logging; allow missing/empty attribute for segmentMatch (#236)

* Fix JSON serialization failure (#237)

When we introduced models for the flag and segment data, we added
to_json methods which proxy to the underlying to_json method provided by
the `json` gem.

We defined the method with a variadic parameter, but we failed to unpack
it when passing it on to the underlying implementation. This resulted in
a serialization failure which prevented the redis data store from
initializing.

* fix: Bump eventsource to resolve header parsing (#239)

The underlying event source library had an issue where, in certain
environments, content-type header detection was failing.

This was resolved in v2.2.2 of the event source gem.

---------

Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com>
Co-authored-by: Jacob Smith <jacob@jacobsmith.io>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: hroederld <hroeder@launchdarkly.com>
Co-authored-by: Kerrie Martinez <kyee@launchdarkly.com>
Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>
Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Ember Stevens <ember.stevens@launchdarkly.com>
Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Matthew M. Keeler <keelerm84@gmail.com>
Co-authored-by: Ben Levy <benjaminlevy007@gmail.com>
Co-authored-by: Ben Levy <ben@foxhound.systems>
Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
LaunchDarklyReleaseBot added a commit that referenced this pull request Apr 3, 2023
@LaunchDarklyReleaseBot @eli-darkly
@LaunchDarklyCI @jacobthemyth @apache-hb @bwoskow-ld @hroederld @ld-kyee @pellyg-ld @samstokes @ember-stevens @louis-launchdarkly @keelerm84 @belevy @matt-dutchie
prepare 7.0.4 release (#215)
118f524 
* make type coercion behavior consistent with earlier versions for now

* whitespace

* break up Evaluator tests further

* make EvaluationReason an immutable class

* FrozenError doesn't exist in older Ruby, use more general RuntimeError

* precompute evaluation reasons when we receive a flag

* rm unused

* rename FeatureStore to DataStore

* remove references to UpdateProcessor (now DataSource)

* add event payload ID header

* (6.0) drop support for old Ruby versions

* add Ruby version constraint to gemspec

* remove Rake dependency

* update ld-eventsource to 1.0.2 which doesn't have Rake dependency

* implement diagnostic events in Ruby (#130)

* update ruby-eventsource to 1.0.3 for backoff bug

* fix incorrect initialization of EventProcessor

* remove install-time openssl check that breaks if you don't have rake

* treat comparison with wrong data type as a non-match, not an exception (#134)

* fail fast for nil SDK key when appropriate

* tolerate nil value for user.custom (#137)

* Only shutdown the Redis pool if it is owned by the SDK (#158)

* Only shutdown a Redis pool created by SDK

* Make pool shutdown behavior an option

* improve doc comment

* remove support for indirect/patch and indirect/put (#138)

* update to json 2.3.1 (#139)

* update json dep to 2.3.x to fix CVE

* add publication of API docs on GitHub Pages (#143)

* try fixing release metadata

* update the default base url (#144)

* revert renames of feature_store & update_processor

* [ch92483] Use http gem and add socket factory support (#142)

* update dependencies and add CI for ruby 3 (#141)

* reference eventsource 2.0 in gemspec

* add 5.x releasable branch for releaser

* use Ruby 2.6.6 in releases

* Removed the guides link

* [ch99757] add alias method (#147)

* don't send event for nil user evaluation

* remove lockfile (#148)

* rm redundant nil check

* Experiment Allocation Changes (#150)

* WIP - from sam's pairing session

* starting sdk changes

* adding tests and making sure everything works

* adding more tests

* removing the singleton for fallthrough

* Revert "removing the singleton for fallthrough"

This reverts commit dff7adbb809ecc63118d0fbff9742a88a039c679.

* taking a different approach to keep things immutable

* adding tests for untracked

* remove unnecessary comment

* making sure to return two values in all code paths

Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>

* Use camelCase for JSON property names (#151)

The in_experiment attribute was added to reasons as part of #150 but it doesn't appear to be received in events. I think that's because it's sending it in JSON as "in_experiment" rather than "inExperiment" as we expect to parse it.

* fixing ruby logic causing ih failures (#152)

* fixing ruby logic

* adding missing spec

* Apply suggestions from code review

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* pr tweaks

* making spec language consistent

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* add log warning for missing user key (#153)

* add log warnings for nil/empty user key

* rm warning for empty string key

* fix test

* diagnostic events should respect HTTPS_PROXY (#154)

* minor test simplification (#155)

* allow higher minor versions of json and http gems

* allow v5.x of http gem (#157)

* use Bundler 2.2.10 + modernize CI config (#158)

* enable verbose rspec output

* fix socket factory tests

* restore log suppression

* Replacing deprecated circleci image usage (#159)

* use Releaser v2 config (#161)

* Updates docs URLs

* Update lib/ldclient-rb/ldclient.rb

Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>

* remove reliance on git in gemspec (#163)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504 (#164)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504

* comment phrasing

* Start work on flag builder.

* Add user targeting and rule builder

* Add datasource implementation

* Convert the current_flags hash to use symbols instead of strings as keys

* Fix typo on FlagRuleBuilder copy constructor

* minor refactoring of impl; Added use of new Clause struct instead of Hash in FlagRuleBuilder; Moved TestData.factory out of Impl namespace and renamed Impl to TestDataImpl

* Add the doc comments

* (big segments 1) add public config/interface/reason types (#167)

* Cleanup docstrings to be YARD docs

* Added Util.is_bool helper function to clean up the check for whether an object is a boolean; Removed the DeepCopyHash/DeepCopyArray objects in favor of deep_copy_hash and deep_copy_array functions

* Move public classes out of Impl namespace. Most of it is in public namespace except for the data source now.

* Move require of concurrent/atomics to the correct module

* (big segments 2) implement Big Segments evaluation & status APIs (#168)

* improve CONTRIBUTING.md with notes on code organization

* add note about doc comments

* Cleanup YARD warnings and cleanup docs

* Address PR feedback: Move is_bool back to Impl namespace to avoid confusion; Remove unnecessary nil check on variations in build function; fixup comments

* (big segments 3) implement Redis & DynamoDB big segment stores (#169)

* add missing import

* fix stale calculation

* fix big segments user hash algorithm to use SHA256

* improve & refactor client/evaluation tests

* more cleanup/DRY

* add use_preconfigured_flag and use_preconfigured_segment to TestData (#173)

* always cache big segment query result even if it's nil

* comments

* add test for cache expiration

* use TestData in our own tests (#174)

* use TestData in our own tests

* fix test

* replace LaunchDarkly::FileDataSource with LaunchDarkly::Integrations::FileData

* update ruby-eventsource version for recent SSE fixes

* Bump bundler version (#184)

* Add ability to to set initial reconnect delay (#183)

* Treat secondary as a built-in attribute (#180)

* all_flags_state is invalid if store isn't initialized (#182)

* identify should not emit events if user key is "" (#181)

* Account for traffic allocation on all flags (#185)

* Add contract tests (#178)

* Fix string interpolation in log message (#187)

* Default opts to empty hash when creating persistent feature store (#186)

* Remove Hakiri badge from README (#188)

Hakiri was sunset on January 31st, 2022 at which time our badge stopped
working.

* detect http/https proxy env vars when creating HTTP clients

* rever accidental change

* fix nil safety in test service config

* master -> main (#190)

* master -> main

* update ruby-eventsource version for parsing efficiency fix

* miscellaneous optimizations for event processing (#193)

* Drop support for EOL ruby versions (#196)

Ruby 2.5 was EOL 2021-04-05

As of June 27th, 2022, the latest jRuby is Ruby 2.6 compatible.

* Remove alias support (#195)

* Add polling support for contract test service (#198)

* Update rubocop and enable in CI (#197)

Several of the Rubocop cop definitions have been renamed or moved to
entirely other gems. This brings the configuration up to date with the
latest naming conventions.

* Add windows tests in circleci (#199)

At some point in the past, we were experimenting with using Azure to
verify Window builds. Now that CircleCI supports Windows, we should keep
everything on a single CI provider.

* Add application info support (#194)

* reuse EvaluationDetail instances by precomputing results

* rubocop reformatting

* add super constructor calls

* disable rubocop Rails rules and fix some remaining syntax offenses

* fix super calls

* Add big segment support to contract tests (#201)

* Initial creation of LDContext (#206)

This introduces the initial structure and usage of the LDContext class.

Instances of this class are expected to be created through static
factory methods:

```ruby
LaunchDarkly::LDContext.create({...})
LaunchDarkly::LDContext.create_multi([...])
```

This class is not completed yet. Rather, this initial commit is focused
on the creation patterns and the most basic operations. Subsequent
commits will continue fleshing out this class and its operation.

The `get_value` method will see significant changes as we introduce
attribute reference support. Its current more simplistic implementation
exists only to serve some interim unit tests.

* Add reference based value retrieval (#207)

This commit introduces the References type used for targeting complex
attributes in the new LDContexts.

References are expected to be created through static factory methods:

```ruby
LaunchDarkly::Reference.create("/a/b")
LaunchDarkly::Reference.create_literal("/a/b")
```

These references can be used to retrieve values from an existing
LDContext

```ruby
ref = LaunchDarkly::Reference.create("/a/b")
result = context.get_value_for_reference(ref)
```

* Basic changes to use contexts in evaluations instead of users (#208)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

This replaces `LDUser` with `LDContext` in the parameters for
evaluations, and makes the minimum necessary adjustments to allow
evaluations to keep working as before as long as the context kind is
"user". None of the new behavior defined in the U2C spec is implemented
yet.

Generation of evaluation events is temporarily disabled because the
event logic hasn't been updated yet.

U2C contract tests for evaluations are partially enabled; a lot of
functionality is still missing, but all the tests that only cover
previously-existing evaluation behavior are passing.

[pr]: launchdarkly/php-server-sdk-private#103

* Support ContextKind in Clauses (#209)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

The main features of this commit are:

- introduction of `individual_context` and `individual_context_count`
  methods 
- context kind matching in clauses

[pr]: launchdarkly/php-server-sdk-private#108

* Support included / excluded contexts in segments (#210)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

Segments are now able to provide `includedContext` and `excludedContext`
properties which can target values within a specific context kind.

```json
{
    "includedContexts": [
        {
            "contextKind": "org",
            "values": ["orgkey1", "orgkey2"]
        }
    ]
}
```

[pr]: launchdarkly/php-server-sdk-private#111

* Add contextKind support for rollouts & experiements (#211)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

[pr]: launchdarkly/php-server-sdk-private#110

* Style and test matcher improvements (#212)

This commit enables several rubocop rules that were previously disabled.
Once enabled, `rubocop -A` was run to automatically apply these fixes.

There are a couple of additional changes that were made by hand:

- I added the rubocop and rubocop-performance gems as dev packages. This
  should help address the original installation issue we ran into when I
  introduced these tools.

- By default, new rubocop rules are disabled. This was the default
  before, but if you don't explicitly set this value, each run generates
  a ton of warning noise. This quiets that down.

- Updates some LDContext tests to be more strict in their expectations
  of truth.

* Remove support for secondary attribute (#213)

As decided in the [spec], we are removing the special behavior of the
secondary attribute. Going forward, secondary will be treated like any
other attribute, and will no longer be included when determining the
bucket for a context.

[spec]:
https://launchdarkly.atlassian.net/wiki/spaces/ENG/pages/2165212563/Consistent+and+Transparent+Rollout+Behavior+Unifying+Percent+Rollout+and+Traffic+Allocation

* Remove deprecated APIs (#214)

Since the users to context change requires a version break, this is the
perfect time to remove previously deprecated bits of functionality. This
includes:

- Removing `update_processor*` config entries
- `FileDataSource` entry point
- `RedisFeatureStore` entry point
- `Redis::sadd?` warning in unit tests

* store data model with classes that aren't Hash

* lint

* remove [] override methods in places where we don't need them

* comments

* migrate some more of the model to be non-hash classes

* lint

* Anonymous cannot be nil in new context format (#216)

The legacy user format allowed anonymous to be missing or explicitly
provided but set to nil.

The new context format requires anonymous to either not be set, or if it
is explicitly set, it must be a boolean value.

* Tweak error message language and style (#217)

Our previous error messages suffered from a couple drawbacks:

- The messages were complete sentences, limiting our ability to compose
  error messages
- The messages were overly broad in many cases
- The messages unnecessarily required string interpolation that rarely
  provided much value

These new messages are more succinct and are written as small clauses
which can be used in conjunction with other error messages more easily.

* copyedit

Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>

* Implement prerequisite cycle detection (#219)

* Support attribute reference lookups (#215)

This adds support for slash-delimited paths in clause attributes,
bucketBy, etc. It does not do anything related to private attribute
redaction because none of the U2C event logic is implemented yet.

* Implement segment recursion and cycle detection (#220)

Clauses in segment rules are now allowed to reference segments. To
prevent an infinite recursion edge case, we implement a similar cycle
detection mechanism as used on prerequisites.

* Update event logic to support users to context change (#221)

* Add legacy user-type support to the contract tests (#222)

* Remove inline user configuration option (#223)

* Add context_ configuration options (#224)

These new context_ configuration options are meant to replace the
historic user_ options. If both are provided, the context_ variant will
take precedence.

* Add support for flag context targets (#225)

* Bump diplomat

* Bump redis

* Remove oga

* Bump connection_pool

* Favor set for faster target lookups (#228)

A few of our internal models maintain arrays of values. These arrays can
frequently be checked to see if they contain specific values.

Since set lookups are much faster than array lookups, this commit
changes the internal structure to a set for the values stored in Target
and SegmentTarget.

* Add secure mode hash to contract tests (#229)

* Update big segment support for users to context (#226)

To support the users to context change for big segments, this commit
makes the following changes:

- Introduces a new `Segment.unboundedContextKind` attribute. This will
default to `LDContext::KIND_DEFAULT` and is only referenced when
`Segment.unbounded` is true.

- With the creation of multi-kind contexts, a single evaluation may
result in multiple queries to the big segment store. This is reflected
in the changes to the `EvalResult` processing.

* Drop support for ruby 2.6 (#227)

Ruby 2.6 went EOL in March 2022. We originally didn't drop support for
it as doing so would require dropping support for jRuby as well.
However, jRuby recently released 9.4 which is Ruby 2.7+ compatible.

* Update remaining references from user to contexts (#231)

There are multiple places throughout the code where we are still
referencing users. I have tried to update all the places where a rename
seems reasonable or appropriate. There is still some work to do in the
test flag builders, but that will be done in a subsequent commit.

* Remove new relic integration (#233)

The new relic integration was removed many versions ago but a small
trace remained behind.

* Rename config option private_attribute_names (#234)

Co-authored-by: Eli Bishop <eli@launchdarkly.com>

* Update test data integration to support contexts (#232)

* improve data model validation logging; allow missing/empty attribute for segmentMatch (#236)

* Fix JSON serialization failure (#237)

When we introduced models for the flag and segment data, we added
to_json methods which proxy to the underlying to_json method provided by
the `json` gem.

We defined the method with a variadic parameter, but we failed to unpack
it when passing it on to the underlying implementation. This resulted in
a serialization failure which prevented the redis data store from
initializing.

* fix: Bump eventsource to resolve header parsing (#239)

The underlying event source library had an issue where, in certain
environments, content-type header detection was failing.

This was resolved in v2.2.2 of the event source gem.

* Add key to error log for invalid context during variation call for easier debugging (#214)

---------

Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com>
Co-authored-by: Jacob Smith <jacob@jacobsmith.io>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: hroederld <hroeder@launchdarkly.com>
Co-authored-by: Kerrie Martinez <kyee@launchdarkly.com>
Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>
Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Ember Stevens <ember.stevens@launchdarkly.com>
Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Matthew M. Keeler <keelerm84@gmail.com>
Co-authored-by: Ben Levy <benjaminlevy007@gmail.com>
Co-authored-by: Ben Levy <ben@foxhound.systems>
Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
Co-authored-by: Matt Hooks <46452201+matt-dutchie@users.noreply.github.com>
LaunchDarklyReleaseBot added a commit that referenced this pull request Apr 13, 2023
@LaunchDarklyReleaseBot @eli-darkly
@LaunchDarklyCI @jacobthemyth @apache-hb @bwoskow-ld @hroederld @ld-kyee @pellyg-ld @samstokes @ember-stevens @louis-launchdarkly @keelerm84 @belevy @matt-dutchie
prepare 7.1.0 release (#217)
1b96d04 
* make EvaluationReason an immutable class

* FrozenError doesn't exist in older Ruby, use more general RuntimeError

* precompute evaluation reasons when we receive a flag

* rm unused

* rename FeatureStore to DataStore

* remove references to UpdateProcessor (now DataSource)

* add event payload ID header

* (6.0) drop support for old Ruby versions

* add Ruby version constraint to gemspec

* remove Rake dependency

* update ld-eventsource to 1.0.2 which doesn't have Rake dependency

* implement diagnostic events in Ruby (#130)

* update ruby-eventsource to 1.0.3 for backoff bug

* fix incorrect initialization of EventProcessor

* remove install-time openssl check that breaks if you don't have rake

* treat comparison with wrong data type as a non-match, not an exception (#134)

* fail fast for nil SDK key when appropriate

* tolerate nil value for user.custom (#137)

* Only shutdown the Redis pool if it is owned by the SDK (#158)

* Only shutdown a Redis pool created by SDK

* Make pool shutdown behavior an option

* improve doc comment

* remove support for indirect/patch and indirect/put (#138)

* update to json 2.3.1 (#139)

* update json dep to 2.3.x to fix CVE

* add publication of API docs on GitHub Pages (#143)

* try fixing release metadata

* update the default base url (#144)

* revert renames of feature_store & update_processor

* [ch92483] Use http gem and add socket factory support (#142)

* update dependencies and add CI for ruby 3 (#141)

* reference eventsource 2.0 in gemspec

* add 5.x releasable branch for releaser

* use Ruby 2.6.6 in releases

* Removed the guides link

* [ch99757] add alias method (#147)

* don't send event for nil user evaluation

* remove lockfile (#148)

* rm redundant nil check

* Experiment Allocation Changes (#150)

* WIP - from sam's pairing session

* starting sdk changes

* adding tests and making sure everything works

* adding more tests

* removing the singleton for fallthrough

* Revert "removing the singleton for fallthrough"

This reverts commit dff7adbb809ecc63118d0fbff9742a88a039c679.

* taking a different approach to keep things immutable

* adding tests for untracked

* remove unnecessary comment

* making sure to return two values in all code paths

Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>

* Use camelCase for JSON property names (#151)

The in_experiment attribute was added to reasons as part of #150 but it doesn't appear to be received in events. I think that's because it's sending it in JSON as "in_experiment" rather than "inExperiment" as we expect to parse it.

* fixing ruby logic causing ih failures (#152)

* fixing ruby logic

* adding missing spec

* Apply suggestions from code review

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* pr tweaks

* making spec language consistent

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* add log warning for missing user key (#153)

* add log warnings for nil/empty user key

* rm warning for empty string key

* fix test

* diagnostic events should respect HTTPS_PROXY (#154)

* minor test simplification (#155)

* allow higher minor versions of json and http gems

* allow v5.x of http gem (#157)

* use Bundler 2.2.10 + modernize CI config (#158)

* enable verbose rspec output

* fix socket factory tests

* restore log suppression

* Replacing deprecated circleci image usage (#159)

* use Releaser v2 config (#161)

* Updates docs URLs

* Update lib/ldclient-rb/ldclient.rb

Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>

* remove reliance on git in gemspec (#163)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504 (#164)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504

* comment phrasing

* Start work on flag builder.

* Add user targeting and rule builder

* Add datasource implementation

* Convert the current_flags hash to use symbols instead of strings as keys

* Fix typo on FlagRuleBuilder copy constructor

* minor refactoring of impl; Added use of new Clause struct instead of Hash in FlagRuleBuilder; Moved TestData.factory out of Impl namespace and renamed Impl to TestDataImpl

* Add the doc comments

* (big segments 1) add public config/interface/reason types (#167)

* Cleanup docstrings to be YARD docs

* Added Util.is_bool helper function to clean up the check for whether an object is a boolean; Removed the DeepCopyHash/DeepCopyArray objects in favor of deep_copy_hash and deep_copy_array functions

* Move public classes out of Impl namespace. Most of it is in public namespace except for the data source now.

* Move require of concurrent/atomics to the correct module

* (big segments 2) implement Big Segments evaluation & status APIs (#168)

* improve CONTRIBUTING.md with notes on code organization

* add note about doc comments

* Cleanup YARD warnings and cleanup docs

* Address PR feedback: Move is_bool back to Impl namespace to avoid confusion; Remove unnecessary nil check on variations in build function; fixup comments

* (big segments 3) implement Redis & DynamoDB big segment stores (#169)

* add missing import

* fix stale calculation

* fix big segments user hash algorithm to use SHA256

* improve & refactor client/evaluation tests

* more cleanup/DRY

* add use_preconfigured_flag and use_preconfigured_segment to TestData (#173)

* always cache big segment query result even if it's nil

* comments

* add test for cache expiration

* use TestData in our own tests (#174)

* use TestData in our own tests

* fix test

* replace LaunchDarkly::FileDataSource with LaunchDarkly::Integrations::FileData

* update ruby-eventsource version for recent SSE fixes

* Bump bundler version (#184)

* Add ability to to set initial reconnect delay (#183)

* Treat secondary as a built-in attribute (#180)

* all_flags_state is invalid if store isn't initialized (#182)

* identify should not emit events if user key is "" (#181)

* Account for traffic allocation on all flags (#185)

* Add contract tests (#178)

* Fix string interpolation in log message (#187)

* Default opts to empty hash when creating persistent feature store (#186)

* Remove Hakiri badge from README (#188)

Hakiri was sunset on January 31st, 2022 at which time our badge stopped
working.

* detect http/https proxy env vars when creating HTTP clients

* rever accidental change

* fix nil safety in test service config

* master -> main (#190)

* master -> main

* update ruby-eventsource version for parsing efficiency fix

* miscellaneous optimizations for event processing (#193)

* Drop support for EOL ruby versions (#196)

Ruby 2.5 was EOL 2021-04-05

As of June 27th, 2022, the latest jRuby is Ruby 2.6 compatible.

* Remove alias support (#195)

* Add polling support for contract test service (#198)

* Update rubocop and enable in CI (#197)

Several of the Rubocop cop definitions have been renamed or moved to
entirely other gems. This brings the configuration up to date with the
latest naming conventions.

* Add windows tests in circleci (#199)

At some point in the past, we were experimenting with using Azure to
verify Window builds. Now that CircleCI supports Windows, we should keep
everything on a single CI provider.

* Add application info support (#194)

* reuse EvaluationDetail instances by precomputing results

* rubocop reformatting

* add super constructor calls

* disable rubocop Rails rules and fix some remaining syntax offenses

* fix super calls

* Add big segment support to contract tests (#201)

* Initial creation of LDContext (#206)

This introduces the initial structure and usage of the LDContext class.

Instances of this class are expected to be created through static
factory methods:

```ruby
LaunchDarkly::LDContext.create({...})
LaunchDarkly::LDContext.create_multi([...])
```

This class is not completed yet. Rather, this initial commit is focused
on the creation patterns and the most basic operations. Subsequent
commits will continue fleshing out this class and its operation.

The `get_value` method will see significant changes as we introduce
attribute reference support. Its current more simplistic implementation
exists only to serve some interim unit tests.

* Add reference based value retrieval (#207)

This commit introduces the References type used for targeting complex
attributes in the new LDContexts.

References are expected to be created through static factory methods:

```ruby
LaunchDarkly::Reference.create("/a/b")
LaunchDarkly::Reference.create_literal("/a/b")
```

These references can be used to retrieve values from an existing
LDContext

```ruby
ref = LaunchDarkly::Reference.create("/a/b")
result = context.get_value_for_reference(ref)
```

* Basic changes to use contexts in evaluations instead of users (#208)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

This replaces `LDUser` with `LDContext` in the parameters for
evaluations, and makes the minimum necessary adjustments to allow
evaluations to keep working as before as long as the context kind is
"user". None of the new behavior defined in the U2C spec is implemented
yet.

Generation of evaluation events is temporarily disabled because the
event logic hasn't been updated yet.

U2C contract tests for evaluations are partially enabled; a lot of
functionality is still missing, but all the tests that only cover
previously-existing evaluation behavior are passing.

[pr]: launchdarkly/php-server-sdk-private#103

* Support ContextKind in Clauses (#209)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

The main features of this commit are:

- introduction of `individual_context` and `individual_context_count`
  methods 
- context kind matching in clauses

[pr]: launchdarkly/php-server-sdk-private#108

* Support included / excluded contexts in segments (#210)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

Segments are now able to provide `includedContext` and `excludedContext`
properties which can target values within a specific context kind.

```json
{
    "includedContexts": [
        {
            "contextKind": "org",
            "values": ["orgkey1", "orgkey2"]
        }
    ]
}
```

[pr]: launchdarkly/php-server-sdk-private#111

* Add contextKind support for rollouts & experiements (#211)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

[pr]: launchdarkly/php-server-sdk-private#110

* Style and test matcher improvements (#212)

This commit enables several rubocop rules that were previously disabled.
Once enabled, `rubocop -A` was run to automatically apply these fixes.

There are a couple of additional changes that were made by hand:

- I added the rubocop and rubocop-performance gems as dev packages. This
  should help address the original installation issue we ran into when I
  introduced these tools.

- By default, new rubocop rules are disabled. This was the default
  before, but if you don't explicitly set this value, each run generates
  a ton of warning noise. This quiets that down.

- Updates some LDContext tests to be more strict in their expectations
  of truth.

* Remove support for secondary attribute (#213)

As decided in the [spec], we are removing the special behavior of the
secondary attribute. Going forward, secondary will be treated like any
other attribute, and will no longer be included when determining the
bucket for a context.

[spec]:
https://launchdarkly.atlassian.net/wiki/spaces/ENG/pages/2165212563/Consistent+and+Transparent+Rollout+Behavior+Unifying+Percent+Rollout+and+Traffic+Allocation

* Remove deprecated APIs (#214)

Since the users to context change requires a version break, this is the
perfect time to remove previously deprecated bits of functionality. This
includes:

- Removing `update_processor*` config entries
- `FileDataSource` entry point
- `RedisFeatureStore` entry point
- `Redis::sadd?` warning in unit tests

* store data model with classes that aren't Hash

* lint

* remove [] override methods in places where we don't need them

* comments

* migrate some more of the model to be non-hash classes

* lint

* Anonymous cannot be nil in new context format (#216)

The legacy user format allowed anonymous to be missing or explicitly
provided but set to nil.

The new context format requires anonymous to either not be set, or if it
is explicitly set, it must be a boolean value.

* Tweak error message language and style (#217)

Our previous error messages suffered from a couple drawbacks:

- The messages were complete sentences, limiting our ability to compose
  error messages
- The messages were overly broad in many cases
- The messages unnecessarily required string interpolation that rarely
  provided much value

These new messages are more succinct and are written as small clauses
which can be used in conjunction with other error messages more easily.

* copyedit

Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>

* Implement prerequisite cycle detection (#219)

* Support attribute reference lookups (#215)

This adds support for slash-delimited paths in clause attributes,
bucketBy, etc. It does not do anything related to private attribute
redaction because none of the U2C event logic is implemented yet.

* Implement segment recursion and cycle detection (#220)

Clauses in segment rules are now allowed to reference segments. To
prevent an infinite recursion edge case, we implement a similar cycle
detection mechanism as used on prerequisites.

* Update event logic to support users to context change (#221)

* Add legacy user-type support to the contract tests (#222)

* Remove inline user configuration option (#223)

* Add context_ configuration options (#224)

These new context_ configuration options are meant to replace the
historic user_ options. If both are provided, the context_ variant will
take precedence.

* Add support for flag context targets (#225)

* Bump diplomat

* Bump redis

* Remove oga

* Bump connection_pool

* Favor set for faster target lookups (#228)

A few of our internal models maintain arrays of values. These arrays can
frequently be checked to see if they contain specific values.

Since set lookups are much faster than array lookups, this commit
changes the internal structure to a set for the values stored in Target
and SegmentTarget.

* Add secure mode hash to contract tests (#229)

* Update big segment support for users to context (#226)

To support the users to context change for big segments, this commit
makes the following changes:

- Introduces a new `Segment.unboundedContextKind` attribute. This will
default to `LDContext::KIND_DEFAULT` and is only referenced when
`Segment.unbounded` is true.

- With the creation of multi-kind contexts, a single evaluation may
result in multiple queries to the big segment store. This is reflected
in the changes to the `EvalResult` processing.

* Drop support for ruby 2.6 (#227)

Ruby 2.6 went EOL in March 2022. We originally didn't drop support for
it as doing so would require dropping support for jRuby as well.
However, jRuby recently released 9.4 which is Ruby 2.7+ compatible.

* Update remaining references from user to contexts (#231)

There are multiple places throughout the code where we are still
referencing users. I have tried to update all the places where a rename
seems reasonable or appropriate. There is still some work to do in the
test flag builders, but that will be done in a subsequent commit.

* Remove new relic integration (#233)

The new relic integration was removed many versions ago but a small
trace remained behind.

* Rename config option private_attribute_names (#234)

Co-authored-by: Eli Bishop <eli@launchdarkly.com>

* Update test data integration to support contexts (#232)

* improve data model validation logging; allow missing/empty attribute for segmentMatch (#236)

* Fix JSON serialization failure (#237)

When we introduced models for the flag and segment data, we added
to_json methods which proxy to the underlying to_json method provided by
the `json` gem.

We defined the method with a variadic parameter, but we failed to unpack
it when passing it on to the underlying implementation. This resulted in
a serialization failure which prevented the redis data store from
initializing.

* fix: Bump eventsource to resolve header parsing (#239)

The underlying event source library had an issue where, in certain
environments, content-type header detection was failing.

This was resolved in v2.2.2 of the event source gem.

* Add key to error log for invalid context during variation call for easier debugging (#214)

* feat: Add support for payload filtering (#238)

---------

Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com>
Co-authored-by: Jacob Smith <jacob@jacobsmith.io>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: hroederld <hroeder@launchdarkly.com>
Co-authored-by: Kerrie Martinez <kyee@launchdarkly.com>
Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>
Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Ember Stevens <ember.stevens@launchdarkly.com>
Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Matthew M. Keeler <keelerm84@gmail.com>
Co-authored-by: Ben Levy <benjaminlevy007@gmail.com>
Co-authored-by: Ben Levy <ben@foxhound.systems>
Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
Co-authored-by: Matt Hooks <46452201+matt-dutchie@users.noreply.github.com>
LaunchDarklyReleaseBot added a commit that referenced this pull request May 4, 2023
@LaunchDarklyReleaseBot @eli-darkly
@LaunchDarklyCI @jacobthemyth @apache-hb @bwoskow-ld @hroederld @ld-kyee @pellyg-ld @samstokes @ember-stevens @louis-launchdarkly @keelerm84 @belevy @matt-dutchie
prepare 7.2.0 release (#218)
01dc51d 
* add event payload ID header

* (6.0) drop support for old Ruby versions

* add Ruby version constraint to gemspec

* remove Rake dependency

* update ld-eventsource to 1.0.2 which doesn't have Rake dependency

* implement diagnostic events in Ruby (#130)

* update ruby-eventsource to 1.0.3 for backoff bug

* fix incorrect initialization of EventProcessor

* remove install-time openssl check that breaks if you don't have rake

* treat comparison with wrong data type as a non-match, not an exception (#134)

* fail fast for nil SDK key when appropriate

* tolerate nil value for user.custom (#137)

* Only shutdown the Redis pool if it is owned by the SDK (#158)

* Only shutdown a Redis pool created by SDK

* Make pool shutdown behavior an option

* improve doc comment

* remove support for indirect/patch and indirect/put (#138)

* update to json 2.3.1 (#139)

* update json dep to 2.3.x to fix CVE

* add publication of API docs on GitHub Pages (#143)

* try fixing release metadata

* update the default base url (#144)

* revert renames of feature_store & update_processor

* [ch92483] Use http gem and add socket factory support (#142)

* update dependencies and add CI for ruby 3 (#141)

* reference eventsource 2.0 in gemspec

* add 5.x releasable branch for releaser

* use Ruby 2.6.6 in releases

* Removed the guides link

* [ch99757] add alias method (#147)

* don't send event for nil user evaluation

* remove lockfile (#148)

* rm redundant nil check

* Experiment Allocation Changes (#150)

* WIP - from sam's pairing session

* starting sdk changes

* adding tests and making sure everything works

* adding more tests

* removing the singleton for fallthrough

* Revert "removing the singleton for fallthrough"

This reverts commit dff7adbb809ecc63118d0fbff9742a88a039c679.

* taking a different approach to keep things immutable

* adding tests for untracked

* remove unnecessary comment

* making sure to return two values in all code paths

Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>

* Use camelCase for JSON property names (#151)

The in_experiment attribute was added to reasons as part of #150 but it doesn't appear to be received in events. I think that's because it's sending it in JSON as "in_experiment" rather than "inExperiment" as we expect to parse it.

* fixing ruby logic causing ih failures (#152)

* fixing ruby logic

* adding missing spec

* Apply suggestions from code review

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* pr tweaks

* making spec language consistent

Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>

* add log warning for missing user key (#153)

* add log warnings for nil/empty user key

* rm warning for empty string key

* fix test

* diagnostic events should respect HTTPS_PROXY (#154)

* minor test simplification (#155)

* allow higher minor versions of json and http gems

* allow v5.x of http gem (#157)

* use Bundler 2.2.10 + modernize CI config (#158)

* enable verbose rspec output

* fix socket factory tests

* restore log suppression

* Replacing deprecated circleci image usage (#159)

* use Releaser v2 config (#161)

* Updates docs URLs

* Update lib/ldclient-rb/ldclient.rb

Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>

* remove reliance on git in gemspec (#163)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504 (#164)

* use ruby-eventsource 2.1.1 for fix of sc-123850 and sc-125504

* comment phrasing

* Start work on flag builder.

* Add user targeting and rule builder

* Add datasource implementation

* Convert the current_flags hash to use symbols instead of strings as keys

* Fix typo on FlagRuleBuilder copy constructor

* minor refactoring of impl; Added use of new Clause struct instead of Hash in FlagRuleBuilder; Moved TestData.factory out of Impl namespace and renamed Impl to TestDataImpl

* Add the doc comments

* (big segments 1) add public config/interface/reason types (#167)

* Cleanup docstrings to be YARD docs

* Added Util.is_bool helper function to clean up the check for whether an object is a boolean; Removed the DeepCopyHash/DeepCopyArray objects in favor of deep_copy_hash and deep_copy_array functions

* Move public classes out of Impl namespace. Most of it is in public namespace except for the data source now.

* Move require of concurrent/atomics to the correct module

* (big segments 2) implement Big Segments evaluation & status APIs (#168)

* improve CONTRIBUTING.md with notes on code organization

* add note about doc comments

* Cleanup YARD warnings and cleanup docs

* Address PR feedback: Move is_bool back to Impl namespace to avoid confusion; Remove unnecessary nil check on variations in build function; fixup comments

* (big segments 3) implement Redis & DynamoDB big segment stores (#169)

* add missing import

* fix stale calculation

* fix big segments user hash algorithm to use SHA256

* improve & refactor client/evaluation tests

* more cleanup/DRY

* add use_preconfigured_flag and use_preconfigured_segment to TestData (#173)

* always cache big segment query result even if it's nil

* comments

* add test for cache expiration

* use TestData in our own tests (#174)

* use TestData in our own tests

* fix test

* replace LaunchDarkly::FileDataSource with LaunchDarkly::Integrations::FileData

* update ruby-eventsource version for recent SSE fixes

* Bump bundler version (#184)

* Add ability to to set initial reconnect delay (#183)

* Treat secondary as a built-in attribute (#180)

* all_flags_state is invalid if store isn't initialized (#182)

* identify should not emit events if user key is "" (#181)

* Account for traffic allocation on all flags (#185)

* Add contract tests (#178)

* Fix string interpolation in log message (#187)

* Default opts to empty hash when creating persistent feature store (#186)

* Remove Hakiri badge from README (#188)

Hakiri was sunset on January 31st, 2022 at which time our badge stopped
working.

* detect http/https proxy env vars when creating HTTP clients

* rever accidental change

* fix nil safety in test service config

* master -> main (#190)

* master -> main

* update ruby-eventsource version for parsing efficiency fix

* miscellaneous optimizations for event processing (#193)

* Drop support for EOL ruby versions (#196)

Ruby 2.5 was EOL 2021-04-05

As of June 27th, 2022, the latest jRuby is Ruby 2.6 compatible.

* Remove alias support (#195)

* Add polling support for contract test service (#198)

* Update rubocop and enable in CI (#197)

Several of the Rubocop cop definitions have been renamed or moved to
entirely other gems. This brings the configuration up to date with the
latest naming conventions.

* Add windows tests in circleci (#199)

At some point in the past, we were experimenting with using Azure to
verify Window builds. Now that CircleCI supports Windows, we should keep
everything on a single CI provider.

* Add application info support (#194)

* reuse EvaluationDetail instances by precomputing results

* rubocop reformatting

* add super constructor calls

* disable rubocop Rails rules and fix some remaining syntax offenses

* fix super calls

* Add big segment support to contract tests (#201)

* Initial creation of LDContext (#206)

This introduces the initial structure and usage of the LDContext class.

Instances of this class are expected to be created through static
factory methods:

```ruby
LaunchDarkly::LDContext.create({...})
LaunchDarkly::LDContext.create_multi([...])
```

This class is not completed yet. Rather, this initial commit is focused
on the creation patterns and the most basic operations. Subsequent
commits will continue fleshing out this class and its operation.

The `get_value` method will see significant changes as we introduce
attribute reference support. Its current more simplistic implementation
exists only to serve some interim unit tests.

* Add reference based value retrieval (#207)

This commit introduces the References type used for targeting complex
attributes in the new LDContexts.

References are expected to be created through static factory methods:

```ruby
LaunchDarkly::Reference.create("/a/b")
LaunchDarkly::Reference.create_literal("/a/b")
```

These references can be used to retrieve values from an existing
LDContext

```ruby
ref = LaunchDarkly::Reference.create("/a/b")
result = context.get_value_for_reference(ref)
```

* Basic changes to use contexts in evaluations instead of users (#208)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

This replaces `LDUser` with `LDContext` in the parameters for
evaluations, and makes the minimum necessary adjustments to allow
evaluations to keep working as before as long as the context kind is
"user". None of the new behavior defined in the U2C spec is implemented
yet.

Generation of evaluation events is temporarily disabled because the
event logic hasn't been updated yet.

U2C contract tests for evaluations are partially enabled; a lot of
functionality is still missing, but all the tests that only cover
previously-existing evaluation behavior are passing.

[pr]: launchdarkly/php-server-sdk-private#103

* Support ContextKind in Clauses (#209)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

The main features of this commit are:

- introduction of `individual_context` and `individual_context_count`
  methods 
- context kind matching in clauses

[pr]: launchdarkly/php-server-sdk-private#108

* Support included / excluded contexts in segments (#210)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

Segments are now able to provide `includedContext` and `excludedContext`
properties which can target values within a specific context kind.

```json
{
    "includedContexts": [
        {
            "contextKind": "org",
            "values": ["orgkey1", "orgkey2"]
        }
    ]
}
```

[pr]: launchdarkly/php-server-sdk-private#111

* Add contextKind support for rollouts & experiements (#211)

This commit follows the general approach of the [equivalent PHP SDK
PR][pr].

[pr]: launchdarkly/php-server-sdk-private#110

* Style and test matcher improvements (#212)

This commit enables several rubocop rules that were previously disabled.
Once enabled, `rubocop -A` was run to automatically apply these fixes.

There are a couple of additional changes that were made by hand:

- I added the rubocop and rubocop-performance gems as dev packages. This
  should help address the original installation issue we ran into when I
  introduced these tools.

- By default, new rubocop rules are disabled. This was the default
  before, but if you don't explicitly set this value, each run generates
  a ton of warning noise. This quiets that down.

- Updates some LDContext tests to be more strict in their expectations
  of truth.

* Remove support for secondary attribute (#213)

As decided in the [spec], we are removing the special behavior of the
secondary attribute. Going forward, secondary will be treated like any
other attribute, and will no longer be included when determining the
bucket for a context.

[spec]:
https://launchdarkly.atlassian.net/wiki/spaces/ENG/pages/2165212563/Consistent+and+Transparent+Rollout+Behavior+Unifying+Percent+Rollout+and+Traffic+Allocation

* Remove deprecated APIs (#214)

Since the users to context change requires a version break, this is the
perfect time to remove previously deprecated bits of functionality. This
includes:

- Removing `update_processor*` config entries
- `FileDataSource` entry point
- `RedisFeatureStore` entry point
- `Redis::sadd?` warning in unit tests

* store data model with classes that aren't Hash

* lint

* remove [] override methods in places where we don't need them

* comments

* migrate some more of the model to be non-hash classes

* lint

* Anonymous cannot be nil in new context format (#216)

The legacy user format allowed anonymous to be missing or explicitly
provided but set to nil.

The new context format requires anonymous to either not be set, or if it
is explicitly set, it must be a boolean value.

* Tweak error message language and style (#217)

Our previous error messages suffered from a couple drawbacks:

- The messages were complete sentences, limiting our ability to compose
  error messages
- The messages were overly broad in many cases
- The messages unnecessarily required string interpolation that rarely
  provided much value

These new messages are more succinct and are written as small clauses
which can be used in conjunction with other error messages more easily.

* copyedit

Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>

* Implement prerequisite cycle detection (#219)

* Support attribute reference lookups (#215)

This adds support for slash-delimited paths in clause attributes,
bucketBy, etc. It does not do anything related to private attribute
redaction because none of the U2C event logic is implemented yet.

* Implement segment recursion and cycle detection (#220)

Clauses in segment rules are now allowed to reference segments. To
prevent an infinite recursion edge case, we implement a similar cycle
detection mechanism as used on prerequisites.

* Update event logic to support users to context change (#221)

* Add legacy user-type support to the contract tests (#222)

* Remove inline user configuration option (#223)

* Add context_ configuration options (#224)

These new context_ configuration options are meant to replace the
historic user_ options. If both are provided, the context_ variant will
take precedence.

* Add support for flag context targets (#225)

* Bump diplomat

* Bump redis

* Remove oga

* Bump connection_pool

* Favor set for faster target lookups (#228)

A few of our internal models maintain arrays of values. These arrays can
frequently be checked to see if they contain specific values.

Since set lookups are much faster than array lookups, this commit
changes the internal structure to a set for the values stored in Target
and SegmentTarget.

* Add secure mode hash to contract tests (#229)

* Update big segment support for users to context (#226)

To support the users to context change for big segments, this commit
makes the following changes:

- Introduces a new `Segment.unboundedContextKind` attribute. This will
default to `LDContext::KIND_DEFAULT` and is only referenced when
`Segment.unbounded` is true.

- With the creation of multi-kind contexts, a single evaluation may
result in multiple queries to the big segment store. This is reflected
in the changes to the `EvalResult` processing.

* Drop support for ruby 2.6 (#227)

Ruby 2.6 went EOL in March 2022. We originally didn't drop support for
it as doing so would require dropping support for jRuby as well.
However, jRuby recently released 9.4 which is Ruby 2.7+ compatible.

* Update remaining references from user to contexts (#231)

There are multiple places throughout the code where we are still
referencing users. I have tried to update all the places where a rename
seems reasonable or appropriate. There is still some work to do in the
test flag builders, but that will be done in a subsequent commit.

* Remove new relic integration (#233)

The new relic integration was removed many versions ago but a small
trace remained behind.

* Rename config option private_attribute_names (#234)

Co-authored-by: Eli Bishop <eli@launchdarkly.com>

* Update test data integration to support contexts (#232)

* improve data model validation logging; allow missing/empty attribute for segmentMatch (#236)

* Fix JSON serialization failure (#237)

When we introduced models for the flag and segment data, we added
to_json methods which proxy to the underlying to_json method provided by
the `json` gem.

We defined the method with a variadic parameter, but we failed to unpack
it when passing it on to the underlying implementation. This resulted in
a serialization failure which prevented the redis data store from
initializing.

* fix: Bump eventsource to resolve header parsing (#239)

The underlying event source library had an issue where, in certain
environments, content-type header detection was failing.

This was resolved in v2.2.2 of the event source gem.

* Add key to error log for invalid context during variation call for easier debugging (#214)

* feat: Add support for payload filtering (#238)

* feat: Add data source status provider support (#240)

The client instance will now provide access to a
`data_source_status_provider`. This provider allows developers to
retrieve the status of the SDK on demand, or asynchronously by
registering listeners.

* test: Skip database integration tests by default (#241)

The full unit test suite includes tests relying on externally instances
of Redis, Consult, and DynamoDB.

By default, we do not want to run these tests. Rather, they should be
opt-in by setting the environment variable `LD_SKIP_DATABASE_TESTS=0`.

* feat: Introduce flag change tracker api (#242)

The client instance will now provide access to a `flag_tracker`. This
tracker allows developers to be notified when a flag configuration
changes (or optionally when the /value/ of a flag changes for a
particular context).

* ci: Add code coverage generation (#244)

* feat: Add support for data store status monitoring (#243)

The client instance will now provide access to a
`data_store_status_provider`. This provider allows developers to
retrieve the data store status of the SDK on demand, or asynchronously
by registering listeners.

* Fix monitoring_enabled? access

---------

Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com>
Co-authored-by: Jacob Smith <jacob@jacobsmith.io>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: hroederld <hroeder@launchdarkly.com>
Co-authored-by: Kerrie Martinez <kyee@launchdarkly.com>
Co-authored-by: pellyg-ld <gpelly@launchdarkly.com>
Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Ember Stevens <ember.stevens@launchdarkly.com>
Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Matthew M. Keeler <keelerm84@gmail.com>
Co-authored-by: Ben Levy <benjaminlevy007@gmail.com>
Co-authored-by: Ben Levy <ben@foxhound.systems>
Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
Co-authored-by: Matt Hooks <46452201+matt-dutchie@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eli-darkly eli-darkly eli-darkly approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tonyta @eli-darkly