Add event bus and fix slow bean initialization logs

Author: pmendelski

.github/workflows/build.yml

@@ -14,7 +14,7 @@ jobs:
 
       - name: Skip duplicates and docs
         id: skip
-        uses: fkirc/skip-duplicate-actions@v4
+        uses: fkirc/skip-duplicate-actions@v5
         with:
           paths_ignore: '["**/README.md", "LICENSE", ".gitignore", ".editorconfig", ".idea/**"]'
 
@@ -34,4 +34,4 @@ jobs:
         if: steps.skip.outputs.should_skip != 'true'
         env:
           COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
-        run: ./gradlew build
+        run: ./gradlew build jacocoTestReport coveralls --scan

README.md

@@ -3,17 +3,14 @@
 [![Coverage Status](https://coveralls.io/repos/github/coditory/quark-context/badge.svg)](https://coveralls.io/github/coditory/quark-context)
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.coditory.quark/quark-context/badge.svg)](https://mvnrepository.com/artifact/com.coditory.quark/quark-context)
 
-> Quark Context is a lightweight and single purpose java library for loading and manipulating configurations
+> Lightweight, single purpose, dependency injection java library. Similar to [IoC Container provided by Spring Framework](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans) but lighter.
 
-The idea was to create a small, single-jar library, similar to
-the [IoC Container provided by Spring Framework](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans)
-, that is:
-
-- lightweight, no dependencies
-- single purpose and is not part of a framework
+- lightweight, exactly 3 minimalistic dependencies
+- single purpose, not part of a framework
 - provides both functional and annotation based API
 - has conditional bean registration mechanism
 - detects slow bean creation
+- provides [event bus](https://github.com/coditory/quark-eventbus) integration
 
 ## Installation
 

build.gradle

@@ -4,18 +4,18 @@ plugins {
     id 'jacoco'
     id 'signing'
     id 'com.github.kt3k.coveralls' version '2.12.0'
-    id 'com.coditory.build' version '0.1.18'
+    id 'com.coditory.build' version '0.1.19'
     id 'io.github.gradle-nexus.publish-plugin' version '1.1.0' apply false
 }
 
 group = 'com.coditory.quark'
-description = 'Coditory Quark Configuration Library'
+description = 'Coditory Quark Context Library'
 
 dependencies {
-    api 'org.slf4j:slf4j-api:2.0.0'
+    api 'org.slf4j:slf4j-api:2.0.3'
     api 'org.jetbrains:annotations:23.0.0'
-    testImplementation 'com.coditory.quark:quark-config:0.1.5'
-    testImplementation 'ch.qos.logback:logback-classic:1.4.0'
+    api 'com.coditory.quark:quark-eventbus:0.0.4'
+    testImplementation 'ch.qos.logback:logback-classic:1.4.4'
     testImplementation 'org.spockframework:spock-core:2.3-groovy-4.0'
     testImplementation 'org.skyscreamer:jsonassert:1.5.1'
 }

src/integration/groovy/annotated/SlowBeanCreationSpec.groovy

@@ -0,0 +1,33 @@
+package annotated
+
+import ch.qos.logback.classic.Logger
+import com.coditory.quark.context.Context
+import com.coditory.quark.context.base.CapturingAppender
+import org.slf4j.LoggerFactory
+import spock.lang.Specification
+
+class SlowBeanCreationSpec extends Specification {
+    CapturingAppender appender = new CapturingAppender()
+
+    void setup() {
+        Logger rootLogger = (Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME)
+        rootLogger.addAppender(appender)
+    }
+
+    void cleanup() {
+        Logger rootLogger = (Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME)
+        rootLogger.detachAppender(appender)
+    }
+
+    def "should log slow bean initialization"() {
+        given:
+            Context context = Context.scanPackage(annotated.samples.slow_beans.Bar)
+        when:
+            annotated.samples.slow_beans.Baz baz = context.get(annotated.samples.slow_beans.Baz)
+
+        then:
+            List<String> logs = appender.getLogsByMessagePrefix("Slow bean creation")
+            logs.size() == 1
+            logs.first().startsWith("[WARN] Slow bean creation. Bean: Bar")
+    }
+}

src/integration/groovy/annotated/samples/slow_beans/Bar.groovy

@@ -0,0 +1,4 @@
+package annotated.samples.slow_beans
+
+class Bar {
+}

src/integration/groovy/annotated/samples/slow_beans/Baz.groovy

@@ -0,0 +1,9 @@
+package annotated.samples.slow_beans
+
+class Baz {
+    final Bar bar
+
+    Baz(Bar bar) {
+        this.bar = bar
+    }
+}

src/integration/groovy/annotated/samples/slow_beans/ConfigInit.groovy

@@ -0,0 +1,24 @@
+package annotated.samples.slow_beans
+
+import com.coditory.quark.context.annotations.Bean
+import com.coditory.quark.context.annotations.Configuration
+
+@Configuration
+class ConfigInit {
+    @Bean
+    annotated.samples.slow_beans.Bar bar() {
+        Thread.sleep(1_000)
+        return new annotated.samples.slow_beans.Bar()
+    }
+
+    @Bean
+    annotated.samples.slow_beans.Baz baz(annotated.samples.slow_beans.Bar bar) {
+        return new annotated.samples.slow_beans.Baz(bar)
+    }
+
+    @Bean
+    annotated.samples.slow_beans.Foo foo(annotated.samples.slow_beans.Baz baz) {
+        Thread.sleep(1_000)
+        return new annotated.samples.slow_beans.Foo(baz)
+    }
+}

src/integration/groovy/annotated/samples/slow_beans/Foo.groovy

@@ -0,0 +1,15 @@
+package annotated.samples.slow_beans
+
+import static java.util.Objects.requireNonNull
+
+class Foo {
+    final Baz baz
+
+    Foo(Baz baz) {
+        this.baz = requireNonNull(baz)
+    }
+
+    Foo(Bar bar) {
+        throw new IllegalStateException("This constructor should not be used")
+    }
+}

src/main/java/com/coditory/quark/context/BeanDescriptor.java

@@ -1,10 +1,8 @@
 package com.coditory.quark.context;
 
-import java.util.Objects;
-
 import static java.util.Objects.requireNonNull;
 
-final class BeanDescriptor<T> {
+public record BeanDescriptor<T>(Class<T> type, String name) {
     public static <T> BeanDescriptor<T> descriptor(Class<T> type) {
         return new BeanDescriptor<>(type, null);
     }
@@ -13,51 +11,29 @@ public static <T> BeanDescriptor<T> descriptor(Class<T> type, String name) {
         return new BeanDescriptor<>(type, name);
     }
 
-    private final String name;
-    private final Class<T> type;
-
-    private BeanDescriptor(Class<T> type, String name) {
+    public BeanDescriptor(Class<T> type, String name) {
         this.type = requireNonNull(type);
         this.name = name == null || name.isBlank() ? null : name;
     }
 
-    <R> BeanDescriptor<R> withType(Class<R> type) {
+    public <R> BeanDescriptor<R> withType(Class<R> type) {
         return new BeanDescriptor<>(type, name);
     }
 
-    String getName() {
-        return name;
+    public boolean hasName() {
+        return name != null;
     }
 
-    Class<T> getType() {
-        return type;
+    public String toShortString() {
+        return name != null
+                ? type.getSimpleName() + ":" + name
+                : type.getSimpleName();
     }
 
     @Override
     public String toString() {
-        return "BeanDescriptor{" +
-                "name='" + name + '\'' +
-                ", type=" + type +
-                '}';
-    }
-
-    String toShortString() {
         return name != null
                 ? type.getSimpleName() + ":" + name
                 : type.getSimpleName();
     }
-
-    @Override
-    public boolean equals(Object o) {
-        if (this == o) return true;
-        if (o == null || getClass() != o.getClass()) return false;
-        BeanDescriptor<?> that = (BeanDescriptor<?>) o;
-        return Objects.equals(name, that.name)
-                && Objects.equals(type, that.type);
-    }
-
-    @Override
-    public int hashCode() {
-        return Objects.hash(name, type);
-    }
 }

src/main/java/com/coditory/quark/context/BeanFinalizer.java

@@ -38,9 +38,6 @@ private static void closeBean(Object bean, BeanDescriptor<?> descriptor, Method
             throw new BeanFinalizationException("Could not close bean: " + descriptor.toShortString() + " using method: " + simplifyMethodName(method), e);
         }
         log.debug("Closed bean {} using method {} in {}", descriptor.toShortString(), simplifyMethodName(method), timer.measureAndFormat());
-        if (timer.isOverThreshold()) {
-            log.warn("Detected long bean close operation. Bean: {}, Method: {}, Time: {}", descriptor.toShortString(), simplifyMethodName(method), timer.measureAndFormat());
-        }
     }
 
     private static void closeBean(Closeable bean, BeanDescriptor<?> descriptor) {
@@ -51,8 +48,5 @@ private static void closeBean(Closeable bean, BeanDescriptor<?> descriptor) {
             throw new BeanFinalizationException("Could not close bean: " + descriptor.toShortString(), e);
         }
         log.debug("Closed bean {} in {}", descriptor.toShortString(), timer.measureAndFormat());
-        if (timer.isOverThreshold()) {
-            log.warn("Detected long bean close operation. Bean: {}, Time: {}", descriptor.toShortString(), timer.measureAndFormat());
-        }
     }
 }