prepare 7.1.0 release (#318)

## [7.1.0] - 2023-11-02
### Added:
- Added an improved way of setting wrapper information for wrapper SDKs.
This functionality is primarily intended for use by LaunchDarkly while
developing wrapper SDKs.

---------

Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Alex Engelberg <aengelberg@launchdarkly.com>
Co-authored-by: Anton Mostovoy <anton@mostovoy.net>
Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com>
Co-authored-by: LaunchDarklyCI <LaunchDarklyCI@users.noreply.github.com>
Co-authored-by: Gavin Whelan <gwhelan@launchdarkly.com>
Co-authored-by: ssrm <ssrm@users.noreply.github.com>
Co-authored-by: Harpo Roeder <hroeder@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: Elliot <35050275+Apache-HB@users.noreply.github.com>
Co-authored-by: Robert J. Neal <rneal@launchdarkly.com>
Co-authored-by: Robert J. Neal <robertjneal@users.noreply.github.com>
Co-authored-by: Sam Stokes <sstokes@launchdarkly.com>
Co-authored-by: Ember Stevens <ember.stevens@launchdarkly.com>
Co-authored-by: ember-stevens <79482775+ember-stevens@users.noreply.github.com>
Co-authored-by: Alex Engelberg <alex.benjamin.engelberg@gmail.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>
Co-authored-by: Todd Anderson <tanderson@launchdarkly.com>
Co-authored-by: tanderson-ld <127344469+tanderson-ld@users.noreply.github.com>
Co-authored-by: Matthew M. Keeler <mkeeler@launchdarkly.com>
Co-authored-by: ld-repository-standards[bot] <113625520+ld-repository-standards[bot]@users.noreply.github.com>
Co-authored-by: Kane Parkinson <93555788+kparkinson-ld@users.noreply.github.com>
Co-authored-by: Ryan Lamb <4955475+kinyoklion@users.noreply.github.com>

Author: 20 people

src/main/java/com/launchdarkly/sdk/server/ClientContextImpl.java

@@ -37,7 +37,7 @@ private ClientContextImpl(
   ) {
     super(baseContext.getSdkKey(), baseContext.getApplicationInfo(), baseContext.getHttp(),
         baseContext.getLogging(), baseContext.isOffline(), baseContext.getServiceEndpoints(),
-        baseContext.getThreadPriority());
+        baseContext.getThreadPriority(), baseContext.getWrapperInfo());
     this.sharedExecutor = sharedExecutor;
     this.diagnosticStore = diagnosticStore;
     this.dataSourceUpdateSink = null;
@@ -80,11 +80,11 @@ static ClientContextImpl fromConfig(
       ScheduledExecutorService sharedExecutor
       ) {
     ClientContext minimalContext = new ClientContext(sdkKey, config.applicationInfo, null,
-        null, config.offline, config.serviceEndpoints, config.threadPriority);
+        null, config.offline, config.serviceEndpoints, config.threadPriority, config.wrapperInfo);
     LoggingConfiguration loggingConfig = config.logging.build(minimalContext);
 
     ClientContext contextWithLogging = new ClientContext(sdkKey, config.applicationInfo, null,
-        loggingConfig, config.offline, config.serviceEndpoints, config.threadPriority);
+        loggingConfig, config.offline, config.serviceEndpoints, config.threadPriority, config.wrapperInfo);
     HttpConfiguration httpConfig = config.http.build(contextWithLogging);
 
     if (httpConfig.getProxy() != null) {
@@ -94,7 +94,7 @@ static ClientContextImpl fromConfig(
     }
 
     ClientContext contextWithHttpAndLogging = new ClientContext(sdkKey, config.applicationInfo, httpConfig,
-        loggingConfig, config.offline, config.serviceEndpoints, config.threadPriority);
+        loggingConfig, config.offline, config.serviceEndpoints, config.threadPriority, config.wrapperInfo);
 
     // Create a diagnostic store only if diagnostics are enabled. Diagnostics are enabled as long as 1. the
     // opt-out property was not set in the config, and 2. we are using the standard event processor.

src/main/java/com/launchdarkly/sdk/server/Components.java

