mqtt-devices-parser 1.0.32 → 1.0.33

package/src/db/device.js

@@ -1,3 +1,4 @@
+const logger = require('../logger').child({ label: 'Device database' });
 const moment = require('moment');
 var mysql = require('mysql2')
 
@@ -18,7 +19,7 @@ var self = module.exports = {
 					return resolve(null);
 			})
 			.catch( err => {
-				console.log(err);
+				logger.info(err);
 				return resolve(null);
 			});
 		});
@@ -39,7 +40,7 @@ var self = module.exports = {
 					return resolve(null);
 			})
 			.catch( err => {
-				console.log(err);
+				logger.info(err);
 				return resolve(null);
 			});
 		});
@@ -60,7 +61,7 @@ var self = module.exports = {
 					return resolve(null);
 			})
 			.catch( err => {
-				console.log(err);
+				logger.info(err);
 				return resolve(null);
 			});
 		});
@@ -81,7 +82,7 @@ var self = module.exports = {
 					return resolve(null);
 			})
 			.catch( err => {
-				console.log(err);
+				logger.info(err);
 				return resolve(null);
 			});
 		});
@@ -102,7 +103,7 @@ var self = module.exports = {
 					return resolve(null);
 			})
 			.catch( err => {
-				console.log(err);
+				logger.info(err);
 				return resolve(null);
 			});
 		});
@@ -123,7 +124,7 @@ var self = module.exports = {
 					return resolve(null);
 			})
 			.catch( err => {
-				console.log(err);
+				logger.info(err);
 				return resolve(null);
 			});
 		});
@@ -445,6 +446,27 @@ var self = module.exports = {
 	    let args = ["sensors",deviceId,ref];
 	    query = mysql.format(query,args);
 
+	    $.db.queryRow(query)
+	    .then( rows => {
+	      if(rows.length > 0)
+	        return resolve(rows);
+	      else
+	        return resolve(null);
+	    })
+	    .catch( err => {
+	      logger.info(err);
+	      return resolve(null);
+	    });
+	  });
+	},
+
+	getActuatorsByRef : async(deviceId, ref)=>{
+		return new Promise((resolve,reject) => {
+
+	    let query = "SELECT * FROM ?? where device_id = ? and ref = ?";
+	    let args = ["actuators",deviceId,ref];
+	    query = mysql.format(query,args);
+
 	    $.db.queryRow(query)
 	    .then( rows => {
 	      if(rows.length > 0)
@@ -474,7 +496,7 @@ var self = module.exports = {
 	        return resolve(null);
 	    })
 	    .catch( err => {
-	      console.log(err);
+	      logger.info(err);
 	      return resolve(null);
 	    });
 	  });

package/src/db/firmware.js

@@ -1,3 +1,4 @@
+const logger = require('../logger').child({ label: 'Firmware database' });
 const moment = require('moment');
 var mysql = require('mysql2')
 
@@ -22,7 +23,7 @@ var self = module.exports = {
 	        return resolve(null);
 	    })
 	    .catch( err => {
-	      console.log(err);
+	      logger.info(err);
 	      return resolve(null);
 	    });
 	  });
@@ -51,7 +52,7 @@ var self = module.exports = {
 	        return resolve(null);
 	    })
 	    .catch( err => {
-	      console.log(err);
+	      logger.info(err);
 	      return resolve(null);
 	    });
 	  });
@@ -80,7 +81,7 @@ var self = module.exports = {
 	        return resolve(null);
 	    })
 	    .catch( err => {
-	      console.log(err);
+	      logger.info(err);
 	      return resolve(null);
 	    });
 	  });

package/src/db/fota.js

@@ -1,3 +1,4 @@
+const logger = require('../logger').child({ label: 'FOTA database' });
 const moment = require('moment');
 var mysql = require('mysql2')
 
@@ -74,7 +75,7 @@ var self = module.exports = {
 		  return resolve(rows);
 	    })
 	    .catch( err => {
-	      console.log(err);
+	      logger.info(err);
 	      return resolve(null);
 	    });
 	  });

package/src/db/model.js

@@ -1,3 +1,4 @@
+const logger = require('../logger').child({ label: 'Model database' });
 const moment = require('moment');
 var mysql = require('mysql2')
 
@@ -19,7 +20,7 @@ var self = module.exports = {
 	        return resolve(null);
 	    })
 	    .catch( err => {
-	      console.log(err);
+	      logger.info(err);
 	      return resolve(null);
 	    });
 	  });
