Skip to content

Commit

Permalink
Allow customization of auto timestamp dateCreated and lastUpdated pro…
Browse files Browse the repository at this point in the history 
…perties
  • Loading branch information
@codeconsole
codeconsole committed Dec 9, 2024
1 parent 5646c30 commit d67e1ca
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 78 deletions.
3 changes: 3 additions & 0 deletions grails-datastore-core/src/main/groovy/org/grails/datastore/mapping/config/Entity.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ class Entity<P extends Property> {
* @return Whether automatic time stamps should be applied to 'lastUpdate' and 'dateCreated' properties
*/
boolean autoTimestamp = true
String dateCreated = null
String lastUpdated = null

/**
* @return Whether the entity should be autowired
*/
Expand Down
47 changes: 47 additions & 0 deletions grails-datastore-gorm-tck/src/main/groovy/grails/gorm/tests/CustomAutotimeStampSpec.groovy
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
package grails.gorm.tests

import grails.persistence.Entity

class CustomAutotimeStampSpec extends GormDatastoreSpec{

void "Test when the auto timestamp properties are customized, they are correctly set"() {
when:"An entity is persisted"
def r = new RecordCustom(name: "Test")
r.save(flush:true)
session.clear()
r = RecordCustom.get(r.id)

then:"the custom lastUpdated and dateCreated are set"
r.modified != null && r.modified < new Date()
r.created != null && r.created < new Date()

when:"An entity is modified"
Date previousCreated = r.created
Date previousModified = r.modified
r.name = "Test 2"
r.save(flush:true)
session.clear()
r = RecordCustom.get(r.id)

then:"the custom lastUpdated property is updated and dateCreated is not"
r.modified != null && previousModified > r.modified
previousCreated == r.created
}
@Override
List getDomainClasses() {
[RecordCustom]
}
}

@Entity
class RecordCustom {
Long id
String name
Date created
Date modified

static mapping = {
dateCreated 'created'
lastUpdated 'modified'
}
}
127 changes: 49 additions & 78 deletions ...ore-gorm/src/main/groovy/org/grails/datastore/gorm/events/AutoTimestampEventListener.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ public class AutoTimestampEventListener extends AbstractPersistenceEventListener
public static final String DATE_CREATED_PROPERTY = "dateCreated";
public static final String LAST_UPDATED_PROPERTY = "lastUpdated";

protected Map<String, Boolean> entitiesWithDateCreated = new ConcurrentHashMap<String, Boolean>();
protected Map<String, Boolean> entitiesWithLastUpdated = new ConcurrentHashMap<String, Boolean>();
protected Collection<String> uninitializedEntities = new ConcurrentLinkedQueue<String>();
protected Map<String, String> entitiesWithDateCreated = new ConcurrentHashMap<>();
protected Map<String, String> entitiesWithLastUpdated = new ConcurrentHashMap<>();
protected Collection<String> uninitializedEntities = new ConcurrentLinkedQueue<>();


private TimestampProvider timestampProvider = new DefaultTimestampProvider();
Expand Down Expand Up @@ -80,8 +80,7 @@ protected void onPersistenceEvent(final AbstractPersistenceEvent event) {

if (event.getEventType() == EventType.PreInsert) {
beforeInsert(event.getEntity(), event.getEntityAccess());
}
else if (event.getEventType() == EventType.PreUpdate) {
} else if (event.getEventType() == EventType.PreUpdate) {
beforeUpdate(event.getEntity(), event.getEntityAccess());
}
}
Expand All @@ -96,82 +95,69 @@ public boolean beforeInsert(PersistentEntity entity, EntityAccess ea) {
initializeIfNecessary(entity, name);
Class<?> dateCreatedType = null;
Object timestamp = null;
if (hasDateCreated(name)) {
dateCreatedType = ea.getPropertyType(DATE_CREATED_PROPERTY);
String prop = getDateCreatedPropertyName(name);
if (prop != null) {
dateCreatedType = ea.getPropertyType(prop);
timestamp = timestampProvider.createTimestamp(dateCreatedType);
ea.setProperty(DATE_CREATED_PROPERTY, timestamp);
ea.setProperty(prop, timestamp);
}
if (hasLastUpdated(name)) {
Class<?> lastUpdateType = ea.getPropertyType(LAST_UPDATED_PROPERTY);
if(dateCreatedType == null || !lastUpdateType.isAssignableFrom(dateCreatedType)) {
prop = getLastUpdatedPropertyName(name);
if (prop != null) {
Class<?> lastUpdateType = ea.getPropertyType(prop);
if (dateCreatedType == null || !lastUpdateType.isAssignableFrom(dateCreatedType)) {
timestamp = timestampProvider.createTimestamp(lastUpdateType);
}
ea.setProperty(LAST_UPDATED_PROPERTY, timestamp);
ea.setProperty(prop, timestamp);
}
return true;
}

private void initializeIfNecessary(PersistentEntity entity, String name) {
if(uninitializedEntities.contains(name)) {
if (uninitializedEntities.contains(name)) {
storeDateCreatedAndLastUpdatedInfo(entity);
uninitializedEntities.remove(name);
}
}

public boolean beforeUpdate(PersistentEntity entity, EntityAccess ea) {
if (hasLastUpdated(entity.getName())) {
Class<?> lastUpdateType = ea.getPropertyType(LAST_UPDATED_PROPERTY);
String prop = getLastUpdatedPropertyName(entity.getName());
if (prop != null) {
Class<?> lastUpdateType = ea.getPropertyType(prop);
Object timestamp = timestampProvider.createTimestamp(lastUpdateType);
ea.setProperty(LAST_UPDATED_PROPERTY, timestamp);
ea.setProperty(prop, timestamp);
}
return true;
}

/**
* Here for binary compatibility. Deprecated.
*
* @deprecated Use {@link #hasLastUpdated(String)} instead
*/
@Deprecated
protected boolean hasLastUpdated(PersistentEntity entity) {
return hasLastUpdated(entity.getName());
protected String getLastUpdatedPropertyName(String n) {
return entitiesWithLastUpdated.get(n);
}

protected boolean hasLastUpdated(String n) {
return entitiesWithLastUpdated.containsKey(n) && entitiesWithLastUpdated.get(n);
}

/**
* Here for binary compatibility. Deprecated.
*
* @deprecated Use {@link #hasDateCreated(String)} instead
*/
@Deprecated
protected boolean hasDateCreated(PersistentEntity entity) {
return hasDateCreated(entity.getName());
}

protected boolean hasDateCreated(String n) {
return entitiesWithDateCreated.containsKey(n)&& entitiesWithDateCreated.get(n);
protected String getDateCreatedPropertyName(String n) {
return entitiesWithDateCreated.get(n);
}

protected void storeDateCreatedAndLastUpdatedInfo(PersistentEntity persistentEntity) {
if(persistentEntity.isInitialized()) {

if (persistentEntity.isInitialized()) {
ClassMapping<?> classMapping = persistentEntity.getMapping();
Entity mappedForm = classMapping.getMappedForm();
if(mappedForm == null || mappedForm.isAutoTimestamp()) {
storeTimestampAvailability(entitiesWithDateCreated, persistentEntity, persistentEntity.getPropertyByName(DATE_CREATED_PROPERTY));
storeTimestampAvailability(entitiesWithLastUpdated, persistentEntity, persistentEntity.getPropertyByName(LAST_UPDATED_PROPERTY));
if (mappedForm == null || mappedForm.isAutoTimestamp()) {
storeTimestampAvailability(entitiesWithDateCreated, persistentEntity,
persistentEntity.getPropertyByName(mappedForm.getDateCreated() != null?
mappedForm.getDateCreated() : DATE_CREATED_PROPERTY));
storeTimestampAvailability(entitiesWithLastUpdated, persistentEntity,
persistentEntity.getPropertyByName(mappedForm.getLastUpdated() != null?
mappedForm.getLastUpdated() : LAST_UPDATED_PROPERTY));
}
}
else {
} else {
uninitializedEntities.add(persistentEntity.getName());
}
}

protected void storeTimestampAvailability(Map<String, Boolean> timestampAvailabilityMap, PersistentEntity persistentEntity, PersistentProperty<?> property) {
timestampAvailabilityMap.put(persistentEntity.getName(), property != null && timestampProvider.supportsCreating(property.getType()));
protected void storeTimestampAvailability(Map<String, String> timestampAvailabilityMap, PersistentEntity persistentEntity, PersistentProperty<?> property) {
if (property != null && timestampProvider.supportsCreating(property.getType())) {
timestampAvailabilityMap.put(persistentEntity.getName(), property.getName());
}
}

public void persistentEntityAdded(PersistentEntity entity) {
Expand All @@ -186,25 +172,25 @@ public void setTimestampProvider(TimestampProvider timestampProvider) {
this.timestampProvider = timestampProvider;
}

private void processAllEntries(final Set<Map.Entry<String, Boolean>> entries, final Runnable runnable) {
Map<String, Boolean> originalValues = new LinkedHashMap<String, Boolean>();
for(Map.Entry<String, Boolean> entry: entries) {
private void processAllEntries(final Set<Map.Entry<String, String>> entries, final Runnable runnable) {
Map<String, String> originalValues = new LinkedHashMap<>();
for (Map.Entry<String, String> entry: entries) {
originalValues.put(entry.getKey(), entry.getValue());
entry.setValue(false);
entry.setValue(null);
}
runnable.run();
for(Map.Entry<String, Boolean> entry: entries) {
for (Map.Entry<String, String> entry: entries) {
entry.setValue(originalValues.get(entry.getKey()));
}
}

private void processEntries(final List<Class> classes, Map<String, Boolean> entities, final Runnable runnable) {
Set<Map.Entry<String, Boolean>> entries = new HashSet<>();
private void processEntries(final List<Class> classes, Map<String, String> entities, final Runnable runnable) {
Set<Map.Entry<String, String>> entries = new HashSet<>();
final List<String> classNames = new ArrayList<>(classes.size());
for(Class clazz: classes) {
for (Class clazz: classes) {
classNames.add(clazz.getName());
}
for (Map.Entry<String, Boolean> entry: entities.entrySet()) {
for (Map.Entry<String, String> entry: entities.entrySet()) {
if (classNames.contains(entry.getKey())) {
entries.add(entry);
}
Expand Down Expand Up @@ -238,7 +224,7 @@ public void withoutLastUpdated(final List<Class> classes, final Runnable runnabl
* @param runnable The code to execute while the last updated listener is disabled
*/
public void withoutLastUpdated(final Class clazz, final Runnable runnable) {
ArrayList<Class> list = new ArrayList<Class>(1);
ArrayList<Class> list = new ArrayList<>(1);
list.add(clazz);
withoutLastUpdated(list, runnable);
}
Expand Down Expand Up @@ -269,7 +255,7 @@ public void withoutDateCreated(final List<Class> classes, final Runnable runnabl
* @param runnable The code to execute while the date created listener is disabled
*/
public void withoutDateCreated(final Class clazz, final Runnable runnable) {
ArrayList<Class> list = new ArrayList<Class>(1);
ArrayList<Class> list = new ArrayList<>(1);
list.add(clazz);
withoutDateCreated(list, runnable);
}
Expand All @@ -280,12 +266,7 @@ public void withoutDateCreated(final Class clazz, final Runnable runnable) {
* @param runnable The code to execute while the timestamp listeners are disabled
*/
public void withoutTimestamps(final Runnable runnable) {
withoutDateCreated(new Runnable() {
@Override
public void run() {
withoutLastUpdated(runnable);
}
});
withoutDateCreated(() -> withoutLastUpdated(runnable));
}

/**
Expand All @@ -295,12 +276,7 @@ public void run() {
* @param runnable The code to execute while the timestamp listeners are disabled
*/
public void withoutTimestamps(final List<Class> classes, final Runnable runnable) {
withoutDateCreated(classes, new Runnable() {
@Override
public void run() {
withoutLastUpdated(classes, runnable);
}
});
withoutDateCreated(classes, () -> withoutLastUpdated(classes, runnable));
}

/**
Expand All @@ -310,12 +286,7 @@ public void run() {
* @param runnable The code to execute while the timestamp listeners are disabled
*/
public void withoutTimestamps(final Class clazz, final Runnable runnable) {
withoutDateCreated(clazz, new Runnable() {
@Override
public void run() {
withoutLastUpdated(clazz, runnable);
}
});
withoutDateCreated(clazz, () -> withoutLastUpdated(clazz, runnable));
}

}

0 comments on commit d67e1ca

Please sign in to comment.