chore: remove circular dependencies (#925)

Signed-off-by: Jeromy Cannon <[email protected]>
hashgraph · Dec 5, 2024 · 88f3458 · 88f3458
1 parent d5aaa91
commit 88f3458
Show file tree

Hide file tree

Showing 81 changed files with 1,974 additions and 683 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -32,8 +32,8 @@
     "test-e2e-relay": "cross-env MOCHA_SUITE_NAME=\"Mocha E2E Relay Tests\" c8 --report-dir='coverage/e2e-relay' mocha 'test/e2e/commands/relay.test.ts' --reporter-options configFile=mocha-multi-reporter.json,cmrOutput=mocha-junit-reporter+mochaFile+junit-e2e-relay.xml",
     "solo-test": "tsx --no-deprecation --no-warnings solo.ts",
     "solo": "node --no-deprecation --no-warnings dist/solo.js",
-    "check": "remark . --quiet --frail && eslint . ; cd docs; jsdoc -c jsdoc.conf.json && tsc",
-    "format": "remark . --quiet --frail --output && eslint --fix . && tsc",
+    "check": "remark . --quiet --frail && eslint . && tsc && (madge --circular src/* || true) && cd docs; jsdoc -c jsdoc.conf.json",
+    "format": "remark . --quiet --frail --output && eslint --fix . && tsc && madge --circular src/* || true",
     "test-setup": "./test/e2e/setup-e2e.sh",
     "build": "rm -Rf dist && tsc && node resources/post-build-script.js"
   },
@@ -115,6 +115,7 @@
     "eslint-plugin-tsdoc": "^0.4.0",
     "globals": "^15.13.0",
     "jest-mock": "^29.7.0",
+    "madge": "^8.0.0",
     "mocha": "^11.0.1",
     "mocha-each": "^2.0.1",
     "mocha-junit-reporter": "^2.2.1",

diff --git a/src/commands/account.ts b/src/commands/account.ts
@@ -17,9 +17,10 @@
 import chalk from 'chalk';
 import {BaseCommand} from './base.js';
 import {SoloError, IllegalArgumentError} from '../core/errors.js';
-import {flags} from './index.js';
+import {Flags as flags} from './flags.js';
 import {Listr} from 'listr2';
-import {constants, type AccountManager} from '../core/index.js';
+import * as constants from '../core/constants.js';
+import {type AccountManager} from '../core/account_manager.js';
 import {type AccountId, AccountInfo, HbarUnit, PrivateKey} from '@hashgraph/sdk';
 import {FREEZE_ADMIN_ACCOUNT} from '../core/constants.js';
 import {type Opts} from '../types/index.js';

diff --git a/src/commands/base.ts b/src/commands/base.ts
@@ -16,19 +16,19 @@
  */
 
 import paths from 'path';
-import {MissingArgumentError} from '../core/errors.js';
+import {MissingArgumentError, SoloError} from '../core/errors.js';
 import {ShellRunner} from '../core/shell_runner.js';
