biaws 0.2.0 → 0.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "biaws",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "CLI do Bondia Workspaces para administração, configuração e operação de workspaces",
   "license": "Apache-2.0",
   "repository": {

package/src/cli/help.js

@@ -1,16 +1,38 @@
-import { Args, Command, Help } from "@oclif/core";
+import { Args, Help } from "@oclif/core";
 
-const OVERVIEW = `Bondia Workspaces (BIAWS)
+import { LocalInstanceCommand } from "../baseCommands.js";
+
+function overview(context) {
+  return `Bondia Workspaces (BIAWS)
 
 O BIAWS organiza o contexto operacional de aplicações, melhorias, issues,
 conhecimento e agentes. Este CLI permite administrar uma instalação, configurar
 o acesso global e trabalhar com o workspace associado à pasta atual.
 
-NÍVEIS
-  admin      instala, diagnostica e opera instâncias da plataforma
+NÍVEIS DE USO
+  admin      instala, diagnostica e opera instalação e instâncias da plataforma
   config     gerencia URLs, perfis e credenciais globais
   workspace  associa a pasta e acessa os recursos do workspace
 
+BIAWS CLI
+  Raiz da instalação: ${context.repositoryRoot}
+  Diretório de instâncias: ${context.instancesDirectory}
+  Diretório do CLI: ${context.toolDirectory}
+
+  Configure caminhos persistentes com as variáveis de ambiente:
+
+    BIAWS_ROOT           raiz da release ou checkout BIAWS; deve conter
+                         compose.yaml, scripts/ e os demais arquivos da plataforma
+                         e é normalmente o diretório onde foi feito o git clone
+
+    BIAWS_INSTANCES_DIR  diretório que conterá uma subpasta por instância,
+                         com seu arquivo .env e dados de configuração, normalmente
+                         é o uma pasta instances dentro do BIAWS_ROOT
+
+  Exemplo:
+    export BIAWS_ROOT=/opt/biaws
+    export BIAWS_INSTANCES_DIR=/var/lib/biaws/instances
+
 PRIMEIROS PASSOS
   biaws config init
   biaws workspace init
@@ -22,9 +44,11 @@ AJUDA
   biaws help workspace issues
 
 PROJETO
+  Saiba mais sobre o projeto (e contribua se quiser):
   https://github.com/fbondia/biaws`;
+}
 
-export default class HelpCommand extends Command {
+export default class HelpCommand extends LocalInstanceCommand {
   static description = "explica o BIAWS ou exibe a ajuda de um comando";
   static strict = false;
   static args = {
@@ -38,7 +62,8 @@ export default class HelpCommand extends Command {
     const { args } = await this.parse(this.constructor);
     const subject = args.command || [];
     if (!subject.length) {
-      this.log(OVERVIEW);
+      const context = await this.localContext();
+      this.log(overview(context));
       return;
     }
     await new Help(this.config).showHelp(subject);

package/src/commands/instance/backup.js

@@ -65,10 +65,11 @@ export default class InstanceBackup extends LocalInstanceCommand {
           { secrets: password ? [password] : [], silent: flags.json },
         ),
     );
-    this.output({ json: flags.json }).result(
-      flags.json
-        ? { instance: instance.name, operation: "backup", output }
-        : output,
-    );
+    if (flags.json)
+      this.output({ json: true }).result({
+        instance: instance.name,
+        operation: "backup",
+        output,
+      });
   }
 }

package/src/commands/instance/restore.js

@@ -87,10 +87,11 @@ export default class InstanceRestore extends LocalInstanceCommand {
           { secrets: password ? [password] : [], silent: flags.json },
         ),
     );
-    this.output({ json: flags.json }).result(
-      flags.json
-        ? { instance: instance.name, operation: "restore", output }
-        : output,
-    );
+    if (flags.json)
+      this.output({ json: true }).result({
+        instance: instance.name,
+        operation: "restore",
+        output,
+      });
   }
 }

package/src/core/processRunner.js

@@ -3,13 +3,32 @@ import { spawn as nodeSpawn } from "node:child_process";
 import { ProcessExecutionError } from "./errors.js";
 import { redactText } from "./redaction.js";
 
-function attachOutput(stream, target, chunks, shouldBuffer) {
-  if (!stream) return;
+function attachOutput(stream, target, chunks, options = {}) {
+  if (!stream) return () => {};
+  const secrets = options.secrets || [];
+  let pending = "";
+
+  const writeSanitizedLines = (value) => {
+    pending += value;
+    const lastNewline = pending.lastIndexOf("\n");
+    if (lastNewline < 0) return;
+    target?.write(redactText(pending.slice(0, lastNewline + 1), secrets));
+    pending = pending.slice(lastNewline + 1);
+  };
+
   stream.on("data", (chunk) => {
     const value = String(chunk);
     chunks.push(value);
-    if (!shouldBuffer && target) target.write(value);
+    if (options.silent || !target) return;
+    if (secrets.length) writeSanitizedLines(value);
+    else target.write(value);
   });
+
+  return () => {
+    if (!options.silent && target && pending)
+      target.write(redactText(pending, secrets));
+    pending = "";
+  };
 }
 
 export class ProcessRunner {
@@ -25,8 +44,6 @@ export class ProcessRunner {
       throw new TypeError("ProcessRunner exige comando e array de argumentos.");
     }
     const secrets = options.secrets || [];
-    const shouldBuffer =
-      Boolean(options.silent) || secrets.some((secret) => String(secret || ""));
     const stdoutChunks = [];
     const stderrChunks = [];
     let child;
@@ -47,8 +64,14 @@ export class ProcessRunner {
         { cause, command: redactText(command, secrets) },
       );
     }
-    attachOutput(child.stdout, this.stdout, stdoutChunks, shouldBuffer);
-    attachOutput(child.stderr, this.stderr, stderrChunks, shouldBuffer);
+    const flushStdout = attachOutput(child.stdout, this.stdout, stdoutChunks, {
+      secrets,
+      silent: Boolean(options.silent),
+    });
+    const flushStderr = attachOutput(child.stderr, this.stderr, stderrChunks, {
+      secrets,
+      silent: Boolean(options.silent),
+    });
     if (options.input !== undefined) child.stdin.end(options.input);
 
     return new Promise((resolve, reject) => {
@@ -73,12 +96,6 @@ export class ProcessRunner {
         stdout: redactText(stdoutChunks.join(""), secrets),
         stderr: redactText(stderrChunks.join(""), secrets),
       });
-      const flush = (result) => {
-        if (!shouldBuffer || options.silent) return;
-        if (result.stdout && this.stdout) this.stdout.write(result.stdout);
-        if (result.stderr && this.stderr) this.stderr.write(result.stderr);
-      };
-
       child.once("error", (cause) => {
         cleanup();
         reject(
@@ -90,8 +107,9 @@ export class ProcessRunner {
       });
       child.once("close", (processExitCode, signal) => {
         cleanup();
+        flushStdout();
+        flushStderr();
         const result = { ...output(), processExitCode, signal: signal || null };
-        flush(result);
         if (processExitCode === 0 && !signal) {
           resolve(result);
           return;