Issue #2224 - Entity Centre: API for named config running

platform-dao/src/test/java/ua/com/fielden/platform/test_config/H2OrPostgreSqlOrSqlServerContextSelector.java

@@ -1,30 +1,27 @@
 package ua.com.fielden.platform.test_config;
 
-import static org.apache.commons.lang3.StringUtils.isEmpty;
-
-import java.util.Optional;
-import java.util.Properties;
-
 import ua.com.fielden.platform.test.DbCreator;
 import ua.com.fielden.platform.test.IDomainDrivenTestCaseConfiguration;
 import ua.com.fielden.platform.test.db_creators.H2DbCreator;
 import ua.com.fielden.platform.test.runners.AbstractDomainDrivenTestCaseRunner;
-import ua.com.fielden.platform.test.runners.H2DomainDrivenTestCaseRunner;
-import ua.com.fielden.platform.test.runners.PostgresqlDomainDrivenTestCaseRunner;
-import ua.com.fielden.platform.test.runners.SqlServerDomainDrivenTestCaseRunner;
-
-/**
- * A test runner that selects a test configuration {@link ITestContext} from either {@link H2DomainDrivenTestCaseRunner} or {@link PostgresqlDomainDrivenTestCaseRunner} for running unit test.
- * The criteria for selecting the appropriate test runner is based on runtime settings.
- *
- * @author TG Team
- */
+import ua.com.fielden.platform.test.runners.H2DomainDrivenTestCaseRunner.H2TestContext;
+import ua.com.fielden.platform.test.runners.PostgresqlDomainDrivenTestCaseRunner.PostgresqlTestContext;
+import ua.com.fielden.platform.test.runners.SqlServerDomainDrivenTestCaseRunner.SqlServerTestContext;
+
+import java.util.Optional;
+import java.util.Properties;
+
+import static org.apache.commons.lang3.StringUtils.isEmpty;
+
+/// A test runner that selects a test configuration [ITestContext] from [SqlServerTestContext] or [PostgresqlTestContext].
+/// The criteria for selecting the appropriate test runner is based on runtime settings.
+///
 public class H2OrPostgreSqlOrSqlServerContextSelector extends AbstractDomainDrivenTestCaseRunner {
 
     // Note: This assumes PostgreSQL is listening on port 5432 (the default).
     // There is not much else in the URI that would uniquely identify that we are connecting to a PostgreSQL database.
-    private static final boolean POSTGRESQL = !isEmpty(System.getProperty("databaseUri")) && System.getProperty("databaseUri").contains("5432");
-    private static final boolean SQL_SERVER = !isEmpty(System.getProperty("databaseUri")) && System.getProperty("databaseUri").contains("database");
+    protected static final boolean POSTGRESQL = !isEmpty(System.getProperty("databaseUri")) && System.getProperty("databaseUri").contains("5432");
+    protected static final boolean SQL_SERVER = !isEmpty(System.getProperty("databaseUri")) && System.getProperty("databaseUri").contains("database");
 
     public H2OrPostgreSqlOrSqlServerContextSelector(final Class<?> klass) throws Exception {
         super(klass, POSTGRESQL ? PostgresqlDbCreator.class : (SQL_SERVER ? SqlServerDbCreator.class : H2DbCreator.class), Optional.empty());
@@ -45,10 +42,10 @@ public void dbCleanUp() {
         selectRunnerConfig().dbCleanUp();
     }
 
-    private ITestContext selectRunnerConfig() {
+    protected ITestContext selectRunnerConfig() {
         return POSTGRESQL 
-               ? new PostgresqlDomainDrivenTestCaseRunner.PostgresqlTestContext()
-               : (SQL_SERVER ? new SqlServerDomainDrivenTestCaseRunner.SqlServerTestContext() : new H2DomainDrivenTestCaseRunner.H2TestContext(this));
+               ? new PostgresqlTestContext()
+               : (SQL_SERVER ? new SqlServerTestContext() : new H2TestContext(this));
     }
 
 }

platform-pojo-bl/src/main/java/ua/com/fielden/platform/entity/functional/centre/CentreContextHolder.java

@@ -11,15 +11,15 @@
 import static java.util.Collections.unmodifiableList;
 import static java.util.Collections.unmodifiableMap;
 
-/**
- * The entity holder for centre context and criteria entity's modified props.
- *
- * @author TG Team
- *
- */
+/// The entity holder for centre context and criteria entity's modified props.
+///
 @KeyType(String.class)
 @KeyTitle(value = "Key", desc = "Some key description")
 @CompanionObject(ICentreContextHolder.class)
+// GraphQL Web API schema may not find `CentreContextHolder` type in case if it is used as property in allowed for introspection types
+// (e.g. those that are persistent / synthetic and have no @DenyIntrospection).
+// That's why it is explicitly denied for introspection and such properties become `AbstractDomainTreeRepresentation.isExcluded`.
+@DenyIntrospection
 public class CentreContextHolder extends AbstractEntity<String> {
 
     @IsProperty(Object.class)

platform-pojo-bl/src/main/java/ua/com/fielden/platform/entity/functional/centre/SavingInfoHolder.java

@@ -1,31 +1,27 @@
 package ua.com.fielden.platform.entity.functional.centre;
 
-import static java.util.Collections.unmodifiableList;
-import static java.util.Collections.unmodifiableMap;
-import static ua.com.fielden.platform.entity.NoKey.NO_KEY;
+import ua.com.fielden.platform.entity.AbstractEntity;
+import ua.com.fielden.platform.entity.IContinuationData;
+import ua.com.fielden.platform.entity.NoKey;
+import ua.com.fielden.platform.entity.annotation.*;
 
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
-import ua.com.fielden.platform.entity.AbstractEntity;
-import ua.com.fielden.platform.entity.IContinuationData;
-import ua.com.fielden.platform.entity.NoKey;
-import ua.com.fielden.platform.entity.annotation.CompanionObject;
-import ua.com.fielden.platform.entity.annotation.IsProperty;
-import ua.com.fielden.platform.entity.annotation.KeyType;
-import ua.com.fielden.platform.entity.annotation.Observable;
-import ua.com.fielden.platform.entity.annotation.Title;
+import static java.util.Collections.unmodifiableList;
+import static java.util.Collections.unmodifiableMap;
+import static ua.com.fielden.platform.entity.NoKey.NO_KEY;
 
-/**
- * The entity holder for saving information: entity's modified props + centre context, if any.
- *
- * @author TG Team
- *
- */
+/// The entity holder for saving information: entity's modified props + centre context, if any.
+///
 @KeyType(NoKey.class)
 @CompanionObject(ISavingInfoHolder.class)
+// GraphQL Web API schema may not find `CentreContextHolder` type in case if it is used as property in allowed for introspection types
+// (e.g. those that are persistent / synthetic and have no @DenyIntrospection).
+// That's why it is explicitly denied for introspection and such properties become `AbstractDomainTreeRepresentation.isExcluded`.
+@DenyIntrospection
 public class SavingInfoHolder extends AbstractEntity<NoKey> {
 
     @IsProperty(Object.class)

platform-pojo-bl/src/main/java/ua/com/fielden/platform/entity_centre/review/criteria/EntityQueryCriteria.java

@@ -325,6 +325,12 @@ private Map<String, Object> enhanceQueryParams(final Map<String, Object> buildPa
         return buildParametersMap;
     }
 
+    /// Executes the configured Entity Centre query to find count of entities.
+    ///
+    public int runCount() {
+        return count(generateQueryWithSummaries().getKey());
+    }
+
     /// Executes the configured entity query.
     ///
     public final IPage<T> run(final int pageSize) {

platform-pojo-bl/src/main/java/ua/com/fielden/platform/entity_centre/review/criteria/EntityQueryCriteriaUtils.java

@@ -68,7 +68,7 @@ public static boolean isPropertyAuthorised(final Class<?> root, final String pro
         // Root property (aka "entity itself") is always authorised.
         return property.isEmpty()
             // Non-root property access is governed by *_CanRead_property_* tokens, where the `property` part is never empty.
-            || authorisePropertyReading(root, property, authorisationModel, securityTokenProvider).orElseGet(Result::successful).isSuccessful();
+            || authorisePropertyIfGuarded(root, property, authorisationModel).orElseGet(Result::successful).isSuccessful();
     }
 
     /// Creates an Entity Centre query for a list of [QueryProperty] and other parameters.
@@ -91,7 +91,7 @@ public static <T extends AbstractEntity<?>> EntityQueryProgressiveInterfaces.ICo
         final IDates dates)
     {
         authoriseReading(type.getSimpleName(), READ, authorisationModel, securityTokenProvider).ifFailure(Result::throwRuntime);
-        authoriseCriteria(queryProperties, authorisationModel, securityTokenProvider).ifFailure(Result::throwRuntime);
+        authoriseCriteria(queryProperties, authorisationModel).ifFailure(Result::throwRuntime);
         if (createdByUserConstraint.isPresent()) {
             final QueryProperty queryProperty = EntityQueryCriteriaUtils.createNotInitialisedQueryProperty(managedType, "createdBy");
             final List<String> createdByCriteria = new ArrayList<>();

platform-pojo-bl/src/main/java/ua/com/fielden/platform/sample/domain/TgGeneratedEntity.java

@@ -3,31 +3,25 @@
 import ua.com.fielden.platform.data.generator.WithCreatedByUser;
 import ua.com.fielden.platform.entity.AbstractEntity;
 import ua.com.fielden.platform.entity.DynamicEntityKey;
-import ua.com.fielden.platform.entity.annotation.CompanionObject;
-import ua.com.fielden.platform.entity.annotation.CompositeKeyMember;
-import ua.com.fielden.platform.entity.annotation.CritOnly;
+import ua.com.fielden.platform.entity.annotation.*;
 import ua.com.fielden.platform.entity.annotation.CritOnly.Type;
-import ua.com.fielden.platform.entity.annotation.DescTitle;
-import ua.com.fielden.platform.entity.annotation.IsProperty;
-import ua.com.fielden.platform.entity.annotation.KeyType;
-import ua.com.fielden.platform.entity.annotation.MapEntityTo;
-import ua.com.fielden.platform.entity.annotation.MapTo;
-import ua.com.fielden.platform.entity.annotation.Observable;
-import ua.com.fielden.platform.entity.annotation.Title;
+import ua.com.fielden.platform.reflection.TitlesDescsGetter;
 import ua.com.fielden.platform.security.user.User;
+import ua.com.fielden.platform.utils.Pair;
 
-/**
- * Represents a typical example of an entity to be generated. This particular entity is generated by generator {@link TgGeneratedEntityGenerator}.
- *
- * @author TG Team
- *
- */
+import static ua.com.fielden.platform.entity.annotation.CritOnly.Type.SINGLE;
+
+/// Represents a typical example of an entity to be generated. This particular entity is generated by generator `TgGeneratedEntityGenerator`.
+///
 @KeyType(DynamicEntityKey.class)
 @CompanionObject(ITgGeneratedEntity.class)
 @MapEntityTo
 @DescTitle("Desc")
 public class TgGeneratedEntity extends AbstractEntity<DynamicEntityKey> implements WithCreatedByUser<TgGeneratedEntity> {
-    private static final long serialVersionUID = 1L;
+
+    private static final Pair<String, String> entityTitleAndDesc = TitlesDescsGetter.getEntityTitleAndDesc(TgGeneratedEntity.class);
+    public static final String ENTITY_TITLE = entityTitleAndDesc.getKey();
+    public static final String ENTITY_DESC = entityTitleAndDesc.getValue();
 
     @IsProperty(assignBeforeSave = true)
     @MapTo
@@ -47,10 +41,25 @@ public class TgGeneratedEntity extends AbstractEntity<DynamicEntityKey> implemen
     private User critOnlyMultiProp;
 
     @IsProperty
-    @CritOnly(Type.SINGLE)
+    @CritOnly(SINGLE)
     @Title(value = "CritOnly Single", desc = "CritOnly single property")
     private User critOnlySingleProp;
 
+    @IsProperty
+    @CritOnly(SINGLE)
+    @Required
+    private Integer requiredProp;
+
+    public Integer getRequiredProp() {
+        return requiredProp;
+    }
+
+    @Observable
+    public TgGeneratedEntity setRequiredProp(Integer requiredProp) {
+        this.requiredProp = requiredProp;
+        return this;
+    }
+
     @Observable
     public TgGeneratedEntity setEntityKey(final String entityKey) {
         this.entityKey = entityKey;

platform-pojo-bl/src/main/java/ua/com/fielden/platform/security/tokens/TokenUtils.java

@@ -61,14 +61,14 @@ public static Result authoriseReading(final String entityTypeSimpleName, final T
 
     /// Validates the criteria values to determine whether they can be applied under the authorisation model.
     ///
-    public static Result authoriseCriteria(final List<QueryProperty> queryProperties, final IAuthorisationModel authorisation, final ISecurityTokenProvider securityTokenProvider) {
+    public static Result authoriseCriteria(final List<QueryProperty> queryProperties, final IAuthorisationModel authorisation) {
         return queryProperties.stream()
             .map(queryProperty -> {
                 // Criterion without any conditions is authorised.
                 // Root property (aka "entity itself") is always authorised.
                 if (!queryProperty.isEmptyWithoutMnemonics() && !"".equals(queryProperty.getPropertyName())) {
                     final var originalType = getOriginalType(stripIfNeeded(queryProperty.getEntityClass()));
-                    return authorisePropertyReading(originalType, queryProperty.getPropertyName(), authorisation, securityTokenProvider);
+                    return authorisePropertyIfGuarded(originalType, queryProperty.getPropertyName(), authorisation);
                 }
                 return Optional.<Result>empty();
             })
@@ -78,7 +78,9 @@ public static Result authoriseCriteria(final List<QueryProperty> queryProperties
             .orElseGet(Result::successful);
     }
 
-    public static Optional<Result> authorisePropertyReading(final Class<?> entityType, final String propertyName, final IAuthorisationModel authorisation, final ISecurityTokenProvider securityTokenProvider) {
+    /// Finds authorisation annotation for entity property and performs authorisation, if present.
+    ///
+    public static Optional<Result> authorisePropertyIfGuarded(final Class<?> entityType, final String propertyName, final IAuthorisationModel authorisation) {
         return getPropertyAnnotationOptionally(Authorise.class, entityType, propertyName)
                .map(annot -> (Class<? extends ISecurityToken>) annot.value())
                .map(authorisation::authorise);

platform-pojo-bl/src/main/java/ua/com/fielden/platform/security/tokens/persistent/TgGeneratedEntity_CanRead_Token.java

@@ -0,0 +1,15 @@
+package ua.com.fielden.platform.security.tokens.persistent;
+
+import ua.com.fielden.platform.sample.domain.TgGeneratedEntity;
+import ua.com.fielden.platform.sample.domain.TgVehicleModel;
+import ua.com.fielden.platform.security.ISecurityToken;
+import ua.com.fielden.platform.security.tokens.Template;
+
+import static java.lang.String.format;
+
+/// A security token for entity [TgGeneratedEntity] to guard Read.
+///
+public class TgGeneratedEntity_CanRead_Token implements ISecurityToken {
+    public final static String TITLE = format(Template.READ.forTitle(), TgGeneratedEntity.ENTITY_TITLE);
+    public final static String DESC = format(Template.READ.forDesc(), TgGeneratedEntity.ENTITY_TITLE);
+}

platform-pojo-bl/src/main/java/ua/com/fielden/platform/ui/config/MainMenuItem.java

@@ -1,25 +1,16 @@
 package ua.com.fielden.platform.ui.config;
 
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.Iterator;
-import java.util.List;
-
 import ua.com.fielden.platform.algorithm.search.ITreeNode;
 import ua.com.fielden.platform.entity.AbstractEntity;
-import ua.com.fielden.platform.entity.annotation.CompanionObject;
-import ua.com.fielden.platform.entity.annotation.DenyIntrospection;
-import ua.com.fielden.platform.entity.annotation.DescTitle;
-import ua.com.fielden.platform.entity.annotation.IsProperty;
-import ua.com.fielden.platform.entity.annotation.KeyTitle;
-import ua.com.fielden.platform.entity.annotation.KeyType;
-import ua.com.fielden.platform.entity.annotation.MapEntityTo;
-import ua.com.fielden.platform.entity.annotation.MapTo;
-import ua.com.fielden.platform.entity.annotation.Observable;
-import ua.com.fielden.platform.error.Result;
+import ua.com.fielden.platform.entity.annotation.*;
 import ua.com.fielden.platform.reflection.ClassesRetriever;
 import ua.com.fielden.platform.reflection.PropertyTypeDeterminator;
 
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Iterator;
+import java.util.List;
+
 import static ua.com.fielden.platform.error.Result.failure;
 
 /**

platform-pojo-bl/src/main/java/ua/com/fielden/platform/web/centre/WebApiUtils.java

@@ -1,11 +1,11 @@
 package ua.com.fielden.platform.web.centre;
 
-import static ua.com.fielden.platform.domaintree.ICalculatedProperty.CalculatedPropertyCategory.AGGREGATED_EXPRESSION;
-import static ua.com.fielden.platform.domaintree.impl.AbstractDomainTreeRepresentation.isCalculatedAndOfTypes;
-
 import java.util.List;
 import java.util.stream.Collectors;
 
+import static ua.com.fielden.platform.domaintree.ICalculatedProperty.CalculatedPropertyCategory.AGGREGATED_EXPRESSION;
+import static ua.com.fielden.platform.domaintree.impl.AbstractDomainTreeRepresentation.isCalculatedAndOfTypes;
+
 /**
  * Utilities for Web API (centre, master) and its implementation.
  * 
@@ -22,6 +22,9 @@ public class WebApiUtils {
      * The surrogate title of centre 'link' configuration. This is used when link with centre parameters opens.
      */
     public static final String LINK_CONFIG_TITLE = "_______________________link";
+    public static final String CONFIG_DOES_NOT_EXIST = "Configuration does not exist.";
+    public static final String SAVE_MSG = "Please save and try again.";
+    public static final String DUPLICATE_SAVE_MSG = "Please duplicate, save and try again.";
 
     /** Private default constructor to prevent instantiation. */
     private WebApiUtils() {

platform-pojo-bl/src/main/java/ua/com/fielden/platform/web/utils/CentreExecutionMode.java

@@ -0,0 +1,15 @@
+package ua.com.fielden.platform.web.utils;
+
+/// Distinguishes the two execution modes of `CriteriaResource#executeEntityCentreConfiguration`.
+///
+/// Sealed deliberately so that any future Entity Centre evolution that introduces a new mode forces
+/// reconciliation with the central execution method (the compiler will flag a non-exhaustive switch).
+/// This protects programmatic callers (e.g., `DefaultEntityCentreProcessor`) from breaking when the
+/// UI flow changes.
+///
+/// Permitted implementations:
+/// - [HeadlessCentreExecution] -- programmatic API; data only, no UI augmentation.
+/// - [UiCentreExecution] -- UI-driven; rendering hints, action indices, dynamic-column metadata,
+///   and (when running) the criteria-changed indication are produced.
+///
+public sealed interface CentreExecutionMode permits HeadlessCentreExecution, UiCentreExecution {}

platform-pojo-bl/src/main/java/ua/com/fielden/platform/web/utils/ConfigSettings.java

@@ -0,0 +1,24 @@
+package ua.com.fielden.platform.web.utils;
+
+import ua.com.fielden.platform.security.user.User;
+import ua.com.fielden.platform.ui.config.EntityCentreConfig;
+import ua.com.fielden.platform.ui.menu.MiWithConfigurationSupport;
+import ua.com.fielden.platform.web.interfaces.DeviceProfile;
+
+import java.util.Optional;
+
+/// Convenient record holding Entity Centre configuration settings.
+///
+/// @param saveAsName   optional "save-as" name for named configuration or empty [Optional] for default one
+/// @param owner        a [User] that created the configuration (or own it through inheritance process)
+/// @param device       indicates whether the configuration belongs to [DeviceProfile#DESKTOP] namespace or [DeviceProfile#MOBILE]
+/// @param miType       menu item type for the configuration
+/// @param centreConfig Entity Centre configuration entity instance
+///
+public record ConfigSettings(
+    Optional<String> saveAsName,
+    User owner,
+    DeviceProfile device,
+    Class<? extends MiWithConfigurationSupport<?>> miType,
+    EntityCentreConfig centreConfig
+) {}