Skip to main content

Flutter SDK Reference

This topic describes how to use the Harness Feature Flags SDK for your Flutter application. 

For getting started quickly, you can use our sample code from the SDK README. You can also clone and run a sample application from the Flutter SDK GitHub Repository.

Before you begin

You should read and understand the following:

Version

The current version of this SDK is 1.0.8.

Requirements

To use this SDK, make sure you:

note

To check if you have installed the prerequisites, run the flutter doctor command.

Install the SDK

To install the SDK, add the Feature Flag Flutter SDK dependency into the pubspec.yaml file, for example:

ff_flutter_client_sdk: ^1.0.8

Then import the following packages into your project:

import 'package:ff_flutter_client_sdk/CfClient.dart';  
import 'package:ff_flutter_client_sdk/CfConfiguration.dart';
import 'package:ff_flutter_client_sdk/CfTarget.dart';

Initialize the SDK

To initialize the Flutter SDK, you need to:

  1. Add a Target that you want to Evaluate against a Feature Flag.
  2. (Optional) Configure the SDK options.
  3. Add your Client SDK key to connect to your Harness Environment.
  4. Complete the initialization with the SDK using the Client SDK Key, Target, and Configuration parameters you set.

Add a Target to Evaluate

What is a Target?
Targets are used to control which users see which Variation of a Feature Flag, for example, if you want to do internal testing, you can enable the Flag for some users and not others. When creating a Target, you give it a name and a unique identifier. Often Targets are users but you can create a Target from anything that can be uniquely identified, such as an app or a machine.

For more information about Targets, go to Targeting Users With Flags.

To add a Target, build it and pass in arguments for the following:

ParameterDescriptionRequired?Example
identifierUnique ID for the Target.Read Regex requirements for Target names and identifiers below for accepted characters.Required.setIdentifier("HT_1")
nameName for this Target. This does not have to be unique. Note: If you don’t provide a value, the name will be the same as the identifier.Read Regex requirements for Target names and identifiers below for accepted characters.OptionalNote: If you don't want to send a name, don't send the parameter. Sending an empty argument will cause an error..setName("Harness_Target_1")
Regex requirements for Target names and identifiers

Identifier

Regex: ^[[email protected]_-]*$
Must consist of only alphabetical characters, numbers, and the following symbols:
. (period)
@ (at sign)
-(dash)
_ (underscore)

The characters can be lowercase or uppercase but cannot include accented letters, for example Cafe_789.

Name Regex: ^[\\p{L}\\d [email protected]_-]*$

Must consist of only alphabetical characters, numbers, and the following symbols:
. (period)
@ (at sign)
-(dash)
_ (underscore)
(space)

The characters can be lowercase or uppercase and can include accented letters, for example Café_123.

For example:

var target = CfTargetBuilder().setIdentifier("HT_1").setName("Harness_Target_1").build();

Configure the SDK

You can configure the following options for the SDK:

NameConfiguration OptionDescriptionDefault Value
baseUrlsetConfigUri("https://config.ff.harness.io/api/1.0")The URL used to fetch Feature Flag Evaluations. When using the Relay Proxy, change this to: http://localhost:7000https://config.ff.harness.io/api/1.0
eventsUrlsetEventUrl("https://events.ff.harness.io/api/1.0")The URL for posting metrics data to the Feature Flag service. When using the Relay Proxy, change this to: http://localhost:7000https://events.ff.harness.io/api/1.0
pollIntervalsetPollingInterval(60)The interval in seconds that we poll for changes when you are using stream mode.60 (seconds)
enableStreamsetStreamEnabled(True)Set to true to enable streaming mode.Set to false to disable streaming mode.true
enableAnalyticssetAnalyticsEnabled(True)Set to true to enable analytics.Set to false to disable analytics.Note: When enabled, analytics data is posted every 60 seconds.true

For example:

// Flutter SDK Config  
var conf = CfConfigurationBuilder()
.setConfigUri("https://config.ff.harness.io/api/1.0")
.setEventUrl("https://events.ff.harness.io/api/1.0")
.setPollingInterval(60)
.setStreamEnabled(true)
.setAnalyticsEnabled(true)
.build();

Complete the initialization

CfClient  is a base class that provides all the features of the SDK, which can be accessed with CfClient.initialize.

To initialize the SDK, you must pass in the following:

  • apiKey - The Client SDK Key you created when creating the Feature Flag.
  • Any configuration options you want to use.
  • The Target you want to evaluate.

Sample of initializing the SDK

final conf = CfConfigurationBuilder()  
.setStreamEnabled(false)
.setPollingInterval(60)
.build();

