Check version of app.js script

mikejac · Dec 29, 2022 · 29deae8 · 29deae8
1 parent d0d4b6b
commit 29deae8
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 1 deletion.
diff --git a/lib/HttpActions.js b/lib/HttpActions.js
@@ -332,6 +332,8 @@ class HttpActions {
                 case 'action.devices.IDENTIFY':
                     me._smarthome.debug('HttpActions:httpActionsRegister(/' + url + '): IDENTIFY');
 
+                    me._smarthome.checkAppJsVersion(reqdata.appJsVersion);
+
                     response.status(200).json({
                         requestId: reqdata.requestId,
                         payload: {

diff --git a/lib/SmartHome.js b/lib/SmartHome.js
@@ -26,6 +26,7 @@ const helmet        = require('helmet');
 const morgan        = require('morgan');
 const cors          = require('cors');
 const fs            = require('fs');
+const path          = require('path');
 const events        = require('events');
 const dnssd         = require('@gravitysoftware/dnssd');
 const udp           = require('dgram');
@@ -574,6 +575,43 @@ class GoogleSmartHome {
             }, me._setStateDelay);
         }
     }
+
+    /**
+     * Checks if the app.js script running on the smart speaker is the most up-to-date version.
+     *
+     * During the IDENTIFY request, the app.js script running on the smart speaker sends its version number. Here, we
+     * read the local app.js file, parse the version number out of the file and compare the version numbers with each
+     * other. If the version numbers do not match, the user gets a message on Node-RED's debug panel.
+     *
+     * @param {string} remoteAppJsVersion
+     */
+    checkAppJsVersion(remoteAppJsVersion) {
+        const appJsPath = path.resolve(__dirname, '../local-execution/app.js');
+        fs.readFile(appJsPath, 'utf8', (err, data) => {
+            if (err) {
+                this.error('SmartHome:checkAppJsVersion(): Cannot read app.js file (' + err + ')');
+                return;
+            }
+
+            const regex = /VERSION\s*=\s*'([0-9.]+)'/;
+            const matches = data.match(regex);
+            const localAppJsVersion = matches[1];
+
+            if(typeof localAppJsVersion === 'undefined') {
+                this.error('SmartHome:checkAppJsVersion(): Cannot parse version from app.js file');
+                return;
+            }
+
+            if(remoteAppJsVersion === localAppJsVersion) {
+                this.debug('SmartHome:checkAppJsVersion(): app.js on smart speaker is up to date (v' + localAppJsVersion + ')');
+            } else if(typeof remoteAppJsVersion === 'undefined') {
+                this._mgmtNode.warn('SmartHome:checkAppJsVersion(): app.js on smart speaker did not report version number. Please upload latest app.js as explained on https://github.com/mikejac/node-red-contrib-google-smarthome/blob/master/docs/local_fulfillment.md#updating-appjs.');
+            } else {
+                this._mgmtNode.warn('SmartHome:checkAppJsVersion(): app.js version on smart speaker did not match local app. Expected ' + localAppJsVersion + ', got ' + remoteAppJsVersion + '. Please upload latest app.js as explained on https://github.com/mikejac/node-red-contrib-google-smarthome/blob/master/docs/local_fulfillment.md#updating-appjs.');
+            }
+        });
+    }
+
     //
     //
     //

diff --git a/local-execution/app.js b/local-execution/app.js
@@ -1,6 +1,6 @@
 "use strict";
 
-const VERSION = '2.6';
+const VERSION = '2.7';
 
 /// <reference types="@google/local-home-sdk" />
 /*
@@ -143,6 +143,7 @@ const identifyHandler = async (request) => {
     }
     try {
         const nodeRedData = findNodeRedDeviceDataByClientId(request.requestId, request.devices, clientId);
+        request.appJsVersion = VERSION;
         return await forwardRequest(nodeRedData, "", request);
     }
     catch (err) {