fix(cursor): address sizing and capture review findings

flutter/test/cursor_local_size_test.dart

@@ -25,15 +25,17 @@ class _Image extends ChangeNotifier implements ImageModel {
 }
 
 class _Canvas extends ChangeNotifier implements CanvasModel {
-  _Canvas(this.devicePixelRatio);
+  _Canvas(this.devicePixelRatio, {required this.style, required this.scale});
+
+  final String style;
 
   @override
   final double devicePixelRatio;
   @override
   final imageOverflow = false.obs;
   @override
-  final viewStyle = ViewStyle(
-    style: kRemoteViewStyleAdaptive,
+  late final viewStyle = ViewStyle(
+    style: style,
     width: _viewport.width,
     height: _viewport.height,
     displayWidth: 400,
@@ -44,7 +46,7 @@ class _Canvas extends ChangeNotifier implements CanvasModel {
   @override
   Size get size => _viewport;
   @override
-  double get scale => 0.5;
+  final double scale;
   @override
   double get x => 0;
   @override
@@ -200,8 +202,15 @@ void main() {
     if (Platform.isWindows) expect(cursor.data!.length, 25 * 34 * 4);
   });
 
-  for (final dpr in [1.0, 2.0, 3.0]) {
-    testWidgets('Zoom off at local DPR $dpr ignores remote raster density',
+  for (final (dpr, style, scale) in [
+    for (final dpr in [1.0, 2.0, 3.0])
+      for (final (style, scale) in [
+        (kRemoteViewStyleAdaptive, 0.5),
+        (kRemoteViewStyleCustom, 0.25),
+        (kRemoteViewStyleCustom, 2.0),
+      ]) (dpr, style, scale),
+  ]) {
+    testWidgets('$style scale=$scale DPR=$dpr preserves local size and hotspot',
         (tester) async {
       final channel = Platform.isWindows
           ? SystemChannels.mouseCursor
@@ -227,18 +236,20 @@ void main() {
       addTearDown(() => tester.binding.defaultBinaryMessenger
           .setMockMethodCallHandler(sizeChannel, null));
       final cursor = _Cursor(_arrow(1));
+      final zoom = false.obs;
       await tester.pumpWidget(MediaQuery(
         data: MediaQueryData(devicePixelRatio: dpr),
         child: MultiProvider(
           providers: [
             ChangeNotifierProvider<ImageModel>(create: (_) => _Image()),
-            ChangeNotifierProvider<CanvasModel>(create: (_) => _Canvas(dpr)),
+            ChangeNotifierProvider<CanvasModel>(
+                create: (_) => _Canvas(dpr, style: style, scale: scale)),
             ChangeNotifierProvider<CursorModel>.value(value: cursor),
           ],
           child: ImagePaint(
             ffi: _FFI(),
             id: 'local-size-test',
-            zoomCursor: false.obs,
+            zoomCursor: zoom,
             cursorOverImage: true.obs,
             keyboardEnabled: true.obs,
             remoteCursorMoved: false.obs,
@@ -246,12 +257,14 @@ void main() {
         ),
       ));
       await tester.pump();
-      expect(registered, hasLength(1));
-      final original = registered.single;
+      expect(registered, isNotEmpty);
+      expect(cursor.cache.localSize, Platform.isWindows ? 23.0 * dpr : 23.0);
+      final original = registered.last;
+      final beforeDensityChange = registered.length;
       cursor.cache = _arrow(2);
       cursor.notifyListeners();
       await tester.pump();
-      expect(registered, hasLength(2));
+      expect(registered, hasLength(beforeDensityChange + 1));
       final retina = registered.last;
       expect(
         [retina['width'], retina['height'], retina['hotX'], retina['hotY']],
@@ -264,6 +277,14 @@ void main() {
         reason: 'Only the remote raster density changed; the local cursor must '
             'retain its size and hotspot.',
       );
+      zoom.value = true;
+      await tester.pump();
+      expect(cursor.cache.localSize, isNull);
+      final zoomScale = scale * (Platform.isWindows ? dpr : 1);
+      expect(cursor.cache.scale,
+          zoomScale < kMinCursorSize / 34 ? kMinCursorSize / 34 : zoomScale);
+      expect(cursor.cache.hotx / cursor.cache.scaledWidth, closeTo(4 / 17, 1e-9));
+      expect(cursor.cache.hoty / cursor.cache.scaledHeight, closeTo(4 / 23, 1e-9));
       await tester.pumpWidget(const SizedBox.shrink());
       cursor.dispose();
     });

flutter/test/cursor_measurement_failure_test.dart

@@ -0,0 +1,181 @@
+import 'dart:async';
+import 'dart:io';
+import 'dart:ui' as ui;
+
+import 'package:flutter/services.dart';
+import 'package:flutter/widgets.dart';
+import 'package:flutter_hbb/consts.dart';
+import 'package:flutter_hbb/desktop/pages/remote_page.dart';
+import 'package:flutter_hbb/models/input_model.dart';
+import 'package:flutter_hbb/models/model.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:get/get.dart';
+import 'package:image/image.dart' as img;
+import 'package:provider/provider.dart';
+
+const _viewport = Size(200, 160);
+
+class _Image extends ChangeNotifier implements ImageModel {
+  @override
+  bool get useTextureRender => false;
+  @override
+  ui.Image? get image => null;
+  @override
+  dynamic noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
+}
+
+class _Canvas extends ChangeNotifier implements CanvasModel {
+  _Canvas(this.devicePixelRatio, {required this.style, required this.scale});
+
+  final String style;
+
+  @override
+  final double devicePixelRatio;
+  @override
+  final imageOverflow = false.obs;
+  @override
+  late final viewStyle = ViewStyle(
+    style: style,
+    width: _viewport.width,
+    height: _viewport.height,
+    displayWidth: 400,
+    displayHeight: 320,
+  );
+  @override
+  bool get cursorEmbedded => false;
+  @override
+  Size get size => _viewport;
+  @override
+  final double scale;
+  @override
+  double get x => 0;
+  @override
+  double get y => 0;
+  @override
+  dynamic noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
+}
+
+class _Cursor extends ChangeNotifier implements CursorModel {
+  _Cursor(this.cache);
+
+  @override
+  CursorData cache;
+  @override
+  ui.Image? get image => null;
+  @override
+  double get hotx => cache.hotxOrigin;
+  @override
+  double get hoty => cache.hotyOrigin;
+  @override
+  final Set<String> cachedKeys = {};
+  @override
+  void addKey(String key) => cachedKeys.add(key);
+  @override
+  dynamic noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
+}
+
+class _Input extends Fake implements InputModel {
+  @override
+  final relativeMouseMode = false.obs;
+}
+
+class _Peer extends Fake implements FfiModel {
+  @override
+  final pi = PeerInfo();
+  @override
+  bool get isPeerLinux => false;
+}
+
+class _FFI extends Fake implements FFI {
+  @override
+  final inputModel = _Input();
+  @override
+  final ffiModel = _Peer();
+}
+
+CursorData _cursor(img.Image image,
+    {String id = 'sprite', double hotspot = 0}) {
+  return CursorData(
+    peerId: 'local-size-test',
+    id: id,
+    image: image,
+    scale: 1,
+    data: Platform.isWindows
+        ? image.getBytes(order: img.ChannelOrder.bgra)
+        : Uint8List.fromList(img.encodePng(image)),
+    hotxOrigin: hotspot,
+    hotyOrigin: hotspot,
+    width: image.width,
+    height: image.height,
+  );
+}
+
+CursorData _arrow(int density) {
+  final image =
+      img.Image(width: 17 * density, height: 23 * density, numChannels: 4);
+  img.fill(image, color: img.ColorRgba8(255, 255, 255, 255));
+  return _cursor(image, id: 'arrow-$density', hotspot: 4.0 * density);
+}
+
+void main() {
+  testWidgets('pending or failed size measurement preserves the remote cursor',
+      (tester) async {
+    final channel = Platform.isWindows
+        ? SystemChannels.mouseCursor
+        : const MethodChannel('flutter_custom_cursor');
+    final registered = <Map<dynamic, dynamic>>[];
+    tester.binding.defaultBinaryMessenger.setMockMethodCallHandler(channel,
+        (call) async {
+      if (call.method.startsWith('createCustomCursor')) {
+        final arguments = call.arguments as Map<dynamic, dynamic>;
+        registered.add(arguments);
+        return arguments['name'];
+      }
+      return null;
+    });
+    addTearDown(() => tester.binding.defaultBinaryMessenger
+        .setMockMethodCallHandler(channel, null));
+    const sizeChannel = MethodChannel('org.rustdesk.rustdesk/cursor');
+    final measurement = Completer<double>();
+    tester.binding.defaultBinaryMessenger
+        .setMockMethodCallHandler(sizeChannel, (_) => measurement.future);
+    addTearDown(() => tester.binding.defaultBinaryMessenger
+        .setMockMethodCallHandler(sizeChannel, null));
+    final cursor = _Cursor(_arrow(2));
+    await tester.pumpWidget(_view(cursor));
+    expect(registered, isNotEmpty);
+    measurement.completeError(PlatformException(code: 'cursor_size'));
+    await tester.pump();
+    expect(tester.takeException(), isA<PlatformException>());
+    expect(cursor.cache.localSize, isNull);
+    final scale = Platform.isWindows ? 1.0 : 0.5;
+    expect(cursor.cache.scaledWidth, 34 * scale);
+    expect(cursor.cache.scaledHeight, 46 * scale);
+    expect(cursor.cache.hotx, 8 * scale);
+    expect(cursor.cache.hoty, 8 * scale);
+    expect(registered.last['hotX'], 8 * scale);
+    expect(registered.last['hotY'], 8 * scale);
+    await tester.pumpWidget(const SizedBox.shrink());
+    cursor.dispose();
+  });
+}
+
+Widget _view(_Cursor cursor) => MediaQuery(
+      data: const MediaQueryData(devicePixelRatio: 2),
+      child: MultiProvider(
+        providers: [
+          ChangeNotifierProvider<ImageModel>(create: (_) => _Image()),
+          ChangeNotifierProvider<CanvasModel>(create: (_) => _Canvas(2,
+              style: kRemoteViewStyleAdaptive, scale: 0.25)),
+          ChangeNotifierProvider<CursorModel>.value(value: cursor),
+        ],
+        child: ImagePaint(
+          ffi: _FFI(),
+          id: 'measurement-failure-test',
+          zoomCursor: false.obs,
+          cursorOverImage: true.obs,
+          keyboardEnabled: true.obs,
+          remoteCursorMoved: false.obs,
+        ),
+      ),
+    );

flutter/test/cursor_paint_scale_test.dart

@@ -107,6 +107,10 @@ void main() {
     (kRemoteViewStyleAdaptive, true, 3.0, (48, 64), 0.375, 0.375, true),
     (kRemoteViewStyleOriginal, false, 2.0, (48, 64), 0.5, 0.5, true),
     (kRemoteViewStyleOriginal, true, 2.0, (48, 64), 0.5, 0.5, true),
+    for (final zoom in [false, true])
+      for (final scale in [0.25, 2.0])
+        for (final texture in [false, true])
+          (kRemoteViewStyleCustom, zoom, 2.0, (48, 64), scale, scale, texture),
     (
       kRemoteViewStyleAdaptive,
       false,

flutter/test/cursor_resize_limit_test.dart

@@ -0,0 +1,43 @@
+import 'dart:math';
+import 'dart:typed_data';
+
+import 'package:flutter/foundation.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:flutter_hbb/models/model.dart';
+import 'package:image/image.dart' as img;
+
+void main() {
+  TestWidgetsFlutterBinding.ensureInitialized();
+
+  test('sparse remote artwork cannot amplify the native bitmap without limit',
+      () {
+    const sourceSize = 64;
+    const bitmapLimit = 512;
+    final image = img.Image(width: sourceSize, height: sourceSize, numChannels: 4)
+      ..setPixelRgba(0, 0, 255, 255, 255, 255);
+    final cache = CursorData(
+      peerId: 'sparse-cursor',
+      id: '1',
+      image: image,
+      scale: 1,
+      data: Uint8List.fromList(img.encodePng(image)),
+      hotxOrigin: 32,
+      hotyOrigin: 48,
+      width: sourceSize,
+      height: sourceSize,
+    )..localSize = sourceSize.toDouble();
+    final messages = <String>[];
+    final previous = debugPrint;
+    debugPrint = (String? message, {int? wrapWidth}) {
+      messages.add(message ?? '');
+    };
+    addTearDown(() => debugPrint = previous);
+
+    cache.updateGetKey(1);
+
+    expect(max(cache.scaledWidth, cache.scaledHeight), bitmapLimit);
+    expect(cache.hotx, 32 * cache.scaledWidth / sourceSize);
+    expect(cache.hoty, 48 * cache.scaledHeight / sourceSize);
+    expect(messages.single, contains('bitmap limit'));
+  });
+}