Make Logger instance names qualified (#973)

Author: injectives

driver/clirr-ignored-differences.xml

@@ -25,4 +25,10 @@
         <method>void debug(java.lang.String, java.lang.Throwable)</method>
     </difference>
 
+    <difference>
+        <className>org/neo4j/driver/Logging</className>
+        <differenceType>7012</differenceType>
+        <method>org.neo4j.driver.Logger getLog(java.lang.Class)</method>
+    </difference>
+
 </differences>

driver/src/main/java/org/neo4j/driver/GraphDatabase.java

@@ -36,8 +36,6 @@
  */
 public class GraphDatabase
 {
-    private static final String LOGGER_NAME = GraphDatabase.class.getSimpleName();
-
     /**
      * Return a driver for a Neo4j instance with the default configuration settings
      *
@@ -206,7 +204,7 @@ private static void assertRoutingUris( Iterable<URI> uris )
     private static Logger createLogger( Config config )
     {
         Logging logging = getOrDefault( config ).logging();
-        return logging.getLog( LOGGER_NAME );
+        return logging.getLog( GraphDatabase.class );
     }
 
     private static Config getOrDefault( Config config )

driver/src/main/java/org/neo4j/driver/Logging.java

@@ -87,6 +87,18 @@
  */
 public interface Logging
 {
+    /**
+     * Obtain a {@link Logger} instance by class, its name will be the fully qualified name of the class.
+     *
+     * @param clazz class whose name should be used as the {@link Logger} name.
+     * @return {@link Logger} instance
+     */
+    default Logger getLog( Class<?> clazz )
+    {
+        String canonicalName = clazz.getCanonicalName();
+        return getLog( canonicalName != null ? canonicalName : clazz.getName() );
+    }
+
     /**
      * Obtain a {@link Logger} instance by name.
      *

driver/src/main/java/org/neo4j/driver/internal/DriverFactory.java

@@ -169,7 +169,7 @@ protected InternalDriver createDirectDriver( SecurityPlan securityPlan, BoltServ
         ConnectionProvider connectionProvider = new DirectConnectionProvider( address, connectionPool );
         SessionFactory sessionFactory = createSessionFactory( connectionProvider, retryLogic, config );
         InternalDriver driver = createDriver( securityPlan, sessionFactory, metricsProvider, config );
-        Logger log = config.logging().getLog( Driver.class.getSimpleName() );
+        Logger log = config.logging().getLog( getClass() );
         log.info( "Direct driver instance %s created for server address %s", driver.hashCode(), address );
         return driver;
     }
@@ -186,7 +186,7 @@ protected InternalDriver createRoutingDriver( SecurityPlan securityPlan, BoltSer
                 config, routingSettings );
         SessionFactory sessionFactory = createSessionFactory( connectionProvider, retryLogic, config );
         InternalDriver driver = createDriver( securityPlan, sessionFactory, metricsProvider, config );
-        Logger log = config.logging().getLog( Driver.class.getSimpleName() );
+        Logger log = config.logging().getLog( getClass() );
         log.info( "Routing driver instance %s created for server address %s", driver.hashCode(), address );
         return driver;
     }

driver/src/main/java/org/neo4j/driver/internal/InternalDriver.java

@@ -54,7 +54,7 @@ public class InternalDriver implements Driver
         this.securityPlan = securityPlan;
         this.sessionFactory = sessionFactory;
         this.metricsProvider = metricsProvider;
-        this.log = logging.getLog( Driver.class.getSimpleName() );
+        this.log = logging.getLog( getClass() );
     }
 
     @Override

driver/src/main/java/org/neo4j/driver/internal/async/LeakLoggingNetworkSession.java

@@ -51,9 +51,9 @@ private void logLeakIfNeeded()
         Boolean isOpen = Futures.blockingGet( currentConnectionIsOpen() );
         if ( isOpen )
         {
-            logger.error( "Neo4j Session object leaked, please ensure that your application " +
-                          "fully consumes results in Sessions or explicitly calls `close` on Sessions before disposing of the objects.\n" +
-                          "Session was create at:\n" + stackTrace, null );
+            log.error( "Neo4j Session object leaked, please ensure that your application " +
+                       "fully consumes results in Sessions or explicitly calls `close` on Sessions before disposing of the objects.\n" +
+                       "Session was create at:\n" + stackTrace, null );
         }
     }
     private static String captureStackTrace()

driver/src/main/java/org/neo4j/driver/internal/async/NetworkConnection.java

@@ -75,7 +75,7 @@ public class NetworkConnection implements Connection
 
     public NetworkConnection( Channel channel, ExtendedChannelPool channelPool, Clock clock, MetricsListener metricsListener, Logging logging )
     {
-        this.log = logging.getLog( this.getClass().getCanonicalName() );
+        this.log = logging.getLog( getClass() );
         this.channel = channel;
         this.messageDispatcher = ChannelAttributes.messageDispatcher( channel );
         this.serverAgent = ChannelAttributes.serverAgent( channel );

driver/src/main/java/org/neo4j/driver/internal/async/NetworkSession.java

@@ -48,13 +48,11 @@
 
 public class NetworkSession
 {
-    private static final String LOG_NAME = "Session";
-
     private final ConnectionProvider connectionProvider;
     private final NetworkSessionConnectionContext connectionContext;
     private final AccessMode mode;
     private final RetryLogic retryLogic;
-    protected final Logger logger;
+    protected final Logger log;
 
     private final BookmarkHolder bookmarkHolder;
     private final long fetchSize;
@@ -70,7 +68,7 @@ public NetworkSession( ConnectionProvider connectionProvider, RetryLogic retryLo
         this.connectionProvider = connectionProvider;
         this.mode = mode;
         this.retryLogic = retryLogic;
-        this.logger = new PrefixedLogger( "[" + hashCode() + "]", logging.getLog( LOG_NAME ) );
+        this.log = new PrefixedLogger( "[" + hashCode() + "]", logging.getLog( getClass() ) );
         this.bookmarkHolder = bookmarkHolder;
         this.connectionContext = new NetworkSessionConnectionContext( databaseName, bookmarkHolder.getBookmark() );
         this.fetchSize = fetchSize;

driver/src/main/java/org/neo4j/driver/internal/async/pool/ConnectionPoolImpl.java

@@ -85,7 +85,7 @@ protected ConnectionPoolImpl( ChannelConnector connector, Bootstrap bootstrap, N
         this.channelHealthChecker = nettyChannelHealthChecker;
         this.settings = settings;
         this.metricsListener = metricsListener;
-        this.log = logging.getLog( ConnectionPool.class.getSimpleName() );
+        this.log = logging.getLog( getClass() );
         this.ownsEventLoopGroup = ownsEventLoopGroup;
         this.connectionFactory = connectionFactory;
     }

driver/src/main/java/org/neo4j/driver/internal/async/pool/NettyChannelHealthChecker.java

@@ -42,14 +42,16 @@ public class NettyChannelHealthChecker implements ChannelHealthChecker, Authoriz
 {
     private final PoolSettings poolSettings;
     private final Clock clock;
+    private final Logging logging;
     private final Logger log;
     private final AtomicReference<Optional<Long>> minCreationTimestampMillisOpt;
 
     public NettyChannelHealthChecker( PoolSettings poolSettings, Clock clock, Logging logging )
     {
         this.poolSettings = poolSettings;
         this.clock = clock;
-        this.log = logging.getLog( getClass().getSimpleName() );
+        this.logging = logging;
+        this.log = logging.getLog( getClass() );
         this.minCreationTimestampMillisOpt = new AtomicReference<>( Optional.empty() );
     }
 
@@ -129,7 +131,7 @@ private boolean hasBeenIdleForTooLong( Channel channel )
     private Future<Boolean> ping( Channel channel )
     {
         Promise<Boolean> result = channel.eventLoop().newPromise();
-        messageDispatcher( channel ).enqueue( new PingResponseHandler( result, channel, log ) );
+        messageDispatcher( channel ).enqueue( new PingResponseHandler( result, channel, logging ) );
         channel.writeAndFlush( ResetMessage.RESET, channel.voidPromise() );
         return result;
     }