@@ -41,7 +42,7 @@ var self = module.exports = {
 	        return resolve(null);
 	    })
 	    .catch( err => {
-	      console.log(err);
+	      logger.info(err);
 	      return resolve(null);
 	    });
 	  });
@@ -60,7 +61,7 @@ var self = module.exports = {
 		  return resolve(rows);
 	    })
 	    .catch( err => {
-	      console.log(err);
+	      logger.info(err);
 	      return resolve(null);
 	    });
 	  });
@@ -127,7 +128,7 @@ var self = module.exports = {
 	        return resolve(null);
 	    })
 	    .catch( err => {
-	      console.log(err);
+	      logger.info(err);
 	      return resolve(null);
 	    });
 	  });

package/src/db/sensor.js

@@ -1,3 +1,4 @@
+const logger = require('../logger').child({ label: 'Sensor database' });
 const moment = require('moment');
 var mysql = require('mysql2')
 const table = "sensors"
@@ -20,7 +21,7 @@ var self = module.exports = {
 	        return resolve(null);
 	    })
 	    .catch( err => {
-	      console.log(err);
+	      logger.info(err);
 	      return resolve(null);
 	    });
 	  });
@@ -43,7 +44,7 @@ var self = module.exports = {
 	        return resolve(null);
 	    })
 	    .catch( err => {
-	      console.log(err);
+	      logger.info(err);
 	      return resolve(null);
 	    });
 	  });
@@ -65,7 +66,7 @@ var self = module.exports = {
 	        return resolve(null);
 	    })
 	    .catch( err => {
-	      console.log(err);
+	      logger.info(err);
 	      return resolve(null);
 	    });
 	  });
@@ -84,7 +85,7 @@ var self = module.exports = {
 		  return resolve(rows);
 	    })
 	    .catch( err => {
-	      console.log(err);
+	      logger.info(err);
 	      return resolve(null);
 	    });
 	  });

package/src/device/device.js

@@ -1,20 +1,21 @@
+const logger = require('../logger').child({ label: 'Device' });
 const moment = require('moment');
 const { isDeepStrictEqual } = require('node:util');
 
 var _project = [];
-const table = "sensors"
-const logs_table = "logs_sensor";
 const semver = require('semver');
 
