diff --git a/splitio/example/android/build.gradle b/splitio/example/android/build.gradle index 5160cdd..0822484 100644 --- a/splitio/example/android/build.gradle +++ b/splitio/example/android/build.gradle @@ -5,7 +5,7 @@ buildscript { } dependencies { - classpath 'com.android.tools.build:gradle:4.1.3' + classpath 'com.android.tools.build:gradle:7.4.2' } } @@ -24,6 +24,6 @@ subprojects { project.evaluationDependsOn(':app') } -task clean(type: Delete) { +tasks.register("clean", Delete) { delete rootProject.buildDir } diff --git a/splitio_android/android/build.gradle b/splitio_android/android/build.gradle index 62cfb6c..20feee8 100644 --- a/splitio_android/android/build.gradle +++ b/splitio_android/android/build.gradle @@ -36,8 +36,7 @@ android { } dependencies { - implementation 'io.split.client:android-client:2.12.0' - implementation 'androidx.work:work-runtime:2.7.1' + implementation 'io.split.client:android-client:3.2.1' implementation 'com.squareup.okhttp3:okhttp:3.12.13' testImplementation 'junit:junit:4.13.2' diff --git a/splitio_android/android/gradle/wrapper/gradle-wrapper.jar b/splitio_android/android/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..41d9927 Binary files /dev/null and b/splitio_android/android/gradle/wrapper/gradle-wrapper.jar differ diff --git a/splitio_android/android/gradle/wrapper/gradle-wrapper.properties b/splitio_android/android/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..8049c68 --- /dev/null +++ b/splitio_android/android/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/splitio_android/android/gradlew b/splitio_android/android/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/splitio_android/android/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/splitio_android/android/gradlew.bat b/splitio_android/android/gradlew.bat new file mode 100644 index 0000000..ac1b06f --- /dev/null +++ b/splitio_android/android/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/splitio_android/android/src/main/java/io/split/splitio/SplitClientConfigHelper.java b/splitio_android/android/src/main/java/io/split/splitio/SplitClientConfigHelper.java index 962c5bc..825550e 100644 --- a/splitio_android/android/src/main/java/io/split/splitio/SplitClientConfigHelper.java +++ b/splitio_android/android/src/main/java/io/split/splitio/SplitClientConfigHelper.java @@ -12,6 +12,8 @@ import io.split.android.client.SplitFilter; import io.split.android.client.SyncConfig; import io.split.android.client.impressions.ImpressionListener; +import io.split.android.client.shared.UserConsent; +import io.split.android.client.utils.logger.SplitLogLevel; class SplitClientConfigHelper { @@ -36,11 +38,16 @@ class SplitClientConfigHelper { private static final String SYNC_CONFIG = "syncConfig"; private static final String SYNC_CONFIG_NAMES = "syncConfigNames"; private static final String SYNC_CONFIG_PREFIXES = "syncConfigPrefixes"; + private static final String IMPRESSIONS_MODE = "impressionsMode"; + private static final String SYNC_ENABLED = "syncEnabled"; + private static final String USER_CONSENT = "userConsent"; + private static final String ENCRYPTION_ENABLED = "encryptionEnabled"; + private static final String LOG_LEVEL = "logLevel"; /** * Creates a {@link SplitClientConfig} object from a map. * - * @param configurationMap Map of config values. + * @param configurationMap Map of config values. * @param impressionListener Optional ImpressionListener. * @return {@link SplitClientConfig} object. */ @@ -94,7 +101,7 @@ static SplitClientConfig fromMap(@NonNull Map configurationMap, Boolean enableDebug = getBoolean(configurationMap, ENABLE_DEBUG); if (enableDebug != null && enableDebug) { - builder.enableDebug(); + builder.logLevel(SplitLogLevel.DEBUG); } Boolean streamingEnabled = getBoolean(configurationMap, STREAMING_ENABLED); @@ -156,6 +163,49 @@ static SplitClientConfig fromMap(@NonNull Map configurationMap, builder.syncConfig(syncConfigBuilder.build()); } + String impressionsMode = getString(configurationMap, IMPRESSIONS_MODE); + if (impressionsMode != null) { + builder.impressionsMode(impressionsMode); + } + + Boolean syncEnabled = getBoolean(configurationMap, SYNC_ENABLED); + if (syncEnabled != null) { + builder.syncEnabled(syncEnabled); + } + + String userConsent = getString(configurationMap, USER_CONSENT); + if (userConsent != null) { + if ("unknown".equalsIgnoreCase(userConsent)) { + builder.userConsent(UserConsent.UNKNOWN); + } else if ("declined".equalsIgnoreCase(userConsent)) { + builder.userConsent(UserConsent.DECLINED); + } else { + builder.userConsent(UserConsent.GRANTED); + } + } + + Boolean encryptionEnabled = getBoolean(configurationMap, ENCRYPTION_ENABLED); + if (encryptionEnabled != null) { + builder.encryptionEnabled(encryptionEnabled); + } + + String logLevel = getString(configurationMap, LOG_LEVEL); + if (logLevel != null) { + if ("verbose".equalsIgnoreCase(logLevel)) { + builder.logLevel(SplitLogLevel.VERBOSE); + } else if ("debug".equalsIgnoreCase(logLevel)) { + builder.logLevel(SplitLogLevel.DEBUG); + } else if ("info".equalsIgnoreCase(logLevel)) { + builder.logLevel(SplitLogLevel.INFO); + } else if ("warning".equalsIgnoreCase(logLevel)) { + builder.logLevel(SplitLogLevel.WARNING); + } else if ("error".equalsIgnoreCase(logLevel)) { + builder.logLevel(SplitLogLevel.ERROR); + } else { + builder.logLevel(SplitLogLevel.NONE); + } + } + return builder.serviceEndpoints(serviceEndpointsBuilder.build()).build(); } diff --git a/splitio_android/android/src/test/java/io/split/splitio/SplitClientConfigHelperTest.java b/splitio_android/android/src/test/java/io/split/splitio/SplitClientConfigHelperTest.java index 7add0b9..aa9b7f4 100644 --- a/splitio_android/android/src/test/java/io/split/splitio/SplitClientConfigHelperTest.java +++ b/splitio_android/android/src/test/java/io/split/splitio/SplitClientConfigHelperTest.java @@ -1,6 +1,7 @@ package io.split.splitio; import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertTrue; import static org.mockito.Mockito.mock; @@ -16,6 +17,9 @@ import io.split.android.client.SplitClientConfig; import io.split.android.client.SplitFilter; import io.split.android.client.impressions.ImpressionListener; +import io.split.android.client.service.impressions.ImpressionsMode; +import io.split.android.client.shared.UserConsent; +import io.split.android.client.utils.logger.SplitLogLevel; public class SplitClientConfigHelperTest { @@ -44,8 +48,14 @@ public void configValuesAreMappedCorrectly() { syncConfigMap.put("syncConfigNames", Arrays.asList("split1", "split2")); syncConfigMap.put("syncConfigPrefixes", Arrays.asList("split_", "my_split_")); configValues.put("syncConfig", syncConfigMap); + configValues.put("impressionsMode", "none"); + configValues.put("syncEnabled", false); + configValues.put("userConsent", "declined"); + configValues.put("encryptionEnabled", true); + configValues.put("logLevel", "verbose"); - SplitClientConfig splitClientConfig = SplitClientConfigHelper.fromMap(configValues, mock(ImpressionListener.class)); + SplitClientConfig splitClientConfig = SplitClientConfigHelper + .fromMap(configValues, mock(ImpressionListener.class)); assertEquals(80000, splitClientConfig.featuresRefreshRate()); assertEquals(70000, splitClientConfig.segmentsRefreshRate()); @@ -56,7 +66,6 @@ public void configValuesAreMappedCorrectly() { assertEquals(40000, splitClientConfig.eventFlushInterval()); assertEquals(5000, splitClientConfig.eventsPerPush()); assertEquals("none", splitClientConfig.trafficType()); - assertTrue(splitClientConfig.debugEnabled()); assertTrue(splitClientConfig.streamingEnabled()); assertTrue(splitClientConfig.persistentAttributesEnabled()); assertEquals("apiEndpoint.split.io", splitClientConfig.endpoint()); @@ -68,5 +77,78 @@ public void configValuesAreMappedCorrectly() { assertEquals(SplitFilter.Type.BY_NAME, splitClientConfig.syncConfig().getFilters().get(0).getType()); assertEquals(Arrays.asList("split_", "my_split_"), splitClientConfig.syncConfig().getFilters().get(1).getValues()); assertEquals(SplitFilter.Type.BY_PREFIX, splitClientConfig.syncConfig().getFilters().get(1).getType()); + assertEquals(ImpressionsMode.NONE, splitClientConfig.impressionsMode()); + assertFalse(splitClientConfig.syncEnabled()); + assertEquals(UserConsent.DECLINED, splitClientConfig.userConsent()); + assertTrue(splitClientConfig.encryptionEnabled()); + assertEquals(SplitLogLevel.VERBOSE, splitClientConfig.logLevel()); + } + + @Test + public void enableDebugLogLevelIsMappedCorrectly() { + Map configValues = new HashMap<>(); + + configValues.put("enableDebug", true); + + SplitClientConfig splitClientConfig = SplitClientConfigHelper + .fromMap(configValues, mock(ImpressionListener.class)); + + assertEquals(SplitLogLevel.DEBUG, splitClientConfig.logLevel()); + } + + @Test + public void logLevelsAreMappedCorrectly() { + Map verboseConfigValues = Collections.singletonMap("logLevel", "verbose"); + Map debugConfigValues = Collections.singletonMap("logLevel", "debug"); + Map infoConfigValues = Collections.singletonMap("logLevel", "info"); + Map warnConfigValues = Collections.singletonMap("logLevel", "warning"); + Map errorConfigValues = Collections.singletonMap("logLevel", "error"); + Map noneConfigValues = Collections.singletonMap("logLevel", "none"); + + SplitClientConfig verboseConfig = SplitClientConfigHelper + .fromMap(verboseConfigValues, mock(ImpressionListener.class)); + SplitClientConfig debugConfig = SplitClientConfigHelper.fromMap(debugConfigValues, mock(ImpressionListener.class)); + SplitClientConfig infoConfig = SplitClientConfigHelper.fromMap(infoConfigValues, mock(ImpressionListener.class)); + SplitClientConfig warnConfig = SplitClientConfigHelper.fromMap(warnConfigValues, mock(ImpressionListener.class)); + SplitClientConfig errorConfig = SplitClientConfigHelper.fromMap(errorConfigValues, mock(ImpressionListener.class)); + SplitClientConfig noneConfig = SplitClientConfigHelper.fromMap(noneConfigValues, mock(ImpressionListener.class)); + + assertEquals(SplitLogLevel.VERBOSE, verboseConfig.logLevel()); + assertEquals(SplitLogLevel.DEBUG, debugConfig.logLevel()); + assertEquals(SplitLogLevel.INFO, infoConfig.logLevel()); + assertEquals(SplitLogLevel.WARNING, warnConfig.logLevel()); + assertEquals(SplitLogLevel.ERROR, errorConfig.logLevel()); + assertEquals(SplitLogLevel.NONE, noneConfig.logLevel()); + } + + @Test + public void userConsentIsMappedCorrectly() { + SplitClientConfig grantedConfig = SplitClientConfigHelper + .fromMap(Collections.singletonMap("userConsent", "granted"), mock(ImpressionListener.class)); + SplitClientConfig unknownConfig = SplitClientConfigHelper + .fromMap(Collections.singletonMap("userConsent", "unknown"), mock(ImpressionListener.class)); + SplitClientConfig declinedConfig = SplitClientConfigHelper + .fromMap(Collections.singletonMap("userConsent", "declined"), mock(ImpressionListener.class)); + SplitClientConfig anyConfig = SplitClientConfigHelper + .fromMap(Collections.singletonMap("userConsent", "any"), mock(ImpressionListener.class)); + + assertEquals(UserConsent.GRANTED, grantedConfig.userConsent()); + assertEquals(UserConsent.UNKNOWN, unknownConfig.userConsent()); + assertEquals(UserConsent.DECLINED, declinedConfig.userConsent()); + assertEquals(UserConsent.GRANTED, anyConfig.userConsent()); + } + + @Test + public void impressionsModeValuesAreMappedCorrectly() { + SplitClientConfig debugConfig = SplitClientConfigHelper + .fromMap(Collections.singletonMap("impressionsMode", "debug"), mock(ImpressionListener.class)); + SplitClientConfig noneConfig = SplitClientConfigHelper + .fromMap(Collections.singletonMap("impressionsMode", "none"), mock(ImpressionListener.class)); + SplitClientConfig optimizedConfig = SplitClientConfigHelper + .fromMap(Collections.singletonMap("impressionsMode", "optimized"), mock(ImpressionListener.class)); + + assertEquals(ImpressionsMode.DEBUG, debugConfig.impressionsMode()); + assertEquals(ImpressionsMode.NONE, noneConfig.impressionsMode()); + assertEquals(ImpressionsMode.OPTIMIZED, optimizedConfig.impressionsMode()); } } diff --git a/splitio_ios/example/ios/Podfile.lock b/splitio_ios/example/ios/Podfile.lock index 38ef52f..8ec7ad5 100644 --- a/splitio_ios/example/ios/Podfile.lock +++ b/splitio_ios/example/ios/Podfile.lock @@ -1,9 +1,9 @@ PODS: - Flutter (1.0.0) - - Split (2.15.0) - - splitio_ios (0.1.0): + - Split (2.20.1) + - splitio_ios (0.2.0): - Flutter - - Split (~> 2.15.0) + - Split (~> 2.20.1) DEPENDENCIES: - Flutter (from `Flutter`) @@ -21,8 +21,8 @@ EXTERNAL SOURCES: SPEC CHECKSUMS: Flutter: 50d75fe2f02b26cc09d224853bb45737f8b3214a - Split: d103c6afa47b5d1eac21e066c6bc09c879b21798 - splitio_ios: 665651004a4984a415386b1eed4ae315b50bc069 + Split: afbdfda76fe2c90bd449564eed2d83de00c0ff69 + splitio_ios: e6d3dfe108ba894129a6b249d8914e3c44f0ffc4 PODFILE CHECKSUM: 6ab177d3659abbf5f15e864674366127c98cb8c0 diff --git a/splitio_ios/example/ios/SplitTests/SplitClientConfigHelperTests.swift b/splitio_ios/example/ios/SplitTests/SplitClientConfigHelperTests.swift index 69b43a5..beaa317 100644 --- a/splitio_ios/example/ios/SplitTests/SplitClientConfigHelperTests.swift +++ b/splitio_ios/example/ios/SplitTests/SplitClientConfigHelperTests.swift @@ -1,27 +1,33 @@ import XCTest @testable import splitio_ios +@testable import Split class SplitClientConfigHelperTests: XCTestCase { func testConfigValuesAreMappedCorrectly() throws { let configValues: [String: Any?] = ["featuresRefreshRate": 80000, - "segmentsRefreshRate": 70000, - "impressionsRefreshRate": 60000, - "telemetryRefreshRate": 2000, - "eventsQueueSize": 3999, - "impressionsQueueSize": 2999, - "eventFlushInterval": 40000, - "eventsPerPush": 5000, - "trafficType": "none", - "connectionTimeOut": 10, - "readTimeout": 25, - "disableLabels": true, - "enableDebug": true, - "proxyHost": "https://proxy", - "ready": 25, - "streamingEnabled": true, - "persistentAttributesEnabled": true, - "syncConfig": ["syncConfigNames": ["split1", "split2"], "syncConfigPrefixes": ["split_", "my_split_"]]] + "segmentsRefreshRate": 70000, + "impressionsRefreshRate": 60000, + "telemetryRefreshRate": 2000, + "eventsQueueSize": 3999, + "impressionsQueueSize": 2999, + "eventFlushInterval": 40000, + "eventsPerPush": 5000, + "trafficType": "none", + "connectionTimeOut": 10, + "readTimeout": 25, + "disableLabels": true, + "proxyHost": "https://proxy", + "ready": 25, + "streamingEnabled": true, + "persistentAttributesEnabled": true, + "syncConfig": ["syncConfigNames": ["split1", "split2"], "syncConfigPrefixes": ["split_", "my_split_"]], + "impressionsMode": "none", + "syncEnabled": false, + "userConsent": "declined", + "encryptionEnabled": true, + "logLevel": "verbose" + ] let splitClientConfig = SplitClientConfigHelper.fromMap(configurationMap: configValues, impressionListener: nil) @@ -34,8 +40,51 @@ class SplitClientConfigHelperTests: XCTestCase { XCTAssert(40000 == splitClientConfig.eventsPushRate) XCTAssert(5000 == splitClientConfig.eventsPerPush) XCTAssert("none" == splitClientConfig.trafficType) - XCTAssert(splitClientConfig.isDebugModeEnabled) XCTAssert(splitClientConfig.streamingEnabled) XCTAssert(splitClientConfig.persistentAttributesEnabled) + XCTAssertEqual("NONE", splitClientConfig.impressionsMode) + XCTAssertFalse(splitClientConfig.syncEnabled) + XCTAssertEqual(.declined, splitClientConfig.userConsent) + XCTAssertTrue(splitClientConfig.encryptionEnabled) + XCTAssertEqual(.verbose, splitClientConfig.logLevel) + } + + func testEnableDebugLogLevelIsMappedCorrectly() { + let configValues: [String: Any] = ["enableDebug": true] + let splitClientConfig = SplitClientConfigHelper.fromMap(configurationMap: configValues, impressionListener: nil) + XCTAssertEqual(SplitLogLevel.debug, splitClientConfig.logLevel) + } + + func testLogLevelsAreMappedCorrectly() { + let logLevels = ["verbose", "debug", "info", "warning", "error", "none"] + let expectedLogLevels: [SplitLogLevel] = [.verbose, .debug, .info, .warning, .error, .none] + + for (index, logLevel) in logLevels.enumerated() { + let configValues: [String: Any] = ["logLevel": logLevel] + let config = SplitClientConfigHelper.fromMap(configurationMap: configValues, impressionListener: nil) + XCTAssertEqual(expectedLogLevels[index], config.logLevel) + } + } + + func testUserConsentIsMappedCorrectly() { + let userConsents = ["granted", "unknown", "declined", "any"] + let expectedUserConsents: [UserConsent] = [.granted, .unknown, .declined, .granted] + + for (index, userConsent) in userConsents.enumerated() { + let configValues: [String: Any] = ["userConsent": userConsent] + let config = SplitClientConfigHelper.fromMap(configurationMap: configValues, impressionListener: nil) + XCTAssertEqual(expectedUserConsents[index], config.userConsent) + } + } + + func testImpressionsModeValuesAreMappedCorrectly() { + let impressionsModes = ["debug", "none", "optimized"] + let expectedImpressionsModes: [ImpressionsMode] = [.debug, .none, .optimized] + + for (index, impressionsMode) in impressionsModes.enumerated() { + let configValues: [String: Any] = ["impressionsMode": impressionsMode] + let config = SplitClientConfigHelper.fromMap(configurationMap: configValues, impressionListener: nil) + XCTAssertEqual(expectedImpressionsModes[index].rawValue, config.impressionsMode) + } } } diff --git a/splitio_ios/example/ios/SplitTests/SplitTests.swift b/splitio_ios/example/ios/SplitTests/SplitTests.swift index d94c831..7853301 100644 --- a/splitio_ios/example/ios/SplitTests/SplitTests.swift +++ b/splitio_ios/example/ios/SplitTests/SplitTests.swift @@ -235,12 +235,15 @@ class SplitFactoryStub: SplitFactory { var apiKey: String + var userConsent: UserConsent + init(apiKey: String, client: SplitClient) { self.apiKey = apiKey self.client = client self.nilBucketingKeyClient = SplitClientStub() manager = SplitManagerStub() version = "0.0.0-stub" + userConsent = .unknown } convenience init(apiKey: String) { @@ -267,6 +270,14 @@ class SplitFactoryStub: SplitFactory { func client(matchingKey: String, bucketingKey: String?) -> SplitClient { return client } + + func setUserConsent(enabled: Bool) { + if (enabled) { + self.userConsent = .granted + } else { + self.userConsent = .declined + } + } } class SplitClientStub: SplitClient { diff --git a/splitio_ios/ios/Classes/SplitClientConfigHelper.swift b/splitio_ios/ios/Classes/SplitClientConfigHelper.swift index f6aad57..6d03b98 100644 --- a/splitio_ios/ios/Classes/SplitClientConfigHelper.swift +++ b/splitio_ios/ios/Classes/SplitClientConfigHelper.swift @@ -24,6 +24,11 @@ class SplitClientConfigHelper { static private let SYNC_CONFIG = "syncConfig" static private let SYNC_CONFIG_NAMES = "syncConfigNames" static private let SYNC_CONFIG_PREFIXES = "syncConfigPrefixes" + static private let IMPRESSIONS_MODE = "impressionsMode" + static private let SYNC_ENABLED = "syncEnabled" + static private let USER_CONSENT = "userConsent" + static private let ENCRYPTION_ENABLED = "encryptionEnabled" + static private let LOG_LEVEL = "logLevel" static func fromMap(configurationMap: [String: Any?], impressionListener: SplitImpressionListener?) -> SplitClientConfig { let config = SplitClientConfig() @@ -84,7 +89,11 @@ class SplitClientConfigHelper { if configurationMap[ENABLE_DEBUG] != nil { if let enableDebug = configurationMap[ENABLE_DEBUG] as? Bool { - config.isDebugModeEnabled = enableDebug + if (enableDebug) { + config.logLevel = .debug + } else { + config.logLevel = .none + } } } @@ -150,6 +159,46 @@ class SplitClientConfigHelper { config.sync = syncConfigBuilder.build() } } + + if let impressionsMode = configurationMap[IMPRESSIONS_MODE] as? String { + config.impressionsMode = impressionsMode.uppercased() + } + + if let syncEnabled = configurationMap[SYNC_ENABLED] as? Bool { + config.syncEnabled = syncEnabled + } + + if let userConsent = configurationMap[USER_CONSENT] as? String { + switch userConsent.lowercased() { + case "unknown": + config.userConsent = .unknown + case "declined": + config.userConsent = .declined + default: + config.userConsent = .granted + } + } + + if let encryptionEnabled = configurationMap[ENCRYPTION_ENABLED] as? Bool { + config.encryptionEnabled = encryptionEnabled + } + + if let logLevel = configurationMap[LOG_LEVEL] as? String { + switch logLevel.lowercased() { + case "verbose": + config.logLevel = .verbose + case "debug": + config.logLevel = .debug + case "info": + config.logLevel = .info + case "warning": + config.logLevel = .warning + case "error": + config.logLevel = .error + default: + config.logLevel = .none + } + } config.serviceEndpoints = serviceEndpointsBuilder.build() diff --git a/splitio_ios/ios/splitio_ios.podspec b/splitio_ios/ios/splitio_ios.podspec index 6999409..8cb33f7 100644 --- a/splitio_ios/ios/splitio_ios.podspec +++ b/splitio_ios/ios/splitio_ios.podspec @@ -4,7 +4,7 @@ # Pod::Spec.new do |s| s.name = 'splitio_ios' - s.version = '0.1.0' + s.version = '0.2.0' s.summary = 'split.io official Flutter plugin.' s.description = <<-DESC split.io official Flutter plugin. @@ -15,7 +15,7 @@ split.io official Flutter plugin. s.source = { :path => '.' } s.source_files = 'Classes/**/*' s.dependency 'Flutter' - s.dependency 'Split', '~> 2.15.0' + s.dependency 'Split', '~> 2.20.1' s.platform = :ios, '9.0' # Flutter.framework does not contain a i386 slice. diff --git a/splitio_platform_interface/lib/split_configuration.dart b/splitio_platform_interface/lib/split_configuration.dart index 8c19f9b..9adb7d6 100644 --- a/splitio_platform_interface/lib/split_configuration.dart +++ b/splitio_platform_interface/lib/split_configuration.dart @@ -23,7 +23,7 @@ class SplitConfiguration { /// /// [trafficType] The default traffic type for events tracked using the track method. If not specified, every track call should specify a traffic type. /// - /// [enableDebug] If true, the SDK will log debug messages to the console. + /// [enableDebug] (Deprecated; use logLevel instead) If true, the SDK will log debug messages to the console. /// /// [streamingEnabled] Boolean flag to enable the streaming service as default synchronization mechanism when in foreground. In the event of an issue with streaming, the SDK will fallback to the polling mechanism. If false, the SDK will poll for changes as usual without attempting to use streaming. /// @@ -32,6 +32,16 @@ class SplitConfiguration { /// [impressionListener] Enables impression listener. If true, generated impressions will be streamed in the impressionsStream() method of Splitio. /// /// [syncConfig] Use it to filter specific feature flags to be synced and evaluated by the SDK. If not set, all feature flags will be downloaded. + /// + /// [impressionsMode] This configuration defines how impressions (decisioning events) are queued. Supported modes are [ImpressionsMode.optimized], [ImpressionsMode.none], and [ImpressionsMode.debug]. In [ImpressionsMode.optimized] mode, only unique impressions are queued and posted to Split; this is the recommended mode for experimentation use cases. In [ImpressionsMode.none] mode, no impression is tracked in Split and only minimum viable data to support usage stats is, so never use this mode if you are experimenting with that instance impressions. Use [ImpressionsMode.none] when you want to optimize for feature flagging only use cases and reduce impressions network and storage load. In [ImpressionsMode.debug] mode, ALL impressions are queued and sent to Split; this is useful for validations. This mode doesn't impact the impression listener which receives all generated impressions locally. + /// + /// [syncEnabled] Controls the SDK continuous synchronization flags. When true, a running SDK processes rollout plan updates performed in the Split user interface (default). When false, it fetches all data upon init, which ensures a consistent experience during a user session and optimizes resources when these updates are not consumed by the app. + /// + /// [UserConsent] User consent status used to control the tracking of events and impressions. Possible values are [UserConsent.granted], [UserConsent.declined], and [UserConsent.unknown]. + /// + /// [encryptionEnabled] If set to true, the local database contents is encrypted. Defaults to false. + /// + /// [logLevel] Enables logging according to the level specified. Options are [SplitLogLevel.verbose], [SplitLogLevel.none], [SplitLogLevel.debug], [SplitLogLevel.info], [SplitLogLevel.warning], and [SplitLogLevel.error]. SplitConfiguration({ int? featuresRefreshRate, int? segmentsRefreshRate, @@ -42,7 +52,7 @@ class SplitConfiguration { int? eventFlushInterval, int? eventsPerPush, String? trafficType, - bool? enableDebug, + @Deprecated('Use logLevel instead') bool? enableDebug, bool? streamingEnabled, bool? persistentAttributesEnabled, bool? impressionListener, @@ -52,6 +62,11 @@ class SplitConfiguration { String? streamingServiceEndpoint, String? telemetryServiceEndpoint, SyncConfig? syncConfig, + ImpressionsMode? impressionsMode, + bool? syncEnabled, + UserConsent? userConsent, + bool? encryptionEnabled, + SplitLogLevel? logLevel, }) { if (featuresRefreshRate != null) { configurationMap['featuresRefreshRate'] = featuresRefreshRate; @@ -132,5 +147,39 @@ class SplitConfiguration { 'syncConfigPrefixes': syncConfig.prefixes.toList(growable: false) }; } + + if (impressionsMode != null) { + configurationMap['impressionsMode'] = impressionsMode.name; + } + + if (syncEnabled != null) { + configurationMap['syncEnabled'] = syncEnabled; + } + + if (userConsent != null) { + configurationMap['userConsent'] = userConsent.name; + } + + if (encryptionEnabled != null) { + configurationMap['encryptionEnabled'] = encryptionEnabled; + } + + if (logLevel != null) { + configurationMap['logLevel'] = logLevel.name; + } } } + +enum ImpressionsMode { + debug, + optimized, + none, +} + +enum UserConsent { + granted, + declined, + unknown, +} + +enum SplitLogLevel { verbose, debug, info, warning, error, none } diff --git a/splitio_platform_interface/test/splitio_configuration_test.dart b/splitio_platform_interface/test/splitio_configuration_test.dart index d1c44f5..72c563f 100644 --- a/splitio_platform_interface/test/splitio_configuration_test.dart +++ b/splitio_platform_interface/test/splitio_configuration_test.dart @@ -24,7 +24,13 @@ void main() { streamingServiceEndpoint: 'streamingServiceEndpoint.split.io', telemetryServiceEndpoint: 'telemetryServiceEndpoint.split.io', syncConfig: - SyncConfig(names: ['one', 'two', 'three'], prefixes: ['pre1'])); + SyncConfig(names: ['one', 'two', 'three'], prefixes: ['pre1']), + impressionsMode: ImpressionsMode.none, + syncEnabled: false, + userConsent: UserConsent.declined, + encryptionEnabled: true, + logLevel: SplitLogLevel.debug, + ); expect(config.configurationMap['eventFlushInterval'], 2000); expect(config.configurationMap['eventsPerPush'], 300); @@ -51,6 +57,11 @@ void main() { ['one', 'two', 'three']); expect( config.configurationMap['syncConfig']['syncConfigPrefixes'], ['pre1']); + expect(config.configurationMap['impressionsMode'], 'none'); + expect(config.configurationMap['syncEnabled'], false); + expect(config.configurationMap['userConsent'], 'declined'); + expect(config.configurationMap['encryptionEnabled'], true); + expect(config.configurationMap['logLevel'], 'debug'); }); test('noSpecialValuesLeavesMapEmpty', () async {