npm - @zappinginc/zm2 - Versions diffs - 6.0.14 - Mend

@zappinginc/zm2 6.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (133) hide show

package/.claude/settings.local.json +8 -0
package/.gitattributes +4 -0
package/.mocharc.js +14 -0
package/CHANGELOG.md +2416 -0
package/CLAUDE.md +84 -0
package/CONTRIBUTING.md +124 -0
package/GNU-AGPL-3.0.txt +665 -0
package/LICENSE +1 -0
package/README.md +248 -0
package/bin/zm2 +3 -0
package/bin/zm2-dev +3 -0
package/bin/zm2-docker +3 -0
package/bin/zm2-runtime +3 -0
package/bin/zm2-windows +3 -0
package/bin/zm2.ps1 +3 -0
package/bun.lock +421 -0
package/constants.js +114 -0
package/index.js +13 -0
package/lib/API/Configuration.js +212 -0
package/lib/API/Containerizer.js +335 -0
package/lib/API/Dashboard.js +459 -0
package/lib/API/Deploy.js +117 -0
package/lib/API/Extra.js +775 -0
package/lib/API/ExtraMgmt/Docker.js +30 -0
package/lib/API/Log.js +315 -0
package/lib/API/LogManagement.js +371 -0
package/lib/API/Modules/LOCAL.js +122 -0
package/lib/API/Modules/Modularizer.js +148 -0
package/lib/API/Modules/NPM.js +445 -0
package/lib/API/Modules/TAR.js +362 -0
package/lib/API/Modules/flagExt.js +46 -0
package/lib/API/Modules/index.js +120 -0
package/lib/API/Monit.js +247 -0
package/lib/API/Serve.js +343 -0
package/lib/API/Startup.js +629 -0
package/lib/API/UX/helpers.js +213 -0
package/lib/API/UX/index.js +9 -0
package/lib/API/UX/pm2-describe.js +193 -0
package/lib/API/UX/pm2-ls-minimal.js +31 -0
package/lib/API/UX/pm2-ls.js +483 -0
package/lib/API/Version.js +382 -0
package/lib/API/interpreter.json +12 -0
package/lib/API/pm2-plus/PM2IO.js +372 -0
package/lib/API/pm2-plus/auth-strategies/CliAuth.js +288 -0
package/lib/API/pm2-plus/auth-strategies/WebAuth.js +187 -0
package/lib/API/pm2-plus/helpers.js +97 -0
package/lib/API/pm2-plus/link.js +126 -0
package/lib/API/pm2-plus/pres/motd +16 -0
package/lib/API/pm2-plus/pres/motd.update +26 -0
package/lib/API/pm2-plus/pres/welcome +28 -0
package/lib/API/pm2-plus/process-selector.js +52 -0
package/lib/API/schema.json +379 -0
package/lib/API.js +1931 -0
package/lib/Client.js +776 -0
package/lib/Common.js +911 -0
package/lib/Configuration.js +304 -0
package/lib/Daemon.js +456 -0
package/lib/Event.js +37 -0
package/lib/God/ActionMethods.js +909 -0
package/lib/God/ClusterMode.js +97 -0
package/lib/God/ForkMode.js +297 -0
package/lib/God/Methods.js +265 -0
package/lib/God/Reload.js +240 -0
package/lib/God.js +632 -0
package/lib/HttpInterface.js +76 -0
package/lib/ProcessContainer.js +305 -0
package/lib/ProcessContainerBun.js +360 -0
package/lib/ProcessContainerFork.js +42 -0
package/lib/ProcessContainerForkBun.js +33 -0
package/lib/ProcessUtils.js +55 -0
package/lib/TreeKill.js +118 -0
package/lib/Utility.js +430 -0
package/lib/VersionCheck.js +46 -0
package/lib/Watcher.js +117 -0
package/lib/Worker.js +169 -0
package/lib/binaries/CLI.js +1041 -0
package/lib/binaries/DevCLI.js +183 -0
package/lib/binaries/Runtime.js +101 -0
package/lib/binaries/Runtime4Docker.js +192 -0
package/lib/completion.js +229 -0
package/lib/completion.sh +40 -0
package/lib/motd +36 -0
package/lib/templates/Dockerfiles/Dockerfile-java.tpl +7 -0
package/lib/templates/Dockerfiles/Dockerfile-nodejs.tpl +8 -0
package/lib/templates/Dockerfiles/Dockerfile-ruby.tpl +7 -0
package/lib/templates/ecosystem-es.tpl +24 -0
package/lib/templates/ecosystem-simple-es.tpl +8 -0
package/lib/templates/ecosystem-simple.tpl +6 -0
package/lib/templates/ecosystem.tpl +22 -0
package/lib/templates/init-scripts/launchd.tpl +35 -0
package/lib/templates/init-scripts/openrc.tpl +52 -0
package/lib/templates/init-scripts/pm2-init-amazon.sh +86 -0
package/lib/templates/init-scripts/rcd-openbsd.tpl +41 -0
package/lib/templates/init-scripts/rcd.tpl +44 -0
package/lib/templates/init-scripts/smf.tpl +43 -0
package/lib/templates/init-scripts/systemd-online.tpl +22 -0
package/lib/templates/init-scripts/systemd.tpl +22 -0
package/lib/templates/init-scripts/upstart.tpl +103 -0
package/lib/templates/logrotate.d/pm2 +10 -0
package/lib/templates/sample-apps/http-server/README.md +14 -0
package/lib/templates/sample-apps/http-server/api.js +9 -0
package/lib/templates/sample-apps/http-server/ecosystem.config.js +14 -0
package/lib/templates/sample-apps/http-server/package.json +11 -0
package/lib/templates/sample-apps/pm2-plus-metrics-actions/README.md +45 -0
package/lib/templates/sample-apps/pm2-plus-metrics-actions/custom-metrics.js +66 -0
package/lib/templates/sample-apps/pm2-plus-metrics-actions/ecosystem.config.js +12 -0
package/lib/templates/sample-apps/pm2-plus-metrics-actions/package.json +11 -0
package/lib/templates/sample-apps/python-app/README.md +4 -0
package/lib/templates/sample-apps/python-app/echo.py +7 -0
package/lib/templates/sample-apps/python-app/ecosystem.config.js +12 -0
package/lib/templates/sample-apps/python-app/package.json +11 -0
package/lib/tools/Config.js +248 -0
package/lib/tools/IsAbsolute.js +20 -0
package/lib/tools/copydirSync.js +101 -0
package/lib/tools/deleteFolderRecursive.js +19 -0
package/lib/tools/find-package-json.js +74 -0
package/lib/tools/fmt.js +72 -0
package/lib/tools/isbinaryfile.js +94 -0
package/lib/tools/json5.js +752 -0
package/lib/tools/open.js +63 -0
package/lib/tools/passwd.js +58 -0
package/lib/tools/promise.min.js +1 -0
package/lib/tools/sexec.js +55 -0
package/lib/tools/treeify.js +113 -0
package/lib/tools/which.js +120 -0
package/lib/tools/xdg-open +861 -0
package/package.json +219 -0
package/paths.js +93 -0
package/pm2 +11 -0
package/preinstall.js +24 -0
package/run.sh +9 -0
package/types/index.d.ts +722 -0
package/types/tsconfig.json +14 -0

