homebridge-lib 5.3.2 → 5.4.0

package/cli/json.js

@@ -12,6 +12,10 @@
 const homebridgeLib = require('../index')
 
 const fs = require('fs')
+const util = require('util')
+const zlib = require('zlib')
+
+const gunzip = util.promisify(zlib.unzip)
 
 const { b, u } = homebridgeLib.CommandLineTool
 
@@ -21,26 +25,59 @@ const help = `JSON formatter.
 Usage: ${usage}
 
 By default, ${b('json')} reads JSON from stdin, formats it, and prints it to stdout.
-The following parameters modify this behaviour:
-  ${b('-h')}          Print this help and exit.
-  ${b('-V')}          Print version and exit.
-  ${b('-s')}          Sort object key/value pairs alphabetically on key.
-  ${b('-n')}          Do not include spaces nor newlines in output.
-  ${b('-j')}          Output JSON array of objects for each key/value pair.
-              Each object contains two key/value pairs: key "keys" with an array
-              of keys as value and key "value" with the value as value.
-  ${b('-u')}          Output JSON array of objects for each key/value pair.
-              Each object contains one key/value pair: the path (concatenated
-              keys separated by '/') as key and the value as value.
-  ${b('-a')}          Output path:value in plain text instead of JSON.
-  ${b('-t')}          Limit output to top-level key/values.
-  ${b('-p')} ${u('path')}     Limit output to key/values under ${u('path')}. Set top level below ${u('path')}.
-  ${b('-d')} ${u('depth')}    Limit output to levels above ${u('depth')}.
-  ${b('-l')}          Limit output to leaf (non-array, non-object) key/values.
-  ${b('-k')}          Limit output to keys. With ${b('-u')} output JSON array of paths.
-  ${b('-v')}          Limit output to values. With ${b('-u')} output JSON array of values.
-  ${b('-c')} ${u('string')}   Read JSON from ${u('string')} instead of from stdin.
-  ${u('file')}        Read JSON from ${u('file')} instead of from stdin.`
+
+Parameters:
+  ${b('-h')}, ${b('--help')}
+  Print this help and exit.
+
+  ${b('-V')}, ${b('--version')}
+  Print version and exit.
+
+  ${b('-s')}, ${b('--sortKeys')}
+  Sort object key/value pairs alphabetically on key.
+
+  ${b('-n')}, ${b('--noWhiteSpace')}
+  Do not include spaces nor newlines in output.
+
+  ${b('-j')}, ${b('--jsonArray')}
+  Output JSON array of objects for each key/value pair.
+  Each object contains two key/value pairs:
+  - key ${b('keys')} with an array of keys as value;
+  - key ${b('value')} with the value as value.
+
+  ${b('-u')}, ${b('--joinKeys')}
+  Output JSON array of objects for each key/value pair.
+  Each object contains one key/value pair:
+  the path (concatenated keys separated by ${b('/')} as key and the value as value.
+
+  ${b('-a')}, ${b('--ascii')}
+  Output ${u('path')}${b(':')}${u('value')} in plain text instead of JSON.
+
+  ${b('-t')}, ${b('--topOnly')}
+  Limit output to top-level key/values.
+
+  ${b('-p')} ${u('path')}, ${b('--fromPath=')}${u('path')}
+  Limit output to key/values under ${u('path')}. Set top level below ${u('path')}.
+
+  ${b('-d')} ${u('depth')}, ${b('--maxDepth=')}${u('depth')}
+  Limit output to levels above ${u('depth')}.
+
+  ${b('-l')}, ${b('--leavesOnly')}
+  Limit output to leaf (non-array, non-object) key/values.
+
+  ${b('-k')}, ${b('--keysOnly')}
+  Limit output to keys. With ${b('-u')} output JSON array of paths.
+
+  ${b('-v')}, ${b('--valuesOnly')}
+  Limit output to values. With ${b('-u')} output JSON array of values.
+
+  ${b('-c')} ${u('string')}, ${b('--string=')}${u('string')}
+  Read JSON from ${u('string')} instead of from stdin.
+
+  ${u('file')}
+  Read JSON from ${u('file')} instead of from stdin.
+  When the file name ends in ${b('.gz')}, it is assumed to be a gzip file and
+  uncompressed automatically.`
 
 class Main extends homebridgeLib.CommandLineTool {
   constructor () {
@@ -110,9 +147,11 @@ class Main extends homebridgeLib.CommandLineTool {
           this.error(error)
         }
       })
-      this.fileList.forEach((file) => {
+      this.fileList.forEach(async (file) => {
         try {
-          const s = fs.readFileSync(file === '-' ? 0 : file, 'utf8')
+          const s = file.endsWith('.gz')
+            ? await gunzip(fs.readFileSync(file))
+            : fs.readFileSync(file === '-' ? 0 : file, 'utf8')
           this.processString(s)
         } catch (error) {
           this.error(error)

package/lib/Platform.js

@@ -12,10 +12,12 @@ const fs = require('fs')
 const http = require('http')
 const semver = require('semver')
 const util = require('util')
+const zlib = require('zlib')
 
 const libPackageJson = require('../package.json')
 
 const uuid = /^[0-9A-F]{8}-[0-9A-F]{4}-[1-5][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/
+const gzip = util.promisify(zlib.gzip)
 
 const context = {
   libName: libPackageJson.name,
@@ -210,6 +212,39 @@ class Platform extends homebridgeLib.Delegate {
     }
   }
 
+  /** Create a debug dump file.
+    *
+    * The dump file is a gzipped json file containing
+    * - The hardware and software environment of the server running Homebridge;
+    * - The versions of the plugin and of homebridge-lib;
+    * - The contents of config.json;
+    * - Any plugin-specific information.
+    *
+    * The file is created in the Homebridge user directory, and named after
+    * the plugin.
+    * @param {*} dumpInfo - Plugin-specific information.
+    */
+  async createDumpFile (dumpInfo = {}) {
+    const result = {
+      hardware: this.systemInfo.hwInfo.prettyName,
+      os: this.systemInfo.osInfo.prettyName,
+      node: context.nodeVersion,
+      homebridge: context.homebridgeVersion
+    }
+    result[this._pluginName] = this._pluginVersion
+    result[context.libName] = context.libVersion
+    result.configJson = this._configJson
+    const filename = this._homebridge.user.storagePath() + '/' +
+      this._pluginName + '.json.gz'
+    try {
+      const data = await gzip(JSON.stringify(Object.assign(result, dumpInfo)))
+      await fs.promises.writeFile(filename, data)
+      this.log('created debug dump file %s', filename)
+    } catch (error) {
+      this.error('%s: %s', filename, error)
+    }
+  }
+
   // Write `cachedAccessories` to disk.
   _flushCachedAccessories () {
     this.debug('flush cachedAccessories')
@@ -237,7 +272,7 @@ class Platform extends homebridgeLib.Delegate {
 
     if (beat % context.checkInterval === 0) {
       this._checkLatest(this._pluginName, this._pluginVersion)
-      this._checkLatest(context.libName, context.libVersion)
+      // this._checkLatest(context.libName, context.libVersion)
     }
 
     /** Emitted every second.

package/package.json

@@ -3,7 +3,7 @@
   "description": "Library for homebridge plugins",
   "author": "Erik Baauw",
   "license": "Apache-2.0",
-  "version": "5.3.2",
+  "version": "5.4.0",
   "keywords": [
     "homekit",
     "homebridge"
@@ -28,7 +28,7 @@
     "@homebridge/plugin-ui-utils": "~0.0.19",
     "bonjour-hap": "^3.6.3",
     "chalk": "^4.1.2",
-    "semver": "^7.3.5"
+    "semver": "^7.3.7"
   },
   "scripts": {
     "prepare": "standard && mocha && rm -rf out && jsdoc -c jsdoc.json",