Adds logger on cloud code request object

Author: flovilmart

spec/CloudCodeLogger.spec.js

@@ -0,0 +1,67 @@
+'use strict';
+var LoggerController = require('../src/Controllers/LoggerController').LoggerController;
+var FileLoggerAdapter = require('../src/Adapters/Logger/FileLoggerAdapter').FileLoggerAdapter;
+
+var clearLogs = require('../src/logger').clearLogs;
+var loggerController = new LoggerController(new FileLoggerAdapter());
+
+describe("Cloud Code Logger", () => {
+  beforeAll(() => {
+    clearLogs();
+  });
+  
+  afterAll(() => {
+    clearLogs();
+  });
+
+  it("should expose log to functions", (done) => {
+     Parse.Cloud.define("loggerTest", (req, res) => {
+       req.log('loggerTest', 'info log', { info: 'some log' });
+       req.logger.error('loggerTest','error log', {error: 'there was an error'});
+       res.success({});
+     }); 
+     
+     Parse.Cloud.run('loggerTest').then(() => {
+       Parse.Cloud._removeHook('Functions', 'loggerTest');
+       return loggerController.getLogs({})
+     }).then((res) => {
+       expect(res.length).not.toBe(0);
+       let lastLogs = res.slice(0, 2);
+       let errorMessage = lastLogs[0];
+       let infoMessage = lastLogs[1];
+       expect(errorMessage.level).toBe('error');
+       expect(errorMessage.error).toBe('there was an error');
+       expect(errorMessage.message).toBe('loggerTest error log');
+       expect(infoMessage.level).toBe('info');
+       expect(infoMessage.info).toBe('some log');
+       expect(infoMessage.message).toBe('loggerTest info log');
+       done();
+     });
+  });
+
+  it("should expose log to trigger", (done) => {
+     Parse.Cloud.beforeSave("MyObject", (req, res) => {
+       console.log('Before Save!!');
+       req.log('beforeSave MyObject', 'info log', { info: 'some log' });
+       req.logger.error('beforeSave MyObject','error log', {error: 'there was an error'});
+       res.success({});
+     }); 
+     let obj = new Parse.Object('MyObject')
+     obj.save().then(() => {
+       Parse.Cloud._removeHook('Triggers', 'beforeSave', 'MyObject');
+       return loggerController.getLogs({})
+     }).then((res) => {
+       expect(res.length).not.toBe(0);
+       let lastLogs = res.slice(0, 2);
+       let errorMessage = lastLogs[0];
+       let infoMessage = lastLogs[1];
+       expect(errorMessage.level).toBe('error');
+       expect(errorMessage.error).toBe('there was an error');
+       expect(errorMessage.message).toBe('beforeSave MyObject error log');
+       expect(infoMessage.level).toBe('info');
+       expect(infoMessage.info).toBe('some log');
+       expect(infoMessage.message).toBe('beforeSave MyObject info log');
+       done();
+     });
+  });
+});

spec/LoggerController.spec.js

@@ -1,7 +1,12 @@
 var LoggerController = require('../src/Controllers/LoggerController').LoggerController;
 var FileLoggerAdapter = require('../src/Adapters/Logger/FileLoggerAdapter').FileLoggerAdapter;
 
+var clearLogs = require('../src/logger').clearLogs;
+
 describe('LoggerController', () => {
+  afterEach(() => {
+    clearLogs();
+  });
   it('can check process a query witout throwing', (done) => {
     // Make mock request
     var query = {};

src/Routers/FunctionsRouter.js

@@ -4,8 +4,11 @@ var express = require('express'),
     Parse = require('parse/node').Parse,
     triggers = require('../triggers');
 
+import { addGroup } from '../logger';
 import PromiseRouter from '../PromiseRouter';
 
+let logger = addGroup('cloud-code');
+
 export class FunctionsRouter extends PromiseRouter {
 
   mountRoutes() {
@@ -38,8 +41,13 @@ export class FunctionsRouter extends PromiseRouter {
         params: params,
         master: req.auth && req.auth.isMaster,
         user: req.auth && req.auth.user,
-        installationId: req.info.installationId
+        installationId: req.info.installationId,
+        logger
       };
+      
+      request.log = function() {
+        logger.info.apply(logger, arguments);
+      }
 
       if (theValidator && typeof theValidator === "function") {
         var result = theValidator(request);

src/logger.js

@@ -10,6 +10,31 @@ if (typeof process !== 'undefined' && process.env.NODE_ENV === 'test') {
 }
 
 let currentLogsFolder = LOGS_FOLDER;
+let clearLogs;
+if (process.env.TESTING) {
+  
+  var rmDirContents = function(dirPath) {
+      try { var files = fs.readdirSync(dirPath); }
+      catch(e) { return; }
+      if (files.length > 0)
+        for (var i = 0; i < files.length; i++) {
+          var filePath = dirPath + '/' + files[i];
+          if (fs.statSync(filePath).isFile())
+            fs.unlinkSync(filePath);
+          else
+            rmDir(filePath);
+        }
+    };
+  clearLogs = function() {
+    let folder = currentLogsFolder;
+    if (!path.isAbsolute(folder)) {
+      folder = path.resolve(process.cwd(), folder);
+    }
+    rmDirContents(folder);
+  }
+}
+
+export { clearLogs };
 
 function generateTransports(level) {
   let transports = [

src/triggers.js

@@ -1,6 +1,7 @@
 // triggers.js
 import Parse from 'parse/node';
 import cache  from './cache';
+import { addGroup } from './logger';
 
 export const Types = {
   beforeSave: 'beforeSave',
@@ -113,6 +114,11 @@ export function getRequestObject(triggerType, auth, parseObject, originalParseOb
   if (auth.installationId) {
     request['installationId'] = auth.installationId;
   }
+  let ccLogger = addGroup('cloud-code');
+  request.logger = ccLogger;
+  request.log = function() {
+    ccLogger.info.apply(ccLogger, arguments);
+  }
   return request;
 }