package/lib/API/pm2-plus/auth-strategies/WebAuth.js ADDED Viewed

@@ -0,0 +1,187 @@
+'use strict'
+const cst = require('../../../../constants.js');
+const AuthStrategy = require('@pm2/js-api/src/auth_strategies/strategy')
+const http = require('http')
+const fs = require('fs')
+const url = require('url')
+const exec = require('child_process').exec
+const tryEach = require('async/tryEach');
+module.exports = class WebStrategy extends AuthStrategy {
+  // the client will try to call this but we handle this part ourselves
+  retrieveTokens (km, cb) {
+    this.authenticated = false
+    this.callback = cb
+    this.km = km
+  }
+  // so the cli know if we need to tell user to login/register
+  isAuthenticated () {
+    return new Promise((resolve, reject) => {
+      if (this.authenticated) return resolve(true)
+      let tokensPath = cst.PM2_IO_ACCESS_TOKEN
+      fs.readFile(tokensPath, (err, tokens) => {
+        if (err && err.code === 'ENOENT') return resolve(false)
+        if (err) return reject(err)
+        // verify that the token is valid
+        try {
+          tokens = JSON.parse(tokens || '{}')
+        } catch (err) {
+          fs.unlinkSync(tokensPath)
+          return resolve(false)
+        }
+        // if the refresh tokens is here, the user could be automatically authenticated
+        return resolve(typeof tokens.refresh_token === 'string')
+      })
+    })
+  }
+  // called when we are sure the user asked to be logged in
+  _retrieveTokens (optionalCallback) {
+    const km = this.km
+    const cb = this.callback
+    let verifyToken = (refresh) => {
+      return km.auth.retrieveToken({
+        client_id: this.client_id,
+        refresh_token: refresh
+      })
+    }
+    tryEach([
+      // try to find the token via the environment
+      (next) => {
+        if (!process.env.PM2_IO_TOKEN) {
+          return next(new Error('No token in env'))
+        }
+        verifyToken(process.env.PM2_IO_TOKEN)
+          .then((res) => {
+            return next(null, res.data)
+          }).catch(next)
+      },
+      // try to find it in the file system
+      (next) => {
+        fs.readFile(cst.PM2_IO_ACCESS_TOKEN, (err, tokens) => {
+          if (err) return next(err)
+          // verify that the token is valid
+          tokens = JSON.parse(tokens || '{}')
+          if (new Date(tokens.expire_at) > new Date(new Date().toISOString())) {
+            return next(null, tokens)
+          }
+          verifyToken(tokens.refresh_token)
+            .then((res) => {
+              return next(null, res.data)
+            }).catch(next)
+        })
+      },
+      // otherwise make the whole flow
+      (next) => {
+        return this.loginViaWeb((data) => {
+          // verify that the token is valid
+          verifyToken(data.access_token)
+            .then((res) => {
+              return next(null, res.data)
+            }).catch(err => next(err))
+        })
+      }
+    ], (err, result) => {
+      // if present run the optional callback
+      if (typeof optionalCallback === 'function') {
+        optionalCallback(err, result)
+      }
+      if (result.refresh_token) {
+        this.authenticated = true
+        let file = cst.PM2_IO_ACCESS_TOKEN
+        fs.writeFile(file, JSON.stringify(result), () => {
+          return cb(err, result)
+        })
+      } else {
+        return cb(err, result)
+      }
+    })
+  }
+  loginViaWeb (cb) {
+    const redirectURL = `${this.oauth_endpoint}${this.oauth_query}`
+    console.log(`${cst.PM2_IO_MSG} Please follow the popup or go to this URL :`, '\n', '    ', redirectURL)
+    let shutdown = false
+    let server = http.createServer((req, res) => {
+      // only handle one request
+      if (shutdown === true) return res.end()
+      shutdown = true
+      let query = url.parse(req.url, true).query
+      res.write(`
+        <head>
+          <script>
+          </script>
+        </head>
+        <body>
+          <h2 style="text-align: center">
+            You can go back to your terminal now :)
+          </h2>
+        </body>`)
+      res.end()
+      server.close()
+      return cb(query)
+    })
+    server.listen(43532, () => {
+      this.open(redirectURL)
+    })
+  }
+  deleteTokens (km) {
+    return new Promise((resolve, reject) => {
+      // revoke the refreshToken
+      km.auth.revoke()
+        .then(res => {
+          // remove the token from the filesystem
+          let file = cst.PM2_IO_ACCESS_TOKEN
+          fs.unlinkSync(file)
+          return resolve(res)
+        }).catch(reject)
+    })
+  }
+  open (target, appName, callback) {
+    let opener
+    const escape = function (s) {
+      return s.replace(/"/g, '\\"')
+    }
+    if (typeof (appName) === 'function') {
+      callback = appName
+      appName = null
+    }
+    switch (process.platform) {
+      case 'darwin': {
+        opener = appName ? `open -a "${escape(appName)}"` : `open`
+        break
+      }
+      case 'win32': {
+        opener = appName ? `start "" ${escape(appName)}"` : `start ""`
+        break
+      }
+      default: {
+        opener = appName ? escape(appName) : `xdg-open`
+        break
+      }
+    }
+    if (process.env.SUDO_USER) {
+      opener = 'sudo -u ' + process.env.SUDO_USER + ' ' + opener
+    }
+    return exec(`${opener} "${escape(target)}"`, callback)
+  }
+}

package/lib/API/pm2-plus/helpers.js ADDED Viewed

@@ -0,0 +1,97 @@
+var cst = require('../../../constants.js');
+var Common = require('../../Common.js');
+const chalk = require('ansis');
+const forEach = require('async/forEach');
+const open = require('../../tools/open.js');
+const Modules = require('../Modules');
+function processesAreAlreadyMonitored(CLI, cb) {
+  CLI.Client.executeRemote('getMonitorData', {}, function(err, list) {
+    if (err) return cb(false);
+    var l = list.filter(l => l.pm2_env.km_link == true)
+    var l2 = list.filter(l => l.name == 'pm2-server-monit')
+    return cb(l.length > 0 && l2.length > 0 ? true : false)
+  })
+}
+module.exports = function(CLI) {
+  CLI.prototype.openDashboard = function() {
+    if (!this.gl_interact_infos) {
+      Common.printError(chalk.bold.white('Agent if offline, type `$ pm2 plus` to log in'));
+      return this.exitCli(cst.ERROR_EXIT);
+    }
+    var uri = `https://app.pm2.io/#/r/${this.gl_interact_infos.public_key}`
+    console.log(cst.PM2_IO_MSG + ` Opening ${uri}`)
+    open(uri);
+    setTimeout(_ => {
+      this.exitCli();
+    }, 200);
+  };
+  CLI.prototype.clearSetup = function (opts, cb) {
+    const modules = ['event-loop-inspector']
+    this.gl_is_km_linked = false
+    forEach(modules, (_module, next) => {
+      Modules.uninstall(this, _module, () => {
+        next()
+      });
+    }, (err) => {
+      this.reload('all', () => {
+        return cb()
+      })
+    })
+  }
+  /**
+   * Install required package and enable flags for current running processes
+   */
+  CLI.prototype.minimumSetup = function (opts, cb) {
+    var self = this;
+    this.gl_is_km_linked = true
+    function install(cb) {
+      var modules = []
+      if (opts.type === 'enterprise' || opts.type === 'plus') {
+        modules = ['pm2-logrotate', 'pm2-server-monit']
+        if (opts.type === 'enterprise') {
+          modules.push('deep-metrics')
+        }
+      }
+      forEach(modules, (_module, next) => {
+        Modules.install(self, _module, {}, () => {
+          next()
+        });
+      }, (err) => {
+        self.reload('all', () => {
+          return cb()
+        })
+      })
+    }
+    processesAreAlreadyMonitored(self, (already_monitored) => {
+      if (already_monitored) {
+        console.log(cst.PM2_IO_MSG + ` PM2 ${opts.type || ''} bundle already installed`);
+        return cb()
+      }
+      if (opts.installAll)
+        return install(cb)
+      // promptly.confirm(chalk.bold('Install all pm2 plus dependencies ? (y/n)'), (err, answer) => {
+      //   if (!err && answer === true)
+      return install(cb)
+      // self.reload('all', () => {
+      //     return cb()
+      //   })
+      // });
+    })
+  }
+}

package/lib/API/pm2-plus/link.js ADDED Viewed

@@ -0,0 +1,126 @@
+var cst         = require('../../../constants.js');
+var Common      = require('../../Common.js');
+var chalk       = require('ansis');
+var fs          = require('fs');
+var KMDaemon    = require('@pm2/agent/src/InteractorClient');
+var pkg         = require('../../../package.json')
+module.exports = function(CLI) {
+  CLI.prototype.linkManagement = function(cmd, public_key, machine, opts, cb) {
+    var that = this;
+    // pm2 link stop || kill
+    if (cmd == 'stop' || cmd == 'kill') {
+      that.gl_is_km_linked = false
+      console.log(cst.PM2_IO_MSG + ' Stopping agent...');
+      return that.killAgent(function(err) {
+        if (err) {
+          Common.printError(err);
+          return process.exit(cst.ERROR_EXIT);
+        }
+        console.log(cst.PM2_IO_MSG + ' Stopped');
+        that.reload('all', () => {
+          return process.exit(cst.SUCCESS_EXIT);
+        })
+      });
+    }
+    // pm2 link info
+    if (cmd == 'info') {
+      console.log(cst.PM2_IO_MSG + ' Getting agent information...');
+      that.agentInfos(function(err, infos) {
+        if (err) {
+          console.error(cst.PM2_IO_MSG_ERR + ' ' + err.message);
+          return that.exitCli(cst.ERROR_EXIT);
+        }
+        console.log(infos);
+        return that.exitCli(cst.SUCCESS_EXIT);
+      });
+      return false;
+    }
+    // pm2 link delete
+    if (cmd == 'delete') {
+      that.gl_is_km_linked = false
+      console.log(cst.PM2_IO_MSG + ' Permanently disable agent...');
+      that.killAgent(function(err) {
+        try {
+          fs.unlinkSync(cst.INTERACTION_CONF);
+        } catch(e) {
+          console.log(cst.PM2_IO_MSG + ' No interaction config file found');
+          return process.exit(cst.SUCCESS_EXIT);
+        }
+        console.log(cst.PM2_IO_MSG + ' Agent interaction ended');
+        if (!cb)
+          return process.exit(cst.SUCCESS_EXIT);
+        return cb()
+      });
+      return false;
+    }
+    if (cmd && !public_key) {
+      console.error(cst.PM2_IO_MSG + ' Command [%s] unknown or missing public key', cmd);
+      return process.exit(cst.ERROR_EXIT);
+    }
+    // pm2 link xxx yyy
+    var infos;
+    if (!cmd) {
+      infos = null;
+    }
+    else
+      infos = {
+        public_key : public_key,
+        secret_key : cmd,
+        machine_name : machine,
+        info_node : opts.infoNode || null,
+        pm2_version: pkg.version
+      }
+    that.link(infos, cb)
+  };
+  CLI.prototype.link = function(infos, cb) {
+    var that = this;
+    process.env.WS_JSON_PATCH = true
+    KMDaemon.launchAndInteract(cst, infos, function(err, dt) {
+      if (err) {
+        Common.printError(cst.PM2_IO_MSG + ' Run `$ pm2 plus` to connect')
+        return that.exitCli(cst.ERROR_EXIT);
+      }
+      console.log(chalk.bold.green('[+] PM2+ activated!'))
+      if (!cb) {
+        return that.exitCli(cst.SUCCESS_EXIT);
+      }
+      return cb(null, dt)
+    });
+  };
+  CLI.prototype.agentInfos = function(cb) {
+    KMDaemon.getInteractInfo(this._conf, function(err, data) {
+      if (err)
+        return cb(Common.retErr(err));
+      return cb(null, data);
+    });
+  };
+  CLI.prototype.killAgent = function(cb) {
+    var that = this;
+    KMDaemon.killInteractorDaemon(that._conf, function(err) {
+      if (err)
+        return cb ? cb(Common.retErr(err)) : that.exitCli(cst.SUCCESS_EXIT);
+      return cb ? cb(null) : that.exitCli(cst.SUCCESS_EXIT);
+    });
+  };
+  CLI.prototype.unlink = function(cb) {
+    this.linkManagement('delete', cb);
+  };
+};

package/lib/API/pm2-plus/pres/motd ADDED Viewed

@@ -0,0 +1,16 @@
+  ██████╗ ███╗   ███╗██████╗     ██╗    ██╗ ██████╗
+  ██╔══██╗████╗ ████║╚════██╗    ██║   ██╔╝██╔═══██╗
+  ██████╔╝██╔████╔██║ █████╔╝    ██║  ██╔╝ ██║   ██║
+  ██╔═══╝ ██║╚██╔╝██║██╔═══╝     ██║ ██╔╝  ██║   ██║
+  ██║     ██║ ╚═╝ ██║███████╗    ██║██╔╝   ╚██████╔╝
+  ╚═╝     ╚═╝     ╚═╝╚══════╝    ╚═╝╚═╝     ╚═════╝
+                  https://pm2.io/
+     Harden your Node.js Production Environment
+      - Real-time Monitoring Web Interface
+      - Pro Active Alerting System
+      - Production Profiling for Memory and CPU
+      - PM2 Runtime High Availability Fallback

package/lib/API/pm2-plus/pres/motd.update ADDED Viewed

@@ -0,0 +1,26 @@
+                  -------------
+  ██████╗ ███╗   ███╗██████╗     ██╗    ██╗ ██████╗
+  ██╔══██╗████╗ ████║╚════██╗    ██║   ██╔╝██╔═══██╗
+  ██████╔╝██╔████╔██║ █████╔╝    ██║  ██╔╝ ██║   ██║
+  ██╔═══╝ ██║╚██╔╝██║██╔═══╝     ██║ ██╔╝  ██║   ██║
+  ██║     ██║ ╚═╝ ██║███████╗    ██║██╔╝   ╚██████╔╝
+  ╚═╝     ╚═╝     ╚═╝╚══════╝    ╚═╝╚═╝     ╚═════╝
+                  https://pm2.io/
+     Harden your Node.js Production Environment
+      - Real-time Monitoring Web Interface
+      - Pro Active Alerting System
+      - Production Profiling for Memory and CPU
+      - ZM2 Runtime High Availability Fallback
+             Start using it by typing:
+                    $ zm2 plus
+                  -------------

package/lib/API/pm2-plus/pres/welcome ADDED Viewed

@@ -0,0 +1,28 @@
+                -------------
+               PM2 Plus Edition
+       PM2 Plus is a monitoring dashboard
+        specialized for Node.js Apps.
+               Create an account:
+              $ pm2 plus register
+    Connect your local PM2 to the PM2 Plus servers:
+              $ pm2 plus connect
+    See our UI with your own realtime dashboard:
+              $ pm2 plus web
+          More details available there:
+              http://pm2.io/plus
+                -------------
+        Having complex or specific needs?
+  You can also checkout our enterprise offer at:
+            http://pm2.io/enterprise
+                -------------

package/lib/API/pm2-plus/process-selector.js ADDED Viewed

@@ -0,0 +1,52 @@
+const fs  = require('fs');
+const forEachLimit = require('async/forEachLimit');
+var cst = require('../../../constants.js');
+var Common = require('../../Common.js');
+module.exports = function(CLI) {
+  /**
+   * Monitor Selectively Processes (auto filter in interaction)
+   * @param String state 'monitor' or 'unmonitor'
+   * @param String target <pm_id|name|all>
+   * @param Function cb callback
+   */
+  CLI.prototype.monitorState = function(state, target, cb) {
+    var that = this;
+    if (!target) {
+      Common.printError(cst.PREFIX_MSG_ERR + 'Please specify an <app_name|pm_id>');
+      return cb ? cb(new Error('argument missing')) : that.exitCli(cst.ERROR_EXIT);
+    }
+    function monitor (pm_id, cb) {
+      // State can be monitor or unmonitor
+      that.Client.executeRemote(state, pm_id, cb);
+    }
+    if (target === 'all') {
+      that.Client.getAllProcessId(function (err, procs) {
+        if (err) {
+          Common.printError(err);
+          return cb ? cb(Common.retErr(err)) : that.exitCli(cst.ERROR_EXIT);
+        }
+        forEachLimit(procs, 1, monitor, function (err, res) {
+          return typeof cb === 'function' ? cb(err, res) : that.speedList();
+        });
+      });
+    } else if (!Number.isInteger(parseInt(target))) {
+      this.Client.getProcessIdByName(target, true, function (err, procs) {
+        if (err) {
+          Common.printError(err);
+          return cb ? cb(Common.retErr(err)) : that.exitCli(cst.ERROR_EXIT);
+        }
+        forEachLimit(procs, 1, monitor, function (err, res) {
+          return typeof cb === 'function' ? cb(err, res) : that.speedList();
+        });
+      });
+    } else {
+      monitor(parseInt(target), function (err, res) {
+        return typeof cb === 'function' ? cb(err, res) : that.speedList();
+      });
+    }
+  };
+}