@agilecustoms/envctl 1.27.0 → 1.28.1

package/README.md

@@ -6,7 +6,7 @@
 ## usage
 
 ```shell
-terraform init -backend-config=key=laxa1986
+envctl init -backend-config=key=laxa1986
 envctl apply -var-file=versions.tfvars -var="log_level=debug"
 envctl delete
 ```
@@ -35,12 +35,6 @@ npm view @agilecustoms/envctl version # show latest version available (without i
       5. "Set up connection"
 5. In GH workflow job use `permissions: id-token: write` and release action with input `npm-publish: true`
 
-## History/motivation
-
-`env-api` is a microservice hosted in 'maintenance' account and working as garbage collector: every environment first
-created in `env-api` and then 'managed' by `env-api`: it deletes env when it is not in use anymore OR can extend lifetime.
-Creation API yields unique ID, so you can safely extend lifetime via this ID
-
 ### Authorization
 
 Main use cases:
@@ -58,7 +52,7 @@ Then I thought about Node.js - it is available on dev machines and in GitHub act
 How to distribute it? First I thought about using `ncc` to bundle in one big .js file
 (as I do for `publish-s3` and `gha-healthcheck`) but it will be hard to use on dev machine...
 
-So I ended up publishing this client as an npm package in npmjs
+So I ended up publishing this client as a npm package in npmjs
 - CI environments can install it via GH action `agilecustoms/envctl`
 - developer will install it globally via `npm install -g @agilecustoms/envctl`
 

package/dist/client/Cli.js

