Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: do not send repeated snapshots #126

Merged
merged 5 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
20 changes: 19 additions & 1 deletion lib/src/posthog_widget_widget.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:posthog_flutter/posthog_flutter.dart';
import 'package:posthog_flutter/src/replay/mask/posthog_mask_controller.dart';
import 'package:posthog_flutter/src/replay/vendor/equality.dart';
import 'package:posthog_flutter/src/util/logging.dart';

import 'replay/change_detector.dart';
Expand All @@ -26,6 +27,7 @@ class PostHogWidgetState extends State<PostHogWidget> {
NativeCommunicator? _nativeCommunicator;

Timer? _debounceTimer;
Uint8List? _lastSnapshot;
Duration _debounceDuration = const Duration(milliseconds: 1000);

@override
Expand Down Expand Up @@ -75,17 +77,32 @@ class PostHogWidgetState extends State<PostHogWidget> {
screen: Posthog().currentScreen);
}

// TODO: package:image/image.dart to convert to jpeg instead
// using png because its compressed, the native SDKs will decompress it
// and transform to jpeg if needed (soon webp)
// https://github.com/brendan-duncan/image does not have webp encoding
final ByteData? byteData =
await imageInfo.image.toByteData(format: ui.ImageByteFormat.png);
if (byteData == null) {
printIfDebug('Error: Failed to convert image to byte data.');
imageInfo.image.dispose();
return;
}

Uint8List pngBytes = byteData.buffer.asUint8List();
imageInfo.image.dispose();

if (pngBytes.isEmpty) {
printIfDebug('Error: Failed to convert image byte data to Uint8List.');
return;
}

if (const PHListEquality().equals(pngBytes, _lastSnapshot)) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hard to tell the performance impact of that, can move to a background thread on the native side if needed

printIfDebug('Error: Snapshot is the same as the last one.');
return;
}

_lastSnapshot = pngBytes;

await _nativeCommunicator?.sendFullSnapshot(pngBytes,
id: imageInfo.id, x: imageInfo.x, y: imageInfo.y);
}
Expand All @@ -110,6 +127,7 @@ class PostHogWidgetState extends State<PostHogWidget> {
_changeDetector = null;
_screenshotCapturer = null;
_nativeCommunicator = null;
_lastSnapshot = null;

super.dispose();
}
Expand Down
101 changes: 101 additions & 0 deletions lib/src/replay/vendor/equality.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
// Copyright (c) 2013, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

// Adapted from https://github.com/dart-lang/core/blob/7f9f597e64fa52faebd3c0a2214f61a7b081174d/pkgs/collection/lib/src/equality.dart#L164

// ignore_for_file: library_private_types_in_public_api

const int _hashMask = 0x7fffffff;

/// A generic equality relation on objects.
abstract class _Equality<E> {
const factory _Equality() = _DefaultEquality<E>;

/// Compare two elements for being equal.
///
/// This should be a proper equality relation.
bool equals(E e1, E e2);

/// Get a hashcode of an element.
///
/// The hashcode should be compatible with [equals], so that if
/// `equals(a, b)` then `hash(a) == hash(b)`.
int hash(E e);

/// Test whether an object is a valid argument to [equals] and [hash].
///
/// Some implementations may be restricted to only work on specific types
/// of objects.
bool isValidKey(Object? o);
}

/// Equality of objects that compares only the natural equality of the objects.
///
/// This equality uses the objects' own [Object.==] and [Object.hashCode] for
/// the equality.
///
/// Note that [equals] and [hash] take `Object`s rather than `E`s. This allows
/// `E` to be inferred as `Null` in const contexts where `E` wouldn't be a
/// compile-time constant, while still allowing the class to be used at runtime.
class _DefaultEquality<E> implements _Equality<E> {
const _DefaultEquality();
@override
bool equals(Object? e1, Object? e2) => e1 == e2;
@override
int hash(Object? e) => e.hashCode;
@override
bool isValidKey(Object? o) => true;
}

/// Equality on lists.
///
/// Two lists are equal if they have the same length and their elements
/// at each index are equal.
///
/// This is effectively the same as [IterableEquality] except that it
/// accesses elements by index instead of through iteration.
///
/// The [equals] and [hash] methods accepts `null` values,
/// even if the [isValidKey] returns `false` for `null`.
/// The [hash] of `null` is `null.hashCode`.
class PHListEquality<E> implements _Equality<List<E>> {
final _Equality<E> _elementEquality;
const PHListEquality(
[_Equality<E> elementEquality = const _DefaultEquality<Never>()])
: _elementEquality = elementEquality;

@override
bool equals(List<E>? list1, List<E>? list2) {
if (identical(list1, list2)) return true;
if (list1 == null || list2 == null) return false;
var length = list1.length;
if (length != list2.length) return false;
for (var i = 0; i < length; i++) {
if (!_elementEquality.equals(list1[i], list2[i])) return false;
}
return true;
}

@override
int hash(List<E>? list) {
if (list == null) return null.hashCode;
// Jenkins's one-at-a-time hash function.
// This code is almost identical to the one in IterableEquality, except
// that it uses indexing instead of iterating to get the elements.
var hash = 0;
for (var i = 0; i < list.length; i++) {
var c = _elementEquality.hash(list[i]);
hash = (hash + c) & _hashMask;
hash = (hash + (hash << 10)) & _hashMask;
hash ^= hash >> 6;
}
hash = (hash + (hash << 3)) & _hashMask;
hash ^= hash >> 11;
hash = (hash + (hash << 15)) & _hashMask;
return hash;
}

@override
bool isValidKey(Object? o) => o is List<E>;
}
Loading