hobots 6.0.0 → 6.1.1

package/README.md

@@ -231,6 +231,7 @@ Sem handler próprio de sinal, um `SIGINT`/`SIGTERM` (ou erro fatal) com execuç
 
 ## Changelog resumido
 
+- **6.1.0** — cada item do `items.each` termina com uma linha `[item] FINISH <chave> (<ms>)` no log, no nível do desfecho (`success`/`error`/`warning`), no lugar do `[step] FINISH item — …`; `item.message` com o motivo. Detalhes no [CHANGELOG](./CHANGELOG.md).
 - **6.0.0** — **breaking**: o handler de `items.each` recebe o handle do item, `async (item, index) => …` (`index` opcional); o elemento da lista é `item.value` e a posição, `item.index`. Migração: `async (conta, item, i) => …` → `async (item, i) => { const conta = item.value; … }`. `options.id`/`payload`/`description` continuam recebendo `(element, index)`. **Payload padrão:** sem `options.payload`, os campos do elemento (objeto simples, cópia rasa) viram o payload base do item; `options.payload` substitui, `payload: false` desliga. Detalhes no [CHANGELOG](./CHANGELOG.md).
 - **5.2.0** — **`item.data(payload)`** no handle do `items.each`: guarda atributos do item sem registrar desfecho; mescla a cada chamada e entra em qualquer desfecho (inclusive nos implícitos), entre o `options.payload` do `each` e o payload da chamada de desfecho; zera na nova tentativa. Detalhes no [CHANGELOG](./CHANGELOG.md).
 - **5.1.0** — `items.each` com **nova tentativa por item** (`retries: 1`, `retryDelayMs: 5000`; uma etapa só por elemento, `warning` quando a repetição deu certo, `error` + item `failed` quando esgotou), **`Occurrence`** exportada (`throw new Occurrence(msg, payload?, { image }?)` no handler = item `occurrence`, sem repetir), `id` por campo (`'numero'`), chave composta (`['cnpj', 'competencia']`) ou função — padrão: o campo `id` do elemento — e **reexecução sem repetir**: ao executar novamente o trabalho, pula os ids já `succeeded`/`occurrence` (`skipDone: true`; `POST /v1/runs/{id}/items/done`); resultado com `skipped`; `item.id` sempre `string`, `item.attempt`. Detalhes no [CHANGELOG](./CHANGELOG.md).

package/dist/index.cjs

@@ -45,7 +45,7 @@ module.exports = __toCommonJS(src_exports);
 
 // src/utils.ts
 var SDK_NAME = "hobots";
-var SDK_VERSION = true ? "6.0.0" : "0.0.0-dev";
+var SDK_VERSION = true ? "6.1.1" : "0.0.0-dev";
 function isNode() {
   return typeof process !== "undefined" && typeof process.versions?.node === "string";
 }
