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
5 changes: 5 additions & 0 deletions .changeset/capture-feature-view-interaction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"posthog_flutter": minor
---

Add `captureFeatureView()` and `captureFeatureInteraction()` to capture `$feature_view` and `$feature_interaction` events for a feature flag
186 changes: 186 additions & 0 deletions api/posthog_flutter.api.json
Original file line number Diff line number Diff line change
Expand Up @@ -566,6 +566,68 @@
"type": "method",
"typeParameterNames": []
},
{
"entryPoints": [],
"isDeprecated": false,
"isExperimental": false,
"isStatic": false,
"name": "captureFeatureView",
"parameters": [
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": true,
"isRequired": true,
"name": "flag",
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"typeName": "String"
},
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": true,
"isRequired": false,
"name": "flagVariant",
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"typeName": "String?"
}
],
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"returnTypeName": "Future<void>",
"type": "method",
"typeParameterNames": []
},
{
"entryPoints": [],
"isDeprecated": false,
"isExperimental": false,
"isStatic": false,
"name": "captureFeatureInteraction",
"parameters": [
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": true,
"isRequired": true,
"name": "flag",
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"typeName": "String"
},
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": true,
"isRequired": false,
"name": "flagVariant",
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"typeName": "String?"
}
],
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"returnTypeName": "Future<void>",
"type": "method",
"typeParameterNames": []
},
{
"entryPoints": [],
"isDeprecated": false,
Expand Down Expand Up @@ -1549,6 +1611,68 @@
"type": "method",
"typeParameterNames": []
},
{
"entryPoints": [],
"isDeprecated": false,
"isExperimental": false,
"isStatic": false,
"name": "captureFeatureView",
"parameters": [
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": true,
"isRequired": true,
"name": "flag",
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"typeName": "String"
},
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": true,
"isRequired": false,
"name": "flagVariant",
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"typeName": "String?"
}
],
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"returnTypeName": "Future<void>",
"type": "method",
"typeParameterNames": []
},
{
"entryPoints": [],
"isDeprecated": false,
"isExperimental": false,
"isStatic": false,
"name": "captureFeatureInteraction",
"parameters": [
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": true,
"isRequired": true,
"name": "flag",
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"typeName": "String"
},
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": true,
"isRequired": false,
"name": "flagVariant",
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"typeName": "String?"
}
],
"relativePath": "lib/src/posthog_flutter_platform_interface.dart",
"returnTypeName": "Future<void>",
"type": "method",
"typeParameterNames": []
},
{
"entryPoints": [],
"isDeprecated": false,
Expand Down Expand Up @@ -4889,6 +5013,68 @@
"type": "method",
"typeParameterNames": []
},
{
"entryPoints": [],
"isDeprecated": false,
"isExperimental": false,
"isStatic": false,
"name": "captureFeatureView",
"parameters": [
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": false,
"isRequired": true,
"name": "flag",
"relativePath": "lib/src/posthog.dart",
"typeName": "String"
},
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": true,
"isRequired": false,
"name": "flagVariant",
"relativePath": "lib/src/posthog.dart",
"typeName": "String?"
}
],
"relativePath": "lib/src/posthog.dart",
"returnTypeName": "Future<void>",
"type": "method",
"typeParameterNames": []
},
{
"entryPoints": [],
"isDeprecated": false,
"isExperimental": false,
"isStatic": false,
"name": "captureFeatureInteraction",
"parameters": [
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": false,
"isRequired": true,
"name": "flag",
"relativePath": "lib/src/posthog.dart",
"typeName": "String"
},
{
"isDeprecated": false,
"isExperimental": false,
"isNamed": true,
"isRequired": false,
"name": "flagVariant",
"relativePath": "lib/src/posthog.dart",
"typeName": "String?"
}
],
"relativePath": "lib/src/posthog.dart",
"returnTypeName": "Future<void>",
"type": "method",
"typeParameterNames": []
},
{
"entryPoints": [],
"isDeprecated": false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,14 @@ class PosthogFlutterPlugin :
capture(call, result)
}

"captureFeatureView" -> {
captureFeatureView(call, result)
}

"captureFeatureInteraction" -> {
captureFeatureInteraction(call, result)
}

"screen" -> {
screen(call, result)
}
Expand Down Expand Up @@ -1834,6 +1842,32 @@ class PosthogFlutterPlugin :
}
}

private fun captureFeatureView(
call: MethodCall,
result: Result,
) {
try {
val flag: String = call.argument("flag")!!
PostHog.captureFeatureView(flag, call.argument("flagVariant"))
result.success(null)
} catch (e: Throwable) {
result.error("PosthogFlutterException", e.localizedMessage, null)
}
}

