Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .changeset/v6-major-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@
- **Breaking:** remove `toMap()` from the config classes and `PostHogFeatureFlagResult.fromMap()` from the public API
- **Breaking:** rename `enable()` and `disable()` to `optIn()` and `optOut()` on `PosthogFlutterPlatformInterface`, `PosthogFlutterIO` and `PosthogFlutterWeb`
- Declare Android `minSdkVersion` 23 to match `posthog-android`
- Add a `defaultValue` option to `isFeatureEnabled()`, returned when the flag has no value
27 changes: 27 additions & 0 deletions api/posthog_flutter.api.json
Original file line number Diff line number Diff line change
Expand Up @@ -787,6 +787,15 @@
"name": "sendFeatureFlagEvent",
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"typeName": "bool?"
},
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": true,
"isRequired": false,
"name": "defaultValue",
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"typeName": "bool?"
}
],
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
Expand Down Expand Up @@ -1840,6 +1849,15 @@
"name": "sendFeatureFlagEvent",
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"typeName": "bool?"
},
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": true,
"isRequired": false,
"name": "defaultValue",
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"typeName": "bool?"
}
],
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
Expand Down Expand Up @@ -4507,6 +4525,15 @@
"name": "sendFeatureFlagEvent",
"relativePath": "lib/src/posthog.dart",
"typeName": "bool?"
},
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": true,
"isRequired": false,
"name": "defaultValue",
"relativePath": "lib/src/posthog.dart",
"typeName": "bool?"
}
],
"relativePath": "lib/src/posthog.dart",
Expand Down
3 changes: 2 additions & 1 deletion posthog_flutter/lib/posthog_flutter_web.dart
Original file line number Diff line number Diff line change
Expand Up @@ -413,11 +413,12 @@ class PosthogFlutterWeb extends PosthogFlutterPlatformInterface {

@override
Future<bool> isFeatureEnabled(String key,
{bool? sendFeatureFlagEvent}) async {
{bool? sendFeatureFlagEvent, bool? defaultValue}) async {
final result = await _call(
MethodCall('isFeatureEnabled', {
'key': key,
if (sendFeatureFlagEvent != null) 'sendEvent': sendFeatureFlagEvent,
if (defaultValue != null) 'defaultValue': defaultValue,
}),
);
return result as bool? ?? false;
Expand Down
19 changes: 16 additions & 3 deletions posthog_flutter/lib/src/posthog.dart
Original file line number Diff line number Diff line change
Expand Up @@ -471,18 +471,31 @@ class Posthog {
/// [PostHogConfig.sendFeatureFlagEvent]. Pass `false` to skip the event for
/// this call, or `true` to capture it even when the config turns it off.
///
/// Returns `false` when the flag is disabled, missing, or not a boolean flag.
/// [defaultValue] is what this call returns when the flag has no value.
/// Defaults to `null`, which returns `false`. A flag has no value when flags
/// have not loaded yet, the flags request failed, or no flag has this key. A
/// flag that has a value always wins, including `false` and variants, and
/// `$feature_flag_called` never reports [defaultValue] as the flag's value.
///
/// Returns `false` when the flag is disabled, and `true` when it is enabled
/// or set to a variant.
///
/// **Example:**
/// ```dart
/// if (await Posthog().isFeatureEnabled('new-checkout',
/// sendFeatureFlagEvent: false)) {
/// // show the new checkout without recording a flag exposure
/// }
///
/// // Keep the feature on until the flag says otherwise.
/// final showCheckout =
/// await Posthog().isFeatureEnabled('new-checkout', defaultValue: true);
/// ```
Future<bool> isFeatureEnabled(String key, {bool? sendFeatureFlagEvent}) =>
Future<bool> isFeatureEnabled(String key,
{bool? sendFeatureFlagEvent, bool? defaultValue}) =>
_posthog.isFeatureEnabled(key,
sendFeatureFlagEvent: sendFeatureFlagEvent);
sendFeatureFlagEvent: sendFeatureFlagEvent,
defaultValue: defaultValue);

/// Reloads feature flags for the current user.
///
Expand Down
6 changes: 4 additions & 2 deletions posthog_flutter/lib/src/posthog_flutter_desktop.dart
Original file line number Diff line number Diff line change
Expand Up @@ -442,12 +442,14 @@ class PosthogFlutterDesktop extends PosthogFlutterPlatformInterface {
_guard('unregister', (client) => client.unregister(key));

@override
Future<bool> isFeatureEnabled(String key, {bool? sendFeatureFlagEvent}) =>
Future<bool> isFeatureEnabled(String key,
{bool? sendFeatureFlagEvent, bool? defaultValue}) =>
_guardWith(
'isFeatureEnabled',
false,
defaultValue ?? false,
(client) =>
client.isFeatureEnabled(key, sendEvent: sendFeatureFlagEvent) ??
defaultValue ??
false);

@override
Expand Down
10 changes: 9 additions & 1 deletion posthog_flutter/lib/src/posthog_flutter_io.dart
Original file line number Diff line number Diff line change
Expand Up @@ -589,7 +589,15 @@ class PosthogFlutterIO extends PosthogFlutterPlatformInterface {

@override
Future<bool> isFeatureEnabled(String key,
{bool? sendFeatureFlagEvent}) async {
{bool? sendFeatureFlagEvent, bool? defaultValue}) async {
if (defaultValue != null) {
// Native isFeatureEnabled returns a plain Bool, which can't tell a missing
// flag from a disabled one. Both call the same native flag read.
final result = await getFeatureFlagResult(
key: key, sendFeatureFlagEvent: sendFeatureFlagEvent);
return result?.enabled ?? defaultValue;
}

if (!isSupportedPlatform()) {
return false;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,8 @@ abstract class PosthogFlutterPlatformInterface extends PlatformInterface {
throw UnimplementedError('unregister() has not been implemented.');
}

Future<bool> isFeatureEnabled(String key, {bool? sendFeatureFlagEvent}) {
Future<bool> isFeatureEnabled(String key,
{bool? sendFeatureFlagEvent, bool? defaultValue}) {
throw UnimplementedError('isFeatureEnabled() has not been implemented.');
}

Expand Down
1 change: 1 addition & 0 deletions posthog_flutter/lib/src/posthog_flutter_web_handler.dart
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,7 @@ Future<dynamic> handleWebMethodCall(MethodCall call) async {
final isFeatureEnabled = posthog
?.isFeatureEnabled(stringToJSAny(key), _flagOptions(args))
?.dartify() as bool? ??
args['defaultValue'] as bool? ??
false;
return isFeatureEnabled;
case 'group':
Expand Down
62 changes: 62 additions & 0 deletions posthog_flutter/test/posthog_flutter_desktop_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,11 @@ void main() {
expect(await platform.isFeatureEnabled('flag'), isFalse);
});

test('isFeatureEnabled returns the default', () async {
expect(
await platform.isFeatureEnabled('flag', defaultValue: true), isTrue);
});

test('isOptOut reports opted out', () async {
expect(await platform.isOptOut(), isTrue);
});
Expand Down Expand Up @@ -1808,6 +1813,63 @@ void main() {
expect(view['distinct_id'], distinctId);
});

test('isFeatureEnabled defaultValue only applies to flags with no value',
() async {
final server = await LocalPostHogServer.start();
server.respond = (_) => PostHogResponse.json({
'flags': {
..._variantFlagResponse()['flags']! as Map<String, Object?>,
'off-flag': {'key': 'off-flag', 'enabled': false},
},
});
final flagsLoaded = Completer<void>();
final config = configFor(server)
..onFeatureFlags = () {
if (!flagsLoaded.isCompleted) flagsLoaded.complete();
};
final platform = await setUpPlatform(config);
await flagsLoaded.future;

expect(await platform.isFeatureEnabled('missing', defaultValue: true),
isTrue);
expect(await platform.isFeatureEnabled('missing', defaultValue: false),
isFalse);
expect(await platform.isFeatureEnabled('off-flag', defaultValue: true),
isFalse);
expect(
await platform.isFeatureEnabled('variant-flag', defaultValue: false),
isTrue);
});

test(r'$feature_flag_called does not report the defaultValue', () async {
final server = await LocalPostHogServer.start();
server.respond = (_) => PostHogResponse.json(_variantFlagResponse());
final flagsLoaded = Completer<void>();
final config = configFor(server)
..onFeatureFlags = () {
if (!flagsLoaded.isCompleted) flagsLoaded.complete();
};
final platform = await setUpPlatform(config);
await flagsLoaded.future;

await platform.isFeatureEnabled('missing', defaultValue: true);

final called = await server.waitForEvent(r'$feature_flag_called');
expect(_propertiesOf(called)[r'$feature_flag_response'], isNull);
});

test(
'isFeatureEnabled returns the defaultValue after a failed flags request',
() async {
final server = await LocalPostHogServer.start();
server.respond = (_) => const PostHogResponse(500);
final platform = await setUpPlatform(configFor(server));
await platform.reloadFeatureFlags();

expect(await platform.isFeatureEnabled('missing', defaultValue: true),
isTrue);
});

test(r'sendFeatureFlagEvent false skips $feature_flag_called', () async {
final server = await LocalPostHogServer.start();
server.respond = (_) => PostHogResponse.json(_variantFlagResponse());
Expand Down
55 changes: 55 additions & 0 deletions posthog_flutter/test/posthog_flutter_io_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,61 @@ isolate_dso_base: 7000000000
}
});

group('PosthogFlutterIO isFeatureEnabled defaultValue', () {
void respondToFlagResult(Object? Function() respond) {
TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger
.setMockMethodCallHandler(channel, (call) async {
log.add(call);
return respond();
});
}

for (final (name, native, defaultValue, expected)
in <(String, Map<String, Object?>?, bool, bool)>[
('missing flag returns default true', null, true, true),
('missing flag returns default false', null, false, false),
(
'false flag beats default true',
{'key': 'flag', 'enabled': false, 'variant': null},
true,
false,
),
(
'variant beats default false',
{'key': 'flag', 'enabled': true, 'variant': 'test'},
false,
true,
),
]) {
test(name, () async {
respondToFlagResult(() => native);

expect(
await posthogFlutterIO.isFeatureEnabled('flag',
defaultValue: defaultValue),
expected);
});
}

test('forwards sendFeatureFlagEvent and never sends the default', () async {
respondToFlagResult(() => null);

await posthogFlutterIO.isFeatureEnabled('flag',
sendFeatureFlagEvent: false, defaultValue: true);

expect(log.single.method, 'getFeatureFlagResult');
expect(log.single.arguments, {'key': 'flag', 'sendEvent': false});
});

test('native failure returns the default', () async {
respondToFlagResult(() => throw PlatformException(code: 'failed'));

expect(
await posthogFlutterIO.isFeatureEnabled('flag', defaultValue: true),
isTrue);
});
});

group('PosthogFlutterIO getAllFeatureFlags', () {
test('decodes the native results', () async {
TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -284,11 +284,12 @@ class PosthogFlutterPlatformFake extends PosthogFlutterPlatformInterface {

@override
Future<bool> isFeatureEnabled(String key,
{bool? sendFeatureFlagEvent}) async {
{bool? sendFeatureFlagEvent, bool? defaultValue}) async {
flagReadCalls.add({
'method': 'isFeatureEnabled',
'key': key,
'sendFeatureFlagEvent': sendFeatureFlagEvent,
if (defaultValue != null) 'defaultValue': defaultValue,
});
return featureFlagValues[key] == true;
}
Expand Down
41 changes: 41 additions & 0 deletions posthog_flutter/test/posthog_flutter_web_handler_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,47 @@ void main() {
}
});

group('PosthogFlutterWeb isFeatureEnabled defaultValue', () {
late Object? receivedOptions;

void installFlagValue(JSAny? value) {
final fake = JSObject();
fake.setProperty(
'isFeatureEnabled'.toJS,
((JSString key, JSAny? options) {
receivedOptions = options.dartify();
return value;
}).toJS,
);
globalContext.setProperty('posthog'.toJS, fake);
}

for (final (name, value, defaultValue, expected)
in <(String, JSAny?, bool, bool)>[
('missing flag returns default true', null, true, true),
('missing flag returns default false', null, false, false),
('false flag beats default true', false.toJS, true, false),
('variant beats default false', true.toJS, false, true),
]) {
test(name, () async {
installFlagValue(value);

expect(
await PosthogFlutterWeb()
.isFeatureEnabled('flag', defaultValue: defaultValue),
expected);
});
}

test('does not pass the default to posthog-js', () async {
installFlagValue(null);

await PosthogFlutterWeb().isFeatureEnabled('flag', defaultValue: true);

expect(receivedOptions, <String, Object?>{});
});
});

group('PosthogFlutterWeb getAllFeatureFlags', () {
test('decodes the posthog-js results', () async {
final fake = JSObject();
Expand Down
7 changes: 7 additions & 0 deletions posthog_flutter/test/posthog_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -449,12 +449,19 @@ void main() {
await Posthog().getFeatureFlag('b', sendFeatureFlagEvent: false);
await Posthog().isFeatureEnabled('c');
await Posthog().isFeatureEnabled('d', sendFeatureFlagEvent: true);
await Posthog().isFeatureEnabled('e', defaultValue: true);

expect(fake.flagReadCalls, [
{'method': 'getFeatureFlag', 'key': 'a', 'sendFeatureFlagEvent': null},
{'method': 'getFeatureFlag', 'key': 'b', 'sendFeatureFlagEvent': false},
{'method': 'isFeatureEnabled', 'key': 'c', 'sendFeatureFlagEvent': null},
{'method': 'isFeatureEnabled', 'key': 'd', 'sendFeatureFlagEvent': true},
{
'method': 'isFeatureEnabled',
'key': 'e',
'sendFeatureFlagEvent': null,
'defaultValue': true,
},
]);
});

Expand Down
Loading