feat: Create a local config for storing configurations on the users machine

package.json

@@ -52,6 +52,8 @@
     "@peculiar/x509": "^1.12.3",
     "adm-zip": "^0.5.16",
     "chalk": "^5.3.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
     "dot-object": "^2.1.5",
     "dotenv": "^16.4.5",
     "enquirer": "^2.4.1",

src/commands/base.ts

@@ -20,6 +20,7 @@ import { MissingArgumentError } from '../core/errors.js'
 import { ShellRunner } from '../core/shell_runner.js'
 import type {  ChartManager,  ConfigManager,  Helm,  K8,  DependencyManager, LeaseManager } from '../core/index.js'
 import type {  CommandFlag,  Opts } from '../types/index.js'
+import { type LocalConfig } from '../core/config/local_config.js'
 
 export class BaseCommand extends ShellRunner {
   protected readonly helm: Helm
@@ -29,6 +30,7 @@ export class BaseCommand extends ShellRunner {
   protected readonly depManager: DependencyManager
   protected readonly leaseManager: LeaseManager
   protected readonly _configMaps = new Map<string, any>()
+  protected readonly localConfig: LocalConfig
 
   constructor (opts: Opts) {
     if (!opts || !opts.logger) throw new Error('An instance of core/SoloLogger is required')
@@ -37,6 +39,7 @@ export class BaseCommand extends ShellRunner {
     if (!opts || !opts.chartManager) throw new Error('An instance of core/ChartManager is required')
     if (!opts || !opts.configManager) throw new Error('An instance of core/ConfigManager is required')
     if (!opts || !opts.depManager) throw new Error('An instance of core/DependencyManager is required')
+    if (!opts || !opts.localConfig) throw new Error('An instance of core/LocalConfig is required')
 
     super(opts.logger)
 
@@ -46,6 +49,7 @@ export class BaseCommand extends ShellRunner {
     this.configManager = opts.configManager
     this.depManager = opts.depManager
     this.leaseManager = opts.leaseManager
+    this.localConfig = opts.localConfig
   }
 
   async prepareChartPath (chartDir: string, chartRepo: string, chartReleaseName: string) {

src/commands/flags.ts

@@ -22,8 +22,8 @@
 
 /**
  * Set flag from the flag option
  * @param y instance of yargs
  * @param commandFlags a set of command flags
  *
  */
 export function setCommandFlags (y: any, ...commandFlags: CommandFlag[]) {
@@ -708,6 +708,36 @@
   }
 }
 
+export const userEmailAddress: CommandFlag = {
+  constName: 'userEmailAddress',
+  name: 'email',
+  definition: {
+    describe: 'User email address used for local configuration',
+    defaultValue: '',
+    type: 'string'
+  }
+}
+
+export const deploymentName: CommandFlag = {
+  constName: 'deploymentName',
+  name: 'deployment-name',
+  definition: {
+    describe: 'Solo deployment name',
+    defaultValue: '',
+    type: 'string'
+  }
+}
+
+export const deploymentClusters: CommandFlag = {
+  constName: 'deploymentClusters',
+  name: 'deployment-clusters',
+  definition: {
+    describe: 'Solo deployment cluster list (comma separated)',
+    defaultValue: '',
+    type: 'string'
+  }
+}
+
 //* ------------- Node Proxy Certificates ------------- !//
 
 export const grpcTlsCertificatePath: CommandFlag = {
@@ -782,6 +812,8 @@
   deployCertManagerCrds,
   deployHederaExplorer,
   deployJsonRpcRelay,
+  deploymentClusters,
+  deploymentName,
   deployMinio,
   deployPrometheusStack,
   devMode,
@@ -823,11 +855,10 @@
   tlsPrivateKey,
   tlsPublicKey,
   updateAccountKeys,
+  userEmailAddress,
   valuesFile,
   mirrorNodeVersion,
   hederaExplorerVersion,
-  inputDir,
-  outputDir,
   grpcTlsCertificatePath,
   grpcWebTlsCertificatePath,
   grpcTlsKeyPath,

src/commands/prompts.ts

@@ -23,6 +23,7 @@ import * as helpers from '../core/helpers.js'
 import { hederaExplorerVersion, resetDisabledPrompts } from './flags.js'
 import type { ListrTaskWrapper } from 'listr2'
 import { type CommandFlag } from '../types/index.js'
+import validator from 'validator'
 
 async function prompt (type: string, task: ListrTaskWrapper<any, any, any>, input: any, defaultValue: any, promptMessage: string, emptyCheckMessage: string | null, flagName: string) {
   try {
@@ -366,6 +367,38 @@ export async function promptUpdateAccountKeys (task: ListrTaskWrapper<any, any,
     flags.updateAccountKeys.name)
 }
 
+export async function promptUserEmailAddress (task: ListrTaskWrapper<any, any, any>, input: any) {
+  const promptForInput = async () => {
+    return await task.prompt(ListrEnquirerPromptAdapter).run({
+      type: 'text',
+      message: 'Please enter your email address:'
+    })
+  }
+
+  input = await promptForInput()
+  while (!validator.isEmail(input)) {
+    input = await promptForInput()
+  }
+
+  return input
+}
+
+export async function promptDeploymentName (task: ListrTaskWrapper<any, any, any>, input: any) {
+  return await promptText(task, input,
+    flags.deploymentName.definition.defaultValue,
+    'Enter the Solo deployment name: ',
+    null,
+    flags.deploymentName.name)
+}
+
+export async function promptDeploymentClusters (task: ListrTaskWrapper<any, any, any>, input: any) {
+  return await promptText(task, input,
+    flags.deploymentClusters.definition.defaultValue,
+    'Enter the Solo deployment cluster names (comma separated): ',
+    null,
+    flags.deploymentClusters.name)
+}
+
 export async function promptPrivateKey (task: ListrTaskWrapper<any, any, any>, input: any) {
   return await promptText(task, input,
     flags.ed25519PrivateKey.definition.defaultValue,
@@ -531,6 +564,7 @@ export function getPromptMap (): Map<string, Function> {
     .set(flags.replicaCount.name, promptReplicaCount)
     .set(flags.tlsClusterIssuerType.name, promptTlsClusterIssuerType)
     .set(flags.updateAccountKeys.name, promptUpdateAccountKeys)
+    .set(flags.userEmailAddress.name, promptUserEmailAddress)
     .set(flags.valuesFile.name, promptValuesFile)
     .set(flags.nodeAlias.name, promptNewNodeAlias)
     .set(flags.gossipEndpoints.name, promptGossipEndpoints)

src/core/config/local_config.ts

@@ -0,0 +1,146 @@
+/**
+ * Copyright (C) 2024 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the ""License"");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an ""AS IS"" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+import { IsEmail, IsNotEmpty, IsObject, IsString, validateSync } from 'class-validator'
+import { type ListrTask } from 'listr2'
+import fs from 'fs'
+import * as yaml from 'yaml'
+import { flags } from '../../commands/index.js'
+import { type Deployment, type Deployments, type LocalConfigData } from './local_config_data.js'
+import { MissingArgumentError, SoloError } from '../errors.js'
+import { promptDeploymentClusters, promptDeploymentName, promptUserEmailAddress } from '../../commands/prompts.js'
+import { type SoloLogger } from '../logging.js'
+import { Task } from '../task.js'
+import { IsDeployments } from '../validator_decorators.js'
+
+export class LocalConfig implements LocalConfigData {
+    @IsNotEmpty()
+    @IsEmail()
+    userEmailAddress: string
+
+    // The string is the name of the deployment, will be used as the namespace,
+    // so it needs to be available in all targeted clusters
+    @IsNotEmpty()
+    @IsObject()
+    @IsDeployments()
+    deployments: Deployments
+
+    @IsNotEmpty()
+    @IsString()
+    currentDeploymentName : string
+
+    private readonly skipPromptTask: boolean = false
+
+    constructor (private readonly filePath: string, private readonly logger: SoloLogger) {
+        if (!filePath || filePath === '') throw new MissingArgumentError('a valid filePath is required')
+        if (!logger) throw new Error('An instance of core/SoloLogger is required')
+
+        const allowedKeys = ['userEmailAddress', 'deployments', 'currentDeploymentName']
+        if (this.configFileExists()) {
+            const fileContent = fs.readFileSync(filePath, 'utf8')
+            const parsedConfig = yaml.parse(fileContent)
+
+            for(const key in parsedConfig) {
+                if (!allowedKeys.includes(key)) {
+                    throw new SoloError('Validation of local config failed')
+                }
+                this[key] = parsedConfig[key]
+            }
+
+            this.validate()
+            this.skipPromptTask = true
+        }
+    }
+
+    private validate () {
+        const genericMessage = 'Validation of local config failed'
+        const errors = validateSync(this, {})
+
+        if (errors.length) {
+            throw new SoloError(genericMessage)
+        }
+
+        try {
+            // Custom validations:
+            if (!this.deployments[this.currentDeploymentName]) {
+                throw new SoloError(genericMessage)
+            }
+        }
+        catch(e: any) { throw new SoloError(genericMessage) }
+    }
+
+    public setUserEmailAddress (emailAddress: string): this {
+        this.userEmailAddress = emailAddress
+        this.validate()
+        return this
+    }
+
+    public setDeployments (deployments: Deployments): this {
+        this.deployments = deployments
+        this.validate()
+        return this
+    }
+
+    public setCurrentDeployment (deploymentName: string): this {
+        this.currentDeploymentName = deploymentName
+        this.validate()
+        return this
+    }
+
+    public getCurrentDeployment (): Deployment {
+        return this.deployments[this.currentDeploymentName]
+    }
+
+    private configFileExists (): boolean {
+        return fs.existsSync(this.filePath)
+    }
+
+    public async write (): Promise<void> {
+        const yamlContent = yaml.stringify({
+            userEmailAddress: this.userEmailAddress,
+            deployments: this.deployments,
+            currentDeploymentName: this.currentDeploymentName
+        })
+        await fs.promises.writeFile(this.filePath, yamlContent)
+        this.logger.info(`Wrote local config to ${this.filePath}`)
+    }
+
+    public promptLocalConfigTask (k8, argv): ListrTask<any, any, any>[]  {
+        return new Task('Prompt local configuration', async (ctx, task) => {
+            let userEmailAddress = argv[flags.userEmailAddress.name]
+            if (!userEmailAddress) userEmailAddress = await promptUserEmailAddress(task, userEmailAddress)
+
+            let deploymentName = argv[flags.deploymentName.name]
+            if (!deploymentName) deploymentName = await promptDeploymentName(task, deploymentName)
+
+            let deploymentClusters = argv[flags.deploymentClusters.name]
+            if (!deploymentClusters) deploymentClusters = await promptDeploymentClusters(task, deploymentClusters)
+
+            const deployments = {}
+            deployments[deploymentName] = {
+                clusterAliases: deploymentClusters.split(',')
+            }
+
+            this.userEmailAddress = userEmailAddress
+            this.deployments = deployments
+            this.currentDeploymentName = deploymentName
+            this.validate()
+            await this.write()
+
+            return this
+        }, this.skipPromptTask) as ListrTask<any, any, any>[]
+    }
+}

src/core/config/local_config_data.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright (C) 2024 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the ""License"");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an ""AS IS"" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+export interface Deployment {
+    clusterAliases : string[]
+}
+
+// an alias for the cluster, provided during the configuration
+// of the deployment, must be unique
+export type Deployments = Record<string, Deployment>;
+
+export interface LocalConfigData {
+    userEmailAddress: string;
+    deployments: Deployments;
+    currentDeploymentName: string;
+}

src/core/constants.ts

@@ -178,3 +178,5 @@ export const RELAY_PODS_RUNNING_DELAY = +process.env.RELAY_PODS_RUNNING_DELAY ||
 export const RELAY_PODS_READY_MAX_ATTEMPTS = +process.env.RELAY_PODS_READY_MAX_ATTEMPTS || 100
 export const RELAY_PODS_READY_DELAY = +process.env.RELAY_PODS_READY_DELAY || 1_000
 
+
+export const DEFAULT_LOCAL_CONFIG_FILE = 'local-config.yaml'

src/core/index.ts

@@ -33,6 +33,7 @@ import { DependencyManager } from './dependency_managers/index.js'
 import { AccountManager } from './account_manager.js'
 import { LeaseManager } from './lease/lease_manager.js'
 import { CertificateManager } from './certificate_manager.js'
+import { LocalConfig } from './config/local_config.js'
 
 // Expose components from the core module
 export {
@@ -54,5 +55,6 @@ export {
   DependencyManager,
   AccountManager,
   LeaseManager,
-  CertificateManager
+  CertificateManager,
+  LocalConfig
 }