-import type {
-  ChartManager,
-  ConfigManager,
-  Helm,
-  K8,
-  DependencyManager,
-  LeaseManager,
-  RemoteConfigManager,
-  LocalConfig,
-} from '../core/index.js';
-import type {CommandFlag, Opts} from '../types/index.js';
+import {type LeaseManager} from '../core/lease/lease_manager.js';
+import {type LocalConfig} from '../core/config/local_config.js';
+import {type RemoteConfigManager} from '../core/config/remote/remote_config_manager.js';
+import {type Helm} from '../core/helm.js';
+import {type K8} from '../core/k8.js';
+import {type ChartManager} from '../core/chart_manager.js';
+import {type ConfigManager} from '../core/config_manager.js';
+import {type DependencyManager} from '../core/dependency_managers/index.js';
+import type {CommandFlag, CommandHandlers, Opts} from '../types/index.js';
+import type {Lease} from '../core/lease/lease.js';
+import {Listr} from 'listr2';
 
 export class BaseCommand extends ShellRunner {
   protected readonly helm: Helm;
@@ -178,4 +178,28 @@ export class BaseCommand extends ShellRunner {
   getLocalConfig() {
     return this.localConfig;
   }
+
+  commandActionBuilder(actionTasks: any, options: any, errorString: string, lease: Lease | null) {
+    return async function (argv: any, commandDef: CommandHandlers) {
+      const tasks = new Listr([...actionTasks], options);
+
+      try {
+        await tasks.run();
+      } catch (e: Error | any) {
+        commandDef.parent.logger.error(`${errorString}: ${e.message}`, e);
+        throw new SoloError(`${errorString}: ${e.message}`, e);
+      } finally {
+        const promises = [];
+
+        // @ts-ignore
+        if (commandDef.close) {
+          // @ts-ignore
+          promises.push(commandDef.close());
+        }
+
+        if (lease) promises.push(lease.release());
+        await Promise.all(promises);
+      }
+    };
+  }
 }
diff --git a/src/commands/cluster.ts b/src/commands/cluster.ts
@@ -17,10 +17,10 @@
 import {ListrEnquirerPromptAdapter} from '@listr2/prompt-adapter-enquirer';
 import {Listr} from 'listr2';
 import {SoloError} from '../core/errors.js';
-import {flags} from './index.js';
+import {Flags as flags} from './flags.js';
 import {BaseCommand} from './base.js';
 import chalk from 'chalk';
-import {constants} from '../core/index.js';
+import * as constants from '../core/constants.js';
 import path from 'path';
 import {ListrLease} from '../core/lease/listr_lease.js';
 import {type CommandBuilder} from '../types/aliases.js';

diff --git a/src/commands/context/flags.ts b/src/commands/context/flags.ts
@@ -15,7 +15,7 @@
  *
  */
 
-import {flags} from '../index.js';
+import {Flags as flags} from '../flags.js';
 
 export const USE_FLAGS = {
   requiredFlags: [],

diff --git a/src/commands/context/handlers.ts b/src/commands/context/handlers.ts
@@ -17,7 +17,7 @@
 import {type BaseCommand} from '../base.js';
 import {type ContextCommandTasks} from './tasks.js';
 import * as helpers from '../../core/helpers.js';
-import {constants} from '../../core/index.js';
+import * as constants from '../../core/constants.js';
 import {type CommandHandlers} from '../../types/index.js';
 import * as ContextFlags from './flags.js';
 
@@ -33,7 +33,7 @@ export class ContextCommandHandlers implements CommandHandlers {
   async connect(argv: any) {
     argv = helpers.addFlagsToArgv(argv, ContextFlags.USE_FLAGS);
 
-    const action = helpers.commandActionBuilder(
+    const action = this.parent.commandActionBuilder(
       [
         this.tasks.initialize(argv),
         this.parent.getLocalConfig().promptLocalConfigTask(),

diff --git a/src/commands/context/index.ts b/src/commands/context/index.ts
@@ -15,12 +15,12 @@
  *
  */
 
-import {YargsCommand} from '../../core/index.js';
+import * as ContextFlags from './flags.js';
+import {YargsCommand} from '../../core/yargs_command.js';
 import {BaseCommand} from './../base.js';
 import type {Opts} from '../../types/index.js';
 import {ContextCommandTasks} from './tasks.js';
 import {ContextCommandHandlers} from './handlers.js';
-import * as ContextFlags from './flags.js';
 
 /**
  * Defines the core functionalities of 'node' command

diff --git a/src/commands/context/tasks.ts b/src/commands/context/tasks.ts
@@ -14,8 +14,9 @@
  * limitations under the License.
  *
  */
-import {Task, Templates} from '../../core/index.js';
-import {flags} from '../index.js';
+import {Task} from '../../core/task.js';
+import {Templates} from '../../core/templates.js';
+import {Flags as flags} from '../flags.js';
 import type {ListrTaskWrapper} from 'listr2';
 import {type BaseCommand} from '../base.js';
 

diff --git a/src/commands/deployment.ts b/src/commands/deployment.ts
@@ -17,8 +17,9 @@
 import {Listr, type ListrTaskWrapper} from 'listr2';
 import {SoloError} from '../core/errors.js';
 import {BaseCommand} from './base.js';
-import {flags} from './index.js';
-import {constants, Templates} from '../core/index.js';
+import {Flags as flags} from './flags.js';
+import * as constants from '../core/constants.js';
+import {Templates} from '../core/templates.js';
 import chalk from 'chalk';
 import {RemoteConfigTasks} from '../core/config/remote/remote_config_tasks.js';
 import {ListrLease} from '../core/lease/listr_lease.js';

diff --git a/src/commands/flags.ts b/src/commands/flags.ts
@@ -14,8 +14,8 @@
  * limitations under the License.
  *
  */
-import {ConfigManager, constants} from '../core/index.js';
-import * as core from '../core/index.js';
+import * as constants from '../core/constants.js';
+import {ConfigManager} from '../core/config_manager.js';
 import * as version from '../../version.js';
 import path from 'path';
 import type {CommandFlag} from '../types/index.js';
@@ -497,7 +497,7 @@ export class Flags {
     name: 'cache-dir',
     definition: {
       describe: 'Local cache directory',
-      defaultValue: core.constants.SOLO_CACHE_DIR,
+      defaultValue: constants.SOLO_CACHE_DIR,
       type: 'string',
     },
     prompt: async function promptCacheDir(task: ListrTaskWrapper<any, any, any>, input: any) {

diff --git a/src/commands/index.ts b/src/commands/index.ts
@@ -14,7 +14,6 @@
  * limitations under the License.
  *
  */
-import {Flags as flags} from './flags.js';
 import {ClusterCommand} from './cluster.js';
 import {ContextCommand} from './context/index.js';
 import {InitCommand} from './init.js';
@@ -31,7 +30,7 @@ import {type Opts} from '../types/index.js';
  * @param opts it is an Options object containing logger
  * @returns an array of Yargs command builder
  */
-function Initialize(opts: Opts) {
+export function Initialize(opts: Opts) {
   const initCmd = new InitCommand(opts);
   const clusterCmd = new ClusterCommand(opts);
   const contextCmd = new ContextCommand(opts);
@@ -55,6 +54,3 @@ function Initialize(opts: Opts) {
     deploymentCommand.getCommandDefinition(),
   ];
 }
-
-// Expose components from the command module
-export {Initialize, flags};
diff --git a/src/commands/init.ts b/src/commands/init.ts
@@ -17,11 +17,10 @@
 import {Listr} from 'listr2';
 import path from 'path';
 import {BaseCommand} from './base.js';
-import * as core from '../core/index.js';
-import {constants} from '../core/index.js';
-import * as fs from 'fs';
+import fs from 'fs';
+import * as constants from '../core/constants.js';
 import {SoloError} from '../core/errors.js';
-import {flags} from './index.js';
+import {Flags as flags} from './flags.js';
 import chalk from 'chalk';
 
 /**
@@ -82,7 +81,7 @@ export class InitCommand extends BaseCommand {
         {
           title: 'Check dependencies',
           task: (_, task) => {
-            const deps = [core.constants.HELM];
+            const deps = [constants.HELM];
 
             const subTasks = self.depManager.taskCheckDependencies<Context>(deps);
 

diff --git a/src/commands/mirror_node.ts b/src/commands/mirror_node.ts
@@ -17,10 +17,12 @@
 import {ListrEnquirerPromptAdapter} from '@listr2/prompt-adapter-enquirer';
 import {Listr} from 'listr2';
 import {SoloError, IllegalArgumentError, MissingArgumentError} from '../core/errors.js';
-import {constants, type ProfileManager, type AccountManager} from '../core/index.js';
+import * as constants from '../core/constants.js';
+import {type AccountManager} from '../core/account_manager.js';
+import {type ProfileManager} from '../core/profile_manager.js';
 import {BaseCommand} from './base.js';
-import {flags} from './index.js';
-import {getFileContents, getEnvValue} from '../core/helpers.js';
+import {Flags as flags} from './flags.js';
+import {getEnvValue} from '../core/helpers.js';
 import {RemoteConfigTasks} from '../core/config/remote/remote_config_tasks.js';
 import {type CommandBuilder, type PodName} from '../types/aliases.js';
 import type {Opts} from '../types/index.js';
@@ -369,8 +371,8 @@ export class MirrorNodeCommand extends BaseCommand {
                     const exchangeRatesFileIdNum = 112;
                     const timestamp = Date.now();
 
-                    const fees = await getFileContents(this.accountManager, namespace, feesFileIdNum);
-                    const exchangeRates = await getFileContents(this.accountManager, namespace, exchangeRatesFileIdNum);
+                    const fees = await this.accountManager.getFileContents(namespace, feesFileIdNum);
+                    const exchangeRates = await this.accountManager.getFileContents(namespace, exchangeRatesFileIdNum);
 
                     const importFeesQuery = `INSERT INTO public.file_data(file_data, consensus_timestamp, entity_id, transaction_type) VALUES (decode('${fees}', 'hex'), ${timestamp + '000000'}, ${feesFileIdNum}, 17);`;
                     const importExchangeRatesQuery = `INSERT INTO public.file_data(file_data, consensus_timestamp, entity_id, transaction_type) VALUES (decode('${exchangeRates}', 'hex'), ${

diff --git a/src/commands/network.ts b/src/commands/network.ts
@@ -19,14 +19,18 @@ import chalk from 'chalk';
 import {Listr} from 'listr2';
 import {SoloError, IllegalArgumentError, MissingArgumentError} from '../core/errors.js';
 import {BaseCommand} from './base.js';
-import {flags} from './index.js';
-import {constants, Templates} from '../core/index.js';
+import {Flags as flags} from './flags.js';
+import * as constants from '../core/constants.js';
+import {Templates} from '../core/templates.js';
 import * as helpers from '../core/helpers.js';
 import path from 'path';
 import {addDebugOptions, validatePath} from '../core/helpers.js';
 import fs from 'fs';
 import {RemoteConfigTasks} from '../core/config/remote/remote_config_tasks.js';
-import type {CertificateManager, KeyManager, PlatformInstaller, ProfileManager} from '../core/index.js';
+import {type KeyManager} from '../core/key_manager.js';
+import {type PlatformInstaller} from '../core/platform_installer.js';
+import {type ProfileManager} from '../core/profile_manager.js';
+import {type CertificateManager} from '../core/certificate_manager.js';
 import {type CommandBuilder, type NodeAlias, type NodeAliases} from '../types/aliases.js';
 import type {Opts} from '../types/index.js';
 import {ListrLease} from '../core/lease/listr_lease.js';

diff --git a/src/commands/node/configs.ts b/src/commands/node/configs.ts
@@ -15,14 +15,15 @@
  *
  */
 import {FREEZE_ADMIN_ACCOUNT} from '../../core/constants.js';
-import {constants, Templates} from '../../core/index.js';
+import {Templates} from '../../core/templates.js';
+import * as constants from '../../core/constants.js';
 import {PrivateKey} from '@hashgraph/sdk';
 import {SoloError} from '../../core/errors.js';
 import * as helpers from '../../core/helpers.js';
 import path from 'path';
 import fs from 'fs';
 import {validatePath} from '../../core/helpers.js';
-import {flags} from '../index.js';
+import {Flags as flags} from '../flags.js';
 import {type NodeAlias, type NodeAliases, type PodName} from '../../types/aliases.js';
 import {type NetworkNodeServices} from '../../core/network_node_services.js';
 

diff --git a/src/commands/node/flags.ts b/src/commands/node/flags.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  */
-import {flags} from '../index.js';
+import {Flags as flags} from '../flags.js';
 
 export const DEFAULT_FLAGS = {
   requiredFlags: [],