Issue #2274 - Rationalisation of IoC

platform-benchmark/pom.xml

@@ -63,6 +63,13 @@
 			<scope>provided</scope>
 		</dependency>
 
+		<dependency>
+			<groupId>org.postgresql</groupId>
+			<artifactId>postgresql</artifactId>
+			<version>${posgresql.version}</version>
+			<scope>runtime</scope>
+		</dependency>
+
 	</dependencies>
 	<build>
 		<resources>

platform-benchmark/src/main/java/ua/com/fielden/companion/BenchmarkModule.java

@@ -0,0 +1,61 @@
+package ua.com.fielden.companion;
+
+import com.google.common.cache.Cache;
+import com.google.common.cache.CacheBuilder;
+import com.google.inject.AbstractModule;
+import com.google.inject.Module;
+import com.google.inject.Provides;
+import com.google.inject.Singleton;
+import com.google.inject.util.Modules;
+import ua.com.fielden.platform.entity.proxy.IIdOnlyProxiedEntityTypeCache;
+import ua.com.fielden.platform.ioc.BasicWebServerModule;
+import ua.com.fielden.platform.security.annotations.SessionCache;
+import ua.com.fielden.platform.security.annotations.SessionHashingKey;
+import ua.com.fielden.platform.security.annotations.TrustedDeviceSessionDuration;
+import ua.com.fielden.platform.security.annotations.UntrustedDeviceSessionDuration;
+import ua.com.fielden.platform.security.session.UserSession;
+import ua.com.fielden.platform.security.user.IUserProvider;
+import ua.com.fielden.platform.security.user.impl.ThreadLocalUserProvider;
+import ua.com.fielden.platform.serialisation.api.impl.IdOnlyProxiedEntityTypeCacheForTests;
+
+import java.util.List;
+import java.util.Properties;
+import java.util.concurrent.TimeUnit;
+
+class BenchmarkModule extends BasicWebServerModule  {
+
+    public static Module newBenchmarkModule(final Properties props) {
+        return Modules.override(new BenchmarkModule(props))
+                .with(new AbstractModule() {
+                    @Override
+                    protected void configure() {
+                        // override by a test version because the main one breaks due to an error related to class loaders
+                        bind(IIdOnlyProxiedEntityTypeCache.class).to(IdOnlyProxiedEntityTypeCacheForTests.class);
+                    }
+                });
+    }
+
+    private BenchmarkModule(final Properties props) {
+        super(List::of,
+              List.of(),
+              props);
+    }
+
+    @Override
+    protected void configure() {
+        super.configure();
+
+        bindConstant().annotatedWith(SessionHashingKey.class).to("This is a hasing key, which is used to hash session data for a test server.");
+        bindConstant().annotatedWith(TrustedDeviceSessionDuration.class).to(60 * 24 * 3); // three days
+        bindConstant().annotatedWith(UntrustedDeviceSessionDuration.class).to(2); // five minutes
+
+        bind(IUserProvider.class).to(ThreadLocalUserProvider.class);
+    }
+
+    @Provides
+    @Singleton
+    @SessionCache Cache<String, UserSession> provideSessionCache() {
+        return CacheBuilder.newBuilder().expireAfterWrite(2, TimeUnit.MINUTES).build();
+    }
+
+}

platform-benchmark/src/main/java/ua/com/fielden/companion/CompanionInstantiationBenchmark.java

