Merge pull request #922 from SpineEventEngine/remove-logging-dependency

Introduce Environment library, reduce dependency on Logging

Author: alexander-yevsyukov

base/build.gradle.kts

@@ -57,7 +57,6 @@ dependencies {
     Protobuf.libs.forEach { api(it) }
     api(Guava.lib)
 
-    implementation(Logging.lib)
     implementation(Reflect.lib)
     implementation(Kotlin.reflect)
 

base/src/main/java/io/spine/code/proto/FileDescriptors.java

@@ -29,8 +29,6 @@
 import com.google.protobuf.DescriptorProtos.FileDescriptorSet;
 import com.google.protobuf.Descriptors.FileDescriptor;
 import io.spine.io.Resource;
-import io.spine.logging.Logger;
-import io.spine.logging.LoggingFactory;
 
 import java.io.File;
 import java.io.FileInputStream;
@@ -44,7 +42,6 @@
 import static io.spine.io.IoPreconditions.checkExists;
 import static io.spine.util.Exceptions.newIllegalStateException;
 import static io.spine.util.Predicates2.distinctBy;
-import static java.lang.String.format;
 import static java.util.stream.Collectors.toList;
 import static java.util.stream.Collectors.toSet;
 
@@ -53,8 +50,6 @@
  */
 public final class FileDescriptors {
 
-    private static final Logger logger = LoggingFactory.forEnclosingClass();
-
     /**
      * Extension of the descriptor set files.
      */
@@ -99,10 +94,6 @@ public static List<FileDescriptorProto> parse(File descriptorSetFile) {
     private static List<FileDescriptorProto>
     parseAndFilter(File descriptorSet, Predicate<FileDescriptorProto> filter) {
         checkExists(descriptorSet);
-        logger.atDebug().log(() -> format(
-                "Looking up for the proto files matching predicate `%s` under `%s`.",
-                filter, descriptorSet));
-
         List<FileDescriptorProto> files;
         try (var fis = new FileInputStream(descriptorSet)) {
             var fileSet = FileDescriptorSetReader.parse(fis);
@@ -114,7 +105,6 @@ public static List<FileDescriptorProto> parse(File descriptorSetFile) {
                     e, "Cannot get proto file descriptors. Path: `%s`.", descriptorSet
             );
         }
-        logger.atDebug().log(() -> format("Found %d files.", files.size()));
         return files;
     }
 

base/src/main/java/io/spine/code/proto/FileSet.java

@@ -33,9 +33,6 @@
 import com.google.protobuf.DescriptorProtos.DescriptorProto;
 import com.google.protobuf.DescriptorProtos.FileDescriptorProto;
 import com.google.protobuf.Descriptors.FileDescriptor;
-import io.spine.logging.Level;
-import io.spine.logging.Logger;
-import io.spine.logging.LoggingFactory;
 import io.spine.type.KnownTypes;
 import io.spine.type.MessageType;
 import io.spine.type.Type;
@@ -54,7 +51,6 @@
 import static com.google.common.collect.Maps.newHashMapWithExpectedSize;
 import static io.spine.code.proto.Linker.link;
 import static io.spine.io.IoPreconditions.checkExists;
-import static java.lang.String.format;
 import static java.util.stream.Collectors.joining;
 import static java.util.stream.Collectors.toList;
 import static java.util.stream.Collectors.toMap;
@@ -65,8 +61,6 @@
  */
 public final class FileSet {
 
-    private static final Logger logger = LoggingFactory.forEnclosingClass();
-
     private static final FileDescriptor[] EMPTY = {};
 
     /**
@@ -132,28 +126,24 @@ public static FileSet parseAsKnownFiles(File descriptorSet) {
         return result;
     }
 
+    @SuppressWarnings("UseOfSystemOutOrSystemErr") /* Avoid dependency on Logging. */
     private static void onUnknownFiles(Set<FileName> knownFiles,
                                        Set<FileName> requestedFiles,
                                        File descriptorSetFile) {
-        var detailLevel = Level.DEBUG;
-        logger.atWarning().log(() -> format(
+        System.err.printf(
                 "Some files are unknown. " +
                 "%s files are present in classpath but %s files are discovered in `%s`.%n" +
-                "This means that they may be empty or that they are missing from the classpath. " +
-                "Enable `%s` logs for more info.",
+                "This means that they may be empty or that they are missing from the classpath.",
                 knownFiles.size(),
                 requestedFiles.size(),
-                descriptorSetFile,
-                detailLevel
-        ));
-        logger.at(detailLevel)
-              .log(() -> {
-                  var files = requestedFiles.stream()
-                          .filter(fileName -> !knownFiles.contains(fileName))
-                          .map(FileName::toString)
-                          .collect(joining(", "));
-                  return format("Could not find files: %s.", files);
-              });
+                descriptorSetFile
+        );
+        var files = requestedFiles.stream()
+                .filter(fileName -> !knownFiles.contains(fileName))
+                .map(FileName::toString)
+                .collect(joining(", "));
+
+        System.err.printf("Could not find files: %s.", files);
     }
 
     /**
@@ -165,7 +155,7 @@ private static FileSet doParse(File descriptorSetFile) {
     }
 
     /**
-     * Loads main file set from resources.
+     * Loads the main file set from resources.
      */
     public static FileSet load() {
         Collection<FileDescriptorProto> files = FileDescriptors.load();

base/src/main/java/io/spine/code/proto/Linker.java

@@ -33,16 +33,13 @@
 import com.google.protobuf.Descriptors.DescriptorValidationException;
 import com.google.protobuf.Descriptors.FileDescriptor;
 import io.spine.annotation.VisibleForTesting;
-import io.spine.logging.Logger;
-import io.spine.logging.LoggingFactory;
 
 import java.util.Collection;
 import java.util.List;
 
 import static com.google.common.base.Preconditions.checkState;
 import static com.google.protobuf.Descriptors.FileDescriptor.buildFrom;
 import static io.spine.util.Exceptions.newIllegalStateException;
-import static java.lang.String.format;
 import static java.lang.System.lineSeparator;
 import static java.util.stream.Collectors.joining;
 import static java.util.stream.Collectors.toList;
@@ -52,8 +49,6 @@
  */
 final class Linker {
 
-    private static final Logger logger = LoggingFactory.forEnclosingClass();
-
     private static final FileDescriptor[] NO_DEPENDENCIES = {};
 
     private final List<FileDescriptorProto> input;
@@ -74,13 +69,11 @@ final class Linker {
 
     static FileSet link(Collection<FileDescriptorProto> files) {
         var linker = new Linker(files);
-        logger.atDebug().log(() -> format("Trying to link %d files.", files.size()));
         try {
             linker.resolve();
         } catch (DescriptorValidationException e) {
             throw newIllegalStateException(e, "Unable to link descriptor set files.");
         }
-        logger.atDebug().log(() -> format("Linking complete. %s", linker));
         var result = linker.resolved()
                            .union(linker.partiallyResolved())
                            .union(linker.unresolved());

base/src/main/java/io/spine/code/proto/SourceFile.java

@@ -32,7 +32,6 @@
 import io.spine.base.RejectionType;
 import io.spine.code.fs.AbstractSourceFile;
 import io.spine.code.java.SimpleClassName;
-import io.spine.logging.WithLogging;
 import io.spine.type.MessageType;
 
 import java.nio.file.Path;
@@ -43,12 +42,11 @@
 
 import static com.google.common.base.Preconditions.checkNotNull;
 import static com.google.common.collect.ImmutableList.toImmutableList;
-import static java.lang.String.format;
 
 /**
  * A Protobuf file which also gives access to its {@link FileDescriptor descriptor}.
  */
-public class SourceFile extends AbstractSourceFile implements WithLogging {
+public class SourceFile extends AbstractSourceFile {
 
     private final FileDescriptor descriptor;
 
@@ -130,8 +128,6 @@ public List<MessageType> allThat(Predicate<DescriptorProto> predicate) {
         ImmutableList.Builder<MessageType> result = ImmutableList.builder();
         for (var messageType : descriptor.getMessageTypes()) {
             var declaration = new MessageType(messageType);
-            logger().atDebug().log(() -> format(
-                "Testing `%s` to match `%s`.", declaration, predicate));
             if (predicate.test(messageType.toProto())) {
                 result.add(declaration);
             }

base/src/main/java/io/spine/io/Delete.java

@@ -37,8 +37,6 @@
 import io.spine.code.java.ClassName;
 import io.spine.code.proto.FileSet;
 import io.spine.code.proto.TypeSet;
-import io.spine.logging.Logger;
-import io.spine.logging.LoggingFactory;
 import io.spine.security.InvocationGuard;
 import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
 
@@ -312,8 +310,6 @@ private List<String> allUrlList() {
     @Internal
     public static final class Holder {
 
-        private static final Logger logger = LoggingFactory.forEnclosingClass();
-
         /** The lock to synchronize the write access to the {@code KnownTypes} instance. */
         private static final Lock lock = new ReentrantLock(false);
 
@@ -341,7 +337,6 @@ private static KnownTypes instance() {
         @Internal /* exposed only to `io.spine.tools.type.MoreKnownTypes`. */
         public static void extendWith(TypeSet moreKnownTypes) {
             InvocationGuard.allowOnly("io.spine.tools.type.MoreKnownTypes");
-            logger.atDebug().log(() -> format("Adding types `%s` to known types.", moreKnownTypes));
             lock.lock();
             try {
                 var extended = instance.extendWith(moreKnownTypes);