Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix same hashCodes an different queries with include and exclude #4831

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

13wjdgk
Copy link

@13wjdgk 13wjdgk commented Nov 10, 2024

Closes #4032

There was a bug where the hashCodes of the exclude and include queries were identical.

The issue was caused by the hashCode calculation in HashMap, where the XOR operation between the hashCode of the key and the hashCode of the value (0 or 1) resulted in duplicate hashCodes.

image

Since Exclude and Include are differentiated by 0 and 1 and are put into the hashMap, they were vulnerable to returning duplicate hashCodes.

To resolve this, the fix involved combining the key and value of the HashMap into a single String and calculating the hashCode based on that.

  • You have read the Spring Data contribution guidelines.
  • You use the code formatters provided here and have them applied to your changes. Don’t submit any formatting related changes.
  • You submit test cases (unit or integration tests) that back your changes.
  • You added yourself as author in the headers of the classes you touched. Amend the date range in the Apache license header if needed. For new types, add the license header (copy from another file and set the current year only).

@pivotal-cla
Copy link

@13wjdgk Please sign the Contributor License Agreement!

Click here to manually synchronize the status of this Pull Request.

See the FAQ for frequently asked questions.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Nov 10, 2024
@13wjdgk
Copy link
Author

13wjdgk commented Nov 10, 2024

Instead of toString(), I also considered the following solution.

	int result = nullSafeHashCodeForCriteria(criteria);
	
	public static int nullSafeHashCodeForCriteria(@Nullable Object obj) {
		if (obj == null) {
			return 0;
		} else if(obj instanceof Map<?,?>){
			int result = 0;
			for(Entry<?, ?> entry : ((Map<?, ?>)obj).entrySet()){
				if(entry.getValue() instanceof Integer){
					Integer value = (Integer)entry.getValue();
					int valueHashCode;
					if(value == 0){
						valueHashCode = FieldProjection.EXCLUDE.hashCode();
					}
					else if(value == 1){
						valueHashCode = FieldProjection.INCLUDE.hashCode();
					}else{
						valueHashCode = value.hashCode();
					}
					result += entry.getKey().hashCode() ^ valueHashCode;
				}else {
					result += entry.hashCode();
				}
			}
			return result;
		}

		return obj.hashCode();

	}

If you have a better idea, please let me know in the comments!

@13wjdgk 13wjdgk force-pushed the fix-Include-Excldue-Query-hashCode branch from f5f6bfd to 65257f2 Compare November 10, 2024 04:57
@pivotal-cla
Copy link

@13wjdgk Thank you for signing the Contributor License Agreement!

queryWithInclude.fields().include("key1");
queryWithInclude.fields().include("key2");

assertThat(queryWithExclude.hashCode()).isNotEqualTo(queryWithInclude.hashCode());
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before the fix, the test above failed.
image

@mp911de mp911de added the status: waiting-for-feedback We need additional information before we can continue label Nov 11, 2024
@mp911de mp911de self-assigned this Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: waiting-for-feedback We need additional information before we can continue status: waiting-for-triage An issue we've not yet triaged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Different Queries, same hashCodes
4 participants