Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-16099 Introduce three-state handling for dirty levels to avoid excessive warnings 

We now differentiate between an Attribute which has been marked as "real dirty" from
one which needs to be "treated like dirty", so to not bother end users with a WARN
log when a non-updateable property had not been updated explicitly by them.
This commit is contained in:
Sanne Grinovero 2023-01-25 21:49:38 +00:00 committed by Sanne Grinovero
parent 4fc7293c66
commit ae37509b11
2 changed files with 58 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
hibernate-core/src/main/java/org/hibernate/persister/entity/mutation/AttributeAnalysis.java
View File

@ -37,7 +37,7 @@ public interface AttributeAnalysis {
/**
* Whether the attribute is considered dirty
*/
boolean isDirty();
DirtynessStatus getDirtynessStatus();
/**
* Whether the attribute be skipped completely.
@ -48,4 +48,30 @@ public interface AttributeAnalysis {
default boolean isSkipped() {
return !includeInSet() && !includeInLocking();
}
/**
* Dirty-ness status of each attribute:
* it's useful to differentiate when it's definitely dirty,
* when it's definitely not dirty, and when we need to treat
* it like dirty but there is no certainty - for example
* because we didn't actually load the value from the database.
*/
enum DirtynessStatus {
DIRTY,
NOT_DIRTY {
@Override
boolean isDirty() {
return false;
}
},
CONSIDER_LIKE_DIRTY;
/**
* @return both DIRTY and CONSIDER_LIKE_DIRTY states will return {@code true}
*/
boolean isDirty() {
return true;
}
};
}

50
hibernate-core/src/main/java/org/hibernate/persister/entity/mutation/UpdateCoordinatorStandard.java
View File