private fun captureFeatureInteraction(
call: MethodCall,
result: Result,
) {
try {
val flag: String = call.argument("flag")!!
PostHog.captureFeatureInteraction(flag, call.argument("flagVariant"))
result.success(null)
} catch (e: Throwable) {
result.error("PosthogFlutterException", e.localizedMessage, null)
}
}

private fun distinctId(result: Result) {
try {
val distinctId: String = PostHog.distinctId()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -495,6 +495,10 @@ public class PosthogFlutterPlugin: NSObject, FlutterPlugin {
captureLog(call, result: result)
case "alias":
alias(call, result: result)
case "captureFeatureView":
captureFeatureView(call, result: result)
case "captureFeatureInteraction":
captureFeatureInteraction(call, result: result)
case "distinctId":
distinctId(result)
case "reset":
Expand Down Expand Up @@ -1550,6 +1554,34 @@ extension PosthogFlutterPlugin {
}
}

private func captureFeatureView(
_ call: FlutterMethodCall,
result: @escaping FlutterResult
) {
if let args = call.arguments as? [String: Any],
let flag = args["flag"] as? String
{
PostHogSDK.shared.captureFeatureView(flag: flag, flagVariant: args["flagVariant"] as? String)
result(nil)
} else {
_badArgumentError(result)
}
}

private func captureFeatureInteraction(
_ call: FlutterMethodCall,
result: @escaping FlutterResult
) {
if let args = call.arguments as? [String: Any],
let flag = args["flag"] as? String
{
PostHogSDK.shared.captureFeatureInteraction(flag: flag, flagVariant: args["flagVariant"] as? String)
result(nil)
} else {
_badArgumentError(result)
}
}

private func distinctId(_ result: @escaping FlutterResult) {
let val = PostHogSDK.shared.getDistinctId()
result(val)
Expand Down
44 changes: 44 additions & 0 deletions posthog_flutter/lib/posthog_flutter_web.dart
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import 'src/posthog_flutter_web_handler.dart';
import 'src/utils/before_send.dart';
import 'src/replay/web/web_canvas_mask_provider.dart';
import 'src/utils/capture_utils.dart';
import 'src/utils/feature_event.dart';

/// A web implementation of the PosthogFlutterPlatform of the PosthogFlutter plugin.
class PosthogFlutterWeb extends PosthogFlutterPlatformInterface {
Expand All @@ -32,6 +33,11 @@ class PosthogFlutterWeb extends PosthogFlutterPlatformInterface {
/// way [PosthogFlutterIO] runs it before the platform channel.
List<BeforeSendCallback> _beforeSendCallbacks = [];

// posthog-js has no current screen, so the feature events get it from here
// the way native SDKs stamp it: the last screen beforeSend accepted, under
// its final name, until close().
String? _currentScreen;

Future<PostHogEvent?> _runBeforeSend(
String eventName,
Map<String, Object>? properties, {
Expand Down Expand Up @@ -270,6 +276,7 @@ class PosthogFlutterWeb extends PosthogFlutterPlatformInterface {
final finalScreenName =
processedEvent.properties?[PostHogPropertyName.screenName] as String? ??
screenName;
_currentScreen = finalScreenName;
processedEvent.properties?.remove(PostHogPropertyName.screenName);
final remaining = processedEvent.properties;

Expand All @@ -292,6 +299,42 @@ class PosthogFlutterWeb extends PosthogFlutterPlatformInterface {
return result as String? ?? '';
}

@override
Future<void> captureFeatureView({
required String flag,
String? flagVariant,
}) =>
_captureFeatureEvent(r'$feature_view', flag, flagVariant);

@override
Future<void> captureFeatureInteraction({
required String flag,
String? flagVariant,
}) =>
_captureFeatureEvent(r'$feature_interaction', flag, flagVariant);

Future<void> _captureFeatureEvent(
String event,
String flag,
String? flagVariant,
) async {
final screenName = _currentScreen;
final result = flagVariant == null
? await getFeatureFlagResult(key: flag, sendEvent: false)
: null;
final captured = featureEvent(
event, flag, flagVariant ?? result?.variant ?? result?.enabled);
if (captured == null) return;
await capture(
eventName: event,
properties: {
...captured.properties,
if (screenName != null) PostHogPropertyName.screenName: screenName,
},
userProperties: captured.userProperties,
);
}

@override
Future<void> reset() async {
return handleWebMethodCall(const MethodCall('reset'));
Expand Down Expand Up @@ -430,6 +473,7 @@ class PosthogFlutterWeb extends PosthogFlutterPlatformInterface {

@override
Future<void> close() async {
_currentScreen = null;
return handleWebMethodCall(const MethodCall('close'));
}

Expand Down
Loading
Loading