Move logger config out of Backend constructor

Alec Gibson · Alec Gibson · commit 1992b47c9cb6 · 2018-11-22T08:34:37.000Z
Configuring a package-level logger through an instance constructor is a
bit weird and potentially unexpected.

This change moves the backend logger configuration to the static level,
similar to how it's already set up for the client. Configuration at
static level should indicate that these changes will apply across all
backend instances.
diff --git a/README.md b/README.md
@@ -186,15 +186,14 @@ Note that only the [JSON0 OT type](https://github.com/ottypes/json0) is supporte
 
 By default, ShareDB logs to `console`. This can be overridden if you wish to silence logs, or to log to your own logging driver or alert service.
 
-Methods can be overridden by passing a [`console`-like object](https://developer.mozilla.org/en-US/docs/Web/API/console) to `Backend`:
+Methods can be overridden by passing a [`console`-like object](https://developer.mozilla.org/en-US/docs/Web/API/console) to `logger.setMethods`:
 
 ```javascript
-var share = new Backend({
-  logger: {
-    info: () => {},                         // Silence info
-    warn: () => alerts.warn(arguments),     // Forward warnings to alerting service
-    error: () => alerts.critical(arguments) // Remap errors to critical alerts
-  }
+var ShareDB = require('sharedb');
+ShareDB.logger.setMethods({
+  info: () => {},                         // Silence info
+  warn: () => alerts.warn(arguments),     // Forward warnings to alerting service
+  error: () => alerts.critical(arguments) // Remap errors to critical alerts
 });
 ```
 
@@ -389,9 +388,9 @@ Methods can be overridden by passing a [`console`-like object](https://developer
 ```javascript
 var ShareDB = require('sharedb/lib/client');
 ShareDB.logger.setMethods({
-    info: () => {},                         // Silence info
-    warn: () => alerts.warn(arguments),     // Forward warnings to alerting service
-    error: () => alerts.critical(arguments) // Remap errors to critical alerts
+  info: () => {},                         // Silence info
+  warn: () => alerts.warn(arguments),     // Forward warnings to alerting service
+  error: () => alerts.critical(arguments) // Remap errors to critical alerts
 });
 ```
 
diff --git a/lib/backend.js b/lib/backend.js
@@ -2,7 +2,6 @@ var async = require('async');
 var Agent = require('./agent');
 var Connection = require('./client/connection');
 var emitter = require('./emitter');
-var logger = require('./logger');
 var MemoryDB = require('./db/memory');
 var NoOpMilestoneDB = require('./milestone-db/no-op');
 var MemoryPubSub = require('./pubsub/memory');
@@ -41,8 +40,6 @@ function Backend(options) {
   this.agentsCount = 0;
   this.remoteAgentsCount = 0;
 
-  logger.setMethods(options.logger);
-
   // The below shims are for backwards compatibility. These options will be
   // removed in a future major version
   if (!options.disableDocAction) {
diff --git a/lib/index.js b/lib/index.js
@@ -5,6 +5,7 @@ Backend.Agent = require('./agent');
 Backend.Backend = Backend;
 Backend.DB = require('./db');
 Backend.Error = require('./error');
+Backend.logger = require('./logger');
 Backend.MemoryDB = require('./db/memory');
 Backend.MemoryMilestoneDB = require('./milestone-db/memory');
 Backend.MemoryPubSub = require('./pubsub/memory');