@@ -0,0 +1,86 @@
+package ua.com.fielden.companion;
+
+import com.google.inject.Injector;
+import org.openjdk.jmh.annotations.*;
+import org.openjdk.jmh.infra.Blackhole;
+import ua.com.fielden.platform.basic.config.Workflows;
+import ua.com.fielden.platform.ioc.ApplicationInjectorFactory;
+import ua.com.fielden.platform.ioc.NewUserNotifierMockBindingModule;
+
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Properties;
+
+import static org.openjdk.jmh.annotations.Threads.MAX;
+import static ua.com.fielden.companion.BenchmarkModule.newBenchmarkModule;
+
+/**
+ * <h3> Running this benchmark </h3>
+ *
+ * The following command should be used to run this benchmark, assuming the current working directory is this module (platform-benchmark).
+ * <pre>
+java -jar target/benchmarks.jar \
+    -p propertiesFile="src/main/resources/CompanionInstantiationBenchmark.properties" \
+    -prof gc \
+    "ua.com.fielden.companion.CompanionInstantiationBenchmark"
+ </pre>
+ */
+@Fork(value = 3)
+@Warmup(iterations = 2)
+@Measurement(iterations = 5)
+@Threads(MAX)
+@State(Scope.Benchmark)
+public class CompanionInstantiationBenchmark {
+
+    // required for correct initialisation of Guice modules
+    @Param("") String propertiesFile;
+
+    private Injector injector;
+
+    @Setup(Level.Trial)
+    public void setup() throws IOException {
+        if (!Files.isReadable(Path.of(propertiesFile))) {
+            throw new IllegalStateException("Can't read file: %s".formatted(propertiesFile));
+        }
+
+        final var properties = new Properties();
+        try (final var in = new FileInputStream(propertiesFile)) {
+            properties.load(in);
+        }
+
+        injector = new ApplicationInjectorFactory(Workflows.development)
+                .add(newBenchmarkModule(properties))
+                .add(new NewUserNotifierMockBindingModule())
+                .getInjector();
+
+        // Need to initialise singleton dependencies of companions. Can't enable eager singletons for the whole injector
+        // because stuff starts breaking due to incomplete module configuration. Therefore, manually instantiata a companion
+        // here to force initialisation of singletons.
+        injector.getInstance(Entity1Dao.class);
+    }
+
+    private <T> T getInstance(final Class<T> type) {
+        return injector.getInstance(type);
+    }
+
+    @Benchmark
+    @BenchmarkMode(Mode.AverageTime)
+    @Measurement(iterations = 20, time = 5)
+    public void lightCo(final Blackhole blackhole) {
+        for (int i = 0; i < 1000; i++) {
+            blackhole.consume(getInstance(Entity1Dao.class));
+        }
+    }
+
+    @Benchmark
+    @BenchmarkMode(Mode.AverageTime)
+    @Measurement(iterations = 20, time = 5)
+    public void heavyCo(final Blackhole blackhole) {
+        for (int i = 0; i < 1000; i++) {
+            blackhole.consume(getInstance(Entity2Dao.class));
+        }
+    }
+
+}

platform-benchmark/src/main/java/ua/com/fielden/companion/Entity1.java

@@ -0,0 +1,12 @@
+package ua.com.fielden.companion;
+
+import ua.com.fielden.platform.entity.AbstractEntity;
+import ua.com.fielden.platform.entity.annotation.CompanionObject;
+import ua.com.fielden.platform.entity.annotation.KeyType;
+import ua.com.fielden.platform.entity.annotation.MapEntityTo;
+
+@CompanionObject(Entity1Co.class)
+@KeyType(String.class)
+@MapEntityTo
+class Entity1 extends AbstractEntity<String> {
+}

platform-benchmark/src/main/java/ua/com/fielden/companion/Entity1Co.java

@@ -0,0 +1,6 @@
+package ua.com.fielden.companion;
+
+import ua.com.fielden.platform.dao.IEntityDao;
+
+interface Entity1Co extends IEntityDao<Entity1> {
+}

platform-benchmark/src/main/java/ua/com/fielden/companion/Entity1Dao.java

@@ -0,0 +1,16 @@
+package ua.com.fielden.companion;
+
+import com.google.inject.Inject;
+import ua.com.fielden.platform.dao.CommonEntityDao;
+import ua.com.fielden.platform.entity.annotation.EntityType;
+import ua.com.fielden.platform.entity.query.IFilter;
+
+@EntityType(Entity1.class)
+class Entity1Dao extends CommonEntityDao<Entity1> implements Entity1Co {
+
+    @Inject
+    public Entity1Dao(final IFilter filter) {
+        super(filter);
+    }
+
+}

platform-benchmark/src/main/java/ua/com/fielden/companion/Entity2.java