@@ -1547,6 +1547,10 @@ function stepId() {
 function stepLabel(op, description) {
   return [op, description].filter(Boolean).join(" \u2014 ") || "(sem nome)";
 }
+var ITEM_OP = "item";
+function lifecycleLabel(kind, op, description) {
+  return stepLabel(kind === "item" && op === ITEM_OP ? void 0 : op, description);
+}
 function errorText(error) {
   if (error instanceof Error) return error.message || error.name;
   return safeString(error);
@@ -1579,21 +1583,25 @@ function colorForStatus(status) {
   }
 }
 var Step = class {
-  constructor(transaction, parentStepId, op, description) {
+  constructor(transaction, parentStepId, op, description, kind = "step") {
     this.transaction = transaction;
     this.parentStepId = parentStepId;
     this.op = op;
     this.description = description;
+    this.kind = kind;
   }
   transaction;
   parentStepId;
   op;
   description;
+  kind;
   stepId = stepId();
   startTimestamp = nowISO();
   status = "ok";
   endTimestamp;
   _data;
+  // desfecho que a linha de FINISH reporta no lugar do status da etapa (item do `each`)
+  outcome;
   // ── API do bot ────────────────────────────────────────────────────────────
   warning(message, options) {
     if (this.status !== "error") this._setStatus("warning", message);
@@ -1632,6 +1640,13 @@ var Step = class {
     this._close();
     return this;
   }
+  /**
+   * Faz a linha de FINISH reportar `status`/`reason` em vez do status da etapa — o
+   * `items.each` usa para o log do item seguir o desfecho dele (sucesso/falha/ocorrência).
+   */
+  _setOutcome(status, reason) {
+    this.outcome = { status, reason };
+  }
   _setData(key, value) {
     this._data = { ...this._data, [key]: value };
   }
@@ -1663,14 +1678,15 @@ var Step = class {
   _close() {
     if (this.endTimestamp) return;
     this.endTimestamp = nowISO();
+    const { status, reason } = this.outcome ?? { status: this.status, reason: this.reason() };
     this.transaction.emit(
-      "step",
+      this.kind,
       "finish",
-      stepLabel(this.op, this.description),
+      lifecycleLabel(this.kind, this.op, this.description),
       this.startTimestamp,
       this.endTimestamp,
-      this.status,
-      this.reason()
+      status,
+      reason
     );
   }
   toJSON() {
@@ -1725,7 +1741,7 @@ var Transaction = class {
   emit(kind, phase, label, startTs, endTs, status, reason) {
     const durationMs = startTs && endTs ? new Date(endTs).getTime() - new Date(startTs).getTime() : void 0;
     const suffix = (durationMs != null ? ` (${durationMs}ms)` : "") + (reason ? `: ${reason}` : "");
-    const localFinish = this.echo && kind === "step" && phase === "finish";
+    const localFinish = this.echo && kind !== "transaction" && phase === "finish";
     if (this.client?.debug || localFinish) {
       const tag = colorize(`[hobots:${kind}] ${phase.toUpperCase()}`, phase === "finish" ? colorForStatus(status ?? "ok") : "cyan");
       console.log(`${tag} ${label}${suffix}`);
@@ -1772,13 +1788,16 @@ var Transaction = class {
     if (!step) return fn();
     return runWithStepScope({ transaction: this, step }, fn);
   }
-  /** Abre uma etapa sob a corrente (ou direta da transaction). Interno: o bot usa `step()`. */
-  start(op, description) {
+  /**
+   * Abre uma etapa sob a corrente (ou direta da transaction). Interno: o bot usa `step()`; o
+   * `items.each` abre com `kind: 'item'` (linhas `[item] START/FINISH`).
+   */
+  start(op, description, kind = "step") {
     this.stepGuard?.();
     const parent = this.currentStep();
-    const step = new Step(this, parent ? parent.stepId : this.stepId, op, description);
+    const step = new Step(this, parent ? parent.stepId : this.stepId, op, description, kind);
     this.steps.push(step);
-    this.emit("step", "start", stepLabel(op, description));
+    this.emit(kind, "start", lifecycleLabel(kind, op, description));
     return step;
   }
   /**
@@ -1942,6 +1961,7 @@ var ItemHandle = class {
   id;
   reported = false;
   status;
+  message;
   attempt = 1;
   accumulated = {};
   data(payload) {
@@ -1963,6 +1983,7 @@ var ItemHandle = class {
     this.attempt = attempt;
     this.reported = false;
     this.status = void 0;
+    this.message = void 0;
     this.accumulated = {};
     if (this.step && (this.step.status === "error" || this.step.status === "warning")) {
       this.step._setStatus("ok");
@@ -1972,6 +1993,7 @@ var ItemHandle = class {
   record(status, message, payload, image3) {
     this.reported = true;
     this.status = status;
+    this.message = message;
     const merged = { ...this.basePayload ?? {}, ...this.accumulated, ...payload ?? {} };
     this.sink.report(status, message, Object.keys(merged).length > 0 ? merged : void 0, this.id, image3);
   }
@@ -2023,6 +2045,10 @@ function knownLength(list) {
   const length = list?.length;
   return typeof length === "number" && Number.isInteger(length) && length >= 1 ? length : void 0;
 }
+var ITEM_LOG_STATUS = { succeeded: "ok", occurrence: "warning", failed: "error" };
+function setItemOutcome(step, status, message) {
+  step._setOutcome(ITEM_LOG_STATUS[status], status === "succeeded" ? void 0 : message);
+}
 function skippedMessage(count) {
   if (count === 1) return "1 item pulado: j\xE1 conclu\xEDdo neste trabalho numa execu\xE7\xE3o anterior";
   return `${count} itens pulados: j\xE1 conclu\xEDdos neste trabalho numa execu\xE7\xE3o anterior`;
@@ -2032,18 +2058,29 @@ async function eachItem(list, handler, options, sink) {
   const requested = options.retries ?? DEFAULT_EACH_RETRIES;
   const totalRetries = Number.isFinite(requested) ? Math.max(0, Math.floor(requested)) : DEFAULT_EACH_RETRIES;
   const explicitId = options.id !== void 0;
-  const length = options.progress === false ? void 0 : knownLength(list);
-  if (length !== void 0) sink.declareTotal(length);
   const done = options.skipDone === false ? void 0 : await sink.doneItemIds();
-  let index = 0;
-  for await (const element of list) {
+  const isDone = (id) => id !== void 0 && done !== void 0 && done.has(id);
+  const length = knownLength(list);
+  let entries;
+  if (length !== void 0 && done !== void 0 && done.size > 0) {
+    const pending = [];
+    let position = 0;
+    for await (const element of list) {
+      const id = resolveId(options.id, element, position, explicitId);
+      if (isDone(id)) result.skipped += 1;
+      else pending.push({ element, index: position, id });
+      position += 1;
+    }
+    if (options.progress !== false && pending.length > 0) sink.declareTotal(pending.length);
+    entries = pending;
+  } else {
+    if (options.progress !== false && length !== void 0) sink.declareTotal(length);
+    entries = lazyEntries(list, options.id, explicitId);
+  }
+  for await (const { element, index, id } of entries) {
     sink.checkCanceled();
-    const id = resolveId(options.id, element, index, explicitId);
-    if (done?.size && id !== void 0 && done.has(id)) {
-      result.total += 1;
+    if (isDone(id)) {
       result.skipped += 1;
-      if (options.progress !== false) sink.advance();
-      index += 1;
       continue;
     }
     const description = options.description?.(element, index) ?? id ?? `#${index + 1}`;
@@ -2093,20 +2130,35 @@ async function eachItem(list, handler, options, sink) {
       } else {
         const message = thrownMessage(error);
         if (!handle.reported) handle.failed(message);
-        step?._failed(error);
-        sink.logError(`item ${description} falhou: ${message}`);
+        if (step) {
+          setItemOutcome(step, handle.status ?? "failed", handle.message);
+          step._failed(error);
+        } else {
+          sink.logError(`item ${description} falhou: ${message}`);
+        }
       }
     }
-    step?._close();
+    const final = handle.status ?? "succeeded";
+    if (step) {
+      setItemOutcome(step, final, handle.message);
+      step._close();
+    }
     if (options.progress !== false) sink.advance();
     result.total += 1;
-    result[handle.status ?? "succeeded"] += 1;
-    index += 1;
+    result[final] += 1;
     if (options.flush !== false) await sink.flush();
   }
+  result.total += result.skipped;
   if (result.skipped > 0) sink.logInfo(skippedMessage(result.skipped));
   return result;
 }
+async function* lazyEntries(list, spec, explicit) {
+  let index = 0;
+  for await (const element of list) {
+    yield { element, index, id: resolveId(spec, element, index, explicit) };
+    index += 1;
+  }
+}
 function noteAttempts(step, attempts) {
   if (attempts > 1) step._setData("attempts", attempts);
 }
@@ -2492,7 +2544,7 @@ var RunReporter = class {
     tx.setStepGuard(checkCanceled);
     const eachSink = {
       report: (status, message, payload, id, image3) => this.addItem(status, message, payload, id, image3),
-      startStep: (op, description) => tx.start(op, description),
+      startStep: (op, description) => tx.start(op, description, "item"),
       stepScope: (step, fn) => tx.scope(step, fn),
       declareTotal: (total) => {
         if (this.progressTotal == null) this.setProgress(this.progressCurrent, total);
@@ -2502,7 +2554,9 @@ var RunReporter = class {
       isAborted: () => this.abortController.signal.aborted,
       logInfo: (message) => this.log("info", message),
       logWarning: (message) => this.log("warning", message),
+      /* v8 ignore start -- a run sempre tem `tx`: o item tem etapa e o erro sai na linha `[item] FINISH` (o each só chama logError sem etapa) */
       logError: (message) => this.log("error", message),
+      /* v8 ignore stop */
       sleep: (ms) => cancelableSleep(ms, this.abortController.signal),
       doneItemIds: () => this.listDoneItemIds(),
       flush: () => this.flush()