prepare 4.2.0 release

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to the LaunchDarkly Android SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [3.6.0] - 2023-01-11
+### Added:
+- `LDConfig.Builder.applicationInfo()`, for configuration of application metadata that may be used in LaunchDarkly analytics or other product features. This does not affect feature flag evaluations.
+
 ## [4.1.1] - 2023-01-06
 ### Fixed:
 - The fix for unnecessarily long-lived polling connections in the [3.2.2](https://github.com/launchdarkly/android-client-sdk/releases/tag/3.2.2) release was incomplete: rather than turning off the keep-alive behavior, it only reduced it from 10 minutes to 5 minutes. It should now close the connection immediately after each request as intended.

contract-tests/src/main/java/com/launchdarkly/sdktest/SdkClientEntity.java

@@ -12,6 +12,8 @@
 import com.launchdarkly.sdk.android.LaunchDarklyException;
 import com.launchdarkly.sdk.android.LDClient;
 import com.launchdarkly.sdk.android.LDConfig;
+
+import com.launchdarkly.sdk.android.integrations.ApplicationInfoBuilder;
 import com.launchdarkly.sdk.android.integrations.EventProcessorBuilder;
 import com.launchdarkly.sdk.android.integrations.PollingDataSourceBuilder;
 import com.launchdarkly.sdk.android.integrations.StreamingDataSourceBuilder;
@@ -310,6 +312,17 @@ private LDConfig buildSdkConfig(SdkConfigParams params, LDLogAdapter logAdapter,
             Components.httpConfiguration().useReport(params.clientSide.useReport)
     );
 
+    if (params.tags != null) {
+      ApplicationInfoBuilder ab = Components.applicationInfo();
+      if (params.tags.applicationId != null) {
+        ab.applicationId(params.tags.applicationId);
+      }
+      if (params.tags.applicationVersion != null) {
+        ab.applicationVersion(params.tags.applicationVersion);
+      }
+      builder.applicationInfo(ab);
+    }
+
     if (params.serviceEndpoints != null) {
       if (params.serviceEndpoints.streaming != null) {
         endpoints.streaming(params.serviceEndpoints.streaming);

contract-tests/src/main/java/com/launchdarkly/sdktest/TestService.java

@@ -32,6 +32,7 @@ public class TestService extends NanoHTTPD {
             "service-endpoints",
             "singleton",
             "strongly-typed",
+            "tags"
     };
     private static final String MIME_JSON = "application/json";
     static final Gson gson = new GsonBuilder()

launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/ClientContextImpl.java

@@ -2,7 +2,6 @@
 
 import com.launchdarkly.logging.LDLogger;
 import com.launchdarkly.sdk.LDContext;
-import com.launchdarkly.sdk.android.interfaces.ServiceEndpoints;
 import com.launchdarkly.sdk.android.subsystems.ClientContext;
 import com.launchdarkly.sdk.android.subsystems.HttpConfiguration;
 import com.launchdarkly.sdk.android.subsystems.DataSourceUpdateSink;
@@ -58,12 +57,13 @@ static ClientContextImpl fromConfig(
             TaskExecutor taskExecutor
     ) {
         boolean initiallyInBackground = platformState != null && !platformState.isForeground();
-        ClientContext minimalContext = new ClientContext(mobileKey, logger, config,
+        ClientContext minimalContext = new ClientContext(mobileKey, config.applicationInfo, logger, config,
                 null, environmentName, config.isEvaluationReasons(), initialContext, null,
                 initiallyInBackground, null, config.serviceEndpoints, config.isOffline());
         HttpConfiguration httpConfig = config.http.build(minimalContext);
         ClientContext baseClientContext = new ClientContext(
                 mobileKey,
+                config.applicationInfo,
                 logger,
                 config,
                 null,
@@ -101,6 +101,7 @@ public static ClientContextImpl forDataSource(
         return new ClientContextImpl(
                 new ClientContext(
                         baseClientContext.getMobileKey(),
+                        baseClientContext.getApplicationInfo(),
                         baseClientContext.getBaseLogger(),
                         baseClientContext.getConfig(),
                         dataSourceUpdateSink,

launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/Components.java

@@ -1,5 +1,6 @@
 package com.launchdarkly.sdk.android;
 
+import com.launchdarkly.sdk.android.integrations.ApplicationInfoBuilder;
 import com.launchdarkly.sdk.android.integrations.EventProcessorBuilder;
 import com.launchdarkly.sdk.android.integrations.HttpConfigurationBuilder;
 import com.launchdarkly.sdk.android.integrations.PollingDataSourceBuilder;
@@ -25,6 +26,29 @@
 public abstract class Components {
     private Components() {}
 
+    /**
+     * Returns a configuration builder for the SDK's application metadata.
+     * <p>
+     * Passing this to {@link LDConfig.Builder#applicationInfo(com.launchdarkly.sdk.android.integrations.ApplicationInfoBuilder)},
+     * after setting any desired properties on the builder, applies this configuration to the SDK.
+     * <pre><code>
+     *     LDConfig config = new LDConfig.Builder()
+     *         .applicationInfo(
+     *             Components.applicationInfo()
+     *                 .applicationId("authentication-service")
+     *                 .applicationVersion("1.0.0")
+     *         )
+     *         .build();
+     * </code></pre>
+     *
+     * @return a builder object
+     * @see LDConfig.Builder#applicationInfo(com.launchdarkly.sdk.android.integrations.ApplicationInfoBuilder)
+     * @since 4.1.0
+     */
+    public static ApplicationInfoBuilder applicationInfo() {
+        return new ApplicationInfoBuilder();
+    }
+
     /**
      * Returns a configuration builder for the SDK's networking configuration.
      * <p>

launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/ComponentsImpl.java

@@ -211,6 +211,13 @@ public HttpConfiguration build(ClientContext clientContext) {
             Map<String, String> headers = new HashMap<>();
             headers.put("Authorization", LDUtil.AUTH_SCHEME + clientContext.getMobileKey());
             headers.put("User-Agent", LDUtil.USER_AGENT_HEADER_VALUE);
+            if (clientContext.getApplicationInfo() != null) {
+                String tagHeader = LDUtil.applicationTagHeader(clientContext.getApplicationInfo(),
+                        clientContext.getBaseLogger());
+                if (!tagHeader.isEmpty()) {
+                    headers.put("X-LaunchDarkly-Tags", tagHeader);
+                }
+            }
             if (wrapperName != null) {
                 String wrapperId = wrapperVersion == null ? wrapperName : (wrapperName + "/" + wrapperVersion);
                 headers.put("X-LaunchDarkly-Wrapper", wrapperId);

launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/LDConfig.java

@@ -6,8 +6,10 @@
 import com.launchdarkly.sdk.ContextKind;
 import com.launchdarkly.sdk.LDContext;
 import com.launchdarkly.sdk.LDUser;
+import com.launchdarkly.sdk.android.integrations.ApplicationInfoBuilder;
 import com.launchdarkly.sdk.android.integrations.ServiceEndpointsBuilder;
 import com.launchdarkly.sdk.android.interfaces.ServiceEndpoints;
+import com.launchdarkly.sdk.android.subsystems.ApplicationInfo;
 import com.launchdarkly.sdk.android.subsystems.ComponentConfigurer;
 import com.launchdarkly.sdk.android.subsystems.DataSource;
 import com.launchdarkly.sdk.android.subsystems.EventProcessor;
@@ -55,6 +57,7 @@ public class LDConfig {
 
     final ServiceEndpoints serviceEndpoints;
 
+    final ApplicationInfo applicationInfo;
     final ComponentConfigurer<DataSource> dataSource;
     final ComponentConfigurer<EventProcessor> events;
     final ComponentConfigurer<HttpConfiguration> http;
@@ -71,6 +74,7 @@ public class LDConfig {
 
     LDConfig(Map<String, String> mobileKeys,
              ServiceEndpoints serviceEndpoints,
+             ApplicationInfo applicationInfo,
              ComponentConfigurer<DataSource> dataSource,
              ComponentConfigurer<EventProcessor> events,
              ComponentConfigurer<HttpConfiguration> http,
@@ -85,6 +89,7 @@ public class LDConfig {
              String loggerName) {
         this.mobileKeys = mobileKeys;
         this.serviceEndpoints = serviceEndpoints;
+        this.applicationInfo = applicationInfo;
         this.dataSource = dataSource;
         this.events = events;
         this.http = http;
@@ -151,6 +156,7 @@ public static class Builder {
 
         private ServiceEndpointsBuilder serviceEndpointsBuilder;
 
+        private ApplicationInfoBuilder applicationInfoBuilder = null;
         private ComponentConfigurer<DataSource> dataSource = null;
         private ComponentConfigurer<EventProcessor> events = null;
         private ComponentConfigurer<HttpConfiguration> http = null;
@@ -235,6 +241,22 @@ public Builder serviceEndpoints(ServiceEndpointsBuilder serviceEndpointsBuilder)
             return this;
         }
 
+        /**
+         * Sets the SDK's application metadata, which may be used in LaunchDarkly analytics or other product features,
+         * but does not affect feature flag evaluations.
+         * <p>
+         * This object is normally a configuration builder obtained from {@link Components#applicationInfo()},
+         * which has methods for setting individual metadata properties.
+         *
+         * @param applicationInfoBuilder a configuration builder object returned by {@link Components#applicationInfo()}
+         * @return the builder
+         * @since 4.1.0
+         */
+        public Builder applicationInfo(ApplicationInfoBuilder applicationInfoBuilder) {
+            this.applicationInfoBuilder = applicationInfoBuilder;
+            return this;
+        }
+
         /**
          * Sets the configuration of the component that receives feature flag data from LaunchDarkly.
          * <p>
@@ -574,9 +596,14 @@ public LDConfig build() {
                             serviceEndpointsBuilder)
                             .createServiceEndpoints();
 
+            ApplicationInfo applicationInfo = this.applicationInfoBuilder == null ?
+                    Components.applicationInfo().createApplicationInfo() :
+                    applicationInfoBuilder.createApplicationInfo();
+
             return new LDConfig(
                     mobileKeys,
                     serviceEndpoints,
+                    applicationInfo,
                     this.dataSource == null ? Components.streamingDataSource() : this.dataSource,
                     this.events == null ? Components.sendEvents() : this.events,
                     this.http == null ? Components.httpConfiguration() : this.http,

launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/LDUtil.java

@@ -7,6 +7,7 @@
 import com.launchdarkly.logging.LDLogger;
 import com.launchdarkly.logging.LogValues;
 import com.launchdarkly.sdk.LDContext;
+import com.launchdarkly.sdk.android.subsystems.ApplicationInfo;
 import com.launchdarkly.sdk.android.subsystems.Callback;
 import com.launchdarkly.sdk.android.subsystems.ClientContext;
 import com.launchdarkly.sdk.android.subsystems.HttpConfiguration;
@@ -18,9 +19,12 @@
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
 
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
+import java.util.regex.Pattern;
 
 import okhttp3.Headers;
 
@@ -31,11 +35,48 @@ class LDUtil {
     static <T> Callback<T> noOpCallback() {
         return new Callback<T>() {
             @Override
-            public void onSuccess(T result) {}
+            public void onSuccess(T result) {
+            }
 
             @Override
-            public void onError(Throwable error) {}
+            public void onError(Throwable error) {
+            }
+        };
+    }
+
+    // Tag values must not be empty, and only contain letters, numbers, `.`, `_`, or `-`.
+    private static Pattern TAG_VALUE_REGEX = Pattern.compile("^[-a-zA-Z0-9._]+$");
+
+    /**
+     * Builds the "X-LaunchDarkly-Tags" HTTP header out of the configured application info.
+     *
+     * @param applicationInfo the application metadata
+     * @return a space-separated string of tags, e.g. "application-id/authentication-service application-version/1.0.0"
+     */
+    static String applicationTagHeader(ApplicationInfo applicationInfo, LDLogger logger) {
+        String[][] tags = {
+                {"applicationId", "application-id", applicationInfo.getApplicationId()},
+                {"applicationVersion", "application-version", applicationInfo.getApplicationVersion()},
         };
+        List<String> parts = new ArrayList<>();
+        for (String[] row : tags) {
+            String javaKey = row[0];
+            String tagKey = row[1];
+            String tagVal = row[2];
+            if (tagVal == null) {
+                continue;
+            }
+            if (!TAG_VALUE_REGEX.matcher(tagVal).matches()) {
+                logger.warn("Value of ApplicationInfo.{} contained invalid characters and was discarded", javaKey);
+                continue;
+            }
+            if (tagVal.length() > 64) {
+                logger.warn("Value of ApplicationInfo.{} was longer than 64 characters and was discarded", javaKey);
+                continue;
+            }
+            parts.add(tagKey + "/" + tagVal);
+        }
+        return String.join(" ", parts);
     }
 
     static Headers makeRequestHeaders(

launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/integrations/ApplicationInfoBuilder.java

@@ -0,0 +1,77 @@
+package com.launchdarkly.sdk.android.integrations;
+
+import com.launchdarkly.sdk.android.Components;
+import com.launchdarkly.sdk.android.subsystems.ApplicationInfo;
+
+/**
+ * Contains methods for configuring the SDK's application metadata.
+ * <p>
+ * Application metadata may be used in LaunchDarkly analytics or other product features, but does not affect feature flag evaluations.
+ * <p>
+ * If you want to set non-default values for any of these fields, create a builder with
+ * {@link Components#applicationInfo()}, change its properties with the methods of this class,
+ * and pass it to {@link com.launchdarkly.sdk.android.LDConfig.Builder#applicationInfo(ApplicationInfoBuilder)}:
+ * <pre><code>
+ *     LDConfig config = new LDConfig.Builder()
+ *         .applicationInfo(
+ *             Components.applicationInfo()
+ *                 .applicationId("authentication-service")
+ *                 .applicationVersion("1.0.0")
+ *         )
+ *         .build();
+ * </code></pre>
+ * <p>
+ *
+ * @since 4.1.0
+ */
+public final class ApplicationInfoBuilder {
+    private String applicationId;
+    private String applicationVersion;
+
+    /**
+     * Create an empty ApplicationInfoBuilder.
+     *
+     * @see Components#applicationInfo()
+     */
+    public ApplicationInfoBuilder() {}
+
+    /**
+     * Sets a unique identifier representing the application where the LaunchDarkly SDK is running.
+     * <p>
+     * This can be specified as any string value as long as it only uses the following characters: ASCII
+     * letters, ASCII digits, period, hyphen, underscore. A string containing any other characters will be
+     * ignored.
+     *
+     * @param applicationId the application identifier
+     * @return the builder
+     */
+    public ApplicationInfoBuilder applicationId(String applicationId) {
+        this.applicationId = applicationId;
+        return this;
+    }
+
+    /**
+     * Sets a unique identifier representing the version of the application where the LaunchDarkly SDK
+     * is running.
+     * <p>
+     * This can be specified as any string value as long as it only uses the following characters: ASCII
+     * letters, ASCII digits, period, hyphen, underscore. A string containing any other characters will be
+     * ignored.
+     *
+     * @param applicationVersion the application version
+     * @return the builder
+     */
+    public ApplicationInfoBuilder applicationVersion(String applicationVersion) {
+        this.applicationVersion = applicationVersion;
+        return this;
+    }
+
+    /**
+     * Called internally by the SDK to create the configuration object.
+     *
+     * @return the configuration object
+     */
+    public ApplicationInfo createApplicationInfo() {
+        return new ApplicationInfo(applicationId, applicationVersion);
+    }
+}