@smthrs/journal 1.0.0-rc.16 → 1.0.0-rc.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +26 -8
  3. package/dist/cjs/CallFact.d.ts +8 -8
  4. package/dist/cjs/Consensus.d.ts +26 -6
  5. package/dist/cjs/Consensus.d.ts.map +1 -1
  6. package/dist/cjs/Consensus.js +63 -22
  7. package/dist/cjs/Consensus.js.map +2 -2
  8. package/dist/cjs/EngineEvent.d.ts +23 -23
  9. package/dist/cjs/EngineEvent.d.ts.map +1 -1
  10. package/dist/cjs/EngineEvent.js +3 -2
  11. package/dist/cjs/EngineEvent.js.map +2 -2
  12. package/dist/cjs/ExecutionFact.d.ts +5 -5
  13. package/dist/cjs/Journal.d.ts +77 -2
  14. package/dist/cjs/Journal.d.ts.map +1 -1
  15. package/dist/cjs/Journal.js +1 -0
  16. package/dist/cjs/Journal.js.map +2 -2
  17. package/dist/cjs/JournalGeneration.d.ts +1 -1
  18. package/dist/cjs/JournalGeneration.d.ts.map +1 -1
  19. package/dist/cjs/JournalGeneration.js +10 -1
  20. package/dist/cjs/JournalGeneration.js.map +2 -2
  21. package/dist/cjs/JournalMetrics.d.ts +41 -5
  22. package/dist/cjs/JournalMetrics.d.ts.map +1 -1
  23. package/dist/cjs/JournalMetrics.js +10 -1
  24. package/dist/cjs/JournalMetrics.js.map +2 -2
  25. package/dist/cjs/RedactedLogger.d.ts.map +1 -1
  26. package/dist/cjs/RedactedLogger.js +5 -3
  27. package/dist/cjs/RedactedLogger.js.map +2 -2
  28. package/dist/cjs/Redaction.d.ts +18 -1
  29. package/dist/cjs/Redaction.d.ts.map +1 -1
  30. package/dist/cjs/Redaction.js +142 -12
  31. package/dist/cjs/Redaction.js.map +3 -3
  32. package/dist/cjs/SqlConsensus.d.ts +4 -3
  33. package/dist/cjs/SqlConsensus.d.ts.map +1 -1
  34. package/dist/cjs/SqlConsensus.js +92 -59
  35. package/dist/cjs/SqlConsensus.js.map +2 -2
  36. package/dist/cjs/SqlJournal.d.ts.map +1 -1
  37. package/dist/cjs/SqlJournal.js +370 -131
  38. package/dist/cjs/SqlJournal.js.map +3 -3
  39. package/dist/cjs/StepFact.d.ts +1 -1
  40. package/dist/cjs/TelemetryLog.d.ts +241 -0
  41. package/dist/cjs/TelemetryLog.d.ts.map +1 -0
  42. package/dist/cjs/TelemetryLog.js +349 -0
  43. package/dist/cjs/TelemetryLog.js.map +7 -0
  44. package/dist/cjs/index.d.ts +5 -0
  45. package/dist/cjs/index.d.ts.map +1 -1
  46. package/dist/cjs/index.js +3 -1
  47. package/dist/cjs/index.js.map +2 -2
  48. package/dist/cjs/internal/EventTally.d.ts +31 -0
  49. package/dist/cjs/internal/EventTally.d.ts.map +1 -0
  50. package/dist/cjs/internal/EventTally.js +32 -0
  51. package/dist/cjs/internal/EventTally.js.map +7 -0
  52. package/dist/cjs/internal/JournalDigest.d.ts +24 -0
  53. package/dist/cjs/internal/JournalDigest.d.ts.map +1 -0
  54. package/dist/cjs/internal/JournalDigest.js +44 -0
  55. package/dist/cjs/internal/JournalDigest.js.map +7 -0
  56. package/dist/cjs/internal/JournalTestObserver.d.ts +41 -0
  57. package/dist/cjs/internal/JournalTestObserver.d.ts.map +1 -0
  58. package/dist/cjs/internal/JournalTestObserver.js +38 -0
  59. package/dist/cjs/internal/JournalTestObserver.js.map +7 -0
  60. package/dist/cjs/internal/TelemetryText.d.ts +28 -0
  61. package/dist/cjs/internal/TelemetryText.d.ts.map +1 -0
  62. package/dist/cjs/internal/TelemetryText.js +44 -0
  63. package/dist/cjs/internal/TelemetryText.js.map +7 -0
  64. package/dist/esm/CallFact.d.ts +8 -8
  65. package/dist/esm/Consensus.d.ts +26 -6
  66. package/dist/esm/Consensus.d.ts.map +1 -1
  67. package/dist/esm/Consensus.js +102 -21
  68. package/dist/esm/Consensus.js.map +1 -1
  69. package/dist/esm/EngineEvent.d.ts +23 -23
  70. package/dist/esm/EngineEvent.d.ts.map +1 -1
  71. package/dist/esm/EngineEvent.js +4 -2
  72. package/dist/esm/EngineEvent.js.map +1 -1
  73. package/dist/esm/ExecutionFact.d.ts +5 -5
  74. package/dist/esm/Journal.d.ts +77 -2
  75. package/dist/esm/Journal.d.ts.map +1 -1
  76. package/dist/esm/Journal.js +4 -1
  77. package/dist/esm/Journal.js.map +1 -1
  78. package/dist/esm/JournalGeneration.d.ts +1 -1
  79. package/dist/esm/JournalGeneration.d.ts.map +1 -1
  80. package/dist/esm/JournalGeneration.js +9 -1
  81. package/dist/esm/JournalGeneration.js.map +1 -1
  82. package/dist/esm/JournalMetrics.d.ts +41 -5
  83. package/dist/esm/JournalMetrics.d.ts.map +1 -1
  84. package/dist/esm/JournalMetrics.js +38 -6
  85. package/dist/esm/JournalMetrics.js.map +1 -1
  86. package/dist/esm/RedactedLogger.d.ts.map +1 -1
  87. package/dist/esm/RedactedLogger.js +9 -5
  88. package/dist/esm/RedactedLogger.js.map +1 -1
  89. package/dist/esm/Redaction.d.ts +18 -1
  90. package/dist/esm/Redaction.d.ts.map +1 -1
  91. package/dist/esm/Redaction.js +199 -16
  92. package/dist/esm/Redaction.js.map +1 -1
  93. package/dist/esm/SqlConsensus.d.ts +4 -3
  94. package/dist/esm/SqlConsensus.d.ts.map +1 -1
  95. package/dist/esm/SqlConsensus.js +34 -22
  96. package/dist/esm/SqlConsensus.js.map +1 -1
  97. package/dist/esm/SqlJournal.d.ts.map +1 -1
  98. package/dist/esm/SqlJournal.js +410 -108
  99. package/dist/esm/SqlJournal.js.map +1 -1
  100. package/dist/esm/StepFact.d.ts +1 -1
  101. package/dist/esm/TelemetryLog.d.ts +241 -0
  102. package/dist/esm/TelemetryLog.d.ts.map +1 -0
  103. package/dist/esm/TelemetryLog.js +519 -0
  104. package/dist/esm/TelemetryLog.js.map +1 -0
  105. package/dist/esm/index.d.ts +5 -0
  106. package/dist/esm/index.d.ts.map +1 -1
  107. package/dist/esm/index.js +5 -0
  108. package/dist/esm/index.js.map +1 -1
  109. package/dist/esm/internal/EventTally.d.ts +31 -0
  110. package/dist/esm/internal/EventTally.d.ts.map +1 -0
  111. package/dist/esm/internal/EventTally.js +27 -0
  112. package/dist/esm/internal/EventTally.js.map +1 -0
  113. package/dist/esm/internal/JournalDigest.d.ts +24 -0
  114. package/dist/esm/internal/JournalDigest.d.ts.map +1 -0
  115. package/dist/esm/internal/JournalDigest.js +27 -0
  116. package/dist/esm/internal/JournalDigest.js.map +1 -0
  117. package/dist/esm/internal/JournalTestObserver.d.ts +41 -0
  118. package/dist/esm/internal/JournalTestObserver.d.ts.map +1 -0
  119. package/dist/esm/internal/JournalTestObserver.js +17 -0
  120. package/dist/esm/internal/JournalTestObserver.js.map +1 -0
  121. package/dist/esm/internal/TelemetryText.d.ts +28 -0
  122. package/dist/esm/internal/TelemetryText.d.ts.map +1 -0
  123. package/dist/esm/internal/TelemetryText.js +28 -0
  124. package/dist/esm/internal/TelemetryText.js.map +1 -0
  125. package/docs/README.md +6 -5
  126. package/docs/api.md +244 -49
  127. package/docs/concepts/owner-fence.md +4 -1
  128. package/docs/concepts/redaction.md +45 -2
  129. package/docs/concepts/state-event-authority.md +5 -4
  130. package/docs/concepts/two-channels.md +3 -2
  131. package/docs/guides/read-a-run.md +8 -6
  132. package/docs/guides/redact-log-output.md +4 -2
  133. package/docs/guides/testing.md +4 -2
  134. package/docs/installation.md +23 -9
  135. package/docs/quickstart.md +58 -3
  136. package/docs/troubleshooting.md +4 -2
  137. package/package.json +21 -9
  138. package/src/Consensus.ts +118 -28
  139. package/src/EngineEvent.ts +6 -2
  140. package/src/Journal.ts +85 -2
  141. package/src/JournalGeneration.ts +13 -1
  142. package/src/JournalMetrics.ts +53 -6
  143. package/src/RedactedLogger.ts +10 -4
  144. package/src/Redaction.ts +252 -16
  145. package/src/SqlConsensus.ts +135 -83
  146. package/src/SqlJournal.ts +604 -179
  147. package/src/TelemetryLog.ts +597 -0
  148. package/src/index.ts +6 -0
  149. package/src/internal/EventTally.ts +39 -0
  150. package/src/internal/JournalDigest.ts +30 -0
  151. package/src/internal/JournalTestObserver.ts +48 -0
  152. package/src/internal/TelemetryText.ts +31 -0
