@depup/systeminformation 5.31.4-depup.0 → 5.33.1-depup.0

package/lib/docker.js

@@ -19,9 +19,8 @@ const DockerSocket = require('./dockerSocket');
 const _platform = process.platform;
 const _windows = _platform === 'win32';
 
-const _docker_container_stats = {};
+const _docker_cpu_last_read = {};
 let _docker_socket;
-let _docker_last_read = 0;
 
 // --------------------------
 // get containers (parameter all: get also inactive/exited containers)
@@ -123,7 +122,9 @@ function dockerImages(all, callback) {
               if (element.Names && Object.prototype.toString.call(element.Names) === '[object Array]' && element.Names.length > 0) {
                 element.Name = element.Names[0].replace(/^\/|\/$/g, '');
               }
-              workload.push(dockerImagesInspect(element.Id.trim(), element));
+              if (element.Id && typeof element.Id === 'string') {
+                workload.push(dockerImagesInspect(element.Id.trim(), element));
+              }
             });
             if (workload.length) {
               Promise.all(workload).then((data) => {
@@ -165,13 +166,13 @@ function dockerImagesInspect(imageID, payload) {
       if (typeof imageID !== 'string') {
         return resolve();
       }
-      const imageIDSanitized = (util.isPrototypePolluted() ? '' : util.sanitizeShellString(imageID, true)).trim();
+      const imageIDSanitized = util.isPrototypePolluted() ? '' : util.sanitizeImageID(imageID);
       if (imageIDSanitized) {
         if (!_docker_socket) {
           _docker_socket = new DockerSocket();
         }
 
-        _docker_socket.inspectImage(imageIDSanitized.trim(), (data) => {
+        _docker_socket.inspectImage(imageIDSanitized, (data) => {
           try {
             resolve({
               id: payload.Id,
@@ -188,8 +189,8 @@ function dockerImagesInspect(imageID, payload) {
               created: data.Created ? Math.round(new Date(data.Created).getTime() / 1000) : 0,
               containerConfig: data.ContainerConfig ? data.ContainerConfig : {},
               graphDriver: data.GraphDriver ? data.GraphDriver : {},
-              repoDigests: data.RepoDigests ? data.RepoDigests : {},
-              repoTags: data.RepoTags ? data.RepoTags : {},
+              repoDigests: data.RepoDigests ? data.RepoDigests : [],
+              repoTags: data.RepoTags ? data.RepoTags : [],
               config: data.Config ? data.Config : {},
               rootFS: data.RootFS ? data.RootFS : {}
             });
@@ -208,14 +209,7 @@ exports.dockerImages = dockerImages;
 
 function dockerContainers(all, callback) {
   function inContainers(containers, id) {
-    const filtered = containers.filter((obj) => {
-      /**
-       * @namespace
-       * @property {string}  Id
-       */
-      return obj.Id && obj.Id === id;
-    });
-    return filtered.length > 0;
+    return containers.some((obj) => obj.Id && obj.Id.indexOf(id) === 0);
   }
 
   // fallback - if only callback is given
@@ -244,11 +238,11 @@ function dockerContainers(all, callback) {
         try {
           docker_containers = data;
           if (docker_containers && Object.prototype.toString.call(docker_containers) === '[object Array]' && docker_containers.length > 0) {
-            // GC in _docker_container_stats
-            for (let key in _docker_container_stats) {
-              if ({}.hasOwnProperty.call(_docker_container_stats, key)) {
+            // GC in _docker_cpu_last_read
+            for (let key in _docker_cpu_last_read) {
+              if ({}.hasOwnProperty.call(_docker_cpu_last_read, key)) {
                 if (!inContainers(docker_containers, key)) {
-                  delete _docker_container_stats[key];
+                  delete _docker_cpu_last_read[key];
                 }
               }
             }
@@ -257,7 +251,9 @@ function dockerContainers(all, callback) {
               if (element.Names && Object.prototype.toString.call(element.Names) === '[object Array]' && element.Names.length > 0) {
                 element.Name = element.Names[0].replace(/^\/|\/$/g, '');
               }
-              workload.push(dockerContainerInspect(element.Id.trim(), element));
+              if (element.Id && typeof element.Id === 'string') {
+                workload.push(dockerContainerInspect(element.Id.trim(), element));
+              }
             });
             if (workload.length) {
               Promise.all(workload).then((data) => {
@@ -279,14 +275,6 @@ function dockerContainers(all, callback) {
             resolve(result);
           }
         } catch (err) {
-          // GC in _docker_container_stats
-          for (let key in _docker_container_stats) {
-            if ({}.hasOwnProperty.call(_docker_container_stats, key)) {
-              if (!inContainers(docker_containers, key)) {
-                delete _docker_container_stats[key];
-              }
-            }
-          }
           if (callback) {
             callback(result);
           }
@@ -307,13 +295,13 @@ function dockerContainerInspect(containerID, payload) {
       if (typeof containerID !== 'string') {
         return resolve();
       }
-      const containerIdSanitized = (util.isPrototypePolluted() ? '' : util.sanitizeShellString(containerID, true)).trim();
+      const containerIdSanitized = util.isPrototypePolluted() ? '' : util.sanitizeContainerID(containerID);
       if (containerIdSanitized) {
         if (!_docker_socket) {
           _docker_socket = new DockerSocket();
         }
 
-        _docker_socket.getInspect(containerIdSanitized.trim(), (data) => {
+        _docker_socket.getInspect(containerIdSanitized, (data) => {
           try {
             resolve({
               id: payload.Id,
@@ -327,10 +315,12 @@ function dockerContainerInspect(containerID, payload) {
               createdAt: data.Created ? data.Created : '',
               startedAt: data.State && data.State.StartedAt ? data.State.StartedAt : '',
               finishedAt: data.State && data.State.FinishedAt && !data.State.FinishedAt.startsWith('0001-01-01') ? data.State.FinishedAt : '',
+              status: data.State && data.State.Health && data.State.Health.Status ? data.State.Health.Status : '',
               state: payload.State,
               restartCount: data.RestartCount || 0,
               platform: data.Platform || '',
               driver: data.Driver || '',
+              labels: data.Config && data.Config.Labels ? data.Config.Labels : {},
               ports: payload.Ports,
               mounts: payload.Mounts
               // hostconfig: payload.HostConfig,
@@ -352,7 +342,7 @@ exports.dockerContainers = dockerContainers;
 // --------------------------
 // helper functions for calculation of docker stats
 
-function docker_calcCPUPercent(cpu_stats, precpu_stats) {
+function docker_calcCPUPercent(cpu_stats, precpu_stats, id) {
   /**
    * @namespace
    * @property {object}  cpu_usage
@@ -361,42 +351,47 @@ function docker_calcCPUPercent(cpu_stats, precpu_stats) {
    * @property {object}  cpu_usage
    * @property {Array}  cpu_usage.percpu_usage
    */
+  if (!cpu_stats || !cpu_stats.cpu_usage || !precpu_stats) {
+    return 0;
+  }
+  const precpuTotal = precpu_stats.cpu_usage && precpu_stats.cpu_usage.total_usage ? precpu_stats.cpu_usage.total_usage : 0;
 
   if (!_windows) {
     let cpuPercent = 0.0;
     // calculate the change for the cpu usage of the container in between readings
-    let cpuDelta = cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage;
+    const cpuDelta = cpu_stats.cpu_usage.total_usage - precpuTotal;
     // calculate the change for the entire system between readings
-    let systemDelta = cpu_stats.system_cpu_usage - precpu_stats.system_cpu_usage;
+    const systemDelta = cpu_stats.system_cpu_usage - (precpu_stats.system_cpu_usage || 0);
 
     if (systemDelta > 0.0 && cpuDelta > 0.0) {
       // calculate the change for the cpu usage of the container in between readings
       if (precpu_stats.online_cpus) {
         cpuPercent = (cpuDelta / systemDelta) * precpu_stats.online_cpus * 100.0;
-      } else {
+      } else if (cpu_stats.cpu_usage.percpu_usage && cpu_stats.cpu_usage.percpu_usage.length) {
         cpuPercent = (cpuDelta / systemDelta) * cpu_stats.cpu_usage.percpu_usage.length * 100.0;
       }
     }
 
     return cpuPercent;
   } else {
-    let nanoSecNow = util.nanoSeconds();
+    const nanoSecNow = util.nanoSeconds();
     let cpuPercent = 0.0;
-    if (_docker_last_read > 0) {
-      let possIntervals = nanoSecNow - _docker_last_read; //  / 100 * os.cpus().length;
-      let intervalsUsed = cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage;
+    const lastRead = _docker_cpu_last_read[id] || 0;
+    if (lastRead > 0) {
+      const possIntervals = nanoSecNow - lastRead;
+      const intervalsUsed = cpu_stats.cpu_usage.total_usage - precpuTotal;
       if (possIntervals > 0) {
         cpuPercent = (100.0 * intervalsUsed) / possIntervals;
       }
     }
-    _docker_last_read = nanoSecNow;
+    _docker_cpu_last_read[id] = nanoSecNow;
     return cpuPercent;
   }
 }
 
 function docker_calcNetworkIO(networks) {
-  let rx;
-  let wx;
+  let rx = 0;
+  let wx = 0;
   for (let key in networks) {
     // skip loop if the property is from prototype
     if (!{}.hasOwnProperty.call(networks, key)) {
@@ -481,25 +476,16 @@ function dockerContainerStats(containerIDs, callback) {
           Object.setPrototypeOf(containerIDsSanitized, util.stringObj);
         }
 
-        containerIDsSanitized = containerIDs;
-        containerIDsSanitized = containerIDsSanitized.trim();
+        containerIDsSanitized = containerIDs.trim();
         if (containerIDsSanitized !== '*') {
-          containerIDsSanitized = '';
-          const s = (util.isPrototypePolluted() ? '' : util.sanitizeShellString(containerIDs, true)).trim();
-          const l = util.mathMin(s.length, 2000);
-          for (let i = 0; i <= l; i++) {
-            if (s[i] !== undefined) {
-              s[i].__proto__.toLowerCase = util.stringToLower;
-              const sl = s[i].toLowerCase();
-              if (sl && sl[0] && !sl[1]) {
-                containerIDsSanitized = containerIDsSanitized + sl[0];
-              }
-            }
-          }
+          containerIDsSanitized = util.isPrototypePolluted() ? '' : util.sanitizeContainerID(containerIDs);
         }
-
-        containerIDsSanitized = containerIDsSanitized.trim().toLowerCase().replace(/,+/g, '|');
-        containerArray = containerIDsSanitized.split('|');
+        containerArray = containerIDsSanitized
+          .trim()
+          .toLowerCase()
+          .replace(/,+/g, '|')
+          .split('|')
+          .filter((item) => item.trim());
       }
 
       const result = [];
@@ -508,8 +494,10 @@ function dockerContainerStats(containerIDs, callback) {
       if (containerArray.length && containerArray[0].trim() === '*') {
         containerArray = [];
         dockerContainers().then((allContainers) => {
-          for (let container of allContainers) {
-            containerArray.push(container.id.substring(0, 12));
+          for (let container of (allContainers || []).filter(Boolean)) {
+            if (container.id) {
+              containerArray.push(container.id.substring(0, 12));
+            }
           }
           if (containerArray.length) {
             dockerContainerStats(containerArray.join(',')).then((result) => {
@@ -592,7 +580,7 @@ function dockerContainerStatsSingle(containerID) {
                   result.memUsage = stats.memory_stats && stats.memory_stats.usage ? stats.memory_stats.usage : 0;
                   result.memLimit = stats.memory_stats && stats.memory_stats.limit ? stats.memory_stats.limit : 0;
                   result.memPercent = stats.memory_stats && stats.memory_stats.usage && stats.memory_stats.limit ? (stats.memory_stats.usage / stats.memory_stats.limit) * 100.0 : 0;
-                  result.cpuPercent = stats.cpu_stats && stats.precpu_stats ? docker_calcCPUPercent(stats.cpu_stats, stats.precpu_stats) : 0;
+                  result.cpuPercent = stats.cpu_stats && stats.precpu_stats ? docker_calcCPUPercent(stats.cpu_stats, stats.precpu_stats, containerID) : 0;
                   result.pids = stats.pids_stats && stats.pids_stats.current ? stats.pids_stats.current : 0;
                   result.restartCount = dataInspect.RestartCount ? dataInspect.RestartCount : 0;
                   if (stats.networks) {
@@ -636,7 +624,7 @@ function dockerContainerProcesses(containerID, callback) {
       if (typeof containerID !== 'string') {
         return resolve(result);
       }
-      const containerIdSanitized = (util.isPrototypePolluted() ? '' : util.sanitizeShellString(containerID, true)).trim();
+      const containerIdSanitized = util.isPrototypePolluted() ? '' : util.sanitizeContainerID(containerID);
 
       if (containerIdSanitized) {
         if (!_docker_socket) {

package/lib/dockerSocket.js

@@ -15,307 +15,102 @@
 
 const net = require('net');
 const isWin = require('os').type() === 'Windows_NT';
-const socketPath = isWin ? '//./pipe/docker_engine' : '/var/run/docker.sock';
+const socketPath = process.env.DOCKER_SOCKET || (isWin ? '//./pipe/docker_engine' : '/var/run/docker.sock');
+const socketTimeout = +process.env.DOCKER_SOCKET_TIMEOUT || 30000;
+
+function fetchJson(path, callback) {
+  let done = false;
+  const finish = (result) => {
+    if (!done) {
+      done = true;
+      callback(result);
+    }
+  };
+  try {
+    const socket = net.createConnection({ path: socketPath });
+    let alldata = '';
+
+    socket.setTimeout(socketTimeout, () => {
+      socket.destroy();
+      finish({});
+    });
+
+    socket.on('connect', () => {
+      socket.write(`GET ${path} HTTP/1.0\r\n\r\n`);
+    });
+
+    socket.on('data', (data) => {
+      alldata = alldata + data.toString();
+    });
+
+    socket.on('error', () => {
+      finish({});
+    });
+
+    socket.on('end', () => {
+      const startbody = alldata.indexOf('\r\n\r\n');
+      const status = parseInt(alldata.split(' ')[1], 10);
+      if (startbody < 0 || isNaN(status) || status < 200 || status >= 300) {
+        return finish({});
+      }
+      try {
+        finish(JSON.parse(alldata.substring(startbody + 4)));
+      } catch {
+        finish({});
+      }
+    });
+  } catch {
+    finish({});
+  }
+}
 
 class DockerSocket {
   getInfo(callback) {
-    try {
-      let socket = net.createConnection({ path: socketPath });
-      let alldata = '';
-      let data;
-
-      socket.on('connect', () => {
-        socket.write('GET http:/info HTTP/1.0\r\n\r\n');
-      });
-
-      socket.on('data', (data) => {
-        alldata = alldata + data.toString();
-      });
-
-      socket.on('error', () => {
-        socket = false;
-        callback({});
-      });
-
-      socket.on('end', () => {
-        const startbody = alldata.indexOf('\r\n\r\n');
-        alldata = alldata.substring(startbody + 4);
-        socket = false;
-        try {
-          data = JSON.parse(alldata);
-          callback(data);
-        } catch {
-          callback({});
-        }
-      });
-    } catch {
-      callback({});
-    }
+    fetchJson('http:/info', callback);
   }
 
   listImages(all, callback) {
-    try {
-      let socket = net.createConnection({ path: socketPath });
-      let alldata = '';
-      let data;
-
-      socket.on('connect', () => {
-        socket.write('GET http:/images/json' + (all ? '?all=1' : '') + ' HTTP/1.0\r\n\r\n');
-      });
-
-      socket.on('data', (data) => {
-        alldata = alldata + data.toString();
-      });
-
-      socket.on('error', () => {
-        socket = false;
-        callback({});
-      });
-
-      socket.on('end', () => {
-        const startbody = alldata.indexOf('\r\n\r\n');
-        alldata = alldata.substring(startbody + 4);
-        socket = false;
-        try {
-          data = JSON.parse(alldata);
-          callback(data);
-        } catch {
-          callback({});
-        }
-      });
-    } catch {
-      callback({});
-    }
+    fetchJson(`http:/images/json${all ? '?all=1' : ''}`, callback);
   }
 
   inspectImage(id, callback) {
-    id = id || '';
     if (id) {
-      try {
-        let socket = net.createConnection({ path: socketPath });
-        let alldata = '';
-        let data;
-
-        socket.on('connect', () => {
-          socket.write('GET http:/images/' + id + '/json?stream=0 HTTP/1.0\r\n\r\n');
-        });
-
-        socket.on('data', (data) => {
-          alldata = alldata + data.toString();
-        });
-
-        socket.on('error', () => {
-          socket = false;
-          callback({});
-        });
-
-        socket.on('end', () => {
-          const startbody = alldata.indexOf('\r\n\r\n');
-          alldata = alldata.substring(startbody + 4);
-          socket = false;
-          try {
-            data = JSON.parse(alldata);
-            callback(data);
-          } catch {
-            callback({});
-          }
-        });
-      } catch {
-        callback({});
-      }
+      fetchJson(`http:/images/${id}/json?stream=0`, callback);
     } else {
       callback({});
     }
   }
 
   listContainers(all, callback) {
-    try {
-      let socket = net.createConnection({ path: socketPath });
-      let alldata = '';
-      let data;
-
-      socket.on('connect', () => {
-        socket.write('GET http:/containers/json' + (all ? '?all=1' : '') + ' HTTP/1.0\r\n\r\n');
-      });
-
-      socket.on('data', (data) => {
-        alldata = alldata + data.toString();
-      });
-
-      socket.on('error', () => {
-        socket = false;
-        callback({});
-      });
-
-      socket.on('end', () => {
-        const startbody = alldata.indexOf('\r\n\r\n');
-        alldata = alldata.substring(startbody + 4);
-        socket = false;
-        try {
-          data = JSON.parse(alldata);
-          callback(data);
-        } catch {
-          callback({});
-        }
-      });
-    } catch {
-      callback({});
-    }
+    fetchJson(`http:/containers/json${all ? '?all=1' : ''}`, callback);
   }
 
   getStats(id, callback) {
-    id = id || '';
     if (id) {
-      try {
-        let socket = net.createConnection({ path: socketPath });
-        let alldata = '';
-        let data;
-
-        socket.on('connect', () => {
-          socket.write('GET http:/containers/' + id + '/stats?stream=0 HTTP/1.0\r\n\r\n');
-        });
-
-        socket.on('data', (data) => {
-          alldata = alldata + data.toString();
-        });
-
-        socket.on('error', () => {
-          socket = false;
-          callback({});
-        });
-
-        socket.on('end', () => {
-          const startbody = alldata.indexOf('\r\n\r\n');
-          alldata = alldata.substring(startbody + 4);
-          socket = false;
-          try {
-            data = JSON.parse(alldata);
-            callback(data);
-          } catch {
-            callback({});
-          }
-        });
-      } catch {
-        callback({});
-      }
+      fetchJson(`http:/containers/${id}/stats?stream=0`, callback);
     } else {
       callback({});
     }
   }
 
   getInspect(id, callback) {
-    id = id || '';
     if (id) {
-      try {
-        let socket = net.createConnection({ path: socketPath });
-        let alldata = '';
-        let data;
-
-        socket.on('connect', () => {
-          socket.write('GET http:/containers/' + id + '/json?stream=0 HTTP/1.0\r\n\r\n');
-        });
-
-        socket.on('data', (data) => {
-          alldata = alldata + data.toString();
-        });
-
-        socket.on('error', () => {
-          socket = false;
-          callback({});
-        });
-
-        socket.on('end', () => {
-          const startbody = alldata.indexOf('\r\n\r\n');
-          alldata = alldata.substring(startbody + 4);
-          socket = false;
-          try {
-            data = JSON.parse(alldata);
-            callback(data);
-          } catch {
-            callback({});
-          }
-        });
-      } catch {
-        callback({});
-      }
+      fetchJson(`http:/containers/${id}/json?stream=0`, callback);
     } else {
       callback({});
     }
   }
 
   getProcesses(id, callback) {
-    id = id || '';
     if (id) {
-      try {
-        let socket = net.createConnection({ path: socketPath });
-        let alldata = '';
-        let data;
-
-        socket.on('connect', () => {
-          socket.write('GET http:/containers/' + id + '/top?ps_args=-opid,ppid,pgid,vsz,time,etime,nice,ruser,user,rgroup,group,stat,rss,args HTTP/1.0\r\n\r\n');
-        });
-
-        socket.on('data', (data) => {
-          alldata = alldata + data.toString();
-        });
-
-        socket.on('error', () => {
-          socket = false;
-          callback({});
-        });
-
-        socket.on('end', () => {
-          const startbody = alldata.indexOf('\r\n\r\n');
-          alldata = alldata.substring(startbody + 4);
-          socket = false;
-          try {
-            data = JSON.parse(alldata);
-            callback(data);
-          } catch {
-            callback({});
-          }
-        });
-      } catch {
-        callback({});
-      }
+      fetchJson(`http:/containers/${id}/top?ps_args=-opid,ppid,pgid,vsz,time,etime,nice,ruser,user,rgroup,group,stat,rss,args`, callback);
     } else {
       callback({});
     }
   }
 
   listVolumes(callback) {
-    try {
-      let socket = net.createConnection({ path: socketPath });
-      let alldata = '';
-      let data;
-
-      socket.on('connect', () => {
-        socket.write('GET http:/volumes HTTP/1.0\r\n\r\n');
-      });
-
-      socket.on('data', (data) => {
-        alldata = alldata + data.toString();
-      });
-
-      socket.on('error', () => {
-        socket = false;
-        callback({});
-      });
-
-      socket.on('end', () => {
-        const startbody = alldata.indexOf('\r\n\r\n');
-        alldata = alldata.substring(startbody + 4);
-        socket = false;
-        try {
-          data = JSON.parse(alldata);
-          callback(data);
-        } catch {
-          callback({});
-        }
-      });
-    } catch {
-      callback({});
-    }
+    fetchJson('http:/volumes', callback);
   }
 }