underpost 2.8.884 → 2.8.886

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',
@@ -34,10 +66,9 @@ class UnderpostMonitor {
 
       const confServer = loadReplicas(
         JSON.parse(fs.readFileSync(`./engine-private/conf/${deployId}/conf.server.json`, 'utf8')),
-        'proxy',
       );
 
-      const pathPortAssignmentData = pathPortAssignmentFactory(router, confServer);
+      const pathPortAssignmentData = await pathPortAssignmentFactory(deployId, router, confServer);
 
       let errorPayloads = [];
       if (options.sync === true) {

package/src/cli/repository.js

@@ -1,3 +1,9 @@
+/**
+ * Repository module for managing Git operations and configurations.
+ * @module src/cli/repository.js
+ * @namespace UnderpostRepository
+ */
+
 import { commitData } from '../client/components/core/CommonJs.js';
 import dotenv from 'dotenv';
 import { pbcopy, shellCd, shellExec } from '../server/process.js';
@@ -11,8 +17,23 @@ dotenv.config();
 
 const logger = loggerFactory(import.meta);
 
+/**
+ * @class UnderpostRepository
+ * @description Manages Git operations and configurations.
+ * This class provides a set of static methods to automate various
+ * Git operations, including cloning, pulling, and committing changes.
+ * @memberof UnderpostRepository
+ */
 class UnderpostRepository {
   static API = {
+    /**
+     * Clones a Git repository from GitHub.
+     * @param {string} [gitUri=`${process.env.GITHUB_USERNAME}/pwa-microservices-template`] - The URI of the GitHub repository (e.g., "username/repository").
+     * @param {object} [options={ bare: false, g8: false }] - Cloning options.
+     * @param {boolean} [options.bare=false] - If true, performs a bare clone.
+     * @param {boolean} [options.g8=false] - If true, uses the .g8 extension.
+     * @memberof UnderpostRepository
+     */
     clone(gitUri = `${process.env.GITHUB_USERNAME}/pwa-microservices-template`, options = { bare: false, g8: false }) {
       const gExtension = options.g8 === true ? '.g8' : '.git';
       const repoName = gitUri.split('/').pop();
@@ -26,6 +47,14 @@ class UnderpostRepository {
         },
       );
     },
+    /**
+     * Pulls updates from a GitHub repository.
+     * @param {string} [repoPath='./'] - The local path to the repository.
+     * @param {string} [gitUri=`${process.env.GITHUB_USERNAME}/pwa-microservices-template`] - The URI of the GitHub repository.
+     * @param {object} [options={ g8: false }] - Pulling options.
+     * @param {boolean} [options.g8=false] - If true, uses the .g8 extension.
+     * @memberof UnderpostRepository
+     */
     pull(
       repoPath = './',
       gitUri = `${process.env.GITHUB_USERNAME}/pwa-microservices-template`,
@@ -41,6 +70,18 @@ class UnderpostRepository {
         },
       );
     },
+    /**
+     * Creates a Git commit with a conventional commit message.
+     * @param {string} [repoPath='./'] - The local path to the repository.
+     * @param {string} [commitType='feat'] - The type of commit (e.g., 'feat', 'fix', 'docs', 'reset').
+     * @param {string} [subModule=''] - The submodule or scope of the commit.
+     * @param {string} [message=''] - The commit message.
+     * @param {object} [options={ copy: false, info: false, empty: false }] - Commit options.
+     * @param {boolean} [options.copy=false] - If true, copies the commit message to the clipboard.
+     * @param {boolean} [options.info=false] - If true, displays information about commit types.
+     * @param {boolean} [options.empty=false] - If true, allows an empty commit.
+     * @memberof UnderpostRepository
+     */
     commit(
       repoPath = './',
       commitType = 'feat',
@@ -65,9 +106,18 @@ class UnderpostRepository {
       shellExec(`cd ${repoPath} && git commit ${options?.empty ? `--allow-empty ` : ''}-m "${_message}"`);
     },
 
+    /**
+     * Pushes commits to a remote GitHub repository.
+     * @param {string} [repoPath='./'] - The local path to the repository.
+     * @param {string} [gitUri=`${process.env.GITHUB_USERNAME}/pwa-microservices-template`] - The URI of the GitHub repository.
+     * @param {object} [options={ f: false, g8: false }] - Push options.
+     * @param {boolean} [options.f=false] - If true, forces the push.
+     * @param {boolean} [options.g8=false] - If true, uses the .g8 extension.
+     * @memberof UnderpostRepository
+     */
     push(
       repoPath = './',
-      gitUri = `${process.env.GITHUB_USERNAME}/pwa-microservices-template}`,
+      gitUri = `${process.env.GITHUB_USERNAME}/pwa-microservices-template`,
       options = { f: false, g8: false },
     ) {
       const gExtension = options.g8 === true || options.G8 === true ? '.g8' : '.git';
@@ -90,11 +140,34 @@ class UnderpostRepository {
       );
     },
 
-    new(repositoryName, options = { dev: false, deployId: false, cluster: false }) {
+    /**
+     * Creates a new Underpost project, service, or configuration.
+     * @param {string} repositoryName - The name of the new project or service, or a deployId.
+     * @param {object} [options={ dev: false, deployId: false, cluster: false, subConf: '' }] - Creation options.
+     * @param {boolean} [options.dev=false] - If true, sets up a development project.
+     * @param {boolean} [options.deployId=false] - If true, creates deploy ID configuration files.
+     * @param {boolean} [options.cluster=false] - If true, creates cluster configuration files.
+     * @param {string} [options.subConf=''] - If provided, creates a sub-configuration for a deployId.
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     * @memberof UnderpostRepository
+     */
+    new(repositoryName, options = { dev: false, deployId: false, cluster: false, subConf: '' }) {
       return new Promise(async (resolve, reject) => {
         try {
           await logger.setUpInfo();
           actionInitLog();
+          if (options.subConf && typeof options.subConf === 'string') {
+            const deployId = repositoryName;
+            logger.info('Creating sub conf', {
+              deployId,
+              subConf: options.subConf,
+            });
+            fs.copySync(
+              `./engine-private/conf/${deployId}/conf.server.json`,
+              `./engine-private/conf/${deployId}/conf.server.dev.${options.subConf}.json`,
+            );
+            return resolve();
+          }
           if (repositoryName === 'service')
             return resolve(
               await UnderpostStartUp.API.listenPortController(UnderpostStartUp.API.listenServerFactory(), ':'),
@@ -126,12 +199,26 @@ class UnderpostRepository {
       });
     },
 
+    /**
+     * Gets a list of deleted files from a Git repository.
+     * @param {string} [path='.'] - The path to the repository.
+     * @returns {string[]} An array of deleted file paths.
+     * @memberof UnderpostRepository
+     */
     getDeleteFiles(path = '.') {
       const commandUntrack = `cd ${path} && git ls-files --deleted`;
       const diffUntrackOutput = shellExec(commandUntrack, { stdout: true, silent: true });
       return diffUntrackOutput.toString().split('\n').filter(Boolean);
     },
 
+    /**
+     * Gets a list of changed (modified and untracked) files in a Git repository.
+     * @param {string} [path='.'] - The path to the repository.
+     * @param {string} [extension=''] - An optional file extension to filter by.
+     * @param {boolean} [head=false] - If true, diffs against HEAD^.
+     * @returns {string[]} An array of changed file paths.
+     * @memberof UnderpostRepository
+     */
     getChangedFiles(path = '.', extension = '', head = false) {
       const extensionFilter = extension ? `-- '***.${extension}'` : '';
       const command = `cd ${path} && git diff ${head ? 'HEAD^ HEAD ' : ''}--name-only ${extensionFilter}`;
@@ -146,6 +233,12 @@ class UnderpostRepository {
         .concat(diffUntrackOutput.toString().split('\n').filter(Boolean))
         .filter((f) => !deleteFiles.includes(f));
     },
+    /**
+     * Updates the private configuration repository for a given deployId.
+     * @param {string} deployId - The deployment ID.
+     * @returns {{validVersion: boolean, engineVersion: string, deployVersion: string}} An object indicating if the versions are valid.
+     * @memberof UnderpostRepository
+     */
     privateConfUpdate(deployId) {
       shellCd(`/home/dd/engine`);
       const privateRepoName = `engine-${deployId.split('dd-')[1]}-private`;