You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@causeway.apache.org by ah...@apache.org on 2025/03/12 06:45:41 UTC
(causeway) branch main updated: CAUSEWAY-3859: flattens ManagedObjectEntityBookmarked into a record
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/causeway.git
The following commit(s) were added to refs/heads/main by this push:
new e8d6cf96ecb CAUSEWAY-3859: flattens ManagedObjectEntityBookmarked into a record
e8d6cf96ecb is described below
commit e8d6cf96ecb7382e637c136a3abcc9f95875c2dd
Author: Andi Huber <ah...@apache.org>
AuthorDate: Wed Mar 12 07:41:43 2025 +0100
CAUSEWAY-3859: flattens ManagedObjectEntityBookmarked into a record
---
.../commons/internal/ref/TransientObjectRef.java | 28 ++++--
.../core/metamodel/object/ManagedObject.java | 3 +-
...ked.java => ManagedObjectEntityBookmarked.java} | 112 +++++++++++++--------
.../metamodel/object/ManagedObjectViewmodel.java | 2 +-
.../object/_ManagedObjectEntityHybrid.java | 6 +-
5 files changed, 99 insertions(+), 52 deletions(-)
diff --git a/commons/src/main/java/org/apache/causeway/commons/internal/ref/TransientObjectRef.java b/commons/src/main/java/org/apache/causeway/commons/internal/ref/TransientObjectRef.java
index baec2abf8ee..e8722c8d15e 100644
--- a/commons/src/main/java/org/apache/causeway/commons/internal/ref/TransientObjectRef.java
+++ b/commons/src/main/java/org/apache/causeway/commons/internal/ref/TransientObjectRef.java
@@ -24,26 +24,42 @@
import org.jspecify.annotations.Nullable;
-import lombok.AllArgsConstructor;
import lombok.Getter;
-import lombok.Setter;
-@AllArgsConstructor
+/**
+ * non thread-safe
+ */
public final class TransientObjectRef<T> implements Serializable {
private static final long serialVersionUID = 1L;
- @Getter @Setter
+ @Getter
private transient @Nullable T object;
+ private transient boolean updating;
+
+ public TransientObjectRef(@Nullable final T object) {
+ this.object = object;
+ }
public T computeIfAbsent(final Supplier<T> supplier) {
return object!=null
? object
- : (this.object = supplier.get());
+ : update(__->supplier.get());
}
+ /**
+ * the updater itself must not directly modify this TransientObjectRef instance
+ */
public T update(final UnaryOperator<T> updater) {
- setObject(updater.apply(object));
+ if(updating) {
+ throw new UnsupportedOperationException("nested call to update detected");
+ }
+ this.updating = true;
+ try {
+ this.object = updater.apply(object);
+ } finally {
+ this.updating = false;
+ }
return object;
}
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/ManagedObject.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/ManagedObject.java
index 288bc8a5646..7a4ef559665 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/ManagedObject.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/ManagedObject.java
@@ -65,6 +65,7 @@ public sealed interface ManagedObject
ManagedObjectViewmodel,
ManagedObjectEntityTransient,
ManagedObjectEntityRemoved,
+ ManagedObjectEntityBookmarked,
_ManagedObjectEntityAbstract,
PackedManagedObject {
@@ -486,7 +487,7 @@ private static ManagedObject entityHypridBookmarked(
final @NonNull Object pojo,
final @NonNull Optional<Bookmark> bookmarkIfKnown) {
return new _ManagedObjectEntityHybrid(
- new _ManagedObjectEntityBookmarked(spec, pojo, bookmarkIfKnown));
+ new ManagedObjectEntityBookmarked(spec, pojo, bookmarkIfKnown));
}
// initially detached hybrid that can transition to bookmarked anytime on reassessment
private static ManagedObject entityHybirdTransient(
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/_ManagedObjectEntityBookmarked.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/ManagedObjectEntityBookmarked.java
similarity index 61%
rename from core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/_ManagedObjectEntityBookmarked.java
rename to core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/ManagedObjectEntityBookmarked.java
index faf9175daf8..5c4a4fd664b 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/_ManagedObjectEntityBookmarked.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/ManagedObjectEntityBookmarked.java
@@ -25,12 +25,16 @@
import org.apache.causeway.applib.exceptions.unrecoverable.ObjectNotFoundException;
import org.apache.causeway.applib.services.bookmark.Bookmark;
import org.apache.causeway.applib.services.repository.EntityState;
+import org.apache.causeway.commons.internal.assertions._Assert;
import org.apache.causeway.commons.internal.debug._Debug;
import org.apache.causeway.commons.internal.debug._XrayEvent;
import org.apache.causeway.commons.internal.debug.xray.XrayUi;
import org.apache.causeway.commons.internal.exceptions._Exceptions;
+import org.apache.causeway.commons.internal.ref.TransientObjectRef;
import org.apache.causeway.core.metamodel.facets.object.entity.EntityFacet;
+import org.apache.causeway.core.metamodel.facets.object.title.TitleRenderRequest;
import org.apache.causeway.core.metamodel.object.ManagedObject.Specialization;
+import org.apache.causeway.core.metamodel.objectmanager.memento.ObjectMemento;
import org.apache.causeway.core.metamodel.spec.ObjectSpecification;
import org.jspecify.annotations.NonNull;
@@ -41,22 +45,47 @@
* @see ManagedObject.Specialization#ENTITY
*/
@Log4j2
-final class _ManagedObjectEntityBookmarked
-extends _ManagedObjectEntityAbstract
-implements _Refetchable {
+record ManagedObjectEntityBookmarked(
+ @NonNull ObjectSpecification objSpec,
+ @NonNull TransientObjectRef<Object> pojoRef,
+ @NonNull Bookmark bookmark)
+implements ManagedObject, _Refetchable {
- private /*final*/ @Nullable Object pojo;
- private final @NonNull Bookmark bookmark;
-
- _ManagedObjectEntityBookmarked(
+ ManagedObjectEntityBookmarked(
final ObjectSpecification objSpec,
final Object pojo,
final @NonNull Optional<Bookmark> bookmarkIfKnown) {
- super(ManagedObject.Specialization.ENTITY, objSpec);
- this.pojo = _Compliance.assertCompliance(objSpec, specialization, pojo);
+ this(objSpec, new TransientObjectRef<>(pojo), bookmarkIfKnown.orElse(null));
+ }
+
+ ManagedObjectEntityBookmarked(
+ final ObjectSpecification objSpec,
+ final TransientObjectRef<Object> pojoRef,
+ @Nullable final Bookmark bookmark) {
+ _Assert.assertTrue(objSpec.isEntity());
+ _Compliance.assertCompliance(objSpec, specialization(), pojoRef.getObject());
+ this.objSpec = objSpec;
+ this.pojoRef = pojoRef;
//sanity check bookmark
- this.bookmark = entityFacet().validateBookmark(bookmarkIfKnown
- .orElseGet(this::createBookmark));
+ this.bookmark = Optional.ofNullable(bookmark)
+ .map(entityFacet()::validateBookmark)
+ .orElseGet(this::createBookmark);
+ }
+
+ @Override
+ public Specialization specialization() {
+ return ManagedObject.Specialization.ENTITY;
+ }
+
+ @Override
+ public String getTitle() {
+ return _InternalTitleUtil.titleString(
+ TitleRenderRequest.forObject(this));
+ }
+
+ @Override
+ public Optional<ObjectMemento> getMemento() {
+ return Optional.ofNullable(ObjectMemento.singularOrEmpty(this));
}
@Override
@@ -71,49 +100,55 @@ public boolean isBookmarkMemoized() {
@Override
public Object peekAtPojo() {
- return pojo;
+ return pojoRef.getObject();
}
@Override
public Object getPojo() {
- // refetch if required ...
-
- var entityFacet = entityFacet();
+ // refetch only if required ...
- var entityState = entityFacet.getEntityState(pojo);
+ var entityState = getEntityState();
if(!entityState.isPersistable()) {
throw _Exceptions.illegalState("not persistable %s", objSpec());
}
- if(entityState.isAttached()) {
- return pojo; // is attached
- }
+ if(entityState.isAttached()) return pojoRef.getObject(); // is attached
//[CAUSEWAY-3265] this getPojo() call might originate from a CausewayEntityListener.onPostLoad event,
- // in which case potentially runs into a nested loop resulting in a stack overflow;
- if(refetching) {
- throw _Exceptions.unrecoverable("framework bug: nested call to getPojo() while already refetching");
- }
+ // in which case potentially runs into a nested loop, which we detect and throw
+ return pojoRef.update(old->{
+ var refetchedPojo = refetchPojo(entityState);
+ return _Compliance.assertCompliance(objSpec(), specialization(), refetchedPojo);
+ });
+ }
- refetching = true;
- var refetchedPojo = refetchPojo(entityState);
- refetching = false;
+ @Override
+ public @NonNull EntityState getEntityState() {
+ return entityFacet().getEntityState(peekAtPojo());
+ }
- return this.pojo = _Compliance.assertCompliance(objSpec, specialization, refetchedPojo);
+ @Override
+ public final boolean equals(final Object obj) {
+ return _Compliance.equals(this, obj);
}
@Override
- public @NonNull EntityState getEntityState() {
- var entityFacet = entityFacet();
- return entityFacet.getEntityState(pojo);
+ public final int hashCode() {
+ return _Compliance.hashCode(this);
+ }
+
+ @Override
+ public final String toString() {
+ return _Compliance.toString(this);
}
// -- HELPER
- private boolean refetching;
+ // private boolean refetching;
private Object refetchPojo(final EntityState entityState) {
+ var pojo = pojoRef.getObject();
var entityFacet = entityFacet();
// triggers live-cycle events
@@ -121,9 +156,8 @@ private Object refetchPojo(final EntityState entityState) {
if(refetchedIfSuccess.isEmpty()) {
// if cannot refetch from this special JPA state, try again later
- if(entityState.isDetached()) {
- return pojo;
- }
+ if(entityState.isDetached()) return pojo;
+
// eg. throws on deleted entity
throw new ObjectNotFoundException("" + bookmark);
}
@@ -149,14 +183,10 @@ private Bookmark createBookmark() {
// fail early when detached entities are detected
// should have been re-fetched at start of this request-cycle
- if(
-// && EntityUtil.getPersistenceStandard(managedObject)
-// .map(PersistenceStandard::isJdo)
-// .orElse(false)
- !entityFacet.getEntityState(pojo).hasOid()) {
+ if(!getEntityState().hasOid()) {
_Debug.onCondition(XrayUi.isXrayEnabled(), ()->{
- _Debug.log("detached entity detected %s", pojo);
+ _Debug.log("detached entity detected %s", peekAtPojo());
});
var msg = String.format(
@@ -171,7 +201,7 @@ private Bookmark createBookmark() {
throw _Exceptions.illegalArgument(msg);
}
- return entityFacet.bookmarkForElseFail(pojo);
+ return entityFacet.bookmarkForElseFail(peekAtPojo());
}
}
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/ManagedObjectViewmodel.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/ManagedObjectViewmodel.java
index a68196fc339..710807db818 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/ManagedObjectViewmodel.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/ManagedObjectViewmodel.java
@@ -168,7 +168,7 @@ private void replaceBookmark(final UnaryOperator<Bookmark> replacer) {
private boolean shouldRefresh(final @NonNull TransactionId transactionId) {
// if already refreshed within current transaction, skip
if(Objects.equals(this.txIdDuringWhichRefreshed.getObject(), transactionId)) return false;
- this.txIdDuringWhichRefreshed.setObject(transactionId);
+ this.txIdDuringWhichRefreshed.update(__->transactionId);
return true;
}
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/_ManagedObjectEntityHybrid.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/_ManagedObjectEntityHybrid.java
index 24d25be4812..9fad2b26cf0 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/_ManagedObjectEntityHybrid.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/object/_ManagedObjectEntityHybrid.java
@@ -81,7 +81,7 @@ static MorphState valueOf(final EntityState entityState) {
}
_ManagedObjectEntityHybrid(
- final @NonNull _ManagedObjectEntityBookmarked bookmarked) {
+ final @NonNull ManagedObjectEntityBookmarked bookmarked) {
super(ManagedObject.Specialization.ENTITY, bookmarked.objSpec());
this.variant = bookmarked;
this.morphState = MorphState.BOOKMARKED;
@@ -157,7 +157,7 @@ private void triggerReassessment() {
}
private boolean isVariantBookmarked() {
- return variant instanceof _ManagedObjectEntityBookmarked;
+ return variant instanceof ManagedObjectEntityBookmarked;
}
private boolean isVariantTransient() {
@@ -189,7 +189,7 @@ private void reassessVariant(final EntityState entityState, final Object pojo) {
// morph into attached
private void makeBookmarked(final Object pojo) {
- var attached = new _ManagedObjectEntityBookmarked(objSpec(), pojo, Optional.empty());
+ var attached = new ManagedObjectEntityBookmarked(objSpec(), pojo, Optional.empty());
this.variant = attached;
_Assert.assertTrue(attached.getBookmark().isPresent(),
()->"bookmarked entity must have bookmark");