@@ -0,0 +1,12 @@
+package ua.com.fielden.companion;
+
+import ua.com.fielden.platform.entity.AbstractEntity;
+import ua.com.fielden.platform.entity.annotation.CompanionObject;
+import ua.com.fielden.platform.entity.annotation.KeyType;
+import ua.com.fielden.platform.entity.annotation.MapEntityTo;
+
+@CompanionObject(Entity2Co.class)
+@KeyType(String.class)
+@MapEntityTo
+class Entity2 extends AbstractEntity<String> {
+}

platform-benchmark/src/main/java/ua/com/fielden/companion/Entity2Co.java

@@ -0,0 +1,6 @@
+package ua.com.fielden.companion;
+
+import ua.com.fielden.platform.dao.IEntityDao;
+
+interface Entity2Co extends IEntityDao<Entity2> {
+}

platform-benchmark/src/main/java/ua/com/fielden/companion/Entity2Dao.java

@@ -0,0 +1,33 @@
+package ua.com.fielden.companion;
+
+import com.google.inject.Inject;
+import ua.com.fielden.platform.dao.CommonEntityDao;
+import ua.com.fielden.platform.dao.IEntityAggregatesOperations;
+import ua.com.fielden.platform.entity.annotation.EntityType;
+import ua.com.fielden.platform.entity.query.IFilter;
+import ua.com.fielden.platform.security.user.IUser;
+import ua.com.fielden.platform.security.user.IUserProvider;
+import ua.com.fielden.platform.utils.IDates;
+
+@EntityType(Entity2.class)
+class Entity2Dao extends CommonEntityDao<Entity2> implements Entity2Co {
+
+    private final IUserProvider userProvider;
+    private final IEntityAggregatesOperations aggregatesOps;
+    private final IUser userCo;
+    private final IDates dates;
+
+    @Inject
+    public Entity2Dao(final IFilter filter,
+                      final IUserProvider userProvider,
+                      final IEntityAggregatesOperations aggregatesOps,
+                      final IUser userCo,
+                      final IDates dates) {
+        super(filter);
+        this.userProvider = userProvider;
+        this.aggregatesOps = aggregatesOps;
+        this.userCo = userCo;
+        this.dates = dates;
+    }
+
+}

platform-benchmark/src/main/java/ua/com/fielden/deserialisation/DatesForBenchmarking.java

@@ -4,6 +4,7 @@
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.function.Supplier;
 
+import jakarta.inject.Singleton;
 import org.joda.time.DateTime;
 import org.joda.time.DateTimeZone;
 
@@ -15,6 +16,7 @@
  * @author TG Team
  * 
  */
+@Singleton
 class DatesForBenchmarking implements IDates {
     private DateTime now;
     private Supplier<DateTime> timeSupplier;
@@ -86,4 +88,4 @@ public int startOfWeek() {
         return 1;
     }
 
-}
+}

platform-benchmark/src/main/java/ua/com/fielden/deserialisation/EntityModuleWithPropertyFactoryForBenchmarking.java

@@ -1,21 +1,9 @@
 package ua.com.fielden.deserialisation;
 
-import com.google.inject.Injector;
-import com.google.inject.Scopes;
 import com.google.inject.name.Names;
-
 import ua.com.fielden.platform.basic.config.IApplicationDomainProvider;
-import ua.com.fielden.platform.entity.factory.DefaultCompanionObjectFinderImpl;
-import ua.com.fielden.platform.entity.factory.EntityFactory;
-import ua.com.fielden.platform.entity.factory.ICompanionObjectFinder;
 import ua.com.fielden.platform.entity.factory.IMetaPropertyFactory;
 import ua.com.fielden.platform.entity.ioc.EntityModule;
-import ua.com.fielden.platform.entity.meta.AbstractMetaPropertyFactory;
-import ua.com.fielden.platform.entity.meta.DomainMetaPropertyConfig;
-import ua.com.fielden.platform.entity.validation.DomainValidationConfig;
-import ua.com.fielden.platform.entity.validation.HappyValidator;
-import ua.com.fielden.platform.entity.validation.IBeforeChangeEventHandler;
-import ua.com.fielden.platform.entity.validation.annotation.EntityExists;
 import ua.com.fielden.platform.utils.IDates;
 import ua.com.fielden.platform.utils.IUniversalConstants;
 import ua.com.fielden.platform.web.test.config.ApplicationDomain;