final target = CfTargetBuilder().setIdentifier(name).build();

final res = await CfClient.initialize(apiKey, conf, target);

Evaluate a Flag

Evaluating a Flag is when the SDK processes all Flag rules and returns the correct Variation of that Flag for the Target you provide. 

If a matching Flag can’t be found, or the SDK can’t remotely fetch flags, the default value is returned. 

There are different methods for the different Variation types and for each method you need to pass in:

  • Identifier of the Flag you want to evaluate
  • The default Variation

The Flag is evaluated against the Target you pass in when initializing the SDK.

Evaluate a boolean Variation

//get boolean evaluation  
final evaluation = await CfClient.boolVariation("demo_bool_evaluation", false);

Evaluate a number Variation

//get number evaluation  
final numberEvaluation = await CfClient.numberVariation("demo_number_evaluation", 0);

Evaluate a string Variation

//get string evaluation  
final stringEvaluation = await CfClient.stringVariation("demo_string_evaluation", "default");

Evaluate a JSON Variation

//get json evaluation  
final jsonEvaluation = await CfClient.jsonVariation("demo_json_evaluation", {});

Listen for events

Register the events listener

The eventsListener method provides a way to register a listener for different events that might be triggered by SDK.

The possible events and their responses are outlined in the following table:

EventTypeResponse
SSE_STARTnull
SSE_ENDnull
EVALUATION_POLLINGList<EvaluationResponse>
EVALUATION_CHANGEEvaluationResponse

To listen for events, register the events listener, for example:

CfClient.registerEventsListener((EvaluationResponse, EventType) {  

});

The triggered event will return one of the following types:

enum EventType {  
SSE_START,
SSE_END,
EVALUATION_POLLING,
EVALUATION_CHANGE
}

Close the events listener

To avoid unexpected behavior, when the listener isn't needed, turn it off by calling CfClient.getInstance().unregisterEventsListener(eventsListener), for example:

CfClient.unregisterEventsListener(eventsListener)

Test your app is connected to Harness

When you receive a response showing the current status of your Feature Flag, go to the Harness Platform and toggle the Flag on and off. Then, check your app to verify if the Flag Variation displayed is updated with the Variation you toggled.

A gif showing the Flag being toggled on the Harness app, and the effect it has on the code.

Close the SDK

To avoid potential memory leaks, when you no longer need the SDK, you should close it. For example, when the app is closed, also close the SDK.

To close the SDK, call this method:

CfClient.destroy()

Additional options

Use our public API methods

The Public API exposes the following methods that you can use:

static Future<InitializationResult> initialize(String apiKey, CfConfiguration configuration, CfTarget target)
static Future<bool> boolVariation(String evaluationId, bool defaultValue)
static Future<String> stringVariation(String evaluationId, String defaultValue)
static Future<double> numberVariation(String evaluationId, double defaultValue)
static Future<Map<dynamic, dynamic>> jsonVariation(String evaluationId, Map<dynamic, dynamic> defaultValue)
static Future<void> registerEventsListener(CfEventsListener listener)
static Future<void> unregisterEventsListener(CfEventsListener listener)
static Future<void> destroy()

Sample code for a Flutter application

Here is a sample code for using FF SDKs with the Flutter application.

final conf = CfConfigurationBuilder()  
.setStreamEnabled(true)
.setPollingInterval(60) //time in seconds (minimum value is 60)
.build();
final target = CfTargetBuilder().setIdentifier(name).build();

final res = await CfClient.initialize(apiKey, conf, target);


//get number evaluation
final numberEvaluation = await CfClient.numberVariation("demo_number_evaluation", 0);

//get string evaluaation
final stringEvaluation = await CfClient.stringVariation("demo_string_evaluation", "default");

//get json evaluation
final jsonEvaluation = await CfClient.jsonVariation("demo_json_evaluation", {});

CfClient.registerEventsListener((responseData, eventType) {
_eventListener = (responseData, eventType){};
switch (eventType) {
case EventType.SSE_START:
print("Started SSE");
break;
case EventType.SSE_END:
print("SSE Completed");
break;
case EventType.EVALUATION_CHANGE:
String flag = (responseData as EvaluationResponse).flag;
dynamic value = (responseData as EvaluationResponse).value;

break;
case EventType.EVALUATION_POLLING:
List pollingResult = responseData;

pollingResult.forEach((element) {
String flag = (element as EvaluationResponse).flag;
dynamic value = (element as EvaluationResponse).value;

});
break;
}
});

//Shutting down SDK
CfClient.destroy()