@@ -220,9 +220,8 @@ const bareValueEnd = (text, start, scope, stack, budget) => {
220
220
  continue;
221
221
  }
222
222
  if (char === "<") {
223
- angleClose.lastIndex = end;
224
- const close = angleClose.exec(text)?.index;
225
- if (close !== void 0 && text[close] === ">") {
223
+ const close = angleEnd(text, end);
224
+ if (text[close] === ">") {
226
225
  end = close + 1;
227
226
  continue;
228
227
  }
@@ -265,7 +264,15 @@ const userinfoEnd = (text, start, end) => {
265
264
  return at > 0 ? start + at : end;
266
265
  };
267
266
  const namesCredential = (name, value) => !plainKeyName(name) && !(/tokens$/i.test(name) && /^["'`]?\d+(?![\w.])/.test(value));
267
+ const angleEnd = (text, index) => {
268
+ if (lastAngle.text === text && index >= lastAngle.from && index <= lastAngle.end) return lastAngle.end;
269
+ angleClose.lastIndex = index;
270
+ const end = angleClose.exec(text)?.index ?? text.length;
271
+ lastAngle = { text, from: index, end };
272
+ return end;
273
+ };
268
274
  const angleClose = /[>\r\n]/g;
275
+ let lastAngle = { text: "", from: 0, end: 0 };
269
276
  const continuation = /(?:\s|\\+[nrt])*\+(?:\s|\\+[nrt])*/y;
270
277
  const alreadyRedacted = /^\[REDACTED\]$/;
271
278
  const redactValues = (text, names, scope) => {
@@ -404,6 +411,11 @@ const redactArguments = (text, flags, accept) => {
404
411
  return output + text.slice(position);
405
412
  };
406
413
  const durable = { header: false, diagnostic: false };
414
+ const urlCredentials = /\b([a-z][a-z0-9+.-]{0,30}:\/\/[^\s:@/]*):(?!\[REDACTED\]@)[^\s/?#"'`\\]*@/gi;
415
+ const urlCredentialsSource = urlCredentials.source;
416
+ const machineToken = /smm_[A-Za-z0-9_-]{43,}/;
417
+ const scopedToken = /smt1\.[A-Za-z0-9_-]+\.[A-Za-z0-9_-]{43,}/;
418
+ const redactCredentialWord = (text, token) => text.replace(/[A-Za-z0-9_-]+(?:\.[A-Za-z0-9_-]+)*/g, (word) => token.test(word) ? placeholder : word);
407
419
  const defaultRules = [
408
420
  {
409
421
  id: "private-key-block",
@@ -416,6 +428,23 @@ const defaultRules = [
416
428
  // finds nothing left to change.
417
429
  pattern: /-----BEGIN[^-]*PRIVATE KEY(?: BLOCK)?-----(?:(?!-----BEGIN)[\s\S])*?(?:-----END[^-]*-----|(?=-----BEGIN)|$)/g
418
430
  },
431
+ {
432
+ id: "smithers-scoped-token",
433
+ // control/ScopedToken: base64url JSON claims and a 32-byte HMAC-SHA256.
434
+ // Match the most specific prefix first; claims/signatures can contain smm_.
435
+ // This version prefix is not a JWT header, so the JWT rule cannot cover it.
436
+ pattern: new RegExp(scopedToken.source, "g"),
437
+ rewrite: (text) => redactCredentialWord(text, scopedToken)
438
+ },
439
+ {
440
+ id: "smithers-machine-token",
441
+ // ops/machine-token/issue.ts: smm_ + 32 random bytes in base64url (43 chars).
442
+ // Run before provider-key rules that could consume a token's interior.
443
+ // No word boundary: URL paths and log/Markdown underscores can touch a token.
444
+ // Consume a longer suffix too so a wrapper cannot leave credential material.
445
+ pattern: new RegExp(machineToken.source, "g"),
446
+ rewrite: (text) => redactCredentialWord(text, machineToken)
447
+ },
419
448
  // Git HTTPS OAuth credentials place the secret in the username. Match
420
449
  // before password rewriting removes the x-oauth-basic marker.
421
450
  {
@@ -438,7 +467,7 @@ const defaultRules = [
438
467
  // connection strings. Stopping at the first `:` or `@` left the tail of
439
468
  // such a password in the row. Quotes and backslashes end the scan so a
440
469
  // URL inside JSON text never swallows the next string.
441
- pattern: /\b([a-z][a-z0-9+.-]{0,30}:\/\/[^\s:@/]*):(?!\[REDACTED\]@)[^\s/?#"'`\\]*@/gi,
470
+ pattern: urlCredentials,
442
471
  replace: "$1:[REDACTED]@"
443
472
  },
444
473
  {
@@ -622,6 +651,70 @@ const diagnosticRules = [
622
651
  rewrite: (text) => redactArguments(text, attachedPasswordFlag)
623
652
  }
624
653
  ];
654
+ const privateKeyBlock = new RegExp(defaultRules[0].pattern.source);
655
+ const ruleShape = (rule) => JSON.stringify([
656
+ rule.id,
657
+ rule.pattern.source,
658
+ rule.pattern.flags,
659
+ rule.rewrite === void 0 ? rule.replace ?? placeholder : null
660
+ ]);
661
+ const smithersShapes = defaultRules.filter((rule) => rule.id === "smithers-machine-token" || rule.id === "smithers-scoped-token").map((rule) => ({ shape: ruleShape(rule), rewrite: rule.rewrite, pattern: new RegExp(rule.pattern.source) }));
662
+ const isSmithersRule = (rule) => smithersShapes.some((known) => known.rewrite === rule.rewrite && known.shape === ruleShape(rule));
663
+ const contextualIds = /* @__PURE__ */ new Set([
664
+ "private-key-block",
665
+ "git-oauth-userinfo",
666
+ "url-credentials",
667
+ "bearer-token",
668
+ "slack-webhook",
669
+ "assignment",
670
+ "credential-flag",
671
+ "cookie-session-assignment",
672
+ "authorization-header",
673
+ "bearer-or-basic",
674
+ "password-flag",
675
+ "sshpass-password",
676
+ "user-flag",
677
+ "header-pair",
678
+ "command-password-flag",
679
+ "url-userinfo",
680
+ "signed-query",
681
+ "short-password-flag",
682
+ "attached-password-flag"
683
+ ]);
684
+ const builtinShapes = [...defaultRules, ...diagnosticRules].map((rule) => ({ shape: ruleShape(rule), rewrite: rule.rewrite }));
685
+ const contextualShapes = [...defaultRules, ...diagnosticRules].filter((rule) => contextualIds.has(rule.id)).map((rule) => ({ shape: ruleShape(rule), rewrite: rule.rewrite }));
686
+ const isContextualRule = (rule) => {
687
+ const shape = ruleShape(rule);
688
+ return contextualShapes.some((known) => known.rewrite === rule.rewrite && known.shape === shape);
689
+ };
690
+ const isBuiltinRule = (rule) => {
691
+ const shape = ruleShape(rule);
692
+ return builtinShapes.some((known) => known.rewrite === rule.rewrite && known.shape === shape);
693
+ };
694
+ const hasContextBarrier = (rules, index) => {
695
+ const following = rules.slice(index + 1);
696
+ const barrier = following.findIndex((rule) => !isBuiltinRule(rule));
697
+ return barrier !== -1 && following.slice(barrier + 1).some(isContextualRule);
698
+ };
699
+ const redactSmithersContexts = (value, rule, rules, index, onProtected) => {
700
+ if (rule.pattern.source === defaultRules[0].pattern.source && rule.pattern.flags === defaultRules[0].pattern.flags && value.includes("-----BEGIN") && privateKeyBlock.test(value) && smithersShapes.some(
701
+ (known2) => known2.pattern.test(value) && rules.some((selected) => known2.rewrite === selected.rewrite && known2.shape === ruleShape(selected))
702
+ )) {
703
+ onProtected?.(value, index, true);
704
+ return placeholder;
705
+ }
706
+ if (!rule.id.startsWith("smithers-")) return value;
707
+ const shape = ruleShape(rule);
708
+ const known = smithersShapes.find((known2) => known2.rewrite === rule.rewrite && known2.shape === shape);
709
+ if (known === void 0 || !known.pattern.test(value)) return value;
710
+ const pem = privateKeyBlock.test(value);
711
+ onProtected?.(value, index, pem);
712
+ if (pem) return placeholder;
713
+ const following = rules.slice(index + 1);
714
+ if (hasContextBarrier(rules, index)) return placeholder;
715
+ const contextual = following.filter(isContextualRule).reduce(applyRule, value);
716
+ return contextual === value ? value : placeholder;
717
+ };
625
718
  const redactDiagnostic = (value) => redact(value, { rules: diagnosticRules, onTooDeep: "name" });
626
719
  const sensitiveKeySuffixes = [
627
720
  "auth",
@@ -683,13 +776,17 @@ const candidate = (pattern) => {
683
776
  };
684
777
  const candidates = /* @__PURE__ */ new WeakMap();
685
778
  const applyRule = (text, rule) => {
779
+ if (rule.id === "url-credentials" && rule.pattern.source === urlCredentialsSource && (!text.includes("://") || !text.includes("@"))) return text;
686
780
  if (candidate(rule.pattern)?.test(text) === false) return text;
687
781
  return rule.rewrite === void 0 ? text.replace(rule.pattern, rule.replace ?? placeholder) : rule.rewrite(text);
688
782
  };
689
- const redactString = (value, rules) => {
783
+ const redactString = (value, rules, onProtected) => {
690
784
  let text = value;
691
785
  for (let pass = 0; pass < fixedPointPasses; pass++) {
692
- const next = rules.reduce(applyRule, text);
786
+ const next = rules.reduce(
787
+ (text2, rule, index) => applyRule(redactSmithersContexts(text2, rule, rules, index, onProtected), rule),
788
+ text
789
+ );
693
790
  if (next === text) return text;
694
791
  text = next;
695
792
  }
@@ -748,7 +845,8 @@ const binaryMarker = "[Binary]";
748
845
  const functionMarker = "[Function]";
749
846
  const symbolMarker = "[Symbol]";
750
847
  const depthMarker = "[Deep]";
751
- const redact = (value, options) => {
848
+ const redact = (value, options) => redactWithErrors(value, options);
849
+ const redactWithErrors = (value, options, onError) => {
752
850
  const onTooDeep = options?.onTooDeep ?? "throw";
753
851
  const rules = globalRules(options?.rules ?? defaultRules);
754
852
  const binary = (node, ancestors, depth) => {
@@ -768,7 +866,7 @@ const redact = (value, options) => {
768
866
  }
769
867
  return Object.fromEntries(entries);
770
868
  };
771
- const walk = (node, ancestors, depth, key) => {
869
+ const walk = (node, ancestors, depth, key, skipToJSON = false) => {
772
870
  if (depth > maxDepth) {
773
871
  if (onTooDeep === "name") return depthMarker;
774
872
  throw new RedactionDepthError({
@@ -781,12 +879,21 @@ const redact = (value, options) => {
781
879
  if (typeof node === "function") return functionMarker;
782
880
  if (typeof node === "symbol") return symbolMarker;
783
881
  if (node === null || typeof node !== "object") return node;
882
+ if (onError !== void 0 && node instanceof Error) {
883
+ return onError(node, (value2) => walk(value2, ancestors, depth + 1, ""), depth);
884
+ }
784
885
  if (isBinary(node)) return binary(node, ancestors, depth);
785
886
  if (ancestors.has(node)) return "[Circular]";
786
887
  ancestors.add(node);
787
888
  try {
788
- const toJSON = node.toJSON;
789
- if (typeof toJSON === "function") return walk(toJSON.call(node, key), ancestors, depth, key);
889
+ if (!skipToJSON) {
890
+ const toJSON = node.toJSON;
891
+ if (typeof toJSON === "function") {
892
+ const replacement = toJSON.call(node, key);
893
+ if (replacement === node) ancestors.delete(node);
894
+ return walk(replacement, ancestors, depth + 1, key, true);
895
+ }
896
+ }
790
897
  if (Array.isArray(node)) {
791
898
  const length = node.length;
792
899
  const result = new Array(length);
@@ -824,7 +931,9 @@ const redact = (value, options) => {
824
931
  };
825
932
  return walk(value, /* @__PURE__ */ new WeakSet(), 0, "");
826
933
  };
827
- const make = (options) => (value) => redact(value, options);
934
+ const make = (options) => Object.assign((value) => redact(value, options), {
935
+ withErrors: (value, onError) => redactWithErrors(value, options, onError)
936
+ });
828
937
  const redactJsonString = (json, redactor) => {
829
938
  const decoded = Schema.decodeUnknownResult(UnknownFromJsonString)(json);
830
939
  if (Result.isFailure(decoded)) return json;
@@ -881,6 +990,27 @@ const lineRedactor = (rules = diagnosticRules) => {
881
990
  carry = seen.slice(-64);
882
991
  };
883
992
  const redacted = (text) => redactString(text, globalRules(rules));
993
+ const hasOpenValue = (text) => {
994
+ const selected = globalRules(rules);
995
+ const protectedValues = [];
996
+ let ambiguous = false;
997
+ redactString(text, selected, (value, index, pem) => {
998
+ protectedValues.push({ value, pem });
999
+ if (hasContextBarrier(selected, index)) ambiguous = true;
1000
+ });
1001
+ if (ambiguous) return true;
1002
+ const probeRules = selected.filter((rule) => !isSmithersRule(rule));
1003
+ if (!redactString(text + continuationProbe, probeRules).endsWith(continuationProbe)) return true;
1004
+ const contexts = selected.filter(isContextualRule);
1005
+ for (const { value, pem } of protectedValues) {
1006
+ const probe = value + continuationProbe;
1007
+ if (pem && !redactString(probe, [defaultRules[0]]).endsWith(continuationProbe)) return true;
1008
+ for (const context of contexts) {
1009
+ if (!redactString(probe, [context]).endsWith(continuationProbe)) return true;
1010
+ }
1011
+ }
1012
+ return false;
1013
+ };
884
1014
  const release = () => {
885
1015
  const text = redacted(held.join("\n"));
886
1016
  const overlongBlock = heldOverlong;
@@ -929,7 +1059,7 @@ const lineRedactor = (rules = diagnosticRules) => {
929
1059
  held.push(text);
930
1060
  heldBytes += text.length + 1;
931
1061
  if (held.length <= eagerHeldLines || heldBytes >= askAt) {
932
- if (redacted(held.join("\n") + continuationProbe).endsWith(continuationProbe)) return release();
1062
+ if (!hasOpenValue(held.join("\n"))) return release();
933
1063
  askAt = heldBytes + (heldBytes >> 1);
934
1064
  }
935
1065
  if (held.length <= maxHeldLines && heldBytes <= maxHeldBytes) return [];