Better logging and separate `reflect` artifact #786

alexander-yevsyukov · 2023-03-15T16:02:35Z

This PR improves modularity of the base project, introducing two new modules, logging and reflect. The aim is to later extract these modules into a dedicated repositories and develop them separately.'

The logging module is organized as Kotlin multiplatform project. Several adjustments were necessary to adopt our build scripts for supporting Kotlin KMM. These adjustments will be migrated to config in one of the following PRs.

Logging API improvements

The extracted logging module is a Kotlin multi-platform module, which introduces fluent logging API inspired by Flogger but in Kotlin.

The logging API introduces a notion of LoggingDomain which allows to group classes with logging instructions into a namespace. This namespace is added as a prefix to log messages of these classes in the following format:

[$loggingDomain] $message

In addition to the LoggingDomain Kotlin annotation class, a Java annotation interface JvmLoggingDomain was introduced. The Java annotation allows to annotate both types and packages, and it is used for lookup of a logging domain declared in a package ”hierarchy” from innermost to outermost.

An expected object called LoggingFactory was introduced with the JVM implementation of it.

Kotlin classes in need of logging now may use WithLogging interface, which exposes a logger property. It is expected that the Logging interface currently used from both Java and Kotlin would be later deprecated in favor of WithLogging. But it's too early to say it for sure.

Other notable changes

The callsite of the LoggingApi provided by the Logging interface was fixed so that it refers to the real class which calls logging instructions.
The project structure was improved to push the adoption of script plugins even further.
Kotlin extensions for working with Dokka are now consolidated under buildSrc/.../kotlin/DokkaExts.kt, making the closer to the script plugins that use these extensions.
Configuration of Dokka for Kotlin and for Java now have dedicated script plugins.
The DSL for configuring JAR artifacts is extended to allow Dokka artifacts for Java and Kotlin. More work is needed to allow publication of Dokka artifact in Kotlin API mode.
Kotlin extensions of Gradle types for publishing are now consolidated under PublishingExts.kt.
The code of the base module no longer depends on reflection utilities. Only logging does.
A script plugin (jacoco-kmm-jvm.gradle.kts) was added to address specifics of code coverage in a KMM project.

Improvements to the `reflect` module

AnnotatedPackages class was introduced to simplify working with annotations of nested packages.

Deprecations and removals

Types.isMessageClass(Class) is deprecated in favor of Kotlin extension function Type.isMessageClass() introduced in the base module.
Properties of PublishingRepos for maven.teamdev.com were removed as these repositories are not used for quite a long time.

# Conflicts: # build.gradle.kts # license-report.md # pom.xml # version.gradle.kts

…iplatform`

.ruby-version

Also: * Fix call sites in `io.spine.logging`

yevhenii-nadtochii · 2023-04-13T09:21:06Z

logging/src/jvmTest/kotlin/io/spine/logging/LoggingSpec.kt

+    }
+
+    @Test
+    fun `assume 'SEVER' for errors`() {


Suggested change

fun `assume 'SEVER' for errors`() {

fun `assume 'SEVERE' for errors`() {

yevhenii-nadtochii · 2023-04-13T09:22:16Z

logging/src/jvmTest/kotlin/io/spine/logging/LoggingSpec.kt

+    }
+
+    @Test
+    fun `obtain same 'FluentLogger' Instance`() {


Suggested change

fun `obtain same 'FluentLogger' Instance`() {

fun `obtain same 'FluentLogger' instance`() {

yevhenii-nadtochii · 2023-04-13T09:27:41Z

reflect/build.gradle.kts

+    module
+   `maven-publish`
+    `kotlin-jvm-module`
+    `dokka-for-kotlin`
+    idea
+    `project-report`
+    `detekt-code-analysis`


Can kotlin-jvm-module apply module on its own? It looks like kotlin-jvm-module is already module but with some additional stuff.

And some of these plugins are already applied in module. This block can be shortened.

yevhenii-nadtochii · 2023-04-13T09:41:27Z

reflect/src/test/java/io/spine/reflect/InvokablesTest.java

+            var handle = Invokables.asHandle(method);
+            Truth.assertThat(handle).isNotNull();


Looks like imports were badly optimized. Static imports are in place, but seem to be not used.

armiol

@alexander-yevsyukov LGTM except for the comment related to Ruby set up.

armiol

@alexander-yevsyukov please see a couple more minor comments.

armiol · 2023-04-13T13:03:43Z

buildSrc/src/main/kotlin/java-module.gradle.kts

+        rootFolder.set(rootDir)
+    }
+}
+


This line is redundant.

armiol · 2023-04-13T13:04:56Z

reflect/src/test/java/io/spine/reflect/InvokablesTest.java

@@ -117,38 +113,38 @@ void throwOnInvocationError() throws NoSuchMethodException {
        @DisplayName("convert a visible method to a handle")
        void convertToHandle() throws Throwable {
            var method = ClassWithPrivateMethod.class.getMethod("publicMethod");
-            var handle = asHandle(method);
+            var handle = Invokables.asHandle(method);


Maybe, we should rollback to static imports, as previously?

armiol · 2023-04-13T13:05:22Z

reflect/src/test/java/io/spine/reflect/TypesTest.java

@@ -62,50 +56,41 @@ class TypesTest extends UtilityClassTest<Types> {
    @Test
    @DisplayName("create a map type")
    void createMapType() {
-        var type = mapTypeOf(String.class, Integer.class);
+        var type = Types.mapTypeOf(String.class, Integer.class);


Maybe, we should use static imports, as before?

armiol

@alexander-yevsyukov LGTM.

alexander-yevsyukov added 19 commits March 13, 2023 21:34

Bump version -> 2.0.0-SNAPSHOT.170

a01905e

Add logging module

91fcbc2

Push plugins down to modules

e5e4b6c

Update config

932a0ec

Merge remote-tracking branch 'origin/master' into better-logging

8f33a61

# Conflicts: # build.gradle.kts # license-report.md # pom.xml # version.gradle.kts

Simplify Protobuf compile configuration

3595d82

Update build time

0289a23

Migrate to script plugins

30bf840

Update build time

e6aae1a

Draft multi-platform logging module

c071538

Optimise imports

5ae095f

Update dependencies

4c48b0c

Optimise imports

cfa280d

Bump Protobuf -> 3.22.2

0a204d9

Update version numbers

9461ffd

Consolidate logging module

773f3b5

Simplify dependencies

e238051

Do not create mavenJava publication if there is already `kotlinMult…

