Multiple environments — LaunchDarkly

Overview

This topic explains how to support multiple environments in LaunchDarkly mobile SDKs.

Client-side SDKs

Some LaunchDarkly client-side mobile SDKs support having multiple LDClient instances tied to separate mobile keys. This allows the SDK to evaluate flags from multiple environments. The SDK can evaluate flags from different environments whether they are all in the same LaunchDarkly project or different LaunchDarkly projects.

However, other LaunchDarkly client-side mobile SDKs, including Android, iOS, and React Native, do not support multiple LDClient instances. Instead, you can configure the one SDK instance to connect to multiple environments.

This feature is available in the following client-side SDKs:

Android

Expand Android code sample

All LDClient instances evaluate against the same LDContext. The mobile keys for additional environments are specified, along with identifying names, in a map passed to your LDConfig object.

Here’s how:

1 Map<String, String> otherKeys = new HashMap<String, String>();
2 otherKeys.put("platform", "platform-mobile-key-456def");
3 otherKeys.put("core", "core-mobile-key-789ghi");
4 
5 LDConfig ldConfig = new LDConfig.Builder(AutoEnvAttributes.Enabled)
6     .mobileKey("mobile-key-123abc")
7     .secondaryMobileKeys(otherKeys)
8     .build();
9 
10 LDContext context = LDContext.builder("context-key-123abc")
11     .set("email", "sandy@example.com")
12     .build();
13 
14 LDClient.init(this.getApplication(), ldConfig, context);

To access the secondary mobile key instances, use the getForMobileKey method on LDClient. This method takes the identifier name assigned to your environment key in the secondaryMobileKeys map and returns the associated LDClient instance. Track calls, listeners, and flag evaluation are all tied to the client instance they are evaluated against.

Here’s how:

1 LDClient coreInstance = LDClient.getForMobileKey("core");
2 // Variation determines whether or not a flag is enabled for a specific context
3 coreInstance.boolVariation("core-flag", false);
4 // allFlags produces a map of feature flag keys to their values
5 coreInstance.allFlags();
6 // track records actions end users take in your app
7 coreInstance.track("metric-key-123abc", data);

As all the client instances use the same LDClient object, some calls affect all instances.

These methods include:

1 LDClient coreInstance = LDClient.getForMobileKey("core");
2 
3 // Calls affect all LDClient Instances
4 coreInstance.identify(/*Context Object*/);
5 coreInstance.flush();
6 coreInstance.setOffline();
7 coreInstance.setOnline();
8 coreInstance.close();

To learn more, read LDClient.

iOS

Expand iOS code sample

All LDClient instances evaluate against the same LDContext. The mobile keys for additional environments are specified, along with identifying names, in a map passed to your LDConfig object.

1 let context = try LDContextBuilder(key: "context-key-123abc").build().get()
2 var config = LDConfig(mobileKey: "mobile-key-123abc", autoEnvAttributes: .enabled)
3 // The SDK throws error strings if you add duplicate keys or put the primary key or name in secondaryMobileKeys.
4 try! config.setSecondaryMobileKeys(["platform": "platform-mobile-key-123abc", "core": "core-mobile-key-123abc"])
5 LDClient.start(config: config, context: context)

To access the secondary mobile key instances, use the LDClient.get static method on LDClient. This method takes the identifier name assigned to your environment key in the secondaryMobileKeys map and returns the associated LDClient instance. Track calls, listeners, and flag evaluation are all tied to the client instance they are evaluated against.

Here’s how:

1 let coreInstance = LDClient.get(environment: "core")
2 // Variation determines whether or not a flag is enabled for a specific context
3 let coreFlagValue = coreInstance?.boolVariation(forKey: "core-flag-key-123abc", defaultValue: false)
4 // allFlags produces a map of feature flag keys to their values
5 let allFlags: [String: LDValue]? = coreInstance?.allFlags
6 // track records actions end users take in your app
7 try coreInstance?.track(key: "track-event-key-123abc", data: data)

As all the client instances use the same LDClient object, some SDK functionality affects all instances.

These methods include:

1 coreInstance.identify(/*Context Object*/)
2 coreInstance.flush()
3 coreInstance.setOnline(/*true or false*/)
4 coreInstance.close()

To learn more, read LDClient.

React Native

Expand React Native code sample

Starting with version 10 of the React Native SDK, if you need to support multiple environments in the same application, you can create multiple clients. We do not recommend using multiple environments within one application, because it quickly becomes complex and difficult to manage. If your setup requires it, here’s how:

React Native SDK, v10

1 // not recommended: support multiple environments by creating multiple clients
2 const client1 = new ReactNativeLDClient('mobile-key-123abc', AutoEnvAttributes.Enabled);
3 const client2 = new ReactNativeLDClient('mobile-key-456def', AutoEnvAttributes.Enabled);

Expand for working with multiple environments in earlier versions

In previous versions of the React Native SDK, all LDClient instances evaluate against the same LDContext. The mobile keys for additional environments are specified, along with identifying names, in a map passed to your LDConfig object.

Here’s how:

