Skip to content

Commit

Permalink
prepare 7.2.0 release (#218)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
21 people authored May 4, 2023
1 parent d8cc735 commit 01dc51d
Show file tree
Hide file tree
Showing 35 changed files with 2,138 additions and 74 deletions.
10 changes: 10 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ jobs:
build-test-windows:
executor: win/default

environment:
LD_SKIP_DATABASE_TESTS: 0
LD_ENABLE_CODE_COVERAGE: 1

steps:
- checkout

Expand Down Expand Up @@ -79,6 +83,7 @@ jobs:
- run: bundle _2.2.33_ install
- run: mkdir /tmp/circle-artifacts
- run: bundle _2.2.33_ exec rspec --format documentation --format RspecJunitFormatter -o /tmp/circle-artifacts/rspec.xml spec
- run: mv coverage /tmp/circle-artifacts/

- store_test_results:
path: /tmp/circle-artifacts
Expand All @@ -99,6 +104,10 @@ jobs:
- image: redis
- image: amazon/dynamodb-local

environment:
LD_SKIP_DATABASE_TESTS: 0
LD_ENABLE_CODE_COVERAGE: 1

steps:
- checkout
- when:
Expand All @@ -116,6 +125,7 @@ jobs:
- run: bundle _2.2.33_ install
- run: mkdir /tmp/circle-artifacts
- run: bundle _2.2.33_ exec rspec --format documentation --format RspecJunitFormatter -o /tmp/circle-artifacts/rspec.xml spec
- run: mv coverage /tmp/circle-artifacts/

- when:
condition:
Expand Down
2 changes: 0 additions & 2 deletions .ldrelease/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ jobs:
image: ruby:2.7-buster
template:
name: ruby
env:
LD_SKIP_DATABASE_TESTS: "1" # Don't run Redis/Consul/DynamoDB tests in release; they are run in CI

documentation:
gitHubPages: true
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To run all unit tests:
bundle exec rspec spec
```

By default, the full unit test suite includes live tests of the integrations for Consul, DynamoDB, and Redis. Those tests expect you to have instances of all of those databases running locally. To skip them, set the environment variable `LD_SKIP_DATABASE_TESTS=1` before running the tests.
The full unit test suite includes live tests of the integrations for Consul, DynamoDB, and Redis. Those tests expect you to have instances of all of those databases running locally. By default, these tests will be skipped. To run them, set the environment variable `LD_SKIP_DATABASE_TESTS=0` before running the tests.

### Building documentation

Expand Down
1 change: 1 addition & 0 deletions launchdarkly-server-sdk.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Gem::Specification.new do |spec|

spec.add_development_dependency "aws-sdk-dynamodb", "~> 1.57"
spec.add_development_dependency "bundler", "2.2.33"
spec.add_development_dependency "simplecov", "~> 0.21"
spec.add_development_dependency "rspec", "~> 3.10"
spec.add_development_dependency "diplomat", "~> 2.6"
spec.add_development_dependency "redis", "~> 5.0"
Expand Down
15 changes: 15 additions & 0 deletions lib/ldclient-rb/config.rb
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,23 @@ def initialize(opts = {})
@big_segments = opts[:big_segments] || BigSegmentsConfig.new(store: nil)
@application = LaunchDarkly::Impl::Util.validate_application_info(opts[:application] || {}, @logger)
@payload_filter_key = opts[:payload_filter_key]
@data_source_update_sink = nil
end

#
# Returns the component that allows a data source to push data into the SDK.
#
# This property should only be set by the SDK. Long term access of this
# property is not supported; it is temporarily being exposed to maintain
# backwards compatibility while the SDK structure is updated.
#
# Custom data source implementations should integrate with this sink if
# they want to provide support for data source status listeners.
#
# @private
#
attr_accessor :data_source_update_sink

#
# The base URL for the LaunchDarkly server. This is configurable mainly for testing
# purposes; most users should use the default value.
Expand Down
78 changes: 78 additions & 0 deletions lib/ldclient-rb/impl/broadcaster.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# frozen_string_literal: true

module LaunchDarkly
module Impl

#
# A generic mechanism for registering event listeners and broadcasting
# events to them.
#
# The SDK maintains an instance of this for each available type of listener
# (flag change, data store status, etc.). They are all intended to share a
# single executor service; notifications are submitted individually to this
# service for each listener.
#
class Broadcaster
def initialize(executor, logger)
@listeners = Concurrent::Set.new
@executor = executor
@logger = logger
end

#
# Register a listener to this broadcaster.
#
# @param listener [#update]
#
def add_listener(listener)
unless listener.respond_to? :update
logger.warn("listener (#{listener.class}) does not respond to :update method. ignoring as registered listener")
return
end

listeners.add(listener)
end

#
# Removes a registered listener from this broadcaster.
#
def remove_listener(listener)
listeners.delete(listener)
end

def has_listeners?
!listeners.empty?
end

#
# Broadcast the provided event to all registered listeners.
#
# Each listener will be notified using the broadcasters executor. This
# method is non-blocking.
#
def broadcast(event)
listeners.each do |listener|
executor.post do
begin
listener.update(event)
rescue StandardError => e
logger.error("listener (#{listener.class}) raised exception (#{e}) processing event (#{event.class})")
end
end
end
end


private

# @return [Concurrent::ThreadPoolExecutor]
attr_reader :executor

# @return [Logger]
attr_reader :logger

# @return [Concurrent::Set]
attr_reader :listeners
end
end
end
188 changes: 188 additions & 0 deletions lib/ldclient-rb/impl/data_source.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
require "concurrent"
require "forwardable"
require "ldclient-rb/impl/dependency_tracker"
require "ldclient-rb/interfaces"
require "set"

module LaunchDarkly
module Impl
module DataSource
class StatusProvider
include LaunchDarkly::Interfaces::DataSource::StatusProvider

extend Forwardable
def_delegators :@status_broadcaster, :add_listener, :remove_listener

def initialize(status_broadcaster, update_sink)
# @type [Broadcaster]
@status_broadcaster = status_broadcaster
# @type [UpdateSink]
@data_source_update_sink = update_sink
end

def status
@data_source_update_sink.current_status
end
end

class UpdateSink
include LaunchDarkly::Interfaces::DataSource::UpdateSink

# @return [LaunchDarkly::Interfaces::DataSource::Status]
attr_reader :current_status

def initialize(data_store, status_broadcaster, flag_change_broadcaster)
# @type [LaunchDarkly::Interfaces::FeatureStore]
@data_store = data_store
# @type [Broadcaster]
@status_broadcaster = status_broadcaster
# @type [Broadcaster]
@flag_change_broadcaster = flag_change_broadcaster
@dependency_tracker = LaunchDarkly::Impl::DependencyTracker.new

@mutex = Mutex.new
@current_status = LaunchDarkly::Interfaces::DataSource::Status.new(
LaunchDarkly::Interfaces::DataSource::Status::INITIALIZING,
Time.now,
nil)
end

def init(all_data)
old_data = nil
monitor_store_update do
if @flag_change_broadcaster.has_listeners?
old_data = {}
LaunchDarkly::ALL_KINDS.each do |kind|
old_data[kind] = @data_store.all(kind)
end
end

@data_store.init(all_data)
end

update_full_dependency_tracker(all_data)

return if old_data.nil?

send_change_events(
compute_changed_items_for_full_data_set(old_data, all_data)
)
end

def upsert(kind, item)
monitor_store_update { @data_store.upsert(kind, item) }

# TODO(sc-197908): We only want to do this if the store successfully
# updates the record.
@dependency_tracker.update_dependencies_from(kind, item[:key], item)
if @flag_change_broadcaster.has_listeners?
affected_items = Set.new
@dependency_tracker.add_affected_items(affected_items, {kind: kind, key: item[:key]})
send_change_events(affected_items)
end
end

def delete(kind, key, version)
monitor_store_update { @data_store.delete(kind, key, version) }

@dependency_tracker.update_dependencies_from(kind, key, nil)
if @flag_change_broadcaster.has_listeners?
affected_items = Set.new
@dependency_tracker.add_affected_items(affected_items, {kind: kind, key: key})
send_change_events(affected_items)
end
end

def update_status(new_state, new_error)
return if new_state.nil?

status_to_broadcast = nil

@mutex.synchronize do
old_status = @current_status

if new_state == LaunchDarkly::Interfaces::DataSource::Status::INTERRUPTED && old_status.state == LaunchDarkly::Interfaces::DataSource::Status::INITIALIZING
# See {LaunchDarkly::Interfaces::DataSource::UpdateSink#update_status} for more information
new_state = LaunchDarkly::Interfaces::DataSource::Status::INITIALIZING
end

unless new_state == old_status.state && new_error.nil?
@current_status = LaunchDarkly::Interfaces::DataSource::Status.new(
new_state,
new_state == current_status.state ? current_status.state_since : Time.now,
new_error.nil? ? current_status.last_error : new_error
)
status_to_broadcast = current_status
end
end

@status_broadcaster.broadcast(status_to_broadcast) unless status_to_broadcast.nil?
end

private def update_full_dependency_tracker(all_data)
@dependency_tracker.reset
all_data.each do |kind, items|
items.each do |key, item|
@dependency_tracker.update_dependencies_from(kind, item.key, item)
end
end
end


#
# Method to monitor updates to the store. You provide a block to update
# the store. This mthod wraps that block, catching and re-raising all
# errors, and notifying all status listeners of the error.
#
private def monitor_store_update
begin
yield
rescue => e
error_info = LaunchDarkly::Interfaces::DataSource::ErrorInfo.new(LaunchDarkly::Interfaces::DataSource::ErrorInfo::STORE_ERROR, 0, e.to_s, Time.now)
update_status(LaunchDarkly::Interfaces::DataSource::Status::INTERRUPTED, error_info)
raise
end
end


#
# @param [Hash] old_data
# @param [Hash] new_data
# @return [Set]
#
private def compute_changed_items_for_full_data_set(old_data, new_data)
affected_items = Set.new

LaunchDarkly::ALL_KINDS.each do |kind|
old_items = old_data[kind] || {}
new_items = new_data[kind] || {}

old_items.keys.concat(new_items.keys).each do |key|
old_item = old_items[key]
new_item = new_items[key]

next if old_item.nil? && new_item.nil?

if old_item.nil? || new_item.nil? || old_item[:version] < new_item[:version]
@dependency_tracker.add_affected_items(affected_items, {kind: kind, key: key.to_s})
end
end
end

affected_items
end

#
# @param affected_items [Set]
#
private def send_change_events(affected_items)
affected_items.each do |item|
if item[:kind] == LaunchDarkly::FEATURES
@flag_change_broadcaster.broadcast(LaunchDarkly::Interfaces::FlagChange.new(item[:key]))
end
end
end
end
end
end
end
Loading

0 comments on commit 01dc51d

Please sign in to comment.