@@ -15,6 +15,7 @@ export class Cli {
     constructor() {
     }
     async run(command, args, options = {}) {
+        const successCodes = options.successCodes ?? [0];
         const timeoutMs = options.timeoutMs ?? NO_TIMEOUT;
         const interactive = options.interactive ?? !!options.inScanner;
         const stdio = [interactive ? 'pipe' : 'ignore', 'pipe', 'pipe'];
@@ -93,7 +94,7 @@ export class Cli {
                     reject(new TimeoutException(`Process killed after timeout of ${timeoutMs}ms`));
                     return;
                 }
-                if (code === 0) {
+                if (code !== null && successCodes.includes(code)) {
                     if (errorBuffer) {
                         logger.warn('Process completed successfully, but there were errors:\n' + errorBuffer);
                     }

package/dist/commands/_utils.js

@@ -15,7 +15,7 @@ export function wrap(callable) {
             else {
                 logger.error('Unknown error: \n' + error.stack);
             }
-            process.exit(1);
+            process.exitCode = 1;
         }
     };
 }

package/dist/service/LocalStateService.js

@@ -20,7 +20,7 @@ export class LocalStateService {
         logger.info('Load local state config');
         const filePath = this.filePath();
         if (!fs.existsSync(filePath)) {
-            logger.warn('Local state file does not exist, must have been accidentally deleted, re-initializing');
+            logger.warn('Local state file does not exist, create new one');
             return this.createEmptyConfig(filePath);
         }
         const data = fs.readFileSync(filePath, 'utf-8');

package/dist/service/LogService.js

@@ -1,4 +1,4 @@
-import { basename } from 'node:path';
+import { basename, dirname } from 'node:path';
 import {} from '../client/index.js';
 import { KnownException } from '../exceptions.js';
 import { logger } from '../logger.js';
@@ -17,6 +17,11 @@ export class LogService extends BaseService {
         const urlPath = new URL(url).pathname;
         const gzName = basename(urlPath);
         const timestamp = Number(gzName.slice(0, -7)) * 1000;
+        const res = await this.envApi.fetch(url);
+        if (!res.ok) {
+            const msg = await res.text();
+            throw new KnownException(`Failed to download logs: ${res.status} ${res.statusText}${msg ? ` - ${msg}` : ''}`);
+        }
         const parts = new Intl.DateTimeFormat(undefined, {
             year: 'numeric',
             month: '2-digit',
@@ -28,13 +33,16 @@ export class LogService extends BaseService {
         }).formatToParts(timestamp);
         const get = (type) => parts.find(p => p.type === type)?.value ?? '';
         const outName = `${get('year')}-${get('month')}-${get('day')}_${get('hour')}.${get('minute')}.${get('second')}.log`;
-        const res = await this.envApi.fetch(url);
-        if (!res.ok) {
-            const msg = await res.text();
-            throw new KnownException(`Failed to download logs: ${res.status} ${res.statusText}${msg ? ` - ${msg}` : ''}`);
-        }
         const outPath = await this.cli.writeInTmpFile(res.body, outName);
         logger.info(`Logs saved to: ${outPath}`);
-        await this.cli.run('open', ['-R', outPath]);
+        if (process.platform === 'darwin') {
+            await this.cli.run('open', ['-R', outPath]);
+        }
+        else if (process.platform === 'win32') {
+            await this.cli.run('explorer.exe', [`/select,${outPath}`], { successCodes: [0, 1] });
+        }
+        else {
+            await this.cli.run('xdg-open', [dirname(outPath)]);
+        }
     }
 }

package/dist/service/TerraformAdapter.js

@@ -65,6 +65,18 @@ export class TerraformAdapter {
             return acc;
         }, new Map());
     }
+    async terraform(args, options = {}) {
+        try {
+            await this.cli.run('terraform', args, options);
+        }
+        catch (error) {
+            if (error instanceof ProcessException && error.code !== null && [-2, -4058].includes(error.code)) {
+                const msg = `terraform command failed with code ${error.code}. Perhaps terraform is not installed`;
+                throw new KnownException(`${msg}. Details:\n${error.message}`, { cause: error });
+            }
+            throw error;
+        }
+    }
     getBackend() {
         if (this.backend) {
             return this.backend;
@@ -126,7 +138,7 @@ export class TerraformAdapter {
         const config = this.localStateService.load();
         const fileHash = hash(fileContent);
         if (fileHash !== config.lockFileHash) {
-            throw new KnownException(`Make sure you're using envctl init instead of terraform init`);
+            throw new KnownException(`Make sure to call 'envctl init' prior to 'envctl plan/apply'`);
         }
         const lockUpdated = config.lockHash !== fileHash;
         config.lockHash = fileHash;
@@ -159,7 +171,7 @@ export class TerraformAdapter {
         if (!linuxArm64) {
             logger.info('Lock providers');
             const vars = this.getVars(args);
-            await this.cli.run('terraform', ['providers', 'lock', '-platform=linux_arm64', ...vars]);
+            await this.terraform(['providers', 'lock', '-platform=linux_arm64', ...vars]);
         }
         const fileContent = this.getLockFile();
         const config = this.localStateService.load();
@@ -232,7 +244,7 @@ export class TerraformAdapter {
     async init(args) {
         logger.info('Running: terraform init ' + args.join(' ') + '\n');
         try {
-            await this.cli.run('terraform', ['init', ...args], { interactive: true });
+            await this.terraform(['init', ...args], { interactive: true });
         }
         catch (error) {
             if (!(error instanceof ProcessException)) {
@@ -248,7 +260,7 @@ export class TerraformAdapter {
     async _plan(args, attemptNo) {
         logger.info('Running: terraform plan ' + args.join(' ') + '\n');
         try {
-            await this.cli.run('terraform', ['plan', ...args], { interactive: true });
+            await this.terraform(['plan', ...args], { interactive: true });
         }
         catch (error) {
             if (!(error instanceof ProcessException)) {
@@ -296,7 +308,7 @@ export class TerraformAdapter {
         logger.debug('timeout(ms): ' + timeoutMs);
         logger.info('Running: terraform apply ' + args.join(' ') + '\n');
         try {
-            await this.cli.run('terraform', ['apply', ...args], { timeoutMs, interactive: true });
+            await this.terraform(['apply', ...args], { timeoutMs, interactive: true });
             this.printTime();
         }
         catch (error) {
@@ -329,7 +341,7 @@ export class TerraformAdapter {
         };
         logger.info('Running: terraform destroy ' + args.join(' ') + '\n');
         try {
-            await this.cli.run('terraform', ['destroy', ...args], { outScanner, interactive: true });
+            await this.terraform(['destroy', ...args], { outScanner, interactive: true });
         }
         catch (error) {
             if (!(error instanceof ProcessException)) {
@@ -373,6 +385,6 @@ export class TerraformAdapter {
     }
     async forceUnlock(id) {
         logger.info('Force unlocking state');
-        await this.cli.run('terraform', ['force-unlock', '-force', id]);
+        await this.terraform(['force-unlock', '-force', id]);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agilecustoms/envctl",
-  "version": "1.27.0",
+  "version": "1.28.1",
   "description": "node.js CLI client for manage environments",
   "keywords": [
     "terraform wrapper",
@@ -31,19 +31,18 @@
   "_comment0": "to run via `npx` you must use `name` (with scope) and have at least one entry in `bin`. Key does not matter when run via `npx`",
   "_comment1": "keys become CLI apps (symlinks) when install globally. ex: npm install -g @agilecustoms/envctl; ls $(which alexc-blah) >> lrwxr-xr-x  1 alexc  admin  62 Dec 30 14:29 /opt/homebrew/bin/alexc-blah -> ../lib/node_modules/@agilecustoms/envctl-client/dist/index.js",
   "scripts": {
-    "prepare": "if [ \"$CI\" != \"true\" ]; then husky; fi",
     "lint": "eslint *.{ts,mjs} \"src/**/*.ts\" \"test/**/*.ts\"",
     "lint:fix": "npm run lint -- --fix",
     "test": "vitest run --coverage",
     "build": "tsc -p tsconfig.build.json",
-    "it": "tsc -p tsconfig.build.json --sourceMap true && TEST_CWD=\"$CWD\" node dist/index.js",
+    "it": "tsc -p tsconfig.build.json --sourceMap true && cross-env TEST_CWD=$CWD node dist/index.js",
     "run-help": "     npm run it -- --help",
     "run-version": "  npm run it -- --version",
     "run-configure": "npm run it -- configure",
     "run-logs": "     npm run it -- logs",
     "-d1-": "",
     "d1-desc": "dev env (fully fledged ~/.envctl/default.json)",
-    "d1": "CWD=../tt-core npm run it --",
+    "d1": "cross-env CWD=../tt-core npm run it --",
     "d1-init": "  npm run d1 -- init -reconfigure -upgrade -backend-config=key=d1",
     "d1-status": "npm run d1 -- status --verbose",
     "d1-apply": " npm run d1 -- apply --auto-approve -var=env_size=min",
@@ -51,29 +50,29 @@
     "d1-logs": "  npm run d1 -- logs",
     "-d2-": "",
     "d2-desc": "dev env destroy",
-    "d2": "CWD=../tt-core npm run it --",
+    "d2": "cross-env CWD=../tt-core npm run it --",
     "d2-init": "   npm run d2 -- init -reconfigure -upgrade -backend-config=key=d2",
     "d2-status": " npm run d2 -- status",
     "d2-apply": "  npm run d2 -- apply --auto-approve",
     "d2-destroy": "npm run d2 -- destroy -var=env_size=min --auto-approve",
     "-d3-": "",
     "d3-desc": "dev env plan apply",
-    "d3": "CWD=../tt-core npm run it --",
+    "d3": "cross-env CWD=../tt-core npm run it --",
     "d3-init": "  npm run d3 -- init -reconfigure -upgrade -backend-config=key=d3",
     "d3-plan": "  npm run d3 -- plan -var=env_size=min -var=env=d3 -out=plan",
     "d3-apply": " npm run d3 -- apply plan",
     "d3-delete": "npm run d3 -- delete",
     "-d4-": "",
     "d4-desc": "terraform init and then envctl apply",
-    "d4": "CWD=../tt-core npm run it --",
-    "d4-init": "cd ../tt-core && rm .terraform.lock.hcl && rm .terraform/envctl.json && terraform init -reconfigure -upgrade -backend-config=key=d4",
+    "d4": "cross-env CWD=../tt-core npm run it --",
+    "d4-init": "cd ../tt-core && rimraf .terraform.lock.hcl .terraform/envctl.json && terraform init -reconfigure -upgrade -backend-config=key=d4",
     "d4-init1": " npm run d4 -- init -reconfigure -upgrade -backend-config=key=d4",
     "d4-apply": " npm run d4 -- apply -auto-approve -var=env_size=min",
     "d4-delete": "npm run d4 -- delete",
     "d4-status": "npm run d4 -- status",
     "-e1-": "",
     "e1-desc": "ephemeral env in CI (must have ENVCTL_API_KEY_ in env vars)",
-    "e1": "CWD=../tt-core CI=true ENVCTL_HOME=non-existing ENVCTL_API_KEY=\"$ENVCTL_API_KEY_\" npm run it --",
+    "e1": "cross-env CWD=../tt-core CI=true ENVCTL_HOME=non-existing ENVCTL_API_KEY=\"$ENVCTL_API_KEY_\" npm run it --",
     "e1-create": "npm run e1 -- create-ephemeral e1 --verbose",
     "e1-init": "  npm run e1 -- init -reconfigure -upgrade -backend-config=key=e1",
     "e1-plan": "  npm run e1 -- plan -var=env_size=min -var=env=e1 -out=plan",
@@ -81,15 +80,15 @@
     "e1-delete": "npm run e1 -- delete",
     "-tt-": "",
     "tt-desc": "deploy TT project from local machine",
-    "tt": "CWD=../tt-gitops AWS_PROFILE=ac-tt-dev-deployer npm run it --",
+    "tt": "cross-env CWD=../tt-gitops AWS_PROFILE=ac-tt-dev-deployer npm run it --",
     "run-init": "   npm run tt -- init -reconfigure -upgrade -backend-config=key=laxa1986 -var-file=versions.tfvars",
     "run-status": " npm run tt -- status",
     "run-apply": "  npm run tt -- apply --auto-approve -var=env_size=min -var-file=versions.tfvars",
     "run-delete": " npm run tt -- delete"
   },
   "dependencies": {
-    "commander": "^14.0.0",
     "@inquirer/prompts": "^8.0.0",
+    "commander": "^14.0.0",
     "update-notifier": "^7.3.1"
   },
   "devDependencies": {
@@ -97,9 +96,11 @@
     "@types/node": "^22.10.2",
     "@types/update-notifier": "^6.0.8",
     "@vitest/coverage-v8": "^4.0.0",
+    "cross-env": "^10.1.0",
     "eslint": "^9.22.0",
     "eslint-plugin-import": "^2.31.0",
     "husky": "^9.1.7",
+    "rimraf": "^6.1.3",
     "typescript": "^6.0.0",
     "typescript-eslint": "^8.8.1",
     "vitest": "^4.0.0"