Fixes issue where a incorrect key was being given to the ImageCache (#…

…1000) * Fixed the hashcode in SvgStringLoader and SvgBytesLoader. It was accidently using the svg global object, instead of a local field. This caused caches (such as PaintingBinding.instance.imageCache) to misbehave. * Add a test which ensures the embedded image in a SvgPicture is not incorrectly cached and carried over.
dnfield · Oct 17, 2023 · 16c062b · 16c062b
1 parent 6164f36
commit 16c062b
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 2 deletions.
diff --git a/packages/flutter_svg/lib/src/loaders.dart b/packages/flutter_svg/lib/src/loaders.dart
@@ -237,7 +237,7 @@ class SvgStringLoader extends SvgLoader<void> {
   }
 
   @override
-  int get hashCode => Object.hash(svg, theme, colorMapper);
+  int get hashCode => Object.hash(_svg, theme, colorMapper);
 
   @override
   bool operator ==(Object other) {
@@ -266,7 +266,7 @@ class SvgBytesLoader extends SvgLoader<void> {
   String provideSvg(void message) => utf8.decode(bytes, allowMalformed: true);
 
   @override
-  int get hashCode => Object.hash(svg, theme, colorMapper);
+  int get hashCode => Object.hash(bytes, theme, colorMapper);
 
   @override
   bool operator ==(Object other) {

diff --git a/packages/flutter_svg/test/golden_widget/image_blue.png b/packages/flutter_svg/test/golden_widget/image_blue.png
diff --git a/packages/flutter_svg/test/golden_widget/image_red.png b/packages/flutter_svg/test/golden_widget/image_red.png
diff --git a/packages/flutter_svg/test/widget_svg_test.dart b/packages/flutter_svg/test/widget_svg_test.dart
@@ -728,6 +728,54 @@ void main() {
       matchesGoldenFile('golden_widget/two_of_same.png'),
     );
   });
+
+  // This tests https://github.com/dnfield/flutter_svg/issues/990
+  // Where embedded images were being incorrectly cached.
+  testWidgets('SvgPicture - with cached images', (WidgetTester tester) async {
+    // Simple red and blue 10x10 squares.
+    // Borrowed from https://gist.github.com/ondrek/7413434?permalink_comment_id=4674255#gistcomment-4674255
+    final Map<String, String> images = <String, String>{
+      'red':
+          'iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mP8z8BQz0AEYBxVSF+FABJADveWkH6oAAAAAElFTkSuQmCC',
+      'blue':
+          'iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mNkYPhfz0AEYBxVSF+FAP5FDvcfRYWgAAAAAElFTkSuQmCC',
+    };
+
+    // We keep pumping widgets into the same tester, to ensure the same cache
+    // is used on each iteration.
+    for (final String key in images.keys) {
+      final String image = images[key]!;
+      final String svgStr = '''<svg
+        xmlns="http://www.w3.org/2000/svg"
+        xmlns:xlink="http://www.w3.org/1999/xlink" width="100" height="100">
+        <image width="100" height="100" href="data:image/png;base64,$image" />
+      </svg>''';
+
+      // First try with SvgPicture.string
+      await tester.pumpWidget(RepaintBoundary(
+        child: SvgPicture.string(svgStr),
+      ));
+      await tester.runAsync(() => vg.waitForPendingDecodes());
+      await tester.pumpAndSettle();
+
+      Finder widgetFinder = find.byType(SvgPicture);
+      expect(widgetFinder, findsOneWidget);
+      await expectLater(
+          widgetFinder, matchesGoldenFile('golden_widget/image_$key.png'));
+
+      // Then with SvgPicture.memory
+      await tester.pumpWidget(RepaintBoundary(
+        child: SvgPicture.memory(utf8.encode(svgStr) as Uint8List),
+      ));
+      await tester.runAsync(() => vg.waitForPendingDecodes());
+      await tester.pumpAndSettle();
+
+      widgetFinder = find.byType(SvgPicture);
+      expect(widgetFinder, findsOneWidget);
+      await expectLater(
+          widgetFinder, matchesGoldenFile('golden_widget/image_$key.png'));
+    }
+  });
 }
 
 class FakeAssetBundle extends Fake implements AssetBundle {