1 import LDClient, * as ld from 'launchdarkly-react-native-client-sdk';
2 
3 let config: ld.LDConfig = {
4   mobileKey: 'mobile-key-123abc',
5   secondaryMobileKeys: {
6     'platform': 'platform-mobile-key-456def',
7     'core': 'core-mobile-key-789ghi'
8   },
9 };
10 let context: ld.LDContext = { 'key': 'user-key-123abc', 'kind': 'user' };
11 
12 await client.configure(config, context);

To use functionality with a secondary environment, provide the name of the desired secondary environment as the environment parameter value to many LDClient methods. Some LDClient methods do not have an optional environment parameter because they act across all environments.

To use functionality with a secondary environment, provide the name of the desired secondary environment as the environment parameter value to many LDClient methods.

Here’s how:

React Native SDK v7.0 (JavaScript)

1 // Here, 'core' is the name of a secondary environment
2 
3 // Variation determines whether or not a flag is enabled for a specific context
4 let boolResult = await client.boolVariation('bool-flag-key-123abc', false, 'core');
5 // allFlags produces a map of feature flag keys to their values
6 let allFlagsResult = client.allFlags('core');
7 allFlagsResult.then(values => {
8   console.log(values);
9 });
10 
11 // track records actions end users take in your app
12 client.track('metric-flag-key-123abc', false, 'core');

Some LDClient methods do not have an optional environment parameter because they act across all environments.

These methods include:

React Native SDK v7.0 (JavaScript)

1 identify(context);
2 flush();
3 setOnline();
4 setOffline();
5 isOffline():
6 close();

1	Map<String, String> otherKeys = new HashMap<String, String>();
2	otherKeys.put("platform", "platform-mobile-key-456def");
3	otherKeys.put("core", "core-mobile-key-789ghi");
4
5	LDConfig ldConfig = new LDConfig.Builder(AutoEnvAttributes.Enabled)
6	.mobileKey("mobile-key-123abc")
7	.secondaryMobileKeys(otherKeys)
8	.build();
9
10	LDContext context = LDContext.builder("context-key-123abc")
11	.set("email", "sandy@example.com")
12	.build();
13
14	LDClient.init(this.getApplication(), ldConfig, context);

1	LDClient coreInstance = LDClient.getForMobileKey("core");
2	// Variation determines whether or not a flag is enabled for a specific context
3	coreInstance.boolVariation("core-flag", false);
4	// allFlags produces a map of feature flag keys to their values
5	coreInstance.allFlags();
6	// track records actions end users take in your app
7	coreInstance.track("metric-key-123abc", data);

1	LDClient coreInstance = LDClient.getForMobileKey("core");
2
3	// Calls affect all LDClient Instances
4	coreInstance.identify(/Context Object/);
5	coreInstance.flush();
6	coreInstance.setOffline();
7	coreInstance.setOnline();
8	coreInstance.close();

1	let context = try LDContextBuilder(key: "context-key-123abc").build().get()
2	var config = LDConfig(mobileKey: "mobile-key-123abc", autoEnvAttributes: .enabled)
3	// The SDK throws error strings if you add duplicate keys or put the primary key or name in secondaryMobileKeys.
4	try! config.setSecondaryMobileKeys(["platform": "platform-mobile-key-123abc", "core": "core-mobile-key-123abc"])
5	LDClient.start(config: config, context: context)

1	let coreInstance = LDClient.get(environment: "core")
2	// Variation determines whether or not a flag is enabled for a specific context
3	let coreFlagValue = coreInstance?.boolVariation(forKey: "core-flag-key-123abc", defaultValue: false)
4	// allFlags produces a map of feature flag keys to their values
5	let allFlags: [String: LDValue]? = coreInstance?.allFlags
6	// track records actions end users take in your app
7	try coreInstance?.track(key: "track-event-key-123abc", data: data)

1	coreInstance.identify(/Context Object/)
2	coreInstance.flush()
3	coreInstance.setOnline(/true or false/)
4	coreInstance.close()

1	// not recommended: support multiple environments by creating multiple clients
2	const client1 = new ReactNativeLDClient('mobile-key-123abc', AutoEnvAttributes.Enabled);
3	const client2 = new ReactNativeLDClient('mobile-key-456def', AutoEnvAttributes.Enabled);

1	import LDClient, * as ld from 'launchdarkly-react-native-client-sdk';
2
3	let config: ld.LDConfig = {
4	mobileKey: 'mobile-key-123abc',
5	secondaryMobileKeys: {
6	'platform': 'platform-mobile-key-456def',
7	'core': 'core-mobile-key-789ghi'
8	},
9	};
10	let context: ld.LDContext = { 'key': 'user-key-123abc', 'kind': 'user' };
11
12	await client.configure(config, context);

1	// Here, 'core' is the name of a secondary environment
2
3	// Variation determines whether or not a flag is enabled for a specific context
4	let boolResult = await client.boolVariation('bool-flag-key-123abc', false, 'core');
5	// allFlags produces a map of feature flag keys to their values
6	let allFlagsResult = client.allFlags('core');
7	allFlagsResult.then(values => {
8	console.log(values);
9	});
10
11	// track records actions end users take in your app
12	client.track('metric-flag-key-123abc', false, 'core');

1	identify(context);
2	flush();
3	setOnline();
4	setOffline();
5	isOffline():
6	close();