hereya-cli 0.20.0 → 0.22.0

package/dist/commands/undeploy/index.js

@@ -5,14 +5,19 @@ import { getBackend } from '../../backend/index.js';
 import { getExecutor } from '../../executor/index.js';
 import { getConfigManager } from '../../lib/config/index.js';
 import { getEnvManager } from '../../lib/env/index.js';
+import { getLogger, isDebug, setDebug } from '../../lib/log.js';
 import { getParameterManager } from '../../lib/parameter/index.js';
-import { delay, setDebug } from '../../lib/shell.js';
+import { delay } from '../../lib/shell.js';
 export default class Undeploy extends Command {
     static description = 'Undeploy a hereya project by removing all resources.';
     static examples = ['<%= config.bin %> <%= command.id %>'];
     static flags = {
         chdir: Flags.string({
-            description: 'directory to run command in',
+            description: `
+        Directory where the command will be executed.
+        If not specified, it defaults to the current working directory.
+        Alternatively, you can define the project root by setting the HEREYA_PROJECT_ROOT_DIR environment variable.
+      `,
             required: false,
         }),
         debug: Flags.boolean({
@@ -96,7 +101,10 @@ export default class Undeploy extends Command {
                             skip: (ctx) => ctx.deployPackages.length === 0,
                             async task(ctx, task) {
                                 return task.newListr(ctx.deployPackages.map((packageName) => ({
-                                    async task() {
+                                    rendererOptions: {
+                                        persistentOutput: isDebug(),
+                                    },
+                                    async task(_, task) {
                                         const parameterManager = getParameterManager();
                                         const { parameters } = await parameterManager.getPackageParameters({
                                             package: packageName,
@@ -110,6 +118,7 @@ export default class Undeploy extends Command {
                                         const { executor } = executor$;
                                         const destroyOutput = await executor.destroy({
                                             isDeploying: true,
+                                            logger: getLogger(task),
                                             package: packageName,
                                             parameters,
                                             project: ctx.configOutput.config.project,
@@ -122,7 +131,7 @@ export default class Undeploy extends Command {
                                         }
                                     },
                                     title: `Destroying package ${packageName}`,
-                                })), { concurrent: false });
+                                })), { concurrent: false, rendererOptions: { collapseSubtasks: !isDebug() } });
                             },
                             title: 'Destroying deployment packages',
                         },
@@ -130,7 +139,10 @@ export default class Undeploy extends Command {
                             skip: (ctx) => !ctx.packages || ctx.packages.length === 0,
                             async task(ctx, task) {
                                 return task.newListr(ctx.packages.map((packageName) => ({
-                                    async task() {
+                                    rendererOptions: {
+                                        persistentOutput: isDebug(),
+                                    },
+                                    async task(_, task) {
                                         const parameterManager = getParameterManager();
                                         const { parameters } = await parameterManager.getPackageParameters({
                                             package: packageName,
@@ -144,6 +156,7 @@ export default class Undeploy extends Command {
                                         const { executor } = executor$;
                                         const destroyOutput = await executor.destroy({
                                             isDeploying: true,
+                                            logger: getLogger(task),
                                             package: packageName,
                                             parameters,
                                             project: ctx.configOutput.config.project,
@@ -159,7 +172,7 @@ export default class Undeploy extends Command {
                                         ctx.destroyed = output;
                                     },
                                     title: `Destroying ${packageName}`,
-                                })), { concurrent: true });
+                                })), { concurrent: true, rendererOptions: { collapseSubtasks: !isDebug() } });
                             },
                             title: `Destroying packages`,
                         },
@@ -194,7 +207,7 @@ export default class Undeploy extends Command {
                             },
                             title: 'Saving state',
                         },
-                    ], { concurrent: false });
+                    ], { concurrent: false, rendererOptions: { collapseSubtasks: !isDebug() } });
                 },
             },
         ]);

package/dist/commands/up/index.js

@@ -4,14 +4,19 @@ import { getBackend } from '../../backend/index.js';
 import { getExecutor } from '../../executor/index.js';
 import { getConfigManager } from '../../lib/config/index.js';
 import { getEnvManager } from '../../lib/env/index.js';