@@ -29,15 +17,7 @@
  */
 class EntityModuleWithPropertyFactoryForBenchmarking extends EntityModule {
 
-    protected final EntityFactory entityFactory;
-
-    public EntityModuleWithPropertyFactoryForBenchmarking() {
-        entityFactory = new EntityFactory() {
-        };
-    }
-
-    private final DomainValidationConfig domainValidationConfig = new DomainValidationConfig();
-    private final DomainMetaPropertyConfig domainMetaPropertyConfig = new DomainMetaPropertyConfig();
+    public EntityModuleWithPropertyFactoryForBenchmarking() {}
 
     /**
      * 
@@ -46,43 +26,18 @@ public EntityModuleWithPropertyFactoryForBenchmarking() {
     @Override
     protected void configure() {
         super.configure();
-        bind(EntityFactory.class).toInstance(entityFactory);
         //////////////////////////////////////////////
         //////////// bind property factory ///////////
         //////////////////////////////////////////////
-        bind(IMetaPropertyFactory.class).toInstance(new AbstractMetaPropertyFactory(domainValidationConfig, domainMetaPropertyConfig, new DatesForBenchmarking()) {
-
-            @Override
-            protected IBeforeChangeEventHandler createEntityExists(final EntityExists anotation) {
-                return new HappyValidator();
-            }
-
-        });
+        bind(IMetaPropertyFactory.class).to(MetaPropertyFactoryForBenchmarking.class);
 
         bindConstant().annotatedWith(Names.named("app.name")).to("Unit Tests");
         bindConstant().annotatedWith(Names.named("email.smtp")).to("192.168.1.8");
         bindConstant().annotatedWith(Names.named("email.fromAddress")).to("[email protected]"); 
 
         bind(IApplicationDomainProvider.class).to(ApplicationDomain.class);
-        bind(ICompanionObjectFinder.class).to(DefaultCompanionObjectFinderImpl.class).in(Scopes.SINGLETON);
-        bind(IDates.class).to(DatesForBenchmarking.class).in(Scopes.SINGLETON);
-        bind(IUniversalConstants.class).to(UniversalConstantsForBenchmarking.class).in(Scopes.SINGLETON);
-    }
-
-    public DomainValidationConfig getDomainValidationConfig() {
-        return domainValidationConfig;
-    }
-
-    public DomainMetaPropertyConfig getDomainMetaPropertyConfig() {
-        return domainMetaPropertyConfig;
-    }
-
-    @Override
-    public void setInjector(final Injector injector) {
-        super.setInjector(injector);
-        entityFactory.setInjector(injector);
-        final IMetaPropertyFactory mfp = injector.getInstance(IMetaPropertyFactory.class);
-        mfp.setInjector(injector);
+        bind(IDates.class).to(DatesForBenchmarking.class);
+        bind(IUniversalConstants.class).to(UniversalConstantsForBenchmarking.class);
     }
 
 }

platform-benchmark/src/main/java/ua/com/fielden/deserialisation/MetaPropertyFactoryForBenchmarking.java

@@ -0,0 +1,21 @@
+package ua.com.fielden.deserialisation;
+
+import com.google.inject.Inject;
+import jakarta.inject.Singleton;
+import ua.com.fielden.platform.entity.meta.AbstractMetaPropertyFactory;
+import ua.com.fielden.platform.entity.validation.HappyValidator;
+import ua.com.fielden.platform.entity.validation.IBeforeChangeEventHandler;
+import ua.com.fielden.platform.entity.validation.annotation.EntityExists;
+
+@Singleton
+final class MetaPropertyFactoryForBenchmarking extends AbstractMetaPropertyFactory {
+
+    @Inject
+    public MetaPropertyFactoryForBenchmarking() {}
+
+    @Override
+    protected IBeforeChangeEventHandler createEntityExists(final EntityExists anotation) {
+        return new HappyValidator();
+    }
+
+}