Added option for pretty-printing event logging

Author: bflorian

lib/smart-app.js

@@ -16,7 +16,7 @@ module.exports = class SmartApp {
         this._clientId = options.clientId;
         this._clientSecret = options.clientSecret;
         this._id = options.appId;
-        this._log = new Log(options.logger, options.enableEventLogging);
+        this._log = new Log(options.logger, options.jsonSpace, options.enableEventLogging);
         this._permissions = options.permissions ? options.permissions : [];
         this._disableCustomDisplayName = options.disableCustomDisplayName === undefined ? false : options.disableCustomDisplayName;
         this._disableRemoveApp = options.disableRemoveApp === undefined ? false : options.disableRemoveApp;
@@ -77,12 +77,12 @@ module.exports = class SmartApp {
         return this;
     }
 
-    configureLogger(logger, enableEvents = false) {
-        this._log = new Log(logger, enableEvents);
+    configureLogger(logger, jsonSpace=null, enableEvents = false) {
+        this._log = new Log(logger, jsonSpace, enableEvents);
     }
 
-    enableEventLogging(enabled = true) {
-        this._log.enableEvents(enabled);
+    enableEventLogging(jsonSpace=null, enableEvents = true) {
+        this._log.enableEvents(jsonSpace, enableEvents);
         return this;
     }
 

lib/util/log.js

@@ -7,8 +7,9 @@ const winston = require('winston');
  */
 module.exports = class Log {
 
-    constructor(logger, enableEvents = false) {
+    constructor(logger, jsonSpace = null, enableEvents = false) {
         this._eventsEnabled = enableEvents;
+        this._jsonSpace = jsonSpace;
         if (!logger) {
             this._logger = winston.createLogger({
                 level: 'debug',
@@ -24,7 +25,7 @@ module.exports = class Log {
     event (evt, suffix = '') {
         if ( this._eventsEnabled) {
             try {
-                this._logger.log ('debug', `${evt.lifecycle}${suffix ? `/${suffix}` : ''}\nREQUEST: ${JSON.stringify(evt, null, 2)}`);
+                this._logger.log ('debug', `${evt.lifecycle}${suffix ? `/${suffix}` : ''}\nREQUEST: ${JSON.stringify(evt, null, this._jsonSpace)}`);
             }
             catch (e) {
                 this._logger.log ('error', `${evt.lifecycle}${suffix ? `/${suffix}` : ''}\nREQUEST: ${e}`);
@@ -35,7 +36,7 @@ module.exports = class Log {
     response (data) {
         if ( this._eventsEnabled) {
             try {
-                this._logger.log('debug', `RESPONSE: ${JSON.stringify(data, null, 2)}`);
+                this._logger.log('debug', `RESPONSE: ${JSON.stringify(data, null, this._jsonSpace)}`);
             }
             catch (e) {
                 this._logger.log('debug', `RESPONSE: ${e}`);
@@ -63,7 +64,8 @@ module.exports = class Log {
         this._logger.log ('error', msg);
     }
 
-    enableEvents (value) {
-        this._eventsEnabled = value;
+    enableEvents (jsonSpace, enabled = true) {
+        this._eventsEnabled = enabled;
+        this._jsonSpace = jsonSpace;
     }
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartthings/smartapp",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "SDK for SmartApps using Node JS",
   "author": "SmartThings",
   "contributors": [

test/smartapp-page-spec.js

@@ -3,10 +3,11 @@ const {expect} = require('chai');
 const SmartApp = require('../lib/smart-app');
 
 describe ('smartapp-page-spec', () => {
+
     it('should set page ID', () => {
         const app = new SmartApp();
         app.appId('xxx');
-        app.page('eaMainPage', (page) => {
+        app.page('eaMainPage', (ctx, page) => {
             page.section('whenDoorOpensAndCloses', (section) => {
                 section.deviceSetting('contactSensor')
                     .capabilities(['contactSensor']);
@@ -63,4 +64,36 @@ describe ('smartapp-page-spec', () => {
         console.log(JSON.stringify(initResponse, null, 2));
         console.log(JSON.stringify(pageReponse, null, 2));
     });
+
+    it('should configure event logger', () => {
+        const app = new SmartApp();
+        app.appId('xxx');
+        app.enableEventLogging(4);
+        app.page('eaMainPage', (ctx, page) => {
+            page.section('whenDoorOpensAndCloses', (section) => {
+                section.deviceSetting('contactSensor')
+                    .capabilities(['contactSensor']);
+            });
+        });
+
+        app.handleMockCallback({
+            'lifecycle': 'CONFIGURATION',
+            'executionId': 'e6903fe6-f88f-da69-4c12-e2802606ccbc',
+            'locale': 'en',
+            'version': '0.1.0',
+            'client': {
+                'os': 'ios',
+                'version': '0.0.0',
+                'language': 'en-US'
+            },
+            'configurationData': {
+                'installedAppId': '7d7fa36d-0ad9-4893-985c-6b75858e38e4',
+                'phase': 'INITIALIZE',
+                'pageId': '',
+                'previousPageId': '',
+                'config': {}
+            },
+            'settings': {}
+        });
+    });
 });