+import { getLogger, isDebug, setDebug } from '../../lib/log.js';
 import { getParameterManager } from '../../lib/parameter/index.js';
-import { delay, setDebug } from '../../lib/shell.js';
+import { delay } from '../../lib/shell.js';
 export default class Up extends Command {
     static description = 'Provision all packages in the project.';
     static examples = ['<%= config.bin %> <%= command.id %>'];
     static flags = {
         chdir: Flags.string({
-            description: 'directory to run command in',
+            description: `
+        Directory where the command will be executed.
+        If not specified, it defaults to the current working directory.
+        Alternatively, you can define the project root by setting the HEREYA_PROJECT_ROOT_DIR environment variable.
+      `,
             required: false,
         }),
         debug: Flags.boolean({
@@ -83,7 +88,10 @@ export default class Up extends Command {
                                     return;
                                 }
                                 return task.newListr(removedPackages.map((packageName) => ({
-                                    async task() {
+                                    rendererOptions: {
+                                        persistentOutput: isDebug(),
+                                    },
+                                    async task(_, task) {
                                         const parameterManager = getParameterManager();
                                         const { parameters } = await parameterManager.getPackageParameters({
                                             package: packageName,
@@ -97,6 +105,7 @@ export default class Up extends Command {
                                         const { executor } = executor$;
                                         const destroyOutput = await executor.destroy({
                                             isDeploying: flags.deploy,
+                                            logger: getLogger(task),
                                             package: packageName,
                                             parameters,
                                             project: configOutput.config.project,
@@ -112,7 +121,7 @@ export default class Up extends Command {
                                         ctx.removed = output;
                                     },
                                     title: `Destroying ${packageName}`,
-                                })), { concurrent: true });
+                                })), { concurrent: true, rendererOptions: { collapseSubtasks: !isDebug() } });
                             },
                             title: `Destroying removed packages`,
                         },
@@ -123,7 +132,10 @@ export default class Up extends Command {
                                     return;
                                 }
                                 return task.newListr(ctx.packages.map((packageName) => ({
-                                    async task() {
+                                    rendererOptions: {
+                                        persistentOutput: isDebug(),
+                                    },
+                                    async task(_, task) {
                                         const parameterManager = getParameterManager();
                                         const { parameters } = await parameterManager.getPackageParameters({
                                             package: packageName,
@@ -137,6 +149,7 @@ export default class Up extends Command {
                                         const { executor } = executor$;
                                         const provisionOutput = await executor.provision({
                                             isDeploying: flags.deploy,
+                                            logger: getLogger(task),
                                             package: packageName,
                                             parameters,
                                             project: ctx.configOutput.config.project,
@@ -152,7 +165,7 @@ export default class Up extends Command {
                                         ctx.added = output;
                                     },
                                     title: `Provisioning ${packageName}`,
-                                })), { concurrent: true });
+                                })), { concurrent: true, rendererOptions: { collapseSubtasks: !isDebug() } });
                             },
                             title: `Provisioning packages`,
                         },
@@ -207,7 +220,7 @@ export default class Up extends Command {
                             },
                             title: 'Saving state',
                         },
-                    ], { concurrent: false });
+                    ], { concurrent: false, rendererOptions: { collapseSubtasks: !isDebug() } });
                 },
                 title: 'Waking up the project',
             },

package/dist/commands/workspace/install/index.js

@@ -2,8 +2,9 @@ import { Args, Command, Flags } from '@oclif/core';
 import { Listr, ListrLogger, ListrLogLevels } from 'listr2';
 import { getBackend } from '../../../backend/index.js';
 import { getExecutor } from '../../../executor/index.js';
+import { getLogger, isDebug, setDebug } from '../../../lib/log.js';
 import { arrayOfStringToObject } from '../../../lib/object-utils.js';
