From 574c98a245bf472039ce61a6975350de668fc39c Mon Sep 17 00:00:00 2001 From: LaunchDarklyReleaseBot <86431345+LaunchDarklyReleaseBot@users.noreply.github.com> Date: Wed, 16 Nov 2022 17:53:32 -0800 Subject: [PATCH] prepare 3.2.3 release (#196) * Fixed instanceId * Updates from PR review. * Added version and flagVersion, if available * refactor(LDClient, LDConfig): changes for PR * refactor(LDClient): changed isInternetConnected behavior for PR * refactor(LDClient): removed async getForMobileKeys and wait seconds version, replaced with method that returns requested instance * Bugfix/timber cleanup (#92) Relates to launchdarkly/android-client#60 Cleaned up timber logging messages to use string formatting rather than concatenation. Log messages should remain the same as before. Also replaced Log with Timber in the example app. * Fix crash when example app is backgrounded twice. * Add security provider update mechanism using Google Play Services to attempt a provider update when TLSv1.2 is not available. * Shared Preferences Fix for Multi Environment (#94) * fix(SharedPreferences): added more SharedPreferences first time migration and differentiated SharedPreferences by mobile key * fix(UserLocalSharePreference.java): added missing mobileKey additions to getSharedPreferences, cleaned up debugging code * Fix edge cases in how multi-environment handles connection changes. * fix(UserManagerTest.java): incorrect number of arguments to UserManager instantiation in unit test * Remove line of testing code accidentally left in and refactor shared preferences migration to make future migrations easier. * Final fixes to store migration. Should be fairly future proof. * Fix issue with primitive variation calls always returning null if fallback is null. * Remove CircleCI V1 config file. (#97) * Remove getting/comparing versions as floats (#99) To prevent floating point errors in flag version comparisons. * Include values in unknown summary events and compare values for (#100) equality when creating new summary counters. * simplify flag property deserialization * rm debugging * misc cleanup * rm debugging * add eval reason data model classes * misc fixes * serialize reason * add ability to receive evaluation reasons from LD * 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. * add methods to get value with explanation; refactor existing variation methods * 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. * Revert "Better implementation of EvaluationReason serialization type adapter." Wrong branch... This reverts commit 69c1c9b2b8d9a3b72fcd856f2b6da0e8c896802c. * 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 fdede38cf58af2802a116599580ea64a07d7dc4a. * Revert "rename repo and package name and apply markdown templates (#121)" This reverts commit 221527594dd632322aaf7edafa0b5edff719132e. * Revert "Revert "Fix issue that stream could be started before stopping when calling identify. (#122)"" This reverts commit 08498127157e038ec3e9d29203d29ea09c326679. * Revert "Revert "rename repo and package name and apply markdown templates (#121)"" This reverts commit bbbeb8103b58764a57fddb7bc72b93608702dbe7. * 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 3ac167fb01c5d6545cf91af7817818e313108f80, reversing changes made to d26e00666a89997c4b548bc54fd82882e518b4bc. * 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:

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 c0e71ae1214f6227f2643c467c26bdd1c07ec531. * Revert "Revert "[ch57098] Deprecate LDCountryCode (#141)" so we can do a patch release" This reverts commit 23b930ff0ff503a50af8c0ee4dcb294f688deb82. * 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 1e29a827 * 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 launchdarkly/android-client-sdk#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](https://github.com/launchdarkly/android-client-sdk/issues/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](https://github.com/launchdarkly/android-client-sdk/issues/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 * 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 Co-authored-by: torchhound Co-authored-by: Gavin Whelan Co-authored-by: Arun Bhalla Co-authored-by: jamesthacker Co-authored-by: Gavin Whelan Co-authored-by: torchhound Co-authored-by: Eli Bishop Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com> Co-authored-by: Ben Woskow Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com> Co-authored-by: Robert J. Neal Co-authored-by: Louis Chan Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com> Co-authored-by: Alex Engelberg Co-authored-by: LaunchDarklyReleaseBot --- ...ava => InMemorySummaryEventStoreTest.java} | 11 +- .../sdk/android/DefaultUserManager.java | 3 +- .../com/launchdarkly/sdk/android/Event.java | 8 +- .../android/InMemorySummaryEventStore.java | 114 ++++++++++++++++++ .../android/SharedPrefsSummaryEventStore.java | 101 ---------------- .../sdk/android/SummaryEventStore.java | 31 ++--- 6 files changed, 135 insertions(+), 133 deletions(-) rename launchdarkly-android-client-sdk/src/androidTest/java/com/launchdarkly/sdk/android/{SharedPrefsSummaryEventStoreTest.java => InMemorySummaryEventStoreTest.java} (94%) create mode 100644 launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/InMemorySummaryEventStore.java delete mode 100644 launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/SharedPrefsSummaryEventStore.java diff --git a/launchdarkly-android-client-sdk/src/androidTest/java/com/launchdarkly/sdk/android/SharedPrefsSummaryEventStoreTest.java b/launchdarkly-android-client-sdk/src/androidTest/java/com/launchdarkly/sdk/android/InMemorySummaryEventStoreTest.java similarity index 94% rename from launchdarkly-android-client-sdk/src/androidTest/java/com/launchdarkly/sdk/android/SharedPrefsSummaryEventStoreTest.java rename to launchdarkly-android-client-sdk/src/androidTest/java/com/launchdarkly/sdk/android/InMemorySummaryEventStoreTest.java index 18043da4..5a443958 100644 --- a/launchdarkly-android-client-sdk/src/androidTest/java/com/launchdarkly/sdk/android/SharedPrefsSummaryEventStoreTest.java +++ b/launchdarkly-android-client-sdk/src/androidTest/java/com/launchdarkly/sdk/android/InMemorySummaryEventStoreTest.java @@ -7,6 +7,7 @@ import com.launchdarkly.sdk.LDValue; import com.launchdarkly.sdk.LDValueType; +import org.junit.After; import org.junit.Assert; import org.junit.Before; import org.junit.Rule; @@ -21,9 +22,8 @@ import static org.junit.Assert.assertNull; import static org.junit.Assert.assertTrue; - @RunWith(AndroidJUnit4.class) -public class SharedPrefsSummaryEventStoreTest { +public class InMemorySummaryEventStoreTest { @Rule public TimberLoggingRule timberLoggingRule = new TimberLoggingRule(); @@ -44,6 +44,11 @@ public void setUp() { summaryEventStore = ldClient.getSummaryEventStore(); } + @After + public void tearDown() throws Exception { + ldClient.close(); + } + @Test public void startDateIsSaved() { assertTrue(ldClient.isInitialized()); @@ -102,7 +107,7 @@ public void evaluationsAreSaved() { assertEquals(LDValueType.STRING, features.get("stringFlag").defaultValue.getType()); assertEquals("string", features.get("stringFlag").defaultValue.stringValue()); - assertNull(features.get("jsonFlag").defaultValue); + assertEquals(LDValue.ofNull(), features.get("jsonFlag").defaultValue); } @Test diff --git a/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/DefaultUserManager.java b/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/DefaultUserManager.java index 7b406c18..396d6b8e 100644 --- a/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/DefaultUserManager.java +++ b/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/DefaultUserManager.java @@ -46,8 +46,7 @@ static synchronized DefaultUserManager newInstance(Application application, Feat this.fetcher = fetcher; this.flagStoreManager = new SharedPrefsFlagStoreManager(application, mobileKey, new SharedPrefsFlagStoreFactory(application, logger), maxCachedUsers, logger); - this.summaryEventStore = new SharedPrefsSummaryEventStore(application, - LDConfig.SHARED_PREFS_BASE_KEY + mobileKey + "-summaryevents", logger); + this.summaryEventStore = new InMemorySummaryEventStore(); this.environmentName = environmentName; this.logger = logger; diff --git a/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/Event.java b/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/Event.java index 5d120455..e73f65ba 100644 --- a/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/Event.java +++ b/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/Event.java @@ -117,11 +117,11 @@ class FeatureRequestEvent extends GenericEvent { } class SummaryEvent extends Event { - @Expose Long startDate; - @Expose Long endDate; - @Expose Map features; + @Expose final long startDate; + @Expose final long endDate; + @Expose final Map features; - SummaryEvent(Long startDate, Long endDate, Map features) { + SummaryEvent(long startDate, long endDate, Map features) { super("summary"); this.startDate = startDate; this.endDate = endDate; diff --git a/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/InMemorySummaryEventStore.java b/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/InMemorySummaryEventStore.java new file mode 100644 index 00000000..d2e97915 --- /dev/null +++ b/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/InMemorySummaryEventStore.java @@ -0,0 +1,114 @@ +package com.launchdarkly.sdk.android; + +import androidx.annotation.Nullable; + +import com.launchdarkly.sdk.LDValue; + +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +final class InMemorySummaryEventStore implements SummaryEventStore { + private final class CounterKey { + final String flagKey; + final Integer flagVersion; + final Integer variation; + + CounterKey(String flagKey, Integer flagVersion, Integer variation) { + this.flagKey = flagKey; + this.flagVersion = flagVersion; + this.variation = variation; + } + + @Override + public boolean equals(Object other) { + if (other instanceof CounterKey) { + CounterKey o = (CounterKey)other; + return flagKey.equals(o.flagKey) && Objects.equals(flagVersion, o.flagVersion) && + Objects.equals(variation, o.variation); + } + return false; + } + + @Override + public int hashCode() { + return ((flagKey.hashCode() * 31) + (flagVersion == null ? -1 : flagVersion.intValue())) * 31 + + (variation == null ? -1 : variation.intValue()); + } + } + + private final class CounterValue { + final LDValue value; + final LDValue defaultValue; + volatile int count; + + CounterValue(LDValue value, LDValue defaultValue) { + this.value = value; + this.defaultValue = defaultValue; + } + } + + private final Map data = new HashMap<>(); + private long startTimestamp = 0, endTimestamp = 0; + + public synchronized void clear() { + data.clear(); + startTimestamp = endTimestamp = 0; + } + + @Override + public synchronized void addOrUpdateEvent( + String flagKey, + LDValue value, + LDValue defaultVal, + @Nullable Integer version, + @Nullable Integer variation + ) { + long timestamp = System.currentTimeMillis(); + if (startTimestamp == 0) { + startTimestamp = timestamp; + } + if (timestamp > endTimestamp) { + endTimestamp = timestamp; + } + CounterKey counterKey = new CounterKey(flagKey, version, variation); + CounterValue counterValue = data.get(counterKey); + if (counterValue == null) { + counterValue = new CounterValue(value, defaultVal); + data.put(counterKey, counterValue); + } + counterValue.count++; + } + + @Override + public synchronized SummaryEvent getSummaryEvent() { + if (data.size() == 0) { + return null; + } + Map countersOut = new HashMap<>(); + for (Map.Entry kv: data.entrySet()) { + CounterKey counterKey = kv.getKey(); + String flagKey = counterKey.flagKey; + CounterValue counterValue = kv.getValue(); + SummaryEventStore.FlagCounters countersForFlag = countersOut.get(flagKey); + if (countersForFlag == null) { + countersForFlag = new FlagCounters(counterValue.defaultValue); + countersOut.put(flagKey, countersForFlag); + } + countersForFlag.counters.add(new FlagCounter( + counterValue.value, + counterKey.flagVersion, + counterKey.variation, + counterValue.count + )); + } + return new SummaryEvent(startTimestamp, endTimestamp, countersOut); + } + + @Override + public synchronized SummaryEvent getSummaryEventAndClear() { + SummaryEvent summary = getSummaryEvent(); + clear(); + return summary; + } +} diff --git a/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/SharedPrefsSummaryEventStore.java b/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/SharedPrefsSummaryEventStore.java deleted file mode 100644 index 6d4af3e9..00000000 --- a/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/SharedPrefsSummaryEventStore.java +++ /dev/null @@ -1,101 +0,0 @@ -package com.launchdarkly.sdk.android; - -import android.app.Application; -import android.content.Context; -import android.content.SharedPreferences; - -import com.launchdarkly.logging.LDLogger; -import com.launchdarkly.sdk.LDValue; - -import java.util.HashMap; - -/** - * Used internally by the SDK. - */ -class SharedPrefsSummaryEventStore implements SummaryEventStore { - - private static final String START_DATE_KEY = "$startDate$"; - - private final SharedPreferences sharedPreferences; - private final LDLogger logger; - - SharedPrefsSummaryEventStore(Application application, String name, LDLogger logger) { - this.sharedPreferences = application.getSharedPreferences(name, Context.MODE_PRIVATE); - this.logger = logger; - } - - @Override - public synchronized void addOrUpdateEvent(String flagResponseKey, LDValue value, LDValue defaultVal, Integer version, Integer variation) { - FlagCounters storedCounters = getFlagCounters(flagResponseKey); - - if (storedCounters == null) { - storedCounters = new FlagCounters(defaultVal); - } - - boolean existingCounter = false; - for (FlagCounter counter: storedCounters.counters) { - if (counter.matches(version, variation)) { - counter.count++; - existingCounter = true; - break; - } - } - - if (!existingCounter) { - storedCounters.counters.add(new FlagCounter(value, version, variation)); - } - - SharedPreferences.Editor editor = sharedPreferences.edit(); - editor.putString(flagResponseKey, GsonCache.getGson().toJson(storedCounters)); - if (!sharedPreferences.contains(START_DATE_KEY)) { - editor.putLong(START_DATE_KEY, System.currentTimeMillis()).apply(); - } - editor.apply(); - - logger.debug("Updated summary for flagKey {} to {}", flagResponseKey, GsonCache.getGson().toJson(storedCounters)); - } - - @Override - public synchronized SummaryEvent getSummaryEvent() { - long startDate = sharedPreferences.getLong(START_DATE_KEY, -1); - HashMap features = new HashMap<>(); - for (String key: sharedPreferences.getAll().keySet()) { - if (START_DATE_KEY.equals(key)) { - continue; - } - features.put(key, getFlagCounters(key)); - } - - if (startDate == -1 || features.size() == 0) { - return null; - } - - return new SummaryEvent(startDate, System.currentTimeMillis(), features); - } - - synchronized FlagCounters getFlagCounters(String flagKey) { - try { - String storedJson = sharedPreferences.getString(flagKey, null); - if (storedJson == null) { - return null; - } - return GsonCache.getGson().fromJson(storedJson, FlagCounters.class); - } catch (Exception ignored) { - // Fallthrough to clear - } - // An old version of shared preferences is stored, so clear it. - clear(); - return null; - } - - @Override - public synchronized SummaryEvent getSummaryEventAndClear() { - SummaryEvent summaryEvent = getSummaryEvent(); - clear(); - return summaryEvent; - } - - public synchronized void clear() { - sharedPreferences.edit().clear().apply(); - } -} diff --git a/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/SummaryEventStore.java b/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/SummaryEventStore.java index 2b451333..1e259603 100644 --- a/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/SummaryEventStore.java +++ b/launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/SummaryEventStore.java @@ -17,33 +17,18 @@ interface SummaryEventStore { SummaryEvent getSummaryEventAndClear(); class FlagCounter { - @Expose Integer version; - @Expose Integer variation; - @Expose Boolean unknown; - @Expose LDValue value; - @Expose int count; + @Expose final Integer version; + @Expose final Integer variation; + @Expose final Boolean unknown; + @Expose final LDValue value; + @Expose final int count; - FlagCounter(LDValue value, Integer version, Integer variation) { + FlagCounter(LDValue value, Integer version, Integer variation, int count) { this.version = version; this.variation = variation; - if (version == null) { - unknown = true; - } + unknown = version == null ? Boolean.TRUE : null; this.value = value; - this.count = 1; - } - - boolean isUnknown() { - return unknown != null && unknown; - } - - boolean matches(Integer version, Integer variation) { - if (isUnknown()) { - return version == null; - } - - return Objects.equals(this.version, version) && - Objects.equals(this.variation, variation); + this.count = count; } }