[Fix] Hydrating snapshots for document download (#11540)

* improve localized enum assertion * add empty string regression test (cherry picked from commit e166554)
GCTC-NTGC · Sep 18, 2024 · eb5b553 · eb5b553
1 parent 3cafeb6
commit eb5b553
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/api/app/Traits/HydratesSnapshot.php b/api/app/Traits/HydratesSnapshot.php
@@ -22,6 +22,10 @@ abstract public static function hydrateSnapshot(mixed $snapshot): Model|array;
 
     public static function isFieldLocalizedEnum(mixed $snapshot, mixed $snapshotField): bool
     {
+        if (! isset($snapshot[$snapshotField]) || is_string($snapshot[$snapshotField])) {
+            return false;
+        }
+
         // validator for a single localized enum
         $singleEnumValidator = Validator::make($snapshot, [
             $snapshotField.'.value' => 'required|string',

diff --git a/api/tests/Feature/SnapshotTest.php b/api/tests/Feature/SnapshotTest.php
@@ -212,6 +212,13 @@ public function testLocalizingLegacyEnums()
                         ),
                     ],
                 ],
+                // Empty string details
+                // NOTE: Regression test for empty strings treated as localized enums
+                'experiences' => [
+                    [
+                        'details' => '',
+                    ],
+                ],
             ],
         ]);
 
@@ -235,6 +242,12 @@ public function testLocalizingLegacyEnums()
                     'label' => OperationalRequirement::localizedString(OperationalRequirement::ON_CALL->name),
                 ],
             ],
+            // Empty string details
+            'experiences' => [
+                [
+                    'details' => '',
+                ],
+            ],
         ], $snapshot);
     }
 }