+const deviceLogger = (device) => logger.child({ deviceId: device?.uid || device?.id });
+
 var self = module.exports = {
 
   init : async (config,projects)=>{
     return new Promise(async (resolve,reject) => {
       $.db.connect(config,()=>{
-        console.log("MYSQL is connected");
+        logger.info("MYSQL is connected");
 
         projects.map( async (name,counter)=>{
-          console.log("project:",name)
+          logger.info("project:",name)
           _project[name] = {
             module : null
           };
@@ -92,10 +93,10 @@ var self = module.exports = {
       const oneWeekAgo = moment().utc().subtract(7, 'days').format('YYYY-MM-DD HH:mm:ss');
       if(tableName.startsWith("logs_")){
         const uptimeSeconds = Math.floor(process.uptime());
-        console.log(`deleting logs of table ${tableName} older than ${oneWeekAgo}"`);
+        logger.info(`deleting logs of table ${tableName} older than ${oneWeekAgo}"`);
         await $.db.deleteOldEntries(tableName, { createdAt: oneWeekAgo });
         time = Math.floor(process.uptime()) - uptimeSeconds;
-        console.log(`Logs of table ${tableName} deleted in ${time}s`);
+        logger.info(`Logs of table ${tableName} deleted in ${time}s`);
       }
     }
   },
@@ -109,7 +110,7 @@ var self = module.exports = {
 
     for (const model of models) {
       
-      //console.log("model:",model?.name);
+      //logger.info("model:",model?.name);
       if(!model?.id)
         continue;
 
@@ -139,8 +140,8 @@ var self = module.exports = {
           }
 
           const { latestVersion, latestAppVersion } = firmwareCache.get(cacheKey);
-          //console.log("latestVersion:",latestVersion?.version);
-          //console.log("latestAppVersion:",latestAppVersion?.app_version);
+          //logger.info("latestVersion:",latestVersion?.version);
+          //logger.info("latestAppVersion:",latestAppVersion?.app_version);
 
           if(!latestVersion && !latestAppVersion)
             continue;
@@ -175,20 +176,20 @@ var self = module.exports = {
 
               if (res == null) {
                 try {
-                  console.log("add fota entry for device:", device.uid);
+                  deviceLogger(device).info("add fota entry");
                   await $.db_fota.update(device.id, obj);
                 } catch (err) {
-                  console.error("Error updating FOTA entry:", err);
+                  deviceLogger(device).error({ err }, "Error updating FOTA entry");
                 }
               }
               
             } catch (error) {
-              console.error("Error getting or processing FOTA entry:", error);
+              deviceLogger(device).error({ err: error }, "Error getting or processing FOTA entry");
             }
           }
         }
       }catch(error){
-        console.error(error);
+        logger.error(error);
         continue;
       }
     }
@@ -237,7 +238,7 @@ var self = module.exports = {
             topic = mqtt_prefix+"/fw/fota/update/set";
           }
           let link = `${$.config.web.protocol}${$.config.web.domain}${$.config.web.fw_path}${firmware?.filename}/download?token=${firmware?.token}`;
-          console.log(`Requesting firmware update for ${device.uid} to ${firmware?.filename}`);
+          deviceLogger(device).info(`Requesting firmware update to ${firmware?.filename}`);
           $.mqtt_client.publish(topic,`{"url":"${link}"}`,{qos:1,retain:false});
 
           let obj = {
@@ -269,6 +270,9 @@ var self = module.exports = {
 
   updateSensor : async (device,ref,payload)=>{
 
+    const table = "sensors"
+    const logs_table = "logs_sensor";
+
     let sensors = await $.db_device.getSensorsByRef(device.id,ref)
 
     if(!sensors?.length)
@@ -317,6 +321,55 @@ var self = module.exports = {
     })
   },
 
+  updateActuator : async (device,ref,payload)=>{
+
+    const table = "actuators"
+    const logs_table = "logs_actuators";
+
+    let actuators = await $.db_device.getActuatorsByRef(device.id,ref)
+
+    if(!actuators?.length)
+      return;
+
+    const object = payload;
+    
+    for (const actuator of actuators) {
+      let value = null;
+      let error = null;
+      if(actuator?.type === "json" && object !== null && typeof object === 'object'){
+        if(Object.hasOwnProperty.call(object,actuator?.property)){
+          value = object[actuator.property];
+        }
+      }else{
+        if (typeof object === 'object') {
+          value = object?.value ?? object?.v;
+          error = object?.error ?? object?.e;
+        }else{
+          value = payload;
+        }
+      }
+      if(payload == null || value || error){
+
+        const data = {
+          value,
+          error,
+        }
+
+        let filter = {
+          id : actuator.id
+        }
+
+        await $.db_actuator.update(table,data,filter);
+        if(payload == null){
+          const lastLogId = await $.db_actuator.getLastLogId(logs_table,actuator.id);
+          if(lastLogId != null)
+            await $.db_actuator.confirmMessage(logs_table,lastLogId);
+        }else
+          await $.db_actuator.insert(logs_table,device.id,actuator.id,data);    
+      }
+    }
+  },
+
   handleMqttTopic : async(device, dbTopic, payload, set)=>{
     if(set){
       if(payload === "" || payload == null){
@@ -341,7 +394,7 @@ var self = module.exports = {
           $.db_device.setSynchedTopic(dbTopic.id,false);
       })
       .catch((error)=>{
-        console.error(error);
+        logger.error(error);
       })
     }else{
       // update remote topic
@@ -364,7 +417,7 @@ var self = module.exports = {
         }
       })
       .catch((error)=>{
-        console.error(error);
+        logger.error(error);
       })
 
     }
@@ -392,7 +445,7 @@ var self = module.exports = {
 
 async function parseLwm2mMessage(client, project_name, device, topic, payload, action){
 
-  console.log("parse lwm2m message: ",topic);
+  deviceLogger(device).info({ topic }, "parse lwm2m message");
 
   try{
     payload = JSON.parse(payload);
@@ -420,6 +473,8 @@ async function parseLwm2mMessage(client, project_name, device, topic, payload, a
 
 async function parseMqttMessage(client, project_name, device, topic, payload, retain){
 
+  const log = deviceLogger(device);
+
   if(topic.endsWith("/get")){
     let findTopic = $.parser.getWordBeforeLastSlash(topic);
     const dbTopic = await $.db_device.getMqttTopic(device.id,findTopic)
@@ -433,7 +488,7 @@ async function parseMqttMessage(client, project_name, device, topic, payload, re
   }
 
   const topicBck = topic;
-  //console.log("[MQTT] parse topic: ",topic);
+  //logger.info("[MQTT] parse topic: ",topic);
 
   try{
     payload = JSON.parse(payload);
@@ -518,7 +573,7 @@ async function parseMqttMessage(client, project_name, device, topic, payload, re
             let rows = await $.db_data.updateJson("fw",device.id,payload);
             rows = await $.db_data.addJsonLog("logs_fw",device.id,payload,word);
           }catch(error){
-            console.error(error)
+            log.error(error)
           } 
         }else if(typeof payload !== 'object' && payload !== null){
           // change it to topic.startsWith("fw")
@@ -527,7 +582,7 @@ async function parseMqttMessage(client, project_name, device, topic, payload, re
             let rows = await $.db_data.update("fw",device.id,column,payload);
             rows = await $.db_data.addLog("logs_fw",device.id,column,payload);
           }catch(error){
-            console.error(error)
+            log.error(error)
           } 
         }
       }
@@ -553,14 +608,17 @@ async function parseMqttMessage(client, project_name, device, topic, payload, re
   }
 
   const dbTopic = await $.db_device.getMqttTopic(device.id,findTopic)
-  if(dbTopic != null){
+  if(dbTopic != null){ // mqtt topic is known and it's a setting
     self.handleMqttTopic(device,dbTopic,payload,set);
   }
 
-  // check if topic is a sensor
-  if(!set)
-    self.updateSensor(device,topicBck,payload);
   
+  if(!set) // check if topic is a sensor
+    self.updateSensor(device,topicBck,payload);
+  else{ // check if topic is an actuator
+    self.updateActuator(device,findTopic,payload);
+  }
+
   if(_project[project_name]){
     _project[project_name]?.module?.parseMessage(client,project_name,device,`${word}/${topic}`,payload,retain,()=>{});
   }
@@ -579,7 +637,7 @@ async function synchMqttTopic(device,dbTopic){
       else
         payload = JSON.stringify(dbTopic?.localData);
     }catch(err){
-      console.error(err);
+      logger.error(err);
       return;
     }
   }else{
@@ -598,7 +656,7 @@ async function updateLocalSettings(device,topic,payload){
   let route = topic.split("/");
 
   if (route == null || route.length == 0) {
-    console.warn("updateLocalSettings: topic invalid:", topic);
+    deviceLogger(device).warn({ topic }, "updateLocalSettings: topic invalid");
     return;
   }
 
@@ -627,7 +685,7 @@ async function updateLocalSettings(device,topic,payload){
   if (typeof payload === 'object' && !Array.isArray(payload)) {
     Object.assign(obj, payload);
   } else {
-    console.warn("Payload is not a valid object:", payload);
+    deviceLogger(device).warn({ payload }, "Payload is not a valid object");
     return;
   }
 
@@ -635,7 +693,7 @@ async function updateLocalSettings(device,topic,payload){
     // Update the settings in the database
     await $.db_device.updateLocalSettings(JSON.stringify(settings), device.id);
   } catch (err) {
-    console.error("Failed to update local settings:", err);
+    deviceLogger(device).error({ err }, "Failed to update local settings");
   }
 }
 
@@ -649,7 +707,7 @@ async function updateRemoteSettings(device,topic,payload){
   let route = topic.split("/");
 
   if(route == null){
-    console.warn("updateRemoteSettings: topic invalid:",topic);
+    deviceLogger(device).warn({ topic }, "updateRemoteSettings: topic invalid");
     return;
   }
   // Parse existing settings
@@ -689,19 +747,19 @@ async function updateRemoteSettings(device,topic,payload){
     if(device?.synch && false)
       synchSettings(device,route[0]);
   } catch (err) {
-    console.error("Failed to update local settings:", err);
+    deviceLogger(device).error({ err }, "Failed to update remote settings");
   }
 }
 
 // deprecated - only defined mqtt topics can be synched
 async function synchSettings(device,key){
 
-  console.log(`check topic ${key} from ${device.uid}`);
+  logger.info(`check topic ${key} from ${device.uid}`);
   // Retrieve existing settings
   let localSettings = await $.db_device.getLocalSettings(device.id);
-  console.log(localSettings)
+  logger.info(localSettings)
   let remoteSettings = await $.db_device.getRemoteSettings(device.id);
-  console.log(remoteSettings)
+  logger.info(remoteSettings)
 
   //let keys = await checkSettings(localSettings,remoteSettings);
   /*
@@ -712,12 +770,12 @@ async function synchSettings(device,key){
       let topic = `${mqtt_prefix}/settings/${key}/set`
       try{
         const payload = JSON.stringify(localSettings[key]);
-        console.log(`updating key: ${key} with data:`);
-        console.log(payload);
+        logger.info(`updating key: ${key} with data:`);
+        logger.info(payload);
         $.mqtt_client.publish(topic,payload,{qos:1,retain:false});
       }catch(err){
-        console.error(localSettings[key])
-        console.error(err);
+        logger.error(localSettings[key])
+        logger.error(err);
       }
     }
   }

package/src/device/device.test.js

@@ -26,6 +26,7 @@ global.$ = {
     getById: jest.fn(),
     getMqttTopic: jest.fn(),
     getSensorsByRef: jest.fn(),
+    getActuatorsByRef: jest.fn(),
     updateLocalTopic: jest.fn(),
     setSynchedTopic: jest.fn(),
     updateRemoteTopic: jest.fn(),
@@ -41,6 +42,12 @@ global.$ = {
     getByRef: jest.fn(),
     insert: jest.fn()
   },
+  db_actuator: {
+    update: jest.fn(),
+    insert: jest.fn(),
+    getLastLogId: jest.fn(),
+    confirmMessage: jest.fn()
+  },
   db_data: {
     updateJson: jest.fn(),
     addJsonLog: jest.fn(),
@@ -76,19 +83,31 @@ global.BASE_DIR = '/mock/base/dir';
 
 // Mock require for project modules
 jest.mock('fs');
+jest.mock('../logger', () => {
+  const logger = {
+    child: jest.fn(() => logger),
+    info: jest.fn(),
+    warn: jest.fn(),
+    error: jest.fn()
+  };
+  return logger;
+});
 
 const device = require('./device');
+const logger = require('../logger');
 
 describe('Device Module', () => {
   beforeEach(() => {
     // Clear all mocks before each test
     jest.clearAllMocks();
+    logger.child.mockImplementation(() => logger);
 
     // Setup default mock implementations
     $.db.connect.mockImplementation((config, callback) => callback());
     $.db_project.getByName.mockResolvedValue(null);
     $.db_device.getMqttTopic.mockResolvedValue(null);
     $.db_device.getSensorsByRef.mockResolvedValue([]);
+    $.db_device.getActuatorsByRef.mockResolvedValue([]);
   });
 
   describe('init', () => {
@@ -308,6 +327,41 @@ describe('Device Module', () => {
     });
   });
 
+  describe('updateActuator', () => {
+    it('should update a matched actuator and insert a log for a non-null payload', async () => {
+      const mockDevice = { id: 42 };
+      const actuator = {
+        id: 7,
+        ref: 'mode',
+        type: 'number'
+      };
+
+      $.db_device.getActuatorsByRef.mockResolvedValue([actuator]);
+
+      await device.updateActuator(mockDevice, 'mode', { value: 1 });
+
+      expect($.db_actuator.update).toHaveBeenCalledWith('actuators', { value: 1, error: undefined }, { id: 7 });
+      expect($.db_actuator.insert).toHaveBeenCalledWith('logs_actuators', 42, 7, { value: 1, error: undefined });
+    });
+
+    it('should confirm the last actuator log when payload is null', async () => {
+      const mockDevice = { id: 42 };
+      const actuator = {
+        id: 9,
+        ref: 'fan',
+        type: 'number'
+      };
+
+      $.db_device.getActuatorsByRef.mockResolvedValue([actuator]);
+      $.db_actuator.getLastLogId.mockResolvedValue(15);
+
+      await device.updateActuator(mockDevice, 'fan', null);
+
+      expect($.db_actuator.getLastLogId).toHaveBeenCalledWith('logs_actuators', 9);
+      expect($.db_actuator.confirmMessage).toHaveBeenCalledWith('logs_actuators', 15);
+    });
+  });
+
   describe('deleteLogs', () => {
     it('should delete old logs from all log tables', async () => {
       const mockTables = [
@@ -319,15 +373,11 @@ describe('Device Module', () => {
       $.db.getTables.mockResolvedValue(mockTables);
       $.db.deleteOldEntries.mockResolvedValue();
 
-      const consoleSpy = jest.spyOn(console, 'log').mockImplementation();
-
       await device.deleteLogs();
 
       expect($.db.getTables).toHaveBeenCalled();
       expect($.db.deleteOldEntries).toHaveBeenCalledTimes(2); // Only log tables
-      expect(consoleSpy).toHaveBeenCalledWith(expect.stringContaining('deleting logs of table'));
-
-      consoleSpy.mockRestore();
+      expect(logger.info).toHaveBeenCalledWith(expect.stringContaining('deleting logs of table'));
     });
   });