Merge pull request #368 from DEFRA/bug/FI0-11257-departure-weights-error-display

fix: NMD departure weights — error text, weight persistence and display after clearing (FI0-11257)

Author: salfedev

app/.server/storageDocument.ts

@@ -303,12 +303,16 @@ export const updateStorageDocumentCatchDepartureWeights = async (
       const netWeightProductDeparture = formData[`weight-net-weight-product-departure-${index}`];
       const netWeightFisheryProductDeparture = formData[`weight-net-weight-fishery-product-departure-${index}`];
       if (netWeightProductDeparture !== undefined && netWeightFisheryProductDeparture !== undefined) {
+        // Use null (not undefined) for empty values so the field is explicitly
+        // included in the JSON body. JSON.stringify silently drops undefined,
+        // which means the orchestration never receives the clearing intent and
+        // the old departure-weight value stays in MongoDB.
         catches[index]["netWeightProductDeparture"] = !isEmpty(netWeightProductDeparture)
           ? netWeightProductDeparture
-          : undefined;
+          : null;
         catches[index]["netWeightFisheryProductDeparture"] = !isEmpty(netWeightFisheryProductDeparture)
           ? netWeightFisheryProductDeparture
-          : undefined;
+          : null;
       }
     });
   } else {

app/routes/create-non-manipulation-document.$documentNumber.departure-product-summary.tsx

@@ -57,13 +57,16 @@ export const ConsignmentWeightTableForm = ({ catches, transportType }: Consignme
     if (isArrival) {
       weight = catchItem?.netWeightProductArrival;
     } else if (
-      !catchItem?.netWeightProductDeparture &&
-      !catchItem?.netWeightFisheryProductDeparture &&
+      // Only fall back to arrival weight when departure was NEVER submitted
+      // (undefined). A null value means the user explicitly cleared the field;
+      // in that case show nothing rather than re-showing the arrival weight.
+      catchItem?.netWeightProductDeparture === undefined &&
+      catchItem?.netWeightFisheryProductDeparture === undefined &&
       catchItem?.netWeightProductArrival
     ) {
       weight = catchItem.netWeightProductArrival;
     } else {
-      weight = catchItem?.netWeightProductDeparture;
+      weight = catchItem?.netWeightProductDeparture ?? undefined;
     }
     return weight === undefined ? undefined : Number(weight).toFixed(2);
   };
@@ -72,13 +75,13 @@ export const ConsignmentWeightTableForm = ({ catches, transportType }: Consignme
     if (isArrival) {
       weight = catchItem?.netWeightFisheryProductArrival;
     } else if (
-      !catchItem?.netWeightProductDeparture &&
-      !catchItem?.netWeightFisheryProductDeparture &&
+      catchItem?.netWeightProductDeparture === undefined &&
+      catchItem?.netWeightFisheryProductDeparture === undefined &&
       catchItem?.netWeightFisheryProductArrival
     ) {
       weight = catchItem.netWeightFisheryProductArrival;
     } else {
-      weight = catchItem?.netWeightFisheryProductDeparture;
+      weight = catchItem?.netWeightFisheryProductDeparture ?? undefined;
     }
     return weight === undefined ? undefined : Number(weight).toFixed(2);
   };
@@ -277,7 +280,11 @@ export const action: ActionFunction = async ({ request, params }): Promise<Respo
   const isNonJs = form.get("isNonJs") === "true";
   const { _action, ...values } = Object.fromEntries(form);
   const isDraft = form.get("_action") === "saveAsDraft";
-  const saveToRedisIfErrors = isDraft;
+  // Always persist submitted weights (even when validation fails) so that the
+  // progress page correctly reflects the current state. Without this, a failed
+  // Confirm submission reverts to the previously-saved valid weights in the DB,
+  // causing the section to appear Complete even after the user has cleared them.
+  const saveToRedisIfErrors = true;
 
   const isEdit = (_action as string)?.startsWith("edit-");
   const isRemove = (_action as string)?.startsWith("remove-");

app/types/storageDocument.ts

@@ -17,8 +17,8 @@ export interface StorageDocumentCatch {
   productDescription?: string;
   netWeightProductArrival?: string;
   netWeightFisheryProductArrival?: string;
-  netWeightProductDeparture?: string;
-  netWeightFisheryProductDeparture?: string;
+  netWeightProductDeparture?: string | null;
+  netWeightFisheryProductDeparture?: string | null;
   _id?: string;
 }
 

public/locales-v2/en/errorsText.json

@@ -263,6 +263,7 @@
   "sdNetWeightProductDeparturePositiveMax2Decimal": "Enter the net weight on departure as a number with a maximum of 2 decimal places",
   "sdNetWeightFisheryProductDepartureErrorMax2DecimalLargerThan0": "Enter the fishery product weight with a maximum of 2 decimal places, larger than 0",
   "sdNetWeightFisheryProductDeparturePositiveMax2Decimal": "Enter the fishery product weight as a number with a maximum of 2 decimal places",
+  "sdNetWeightOrFisheryWeightProductDeparture": "Enter the net weight on departure and the fishery product weight on departure",
   "sdNetWeightProductDepartureExceedsArrival": "Departure weight cannot be greater than arrival weight",
   "sdNetWeightFisheryProductDepartureExceedsProductDeparture": "Fishery products net weight on arrival cannot exceed the product net weight",
   "sdNetWeightProductDepartureExceed12Digit": "The net weight on departure must be less than 100000000000",