Android SDK 4.x to 5.0 migration guide

Overview

This topic explains the changes in the Android 5.0 release and how to migrate to that version.

Version 5.0 includes breaking changes. It removes the deprecated LDUser. To learn more, read Understanding what was removed.

Version 5 also introduces the ability to have LaunchDarkly automatically provide data about the mobile environment where the application is running. This data makes it simpler to target your mobile customers based on application name or version, or on device characteristics including manufacturer, model, operating system, and so on.

When you configure the SDK, starting in version 5.0 you must indicate whether LaunchDarkly should or should not include this data.

This data is provided in two new context kinds. The data is added automatically to each evaluation context you provide.

Customers who are billed by primary context kind may be charged based on the ld_device context kind if it becomes the context kind with the highest volume of monthly activity in their account. This feature does not affect customers on other billing models. To learn more, read Account usage metrics.

Before you migrate to version 5.0, we recommend updating to the latest 4.x version. If you update to the latest 4.x version, deprecation warnings appear in areas of your code that need to be changed for 5.0, for example, any use of LDUser. You can update these areas at your own pace while still using 4.x, rather than migrating everything simultaneously. To learn more about updating to the latest 4.x version, visit the SDK's GitHub repository.

Understanding changes to configuration options

Version 5.0 introduces a new, required configuration parameter. Use this to indicate whether LaunchDarkly should automatically provide data about the mobile environment where the application is running as part of each evaluation context. You must include this parameter when building your LDConfig.

Here's how:

LDConfig ldConfig = new LDConfig.Builder(AutoEnvAttributes.Enabled)
    .mobileKey("mobile-key-123abc")
    .build();
COPY

To disable this option, pass in AutoEnvAttributes.Disabled instead.

To learn more, read LDConfig.Builder.

Understanding the automatically added environment attributes

If you use AutoEnvAttributes.Enabled in the SDK client configuration, the SDK automatically adds two additional contexts to each context that you evaluate. You can use attributes from these contexts in your targeting rules.

These automatically added contexts include the following attributes:

If the SDK cannot determine the information for a particular attribute, it will not include that attribute. For example, if the SDK cannot determine the device's model, it will not include the model attribute.

Automatic environment attributes and application metadata configuration

If you are already setting application metadata as part of your SDK configuration, you can still use this new environment attributes feature. Any application metadata that you set will override the automatically collected environment attributes.

Specifically, ld_application context attributes are set based on the following priority order:

1. If you set values for application id, name, version, or version name using application metadata configuration in the SDK, then the ld_application context will reflect those values.
2. Otherwise, if you have set values for the application id, name, version, or version name within your mobile app, the ld_application context will reflect those values.
3. Otherwise, the ld_application context will use the LaunchDarkly SDK name and version.

Understanding changes to application information

In previous versions, you could use the LDConfig builder's .applicationInfo method to set the application id and application version. Starting with version 5, you can also set the application name and version name.

Here's how:

LDConfig config = new LDConfig.Builder(AutoEnvAttributes.Enabled)
    .applicationInfo(
        Components.applicationInfo()
            .applicationId("authentication-service")
            .applicationName("Authentication-Service")
            .applicationVersion("1.0.0")
            .applicationVersionName("v1")
    )
    .build();
COPY

To learn more, read Application metadata configuration.

Understanding what was removed

Version 5.0 removes the deprecated LDUser. Version 4 of the Android SDK replaced users with contexts. Starting in version 5, the deprecated LDUser is removed.

Here's how to construct a basic context, as compared with constructing a user:

LDUser user = new LDUser("user-key-123abc");
COPY

To learn more about replacing users with contexts, read the Android SDK 3.x to 4.0 migration guide and Best practices for upgrading users to contexts.