update command logging

lib/core/connection/connection.js

@@ -253,7 +253,6 @@ class Connection extends EventEmitter {
  write(buffer) {
  // Debug Log
  if (this.logger.isDebug()) {
- // TODO: might need to redact?
  if (!Array.isArray(buffer)) {
  this.logger.debug(`writing buffer [ ${buffer.toString('hex').length} ] to ${this.address}`);
  } else {

lib/core/cursor.js

@@ -524,7 +524,6 @@ class CoreCursor extends Readable {
 
  if (cursor.operation) {
  if (cursor.logger.isDebug()) {
- // TODO: can this contain sensitive data?
  cursor.logger.debug(
  `issue initial query [${JSON.stringify(cursor.cmd)}] with flags [${JSON.stringify(
  cursor.query
@@ -592,7 +591,6 @@ class CoreCursor extends Readable {
  }
 
  if (cursor.logger.isDebug()) {
- // TODO: can this contain sensitive data?
  cursor.logger.debug(
  `issue initial query [${JSON.stringify(cursor.cmd)}] with flags [${JSON.stringify(
  cursor.query

lib/core/sdam/server.js

@@ -20,6 +20,7 @@ const isNodeShuttingDownError = require('../error').isNodeShuttingDownError;
 const isNetworkErrorBeforeHandshake = require('../error').isNetworkErrorBeforeHandshake;
 const maxWireVersion = require('../utils').maxWireVersion;
 const makeStateMachine = require('../utils').makeStateMachine;
+const extractCommand = require('../../command_utils').extractCommand;
 const common = require('./common');
 const ServerType = common.ServerType;
 const isTransactionCommand = require('../transactions').isTransactionCommand;
@@ -261,11 +262,11 @@ class Server extends EventEmitter {
 
  // Debug log
  if (this.s.logger.isDebug()) {
- // TODO: redact or delete
+ const extractedCommand = extractCommand(cmd);
  this.s.logger.debug(
  `executing command [${JSON.stringify({
  ns,
- cmd,
+ cmd: extractedCommand.shouldRedact ? extractedCommand.name : cmd,
  options: debugOptions(DEBUG_FIELDS, options)
  })}] against ${this.name}`
  );

lib/core/topologies/server.js

@@ -16,6 +16,7 @@ var inherits = require('util').inherits,
  createCompressionInfo = require('./shared').createCompressionInfo,
  resolveClusterTime = require('./shared').resolveClusterTime,
  SessionMixins = require('./shared').SessionMixins,
+ extractCommand = require('../../command_utils').extractCommand,
  relayEvents = require('../utils').relayEvents;
 
 const collationNotSupported = require('../utils').collationNotSupported;
@@ -608,19 +609,20 @@ Server.prototype.command = function(ns, cmd, options, callback) {
  options = Object.assign({}, options, { wireProtocolCommand: false });
 
  // Debug log
- if (self.s.logger.isDebug())
- // TODO: redact or delete
+ if (self.s.logger.isDebug()) {
+ const extractedCommand = extractCommand(cmd);
  self.s.logger.debug(
  f(
  'executing command [%s] against %s',
  JSON.stringify({
  ns: ns,
- cmd: cmd,
+ cmd: extractedCommand.shouldRedact ? extractedCommand.name : cmd,
  options: debugOptions(debugFields, options)
  }),
  self.name
  )
  );
+ }
 
  // If we are not connected or have a disconnectHandler specified
  if (disconnectHandler(self, 'command', ns, cmd, options, callback)) return;

lib/operations/command.js

@@ -8,6 +8,7 @@ const handleCallback = require('../utils').handleCallback;
 const MongoError = require('../core').MongoError;
 const ReadPreference = require('../core').ReadPreference;
 const MongoDBNamespace = require('../utils').MongoDBNamespace;
+const extractCommand = require('../command_utils').extractCommand;
 
 const debugFields = [
  'authSource',
@@ -95,10 +96,10 @@ class CommandOperation extends OperationBase {
 
  // Debug information
  if (db.s.logger.isDebug()) {
- // TODO: redact or delete
+ const extractedCommand = extractCommand(command);
  db.s.logger.debug(
  `executing command ${JSON.stringify(
- command
+ extractedCommand.shouldRedact ? extractedCommand.name : command
  )} against ${dbName}.$cmd with options [${JSON.stringify(
  debugOptions(debugFields, options)
  )}]`

lib/operations/command_v2.js

@@ -9,6 +9,7 @@ const maxWireVersion = require('../core/utils').maxWireVersion;
 const decorateWithExplain = require('../utils').decorateWithExplain;
 const commandSupportsReadConcern = require('../core/sessions').commandSupportsReadConcern;
 const MongoError = require('../core/error').MongoError;
+const extractCommand = require('../command_utils').extractCommand;
 
 const SUPPORTS_WRITE_CONCERN_AND_COLLATION = 5;
 
@@ -89,8 +90,12 @@ class CommandOperationV2 extends OperationBase {
  }
 
  if (this.logger && this.logger.isDebug()) {
- // TODO: redact or delete
- this.logger.debug(`executing command ${JSON.stringify(cmd)} against ${this.ns}`);
+ const extractedCommand = extractCommand(cmd);
+ this.logger.debug(
+ `executing command ${JSON.stringify(
+ extractedCommand.shouldRedact ? extractedCommand.name : cmd
+ )} against ${this.ns}`
+ );
  }
 
  server.command(this.ns.toString(), cmd, this.options, (err, result) => {

lib/operations/db_ops.js

@@ -8,6 +8,7 @@ const MongoError = require('../core').MongoError;
 const parseIndexOptions = require('../utils').parseIndexOptions;
 const ReadPreference = require('../core').ReadPreference;
 const toError = require('../utils').toError;
+const extractCommand = require('../command_utils').extractCommand;
 const CONSTANTS = require('../constants');
 const MongoDBNamespace = require('../utils').MongoDBNamespace;
 
@@ -227,15 +228,16 @@ function executeCommand(db, command, options, callback) {
  options.readPreference = ReadPreference.resolve(db, options);
 
  // Debug information
- if (db.s.logger.isDebug())
- // TODO: redact or delete
+ if (db.s.logger.isDebug()) {
+ const extractedCommand = extractCommand(command);
  db.s.logger.debug(
  `executing command ${JSON.stringify(
- command
+ extractedCommand.shouldRedact ? extractedCommand.name : command
  )} against ${dbName}.$cmd with options [${JSON.stringify(
  debugOptions(debugFields, options)
  )}]`
  );
+ }
 
  // Execute command
  db.s.topology.command(db.s.namespace.withCollection('$cmd'), command, options, (err, result) => {