@@ -12,6 +12,7 @@
 import com.launchdarkly.sdk.server.ComponentsImpl.PollingDataSourceBuilderImpl;
 import com.launchdarkly.sdk.server.ComponentsImpl.ServiceEndpointsBuilderImpl;
 import com.launchdarkly.sdk.server.ComponentsImpl.StreamingDataSourceBuilderImpl;
+import com.launchdarkly.sdk.server.ComponentsImpl.WrapperInfoBuilderImpl;
 import com.launchdarkly.sdk.server.integrations.ApplicationInfoBuilder;
 import com.launchdarkly.sdk.server.integrations.BigSegmentsConfigurationBuilder;
 import com.launchdarkly.sdk.server.integrations.EventProcessorBuilder;
@@ -21,6 +22,7 @@
 import com.launchdarkly.sdk.server.integrations.PollingDataSourceBuilder;
 import com.launchdarkly.sdk.server.integrations.ServiceEndpointsBuilder;
 import com.launchdarkly.sdk.server.integrations.StreamingDataSourceBuilder;
+import com.launchdarkly.sdk.server.integrations.WrapperInfoBuilder;
 import com.launchdarkly.sdk.server.interfaces.HttpAuthentication;
 import com.launchdarkly.sdk.server.subsystems.BigSegmentStore;
 import com.launchdarkly.sdk.server.subsystems.ComponentConfigurer;
@@ -420,4 +422,14 @@ public static ApplicationInfoBuilder applicationInfo() {
   public static ServiceEndpointsBuilder serviceEndpoints() {
     return new ServiceEndpointsBuilderImpl();
   }
+
+  /**
+   * Returns a wrapper information builder.
+   * <p>
+   * This is intended for use by LaunchDarkly in the development of wrapper SDKs.
+   *
+   * @return a builder object
+   * @since 7.1.0
+   */
+  public static WrapperInfoBuilder wrapperInfo() { return new WrapperInfoBuilderImpl(); }
 }

src/main/java/com/launchdarkly/sdk/server/ComponentsImpl.java

@@ -21,9 +21,11 @@
 import com.launchdarkly.sdk.server.integrations.PollingDataSourceBuilder;
 import com.launchdarkly.sdk.server.integrations.ServiceEndpointsBuilder;
 import com.launchdarkly.sdk.server.integrations.StreamingDataSourceBuilder;
+import com.launchdarkly.sdk.server.integrations.WrapperInfoBuilder;
 import com.launchdarkly.sdk.server.interfaces.DataSourceStatusProvider;
 import com.launchdarkly.sdk.server.interfaces.HttpAuthentication;
 import com.launchdarkly.sdk.server.interfaces.ServiceEndpoints;
+import com.launchdarkly.sdk.server.interfaces.WrapperInfo;
 import com.launchdarkly.sdk.server.subsystems.ClientContext;
 import com.launchdarkly.sdk.server.subsystems.ComponentConfigurer;
 import com.launchdarkly.sdk.server.subsystems.DataSource;
@@ -342,8 +344,24 @@ public HttpConfiguration build(ClientContext clientContext) {
           headers.put("X-LaunchDarkly-Tags", tagHeader);
         }
       }
-      if (wrapperName != null) {
-        String wrapperId = wrapperVersion == null ? wrapperName : (wrapperName + "/" + wrapperVersion);
+
+      String wrapperNameToUse = null;
+      String wrapperVersionToUse = null;
+
+      WrapperInfo wrapperInfo = clientContext.getWrapperInfo();
+      // If information from wrapperInfo is available, then it overwrites that from the http properties
+      // builder.
+      if(wrapperInfo != null) {
+        wrapperNameToUse = wrapperInfo.getWrapperName();
+        wrapperVersionToUse = wrapperInfo.getWrapperVersion();
+      }
+      else if (wrapperName != null) {
+        wrapperNameToUse = wrapperName;
+        wrapperVersionToUse = wrapperVersion;
+      }
+
+      if(wrapperNameToUse != null) {
+        String wrapperId = wrapperVersionToUse == null ? wrapperNameToUse : (wrapperNameToUse + "/" + wrapperVersionToUse);
         headers.put("X-LaunchDarkly-Wrapper", wrapperId);
       }
 
@@ -447,6 +465,14 @@ public ServiceEndpoints createServiceEndpoints() {
       }
       return new ServiceEndpoints(streamingBaseUri, pollingBaseUri, eventsBaseUri);
     }
+
+    public static ServiceEndpointsBuilderImpl fromServiceEndpoints(ServiceEndpoints endpoints) {
+      ServiceEndpointsBuilderImpl newBuilder = new ServiceEndpointsBuilderImpl();
+      newBuilder.eventsBaseUri = endpoints.getEventsBaseUri();
+      newBuilder.pollingBaseUri = endpoints.getPollingBaseUri();
+      newBuilder.streamingBaseUri = endpoints.getStreamingBaseUri();
+      return newBuilder;
+    }
   }
 
   static HttpProperties toHttpProperties(HttpConfiguration httpConfig) {
@@ -465,4 +491,22 @@ static HttpProperties toHttpProperties(HttpConfiguration httpConfig) {
         httpConfig.getSslSocketFactory(),
         httpConfig.getTrustManager());
   }
+
+  static final class WrapperInfoBuilderImpl extends WrapperInfoBuilder {
+    public WrapperInfoBuilderImpl() {
+      this(null, null);
+    }
+    public WrapperInfoBuilderImpl(String wrapperName, String wrapperVersion) {
+      this.wrapperName = wrapperName;
+      this.wrapperVersion = wrapperVersion;
+    }
+
+    public WrapperInfo build() {
+      return new WrapperInfo(wrapperName, wrapperVersion);
+    }
+
+    public static WrapperInfoBuilderImpl fromInfo(WrapperInfo info) {
+      return new WrapperInfoBuilderImpl(info.getWrapperName(), info.getWrapperVersion());
+    }
+  }
 }

src/main/java/com/launchdarkly/sdk/server/LDConfig.java

@@ -4,9 +4,11 @@
 import com.launchdarkly.sdk.EvaluationReason.BigSegmentsStatus;
 import com.launchdarkly.sdk.server.integrations.ApplicationInfoBuilder;
 import com.launchdarkly.sdk.server.integrations.ServiceEndpointsBuilder;
+import com.launchdarkly.sdk.server.integrations.WrapperInfoBuilder;
 import com.launchdarkly.sdk.server.interfaces.ApplicationInfo;
 import com.launchdarkly.sdk.server.interfaces.BigSegmentsConfiguration;
 import com.launchdarkly.sdk.server.interfaces.ServiceEndpoints;
+import com.launchdarkly.sdk.server.interfaces.WrapperInfo;
 import com.launchdarkly.sdk.server.subsystems.ComponentConfigurer;
 import com.launchdarkly.sdk.server.subsystems.DataSource;
 import com.launchdarkly.sdk.server.subsystems.DataStore;
@@ -24,7 +26,7 @@ public final class LDConfig {
    * The default value for {@link Builder#startWait(Duration)}: 5 seconds.
    */
   public static final Duration DEFAULT_START_WAIT = Duration.ofSeconds(5);
-  
+
   protected static final LDConfig DEFAULT = new Builder().build();
 
   final ApplicationInfo applicationInfo;
@@ -39,6 +41,7 @@ public final class LDConfig {
   final boolean offline;
   final Duration startWait;
   final int threadPriority;
+  final WrapperInfo wrapperInfo;
 
   protected LDConfig(Builder builder) {
     if (builder.offline) {
@@ -62,8 +65,9 @@ protected LDConfig(Builder builder) {
       .createServiceEndpoints();
     this.startWait = builder.startWait;
     this.threadPriority = builder.threadPriority;
+    this.wrapperInfo = builder.wrapperBuilder != null ? builder.wrapperBuilder.build() : null;
   }
-  
+
   /**
    * A <a href="http://en.wikipedia.org/wiki/Builder_pattern">builder</a> that helps construct
    * {@link com.launchdarkly.sdk.server.LDConfig} objects. Builder calls can be chained, enabling the
@@ -88,13 +92,35 @@ public static class Builder {
     private boolean offline = false;
     private Duration startWait = DEFAULT_START_WAIT;
     private int threadPriority = Thread.MIN_PRIORITY;
+    private WrapperInfoBuilder wrapperBuilder = null;
 
     /**
      * Creates a builder with all configuration parameters set to the default
      */
     public Builder() {
     }
 
+    public static Builder fromConfig(LDConfig config) {
+      Builder newBuilder = new Builder();
+      newBuilder.applicationInfoBuilder = ApplicationInfoBuilder.fromApplicationInfo(config.applicationInfo);
+      newBuilder.bigSegments = config.bigSegments;
+      newBuilder.dataSource = config.dataSource;
+      newBuilder.dataStore = config.dataStore;
+      newBuilder.diagnosticOptOut = config.diagnosticOptOut;
+      newBuilder.events = config.events;
+      newBuilder.http = config.http;
+      newBuilder.logging = config.logging;
+
+      newBuilder.serviceEndpointsBuilder = ComponentsImpl.ServiceEndpointsBuilderImpl
+        .fromServiceEndpoints(config.serviceEndpoints);
+      newBuilder.offline = config.offline;
+      newBuilder.startWait = config.startWait;
+      newBuilder.threadPriority = config.threadPriority;
+      newBuilder.wrapperBuilder = config.wrapperInfo != null ?
+        ComponentsImpl.WrapperInfoBuilderImpl.fromInfo(config.wrapperInfo) : null;
+      return newBuilder;
+    }
+
     /**
      * Sets the SDK's application metadata, which may be used in LaunchDarkly analytics or other product features,
      * but does not affect feature flag evaluations.
@@ -144,7 +170,7 @@ public Builder bigSegments(ComponentConfigurer<BigSegmentsConfiguration> bigSegm
       this.bigSegments = bigSegmentsConfigurer;
       return this;
     }
-    
+
     /**
      * Sets the implementation of the component that receives feature flag data from LaunchDarkly,
      * using a factory object. Depending on the implementation, the factory may be a builder that
@@ -154,7 +180,7 @@ public Builder bigSegments(ComponentConfigurer<BigSegmentsConfiguration> bigSegm
      * {@link Components#pollingDataSource()}, or a test fixture such as
      * {@link com.launchdarkly.sdk.server.integrations.FileData#dataSource()}. See those methods
      * for details on how to configure them.
-     * 
+     *
      * @param dataSourceConfigurer the data source configuration builder
      * @return the main configuration builder
      * @since 4.12.0
@@ -169,7 +195,7 @@ public Builder dataSource(ComponentConfigurer<DataSource> dataSourceConfigurer)
      * related data received from LaunchDarkly, using a factory object. The default is
      * {@link Components#inMemoryDataStore()}; for database integrations, use
      * {@link Components#persistentDataStore(ComponentConfigurer)}.
-     * 
+     *
      * @param dataStoreConfigurer the data store configuration builder
      * @return the main configuration builder
      * @since 4.12.0
@@ -206,7 +232,7 @@ public Builder diagnosticOptOut(boolean diagnosticOptOut) {
      * {@link Components#sendEvents()} and then set custom options for event processing; or, disable
      * events with {@link Components#noEvents()}; or, choose to use a custom implementation (for
      * instance, a test fixture).
-     * 
+     *
      * @param eventsConfigurer the events configuration builder
      * @return the main configuration builder
      * @since 4.12.0
@@ -222,7 +248,7 @@ public Builder events(ComponentConfigurer<EventProcessor> eventsConfigurer) {
      * Sets the SDK's networking configuration, using a configuration builder. This builder is
      * obtained from {@link Components#httpConfiguration()}, and has methods for setting individual
      * HTTP-related properties.
-     * 
+     *
      * @param httpConfigurer the HTTP configuration builder
      * @return the main configuration builder
      * @since 4.13.0
@@ -237,7 +263,7 @@ public Builder http(ComponentConfigurer<HttpConfiguration> httpConfigurer) {
      * Sets the SDK's logging configuration, using a factory object. This object is normally a
      * configuration builder obtained from {@link Components#logging()}, which has methods
      * for setting individual logging-related properties.
-     * 
+     *
      * @param loggingConfigurer the logging configuration builder
      * @return the main configuration builder
      * @since 5.0.0
@@ -258,7 +284,7 @@ public Builder logging(ComponentConfigurer<LoggingConfiguration> loggingConfigur
      * This is equivalent to calling {@code dataSource(Components.externalUpdatesOnly())} and
      * {@code events(Components.noEvents())}. It overrides any other values you may have set for
      * {@link #dataSource(ComponentConfigurer)} or {@link #events(ComponentConfigurer)}.
-     * 
+     *
      * @param offline when set to true no calls to LaunchDarkly will be made
      * @return the builder
      */
@@ -267,7 +293,7 @@ public Builder offline(boolean offline) {
       return this;
     }
 
-    /** 
+    /**
      * Sets the base service URIs used by SDK components.
      * <p>
      * This object is normally a configuration builder obtained from {@link Components#serviceEndpoints()},
@@ -305,7 +331,7 @@ public Builder startWait(Duration startWait) {
      * <p>
      * Values outside the range of [{@code Thread.MIN_PRIORITY}, {@code Thread.MAX_PRIORITY}] will be set
      * to the minimum or maximum.
-     *  
+     *
      * @param threadPriority the priority for SDK threads
      * @return the builder
      * @since 5.0.0
@@ -314,7 +340,24 @@ public Builder threadPriority(int threadPriority) {
       this.threadPriority = Math.max(Thread.MIN_PRIORITY, Math.min(Thread.MAX_PRIORITY, threadPriority));
       return this;
     }
-    
+
+    /**
+     * Set the wrapper information.
+     * <p>
+     * This is intended for use with wrapper SDKs from LaunchDarkly.
+     * <p>
+     * If the WrapperBuilder is set, then it will replace the wrapper information from the HttpPropertiesBuilder.
+     * Additionally, any wrapper SDK may overwrite any application developer provided wrapper information.
+     *
+     * @param wrapperBuilder the wrapper builder
+     * @return the builder
+     * @since 7.1.0
+     */
+    public Builder wrapper(WrapperInfoBuilder wrapperBuilder) {
+      this.wrapperBuilder = wrapperBuilder;
+      return this;
+    }
+
     /**
      * Builds the configured {@link com.launchdarkly.sdk.server.LDConfig} object.
      *

src/main/java/com/launchdarkly/sdk/server/integrations/ApplicationInfoBuilder.java

@@ -74,4 +74,11 @@ public ApplicationInfoBuilder applicationVersion(String applicationVersion) {
   public ApplicationInfo createApplicationInfo() {
     return new ApplicationInfo(applicationId, applicationVersion);
   }
+
+  public static ApplicationInfoBuilder fromApplicationInfo(ApplicationInfo info) {
+    ApplicationInfoBuilder newBuilder = new ApplicationInfoBuilder();
+    newBuilder.applicationId = info.getApplicationId();
+    newBuilder.applicationVersion = info.getApplicationVersion();
+    return newBuilder;
+  }
 }

src/main/java/com/launchdarkly/sdk/server/integrations/WrapperInfoBuilder.java

@@ -0,0 +1,42 @@
+package com.launchdarkly.sdk.server.integrations;
+
+import com.launchdarkly.sdk.server.interfaces.WrapperInfo;
+
+/**
+ * Contains methods for configuring wrapper information.
+ * <p>
+ * This builder is primarily intended for use by LaunchDarkly in developing wrapper SDKs.
+ * <p>
+ * If the WrapperBuilder is used, then it will replace the wrapper information from the HttpPropertiesBuilder.
+ * Additionally, any wrapper SDK may overwrite any application developer provided wrapper information.
+ */
+ public abstract class WrapperInfoBuilder {
+  protected String wrapperName;
+  protected String wrapperVersion;
+
+  /**
+   * Set the name of the wrapper.
+   *
+   * @param wrapperName the name of the wrapper
+   * @return the builder
+   */
+  public WrapperInfoBuilder wrapperName(String wrapperName) {
+    this.wrapperName = wrapperName;
+    return this;
+  }
+
+  /**
+   * Set the version of the wrapper.
+   * <p>
+   * This information will not be used unless the wrapperName is also set.
+   *
+   * @param wrapperVersion the version of the wrapper
+   * @return the builder
+   */
+  public WrapperInfoBuilder wrapperVersion(String wrapperVersion) {
+    this.wrapperVersion = wrapperVersion;
+    return this;
+  }
+
+  public abstract WrapperInfo build();
+}