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.

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

Breaking change from 3.x.x to 4.x.x #211

Open
kikoso opened this issue Feb 28, 2023 · 1 comment
Open

Breaking change from 3.x.x to 4.x.x #211

kikoso opened this issue Feb 28, 2023 · 1 comment

Comments

@kikoso
Copy link

kikoso commented Feb 28, 2023

Describe the bug
Proguard changed between 3.x.x and 4.x.x, leading to potential malfunctioning in the SDK. This has not been marked as a breaking change, and it is not marked in the migration guide.

To reproduce
Migration guide and breaking changes do not contain a reference to this.

Expected behavior
Both the migration guide and the breaking changes list should contain information about breaking changes.

SDK version
3.x.x to 4.x.x

OS/platform
Android

@louis-launchdarkly
Copy link
Contributor

Hello @kikoso, thank you for raising the issue with us. We will look into this and update the Changelog and migration guide accordingly.

Filed Internally as 190648.

LaunchDarklyReleaseBot added a commit that referenced this issue Mar 15, 2023
* use SecureRandom instead of Random, just to make scanners happier

* rm unused

* fix deletion versioning logic, implement tombstones (#244)

* disable contract tests for API 31/33

* use okhttp-eventsource 1.11.3

* ensure timed-out clients get closed in contract tests

* clean up instances map on close (#247)

* clean up instances map on close

* improve atomicity of access to instances, ensure they can't be modified via closed clients

* update more methods that iterate over instances

* rm unnecessary LDClientControl

* use com.launchdarkly.logging with Timber adapter (#235)

* use fully-qualified context key in flag store (doesn't include migration)

* suppress contract tests for inline users in events

* rm unused plugin

* update more user references to contexts

* use LDContext in API and evaluations; disable events for now

* update some more references to "users"

* add contract test support for context type

* fix test

* adopt new event processor

* rm redundant class

* update snapshot version

* fix tiny inconsistency in build.gradle

* set request paths for event sender

* fix private attributes configuration

* make test expectation correspond to the endpoint we're using now

* fix HTTP cache configuration

* fix test

* remove debug output

* misc fixes

* add config option for generating anonymous keys

* test should be testing trackData

* fix anonymous key logic

* add storage abstraction and use it in ContextDecorator

* rm inapplicable comment

* update evaluation endpoint paths

* refactor more components to use storage abstraction

* misc fixes

* debugging

* debugging

* debugging

* substitute simple in-memory persistence in contract tests

* rm debugging, move test fixture

* comment

* create PersistentDataStoreWrapper component to encapsulate storage schema rules

* misc cleanup, comments

* ensure test log tag name isn't too long

* rm unused

* rm unused

* spacing

* major refactoring of context/flag manager components and ConnectivityManager

* rm duplicate test

* revert unnecessary change

* rm redundant helper

* clearer handling of exceptions in Gson deserialization

* improve test logging: add full test name to log line, force enable debug

* misc fixes

* more cleanup of JSON parsing logic

* create module for shared test code

* tolerate missing keys in flag data

* rm redundant class

* rm unused

* create PlatformState abstraction

* misc cleanup, factor various properties out into ClientState

* rm tests that can't possibly work in any supported API version

* fix tests, move network listener to ConnectivityManager

* comments

* fix error logging

* discard pre-v4 SDK data, migrate anon user key if possible

* clean up leftover polling alarms

* simplify by moving triggerPoll logic inside ConnectivityManager

* use regular worker threads for polling instead of AlarmManager

* simplify further by moving Debounce usage into ConnectivityManager

* config streamlining: ServiceEndpoints

* move LDConfigTest to unit tests and fix warning message

* update okhttp-eventsource version + streaming timeout fix

* update contract tests

* rm obsolete manifest entry

* update ProGuard rules file

* javadoc fix

* fix endpoint config in contract tests

* add temporary test suppressions

* create ClientContext object as a standard way to pass configuration to components

* fix javadoc

* don't use connection pool/keep-alive for polling requests

* add sub-configuration builder for events

* diagnosticRecordingInterval should also be part of the new builder

* misc fixes

* remove deprecated usages & unused imports

* misc fixes

* revert unnecessary change

* doc comments

* add configuration builders for polling/streaming

* fix polling mode initialization

* fix diagnostic event properties

* fix logic for diagnostic recording interval

* fix tests

* fix defaulting logic

* fix test

* fix merge

* fix tests

* add configuration builder for HTTP

* improve tests

* test cleanup

* fix test

* fix example code

* add configuration builder for service endpoints

* misc fixes

* disable diagnostic events if analytics events are disabled

* deprecations

* revise streaming/polling components to use a pluggable data source abstraction

* don't keep summary event counters in SharedPreferences

* don't create a summary event if there's no data

* misc cleanup + comments

* rm duplicated lines

* use regular in-memory storage for summary events (customer-reported performance issue) (#279)

* don't keep summary event counters in SharedPreferences

* don't create a summary event if there's no data

* fix doc comment

* add overloads for using LDUser instead of LDContext

* update Proguard rules file

* fix @SInCE

* fix test

* (4.0) add test data source (#282)

* use latest package versions

* if SDK starts in the background, do an initial poll

* add "use streaming even in background" option (4.x)

* do an initial poll if SDK starts in the background (3.x) (#286)

* add streamEvenInBackground option (3.x) (#287)

* re-fix previous fix for connection keep-alive

* prepare 3.5.1 release (#205)

* Remove couple of debug messages.

* Handle todos.

* Revert to old String behavior for allFlags, initialize WeakReference in SharedPrefsFlagStore.

* Better implementation of EvaluationReason serialization type adapter.

* Revert "Better implementation of EvaluationReason serialization type
adapter." Wrong branch...

This reverts commit 69c1c9b.

* Gw/ch29266/flagstore (#105)

* Changed shared preferences store system to user a single FlagStore
system that holds all the information on a flag to prevent issues
arising from unsynchronized separate stores for flag meta-data and
values.

* Abstract FlagStoreManager from FlagStore, new FlagStoreFactory class so manager can construct FlagStores of unknown type. Reformatted interfaces. Removed unused imports.

* Handle null case in allFlags, actually commit changes to UserManager.

* Hopefully fix edge cases in summary event reporting to pass testing.

* Hopefully fix edge cases in summary event reporting to pass testing.

* Simplify getFeaturesJsonObject as no longer using -1 as placeholder for null for variations.

* Make Flag non-mutable. Move GsonCache to gson package, move custom serializer/deserializers to classes in gson package and create one for PUT responses. Removed BaseUserSharedPreferences.

* Send summary event even if stored flag doesn't exist.

* Move sendSummaryEvent update code to UserSummaryEventSharedPreferences to synchronize to prevent data race on sending, updating, and clearing event store. Move SummaryEventSharedPreferences and UserSummaryEventSharedPreferences out of response package.

* Update SharedPrefsFlagStore to hold StoreUpdatedListener in weak reference. Fix various warnings.

* Migration code for upcoming flagstore.

* Remove couple of debug messages.

* Handle todos.

* Revert to old String behavior for allFlags, initialize WeakReference in SharedPrefsFlagStore.

* Better implementation of EvaluationReason serialization type adapter.

* Remove isUnknown argument from SummaryEventSharedPreferences methods. Use Runnable instead of Callable in UserManager to avoid useless return nulls. Rename FlagStoreFactoryInterface to FlagStoreFactory.

* Statically initialize Gson instance in GsonCache.

* Make Gson instance in GsonCache final on principle.

* Return json flags as JsonElement in allFlags map. (#106)

* Bump ok-http version to 3.9.1 (#107)

* fix annotations so eval reasons are serialized in events

* fix/expand doc comments for public methods

* typo

* typo

* add version string getter method

* Check for null key before file comparison check. (#110)

* [ch33658] Add unsafeReset() for LDClient testing re-initialization (#111)

Add `unsafeReset()` method to close and clear instances for re-initializing client between tests. Update LDClientTest to call `unsafeReset()` before tests.

* [ch33846] Rename tests to not start with capitals and general refactoring (#112)

* Rename tests to not start with capitals
* Reindent MultiEnvironmentLDClientTest to be consistent
* Optimize imports
* Move TLS patch into TLSUtils
* Make setModernTlsVersionsOnSocket private and remove redundant null check
* Remove code duplication in LDClient track overloaded methods.
* Remove validateParameter in LDClient that was using a NullPointerException as a null test.
* Simplify Debounce to use listener instead of callback.

* Add documentation for flagstore implementation (#113)

* [ch35150] Unit tests and bug fixes (#114)

- Use android test orchestrator to run tests isolated from each other. This prevents the issues testing singletons. Also enabled option to clear package data between runs allowing more extensive flagstore testing.
- Remove unsafe reset as it was added only for allowing testing the LDClient singleton.
- Tests for new FlagStore code.
- Convenience test FlagBuilder
- Fix Migration to not turn all flags into Strings
- Fix issue with clearAndApplyFlagUpdates not generating correct events for listeners.

* Add compatibility behavior to stringVariation and allFlags methods. (#115)

If a Json flag is requested with stringVariation it will serialize it to a String. Json flags will also be serialized to Strings for the map returned by allFlags()

* Update LDUser not to store all fields as Json. (#116)

Add testing rule to setup and teardown Timber trees for debug logging. Add additional LDUser tests. Fixed a bit of flakiness in deletesOlderThanLastFiveStoredUsers test that showed up all of a sudden.

* Add metricValue field to CustomEvent, add overloaded track method for (#118)

creating custom events with metricValues.

* [ch37794] Run connected emulator tests in CircleCI (#120)

* [ch34533] connection status, removing guava, network restructuring. (#117)

* Add ConnectionInformation class.
* Remove all internal uses of Guava.
* Update StreamUpdateProcessor to only debounce ping events.
* Add a connection state monitor to the example app.

* rename repo and package name and apply markdown templates (#121)

* Fix issue that stream could be started before stopping when calling identify. (#122)

* Revert "Fix issue that stream could be started before stopping when calling identify. (#122)"

This reverts commit fdede38.

* Revert "rename repo and package name and apply markdown templates (#121)"

This reverts commit 2215275.

* Revert "Revert "Fix issue that stream could be started before stopping when calling identify. (#122)""

This reverts commit 0849812.

* Revert "Revert "rename repo and package name and apply markdown templates (#121)""

This reverts commit bbbeb81.

* Fix thread leak on identify call from restarting EventProcessor without shutting it down first. (#123)

* Add top level try/catch to migration methods. Check flag version SharedPreferences object for String type before cast. (#124)

* Update Throttler to call runnable on background thread. (#125)

* Fix ConcurrentModificationException of instance map (#126)

Move iteration over client instances for ConnectivityReceiver and PollingUpdater to within LDClient to allow synchronizing on initialization.

* adding a circleci badge to the readme (#127)

* Fix bug where `stop` in StreamUpdateProcessor could not call it's listener when the stream is already closed.

This caused a race condition in repeated stream restarts that could put the SDK in a bad state.

* Change LDAwaitFuture to not treat zero timeout as unlimited timeout

Treating a timeout of zero as unlimited caused a change in behavior when initializing the SDK. This update restores the behavior init had when zero was passed as the timeout argument from pre-2.8.0. Also improves handling of spurious wakeups, and includes test cases for LDAwaitFuture.

* Revert "Merge remote-tracking branch 'remotes/origin/experiment' into next-release"

This reverts commit 3ac167f, reversing
changes made to d26e006.

* CircleCI fixes (#131)

* Better ci fix (#132)

* Speedup tests by building on macOS (#137)

* Background identify fixes (#133)

Add new testing controllers for network and foreground states. For network control, mobile data must be disabled on recent Android versions, updated circleci config to do this. Add new connectivity manager tests. Made EventProcessor and UserManager minimal interfaces for mocking, with actual implementations moved to DefaultEventProcessor and DefaultUserManager. Fixed issue with blocking in background modes.

* Experimentation 1.5 updates (#134)

* add entire compile-time classpath to javadoc classpath

* javadoc fixes: <p/> is not a thing

* do fail on javadoc errors

* add javadoc step, misc CI cleanup

* misc javadoc fixes

* remove unintentional(?) immediate event flush; clean up event tests

* remove unreliable test assumption about elapsed time

* [ch57098] Deprecate LDCountryCode (#141)

Deprecate LDCountryCode class and LDUser setters that take LDCountryCode as an argument.

* Catch `SecurityException` when setting alarm in case there are already (#143)

the maximum allowed number of alarms on Samsung devices.

* Revert "[ch57098] Deprecate LDCountryCode (#141)" so we can do a patch release
first.

This reverts commit c0e71ae.

* Revert "Revert "[ch57098] Deprecate LDCountryCode (#141)" so we can do a patch release"

This reverts commit 23b930f.

* Deprecate public classes (#145)

* Deprecate some unnecessarily public classes, duplicate classes as non-public to
avoid using the deprecated classes.

* [ch61092] Add event payload ID. (#147)

* Add event retry. (#149)

* Fix javadoc comment for release.

* Fix broken merge.

* [ch65133] Deprecate classes (#150)

* Deprecate UserSummaryEventSharedPreferences, SummaryEventSharedPreferences, FeatureFlagFetcher, Util, Debounce.

* Improve Javadoc and reduce interface clutter. (#152)

* Save Javadoc artifact and include logcat in circle output with tee. (#153)

* Save Javadoc artifact on circleci.

* Add step to kill emulator after tests, and tee output of logcat for visibility
during run.

* [ch62120] Background during identify callback (#154)

* Adding more connectivity manager tests.
* Updated internal `Foreground` class to call listeners on a background thread.
* Add some comments explaining the behavior of test controllers.
* Adding fixes for cases where the completion callback may not be called.

* [ch65914] Diagnostic events (#156)

* [ch65352] Expose LDValue rather than Gson types (#158)

* Remove SET_ALARM permission. The comment that this was required for background updating is incorrect, this permission is only for sending broadcasts to an alarm clock application, something we do not do, and should never do. (#159)

* Fix minimum diagnostic recording interval comment. (#160)

* Data since date was not getting reset after each periodic diagnostic event. (#161)

* [ch75315] Add maxCachedUsers configuration option (#162)

Adds maxCachedUsers configuration option for configuring the limit on how many
users have their flags cached locally.

* Configure okhttp cache for polling requests to be stored in a subdirectory of the application cache directory. (#164)

* Fixes ch76614 and add test of null fallback unknown flag event generation. Also some finishing touches to LDValue changes, including LDClientInterface updates, more tests, and improvements to null behavior handling. (#163)

* Removing ldvalue changes before release (#165)

* Revert "[ch65352] Expose LDValue rather than Gson types (#158)"

This reverts commit 1e29a82

* Fixes after revert.

* [ch69437] Support for setting additional headers to be included in requests. (#166)

* [ch89933] Improve resiliency of store for summary events. (#167)

See #105 for the original issue.

* [ch94053] Improve throttler behavior. (#169)

* Add doubleVariation, doubleVariationDetail. (#171)

Deprecates floatVariation, floatVariationDetail.

* Provide pollUri configuration and deprecate baseUri. (#172)

* Fix throttler behavior to ensure attempt count resets are not cancelled (#178)

* [ch98336] Broaden catch statement on scheduling polling alarm (#181)

This is to handle more than just the SecurityException that Samsung throws, as we've gotten an issue report that some devices throw a IllegalStateException instead.

* Removed the guides link

* Include flag key in warning message when converting a json flag to a string (#185)

* (2.x) Prevent NullPointerException when diagnostic processor shut down before starting. (#210)

* Release 2.14.2 (#130)

## [2.14.2] - 2021-06-02
### Fixed
- Added check to prevent `NullPointerException` in `DiagnosticEventProcessor.stopScheduler` when `LDClient.close` is called before the application is foregrounded when the SDK was initialized in the background. ([#127](#127))
- Log message warning that JSON flag was requested as a String has been updated to include the key of the flag requested to assist in discovering which flag is being requested with an unexpected type. ([#116](#116))

* Bump version and update changelog for release.

* Explicitly specify android:exported attribute on manifest receivers. (#211)

* Update java common (#212)

* Flag PendingIntent on new enough platforms as the flag is required on Android S+ (#213)

* Add try for getting network capabilities (#214)

* ch103537 bump java-sdk-common to 1.2 to support inExperiment on eval reason (#215)

* Remove `allowBackup` manifest attribute that can conflict with the application's (#217)

* Update the version to 2.8.9

* Add explicit proguard directives for keeping BroadcastReceivers. (#219)

* Bump Gradle, Android Gradle Plugin, and Dexcount Gradle

* Use the latest 7.1.1 version

* Using the version that still support Java 8 but pin the grgit core behind the scene

* Remove Android Appcompat dependency (#222)

* Bump dependencies and reorganize Gradle file somewhat. (#223)

* Add the null check to prevent multiple allocation of the DiagnosticEventProcessor

* Fix sonatype release plugin (#226)

* Add .ldrelease configuration (#227)

* Add contract test service (#228)

* Fix test service failing on later API versions (#229)

* Add usesCleartextTraffic=true to contract-tests AndroidManifest

This allows the contract tests to work on API level 28 and above

* Fix start-emulator.sh to pick the newest image instead of the oldest

* Refactor CI config into separate jobs with a matrix (#230)

* Don't auto-retry emulator tests (#231)

* Add contract tests for API level 21 (#232)

* Remove unnecessary locking in LDClient (#233)

* Remove `synchronized` keywords from every `LDClient` method

* Treat `instances` as immutable, and swap out the whole map after constructing all the clients

* Use a lock to ensure we don't try to init twice

* Update `ConnectivityManager` so it now manages `DiagnosticEventManager`

* Run contract tests on Android 31, 33 (#234)

* Unsuppress streaming/requests and polling/requests (#236)

* don't create a new executor just to trigger a flush

* remove short publishing timeout, use defaults of 60 retries & 10 seconds

* Serialize null values of `anonymous` as null (#237)

* fix URL path concatenation to avoid double slashes

* fix NPE in edge case where variation is null but value isn't

* use SecureRandom instead of Random, just to make scanners happier

* rm unused

* fix deletion versioning logic, implement tombstones (#244)

* disable contract tests for API 31/33

* use okhttp-eventsource 1.11.3

* ensure timed-out clients get closed in contract tests

* clean up instances map on close (#247)

* clean up instances map on close

* improve atomicity of access to instances, ensure they can't be modified via closed clients

* update more methods that iterate over instances

* rm unnecessary LDClientControl

* use com.launchdarkly.logging with Timber adapter (#235)

* rm unused plugin

* clean up leftover polling alarms

* don't use connection pool/keep-alive for polling requests

* add sub-configuration builder for events

* diagnosticRecordingInterval should also be part of the new builder

* misc fixes

* remove deprecated usages & unused imports

* misc fixes

* revert unnecessary change

* doc comments

* add configuration builders for polling/streaming

* fix polling mode initialization

* fix diagnostic event properties

* fix logic for diagnostic recording interval

* fix tests

* fix defaulting logic

* fix test

* add configuration builder for HTTP

* improve tests

* test cleanup

* fix test

* add configuration builder for service endpoints

* misc fixes

* disable diagnostic events if analytics events are disabled

* deprecations

* don't keep summary event counters in SharedPreferences

* don't create a summary event if there's no data

* rm duplicated lines

* use regular in-memory storage for summary events (customer-reported performance issue) (#279)

* don't keep summary event counters in SharedPreferences

* don't create a summary event if there's no data

* fix doc comment

* fix @SInCE

* do an initial poll if SDK starts in the background (3.x) (#286)

* add streamEvenInBackground option (3.x) (#287)

* re-fix previous fix for connection keep-alive

Co-authored-by: Gavin Whelan <gwhelan@launchdarkly.com>
Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Robert J. Neal <robertjneal@users.noreply.github.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Alex Engelberg <aengelberg@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>

* update obsolete credential paths

* Releasing version 3.5.1

* add ApplicationInfo a.k.a. tags (3.x) (#289)

* prepare 3.6.0 release (#207)

* Revert to old String behavior for allFlags, initialize WeakReference in SharedPrefsFlagStore.

* Better implementation of EvaluationReason serialization type adapter.

* Revert "Better implementation of EvaluationReason serialization type
adapter." Wrong branch...

This reverts commit 69c1c9b.

* Gw/ch29266/flagstore (#105)

* Changed shared preferences store system to user a single FlagStore
system that holds all the information on a flag to prevent issues
arising from unsynchronized separate stores for flag meta-data and
values.

* Abstract FlagStoreManager from FlagStore, new FlagStoreFactory class so manager can construct FlagStores of unknown type. Reformatted interfaces. Removed unused imports.

* Handle null case in allFlags, actually commit changes to UserManager.

* Hopefully fix edge cases in summary event reporting to pass testing.

* Hopefully fix edge cases in summary event reporting to pass testing.

* Simplify getFeaturesJsonObject as no longer using -1 as placeholder for null for variations.

* Make Flag non-mutable. Move GsonCache to gson package, move custom serializer/deserializers to classes in gson package and create one for PUT responses. Removed BaseUserSharedPreferences.

* Send summary event even if stored flag doesn't exist.

* Move sendSummaryEvent update code to UserSummaryEventSharedPreferences to synchronize to prevent data race on sending, updating, and clearing event store. Move SummaryEventSharedPreferences and UserSummaryEventSharedPreferences out of response package.

* Update SharedPrefsFlagStore to hold StoreUpdatedListener in weak reference. Fix various warnings.

* Migration code for upcoming flagstore.

* Remove couple of debug messages.

* Handle todos.

* Revert to old String behavior for allFlags, initialize WeakReference in SharedPrefsFlagStore.

* Better implementation of EvaluationReason serialization type adapter.

* Remove isUnknown argument from SummaryEventSharedPreferences methods. Use Runnable instead of Callable in UserManager to avoid useless return nulls. Rename FlagStoreFactoryInterface to FlagStoreFactory.

* Statically initialize Gson instance in GsonCache.

* Make Gson instance in GsonCache final on principle.

* Return json flags as JsonElement in allFlags map. (#106)

* Bump ok-http version to 3.9.1 (#107)

* fix annotations so eval reasons are serialized in events

* fix/expand doc comments for public methods

* typo

* typo

* add version string getter method

* Check for null key before file comparison check. (#110)

* [ch33658] Add unsafeReset() for LDClient testing re-initialization (#111)

Add `unsafeReset()` method to close and clear instances for re-initializing client between tests. Update LDClientTest to call `unsafeReset()` before tests.

* [ch33846] Rename tests to not start with capitals and general refactoring (#112)

* Rename tests to not start with capitals
* Reindent MultiEnvironmentLDClientTest to be consistent
* Optimize imports
* Move TLS patch into TLSUtils
* Make setModernTlsVersionsOnSocket private and remove redundant null check
* Remove code duplication in LDClient track overloaded methods.
* Remove validateParameter in LDClient that was using a NullPointerException as a null test.
* Simplify Debounce to use listener instead of callback.

* Add documentation for flagstore implementation (#113)

* [ch35150] Unit tests and bug fixes (#114)

- Use android test orchestrator to run tests isolated from each other. This prevents the issues testing singletons. Also enabled option to clear package data between runs allowing more extensive flagstore testing.
- Remove unsafe reset as it was added only for allowing testing the LDClient singleton.
- Tests for new FlagStore code.
- Convenience test FlagBuilder
- Fix Migration to not turn all flags into Strings
- Fix issue with clearAndApplyFlagUpdates not generating correct events for listeners.

* Add compatibility behavior to stringVariation and allFlags methods. (#115)

If a Json flag is requested with stringVariation it will serialize it to a String. Json flags will also be serialized to Strings for the map returned by allFlags()

* Update LDUser not to store all fields as Json. (#116)

Add testing rule to setup and teardown Timber trees for debug logging. Add additional LDUser tests. Fixed a bit of flakiness in deletesOlderThanLastFiveStoredUsers test that showed up all of a sudden.

* Add metricValue field to CustomEvent, add overloaded track method for (#118)

creating custom events with metricValues.

* [ch37794] Run connected emulator tests in CircleCI (#120)

* [ch34533] connection status, removing guava, network restructuring. (#117)

* Add ConnectionInformation class.
* Remove all internal uses of Guava.
* Update StreamUpdateProcessor to only debounce ping events.
* Add a connection state monitor to the example app.

* rename repo and package name and apply markdown templates (#121)

* Fix issue that stream could be started before stopping when calling identify. (#122)

* Revert "Fix issue that stream could be started before stopping when calling identify. (#122)"

This reverts commit fdede38.

* Revert "rename repo and package name and apply markdown templates (#121)"

This reverts commit 2215275.

* Revert "Revert "Fix issue that stream could be started before stopping when calling identify. (#122)""

This reverts commit 0849812.

* Revert "Revert "rename repo and package name and apply markdown templates (#121)""

This reverts commit bbbeb81.

* Fix thread leak on identify call from restarting EventProcessor without shutting it down first. (#123)

* Add top level try/catch to migration methods. Check flag version SharedPreferences object for String type before cast. (#124)

* Update Throttler to call runnable on background thread. (#125)

* Fix ConcurrentModificationException of instance map (#126)

Move iteration over client instances for ConnectivityReceiver and PollingUpdater to within LDClient to allow synchronizing on initialization.

* adding a circleci badge to the readme (#127)

* Fix bug where `stop` in StreamUpdateProcessor could not call it's listener when the stream is already closed.

This caused a race condition in repeated stream restarts that could put the SDK in a bad state.

* Change LDAwaitFuture to not treat zero timeout as unlimited timeout

Treating a timeout of zero as unlimited caused a change in behavior when initializing the SDK. This update restores the behavior init had when zero was passed as the timeout argument from pre-2.8.0. Also improves handling of spurious wakeups, and includes test cases for LDAwaitFuture.

* Revert "Merge remote-tracking branch 'remotes/origin/experiment' into next-release"

This reverts commit 3ac167f, reversing
changes made to d26e006.

* CircleCI fixes (#131)

* Better ci fix (#132)

* Speedup tests by building on macOS (#137)

* Background identify fixes (#133)

Add new testing controllers for network and foreground states. For network control, mobile data must be disabled on recent Android versions, updated circleci config to do this. Add new connectivity manager tests. Made EventProcessor and UserManager minimal interfaces for mocking, with actual implementations moved to DefaultEventProcessor and DefaultUserManager. Fixed issue with blocking in background modes.

* Experimentation 1.5 updates (#134)

* add entire compile-time classpath to javadoc classpath

* javadoc fixes: <p/> is not a thing

* do fail on javadoc errors

* add javadoc step, misc CI cleanup

* misc javadoc fixes

* remove unintentional(?) immediate event flush; clean up event tests

* remove unreliable test assumption about elapsed time

* [ch57098] Deprecate LDCountryCode (#141)

Deprecate LDCountryCode class and LDUser setters that take LDCountryCode as an argument.

* Catch `SecurityException` when setting alarm in case there are already (#143)

the maximum allowed number of alarms on Samsung devices.

* Revert "[ch57098] Deprecate LDCountryCode (#141)" so we can do a patch release
first.

This reverts commit c0e71ae.

* Revert "Revert "[ch57098] Deprecate LDCountryCode (#141)" so we can do a patch release"

This reverts commit 23b930f.

* Deprecate public classes (#145)

* Deprecate some unnecessarily public classes, duplicate classes as non-public to
avoid using the deprecated classes.

* [ch61092] Add event payload ID. (#147)

* Add event retry. (#149)

* Fix javadoc comment for release.

* Fix broken merge.

* [ch65133] Deprecate classes (#150)

* Deprecate UserSummaryEventSharedPreferences, SummaryEventSharedPreferences, FeatureFlagFetcher, Util, Debounce.

* Improve Javadoc and reduce interface clutter. (#152)

* Save Javadoc artifact and include logcat in circle output with tee. (#153)

* Save Javadoc artifact on circleci.

* Add step to kill emulator after tests, and tee output of logcat for visibility
during run.

* [ch62120] Background during identify callback (#154)

* Adding more connectivity manager tests.
* Updated internal `Foreground` class to call listeners on a background thread.
* Add some comments explaining the behavior of test controllers.
* Adding fixes for cases where the completion callback may not be called.

* [ch65914] Diagnostic events (#156)

* [ch65352] Expose LDValue rather than Gson types (#158)

* Remove SET_ALARM permission. The comment that this was required for background updating is incorrect, this permission is only for sending broadcasts to an alarm clock application, something we do not do, and should never do. (#159)

* Fix minimum diagnostic recording interval comment. (#160)

* Data since date was not getting reset after each periodic diagnostic event. (#161)

* [ch75315] Add maxCachedUsers configuration option (#162)

Adds maxCachedUsers configuration option for configuring the limit on how many
users have their flags cached locally.

* Configure okhttp cache for polling requests to be stored in a subdirectory of the application cache directory. (#164)

* Fixes ch76614 and add test of null fallback unknown flag event generation. Also some finishing touches to LDValue changes, including LDClientInterface updates, more tests, and improvements to null behavior handling. (#163)

* Removing ldvalue changes before release (#165)

* Revert "[ch65352] Expose LDValue rather than Gson types (#158)"

This reverts commit 1e29a82

* Fixes after revert.

* [ch69437] Support for setting additional headers to be included in requests. (#166)

* [ch89933] Improve resiliency of store for summary events. (#167)

See #105 for the original issue.

* [ch94053] Improve throttler behavior. (#169)

* Add doubleVariation, doubleVariationDetail. (#171)

Deprecates floatVariation, floatVariationDetail.

* Provide pollUri configuration and deprecate baseUri. (#172)

* Fix throttler behavior to ensure attempt count resets are not cancelled (#178)

* [ch98336] Broaden catch statement on scheduling polling alarm (#181)

This is to handle more than just the SecurityException that Samsung throws, as we've gotten an issue report that some devices throw a IllegalStateException instead.

* Removed the guides link

* Include flag key in warning message when converting a json flag to a string (#185)

* (2.x) Prevent NullPointerException when diagnostic processor shut down before starting. (#210)

* Release 2.14.2 (#130)

## [2.14.2] - 2021-06-02
### Fixed
- Added check to prevent `NullPointerException` in `DiagnosticEventProcessor.stopScheduler` when `LDClient.close` is called before the application is foregrounded when the SDK was initialized in the background. ([#127](#127))
- Log message warning that JSON flag was requested as a String has been updated to include the key of the flag requested to assist in discovering which flag is being requested with an unexpected type. ([#116](#116))

* Bump version and update changelog for release.

* Explicitly specify android:exported attribute on manifest receivers. (#211)

* Update java common (#212)

* Flag PendingIntent on new enough platforms as the flag is required on Android S+ (#213)

* Add try for getting network capabilities (#214)

* ch103537 bump java-sdk-common to 1.2 to support inExperiment on eval reason (#215)

* Remove `allowBackup` manifest attribute that can conflict with the application's (#217)

* Update the version to 2.8.9

* Add explicit proguard directives for keeping BroadcastReceivers. (#219)

* Bump Gradle, Android Gradle Plugin, and Dexcount Gradle

* Use the latest 7.1.1 version

* Using the version that still support Java 8 but pin the grgit core behind the scene

* Remove Android Appcompat dependency (#222)

* Bump dependencies and reorganize Gradle file somewhat. (#223)

* Add the null check to prevent multiple allocation of the DiagnosticEventProcessor

* Fix sonatype release plugin (#226)

* Add .ldrelease configuration (#227)

* Add contract test service (#228)

* Fix test service failing on later API versions (#229)

* Add usesCleartextTraffic=true to contract-tests AndroidManifest

This allows the contract tests to work on API level 28 and above

* Fix start-emulator.sh to pick the newest image instead of the oldest

* Refactor CI config into separate jobs with a matrix (#230)

* Don't auto-retry emulator tests (#231)

* Add contract tests for API level 21 (#232)

* Remove unnecessary locking in LDClient (#233)

* Remove `synchronized` keywords from every `LDClient` method

* Treat `instances` as immutable, and swap out the whole map after constructing all the clients

* Use a lock to ensure we don't try to init twice

* Update `ConnectivityManager` so it now manages `DiagnosticEventManager`

* Run contract tests on Android 31, 33 (#234)

* Unsuppress streaming/requests and polling/requests (#236)

* don't create a new executor just to trigger a flush

* remove short publishing timeout, use defaults of 60 retries & 10 seconds

* Serialize null values of `anonymous` as null (#237)

* fix URL path concatenation to avoid double slashes

* fix NPE in edge case where variation is null but value isn't

* use SecureRandom instead of Random, just to make scanners happier

* rm unused

* fix deletion versioning logic, implement tombstones (#244)

* disable contract tests for API 31/33

* use okhttp-eventsource 1.11.3

* ensure timed-out clients get closed in contract tests

* clean up instances map on close (#247)

* clean up instances map on close

* improve atomicity of access to instances, ensure they can't be modified via closed clients

* update more methods that iterate over instances

* rm unnecessary LDClientControl

* use com.launchdarkly.logging with Timber adapter (#235)

* rm unused plugin

* clean up leftover polling alarms

* don't use connection pool/keep-alive for polling requests

* add sub-configuration builder for events

* diagnosticRecordingInterval should also be part of the new builder

* misc fixes

* remove deprecated usages & unused imports

* misc fixes

* revert unnecessary change

* doc comments

* add configuration builders for polling/streaming

* fix polling mode initialization

* fix diagnostic event properties

* fix logic for diagnostic recording interval

* fix tests

* fix defaulting logic

* fix test

* add configuration builder for HTTP

* improve tests

* test cleanup

* fix test

* add configuration builder for service endpoints

* misc fixes

* disable diagnostic events if analytics events are disabled

* deprecations

* don't keep summary event counters in SharedPreferences

* don't create a summary event if there's no data

* rm duplicated lines

* use regular in-memory storage for summary events (customer-reported performance issue) (#279)

* don't keep summary event counters in SharedPreferences

* don't create a summary event if there's no data

* fix doc comment

* fix @SInCE

* do an initial poll if SDK starts in the background (3.x) (#286)

* add streamEvenInBackground option (3.x) (#287)

* re-fix previous fix for connection keep-alive

* add ApplicationInfo a.k.a. tags (3.x) (#289)

Co-authored-by: Gavin Whelan <gwhelan@launchdarkly.com>
Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Robert J. Neal <robertjneal@users.noreply.github.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Alex Engelberg <aengelberg@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>

* Releasing version 3.6.0

* add ApplicationInfo a.k.a. tags (4.x) (#290)

* Added missing callback

* Adding missing call to register/unregister in unit test found in review.

---------

Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Gavin Whelan <gwhelan@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Robert J. Neal <robertjneal@users.noreply.github.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
Co-authored-by: Alex Engelberg <aengelberg@launchdarkly.com>
Co-authored-by: Todd Anderson <tanderson@launchdarkly.com>
Co-authored-by: tanderson-ld <127344469+tanderson-ld@users.noreply.github.com>
tanderson-ld pushed a commit that referenced this issue May 17, 2023
* Remove couple of debug messages.

* Handle todos.

* Revert to old String behavior for allFlags, initialize WeakReference in SharedPrefsFlagStore.

* Better implementation of EvaluationReason serialization type adapter.

* Revert "Better implementation of EvaluationReason serialization type
adapter." Wrong branch...

This reverts commit 69c1c9b.

* Gw/ch29266/flagstore (#105)

* Changed shared preferences store system to user a single FlagStore
system that holds all the information on a flag to prevent issues
arising from unsynchronized separate stores for flag meta-data and
values.

* Abstract FlagStoreManager from FlagStore, new FlagStoreFactory class so manager can construct FlagStores of unknown type. Reformatted interfaces. Removed unused imports.

* Handle null case in allFlags, actually commit changes to UserManager.

* Hopefully fix edge cases in summary event reporting to pass testing.

* Hopefully fix edge cases in summary event reporting to pass testing.

* Simplify getFeaturesJsonObject as no longer using -1 as placeholder for null for variations.

* Make Flag non-mutable. Move GsonCache to gson package, move custom serializer/deserializers to classes in gson package and create one for PUT responses. Removed BaseUserSharedPreferences.

* Send summary event even if stored flag doesn't exist.

* Move sendSummaryEvent update code to UserSummaryEventSharedPreferences to synchronize to prevent data race on sending, updating, and clearing event store. Move SummaryEventSharedPreferences and UserSummaryEventSharedPreferences out of response package.

* Update SharedPrefsFlagStore to hold StoreUpdatedListener in weak reference. Fix various warnings.

* Migration code for upcoming flagstore.

* Remove couple of debug messages.

* Handle todos.

* Revert to old String behavior for allFlags, initialize WeakReference in SharedPrefsFlagStore.

* Better implementation of EvaluationReason serialization type adapter.

* Remove isUnknown argument from SummaryEventSharedPreferences methods. Use Runnable instead of Callable in UserManager to avoid useless return nulls. Rename FlagStoreFactoryInterface to FlagStoreFactory.

* Statically initialize Gson instance in GsonCache.

* Make Gson instance in GsonCache final on principle.

* Return json flags as JsonElement in allFlags map. (#106)

* Bump ok-http version to 3.9.1 (#107)

* fix annotations so eval reasons are serialized in events

* fix/expand doc comments for public methods

* typo

* typo

* add version string getter method

* Check for null key before file comparison check. (#110)

* [ch33658] Add unsafeReset() for LDClient testing re-initialization (#111)

Add `unsafeReset()` method to close and clear instances for re-initializing client between tests. Update LDClientTest to call `unsafeReset()` before tests.

* [ch33846] Rename tests to not start with capitals and general refactoring (#112)

* Rename tests to not start with capitals
* Reindent MultiEnvironmentLDClientTest to be consistent
* Optimize imports
* Move TLS patch into TLSUtils
* Make setModernTlsVersionsOnSocket private and remove redundant null check
* Remove code duplication in LDClient track overloaded methods.
* Remove validateParameter in LDClient that was using a NullPointerException as a null test.
* Simplify Debounce to use listener instead of callback.

* Add documentation for flagstore implementation (#113)

* [ch35150] Unit tests and bug fixes (#114)

- Use android test orchestrator to run tests isolated from each other. This prevents the issues testing singletons. Also enabled option to clear package data between runs allowing more extensive flagstore testing.
- Remove unsafe reset as it was added only for allowing testing the LDClient singleton.
- Tests for new FlagStore code.
- Convenience test FlagBuilder
- Fix Migration to not turn all flags into Strings
- Fix issue with clearAndApplyFlagUpdates not generating correct events for listeners.

* Add compatibility behavior to stringVariation and allFlags methods. (#115)

If a Json flag is requested with stringVariation it will serialize it to a String. Json flags will also be serialized to Strings for the map returned by allFlags()

* Update LDUser not to store all fields as Json. (#116)

Add testing rule to setup and teardown Timber trees for debug logging. Add additional LDUser tests. Fixed a bit of flakiness in deletesOlderThanLastFiveStoredUsers test that showed up all of a sudden.

* Add metricValue field to CustomEvent, add overloaded track method for (#118)

creating custom events with metricValues.

* [ch37794] Run connected emulator tests in CircleCI (#120)

* [ch34533] connection status, removing guava, network restructuring. (#117)

* Add ConnectionInformation class.
* Remove all internal uses of Guava.
* Update StreamUpdateProcessor to only debounce ping events.
* Add a connection state monitor to the example app.

* rename repo and package name and apply markdown templates (#121)

* Fix issue that stream could be started before stopping when calling identify. (#122)

* Revert "Fix issue that stream could be started before stopping when calling identify. (#122)"

This reverts commit fdede38.

* Revert "rename repo and package name and apply markdown templates (#121)"

This reverts commit 2215275.

* Revert "Revert "Fix issue that stream could be started before stopping when calling identify. (#122)""

This reverts commit 0849812.

* Revert "Revert "rename repo and package name and apply markdown templates (#121)""

This reverts commit bbbeb81.

* Fix thread leak on identify call from restarting EventProcessor without shutting it down first. (#123)

* Add top level try/catch to migration methods. Check flag version SharedPreferences object for String type before cast. (#124)

* Update Throttler to call runnable on background thread. (#125)

* Fix ConcurrentModificationException of instance map (#126)

Move iteration over client instances for ConnectivityReceiver and PollingUpdater to within LDClient to allow synchronizing on initialization.

* adding a circleci badge to the readme (#127)

* Fix bug where `stop` in StreamUpdateProcessor could not call it's listener when the stream is already closed.

This caused a race condition in repeated stream restarts that could put the SDK in a bad state.

* Change LDAwaitFuture to not treat zero timeout as unlimited timeout

Treating a timeout of zero as unlimited caused a change in behavior when initializing the SDK. This update restores the behavior init had when zero was passed as the timeout argument from pre-2.8.0. Also improves handling of spurious wakeups, and includes test cases for LDAwaitFuture.

* Revert "Merge remote-tracking branch 'remotes/origin/experiment' into next-release"

This reverts commit 3ac167f, reversing
changes made to d26e006.

* CircleCI fixes (#131)

* Better ci fix (#132)

* Speedup tests by building on macOS (#137)

* Background identify fixes (#133)

Add new testing controllers for network and foreground states. For network control, mobile data must be disabled on recent Android versions, updated circleci config to do this. Add new connectivity manager tests. Made EventProcessor and UserManager minimal interfaces for mocking, with actual implementations moved to DefaultEventProcessor and DefaultUserManager. Fixed issue with blocking in background modes.

* Experimentation 1.5 updates (#134)

* add entire compile-time classpath to javadoc classpath

* javadoc fixes: <p/> is not a thing

* do fail on javadoc errors

* add javadoc step, misc CI cleanup

* misc javadoc fixes

* remove unintentional(?) immediate event flush; clean up event tests

* remove unreliable test assumption about elapsed time

* [ch57098] Deprecate LDCountryCode (#141)

Deprecate LDCountryCode class and LDUser setters that take LDCountryCode as an argument.

* Catch `SecurityException` when setting alarm in case there are already (#143)

the maximum allowed number of alarms on Samsung devices.

* Revert "[ch57098] Deprecate LDCountryCode (#141)" so we can do a patch release
first.

This reverts commit c0e71ae.

* Revert "Revert "[ch57098] Deprecate LDCountryCode (#141)" so we can do a patch release"

This reverts commit 23b930f.

* Deprecate public classes (#145)

* Deprecate some unnecessarily public classes, duplicate classes as non-public to
avoid using the deprecated classes.

* [ch61092] Add event payload ID. (#147)

* Add event retry. (#149)

* Fix javadoc comment for release.

* Fix broken merge.

* [ch65133] Deprecate classes (#150)

* Deprecate UserSummaryEventSharedPreferences, SummaryEventSharedPreferences, FeatureFlagFetcher, Util, Debounce.

* Improve Javadoc and reduce interface clutter. (#152)

* Save Javadoc artifact and include logcat in circle output with tee. (#153)

* Save Javadoc artifact on circleci.

* Add step to kill emulator after tests, and tee output of logcat for visibility
during run.

* [ch62120] Background during identify callback (#154)

* Adding more connectivity manager tests.
* Updated internal `Foreground` class to call listeners on a background thread.
* Add some comments explaining the behavior of test controllers.
* Adding fixes for cases where the completion callback may not be called.

* [ch65914] Diagnostic events (#156)

* [ch65352] Expose LDValue rather than Gson types (#158)

* Remove SET_ALARM permission. The comment that this was required for background updating is incorrect, this permission is only for sending broadcasts to an alarm clock application, something we do not do, and should never do. (#159)

* Fix minimum diagnostic recording interval comment. (#160)

* Data since date was not getting reset after each periodic diagnostic event. (#161)

* [ch75315] Add maxCachedUsers configuration option (#162)

Adds maxCachedUsers configuration option for configuring the limit on how many
users have their flags cached locally.

* Configure okhttp cache for polling requests to be stored in a subdirectory of the application cache directory. (#164)

* Fixes ch76614 and add test of null fallback unknown flag event generation. Also some finishing touches to LDValue changes, including LDClientInterface updates, more tests, and improvements to null behavior handling. (#163)

* Removing ldvalue changes before release (#165)

* Revert "[ch65352] Expose LDValue rather than Gson types (#158)"

This reverts commit 1e29a82

* Fixes after revert.

* [ch69437] Support for setting additional headers to be included in requests. (#166)

* [ch89933] Improve resiliency of store for summary events. (#167)

See #105 for the original issue.

* [ch94053] Improve throttler behavior. (#169)

* Add doubleVariation, doubleVariationDetail. (#171)

Deprecates floatVariation, floatVariationDetail.

* Provide pollUri configuration and deprecate baseUri. (#172)

* Fix throttler behavior to ensure attempt count resets are not cancelled (#178)

* [ch98336] Broaden catch statement on scheduling polling alarm (#181)

This is to handle more than just the SecurityException that Samsung throws, as we've gotten an issue report that some devices throw a IllegalStateException instead.

* Removed the guides link

* Include flag key in warning message when converting a json flag to a string (#185)

* (2.x) Prevent NullPointerException when diagnostic processor shut down before starting. (#210)

* Release 2.14.2 (#130)

## [2.14.2] - 2021-06-02
### Fixed
- Added check to prevent `NullPointerException` in `DiagnosticEventProcessor.stopScheduler` when `LDClient.close` is called before the application is foregrounded when the SDK was initialized in the background. ([#127](#127))
- Log message warning that JSON flag was requested as a String has been updated to include the key of the flag requested to assist in discovering which flag is being requested with an unexpected type. ([#116](#116))

* Bump version and update changelog for release.

* Explicitly specify android:exported attribute on manifest receivers. (#211)

* Update java common (#212)

* Flag PendingIntent on new enough platforms as the flag is required on Android S+ (#213)

* Add try for getting network capabilities (#214)

* ch103537 bump java-sdk-common to 1.2 to support inExperiment on eval reason (#215)

* Remove `allowBackup` manifest attribute that can conflict with the application's (#217)

* Update the version to 2.8.9

* Add explicit proguard directives for keeping BroadcastReceivers. (#219)

* Bump Gradle, Android Gradle Plugin, and Dexcount Gradle

* Use the latest 7.1.1 version

* Using the version that still support Java 8 but pin the grgit core behind the scene

* Remove Android Appcompat dependency (#222)

* Bump dependencies and reorganize Gradle file somewhat. (#223)

* Add the null check to prevent multiple allocation of the DiagnosticEventProcessor

* Fix sonatype release plugin (#226)

* Add .ldrelease configuration (#227)

* Add contract test service (#228)

* Fix test service failing on later API versions (#229)

* Add usesCleartextTraffic=true to contract-tests AndroidManifest

This allows the contract tests to work on API level 28 and above

* Fix start-emulator.sh to pick the newest image instead of the oldest

* Refactor CI config into separate jobs with a matrix (#230)

* Don't auto-retry emulator tests (#231)

* Add contract tests for API level 21 (#232)

* Remove unnecessary locking in LDClient (#233)

* Remove `synchronized` keywords from every `LDClient` method

* Treat `instances` as immutable, and swap out the whole map after constructing all the clients

* Use a lock to ensure we don't try to init twice

* Update `ConnectivityManager` so it now manages `DiagnosticEventManager`

* Run contract tests on Android 31, 33 (#234)

* Unsuppress streaming/requests and polling/requests (#236)

* don't create a new executor just to trigger a flush

* remove short publishing timeout, use defaults of 60 retries & 10 seconds

* Serialize null values of `anonymous` as null (#237)

* fix URL path concatenation to avoid double slashes

* fix NPE in edge case where variation is null but value isn't

* use SecureRandom instead of Random, just to make scanners happier

* rm unused

* fix deletion versioning logic, implement tombstones (#244)

* disable contract tests for API 31/33

* use okhttp-eventsource 1.11.3

* ensure timed-out clients get closed in contract tests

* clean up instances map on close (#247)

* clean up instances map on close

* improve atomicity of access to instances, ensure they can't be modified via closed clients

* update more methods that iterate over instances

* rm unnecessary LDClientControl

* use com.launchdarkly.logging with Timber adapter (#235)

* rm unused plugin

* clean up leftover polling alarms

* don't use connection pool/keep-alive for polling requests

* add sub-configuration builder for events

* diagnosticRecordingInterval should also be part of the new builder

* misc fixes

* remove deprecated usages & unused imports

* misc fixes

* revert unnecessary change

* doc comments

* add configuration builders for polling/streaming

* fix polling mode initialization

* fix diagnostic event properties

* fix logic for diagnostic recording interval

* fix tests

* fix defaulting logic

* fix test

* add configuration builder for HTTP

* improve tests

* test cleanup

* fix test

* add configuration builder for service endpoints

* misc fixes

* disable diagnostic events if analytics events are disabled

* deprecations

* don't keep summary event counters in SharedPreferences

* don't create a summary event if there's no data

* rm duplicated lines

* use regular in-memory storage for summary events (customer-reported performance issue) (#279)

* don't keep summary event counters in SharedPreferences

* don't create a summary event if there's no data

* fix doc comment

* fix @SInCE

* do an initial poll if SDK starts in the background (3.x) (#286)

* add streamEvenInBackground option (3.x) (#287)

* re-fix previous fix for connection keep-alive

Co-authored-by: Gavin Whelan <gwhelan@launchdarkly.com>
Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Robert J. Neal <robertjneal@users.noreply.github.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Alex Engelberg <aengelberg@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
tanderson-ld pushed a commit that referenced this issue May 17, 2023
* Revert to old String behavior for allFlags, initialize WeakReference in SharedPrefsFlagStore.

* Better implementation of EvaluationReason serialization type adapter.

* Revert "Better implementation of EvaluationReason serialization type
adapter." Wrong branch...

This reverts commit 69c1c9b.

* Gw/ch29266/flagstore (#105)

* Changed shared preferences store system to user a single FlagStore
system that holds all the information on a flag to prevent issues
arising from unsynchronized separate stores for flag meta-data and
values.

* Abstract FlagStoreManager from FlagStore, new FlagStoreFactory class so manager can construct FlagStores of unknown type. Reformatted interfaces. Removed unused imports.

* Handle null case in allFlags, actually commit changes to UserManager.

* Hopefully fix edge cases in summary event reporting to pass testing.

* Hopefully fix edge cases in summary event reporting to pass testing.

* Simplify getFeaturesJsonObject as no longer using -1 as placeholder for null for variations.

* Make Flag non-mutable. Move GsonCache to gson package, move custom serializer/deserializers to classes in gson package and create one for PUT responses. Removed BaseUserSharedPreferences.

* Send summary event even if stored flag doesn't exist.

* Move sendSummaryEvent update code to UserSummaryEventSharedPreferences to synchronize to prevent data race on sending, updating, and clearing event store. Move SummaryEventSharedPreferences and UserSummaryEventSharedPreferences out of response package.

* Update SharedPrefsFlagStore to hold StoreUpdatedListener in weak reference. Fix various warnings.

* Migration code for upcoming flagstore.

* Remove couple of debug messages.

* Handle todos.

* Revert to old String behavior for allFlags, initialize WeakReference in SharedPrefsFlagStore.

* Better implementation of EvaluationReason serialization type adapter.

* Remove isUnknown argument from SummaryEventSharedPreferences methods. Use Runnable instead of Callable in UserManager to avoid useless return nulls. Rename FlagStoreFactoryInterface to FlagStoreFactory.

* Statically initialize Gson instance in GsonCache.

* Make Gson instance in GsonCache final on principle.

* Return json flags as JsonElement in allFlags map. (#106)

* Bump ok-http version to 3.9.1 (#107)

* fix annotations so eval reasons are serialized in events

* fix/expand doc comments for public methods

* typo

* typo

* add version string getter method

* Check for null key before file comparison check. (#110)

* [ch33658] Add unsafeReset() for LDClient testing re-initialization (#111)

Add `unsafeReset()` method to close and clear instances for re-initializing client between tests. Update LDClientTest to call `unsafeReset()` before tests.

* [ch33846] Rename tests to not start with capitals and general refactoring (#112)

* Rename tests to not start with capitals
* Reindent MultiEnvironmentLDClientTest to be consistent
* Optimize imports
* Move TLS patch into TLSUtils
* Make setModernTlsVersionsOnSocket private and remove redundant null check
* Remove code duplication in LDClient track overloaded methods.
* Remove validateParameter in LDClient that was using a NullPointerException as a null test.
* Simplify Debounce to use listener instead of callback.

* Add documentation for flagstore implementation (#113)

* [ch35150] Unit tests and bug fixes (#114)

- Use android test orchestrator to run tests isolated from each other. This prevents the issues testing singletons. Also enabled option to clear package data between runs allowing more extensive flagstore testing.
- Remove unsafe reset as it was added only for allowing testing the LDClient singleton.
- Tests for new FlagStore code.
- Convenience test FlagBuilder
- Fix Migration to not turn all flags into Strings
- Fix issue with clearAndApplyFlagUpdates not generating correct events for listeners.

* Add compatibility behavior to stringVariation and allFlags methods. (#115)

If a Json flag is requested with stringVariation it will serialize it to a String. Json flags will also be serialized to Strings for the map returned by allFlags()

* Update LDUser not to store all fields as Json. (#116)

Add testing rule to setup and teardown Timber trees for debug logging. Add additional LDUser tests. Fixed a bit of flakiness in deletesOlderThanLastFiveStoredUsers test that showed up all of a sudden.

* Add metricValue field to CustomEvent, add overloaded track method for (#118)

creating custom events with metricValues.

* [ch37794] Run connected emulator tests in CircleCI (#120)

* [ch34533] connection status, removing guava, network restructuring. (#117)

* Add ConnectionInformation class.
* Remove all internal uses of Guava.
* Update StreamUpdateProcessor to only debounce ping events.
* Add a connection state monitor to the example app.

* rename repo and package name and apply markdown templates (#121)

* Fix issue that stream could be started before stopping when calling identify. (#122)

* Revert "Fix issue that stream could be started before stopping when calling identify. (#122)"

This reverts commit fdede38.

* Revert "rename repo and package name and apply markdown templates (#121)"

This reverts commit 2215275.

* Revert "Revert "Fix issue that stream could be started before stopping when calling identify. (#122)""

This reverts commit 0849812.

* Revert "Revert "rename repo and package name and apply markdown templates (#121)""

This reverts commit bbbeb81.

* Fix thread leak on identify call from restarting EventProcessor without shutting it down first. (#123)

* Add top level try/catch to migration methods. Check flag version SharedPreferences object for String type before cast. (#124)

* Update Throttler to call runnable on background thread. (#125)

* Fix ConcurrentModificationException of instance map (#126)

Move iteration over client instances for ConnectivityReceiver and PollingUpdater to within LDClient to allow synchronizing on initialization.

* adding a circleci badge to the readme (#127)

* Fix bug where `stop` in StreamUpdateProcessor could not call it's listener when the stream is already closed.

This caused a race condition in repeated stream restarts that could put the SDK in a bad state.

* Change LDAwaitFuture to not treat zero timeout as unlimited timeout

Treating a timeout of zero as unlimited caused a change in behavior when initializing the SDK. This update restores the behavior init had when zero was passed as the timeout argument from pre-2.8.0. Also improves handling of spurious wakeups, and includes test cases for LDAwaitFuture.

* Revert "Merge remote-tracking branch 'remotes/origin/experiment' into next-release"

This reverts commit 3ac167f, reversing
changes made to d26e006.

* CircleCI fixes (#131)

* Better ci fix (#132)

* Speedup tests by building on macOS (#137)

* Background identify fixes (#133)

Add new testing controllers for network and foreground states. For network control, mobile data must be disabled on recent Android versions, updated circleci config to do this. Add new connectivity manager tests. Made EventProcessor and UserManager minimal interfaces for mocking, with actual implementations moved to DefaultEventProcessor and DefaultUserManager. Fixed issue with blocking in background modes.

* Experimentation 1.5 updates (#134)

* add entire compile-time classpath to javadoc classpath

* javadoc fixes: <p/> is not a thing

* do fail on javadoc errors

* add javadoc step, misc CI cleanup

* misc javadoc fixes

* remove unintentional(?) immediate event flush; clean up event tests

* remove unreliable test assumption about elapsed time

* [ch57098] Deprecate LDCountryCode (#141)

Deprecate LDCountryCode class and LDUser setters that take LDCountryCode as an argument.

* Catch `SecurityException` when setting alarm in case there are already (#143)

the maximum allowed number of alarms on Samsung devices.

* Revert "[ch57098] Deprecate LDCountryCode (#141)" so we can do a patch release
first.

This reverts commit c0e71ae.

* Revert "Revert "[ch57098] Deprecate LDCountryCode (#141)" so we can do a patch release"

This reverts commit 23b930f.

* Deprecate public classes (#145)

* Deprecate some unnecessarily public classes, duplicate classes as non-public to
avoid using the deprecated classes.

* [ch61092] Add event payload ID. (#147)

* Add event retry. (#149)

* Fix javadoc comment for release.

* Fix broken merge.

* [ch65133] Deprecate classes (#150)

* Deprecate UserSummaryEventSharedPreferences, SummaryEventSharedPreferences, FeatureFlagFetcher, Util, Debounce.

* Improve Javadoc and reduce interface clutter. (#152)

* Save Javadoc artifact and include logcat in circle output with tee. (#153)

* Save Javadoc artifact on circleci.

* Add step to kill emulator after tests, and tee output of logcat for visibility
during run.

* [ch62120] Background during identify callback (#154)

* Adding more connectivity manager tests.
* Updated internal `Foreground` class to call listeners on a background thread.
* Add some comments explaining the behavior of test controllers.
* Adding fixes for cases where the completion callback may not be called.

* [ch65914] Diagnostic events (#156)

* [ch65352] Expose LDValue rather than Gson types (#158)

* Remove SET_ALARM permission. The comment that this was required for background updating is incorrect, this permission is only for sending broadcasts to an alarm clock application, something we do not do, and should never do. (#159)

* Fix minimum diagnostic recording interval comment. (#160)

* Data since date was not getting reset after each periodic diagnostic event. (#161)

* [ch75315] Add maxCachedUsers configuration option (#162)

Adds maxCachedUsers configuration option for configuring the limit on how many
users have their flags cached locally.

* Configure okhttp cache for polling requests to be stored in a subdirectory of the application cache directory. (#164)

* Fixes ch76614 and add test of null fallback unknown flag event generation. Also some finishing touches to LDValue changes, including LDClientInterface updates, more tests, and improvements to null behavior handling. (#163)

* Removing ldvalue changes before release (#165)

* Revert "[ch65352] Expose LDValue rather than Gson types (#158)"

This reverts commit 1e29a82

* Fixes after revert.

* [ch69437] Support for setting additional headers to be included in requests. (#166)

* [ch89933] Improve resiliency of store for summary events. (#167)

See #105 for the original issue.

* [ch94053] Improve throttler behavior. (#169)

* Add doubleVariation, doubleVariationDetail. (#171)

Deprecates floatVariation, floatVariationDetail.

* Provide pollUri configuration and deprecate baseUri. (#172)

* Fix throttler behavior to ensure attempt count resets are not cancelled (#178)

* [ch98336] Broaden catch statement on scheduling polling alarm (#181)

This is to handle more than just the SecurityException that Samsung throws, as we've gotten an issue report that some devices throw a IllegalStateException instead.

* Removed the guides link

* Include flag key in warning message when converting a json flag to a string (#185)

* (2.x) Prevent NullPointerException when diagnostic processor shut down before starting. (#210)

* Release 2.14.2 (#130)

## [2.14.2] - 2021-06-02
### Fixed
- Added check to prevent `NullPointerException` in `DiagnosticEventProcessor.stopScheduler` when `LDClient.close` is called before the application is foregrounded when the SDK was initialized in the background. ([#127](#127))
- Log message warning that JSON flag was requested as a String has been updated to include the key of the flag requested to assist in discovering which flag is being requested with an unexpected type. ([#116](#116))

* Bump version and update changelog for release.

* Explicitly specify android:exported attribute on manifest receivers. (#211)

* Update java common (#212)

* Flag PendingIntent on new enough platforms as the flag is required on Android S+ (#213)

* Add try for getting network capabilities (#214)

* ch103537 bump java-sdk-common to 1.2 to support inExperiment on eval reason (#215)

* Remove `allowBackup` manifest attribute that can conflict with the application's (#217)

* Update the version to 2.8.9

* Add explicit proguard directives for keeping BroadcastReceivers. (#219)

* Bump Gradle, Android Gradle Plugin, and Dexcount Gradle

* Use the latest 7.1.1 version

* Using the version that still support Java 8 but pin the grgit core behind the scene

* Remove Android Appcompat dependency (#222)

* Bump dependencies and reorganize Gradle file somewhat. (#223)

* Add the null check to prevent multiple allocation of the DiagnosticEventProcessor

* Fix sonatype release plugin (#226)

* Add .ldrelease configuration (#227)

* Add contract test service (#228)

* Fix test service failing on later API versions (#229)

* Add usesCleartextTraffic=true to contract-tests AndroidManifest

This allows the contract tests to work on API level 28 and above

* Fix start-emulator.sh to pick the newest image instead of the oldest

* Refactor CI config into separate jobs with a matrix (#230)

* Don't auto-retry emulator tests (#231)

* Add contract tests for API level 21 (#232)

* Remove unnecessary locking in LDClient (#233)

* Remove `synchronized` keywords from every `LDClient` method

* Treat `instances` as immutable, and swap out the whole map after constructing all the clients

* Use a lock to ensure we don't try to init twice

* Update `ConnectivityManager` so it now manages `DiagnosticEventManager`

* Run contract tests on Android 31, 33 (#234)

* Unsuppress streaming/requests and polling/requests (#236)

* don't create a new executor just to trigger a flush

* remove short publishing timeout, use defaults of 60 retries & 10 seconds

* Serialize null values of `anonymous` as null (#237)

* fix URL path concatenation to avoid double slashes

* fix NPE in edge case where variation is null but value isn't

* use SecureRandom instead of Random, just to make scanners happier

* rm unused

* fix deletion versioning logic, implement tombstones (#244)

* disable contract tests for API 31/33

* use okhttp-eventsource 1.11.3

* ensure timed-out clients get closed in contract tests

* clean up instances map on close (#247)

* clean up instances map on close

* improve atomicity of access to instances, ensure they can't be modified via closed clients

* update more methods that iterate over instances

* rm unnecessary LDClientControl

* use com.launchdarkly.logging with Timber adapter (#235)

* rm unused plugin

* clean up leftover polling alarms

* don't use connection pool/keep-alive for polling requests

* add sub-configuration builder for events

* diagnosticRecordingInterval should also be part of the new builder

* misc fixes

* remove deprecated usages & unused imports

* misc fixes

* revert unnecessary change

* doc comments

* add configuration builders for polling/streaming

* fix polling mode initialization

* fix diagnostic event properties

* fix logic for diagnostic recording interval

* fix tests

* fix defaulting logic

* fix test

* add configuration builder for HTTP

* improve tests

* test cleanup

* fix test

* add configuration builder for service endpoints

* misc fixes

* disable diagnostic events if analytics events are disabled

* deprecations

* don't keep summary event counters in SharedPreferences

* don't create a summary event if there's no data

* rm duplicated lines

* use regular in-memory storage for summary events (customer-reported performance issue) (#279)

* don't keep summary event counters in SharedPreferences

* don't create a summary event if there's no data

* fix doc comment

* fix @SInCE

* do an initial poll if SDK starts in the background (3.x) (#286)

* add streamEvenInBackground option (3.x) (#287)

* re-fix previous fix for connection keep-alive

* add ApplicationInfo a.k.a. tags (3.x) (#289)

Co-authored-by: Gavin Whelan <gwhelan@launchdarkly.com>
Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Robert J. Neal <robertjneal@users.noreply.github.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Alex Engelberg <aengelberg@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants