underpost 2.8.885 → 2.81.0

package/src/cli/index.js

@@ -64,10 +64,11 @@ program
 // 'cmt' command: Commit changes to a GitHub repository
 program
   .command('cmt')
-  .argument('<path>', 'The absolute or relative directory path of the repository.')
-  .argument(`<commit-type>`, `The type of commit to perform. Options: ${Object.keys(commitData).join(', ')}.`)
+  .argument('[path]', 'The absolute or relative directory path of the repository.')
+  .argument(`[commit-type]`, `The type of commit to perform. Options: ${Object.keys(commitData).join(', ')}.`)
   .argument(`[module-tag]`, 'Optional: Sets a specific module tag for the commit.')
   .argument(`[message]`, 'Optional: Provides an additional custom message for the commit.')
+  .option(`--log`, 'Shows commit history from the specified number of latest n path commits.')
   .option('--empty', 'Allows committing with empty files.')
   .option('--copy', 'Copies the generated commit message to the clipboard.')
   .option('--info', 'Displays information about available commit types.')
@@ -89,7 +90,7 @@ program
   .command('env')
   .argument(
     '[deploy-id]',
-    `The deployment configuration ID. Use 'clean' to restore default environment settings. User 'root' to load root env. User 'current' to get plain current deploy Id.`,
+    `The deployment configuration ID. Use 'clean' to restore default environment settings. Use 'root' to load underpost root env. Use 'current' to get plain current deploy Id.`,
   )
   .argument('[env]', 'Optional: The environment to set (e.g., "production", "development"). Defaults to "production".')
   .argument('[subConf]', 'Optional: The sub configuration to set.')
@@ -183,7 +184,11 @@ program
   .option('--versions <deployment-versions>', 'A comma-separated list of custom deployment versions.')
   .option('--traffic <traffic-versions>', 'A comma-separated list of custom deployment traffic weights.')
   .option('--disable-update-deployment', 'Disables updates to deployments.')
-  .option('--info-traffic', 'Retrieves traffic configuration from current resource deployments.')
+  .option('--disable-update-proxy', 'Disables updates to proxies.')
+  .option(
+    '--status',
+    'Retrieves current network traffic data from resource deployments and the host machine network configuration.',
+  )
   .option('--kubeadm', 'Enables the kubeadm context for deployment operations.')
   .option('--etc-hosts', 'Enables the etc-hosts context for deployment operations.')
   .option('--restore-hosts', 'Restores default `/etc/hosts` entries.')
@@ -217,6 +222,7 @@ program
   .option('--secrets', 'Includes Dockerfile environment secrets during the build.')
   .option('--secrets-path [secrets-path]', 'Specifies a custom path for Dockerfile environment secrets.')
   .option('--reset', 'Performs a build without using the cache.')
+  .option('--dev', 'Use development mode.')
   .option('--k3s-load', 'Loads the image into a K3s cluster.')
   .description(
     'Builds a Docker image from a specified Dockerfile with various options for naming, saving, and loading.',
@@ -231,6 +237,7 @@ program
   .option('--kubeadm-load', 'Imports the pulled image into a Kubeadm cluster.')
   .option('--version', 'Sets a custom version for the base images.')
   .option('--k3s-load', 'Loads the image into a K3s cluster.')
+  .option('--dev', 'Use development mode.')
   .description('Pulls required Underpost Dockerfile base images and optionally loads them into clusters.')
   .action(Underpost.image.dockerfile.pullBaseImages);
 

package/src/cli/monitor.js

@@ -1,3 +1,9 @@
+/**
+ * Monitor module for managing the monitoring of deployments and services.
+ * @module src/cli/monitor.js
+ * @namespace UnderpostMonitor
+ */
+
 import { loadReplicas, pathPortAssignmentFactory } from '../server/conf.js';
 import { loggerFactory } from '../server/logger.js';
 import UnderpostDeploy from './deploy.js';
@@ -9,8 +15,34 @@ import { isInternetConnection } from '../server/dns.js';
 
 const logger = loggerFactory(import.meta);
 
+/**
+ * @class UnderpostMonitor
+ * @description Manages deployment monitoring and health checks.
+ * This class provides a set of static methods to monitor and manage
+ * deployment health, including checking server status, handling traffic
+ * switching, and orchestrating monitoring workflows.
+ * @memberof UnderpostMonitor
+ */
 class UnderpostMonitor {
   static API = {
+    /**
+     * @method callback
+     * @description Initiates a deployment monitoring workflow based on the provided options.
+     * This method orchestrates the monitoring process for a specific deployment, handling
+     * traffic switching, error accumulation, and optional Git integration for version control.
+     * @param {string} deployId - The identifier for the deployment to monitor.
+     * @param {string} [env='development'] - The environment for the deployment (e.g., 'development', 'production').
+     * @param {object} [options] - An object containing boolean flags for various operations.
+     * @param {boolean} [options.now=false] - Perform a single health check immediately.
+     * @param {boolean} [options.single=false] - Perform a single health check and exit.
+     * @param {string} [options.msInterval=''] - Interval in milliseconds for periodic health checks.
+     * @param {string} [options.type=''] - Type of deployment (e.g., 'blue-green', 'remote').
+     * @param {string} [options.replicas=''] - Number of replicas for the deployment.
+     * @param {boolean} [options.sync=false] - Synchronize traffic switching with the deployment.
+     * @param {object} [commanderOptions] - Options passed from the command line interface.
+     * @param {object} [auxRouter] - Optional router configuration for the deployment.
+     * @memberof UnderpostMonitor
+     */
     async callback(
       deployId,
       env = 'development',
@@ -33,10 +65,11 @@ class UnderpostMonitor {
       const router = auxRouter ?? (await UnderpostDeploy.API.routerFactory(deployId, env));
 
       const confServer = loadReplicas(
+        deployId,
         JSON.parse(fs.readFileSync(`./engine-private/conf/${deployId}/conf.server.json`, 'utf8')),
       );
 
-      const pathPortAssignmentData = pathPortAssignmentFactory(router, confServer);
+      const pathPortAssignmentData = await pathPortAssignmentFactory(deployId, router, confServer);
 
       let errorPayloads = [];
       if (options.sync === true) {

package/src/cli/repository.js

@@ -83,7 +83,7 @@ class UnderpostRepository {
      * @memberof UnderpostRepository
      */
     commit(
-      repoPath = './',
+      repoPath = undefined,
       commitType = 'feat',
       subModule = '',
       message = '',
@@ -91,8 +91,31 @@ class UnderpostRepository {
         copy: false,
         info: false,
         empty: false,
+        log: false,
       },
     ) {
+      if (options.log) {
+        const history = UnderpostRepository.API.getHistory(repoPath);
+        if (history[0]) {
+          pbcopy(
+            history
+              .reverse()
+              .map((commitData, i) => `${i === 0 ? '' : ' && '}git --no-pager show ${commitData.hash}`)
+              .join(''),
+          );
+          for (const commit of history) {
+            console.log(commit.hash.yellow, commit.message);
+            console.log(
+              shellExec(`git show --name-status --pretty="" ${commit.hash}`, {
+                stdout: true,
+                silent: true,
+                disableLog: true,
+              }).red,
+            );
+          }
+        } else logger.warn('No commits found');
+        return;
+      }
       if (commitType === 'reset') {
         if (options.copy) pbcopy(shellExec(`git --no-pager log -1 --pretty=%B`, { stdout: true }));
         shellExec(`cd ${repoPath} && git reset --soft HEAD~${isNaN(parseInt(subModule)) ? 1 : parseInt(subModule)}`);
@@ -268,6 +291,24 @@ Prevent build private config repo.`,
         deployVersion: packageJsonDeploy.version,
       };
     },
+    getHistory(sinceCommit = 5) {
+      return shellExec(`git log --oneline --graph --decorate -n ${sinceCommit}`, { stdout: true, silent: true })
+        .split(`\n`)
+        .map((line) => {
+          return {
+            hash: line.slice(2, 10),
+            message: line.slice(11),
+          };
+        })
+        .filter((line) => line.hash)
+        .map((line) => {
+          line.files = shellExec(`git show --name-status --pretty="" ${line.hash}`, {
+            stdout: true,
+            silent: true,
+          });
+          return line;
+        });
+    },
   };
 }