-import { delay, setDebug } from '../../../lib/shell.js';
+import { delay } from '../../../lib/shell.js';
 import { load } from '../../../lib/yaml-utils.js';
 export default class WorkspaceInstall extends Command {
     static args = {
@@ -73,13 +74,17 @@ export default class WorkspaceInstall extends Command {
                             title: 'Resolving parameters',
                         },
                         {
-                            async task(ctx) {
+                            rendererOptions: {
+                                persistentOutput: isDebug(),
+                            },
+                            async task(ctx, task) {
                                 const executor$ = getExecutor();
                                 if (!executor$.success) {
                                     throw new Error(executor$.reason);
                                 }
                                 const { executor } = executor$;
                                 const provisionOutput = await executor.provision({
+                                    logger: getLogger(task),
                                     package: args.package,
                                     parameters: ctx.parameters,
                                     workspace: flags.workspace,
@@ -112,7 +117,7 @@ export default class WorkspaceInstall extends Command {
                 },
                 title: `Installing ${args.package} into workspace ${flags.workspace}`,
             },
-        ], { concurrent: false });
+        ], { concurrent: false, rendererOptions: { collapseSubtasks: !isDebug() } });
         try {
             await task.run();
             myLogger.log(ListrLogLevels.COMPLETED, `Package ${args.package} installed successfully into workspace ${flags.workspace}`);

package/dist/commands/workspace/uninstall/index.js

@@ -2,8 +2,9 @@ import { Args, Command, Flags } from '@oclif/core';
 import { Listr, ListrLogger, ListrLogLevels } from 'listr2';
 import { getBackend } from '../../../backend/index.js';
 import { getExecutor } from '../../../executor/index.js';
+import { getLogger, isDebug, setDebug } from '../../../lib/log.js';
 import { arrayOfStringToObject } from '../../../lib/object-utils.js';
-import { delay, setDebug } from '../../../lib/shell.js';
+import { delay } from '../../../lib/shell.js';
 import { load } from '../../../lib/yaml-utils.js';
 export default class WorkspaceUninstall extends Command {
     static args = {
@@ -80,13 +81,17 @@ export default class WorkspaceUninstall extends Command {
                             title: 'Resolving parameters',
                         },
                         {
-                            async task(ctx) {
+                            rendererOptions: {
+                                persistentOutput: isDebug(),
+                            },
+                            async task(ctx, task) {
                                 const executor$ = getExecutor();
                                 if (!executor$.success) {
                                     throw new Error(executor$.reason);
                                 }
                                 const { executor } = executor$;
                                 const destroyOutput = await executor.destroy({
+                                    logger: getLogger(task),
                                     package: args.package,
                                     parameters: ctx.parameters,
                                     workspace: flags.workspace,
@@ -118,7 +123,7 @@ export default class WorkspaceUninstall extends Command {
                 },
                 title: `Uninstalling package ${args.package} from workspace ${flags.workspace}`,
             },
-        ]);
+        ], { concurrent: false, rendererOptions: { collapseSubtasks: !isDebug() } });
         try {
             await task.run();
             myLogger.log(ListrLogLevels.COMPLETED, `Package ${args.package} uninstalled successfully from workspace ${flags.workspace}`);

package/dist/executor/interface.d.ts

@@ -1,6 +1,8 @@
+import { Logger } from '../lib/log.js';
 import { IPackageMetadata } from '../lib/package/index.js';
 export type ExecutorProvisionInput = {
     isDeploying?: boolean;
+    logger?: Logger;
     package: string;
     parameters?: {
         [key: string]: string;

package/dist/executor/local.js

@@ -12,6 +12,7 @@ export class LocalExecutor {
         return destroyPackage({
             ...input,
             env: getWorkspaceEnvOutput.env,
+            logger: input.logger,
         });
     }
     async provision(input) {
@@ -25,6 +26,7 @@ export class LocalExecutor {
         return provisionPackage({
             ...input,
             env: getWorkspaceEnvOutput.env,
+            logger: input.logger,
         });
     }
     async resolveEnvValues(input) {

package/dist/iac/cdk.js

@@ -1,5 +1,5 @@
 import { CloudFormationClient, DescribeStacksCommand } from '@aws-sdk/client-cloudformation';
-import { writeFileSync } from 'node:fs';
+import { writeFile } from 'node:fs/promises';
 import path from 'node:path';
 import { runShell } from '../lib/shell.js';
 import { load } from '../lib/yaml-utils.js';
@@ -15,6 +15,7 @@ export class Cdk {
                     ...remainingEnv,
                     STACK_NAME: input.id
                 },
+                logger: input.logger,
             });
             const env = await this.getEnv(input.id);
             return { env, success: true };
@@ -34,7 +35,8 @@ export class Cdk {
                 env: {
                     ...remainingEnv,
                     STACK_NAME: input.id
-                }
+                },
+                logger: input.logger,
             });
             return { env, success: true };
         }
@@ -58,16 +60,18 @@ export class Cdk {
         ], {
             directory: workDir,
             env: { ...input.env, ...input.parameters },
+            logger: input.logger,
         });
         const result = await runShell('npx', [
             'aws-cdk', 'synth',
         ], {
             directory: workDir,
             env: { ...input.env, ...input.parameters },
+            logger: input.logger,
             stdio: 'pipe',
         });
         const stackYamlPath = path.join(workDir, '.stack.yaml');
-        writeFileSync(stackYamlPath, result.stdout);
+        await writeFile(stackYamlPath, result.stdout, { encoding: 'utf8' });
         const { data: synthedStack } = await load(stackYamlPath);
         return Object.keys(synthedStack.Parameters);
     }

package/dist/iac/common.d.ts

@@ -1,3 +1,4 @@
+import { Logger } from '../lib/log.js';
 export interface Iac {
     apply(input: ApplyInput): Promise<ApplyOutput>;
     destroy(input: DestroyInput): Promise<DestroyOutput>;
@@ -19,6 +20,7 @@ export type ApplyInput = {
         terraformStateBucketRegion?: string;
         terraformStateLockTableName: string;
     };
+    logger?: Logger;
     parameters?: {
         [key: string]: string;
     };

package/dist/iac/terraform.d.ts

@@ -1,8 +1,9 @@
+import { Logger } from '../lib/log.js';
 import { ApplyInput, ApplyOutput, DestroyInput, DestroyOutput, Iac } from './common.js';
 export declare class Terraform implements Iac {
     apply(input: ApplyInput): Promise<ApplyOutput>;
     destroy(input: DestroyInput): Promise<DestroyOutput>;
-    downloadTerraform(): Promise<boolean>;
+    downloadTerraform(logger?: Logger): Promise<boolean>;
     private getEnv;
     private getTerraformBinary;
     private getWithRedirect;

package/dist/iac/terraform.js

@@ -26,7 +26,7 @@ export class Terraform {
             await fs.promises.writeFile(backendFile, backendConfig);
         }
         try {
-            const terraform = await this.getTerraformBinary();
+            const terraform = await this.getTerraformBinary(input.logger);
             await runShell(terraform, ['init'], {
                 directory: input.pkgPath,
                 env: {
@@ -40,6 +40,7 @@ export class Terraform {
                         typeof value === 'object' ? JSON.stringify(value) : value,
                     ]),
                 },
+                logger: input.logger,
             });
             await runShell(terraform, ['apply', '-auto-approve'], {
                 directory: input.pkgPath,
@@ -54,6 +55,7 @@ export class Terraform {
                         typeof value === 'object' ? JSON.stringify(value) : value,
                     ]),
                 },
+                logger: input.logger,
             });
             const env = await this.getEnv(input.pkgPath);
             return {
@@ -69,7 +71,7 @@ export class Terraform {
         }
     }
     async destroy(input) {
-        const terraform = await this.getTerraformBinary();
+        const terraform = await this.getTerraformBinary(input.logger);
         try {
             await runShell(terraform, ['init'], {
                 directory: input.pkgPath,
@@ -84,6 +86,7 @@ export class Terraform {
                         typeof value === 'object' ? JSON.stringify(value) : value,
                     ]),
                 },
+                logger: input.logger,
             });
             const env = await this.getEnv(input.pkgPath);
             await runShell(terraform, ['destroy', '-auto-approve'], {
@@ -99,6 +102,7 @@ export class Terraform {
                         typeof value === 'object' ? JSON.stringify(value) : value,
                     ]),
                 },
+                logger: input.logger,
             });
             return {
                 env,
@@ -112,7 +116,11 @@ export class Terraform {
             };
         }
     }
