Refactor logging to provide common logger from LoggerAdapter (#2478)

* Refactor logging to provide common logger from LoggerAdapter

Move logger logic de WinstonLoggerAdapter

Further improvements in configuration

Use logger instead of getLogger

- Removes PLog module

Reverts name changes

nits

* Adds additional logging levels as requirements

* Adds tests for logging configuration

* removes flaky test

* investigate...

* further investigation

* Adds silent option to disable console output

* Restores logs with VERBOSE in tests

* Expose controller instead of adapter, reduces method requirements for adapter

* Shuffles initializations around

* Fix doc

* Load cloudCode last to make sure the logger is available

* Adds test to make sure we can load an adapter from npm module

* extract defaults

* Adds defaultMongoURI to defaults

* fix defaults values

* Proper error for PG failures

* Disable flaky test

src/LiveQuery/Client.js

@@ -1,5 +1,5 @@
-import PLog from './PLog';
 import Parse from 'parse/node';
+import logger from '../logger';
 
 import type { FlattenedObjectData } from './Subscription';
 export type Message = { [attr: string]: any };
@@ -37,7 +37,7 @@ class Client {
   }
 
   static pushResponse(parseWebSocket: any, message: Message): void {
-    PLog.verbose('Push Response : %j', message);
+    logger.verbose('Push Response : %j', message);
     parseWebSocket.send(message);
   }
 

src/LiveQuery/PLog.js

@@ -1,5 +0,0 @@
-import { addGroup } from '../logger';
-
-let PLog = addGroup('parse-live-query-server');
-
-module.exports = PLog;

src/LiveQuery/ParseCloudCodePublisher.js

@@ -1,5 +1,5 @@
 import { ParsePubSub } from './ParsePubSub';
-import PLog from './PLog';
+import logger from '../logger';
 
 class ParseCloudCodePublisher {
   parsePublisher: Object;
@@ -20,7 +20,7 @@ class ParseCloudCodePublisher {
 
   // Request is the request object from cloud code functions. request.object is a ParseObject.
   _onCloudCodeMessage(type: string, request: any): void {
-    PLog.verbose('Raw request from cloud code current : %j | original : %j', request.object, request.original);
+    logger.verbose('Raw request from cloud code current : %j | original : %j', request.object, request.original);
     // We need the full JSON which includes className
     let message = {
       currentParseObject: request.object._toFullJSON()

src/LiveQuery/ParseLiveQueryServer.js

@@ -3,7 +3,7 @@ import Parse from 'parse/node';
 import { Subscription } from './Subscription';
 import { Client } from './Client';
 import { ParseWebSocketServer } from './ParseWebSocketServer';
-import PLog from './PLog';
+import logger from '../logger';
 import RequestSchema from './RequestSchema';
 import { matchesQuery, queryHash } from './QueryTools';
 import { ParsePubSub } from './ParsePubSub';
@@ -25,15 +25,14 @@ class ParseLiveQueryServer {
     this.subscriptions = new Map();
 
     config = config || {};
-    // Set LogLevel
-    PLog.level = config.logLevel || 'INFO';
+
     // Store keys, convert obj to map
     let keyPairs = config.keyPairs || {};
     this.keyPairs = new Map();
     for (let key of Object.keys(keyPairs)) {
       this.keyPairs.set(key, keyPairs[key]);
     }
-    PLog.verbose('Support key pairs', this.keyPairs);
+    logger.verbose('Support key pairs', this.keyPairs);
 
     // Initialize Parse
     Parse.Object.disableSingleInstance();
@@ -62,7 +61,7 @@ class ParseLiveQueryServer {
     // Register message handler for subscriber. When publisher get messages, it will publish message
     // to the subscribers and the handler will be called.
     this.subscriber.on('message', (channel, messageStr) => {
-      PLog.verbose('Subscribe messsage %j', messageStr);
+      logger.verbose('Subscribe messsage %j', messageStr);
       let message = JSON.parse(messageStr);
       this._inflateParseObject(message);
       if (channel === 'afterSave') {
@@ -70,7 +69,7 @@ class ParseLiveQueryServer {
       } else if (channel === 'afterDelete') {
         this._onAfterDelete(message);
       } else {
-        PLog.error('Get message %s from unknown channel %j', message, channel);
+        logger.error('Get message %s from unknown channel %j', message, channel);
       }
     });
 
@@ -100,16 +99,16 @@ class ParseLiveQueryServer {
   // Message is the JSON object from publisher after inflated. Message.currentParseObject is the ParseObject after changes.
   // Message.originalParseObject is the original ParseObject.
   _onAfterDelete(message: any): void {
-    PLog.verbose('afterDelete is triggered');
+    logger.verbose('afterDelete is triggered');
 
     let deletedParseObject = message.currentParseObject.toJSON();
     let className = deletedParseObject.className;
-    PLog.verbose('ClassName: %j | ObjectId: %s', className, deletedParseObject.id);
-    PLog.verbose('Current client number : %d', this.clients.size);
+    logger.verbose('ClassName: %j | ObjectId: %s', className, deletedParseObject.id);
+    logger.verbose('Current client number : %d', this.clients.size);
 
     let classSubscriptions = this.subscriptions.get(className);
     if (typeof classSubscriptions === 'undefined') {
-      PLog.error('Can not find subscriptions under this class ' + className);
+      logger.error('Can not find subscriptions under this class ' + className);
       return;
     }
     for (let subscription of classSubscriptions.values()) {
@@ -131,7 +130,7 @@ class ParseLiveQueryServer {
             }
             client.pushDelete(requestId, deletedParseObject);
           }, (error) => {
-            PLog.error('Matching ACL error : ', error);
+            logger.error('Matching ACL error : ', error);
           });
         }
       }
@@ -141,7 +140,7 @@ class ParseLiveQueryServer {
   // Message is the JSON object from publisher after inflated. Message.currentParseObject is the ParseObject after changes.
   // Message.originalParseObject is the original ParseObject.
   _onAfterSave(message: any): void {
-    PLog.verbose('afterSave is triggered');
+    logger.verbose('afterSave is triggered');
 
     let originalParseObject = null;
     if (message.originalParseObject) {
@@ -149,12 +148,12 @@ class ParseLiveQueryServer {
     }
     let currentParseObject = message.currentParseObject.toJSON();
     let className = currentParseObject.className;
-    PLog.verbose('ClassName: %s | ObjectId: %s', className, currentParseObject.id);
-    PLog.verbose('Current client number : %d', this.clients.size);
+    logger.verbose('ClassName: %s | ObjectId: %s', className, currentParseObject.id);
+    logger.verbose('Current client number : %d', this.clients.size);
 
     let classSubscriptions = this.subscriptions.get(className);
     if (typeof classSubscriptions === 'undefined') {
-      PLog.error('Can not find subscriptions under this class ' + className);
+      logger.error('Can not find subscriptions under this class ' + className);
       return;
     }
     for (let subscription of classSubscriptions.values()) {
@@ -192,7 +191,7 @@ class ParseLiveQueryServer {
             originalACLCheckingPromise,
             currentACLCheckingPromise
           ).then((isOriginalMatched, isCurrentMatched) => {
-            PLog.verbose('Original %j | Current %j | Match: %s, %s, %s, %s | Query: %s',
+            logger.verbose('Original %j | Current %j | Match: %s, %s, %s, %s | Query: %s',
               originalParseObject,
               currentParseObject,
               isOriginalSubscriptionMatched,
@@ -220,7 +219,7 @@ class ParseLiveQueryServer {
             let functionName = 'push' + type;
             client[functionName](requestId, currentParseObject);
           }, (error) => {
-            PLog.error('Matching ACL error : ', error);
+            logger.error('Matching ACL error : ', error);
           });
         }
       }
@@ -232,12 +231,12 @@ class ParseLiveQueryServer {
       if (typeof request === 'string') {
         request = JSON.parse(request);
       }
-      PLog.verbose('Request: %j', request);
+      logger.verbose('Request: %j', request);
 
       // Check whether this request is a valid request, return error directly if not
       if (!tv4.validate(request, RequestSchema['general']) || !tv4.validate(request, RequestSchema[request.op])) {
         Client.pushError(parseWebsocket, 1, tv4.error.message);
-        PLog.error('Connect message error %s', tv4.error.message);
+        logger.error('Connect message error %s', tv4.error.message);
         return;
       }
 
@@ -253,15 +252,15 @@ class ParseLiveQueryServer {
           break;
         default:
           Client.pushError(parseWebsocket, 3, 'Get unknown operation');
-          PLog.error('Get unknown operation', request.op);
+          logger.error('Get unknown operation', request.op);
       }
     });
 
     parseWebsocket.on('disconnect', () => {
-      PLog.log('Client disconnect: %d', parseWebsocket.clientId);
+      logger.info('Client disconnect: %d', parseWebsocket.clientId);
       let clientId = parseWebsocket.clientId;
       if (!this.clients.has(clientId)) {
-        PLog.error('Can not find client %d on disconnect', clientId);
+        logger.error('Can not find client %d on disconnect', clientId);
         return;
       }
 
@@ -285,8 +284,8 @@ class ParseLiveQueryServer {
         }
       }
 
-      PLog.verbose('Current clients %d', this.clients.size);
-      PLog.verbose('Current subscriptions %d', this.subscriptions.size);
+      logger.verbose('Current clients %d', this.clients.size);
+      logger.verbose('Current subscriptions %d', this.subscriptions.size);
     });
   }
 
@@ -331,14 +330,14 @@ class ParseLiveQueryServer {
   _handleConnect(parseWebsocket: any, request: any): any {
     if (!this._validateKeys(request, this.keyPairs)) {
       Client.pushError(parseWebsocket, 4, 'Key in request is not valid');
-      PLog.error('Key in request is not valid');
+      logger.error('Key in request is not valid');
       return;
     }
     let client = new Client(this.clientId, parseWebsocket);
     parseWebsocket.clientId = this.clientId;
     this.clientId += 1;
     this.clients.set(parseWebsocket.clientId, client);
-    PLog.log('Create new client: %d', parseWebsocket.clientId);
+    logger.info('Create new client: %d', parseWebsocket.clientId);
     client.pushConnect();
   }
 
@@ -361,7 +360,7 @@ class ParseLiveQueryServer {
     // If we can not find this client, return error to client
     if (!parseWebsocket.hasOwnProperty('clientId')) {
       Client.pushError(parseWebsocket, 2, 'Can not find this client, make sure you connect to server before subscribing');
-      PLog.error('Can not find this client, make sure you connect to server before subscribing');
+      logger.error('Can not find this client, make sure you connect to server before subscribing');
       return;
     }
     let client = this.clients.get(parseWebsocket.clientId);
@@ -400,15 +399,15 @@ class ParseLiveQueryServer {
 
     client.pushSubscribe(request.requestId);
 
-    PLog.verbose('Create client %d new subscription: %d', parseWebsocket.clientId, request.requestId);
-    PLog.verbose('Current client number: %d', this.clients.size);
+    logger.verbose('Create client %d new subscription: %d', parseWebsocket.clientId, request.requestId);
+    logger.verbose('Current client number: %d', this.clients.size);
   }
 
   _handleUnsubscribe(parseWebsocket: any, request: any): any {
     // If we can not find this client, return error to client
     if (!parseWebsocket.hasOwnProperty('clientId')) {
       Client.pushError(parseWebsocket, 2, 'Can not find this client, make sure you connect to server before unsubscribing');
-      PLog.error('Can not find this client, make sure you connect to server before unsubscribing');
+      logger.error('Can not find this client, make sure you connect to server before unsubscribing');
       return;
     }
     let requestId = request.requestId;
@@ -416,7 +415,7 @@ class ParseLiveQueryServer {
     if (typeof client === 'undefined') {
       Client.pushError(parseWebsocket, 2, 'Cannot find client with clientId '  + parseWebsocket.clientId +
         '. Make sure you connect to live query server before unsubscribing.');
-      PLog.error('Can not find this client ' + parseWebsocket.clientId);
+      logger.error('Can not find this client ' + parseWebsocket.clientId);
       return;
     }
 
@@ -424,7 +423,7 @@ class ParseLiveQueryServer {
     if (typeof subscriptionInfo === 'undefined') {
       Client.pushError(parseWebsocket, 2, 'Cannot find subscription with clientId '  + parseWebsocket.clientId +
         ' subscriptionId ' + requestId + '. Make sure you subscribe to live query server before unsubscribing.');
-      PLog.error('Can not find subscription with clientId ' + parseWebsocket.clientId +  ' subscriptionId ' + requestId);
+      logger.error('Can not find subscription with clientId ' + parseWebsocket.clientId +  ' subscriptionId ' + requestId);
       return;
     }
 
@@ -446,14 +445,10 @@ class ParseLiveQueryServer {
 
     client.pushUnsubscribe(request.requestId);
 
-    PLog.verbose('Delete client: %d | subscription: %d', parseWebsocket.clientId, request.requestId);
+    logger.verbose('Delete client: %d | subscription: %d', parseWebsocket.clientId, request.requestId);
   }
 }
 
-ParseLiveQueryServer.setLogLevel = function(logLevel) {
-  PLog.logLevel = logLevel;
-}
-
 export {
   ParseLiveQueryServer
 }

src/LiveQuery/ParseWebSocketServer.js

@@ -1,4 +1,4 @@
-import PLog from './PLog';
+import logger from '../logger';
 
 let typeMap = new Map([['disconnect', 'close']]);
 
@@ -9,7 +9,7 @@ export class ParseWebSocketServer {
     let WebSocketServer = require('ws').Server;
     let wss = new WebSocketServer({ server: server });
     wss.on('listening', () => {
-      PLog.log('Parse LiveQuery Server starts running');
+      logger.info('Parse LiveQuery Server starts running');
     });
     wss.on('connection', (ws) => {
       onConnect(new ParseWebSocket(ws));

src/LiveQuery/SessionTokenCache.js

@@ -1,6 +1,6 @@
 import Parse from 'parse/node';
 import LRU from 'lru-cache';
-import PLog from './PLog';
+import logger from '../logger';
 
 class SessionTokenCache {
   cache: Object;
@@ -18,16 +18,16 @@ class SessionTokenCache {
     }
     let userId = this.cache.get(sessionToken);
     if (userId) {
-      PLog.verbose('Fetch userId %s of sessionToken %s from Cache', userId, sessionToken);
+      logger.verbose('Fetch userId %s of sessionToken %s from Cache', userId, sessionToken);
       return Parse.Promise.as(userId);
     }
     return Parse.User.become(sessionToken).then((user) => {
-      PLog.verbose('Fetch userId %s of sessionToken %s from Parse', user.id, sessionToken);
+      logger.verbose('Fetch userId %s of sessionToken %s from Parse', user.id, sessionToken);
       let userId = user.id;
       this.cache.set(sessionToken, userId);
       return Parse.Promise.as(userId);
     }, (error) => {
-      PLog.error('Can not fetch userId for sessionToken %j, error %j', sessionToken, error);
+      logger.error('Can not fetch userId for sessionToken %j, error %j', sessionToken, error);
       return Parse.Promise.error(error);
     });
   }

src/LiveQuery/Subscription.js

@@ -1,5 +1,5 @@
-import {matchesQuery, queryHash} from './QueryTools';
-import PLog from './PLog';
+import {matchesQuery, queryHash}  from './QueryTools';
+import logger from '../logger';
 
 export type FlattenedObjectData = { [attr: string]: any };
 export type QueryData = { [attr: string]: any };
@@ -29,13 +29,13 @@ class Subscription {
   deleteClientSubscription(clientId: number, requestId: number): void {
     let requestIds = this.clientRequestIds.get(clientId);
     if (typeof requestIds === 'undefined') {
-      PLog.error('Can not find client %d to delete', clientId);
+      logger.error('Can not find client %d to delete', clientId);
       return;
     }
 
     let index = requestIds.indexOf(requestId);
     if (index < 0) {
-      PLog.error('Can not find client %d subscription %d to delete', clientId, requestId);
+      logger.error('Can not find client %d subscription %d to delete', clientId, requestId);
       return;
     }
     requestIds.splice(index, 1);