You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@causeway.apache.org by da...@apache.org on 2026/06/08 17:28:51 UTC

(causeway) 14/25: CAUSEWAY-4030: captures singleton list command results

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

danhaywood pushed a commit to branch CAUSEWAY-4032
in repository https://gitbox.apache.org/repos/asf/causeway.git

commit e10272418e5f56069449fcb0c9f152a5d8b54e02
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Mon Jun 8 13:20:22 2026 +0100

    CAUSEWAY-4030: captures singleton list command results
---
 .../executor/MemberExecutorServiceDefault.java     |  22 ++++-
 .../executor/MemberExecutorServiceDefaultTest.java | 110 +++++++++++++++++++++
 .../integtest/CommandLog_IntegTestAbstract.java    |  21 ++++
 .../commandlog/applib/integtest/model/Counter.java |  10 ++
 .../tasks.md                                       |  34 +++----
 5 files changed, 178 insertions(+), 19 deletions(-)

diff --git a/core/runtimeservices/src/main/java/org/apache/causeway/core/runtimeservices/executor/MemberExecutorServiceDefault.java b/core/runtimeservices/src/main/java/org/apache/causeway/core/runtimeservices/executor/MemberExecutorServiceDefault.java
index 5f3bd315fe1..a2bbff22fdf 100644
--- a/core/runtimeservices/src/main/java/org/apache/causeway/core/runtimeservices/executor/MemberExecutorServiceDefault.java
+++ b/core/runtimeservices/src/main/java/org/apache/causeway/core/runtimeservices/executor/MemberExecutorServiceDefault.java
@@ -311,16 +311,34 @@ private Object invokeMethodPassThrough(
         return CanonicalInvoker.invoke(methodFacade, targetPojo, executionParameters);
     }
 