@ -596,10 +596,11 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
try {
if ( attributeMapping.getJdbcTypeCount() > 0
&& attributeMapping instanceof SingularAttributeMapping ) {
SingularAttributeMapping asSingularAttributeMapping = (SingularAttributeMapping) attributeMapping;
processAttribute(
analysis,
attributeIndex,
(SingularAttributeMapping) attributeMapping,
asSingularAttributeMapping,
oldVersion,
oldValues,
inclusionChecker,
@ -607,7 +608,8 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
session
);
if ( analysis.currentAttributeAnalysis.isDirty() ) {
// In this case we check for exactly DirtynessStatus.DIRTY so to not log warnings when the user didn't get it wrong:
if ( analysis.currentAttributeAnalysis.getDirtynessStatus() == AttributeAnalysis.DirtynessStatus.DIRTY ) {
if ( !propertyUpdateability[attributeIndex] ) {
LOG.ignoreImmutablePropertyModification( attributeMapping.getAttributeName(), persister.getEntityName() );
}
@ -702,7 +704,7 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
mutationExecutor,
staticUpdateGroup,
// (position, attribute) -> valuesAnalysis.getAttributeAnalyses().get( position ).isDirty(),
(position, attribute) -> true,
(position, attribute) -> AttributeAnalysis.DirtynessStatus.CONSIDER_LIKE_DIRTY,
session
);
bindPartitionColumnValueBindings( oldValues, session, mutationExecutor.getJdbcValueBindings() );
@ -880,7 +882,7 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
return true;
}
else if ( entityPersister().getEntityMetamodel().isDynamicUpdate() && dirtinessChecker != null ) {
return attributeAnalysis.includeInSet() && dirtinessChecker.isDirty( attributeIndex, attributeMapping );
return attributeAnalysis.includeInSet() && dirtinessChecker.isDirty( attributeIndex, attributeMapping ).isDirty();
}
else {
return true;
@ -916,7 +918,7 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
valuesAnalysis,
mutationExecutor,
dynamicUpdateGroup,
(attributeIndex, attribute) -> dirtinessChecker.include( attributeIndex, (SingularAttributeMapping) attribute ),
(attributeIndex, attribute) -> dirtinessChecker.include( attributeIndex, (SingularAttributeMapping) attribute ) ? AttributeAnalysis.DirtynessStatus.CONSIDER_LIKE_DIRTY : AttributeAnalysis.DirtynessStatus.NOT_DIRTY,
session
);
bindPartitionColumnValueBindings( oldValues, session, mutationExecutor.getJdbcValueBindings() );
@ -986,7 +988,7 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
updateGroupBuilder,
oldValues,
valuesAnalysis,
(position, attribute) -> valuesAnalysis.getAttributeAnalyses().get( position ).isDirty(),
(position, attribute) -> valuesAnalysis.getAttributeAnalyses().get( position ).getDirtynessStatus(),
session
);
@ -1134,7 +1136,7 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
else {
return versionability[attributeIndex]
&& attributeAnalysis.includeInLocking()
&& dirtinessChecker.isDirty(attributeIndex, attributeMapping);
&& dirtinessChecker.isDirty( attributeIndex, attributeMapping ).isDirty();
}
}
else {
@ -1160,7 +1162,7 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
else {
final boolean includeInSet = !entityPersister().getEntityMetamodel().isDynamicUpdate()
|| dirtinessChecker == null
|| dirtinessChecker.isDirty( attributeIndex, attributeMapping );
|| dirtinessChecker.isDirty( attributeIndex, attributeMapping ).isDirty();
if ( includeInSet ) {
attributeMapping.forEachUpdatable( tableUpdateBuilder );
}
@ -1289,7 +1291,7 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
currentAttributeAnalysis = new IncludedAttributeAnalysis( (SingularAttributeMapping) attribute );
if ( dirtyAttributeIndexes == null
|| contains( dirtyAttributeIndexes, attribute.getStateArrayPosition() ) ) {
currentAttributeAnalysis.markDirty();
currentAttributeAnalysis.markDirty( dirtyAttributeIndexes != null );
}
}
@ -1343,7 +1345,12 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
* Local extension to AttributeAnalysis
*/
private interface AttributeAnalysisImplementor extends AttributeAnalysis {
void markDirty();
/**
* @param asCertain set to true when we're sure, false when we merely need to treat the attribute
* as dirty but couldn't actually run the comparison.
* Once it's marked at least once "with certainty", there is no option to revert to a lower state.
*/
void markDirty(boolean asCertain);
}
/**
@ -1376,12 +1383,12 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
}
@Override
public boolean isDirty() {
return false;
public DirtynessStatus getDirtynessStatus() {
return DirtynessStatus.NOT_DIRTY;
}
@Override
public void markDirty() {
public void markDirty(boolean certainty) {
}
@Override
@ -1403,7 +1410,7 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
private final List<ColumnSetAnalysis> columnValueAnalyses;
private final List<ColumnLockingAnalysis> columnLockingAnalyses;
private boolean dirty;
private DirtynessStatus dirty = DirtynessStatus.NOT_DIRTY;
public IncludedAttributeAnalysis(SingularAttributeMapping attribute) {
this.attribute = attribute;
@ -1428,14 +1435,19 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
}
@Override
public boolean isDirty() {
public DirtynessStatus getDirtynessStatus() {
return dirty;
}
@Internal
@Override
public void markDirty() {
this.dirty = true;
public void markDirty(boolean certain) {
if ( certain ) {
this.dirty = DirtynessStatus.DIRTY;
}
else if ( this.dirty == DirtynessStatus.NOT_DIRTY ) {
this.dirty = DirtynessStatus.CONSIDER_LIKE_DIRTY;
}
}
@Override
@ -1529,7 +1541,7 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
// oldValues
null,
valuesAnalysis,
(position, attribute) -> valuesAnalysis.getAttributeAnalyses().get( position ).isDirty(),
(position, attribute) -> valuesAnalysis.getAttributeAnalyses().get( position ).getDirtynessStatus(),
// session
null
);
@ -1591,7 +1603,7 @@ public class UpdateCoordinatorStandard extends AbstractMutationCoordinator imple
@FunctionalInterface
protected interface DirtinessChecker {
boolean isDirty(int position, AttributeMapping attribute);
AttributeAnalysis.DirtynessStatus isDirty(int position, AttributeMapping attribute);
}
@Override