PR updates

Author: angelosilvestre

lib/src/goldens/golden_collections.dart

@@ -13,15 +13,10 @@ import 'package:image/image.dart' as img;
 /// corresponding golden image.
 /// {@endtemplate}
 class GoldenCollection {
-  GoldenCollection(
-    this.imagesById, {
-    required this.metadata,
-  });
+  GoldenCollection(this.imagesById);
 
   final Map<String, GoldenImage> imagesById;
 
-  final GoldenSceneMetadata metadata;
-
   List<String> get ids => imagesById.keys.toList(growable: false);
 
   bool hasId(String id) => imagesById[id] != null;

lib/src/goldens/golden_scenes.dart

@@ -15,7 +15,7 @@ import 'package:image/image.dart';
 ///
 /// This function loads the scene image from the [file], extracts each individual golden
 /// image from the scene, and then returns all of those golden images as a [GoldenCollection].
-GoldenCollection extractGoldenCollectionFromSceneFile(File file) {
+(GoldenCollection, GoldenSceneMetadata) extractGoldenCollectionFromSceneFile(File file) {
   FtgLog.pipeline.fine("Extracting golden collection from golden image.");
 
   // Read the scene PNG data into memory.
@@ -38,7 +38,7 @@ GoldenCollection extractGoldenCollectionFromSceneFile(File file) {
   }
 
   // Extract the golden images from the scene image.
-  return _extractCollectionFromScene(sceneMetadata, sceneImage);
+  return (_extractCollectionFromScene(sceneMetadata, sceneImage), sceneMetadata);
 }
 
 /// Extracts a [GoldenCollection] from a golden scene within the current widget tree.
@@ -100,10 +100,7 @@ GoldenCollection _extractCollectionFromScene(GoldenSceneMetadata sceneMetadata,
     );
   }
 
-  return GoldenCollection(
-    goldenImages,
-    metadata: sceneMetadata,
-  );
+  return GoldenCollection(goldenImages);
 }
 
 RenderRepaintBoundary? _findNearestRepaintBoundary(Finder bounds) {
@@ -131,6 +128,7 @@ RenderRepaintBoundary? _findNearestRepaintBoundary(Finder bounds) {
 class GoldenSceneMetadata {
   static GoldenSceneMetadata fromJson(Map<String, dynamic> json) {
     return GoldenSceneMetadata(
+      description: json["description"] ?? "",
       images: [
         for (final imageJson in (json["images"] as List<dynamic>)) //
           GoldenImageMetadata.fromJson(imageJson),
@@ -139,13 +137,16 @@ class GoldenSceneMetadata {
   }
 
   const GoldenSceneMetadata({
+    required this.description,
     required this.images,
   });
 
+  final String description;
   final List<GoldenImageMetadata> images;
 
   Map<String, dynamic> toJson() {
     return {
+      "description": description,
       "images": images.map((image) => image.toJson()).toList(growable: false),
     };
   }

lib/src/scenes/film_strip.dart

@@ -277,6 +277,7 @@ class FilmStrip {
     // Lookup and return metadata for the position and size of each golden image
     // within the gallery.
     return GoldenSceneMetadata(
+      description: goldenName,
       images: [
         for (final golden in renderablePhotos.keys)
           GoldenImageMetadata(
@@ -339,7 +340,7 @@ class FilmStrip {
       // TODO: report error in structured way.
       throw Exception("Can't compare goldens. Golden file doesn't exist: ${goldenFile.path}");
     }
-    final goldenCollection = extractGoldenCollectionFromSceneFile(goldenFile);
+    final (goldenCollection, metadata) = extractGoldenCollectionFromSceneFile(goldenFile);
 
     FtgLog.pipeline.fine("Extracting golden collection from current widget tree (screenshots).");
     late final GoldenCollection screenshotCollection;

lib/src/scenes/gallery.dart

@@ -396,6 +396,7 @@ class Gallery {
     // Lookup and return metadata for the position and size of each golden image
     // within the gallery.
     return GoldenSceneMetadata(
+      description: _sceneDescription,
       images: [
         for (final golden in renderablePhotos.keys)
           GoldenImageMetadata(
@@ -459,7 +460,7 @@ class Gallery {
       // TODO: report error in structured way.
       throw Exception("Can't compare goldens. Golden file doesn't exist: ${goldenFile.path}");
     }
-    final goldenCollection = extractGoldenCollectionFromSceneFile(goldenFile);
+    final (goldenCollection, metadata) = extractGoldenCollectionFromSceneFile(goldenFile);
 
     // Extract scene metadata from the current widget tree.
     FtgLog.pipeline.fine("Extracting golden collection from current widget tree (screenshots).");
@@ -505,21 +506,15 @@ class Gallery {
         // The golden check passed.
         items.add(
           GoldenReport.success(
-            goldenCollection.metadata.images.where((image) => image.id == screenshotId).first,
+            metadata.images.where((image) => image.id == screenshotId).first,
           ),
         );
       } else {
         // The golden check failed.
         items.add(
           GoldenReport.failure(
-            metadata: goldenCollection.metadata.images.where((image) => image.id == screenshotId).first,
-            details: [
-              GoldenCheckDetail(
-                status: GoldenTestStatus.failure,
-                description: mismatch.toString(),
-                mismatch: mismatch,
-              ),
-            ],
+            metadata: metadata.images.where((image) => image.id == screenshotId).first,
+            mismatch: mismatch,
           ),
         );
       }
@@ -548,8 +543,8 @@ class Gallery {
     }
 
     final report = GoldenSceneReport(
-      sceneDescription: _sceneDescription,
-      metadata: goldenCollection.metadata,
+      //sceneDescription: _sceneDescription,
+      metadata: metadata,
       items: items,
       missingCandidates: missingCandidates,
       extraCandidates: extraCandidates,

lib/src/scenes/golden_scene.dart

@@ -119,16 +119,12 @@ typedef GoldenSetup = FutureOr<void> Function(WidgetTester tester);
 /// the missing candidates and candidates that have no corresponding golden.
 class GoldenSceneReport {
   GoldenSceneReport({
-    required this.sceneDescription,
     required this.metadata,
     required this.items,
     required this.missingCandidates,
     required this.extraCandidates,
   });
 
-  /// The human readable description of the scene.
-  final String sceneDescription;
-
   /// The metadata of the scene, such as the golden images and their positions.
   final GoldenSceneMetadata metadata;
 
@@ -159,51 +155,38 @@ class GoldenReport {
     return GoldenReport(
       status: GoldenTestStatus.success,
       metadata: metadata,
-      details: [],
     );
   }
 
   factory GoldenReport.failure({
     required GoldenImageMetadata metadata,
-    required List<GoldenCheckDetail> details,
+    required GoldenMismatch mismatch,
   }) {
     return GoldenReport(
       status: GoldenTestStatus.failure,
       metadata: metadata,
-      details: details,
+      mismatch: mismatch,
     );
   }
 
   GoldenReport({
     required this.status,
     required this.metadata,
-    required this.details,
-  });
+    this.mismatch,
+  }) : assert(
+          status == GoldenTestStatus.success || mismatch != null,
+          "A failure report must have a mismatch.",
+        );
 
   /// Whether the gallery item passed or failed the golden check.
   final GoldenTestStatus status;
 
   /// The metadata of the candidate image of this report.
   final GoldenImageMetadata metadata;
 
-  /// The details of the golden check for this item.
+  /// The failure details of the gallery item, if it failed the golden check.
   ///
-  /// Might contain both successful and failed checks.
-  final List<GoldenCheckDetail> details;
-}
-
-class GoldenCheckDetail {
-  GoldenCheckDetail({
-    required this.status,
-    required this.description,
-    this.mismatch,
-  }) : assert(
-          status != GoldenTestStatus.success || mismatch == null,
-          "A successful golden test cannot have a mismatch",
-        );
-
-  final GoldenTestStatus status;
-  final String description;
+  /// Non-`null` if [status] is [GoldenTestStatus.failure] and `null` otherwise.
   final GoldenMismatch? mismatch;
 }
 

lib/src/scenes/golden_scene_report_printer.dart

@@ -12,7 +12,7 @@ class GoldenSceneReportPrinter {
     final buffer = StringBuffer();
 
     // Report the summary of passed/failed tests and missing/extra candidates.
-    buffer.write("Golden scene has failures: ${report.sceneDescription} (");
+    buffer.write("Golden scene has failures: ${report.metadata.description} (");
     buffer.write("✅ ${report.totalPassed}/${report.items.length}, ");
     buffer.write("❌ ${report.totalFailed}/${report.items.length}");
     if (report.missingCandidates.isNotEmpty || report.extraCandidates.isNotEmpty) {
@@ -40,11 +40,7 @@ class GoldenSceneReportPrinter {
         }
 
         // This item has a failed check.
-        final mismatch = item.details //
-            .where((detail) => detail.mismatch != null)
-            .firstOrNull
-            ?.mismatch;
-
+        final mismatch = item.mismatch;
         switch (mismatch) {
           case WrongSizeGoldenMismatch():
             buffer.writeln(