-    async downloadTerraform() {
+    async downloadTerraform(logger) {
+        if (process.env.HEREYA_SKIP_TERRAFORM_DOWNLOAD === 'true') {
+            logger?.info('Skipping terraform download');
+            return false;
+        }
         const TERRAFORM_DOWNLOAD_URLS = new Map([
             ['darwin_arm64', 'https://github.com/opentofu/opentofu/releases/download/v1.9.0/tofu_1.9.0_darwin_arm64.zip'],
             ['darwin_x64', 'https://github.com/opentofu/opentofu/releases/download/v1.9.0/tofu_1.9.0_darwin_amd64.zip'],
@@ -140,7 +148,7 @@ export class Terraform {
                 await fs.promises.rm(tfPath);
             }
         }
-        console.log('Downloading terraform...');
+        logger?.info('Downloading terraform...');
         const binKey = `${os.platform()}_${os.arch()}`;
         const url = TERRAFORM_DOWNLOAD_URLS.get(binKey);
         if (!url) {
@@ -168,8 +176,8 @@ export class Terraform {
         });
         return true;
     }
-    async getEnv(pkgPath) {
-        const terraform = await this.getTerraformBinary();
+    async getEnv(pkgPath, logger) {
+        const terraform = await this.getTerraformBinary(logger);
         const resourceOut = await runShell(terraform, ['output', '--json'], {
             directory: pkgPath,
             stdio: 'pipe',
@@ -186,8 +194,8 @@ export class Terraform {
         }
         return tfEnv;
     }
-    async getTerraformBinary() {
-        await this.downloadTerraform();
+    async getTerraformBinary(logger) {
+        await this.downloadTerraform(logger);
         return this.terraformBinPath();
     }
     async getWithRedirect(url, handler, reject) {
@@ -206,6 +214,9 @@ export class Terraform {
             .on('error', (error) => reject(error));
     }
     terraformBinPath() {
+        if (process.env.HEREYA_TERRAFORM_BIN_PATH) {
+            return process.env.HEREYA_TERRAFORM_BIN_PATH;
+        }
         return path.join(os.homedir(), '.hereya', 'iac', 'terraform', 'tofu_1', os.platform() === 'win32' ? 'tofu.exe' : 'tofu');
     }
 }

package/dist/infrastructure/aws.js

@@ -63,6 +63,7 @@ export class AwsInfrastructure {
             env: input.env ?? {},
             id: input.id,
             infraConfig,
+            logger: input.logger,
             parameters: input.parameters,
             pkgPath: downloadPath,
         });
@@ -97,6 +98,7 @@ export class AwsInfrastructure {
             env: input.env ?? {},
             id: input.id,
             infraConfig,
+            logger: input.logger,
             parameters: input.parameters,
             pkgPath: downloadPath,
         });

package/dist/infrastructure/common.d.ts

@@ -1,4 +1,5 @@
 import { IacType } from '../iac/common.js';
+import { Logger } from '../lib/log.js';
 export declare enum InfrastructureType {
     aws = "aws",
     azure = "azure",
@@ -27,6 +28,7 @@ export type ProvisionInput = {
     };
     iacType: IacType;
     id: string;
+    logger?: Logger;
     parameters?: {
         [key: string]: string;
     };

package/dist/infrastructure/index.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { Logger } from '../lib/log.js';
 import { PackageMetadata } from '../lib/package/index.js';
 import { AwsInfrastructure } from './aws.js';
 import { Infrastructure, InfrastructureType } from './common.js';
@@ -15,6 +16,7 @@ export type ProvisionPackageInput = {
         [key: string]: string;
     };
     isDeploying?: boolean;
+    logger?: Logger;
     package: string;
     parameters?: {
         [key: string]: string;

package/dist/infrastructure/index.js

@@ -57,6 +57,7 @@ export async function destroyPackage(input) {
             env: input.env,
             iacType: metadata.iac,
             id,
+            logger: input.logger,
             parameters: input.parameters,
             pkgName,
             pkgUrl: packageUri,
@@ -68,6 +69,7 @@ export async function destroyPackage(input) {
             env: input.env,
             iacType: metadata.iac,
             id,
+            logger: input.logger,
             parameters: input.parameters,
             pkgName,
             pkgUrl: packageUri,
@@ -142,6 +144,7 @@ export async function provisionPackage(input) {
             env: { ...input.env, ...depsEnv },
             iacType: metadata.iac,
             id,
+            logger: input.logger,
             parameters: input.parameters,
             pkgName,
             pkgUrl: packageUri,
@@ -153,6 +156,7 @@ export async function provisionPackage(input) {
             env: input.env,
             iacType: metadata.iac,
             id,
+            logger: input.logger,
             parameters: input.parameters,
             pkgName,
             pkgUrl: packageUri,

package/dist/infrastructure/local.js

@@ -27,6 +27,7 @@ export class LocalInfrastructure {
         const output = await iac.destroy({
             env: input.env ?? {},
             id: input.id,
+            logger: input.logger,
             parameters: input.parameters,
             pkgPath: downloadPath,
         });
@@ -49,6 +50,7 @@ export class LocalInfrastructure {
         const output = await iac.apply({
             env: input.env ?? {},
             id: input.id,
+            logger: input.logger,
             parameters: input.parameters,
             pkgPath: downloadPath,
         });

package/dist/lib/log.d.ts

@@ -1,4 +1,18 @@
-export declare function getLogger(): {
-    done(message: string): void;
-    log(message: string): void;
+import { ListrTaskWrapper } from 'listr2';
+export declare function setDebug(value: boolean): void;
+export declare function isDebug(): boolean;
+export declare function getLogger(task: ListrTaskWrapper<any, any, any>): {
+    debug(message: string): void;
+    error(message: string): void;
+    info(message: string): void;
 };
+export declare function getDefaultLogger(): {
+    debug(message: string): void;
+    error(message: string): void;
+    info(message: string): void;
+};
+export interface Logger {
+    debug(message: string): void;
+    error(message: string): void;
+    info(message: string): void;
+}

package/dist/lib/log.js

@@ -1,13 +1,63 @@
-import { ListrLogger, ListrLogLevels } from 'listr2';
-const myLogger = new ListrLogger({ useIcons: false });
-const logger = {
-    done(message) {
-        myLogger.log(ListrLogLevels.COMPLETED, message);
-    },
-    log(message) {
-        myLogger.log(ListrLogLevels.OUTPUT, message);
-    },
-};
-export function getLogger() {
-    return logger;
+import fs from 'node:fs';
+import path from 'node:path';
+import { stripVTControlCharacters } from 'node:util';
+let debug = false;
+export function setDebug(value) {
+    debug = value;
+}
+export function isDebug() {
+    return debug;
+}
+const logPath = path.resolve(process.cwd(), 'hereya-debug.log');
+export function getLogger(task) {
+    let logFile;
+    if (isDebug()) {
+        logFile = fs.createWriteStream(logPath, { encoding: 'utf8', flags: 'a' });
+    }
+    return {
+        debug(message) {
+            if (isDebug()) {
+                task.output = message;
+                logFile.write(stripVTControlCharacters(message), 'utf8');
+            }
+        },
+        error(message) {
+            task.output = message;
+            if (isDebug()) {
+                logFile.write(stripVTControlCharacters(message), 'utf8');
+            }
+        },
+        info(message) {
+            task.output = message;
+            if (isDebug()) {
+                logFile.write(stripVTControlCharacters(message), 'utf8');
+            }
+        },
+    };
+}
+export function getDefaultLogger() {
+    let logFile;
+    if (isDebug()) {
+        logFile = fs.createWriteStream(logPath, { encoding: 'utf8', flags: 'a' });
+    }
+    return {
+        debug(message) {
+            if (isDebug()) {
+                console.debug(message);
+                logFile.write(stripVTControlCharacters(message), 'utf8');
+            }
+        },
+        error(message) {
+            if (isDebug()) {
+                console.error(message);
+                logFile.write(stripVTControlCharacters(message), 'utf8');
+            }
+        },
+        info(message) {
+            if (isDebug()) {
+                console.info(message);
+                logFile.write(stripVTControlCharacters(message), 'utf8');
+            }
+        },
+    };
 }