f90c54a

…iplatform`

Bump version -> 2.0.0-SNAPSHOT.170

1779ccd

alexander-yevsyukov self-assigned this Mar 15, 2023

alexander-yevsyukov commented Mar 15, 2023

View reviewed changes

.ruby-version Outdated Show resolved Hide resolved

alexander-yevsyukov added 9 commits March 15, 2023 17:22

Use withSourcesJar() and withJavadocJar() syntax

6676329

Apply Javadoc configuration after kotlin{}

2af6add

Improve script plugin name

ef55135

Ignore artifact files

0736f30

Add new logging API

cfef3ac

Also: * Fix call sites in `io.spine.logging`

Fix missing dependency

99a813a

Update build time

72a9d5b

Use expect/actual arrangement for LoggerFactory

7468883

Migrate to Kotest

9e26180

yevhenii-nadtochii reviewed Apr 13, 2023

View reviewed changes

alexander-yevsyukov added 2 commits April 13, 2023 13:34

Clarify delegation for standard pub. handler

1d4b24c

Remove redundant file

1694888

armiol requested changes Apr 13, 2023

View reviewed changes

alexander-yevsyukov added 7 commits April 13, 2023 13:37

Correct doc typo

7f99db7

Fix display message typo

1f3685c

Improve script plugin names and usage

a7ab204

Fix display name typo

d68b53e

Improve script plugin usage

86a8674

Restore static imports

d0ca56c

Optimise imports

3acb356

alexander-yevsyukov requested review from yevhenii-nadtochii and armiol April 13, 2023 12:57

alexander-yevsyukov enabled auto-merge April 13, 2023 12:57

Address documentation comments

1feeac1

armiol requested changes Apr 13, 2023

View reviewed changes

alexander-yevsyukov added 4 commits April 13, 2023 14:07

Use static import

3e2050d

Remove redundant empty line

1b12117

Restore static imports

cc45ba2

Restore static imports

66014c1

alexander-yevsyukov requested a review from armiol April 13, 2023 13:11

armiol approved these changes Apr 13, 2023

View reviewed changes

alexander-yevsyukov added this pull request to the merge queue Apr 13, 2023

Merged via the queue into master with commit 9782594 Apr 13, 2023

alexander-yevsyukov mentioned this pull request Apr 14, 2023

Update build scripts SpineEventEngine/config#464

Merged

alexander-yevsyukov deleted the better-logging branch April 14, 2023 16:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Better logging and separate `reflect` artifact #786

Better logging and separate `reflect` artifact #786

alexander-yevsyukov commented Mar 15, 2023 •

edited by armiol

Loading

yevhenii-nadtochii Apr 13, 2023

yevhenii-nadtochii Apr 13, 2023

yevhenii-nadtochii Apr 13, 2023

yevhenii-nadtochii Apr 13, 2023

armiol left a comment

armiol left a comment

armiol Apr 13, 2023

armiol Apr 13, 2023

armiol Apr 13, 2023

armiol left a comment

	fun `assume 'SEVER' for errors`() {
	fun `assume 'SEVERE' for errors`() {

	fun `obtain same 'FluentLogger' Instance`() {
	fun `obtain same 'FluentLogger' instance`() {

		var handle = Invokables.asHandle(method);
		Truth.assertThat(handle).isNotNull();

Better logging and separate reflect artifact #786

Better logging and separate reflect artifact #786

Conversation

alexander-yevsyukov commented Mar 15, 2023 • edited by armiol Loading

Logging API improvements

Other notable changes

Improvements to the reflect module

Deprecations and removals

yevhenii-nadtochii Apr 13, 2023

Choose a reason for hiding this comment

yevhenii-nadtochii Apr 13, 2023

Choose a reason for hiding this comment

yevhenii-nadtochii Apr 13, 2023

Choose a reason for hiding this comment

yevhenii-nadtochii Apr 13, 2023

Choose a reason for hiding this comment

armiol left a comment

Choose a reason for hiding this comment

armiol left a comment

Choose a reason for hiding this comment

armiol Apr 13, 2023

Choose a reason for hiding this comment

armiol Apr 13, 2023

Choose a reason for hiding this comment

armiol Apr 13, 2023

Choose a reason for hiding this comment

armiol left a comment

Choose a reason for hiding this comment

Better logging and separate `reflect` artifact #786

Better logging and separate `reflect` artifact #786

alexander-yevsyukov commented Mar 15, 2023 •

edited by armiol

Loading

Improvements to the `reflect` module