Issue 53091: Don't include calculated aliquot rollup columns in audit details (#6819)

Author: labkey-susanh

api/src/org/labkey/api/audit/SampleTimelineAuditEvent.java

@@ -11,13 +11,16 @@
 
 import java.util.LinkedHashMap;
 import java.util.Map;
+import java.util.Set;
 
 public class SampleTimelineAuditEvent extends DetailedAuditTypeEvent
 {
     public static final String EVENT_TYPE = "SampleTimelineEvent";
 
     public static final String SAMPLE_TIMELINE_EVENT_TYPE = "SampleTimelineEventType";
 
+    public static final Set<String> EXCLUDED_DETAIL_FIELDS = Set.of("AvailableAliquotVolume", "AvailableAliquotCount", "AliquotCount", "AliquotVolume", "AliquotUnit");
+
     public enum SampleTimelineEventType
     {
         INSERT("Sample was registered.", "Registered"),
@@ -196,14 +199,16 @@ public Map<String, Object> getAuditLogMessageElements()
 
     /**
      * If the sample state changed, explicitly add in the Status Label value to the map so that it will render in the
-     * audit log timeline event even if the DataState row is later deleted.
+     * audit log timeline event even if the DataState row is later deleted.  Also, remove the aliquot rollup calculated
+     * fields from the data.
      */
     @Override
     public void setOldRecordMap(String oldRecordMap, Container container)
     {
         if (oldRecordMap != null)
         {
             Map<String, String> row = new CaseInsensitiveHashMap<>(AbstractAuditTypeProvider.decodeFromDataMap(oldRecordMap));
+            EXCLUDED_DETAIL_FIELDS.forEach(row::remove);
             String label = getStatusLabel(row, container);
             if (label != null)
             {
@@ -216,20 +221,20 @@ public void setOldRecordMap(String oldRecordMap, Container container)
 
     /**
      * If the sample state changed, explicitly add in the Status Label value to the map so that it will render in the
-     * audit log timeline event even if the DataState row is later deleted.
+     * audit log timeline event even if the DataState row is later deleted. Also, remove the aliquot rollup calculated
+     * fields from the data.
      */
     @Override
     public void setNewRecordMap(String newRecordMap, Container container)
     {
         if (newRecordMap != null)
         {
             Map<String, String> row = new CaseInsensitiveHashMap<>(AbstractAuditTypeProvider.decodeFromDataMap(newRecordMap));
+            EXCLUDED_DETAIL_FIELDS.forEach(row::remove);
             String label = getStatusLabel(row, container);
             if (label != null)
-            {
                 row.put("samplestatelabel", label);
-                newRecordMap = AbstractAuditTypeProvider.encodeForDataMap(row);
-            }
+            newRecordMap = AbstractAuditTypeProvider.encodeForDataMap(row);
         }
         super.setNewRecordMap(newRecordMap, container);
     }

experiment/src/org/labkey/experiment/api/ExpSampleTypeTestCase.jsp

@@ -1022,8 +1022,11 @@ public void testDetailedAuditLog() throws Exception
     Map<String,String> newRecordMap = new CaseInsensitiveHashMap<>(PageFlowUtil.mapFromQueryString(events.get(0).getNewRecordMap()));
     assertEquals("Initial", newRecordMap.get("Measure"));
     assertEquals("1.0", newRecordMap.get("Value"));
-    assertEquals("0", newRecordMap.get("AliquotCount"));
-    assertEquals("0.0", newRecordMap.get("AliquotVolume"));
+    assertNull(newRecordMap.get("AliquotCount"));
+    assertNull(newRecordMap.get("AliquotVolume"));
+    assertNull(newRecordMap.get("AvailableAliquotVolume"));
+    assertNull(newRecordMap.get("AvailableAliquotCount"));
+    assertNull(newRecordMap.get("AliquotUnit"));
 
     // UPDATE
     rows.clear(); errors.clear();