How to use requestEndLoggingFormat method in Appium Base Driver

1"use strict";2var _ = require("underscore")3  , gridRegister = require('./grid-register.js')4  , logger = require('./logger.js').get('appium')5  , status = require('./status.js')6  , io = require('socket.io')7  , mkdirp = require('mkdirp')8  , bytes = require('bytes')9  , domain = require('domain')10  , format = require('util').format11  , Args = require("vargs").Constructor;12module.exports.allowCrossDomain = function (req, res, next) {13  safely(req, function () {14    res.header('Access-Control-Allow-Origin', '*');15    res.header('Access-Control-Allow-Methods', 'GET,POST,PUT,OPTIONS,DELETE');16    res.header('Access-Control-Allow-Headers', 'origin, content-type, accept');17  });18  // need to respond 200 to OPTIONS19  if ('OPTIONS' === req.method) {20    safely(req, function () {21      res.sendStatus(200);22    });23  } else {24    next();25  }26};27module.exports.winstonStream = {28  write: function (msg) {29    msg = msg.replace(/$\s*$/m, "");30    msg = msg.replace(/\[[^\]]+\] /, "");31    logger.log('debug', msg);32  }33};34module.exports.catchAllHandler = function (e, req, res, next) {35  safely(req, function () {36    res.status(500).send({37      status: status.codes.UnknownError.code38    , value: "ERROR running Appium command: " + e.message39    });40  });41  next(e);42};43module.exports.checkArgs = function (parser, args) {44  var exclusives = [45    ['noReset', 'fullReset']46    , ['ipa', 'safari']47    , ['app', 'safari']48    , ['forceIphone', 'forceIpad']49    , ['deviceName', 'defaultDevice']50  ];51  _.each(exclusives, function (exSet) {52    var numFoundInArgs = 0;53    _.each(exSet, function (opt) {54      if (_.has(args, opt) && args[opt]) {55        numFoundInArgs++;56      }57    });58    if (numFoundInArgs > 1) {59      console.error(("You can't pass in more than one argument from the set " +60        JSON.stringify(exSet) + ", since they are mutually exclusive").red);61      process.exit(1);62    }63  });64  var checkValidPort = function (port) {65    if (port > 0 && port < 65536) return true;66    console.error("Port must be greater than 0 and less than 65536");67    return false;68  };69  var validations = {70    port: checkValidPort71  , callbackPort: checkValidPort72  , bootstrapPort: checkValidPort73  , selendroidPort: checkValidPort74  , chromedriverPort: checkValidPort75  , robotPort: checkValidPort76  , backendRetries: function (r) { return r >= 0; }77  };78  var nonDefaultArgs = getNonDefaultArgs(parser, args);79  _.each(validations, function (validator, arg) {80    if (_.has(nonDefaultArgs, arg)) {81      if (!validator(args[arg])) {82        console.error("Invalid argument for param " + arg + ": " + args[arg]);83        process.exit(1);84      }85    }86  });87};88module.exports.noColorLogger = function (tokens, req, res) {89  var len = parseInt(res.getHeader('Content-Length'), 10);90  len = isNaN(len) ? '' : ' - ' + bytes(len);91  return req.method + ' ' + req.originalUrl + ' ' +92    res.statusCode + ' ' + (new Date() - req._startTime) + 'ms' + len;93};94module.exports.configureServer = function (rawConfig, appiumVer, appiumServer,95    cb) {96  var appiumRev;97  if (!rawConfig) {98    return cb(new Error('config data required'));99  }100  var versionMismatches = {};101  var excludedKeys = ["git-sha", "node_bin", "built"];102  _.each(rawConfig, function (deviceConfig, key) {103    if (deviceConfig.version !== appiumVer && !_.contains(excludedKeys, key)) {104      versionMismatches[key] = deviceConfig.version;105    } else if (key === "git-sha") {106      appiumRev = rawConfig['git-sha'];107    }108  });109  if (_.keys(versionMismatches).length) {110    logger.error("Got some configuration version mismatches. Appium is " +111                 "at " + appiumVer + ".");112    _.each(versionMismatches, function (mismatchedVer, key) {113      logger.error(key + " configured at " + mismatchedVer);114    });115    logger.error("Please re-run reset.sh or config");116    return cb(new Error("Appium / config version mismatch"));117  } else {118    appiumServer.registerConfig(rawConfig);119    cb(null, appiumRev);120  }121};122module.exports.conditionallyPreLaunch = function (args, appiumServer, cb) {123  if (args.launch) {124    logger.debug("Starting Appium in pre-launch mode");125    appiumServer.preLaunch(function (err) {126      if (err) {127        logger.error("Could not pre-launch appium: " + err);128        cb(err);129      } else {130        cb(null);131      }132    });133  } else {134    cb(null);135  }136};137module.exports.prepareTmpDir = function (args, cb) {138  if (args.tmpDir === null) return cb();139  mkdirp(args.tmpDir, function (err) {140    if (err) {141      logger.error("Could not ensure tmp dir '" + args.tmpDir + "' exists");142      logger.error(err);143    }144    cb(err);145  });146};147var startAlertSocket = function (restServer, appiumServer) {148  var alerts = io(restServer, {149    'flash policy port': -1,150    'logger': logger,151    'log level': 1,152    'polling duration': 10,153    'transports': ['websocket', 'flashsocket']154  });155  alerts.sockets.on("connection", function (socket) {156    logger.debug("Client connected: " + (socket.id).toString());157    socket.on('disconnect', function (data) {158      logger.debug("Client disconnected: " + data);159    });160  });161  // add web socket so we can emit events162  appiumServer.attachSocket(alerts);163};164var getNonDefaultArgs = function (parser, args) {165  var nonDefaults = {};166  _.each(parser.rawArgs, function (rawArg) {167    var arg = rawArg[1].dest;168    if (args[arg] !== rawArg[1].defaultValue) {169      nonDefaults[arg] = args[arg];170    }171  });172  return nonDefaults;173};174var getDeprecatedArgs = function (parser, args) {175  var deprecated = {};176  _.each(parser.rawArgs, function (rawArg) {177    var arg = rawArg[1].dest;178    if (args[arg] && rawArg[1].deprecatedFor) {179      deprecated[rawArg[0]] = "use instead: " + rawArg[1].deprecatedFor;180    }181  });182  return deprecated;183};184module.exports.startListening = function (server, args, parser, appiumVer, appiumRev, appiumServer, cb) {185  var alreadyReturned = false;186  server.listen(args.port, args.address, function () {187    var welcome = "Welcome to Appium v" + appiumVer;188    if (appiumRev) {189      welcome += " (REV " + appiumRev + ")";190    }191    logger.info(welcome);192    var logMessage = "Appium REST http interface listener started on " +193                     args.address + ":" + args.port;194    logger.info(logMessage);195    startAlertSocket(server, appiumServer);196    if (args.nodeconfig !== null) {197      gridRegister.registerNode(args.nodeconfig, args.address, args.port);198    }199    var showArgs = getNonDefaultArgs(parser, args);200    if (_.size(showArgs)) {201      logger.debug("Non-default server args: " + JSON.stringify(showArgs));202    }203    var deprecatedArgs = getDeprecatedArgs(parser, args);204    if (_.size(deprecatedArgs)) {205      logger.warn("Deprecated server args: " + JSON.stringify(deprecatedArgs));206    }207    logger.info('Console LogLevel: ' + logger.transports.console.level);208    if (logger.transports.file) {209      logger.info('File LogLevel: ' + logger.transports.file.level);210    }211  });212  server.on('error', function (err) {213    if (err.code === 'EADDRNOTAVAIL') {214      logger.error("Couldn't start Appium REST http interface listener. Requested address is not available.");215    } else {216      logger.error("Couldn't start Appium REST http interface listener. Requested port is already in use. Please make sure there's no other instance of Appium running already.");217    }218    if (!alreadyReturned) {219      alreadyReturned = true;220      cb(err);221    }222  });223  server.on('connection', function (socket) {224    socket.setTimeout(600 * 1000); // 10 minute timeout225  });226  setTimeout(function () {227    if (!alreadyReturned) {228      alreadyReturned = true;229      cb(null);230    }231  }, 1000);232};233// Copied the morgan compile function over so that cooler formats234// may be configured235function compile(fmt) {236  fmt = fmt.replace(/"/g, '\\"');237  var js = '  return "' + fmt.replace(/:([-\w]{2,})(?:\[([^\]]+)\])?/g,238    function (_, name, arg) {239      return '"\n    + (tokens["' + name + '"](req, res, "' + arg + '") || "-") + "';240    }) + '";';241  // jshint evil:true242  return new Function('tokens, req, res', js);243}244module.exports.requestStartLoggingFormat = compile('-->'.white + ' ' + ':method'.white + ' ' +245  ':url'.white);246// Copied the morgan format.dev function, modified to use colors package247// and custom logging line248module.exports.requestEndLoggingFormat = function (tokens, req, res) {249  var status = res.statusCode;250  var statusStr = ':status';251  if (status >= 500) statusStr = statusStr.red;252  else if (status >= 400) statusStr = statusStr.yellow;253  else if (status >= 300) statusStr = statusStr.cyan;254  else statusStr = statusStr.green;255  var fn = compile('<-- :method :url '.white + statusStr +256    ' :response-time ms - :res[content-length]'.grey);257  return fn(tokens, req, res);258};259function getRequestContext(req) {260  if (!req) return '';261  var data = '';262  try {263    if (req.body) data = JSON.stringify(req.body).substring(0, 200);264  } catch (ign) {}265  return format('context: [%s %s %s]', req.method, req.url, data).replace(/ ]$/, '');266}267// Mainly used to wrap http response methods, or for cases where errors268// perdure the domain269var safely = function () {270  var args = new (Args)(arguments);271  var req = args.all[0];272  var fn = args.callback;273  try {274    fn();275  } catch (err) {276    logger.error('Unexpected error:', err.stack, getRequestContext(req));277  }278};279module.exports.safely = safely;280module.exports.domainMiddleware = function () {281  return function (req, res, next) {282    var reqDomain = domain.create();283    reqDomain.add(req);284    reqDomain.add(res);285    res.on('close', function () {286      setTimeout(function () {287        reqDomain.dispose();288      }, 5000);289    });290    reqDomain.on('error', function (err) {291      logger.error('Unhandled error:', err.stack, getRequestContext(req));292    });293    reqDomain.run(next);294  };...

...78    , server = http.createServer(rest);79  rest.use(domainMiddleware());80  rest.use(morgan(function (tokens, req, res) {81    // morgan output is redirected straight to winston82    logger.info(requestEndLoggingFormat(tokens, req, res),83      (res.jsonResp || '').grey);84  }));85  rest.use(favicon(path.join(__dirname, 'static/favicon.ico')));86  rest.use(express.static(path.join(__dirname, 'static')));87  rest.use(allowCrossDomain);88  rest.use(parserWrap);89  rest.use(bodyParser.urlencoded({extended: true}));90  rest.use(bodyParser.json({limit: '50mb'}));91  rest.use(morgan({format: function (tokens, req, res) {92    // morgan output is redirected straight to winston93    var data = '';94    try {95      if (req.body) data = JSON.stringify(req.body).substring(0, 1000);96    } catch (ign) {}...

...29  let fn = compile(`${'<-- :method :url '.white}${statusStr} ${':response-time ms - :res[content-length]'.grey}`);30  return fn(tokens, req, res);31}32const endLogFormatter = morgan((tokens, req, res) => {33  log.info(requestEndLoggingFormat(tokens, req, res),34    (res.jsonResp || '').grey);35});36const requestStartLoggingFormat = compile(`${'-->'.white} ${':method'.white} ${':url'.white}`);37const startLogFormatter = morgan((tokens, req, res) => {38  // morgan output is redirected straight to winston39  let data = '';40  try {41    if (req.body) {42      data = JSON.stringify(req.body).substring(0, 1000);43    }44  } catch (ign) {}45  log.info(requestStartLoggingFormat(tokens, req, res), data.grey);46}, {immediate: true});47export { endLogFormatter, startLogFormatter };