-    private void setCommandResultIfEntity(
+    void setCommandResultIfEntity(
             final Command command,
             final ManagedObject resultAdapter) {
         if(command.getResult() != null) {
             // don't trample over any existing result, eg subsequent mixins.
             return;
         }
+        singletonResultCandidate(resultAdapter)
+                .ifPresent(candidate -> setCommandResultIfEntityScalar(command, candidate));
+    }
+
+    private Optional<ManagedObject> singletonResultCandidate(final ManagedObject resultAdapter) {
         if(ManagedObjects.isNullOrUnspecifiedOrEmpty(resultAdapter)) {
-            return;
+            return Optional.empty();
+        }
+        if(resultAdapter instanceof PackedManagedObject) {
+            val unpacked = ((PackedManagedObject)resultAdapter).unpack();
+            return unpacked.size() == 1
+                    ? unpacked.getSingleton()
+                            .filter(candidate -> !ManagedObjects.isNullOrUnspecifiedOrEmpty(candidate))
+                    : Optional.empty();
         }
+        return Optional.of(resultAdapter);
+    }
+
+    private void setCommandResultIfEntityScalar(
+            final Command command,
+            final ManagedObject resultAdapter) {
         val entityState = resultAdapter.getEntityState();
         if(!entityState.isPersistable()) {
             return;
diff --git a/core/runtimeservices/src/test/java/org/apache/causeway/core/runtimeservices/executor/MemberExecutorServiceDefaultTest.java b/core/runtimeservices/src/test/java/org/apache/causeway/core/runtimeservices/executor/MemberExecutorServiceDefaultTest.java
index d058ecdb9f6..f31d0d099e0 100644
--- a/core/runtimeservices/src/test/java/org/apache/causeway/core/runtimeservices/executor/MemberExecutorServiceDefaultTest.java
+++ b/core/runtimeservices/src/test/java/org/apache/causeway/core/runtimeservices/executor/MemberExecutorServiceDefaultTest.java
@@ -18,19 +18,27 @@
  */
 package org.apache.causeway.core.runtimeservices.executor;
 
+import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verifyNoInteractions;
 import static org.mockito.Mockito.when;
 
+import java.util.Optional;
+import java.util.UUID;
+
 import javax.inject.Provider;
 
 import org.junit.jupiter.api.Test;
 
+import org.apache.causeway.applib.services.bookmark.Bookmark;
 import org.apache.causeway.applib.services.command.Command;
 import org.apache.causeway.applib.services.command.CommandRecordingSuppressed;
+import org.apache.causeway.applib.services.repository.EntityState;
+import org.apache.causeway.commons.collections.Can;
 import org.apache.causeway.core.config.CausewayConfiguration;
 import org.apache.causeway.core.metamodel.interactions.InteractionHead;
 import org.apache.causeway.core.metamodel.object.ManagedObject;
+import org.apache.causeway.core.metamodel.object.PackedManagedObject;
 import org.apache.causeway.core.metamodel.services.publishing.CommandPublisher;
 import org.apache.causeway.core.metamodel.spec.feature.ObjectMember;
 
@@ -77,6 +85,108 @@ void prepare_command_for_publishing_does_nothing_for_suppressed_owner() {
         verifyNoInteractions(commandPublisherProvider);
     }
 
+    @Test
+    void set_command_result_records_scalar_bookmarkable_entity() {
+        var service = newService();
+        var command = newCommand();
+        var bookmark = bookmark("1");
+
+        service.setCommandResultIfEntity(command, entityAdapter(bookmark));
+
+        assertThat(command.getResult()).isEqualTo(bookmark);
+    }
+
+    @Test
+    void set_command_result_records_singleton_packed_bookmarkable_entity() {
+        var service = newService();
+        var command = newCommand();
+        var bookmark = bookmark("1");
+
+        service.setCommandResultIfEntity(command, packed(entityAdapter(bookmark)));
+
+        assertThat(command.getResult()).isEqualTo(bookmark);
+    }
+
+    @Test
+    void set_command_result_ignores_empty_packed_result() {
+        var service = newService();
+        var command = newCommand();
+
+        service.setCommandResultIfEntity(command, packed());
+
+        assertThat(command.getResult()).isNull();
+    }
+
+    @Test
+    void set_command_result_ignores_multi_object_packed_result() {
+        var service = newService();
+        var command = newCommand();
+
+        service.setCommandResultIfEntity(command, packed(entityAdapter(bookmark("1")), entityAdapter(bookmark("2"))));
+
+        assertThat(command.getResult()).isNull();
+    }
+
+    @Test
+    void set_command_result_ignores_singleton_packed_non_bookmarkable_result() {
+        var service = newService();
+        var command = newCommand();
+
+        service.setCommandResultIfEntity(command, packed(valueAdapter()));
+
+        assertThat(command.getResult()).isNull();
+    }
+
+    @Test
+    void set_command_result_does_not_overwrite_existing_result() {
+        var service = newService();
+        var command = newCommand();
+        var existing = bookmark("existing");
+        command.updater().setResult(org.apache.causeway.commons.functional.Try.success(existing));
+
+        service.setCommandResultIfEntity(command, packed(entityAdapter(bookmark("new"))));
+
+        assertThat(command.getResult()).isEqualTo(existing);
+    }
+
+    private MemberExecutorServiceDefault newService() {
+        @SuppressWarnings("unchecked")
+        Provider<CommandPublisher> commandPublisherProvider = mock(Provider.class);
+        return newService(commandPublisherProvider);
+    }
+
+    private Command newCommand() {
+        return new Command(UUID.randomUUID());
+    }
+
+    private Bookmark bookmark(final String identifier) {
+        return Bookmark.forLogicalTypeNameAndIdentifier("demo.Customer", identifier);
+    }
+
+    private ManagedObject entityAdapter(final Bookmark bookmark) {
+        var adapter = mock(ManagedObject.class);
+        when(adapter.getSpecialization()).thenReturn(ManagedObject.Specialization.ENTITY);
+        when(adapter.getPojo()).thenReturn(new Object());
+        when(adapter.getEntityState()).thenReturn(EntityState.ATTACHED);
+        when(adapter.getBookmark()).thenReturn(Optional.of(bookmark));
+        return adapter;
+    }
+
+    private ManagedObject valueAdapter() {
+        var adapter = mock(ManagedObject.class);
+        when(adapter.getSpecialization()).thenReturn(ManagedObject.Specialization.VALUE);
+        when(adapter.getPojo()).thenReturn("not-bookmarkable");
+        when(adapter.getEntityState()).thenReturn(EntityState.NOT_PERSISTABLE);
+        return adapter;
+    }
+
+    private PackedManagedObject packed(final ManagedObject... elements) {
+        var packed = mock(PackedManagedObject.class);
+        when(packed.getSpecialization()).thenReturn(ManagedObject.Specialization.PACKED);
+        when(packed.unpack()).thenReturn(Can.ofArray(elements));
+        return packed;
+    }
+
     private MemberExecutorServiceDefault newService(final Provider<CommandPublisher> commandPublisherProvider) {
         return new MemberExecutorServiceDefault(
                 null,
diff --git a/extensions/core/commandlog/applib/src/test/java/org/apache/causeway/extensions/commandlog/applib/integtest/CommandLog_IntegTestAbstract.java b/extensions/core/commandlog/applib/src/test/java/org/apache/causeway/extensions/commandlog/applib/integtest/CommandLog_IntegTestAbstract.java
index 3cd9953acaf..2c371fed59f 100644
--- a/extensions/core/commandlog/applib/src/test/java/org/apache/causeway/extensions/commandlog/applib/integtest/CommandLog_IntegTestAbstract.java
+++ b/extensions/core/commandlog/applib/src/test/java/org/apache/causeway/extensions/commandlog/applib/integtest/CommandLog_IntegTestAbstract.java
@@ -307,6 +307,10 @@ void safe_action_command_publishing_logs_null_list_and_scalar_results() {
         interactionService.nextInteraction();
         wrapperFactory.wrap(counter1).findSelfAsList();
         interactionService.nextInteraction();
+        wrapperFactory.wrap(counter1).findEmptyList();
+        interactionService.nextInteraction();
+        wrapperFactory.wrap(counter1).findSelfTwiceAsList();
+        interactionService.nextInteraction();
         wrapperFactory.wrap(counter1).findNameAsScalar();
         interactionService.nextInteraction();
 
@@ -317,7 +321,24 @@ void safe_action_command_publishing_logs_null_list_and_scalar_results() {
                 .contains(
                         "commandlog.test.Counter#findNull",
                         "commandlog.test.Counter#findSelfAsList",
+                        "commandlog.test.Counter#findEmptyList",
+                        "commandlog.test.Counter#findSelfTwiceAsList",
                         "commandlog.test.Counter#findNameAsScalar");
+        assertThat(entryFor(entries, "commandlog.test.Counter#findSelfAsList").getResult())
+                .isEqualTo(bookmarkService.bookmarkForElseFail(counter1));
+        assertThat(entryFor(entries, "commandlog.test.Counter#findNull").getResult()).isNull();
+        assertThat(entryFor(entries, "commandlog.test.Counter#findEmptyList").getResult()).isNull();
+        assertThat(entryFor(entries, "commandlog.test.Counter#findSelfTwiceAsList").getResult()).isNull();
+        assertThat(entryFor(entries, "commandlog.test.Counter#findNameAsScalar").getResult()).isNull();
+    }
+
+    private CommandLogEntry entryFor(
+            final List<? extends CommandLogEntry> entries,
+            final String logicalMemberIdentifier) {
+        return entries.stream()
+                .filter(entry -> logicalMemberIdentifier.equals(entry.getLogicalMemberIdentifier()))
+                .findFirst()
+                .orElseThrow();
     }
 
 
diff --git a/extensions/core/commandlog/applib/src/test/java/org/apache/causeway/extensions/commandlog/applib/integtest/model/Counter.java b/extensions/core/commandlog/applib/src/test/java/org/apache/causeway/extensions/commandlog/applib/integtest/model/Counter.java
index 2a292852e93..d51eb0bed24 100644
--- a/extensions/core/commandlog/applib/src/test/java/org/apache/causeway/extensions/commandlog/applib/integtest/model/Counter.java
+++ b/extensions/core/commandlog/applib/src/test/java/org/apache/causeway/extensions/commandlog/applib/integtest/model/Counter.java
@@ -83,6 +83,16 @@ public List<Counter> findSelfAsList() {
         return List.of(this);
     }
 
+    @Action(semantics = SemanticsOf.SAFE)
+    public List<Counter> findEmptyList() {
+        return List.of();
+    }
+
+    @Action(semantics = SemanticsOf.SAFE)
+    public List<Counter> findSelfTwiceAsList() {
+        return List.of(this, this);
+    }
+
     @Action(semantics = SemanticsOf.SAFE)
     public String findNameAsScalar() {
         return getName();
diff --git a/openspec/changes/record-single-list-result-in-command-log/tasks.md b/openspec/changes/record-single-list-result-in-command-log/tasks.md
index fdd676c2f52..9a6d259dc4f 100644
--- a/openspec/changes/record-single-list-result-in-command-log/tasks.md
+++ b/openspec/changes/record-single-list-result-in-command-log/tasks.md
@@ -1,33 +1,33 @@
 ## 1. Discovery
 
-- [ ] 1.1 Locate the current command result bookmark extraction path for scalar action results.
-- [ ] 1.2 Identify the managed-object APIs for safely inspecting zero, one, or more elements of a packed list, collection, array, or iterable result.
-- [ ] 1.3 Identify existing tests for `CommandSubscriberForCommandLog`, `MemberExecutorServiceDefault`, safe action command publishing, and command export known-target validation that can be extended.
+- [x] 1.1 Locate the current command result bookmark extraction path for scalar action results.
+- [x] 1.2 Identify the managed-object APIs for safely inspecting zero, one, or more elements of a packed list, collection, array, or iterable result.
+- [x] 1.3 Identify existing tests for `CommandSubscriberForCommandLog`, `MemberExecutorServiceDefault`, safe action command publishing, and command export known-target validation that can be extended.
 
 ## 2. Result Bookmark Extraction
 
-- [ ] 2.1 Refactor scalar command result bookmark extraction into a helper that accepts one candidate managed object.
-- [ ] 2.2 Add singleton-container detection that inspects at most enough elements to distinguish empty, singleton, and multi-element results.
-- [ ] 2.3 Store the contained object's bookmark when the result container has exactly one bookmarkable domain object.
-- [ ] 2.4 Leave the command result unset for empty containers, multi-element containers, scalar values, and singleton containers containing non-bookmarkable values.
-- [ ] 2.5 Preserve the existing guard that does not overwrite an already populated command result.
+- [x] 2.1 Refactor scalar command result bookmark extraction into a helper that accepts one candidate managed object.
+- [x] 2.2 Add singleton-container detection that inspects at most enough elements to distinguish empty, singleton, and multi-element results.
+- [x] 2.3 Store the contained object's bookmark when the result container has exactly one bookmarkable domain object.
+- [x] 2.4 Leave the command result unset for empty containers, multi-element containers, scalar values, and singleton containers containing non-bookmarkable values.
+- [x] 2.5 Preserve the existing guard that does not overwrite an already populated command result.
 
 ## 3. Export and Replay Integration
 
-- [ ] 3.1 Verify command export YAML emits the existing `result` field when a singleton-container result bookmark was recorded.
-- [ ] 3.2 Verify command export YAML omits `result` for empty and multi-object container results.
+- [x] 3.1 Verify command export YAML emits the existing `result` field when a singleton-container result bookmark was recorded.
+- [x] 3.2 Verify command export YAML omits `result` for empty and multi-object container results.
 - [ ] 3.3 Verify export known-target validation treats a recorded singleton-container result bookmark as an earlier known result.
-- [ ] 3.4 Verify replay result mapping receives recorded and actual result bookmarks for replayed commands whose recorded result came from a singleton container.
+- [x] 3.4 Verify replay result mapping receives recorded and actual result bookmarks for replayed commands whose recorded result came from a singleton container.
 
 ## 4. Tests and Documentation
 
-- [ ] 4.1 Add unit tests for scalar bookmarkable result behavior to guard against regressions.
-- [ ] 4.2 Add unit tests for singleton-list, empty-list, multi-object-list, and singleton-non-bookmarkable-list result behavior.
-- [ ] 4.3 Add integration or regression tests covering a safe finder that returns a singleton list followed by a command targeting that object.
-- [ ] 4.4 Update user-facing or developer documentation if command recording result capture behavior is documented.
+- [x] 4.1 Add unit tests for scalar bookmarkable result behavior to guard against regressions.
+- [x] 4.2 Add unit tests for singleton-list, empty-list, multi-object-list, and singleton-non-bookmarkable-list result behavior.
+- [x] 4.3 Add integration or regression tests covering a safe finder that returns a singleton list followed by a command targeting that object.
+- [x] 4.4 Update user-facing or developer documentation if command recording result capture behavior is documented.
 
 ## 5. Validation
 
 - [ ] 5.1 Run the relevant commandlog applib unit tests.
-- [ ] 5.2 Run the relevant runtime services or metamodel tests for action result handling.
-- [ ] 5.3 Run OpenSpec validation for `record-single-list-result-in-command-log`.
+- [x] 5.2 Run the relevant runtime services or metamodel tests for action result handling.
+- [x] 5.3 Run OpenSpec validation for `record-single-list-result-in-command-log`.