Merge pull request #65 from HarperFast/chore/harperdb-is-dead-long-live-harper

HarperDB is dead. Long live Harper!

Author: cap10morgan

bin/cliOperations.js

@@ -142,7 +142,7 @@ async function cliOperations(req) {
 		// is running and that we can communicate with it.
 		initConfig();
 		if (!getHdbPid()) {
-			console.error('HarperDB must be running to perform this operation');
+			console.error('Harper must be running to perform this operation');
 			process.exit();
 		}
 

bin/harper.js

@@ -14,7 +14,7 @@ process.setSourceMapsEnabled(true); // this is necessary for source maps to work
 const HELP = `
 Usage: harperdb [command]
 
-With no command, harperdb will simply run HarperDB (in the foreground)
+With no command, harper will simply run Harper (in the foreground)
 
 By default, the CLI also supports certain Operation APIs. Specify the operation name and any required parameters, and omit the 'operation' command.
 
@@ -28,7 +28,7 @@ renew-certs                     - Generate a new set of self-signed certificates
 restart                         - Restart the harperdb background process
 run <path>                      - Run the application in the specified path
 start                           - Starts a separate background process for harperdb and CLI will exit
-status                          - Print the status of HarperDB
+status                          - Print the status of Harper
 stop                            - Stop the harperdb background process
 help                            - Display this output
 upgrade                         - Upgrade harperdb
@@ -80,7 +80,7 @@ async function harper() {
 			// The require is here to better control the flow of imports when this module is called.
 			return require('./upgrade.js')
 				.upgrade(null)
-				.then(() => 'Your instance of HarperDB is up to date!');
+				.then(() => 'Your instance of Harper is up to date!');
 		case SERVICE_ACTIONS_ENUM.STATUS:
 			return require('./status.js')();
 		case SERVICE_ACTIONS_ENUM.RENEWCERTS:

bin/restart.js

@@ -15,7 +15,7 @@ const path = require('node:path');
 const { unlinkSync } = require('node:fs');
 envMgr.initSync();
 
-const RESTART_RESPONSE = `Restarting HarperDB. This may take up to ${hdbTerms.RESTART_TIMEOUT_MS / 1000} seconds.`;
+const RESTART_RESPONSE = `Restarting Harper. This may take up to ${hdbTerms.RESTART_TIMEOUT_MS / 1000} seconds.`;
 const INVALID_SERVICE_ERR = 'Invalid service';
 
 let calledFromCli;
@@ -35,9 +35,8 @@ if (isMainThread) {
 }
 
 /**
- * Restart HarperDB.
- * In PM2 mode HarperDB, Leaf and Hub servers are managed by PM2. Function will use PM2 to restart these three processes.
- * In good old regular mode (PM2 is nowhere to be seen) it will restart all the child threads and the hub and leaf server processes.
+ * Restart Harper.
+ * It will restart all the child threads and the hub and leaf server processes.
  * @param req
  * @returns {Promise<string>}
  */

bin/run.js

@@ -32,11 +32,11 @@ let pmUtils;
 let cmdArgs;
 let skipExitListeners = false;
 
-const UPGRADE_COMPLETE_MSG = 'Upgrade complete.  Starting HarperDB.';
-const UPGRADE_ERR = 'Got an error while trying to upgrade your HarperDB instance.  Exiting HarperDB.';
-const HDB_NOT_FOUND_MSG = 'HarperDB not found, starting install process.';
-const INSTALL_ERR = 'There was an error during install, check install_log.log for more details.  Exiting.';
-const HDB_STARTED = 'HarperDB successfully started.';
+const UPGRADE_COMPLETE_MSG = 'Upgrade complete. Starting Harper.';
+const UPGRADE_ERR = 'Got an error while trying to upgrade your Harper instance. Exiting Harper.';
+const HDB_NOT_FOUND_MSG = 'Harper not found, starting install process.';
+const INSTALL_ERR = 'There was an error during install, check install_log.log for more details. Exiting.';
+const HDB_STARTED = 'Harper successfully started.';
 
 function addUnhandleRejectionListener() {
 	process.on('unhandledRejection', (reason, promise) => {
@@ -73,7 +73,7 @@ function addExitListeners() {
  */
 async function initialize(calledByInstall = false, calledByMain = false) {
 	// Check to see if HDB is installed, if it isn't we call install.
-	console.log(chalk.magenta('Starting HarperDB...'));
+	console.log(chalk.magenta('Starting Harper...'));
 
 	addUnhandleRejectionListener();
 
@@ -108,24 +108,24 @@ async function initialize(calledByInstall = false, calledByMain = false) {
 		}
 	}
 
-	// Check to see if HarperDB is already running by checking for a pid file
+	// Check to see if Harper is already running by checking for a pid file
 	// If found confirm it matches a currently running processes
 	let hdbPid = getHdbPid();
 	if (hdbPid) {
-		hdbLogger.debug('Error: HarperDB is already running');
-		console.error(`Error: HarperDB is already running (pid: ${hdbPid})`);
+		hdbLogger.debug('Error: Harper is already running');
+		console.error(`Error: Harper is already running (pid: ${hdbPid})`);
 		process.exit(4);
 	}
 
 	addExitListeners();
 
 	if (calledByMain) {
-		// Write HarperDB PID to file for tracking purposes
+		// Write Harper PID to file for tracking purposes
 		await fs.writeFile(path.join(env.get(hdbTerms.CONFIG_PARAMS.ROOTPATH), hdbTerms.HDB_PID_FILE), `${process.pid}`);
 	}
-	hdbLogger.info('HarperDB PID', process.pid);
+	hdbLogger.info('Harper PID', process.pid);
 
-	// Check to see if an upgrade is needed based on existing hdbInfo data.  If so, we need to force the user to upgrade
+	// Check to see if an upgrade is needed based on existing hdbInfo data. If so, we need to force the user to upgrade
 	// before the server can be started.
 	let upgradeVers;
 	try {
@@ -138,7 +138,7 @@ async function initialize(calledByInstall = false, calledByMain = false) {
 	} catch (err) {
 		if (upgradeVers) {
 			console.error(
-				`Got an error while trying to upgrade your HarperDB instance to version ${upgradeVers}.  Exiting HarperDB.`,
+				`Got an error while trying to upgrade your Harper instance to version ${upgradeVers}. Exiting Harper.`,
 				err
 			);
 			hdbLogger.error(err);
@@ -188,12 +188,12 @@ async function main(calledByInstall = false) {
 function started() {
 	// Console log Harper dog logo
 	hdbLogger.suppressLogging(() => {
-		console.log(chalk.magenta(`HarperDB ${packageJson.version} successfully started`));
+		console.log(chalk.magenta(`Harper ${packageJson.version} successfully started`));
 	});
 	hdbLogger.notify(HDB_STARTED);
 }
 /**
- * Launches a separate process for HarperDB and then exits. This is an unusual practice and is anathema
+ * Launches a separate process for Harper and then exits. This is an unusual practice and is anathema
  * to the way processes are typically handled, both in terminal and for services (systemd), but this functionality
  * is retained for legacy purposes.
  * @returns {Promise<void>} // ha ha, it doesn't!
@@ -297,7 +297,7 @@ function startupLog(portResolutions) {
 			env.get(CONFIG_PARAMS.REPLICATION_SECUREPORT) ?? env.get(CONFIG_PARAMS.OPERATIONSAPI_NETWORK_SECUREPORT);
 
 		repLog += replicationPort ? `WS: ${replicationPort}, ` : '';
-		repLog += replicationSecurePort ? `WSS: ${replicationSecurePort}  ` : '';
+		repLog += replicationSecurePort ? `WSS: ${replicationSecurePort} ` : '';
 		logMsg += `${repLog.slice(0, -2)}\n`;
 	}
 

bin/stop.js

@@ -6,7 +6,7 @@ const childProcess = require('child_process');
 const exec = util.promisify(childProcess.exec);
 const sysInfo = require('../utility/environment/systemInformation.js');
 
-const STOP_MSG = 'Stopping HarperDB.';
+const STOP_MSG = 'Stopping Harper.';
 
 module.exports = stop;
 

bin/upgrade.js

@@ -29,7 +29,7 @@ module.exports = {
 };
 
 /**
- * Runs the upgrade directives, if needed, for an updated version of HarperDB.
+ * Runs the upgrade directives, if needed, for an updated version of Harper.
  *
  * @param upgradeObj - optional
  * @returns {Promise<void>}
@@ -53,12 +53,12 @@ async function upgrade(upgradeObj) {
 	if (!hdbUpgradeInfo) {
 		hdbUpgradeInfo = await hdbInfoController.getVersionUpdateInfo();
 		if (!hdbUpgradeInfo) {
-			console.log('HarperDB version is current');
+			console.log('Harper version is current');
 			process.exit(0);
 		}
 	}
 
-	printToLogAndConsole(`This version of HarperDB is ${packageJson.version}`, hdbTerms.LOG_LEVELS.INFO);
+	printToLogAndConsole(`This version of Harper is ${packageJson.version}`, hdbTerms.LOG_LEVELS.INFO);
 
 	//The upgrade version should always be included in the hdbUpgradeInfo object returned from the getVersion function
 	// above but testing for it and using the version from package.json just in case it is not
@@ -84,7 +84,7 @@ async function upgrade(upgradeObj) {
 	}
 
 	if (!startUpgrade) {
-		console.log('Cancelled upgrade, closing HarperDB');
+		console.log('Cancelled upgrade, closing Harper');
 		process.exit(exitCode);
 	}
 
@@ -93,7 +93,7 @@ async function upgrade(upgradeObj) {
 	await runUpgrade(hdbUpgradeInfo);
 
 	printToLogAndConsole(
-		`HarperDB was successfully upgraded to version ${hdbUpgradeInfo[UPGRADE_VERSION]}`,
+		`Harper was successfully upgraded to version ${hdbUpgradeInfo[UPGRADE_VERSION]}`,
 		hdbTerms.LOG_LEVELS.INFO
 	);
 }

components/componentLoader.ts

@@ -45,7 +45,7 @@ let watchesSetup;
 let resources;
 
 /**
- * Load all the applications registered in HarperDB, those in the components directory as well as any directly
+ * Load all the applications registered in Harper, those in the components directory as well as any directly
  * specified to run
  * @param loadedPluginModules
  * @param loadedResources

components/operations.js

@@ -419,7 +419,7 @@ async function deployComponent(req) {
 	let response = await server.replication.replicateOperation(req);
 	if (req.restart === true) {
 		manageThreads.restartWorkers('http');
-		response.message = `Successfully deployed: ${application.name}, restarting HarperDB`;
+		response.message = `Successfully deployed: ${application.name}, restarting Harper`;
 	} else if (rollingRestart) {
 		const serverUtilities = require('../server/serverHelpers/serverUtilities.ts');
 		const jobResponse = await serverUtilities.executeJob({
@@ -429,7 +429,7 @@ async function deployComponent(req) {
 		});
 
 		response.restartJobId = jobResponse.job_id;
-		response.message = `Successfully deployed: ${application.name}, restarting HarperDB`;
+		response.message = `Successfully deployed: ${application.name}, restarting Harper`;
 	} else response.message = `Successfully deployed: ${application.name}`;
 
 	return response;
@@ -631,7 +631,7 @@ async function dropComponent(req) {
 	let response = await server.replication.replicateOperation(req);
 	if (req.restart === true) {
 		manageThreads.restartWorkers('http');
-		response.message = `Successfully dropped: ${projectPath}, restarting HarperDB`;
+		response.message = `Successfully dropped: ${projectPath}, restarting Harper`;
 	} else response.message = `Successfully dropped: ${projectPath}`;
 	return response;
 }

config/configUtils.js

@@ -23,7 +23,7 @@ const EMPTY_GET_VALUE = 'Empty parameter sent to getConfigValue';
 const DEFAULT_CONFIG_FILE_PATH = path.join(__dirname, '../../static', hdbTerms.HDB_DEFAULT_CONFIG_FILE);
 
 const CONFIGURE_SUCCESS_RESPONSE =
-	'Configuration successfully set. You must restart HarperDB for new config settings to take effect.';
+	'Configuration successfully set. You must restart Harper for new config settings to take effect.';
 
 const DEPRECATED_CONFIG = {
 	logging_rotation_retain: 'logging.rotation.retain',
@@ -71,7 +71,7 @@ function resolvePath(relativePath) {
 }
 
 /**
- * Builds the HarperDB config file using user inputs and default values from defaultConfig.yaml
+ * Builds the Harper config file using user inputs and default values from defaultConfig.yaml
  * @param args - any args that the user provided.
  */
 function createConfigFile(args, skipFsValidation = false) {
@@ -232,7 +232,7 @@ function getConfigFilePath(bootPropsFilePath = hdbUtils.getPropsFilePath()) {
 
 /**
  * If in memory config obj is undefined or init is being forced,
- * read and parses the HarperDB config file and add to config object.
+ * read and parses the Harper config file and add to config object.
  * @param force
  */
 function initConfig(force = false) {
@@ -244,7 +244,7 @@ function initConfig(force = false) {
 				fs.accessSync(bootPropsFilePath, fs.constants.F_OK | fs.constants.R_OK);
 			} catch (err) {
 				logger.error(err);
-				throw new Error(`HarperDB properties file at path ${bootPropsFilePath} does not exist`);
+				throw new Error(`Harper properties file at path ${bootPropsFilePath} does not exist`);
 			}
 		}
 
@@ -267,12 +267,12 @@ function initConfig(force = false) {
 			configDoc = parseYamlDoc(configFilePath);
 		} catch (err) {
 			if (err.code === hdbTerms.NODE_ERROR_CODES.ENOENT) {
-				logger.trace(`HarperDB config file not found at ${configFilePath}. 
+				logger.trace(`Harper config file not found at ${configFilePath}. 
 				This can occur during early stages of install where the config file has not yet been created`);
 				return;
 			} else {
 				logger.error(err);
-				throw new Error(`Error reading HarperDB config file at ${configFilePath}`);
+				throw new Error(`Error reading Harper config file at ${configFilePath}`);
 			}
 		}
 
@@ -569,7 +569,7 @@ function backupConfigFile(configPath, hdbRoot) {
 
 const PRESERVED_PROPERTIES = ['databases'];
 /**
- * Flattens the JSON version of HarperDB config with underscores separating each parent/child key.
+ * Flattens the JSON version of Harper config with underscores separating each parent/child key.
  * @param obj
  * @returns {null}
  */
@@ -702,7 +702,7 @@ function readConfigFile() {
 	} catch (err) {
 		if (!hdbUtils.noBootFile()) {
 			logger.error(err);
-			throw new Error(`HarperDB properties file at path ${bootPropsFilePath} does not exist`);
+			throw new Error(`Harper properties file at path ${bootPropsFilePath} does not exist`);
 		}
 	}
 

config/harperConfigEnvVars.ts

@@ -2,7 +2,7 @@
  * HARPER_DEFAULT_CONFIG and HARPER_SET_CONFIG environment variable support
  *
  * This module provides utilities for applying configuration from environment variables
- * to HarperDB's configuration system with source tracking and drift detection.
+ * to Harper's configuration system with source tracking and drift detection.
  *
  * Features:
  * - Install-time and runtime configuration from env vars