-
Notifications
You must be signed in to change notification settings - Fork 67
Expand file tree
/
Copy pathposthog_flutter_io.dart
More file actions
685 lines (596 loc) · 19.4 KB
/
posthog_flutter_io.dart
File metadata and controls
685 lines (596 loc) · 19.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
import 'dart:async';
import 'util/platform_io_stub.dart'
if (dart.library.io) 'util/platform_io_real.dart';
import 'package:flutter/services.dart';
import 'package:posthog_flutter/src/surveys/survey_service.dart';
import 'package:posthog_flutter/src/util/logging.dart';
import 'surveys/models/posthog_display_survey.dart' as models;
import 'surveys/models/survey_callbacks.dart';
import 'error_tracking/dart_exception_processor.dart';
import 'utils/capture_utils.dart';
import 'utils/property_normalizer.dart';
import 'feature_flag_result.dart';
import 'posthog_config.dart';
import 'posthog_constants.dart';
import 'posthog_event.dart';
import 'posthog_flutter_platform_interface.dart';
/// An implementation of [PosthogFlutterPlatformInterface] that uses method channels.
class PosthogFlutterIO extends PosthogFlutterPlatformInterface {
PosthogFlutterIO() {
_methodChannel.setMethodCallHandler(_handleMethodCall);
}
/// The method channel used to interact with the native platform.
final _methodChannel = const MethodChannel('posthog_flutter');
OnFeatureFlagsCallback? _onFeatureFlagsCallback;
/// Stored configuration for accessing inAppIncludes and other settings
PostHogConfig? _config;
/// Stored beforeSend callbacks for dropping/modifying events
List<BeforeSendCallback> _beforeSendCallbacks = [];
/// Applies the beforeSend callbacks to an event in order.
/// Returns the possibly modified event, or null if any callback drops it.
Future<PostHogEvent?> _runBeforeSend(
String eventName,
Map<String, Object>? properties, {
Map<String, Object>? userProperties,
Map<String, Object>? userPropertiesSetOnce,
}) async {
var event = PostHogEvent(
event: eventName,
properties: properties,
userProperties: userProperties,
userPropertiesSetOnce: userPropertiesSetOnce,
);
if (_beforeSendCallbacks.isEmpty) return event;
for (final callback in _beforeSendCallbacks) {
final result = await _applyBeforeSendCallback(callback, event);
if (result == null) return null;
event = result;
}
return event;
}
/// Applies a single beforeSend callback safely.
/// Returns null if event should be dropped, otherwise returns the (possibly modified) event.
/// Handles both synchronous and asynchronous callbacks via FutureOr.
Future<PostHogEvent?> _applyBeforeSendCallback(
BeforeSendCallback callback, PostHogEvent event) async {
try {
final callbackResult = callback(event);
if (callbackResult is Future<PostHogEvent?>) {
return await callbackResult;
}
return callbackResult;
} catch (e) {
printIfDebug('[PostHog] beforeSend callback threw exception: $e');
return event;
}
}
/// Native plugin calls to Flutter
///
Future<dynamic> _handleMethodCall(MethodCall call) async {
switch (call.method) {
case 'showSurvey':
final survey = Map<String, dynamic>.from(call.arguments);
return showSurvey(survey);
case 'hideSurveys':
await cleanupSurveys();
return null;
case 'onFeatureFlagsCallback':
_onFeatureFlagsCallback?.call();
break;
default:
printIfDebug(
'[PostHog] ${call.method} not implemented in PosthogFlutterPlatformInterface');
return null;
}
}
@override
Future<void> showSurvey(Map<String, dynamic> survey) async {
if (!isSupportedPlatform()) {
printIfDebug('Cannot show survey: Platform is not supported');
return;
}
final widget = PosthogFlutterPlatformInterface.instance;
if (widget is! PosthogFlutterIO) {
printIfDebug(
'Cannot show survey: PosthogFlutterPlatformInterface instance is not PosthogFlutterIO');
return;
}
final displaySurvey = models.PostHogDisplaySurvey.fromDict(survey);
// Try to show using SurveyService
// This will work if the user has set up the PosthogObserver correctly in their app
await SurveyService().showSurvey(
displaySurvey,
(survey) async {
// onShown
try {
await _methodChannel.invokeMethod('surveyAction', {'type': 'shown'});
} on PlatformException catch (exception) {
printIfDebug('Exception on surveyAction(shown): $exception');
}
},
(survey, index, response) async {
// onResponse
int nextIndex = index;
bool isSurveyCompleted = false;
try {
final result = await _methodChannel.invokeMethod('surveyAction', {
'type': 'response',
'index': index,
'response': response,
}) as Map;
nextIndex = (result['nextIndex'] as num).toInt();
isSurveyCompleted = result['isSurveyCompleted'] as bool;
} on PlatformException catch (exception) {
printIfDebug('Exception on surveyAction(response): $exception');
}
final nextQuestion = PostHogSurveyNextQuestion(
questionIndex: nextIndex,
isSurveyCompleted: isSurveyCompleted,
);
return nextQuestion;
},
(survey) async {
// onClose
try {
await _methodChannel.invokeMethod('surveyAction', {'type': 'closed'});
} on PlatformException catch (exception) {
printIfDebug('Exception on surveyAction(closed): $exception');
}
},
);
}
/// Cleans up any active surveys when the survey feature is stopped
Future<void> cleanupSurveys() async {
if (!isSupportedPlatform()) {
printIfDebug('Cannot cleanup surveys: Platform is not supported');
return;
}
SurveyService().hideSurvey();
}
/// Flutter to Native Calls
///
@override
Future<void> setup(PostHogConfig config) async {
// Store config for later use in exception processing
_config = config;
if (!isSupportedPlatform()) {
return;
}
_onFeatureFlagsCallback = config.onFeatureFlags;
_beforeSendCallbacks = config.beforeSend;
try {
await _methodChannel.invokeMethod('setup', config.toMap());
} on PlatformException catch (exception) {
printIfDebug('Exeption on setup: $exception');
}
}
@override
Future<void> identify({
required String userId,
Map<String, Object>? userProperties,
Map<String, Object>? userPropertiesSetOnce,
}) async {
if (!isSupportedPlatform()) {
return;
}
try {
final normalizedUserProperties = userProperties != null
? PropertyNormalizer.normalize(userProperties)
: null;
final normalizedUserPropertiesSetOnce = userPropertiesSetOnce != null
? PropertyNormalizer.normalize(userPropertiesSetOnce)
: null;
await _methodChannel.invokeMethod('identify', {
'userId': userId,
if (normalizedUserProperties != null)
'userProperties': normalizedUserProperties,
if (normalizedUserPropertiesSetOnce != null)
'userPropertiesSetOnce': normalizedUserPropertiesSetOnce,
});
} on PlatformException catch (exception) {
printIfDebug('Exeption on identify: $exception');
}
}
@override
Future<void> capture({
required String eventName,
Map<String, Object>? properties,
Map<String, Object>? userProperties,
Map<String, Object>? userPropertiesSetOnce,
}) async {
if (!isSupportedPlatform()) {
return;
}
// Apply beforeSend callback
final processedEvent = await _runBeforeSend(
eventName,
properties,
userProperties: userProperties,
userPropertiesSetOnce: userPropertiesSetOnce,
);
if (processedEvent == null) {
printIfDebug('[PostHog] Event dropped by beforeSend: $eventName');
return;
}
try {
// Use processed event properties (potentially modified by beforeSend)
final extracted = CaptureUtils.extractUserProperties(
properties: processedEvent.properties,
userProperties: processedEvent.userProperties,
userPropertiesSetOnce: processedEvent.userPropertiesSetOnce,
);
final extractedProperties = extracted.properties;
final extractedUserProperties = extracted.userProperties;
final extractedUserPropertiesSetOnce = extracted.userPropertiesSetOnce;
final normalizedProperties = extractedProperties != null
? PropertyNormalizer.normalize(extractedProperties)
: null;
final normalizedUserProperties = extractedUserProperties != null
? PropertyNormalizer.normalize(extractedUserProperties)
: null;
final normalizedUserPropertiesSetOnce =
extractedUserPropertiesSetOnce != null
? PropertyNormalizer.normalize(extractedUserPropertiesSetOnce)
: null;
await _methodChannel.invokeMethod('capture', {
'eventName': processedEvent.event,
if (normalizedProperties != null) 'properties': normalizedProperties,
if (normalizedUserProperties != null)
'userProperties': normalizedUserProperties,
if (normalizedUserPropertiesSetOnce != null)
'userPropertiesSetOnce': normalizedUserPropertiesSetOnce,
});
} on PlatformException catch (exception) {
printIfDebug('Exeption on capture: $exception');
}
}
@override
Future<void> screen({
required String screenName,
Map<String, Object>? properties,
}) async {
if (!isSupportedPlatform()) {
return;
}
// Add screenName as $screen_name property for beforeSend
final propsWithScreenName = <String, Object>{
PostHogPropertyName.screenName: screenName,
...?properties,
};
// Apply beforeSend callback - screen events are captured as $screen
final processedEvent =
await _runBeforeSend(PostHogEventName.screen, propsWithScreenName);
if (processedEvent == null) {
printIfDebug('[PostHog] Screen event dropped by beforeSend: $screenName');
return;
}
// If event name was changed, use regular capture() instead
if (processedEvent.event != PostHogEventName.screen) {
await capture(
eventName: processedEvent.event,
properties: processedEvent.properties?.cast<String, Object>(),
);
return;
}
// Get the (possibly modified) screen name from properties and remove it
final finalScreenName =
processedEvent.properties?[PostHogPropertyName.screenName] as String? ??
screenName;
// It will be added back by native sdk
processedEvent.properties?.remove(PostHogPropertyName.screenName);
try {
final normalizedProperties = processedEvent.properties?.isNotEmpty == true
? PropertyNormalizer.normalize(
processedEvent.properties!.cast<String, Object>())
: null;
await _methodChannel.invokeMethod('screen', {
'screenName': finalScreenName,
if (normalizedProperties != null) 'properties': normalizedProperties,
});
} on PlatformException catch (exception) {
printIfDebug('Exeption on screen: $exception');
}
}
@override
Future<void> alias({
required String alias,
}) async {
if (!isSupportedPlatform()) {
return;
}
try {
await _methodChannel.invokeMethod('alias', {
'alias': alias,
});
} on PlatformException catch (exception) {
printIfDebug('Exeption on alias: $exception');
}
}
@override
Future<String> getDistinctId() async {
if (!isSupportedPlatform()) {
return "";
}
try {
return await _methodChannel.invokeMethod('distinctId');
} on PlatformException catch (exception) {
printIfDebug('Exeption on getDistinctId: $exception');
return "";
}
}
@override
Future<void> reset() async {
if (!isSupportedPlatform()) {
return;
}
try {
await _methodChannel.invokeMethod('reset');
} on PlatformException catch (exception) {
printIfDebug('Exeption on reset: $exception');
}
}
@override
Future<void> disable() async {
if (!isSupportedPlatform()) {
return;
}
try {
await _methodChannel.invokeMethod('disable');
} on PlatformException catch (exception) {
printIfDebug('Exeption on disable: $exception');
}
}
@override
Future<void> enable() async {
if (!isSupportedPlatform()) {
return;
}
try {
await _methodChannel.invokeMethod('enable');
} on PlatformException catch (exception) {
printIfDebug('Exeption on enable: $exception');
}
}
@override
Future<bool> isOptOut() async {
if (!isSupportedPlatform()) {
return true;
}
try {
final result = await _methodChannel.invokeMethod('isOptOut');
return result as bool? ?? true;
} on PlatformException catch (exception) {
printIfDebug('Exception on isOptOut: $exception');
return true;
}
}
@override
Future<void> debug(bool enabled) async {
if (!isSupportedPlatform()) {
return;
}
try {
await _methodChannel.invokeMethod('debug', {
'debug': enabled,
});
} on PlatformException catch (exception) {
printIfDebug('Exeption on debug: $exception');
}
}
@override
Future<bool> isFeatureEnabled(String key) async {
if (!isSupportedPlatform()) {
return false;
}
try {
return await _methodChannel.invokeMethod('isFeatureEnabled', {
'key': key,
});
} on PlatformException catch (exception) {
printIfDebug('Exeption on isFeatureEnabled: $exception');
return false;
}
}
@override
Future<void> reloadFeatureFlags() async {
if (!isSupportedPlatform()) {
return;
}
try {
await _methodChannel.invokeMethod('reloadFeatureFlags');
} on PlatformException catch (exception) {
printIfDebug('Exeption on reloadFeatureFlags: $exception');
}
}
@override
Future<void> group({
required String groupType,
required String groupKey,
Map<String, Object>? groupProperties,
}) async {
if (!isSupportedPlatform()) {
return;
}
try {
final normalizedGroupProperties = groupProperties != null
? PropertyNormalizer.normalize(groupProperties)
: null;
await _methodChannel.invokeMethod('group', {
'groupType': groupType,
'groupKey': groupKey,
if (normalizedGroupProperties != null)
'groupProperties': normalizedGroupProperties,
});
} on PlatformException catch (exception) {
printIfDebug('Exeption on group: $exception');
}
}
@override
Future<Object?> getFeatureFlag({
required String key,
}) async {
if (!isSupportedPlatform()) {
return null;
}
try {
return await _methodChannel.invokeMethod('getFeatureFlag', {
'key': key,
});
} on PlatformException catch (exception) {
printIfDebug('Exeption on getFeatureFlag: $exception');
return null;
}
}
@override
Future<Object?> getFeatureFlagPayload({
required String key,
}) async {
if (!isSupportedPlatform()) {
return null;
}
try {
return await _methodChannel.invokeMethod('getFeatureFlagPayload', {
'key': key,
});
} on PlatformException catch (exception) {
printIfDebug('Exeption on getFeatureFlagPayload: $exception');
return null;
}
}
@override
Future<PostHogFeatureFlagResult?> getFeatureFlagResult({
required String key,
bool sendEvent = true,
}) async {
if (!isSupportedPlatform()) {
return null;
}
try {
final result = await _methodChannel.invokeMethod('getFeatureFlagResult', {
'key': key,
'sendEvent': sendEvent,
});
// Native returns: { key, enabled, variant, payload }
return PostHogFeatureFlagResult.fromMap(result, key);
} on PlatformException catch (exception) {
printIfDebug('Exception on getFeatureFlagResult: $exception');
return null;
}
}
@override
Future<void> register(String key, Object value) async {
if (!isSupportedPlatform()) {
return;
}
try {
return await _methodChannel
.invokeMethod('register', {'key': key, 'value': value});
} on PlatformException catch (exception) {
printIfDebug('Exeption on register: $exception');
}
}
@override
Future<void> unregister(String key) async {
if (!isSupportedPlatform()) {
return;
}
try {
return await _methodChannel.invokeMethod('unregister', {'key': key});
} on PlatformException catch (exception) {
printIfDebug('Exeption on unregister: $exception');
}
}
@override
Future<void> flush() async {
if (!isSupportedPlatform()) {
return;
}
try {
return await _methodChannel.invokeMethod('flush');
} on PlatformException catch (exception) {
printIfDebug('Exeption on flush: $exception');
}
}
@override
Future<void> captureException(
{required Object error,
StackTrace? stackTrace,
Map<String, Object>? properties}) async {
if (!isSupportedPlatform()) {
return;
}
try {
final exceptionProps = DartExceptionProcessor.processException(
error: error,
stackTrace: stackTrace,
properties: properties,
inAppIncludes: _config?.errorTrackingConfig.inAppIncludes,
inAppExcludes: _config?.errorTrackingConfig.inAppExcludes,
inAppByDefault: _config?.errorTrackingConfig.inAppByDefault ?? true,
);
// Apply beforeSend callback - exception events are captured as $exception
final processedEvent = await _runBeforeSend(
PostHogEventName.exception, exceptionProps.cast<String, Object>());
if (processedEvent == null) {
printIfDebug(
'[PostHog] Exception event dropped by beforeSend: ${error.runtimeType}');
return;
}
// If event name was changed, use capture() instead
if (processedEvent.event != PostHogEventName.exception) {
await capture(
eventName: processedEvent.event,
properties: processedEvent.properties?.cast<String, Object>(),
);
return;
}
// Add timestamp from Flutter side (will be used and removed from native plugins)
final timestamp = DateTime.now().millisecondsSinceEpoch;
final normalizedData = processedEvent.properties != null
? PropertyNormalizer.normalize(
processedEvent.properties!.cast<String, Object>())
: <String, Object>{};
await _methodChannel.invokeMethod('captureException',
{'timestamp': timestamp, 'properties': normalizedData});
} on PlatformException catch (exception) {
printIfDebug('Exception in captureException: $exception');
}
}
@override
Future<void> close() async {
if (!isSupportedPlatform()) {
return;
}
try {
return await _methodChannel.invokeMethod('close');
} on PlatformException catch (exception) {
printIfDebug('Exeption on close: $exception');
}
}
@override
Future<String?> getSessionId() async {
if (!isSupportedPlatform()) {
return null;
}
try {
final sessionId = await _methodChannel.invokeMethod('getSessionId');
return sessionId;
} on PlatformException catch (exception) {
printIfDebug('Exception on getSessionId: $exception');
return null;
}
}
// For internal use
@override
Future<void> openUrl(String url) async {
if (!isSupportedPlatform()) {
printIfDebug('Cannot open url $url: Platform is not supported');
return;
}
try {
await _methodChannel.invokeMethod('openUrl', url);
} on PlatformException catch (exception) {
printIfDebug('Exception on openUrl: $exception');
}
}
}