@uipath/audit-commands 1.203.0-preview.235 → 1.203.0-preview.240

package/dist/index.js

@@ -6953,7 +6953,165 @@ class FilterImplicitLimitError extends Error {
     this.instructions = "Pass --limit <n> to choose how many records the filter applies to. " + "To filter over all records, pass the command's maximum accepted --limit (see the option's description in --help).";
   }
 }
-function applyFilter(data, filter) {
+function countRecords(data) {
+  if (Array.isArray(data))
+    return data.length;
+  return data == null ? 0 : 1;
+}
+function availableFields(data) {
+  const records = Array.isArray(data) ? data : [data];
+  const keys = new Set;
+  for (const record of records) {
+    if (record && typeof record === "object" && !Array.isArray(record)) {
+      for (const key of Object.keys(record))
+        keys.add(key);
+    }
+  }
+  return [...keys];
+}
+function decodeQuotedIdentifier(whole, inner) {
+  const [error, decoded] = catchError2(() => JSON.parse(whole));
+  if (!error && typeof decoded === "string")
+    return decoded;
+  return inner.replace(/\\(.)/g, "$1");
+}
+function referencedFields(filter) {
+  const top = new Set;
+  const nested = new Set;
+  const withoutValueLiterals = filter.replace(/'(?:\\.|[^'\\])*'/g, " ").replace(/`(?:\\.|[^`\\])*`/g, " ");
+  const isPathTail = (text, index) => text[index - 1] === "." && /[A-Za-z0-9_"]/.test(text[index - 2] ?? "");
+  const quoted = [];
+  const withoutLiterals = withoutValueLiterals.replace(/"((?:\\.|[^"\\])*)"/g, (whole, name, index) => {
+    const isAlias = /^\s*:/.test(withoutValueLiterals.slice(index + whole.length));
+    if (!isAlias) {
+      quoted.push({
+        name: decodeQuotedIdentifier(whole, name),
+        index,
+        tail: isPathTail(withoutValueLiterals, index)
+      });
+    }
+    return `"${" ".repeat(whole.length - 2)}"`;
+  });
+  const descent = /[A-Za-z0-9_"]\s*[.[]/.exec(withoutLiterals);
+  const rootEnd = descent ? descent.index + 1 : Number.POSITIVE_INFINITY;
+  const place = (name, index, tail) => {
+    if (tail || index >= rootEnd)
+      nested.add(name);
+    else
+      top.add(name);
+  };
+  for (const entry of quoted)
+    place(entry.name, entry.index, entry.tail);
+  const identifiers = withoutLiterals.matchAll(/([A-Za-z_][A-Za-z0-9_]*)(\s*[:(])?/g);
+  const reserved = new Set(["true", "false", "null", "and", "or", "not"]);
+  for (const match of identifiers) {
+    const [, name, trailing] = match;
+    if (trailing || reserved.has(name))
+      continue;
+    place(name, match.index, isPathTail(withoutLiterals, match.index));
+  }
+  return {
+    top: [...top],
+    nested: [...nested].filter((name) => !top.has(name)),
+    hasPredicate: /\[\s*\?/.test(withoutValueLiterals)
+  };
+}
+function appearsBelowTopLevel(data, name) {
+  let budget = 2000;
+  const visit = (value, depth) => {
+    if (budget-- <= 0 || depth > 4)
+      return false;
+    if (value === null || typeof value !== "object")
+      return false;
+    if (Array.isArray(value))
+      return value.some((entry) => visit(entry, depth));
+    const record = value;
+    if (depth > 0 && Object.hasOwn(record, name))
+      return true;
+    return Object.values(record).some((entry) => visit(entry, depth + 1));
+  };
+  return visit(data, 0);
+}
+function alwaysNullKeys(records) {
+  const objects = records.filter((r) => r != null && typeof r === "object" && !Array.isArray(r));
+  if (objects.length === 0 || objects.length !== records.length)
+    return [];
+  const keys = [...new Set(objects.flatMap((o) => Object.keys(o)))];
+  if (keys.length === 0)
+    return [];
+  const nullKeys = keys.filter((key) => objects.every((record) => record[key] === null));
+  return nullKeys.length === keys.length ? nullKeys : [];
+}
+function carriesOnlyNulls(value) {
+  if (value === null)
+    return true;
+  if (Array.isArray(value)) {
+    return value.length > 0 && value.every(carriesOnlyNulls);
+  }
+  if (typeof value === "object" && value !== undefined) {
+    const values = Object.values(value);
+    return values.length > 0 && values.every(carriesOnlyNulls);
+  }
+  return false;
+}
+function nameList(names, cap2 = 12) {
+  const shown = names.slice(0, cap2).map((n) => `\`${n}\``);
+  const rest = names.length - shown.length;
+  return shown.join(", ") + (rest > 0 ? `, and ${rest} more` : "");
+}
+function buildFilterWarning(filter, data, outcome) {
+  const present = availableFields(data);
+  const refs = referencedFields(filter);
+  const unknown = refs.top.filter((name) => !present.includes(name) && !appearsBelowTopLevel(data, name));
+  const unchecked = refs.nested.filter((name) => !present.includes(name));
+  const count = countRecords(data);
+  const scope = `${count} record(s)`;
+  const isNotAField = (names) => `${nameList(names)} ${names.length === 1 ? "is not a field" : "are not fields"} on the ${scope} it read`;
+  const soundness = unchecked.length > 0 ? `${nameList(unchecked)} ${unchecked.length === 1 ? "reads" : "read"} below the top level, so ${unchecked.length === 1 ? "it was" : "they were"} not checked against the record keys` : refs.top.length > 0 ? "every field it names exists" : "";
+  const withSoundness = (base) => soundness ? `${base}, and ${soundness}` : base;
+  let detail;
+  let lede;
+  if (outcome.kind === "null-elements") {
+    lede = "returned only null values";
+    const projected = `all ${outcome.count} of the elements it projected are null`;
+    if (unknown.length > 0) {
+      detail = `${projected}, because ${isNotAField(unknown)}`;
+    } else if (unchecked.length > 0) {
+      detail = withSoundness(projected);
+    } else {
+      detail = `${projected}, and every field it names exists — a multi-select list ` + `(\`[A, B]\`) reads each entry against \`Data\` itself, so on a list ` + `result use \`[].[A, B]\` or \`[].{a: A, b: B}\` to read the records`;
+    }
+  } else if (outcome.kind === "null-rows") {
+    lede = "returned only null values";
+    const projected = `every value it projected is null on all ${outcome.count} row(s)`;
+    detail = unknown.length > 0 ? `${projected}, because ${isNotAField(unknown)}` : withSoundness(projected);
+  } else if (outcome.kind === "null-values") {
+    lede = "returned only null values";
+    const projected = `every key it projected (${nameList(outcome.keys)}) is null`;
+    const sameSet = unknown.length === outcome.keys.length && outcome.keys.every((k) => unknown.includes(k));
+    if (sameSet) {
+      detail = `${isNotAField(outcome.keys)}, so every key it projected is null`;
+    } else if (unknown.length > 0) {
+      detail = `${projected}, because ${isNotAField(unknown)}`;
+    } else {
+      detail = withSoundness(`${projected} on all ${scope}`);
+    }
+  } else {
+    lede = "returned nothing";
+    if (unknown.length > 0) {
+      detail = isNotAField(unknown);
+    } else {
+      const selection = refs.hasPredicate ? "no record matched" : "the expression resolved to no value";
+      detail = withSoundness(`${selection} — it read ${scope}`);
+    }
+  }
+  const fields = present.length > 0 ? ` Available fields: ${nameList(present)}.` : "";
+  return `--output-filter ${JSON.stringify(filter)} ${lede}: ${detail}.${fields}`;
+}
+function appendWarning(existing, note) {
+  return existing ? `${existing} ${note}` : note;
+}
+function applyFilter(data, filter, onWarning) {
   const codec = requireJmespath();
   let result;
   try {
@@ -6961,9 +7119,34 @@ function applyFilter(data, filter) {
   } catch (err) {
     throw new FilterEvaluationError(filter, err);
   }
-  if (result == null)
+  const inputCount = countRecords(data);
+  const warn = (outcome) => {
+    if (inputCount === 0)
+      return;
+    const note = buildFilterWarning(filter, data, outcome);
+    getOutputSink().writeErr(`[WARN] ${note}
+`);
+    onWarning?.(note);
+  };
+  const warnIfAllNull = (records) => {
+    const keys = alwaysNullKeys(records);
+    if (keys.length > 0)
+      warn({ kind: "null-values", keys });
+  };
+  if (result == null) {
+    warn({ kind: "empty" });
     return [];
+  }
   if (Array.isArray(result)) {
+    if (result.length === 0) {
+      warn({ kind: "empty" });
+    } else if (result.every((entry) => entry === null)) {
+      warn({ kind: "null-elements", count: result.length });
+    } else if (result.every((entry) => Array.isArray(entry)) && carriesOnlyNulls(result)) {
+      warn({ kind: "null-rows", count: result.length });
+    } else {
+      warnIfAllNull(result);
+    }
     if (result.length > 0 && typeof result[0] !== "object") {
       const fieldMatch = filter.match(/\.(\w+)$/);
       const key = fieldMatch ? fieldMatch[1] : "Value";
@@ -6971,10 +7154,30 @@ function applyFilter(data, filter) {
     }
     return result;
   }
-  if (typeof result === "object")
+  if (typeof result === "object") {
+    warnIfAllNull([result]);
     return result;
+  }
   return { Value: result };
 }
+function filterFailureData(envelope) {
+  const filter = getOutputFilter();
+  const data = envelope.Data;
+  if (!filter || data == null)
+    return;
+  let note;
+  const [filterError, filtered] = catchError2(() => applyFilter(data, filter, (n) => {
+    note = n;
+  }));
+  if (filterError) {
+    envelope.Warning = appendWarning(envelope.Warning, `--output-filter was not applied, so Data is shown in full: ${filterError.message}`);
+    return;
+  }
+  envelope.Data = filtered;
+  if (note) {
+    envelope.Warning = appendWarning(envelope.Warning, note);
+  }
+}
 function defaultErrorCodeForResult(result) {
   switch (result) {
     case RESULTS.AuthenticationError:
@@ -7057,8 +7260,14 @@ var OutputFormatter;
     }
     const filter = getOutputFilter();
     if (filter) {
-      const filtered = applyFilter(data.Data, filter);
+      let note;
+      const filtered = applyFilter(data.Data, filter, (n) => {
+        note = n;
+      });
       data.Data = normalize ? normalizeDataKeys(filtered, verbatim, subtrees && { refs: subtrees.refs, mode: "skip" }) : filtered;
+      if (note) {
+        data.Warning = appendWarning(data.Warning, note);
+      }
     }
     logOutput(normalizeOutputKeys(data), getOutputFormat(), options?.tableRowStyle);
   }
@@ -7086,6 +7295,7 @@ var OutputFormatter;
     delete envelope.TelemetryErrorClass;
     delete envelope.TelemetryTerminalOutcome;
     delete envelope.TelemetryTerminalSignal;
+    filterFailureData(envelope);
     if (!suppressTelemetry) {
       telemetry.trackEvent(CommonTelemetryEvents.Error, {
         result: data.Result,
@@ -7134,13 +7344,20 @@ var OutputFormatter;
   OutputFormatter.log = log;
   function formatToString(data) {
     const filter = getOutputFilter();
+    const envelope = data;
     if ("Data" in data && data.Data != null) {
       data.Data = normalizeDataKeys(data.Data);
       if (filter) {
-        data.Data = normalizeDataKeys(applyFilter(data.Data, filter));
+        let note;
+        data.Data = normalizeDataKeys(applyFilter(data.Data, filter, (n) => {
+          note = n;
+        }));
+        if (note) {
+          envelope.Warning = appendWarning(envelope.Warning, note);
+        }
       }
     }
-    const output = normalizeOutputKeys(data);
+    const output = normalizeOutputKeys(envelope);
     const lines = [];
     const sink = getOutputSink();
     printOutput(output, getOutputFormat(), (msg) => {
@@ -8914,4 +9131,4 @@ export {
   registerCommands
 };
 
-//# debugId=CB93B8471D4DB1E864756E2164756E21
+//# debugId=C45BBF6F908F140B64756E2164756E21

package/package.json

@@ -2,7 +2,7 @@
     "name": "@uipath/audit-commands",
     "author": "UiPath",
     "license": "SEE LICENSE IN LICENSE.txt",
-    "version": "1.203.0-preview.235",
+    "version": "1.203.0-preview.240",
     "description": "Admin CLI commands for the UiPath Audit Service — query event sources, paginate events, and export ZIPs from the long-term store. Library composed by admin-tool, not a standalone CLI tool.",
     "private": false,
     "repository": {
@@ -26,5 +26,5 @@
     "files": [
         "dist"
     ],
-    "gitHead": "4788b04c17a4429e5a994af2c3eba3898d1c4b13"
+    "gitHead": "95409ea61d359dff5465afaf59cb3a5efae542af"
 }