(nifi) branch main updated: NIFI-13715 Fixed StandardProvenanceEventRecord.hashCode() to sort Parent/Child FlowFiles as equals() does

[pvillard]

This is an automated email from the ASF dual-hosted git repository.

pvillard pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi.git


The following commit(s) were added to refs/heads/main by this push:
     new 85ca96cc90 NIFI-13715 Fixed StandardProvenanceEventRecord.hashCode() 
to sort Parent/Child FlowFiles as equals() does
85ca96cc90 is described below

commit 85ca96cc90e58a225dbf3a434a53d55bbe620ad9
Author: Peter Turcsanyi <turcsa...@apache.org>
AuthorDate: Thu Sep 5 16:33:02 2024 +0200

    NIFI-13715 Fixed StandardProvenanceEventRecord.hashCode() to sort 
Parent/Child FlowFiles as equals() does
    
    Signed-off-by: Pierre Villard <pierre.villard...@gmail.com>
    
    This closes #9233.
---
 .../provenance/StandardProvenanceEventRecord.java  |  8 ++-
 .../StandardProvenanceEventRecordTest.java         | 64 ++++++++++++++++++++++
 2 files changed, 71 insertions(+), 1 deletion(-)

diff --git 
a/nifi-commons/nifi-data-provenance-utils/src/main/java/org/apache/nifi/provenance/StandardProvenanceEventRecord.java
 
b/nifi-commons/nifi-data-provenance-utils/src/main/java/org/apache/nifi/provenance/StandardProvenanceEventRecord.java
index cc3306fca8..28ae304edc 100644
--- 
a/nifi-commons/nifi-data-provenance-utils/src/main/java/org/apache/nifi/provenance/StandardProvenanceEventRecord.java
+++ 
b/nifi-commons/nifi-data-provenance-utils/src/main/java/org/apache/nifi/provenance/StandardProvenanceEventRecord.java
@@ -303,9 +303,15 @@ public class StandardProvenanceEventRecord implements 
ProvenanceEventRecord {
             eventTypeCode = 4812 + eventType.hashCode() + 4 * uuid.hashCode();
         }
 
+        final List<String> sortedChildUuids = new ArrayList<>(getChildUuids());
+        final List<String> sortedParentUuids = new 
ArrayList<>(getParentUuids());
+
+        Collections.sort(sortedChildUuids);
+        Collections.sort(sortedParentUuids);
+
         return -37423 + 3 * componentId.hashCode() + (transitUri == null ? 0 : 
41 * transitUri.hashCode())
                 + (relationship == null ? 0 : 47 * relationship.hashCode()) + 
44 * eventTypeCode
-                + 47 * getChildUuids().hashCode() + 47 * 
getParentUuids().hashCode();
+                + 47 * sortedChildUuids.hashCode() + 47 * 
sortedParentUuids.hashCode();
     }
 
     @Override
diff --git 
a/nifi-commons/nifi-data-provenance-utils/src/test/java/org/apache/nifi/provenance/StandardProvenanceEventRecordTest.java
 
b/nifi-commons/nifi-data-provenance-utils/src/test/java/org/apache/nifi/provenance/StandardProvenanceEventRecordTest.java
new file mode 100644
index 0000000000..3ae3a9bbb3
--- /dev/null
+++ 
b/nifi-commons/nifi-data-provenance-utils/src/test/java/org/apache/nifi/provenance/StandardProvenanceEventRecordTest.java
@@ -0,0 +1,64 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.nifi.provenance;
+
+import org.junit.jupiter.api.Test;
+
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class StandardProvenanceEventRecordTest {
+
+    private static final String FLOWFILE_ID_1 = "FF-1";
+    private static final String FLOWFILE_ID_2 = "FF-2";
+
+    @Test
+    void testEqualsAndHashCodeWithChildFlowFilesInDifferentOrder() {
+        final ProvenanceEventRecord event1 = initProvenanceEvent()
+                .setChildUuids(List.of(FLOWFILE_ID_1, FLOWFILE_ID_2))
+                .build();
+        final ProvenanceEventRecord event2 = initProvenanceEvent()
+                .setChildUuids(List.of(FLOWFILE_ID_2, FLOWFILE_ID_1))
+                .build();
+
+        assertEquals(event1, event2);
+        assertEquals(event1.hashCode(), event2.hashCode());
+    }
+
+    @Test
+    void testEqualsAndHashCodeWithParentFlowFilesInDifferentOrder() {
+        final ProvenanceEventRecord event1 = initProvenanceEvent()
+                .setParentUuids(List.of(FLOWFILE_ID_1, FLOWFILE_ID_2))
+                .build();
+        final ProvenanceEventRecord event2 = initProvenanceEvent()
+                .setParentUuids(List.of(FLOWFILE_ID_2, FLOWFILE_ID_1))
+                .build();
+
+        assertEquals(event1, event2);
+        assertEquals(event1.hashCode(), event2.hashCode());
+    }
+
+    private StandardProvenanceEventRecord.Builder initProvenanceEvent() {
+        return new StandardProvenanceEventRecord.Builder()
+                .setEventType(ProvenanceEventType.FORK)
+                .setComponentId("0")
+                .setComponentType("processor")
+                .setFlowFileUUID("FF")
+                .setCurrentContentClaim("container", "section", "identifier", 
0L, 0);
+    }
+}