@smthrs/journal 0.0.0-stage → 1.0.0-rc.3
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.
- package/CHANGELOG.md +149 -0
- package/LICENSE +21 -0
- package/README.md +206 -2
- package/dist/cjs/CallFact.d.ts +129 -0
- package/dist/cjs/CallFact.d.ts.map +1 -0
- package/dist/cjs/CallFact.js +106 -0
- package/dist/cjs/CallFact.js.map +7 -0
- package/dist/cjs/Consensus.d.ts +440 -0
- package/dist/cjs/Consensus.d.ts.map +1 -0
- package/dist/cjs/Consensus.js +251 -0
- package/dist/cjs/Consensus.js.map +7 -0
- package/dist/cjs/EngineEvent.d.ts +890 -0
- package/dist/cjs/EngineEvent.d.ts.map +1 -0
- package/dist/cjs/EngineEvent.js +383 -0
- package/dist/cjs/EngineEvent.js.map +7 -0
- package/dist/cjs/ExecutionFact.d.ts +216 -0
- package/dist/cjs/ExecutionFact.d.ts.map +1 -0
- package/dist/cjs/ExecutionFact.js +303 -0
- package/dist/cjs/ExecutionFact.js.map +7 -0
- package/dist/cjs/Journal.d.ts +617 -0
- package/dist/cjs/Journal.d.ts.map +1 -0
- package/dist/cjs/Journal.js +190 -0
- package/dist/cjs/Journal.js.map +7 -0
- package/dist/cjs/JournalEvent.d.ts +421 -0
- package/dist/cjs/JournalEvent.d.ts.map +1 -0
- package/dist/cjs/JournalEvent.js +281 -0
- package/dist/cjs/JournalEvent.js.map +7 -0
- package/dist/cjs/JournalGeneration.d.ts +34 -0
- package/dist/cjs/JournalGeneration.d.ts.map +1 -0
- package/dist/cjs/JournalGeneration.js +72 -0
- package/dist/cjs/JournalGeneration.js.map +7 -0
- package/dist/cjs/JournalMetrics.d.ts +72 -0
- package/dist/cjs/JournalMetrics.d.ts.map +1 -0
- package/dist/cjs/JournalMetrics.js +55 -0
- package/dist/cjs/JournalMetrics.js.map +7 -0
- package/dist/cjs/Migrations.d.ts +42 -0
- package/dist/cjs/Migrations.d.ts.map +1 -0
- package/dist/cjs/Migrations.js +58 -0
- package/dist/cjs/Migrations.js.map +7 -0
- package/dist/cjs/OwnerId.d.ts +40 -0
- package/dist/cjs/OwnerId.d.ts.map +1 -0
- package/dist/cjs/OwnerId.js +40 -0
- package/dist/cjs/OwnerId.js.map +7 -0
- package/dist/cjs/Projection.d.ts +29 -0
- package/dist/cjs/Projection.d.ts.map +1 -0
- package/dist/cjs/Projection.js +25 -0
- package/dist/cjs/Projection.js.map +7 -0
- package/dist/cjs/RedactedLogger.d.ts +121 -0
- package/dist/cjs/RedactedLogger.d.ts.map +1 -0
- package/dist/cjs/RedactedLogger.js +235 -0
- package/dist/cjs/RedactedLogger.js.map +7 -0
- package/dist/cjs/Redaction.d.ts +350 -0
- package/dist/cjs/Redaction.d.ts.map +1 -0
- package/dist/cjs/Redaction.js +928 -0
- package/dist/cjs/Redaction.js.map +7 -0
- package/dist/cjs/SqlConsensus.d.ts +44 -0
- package/dist/cjs/SqlConsensus.d.ts.map +1 -0
- package/dist/cjs/SqlConsensus.js +243 -0
- package/dist/cjs/SqlConsensus.js.map +7 -0
- package/dist/cjs/SqlJournal.d.ts +173 -0
- package/dist/cjs/SqlJournal.d.ts.map +1 -0
- package/dist/cjs/SqlJournal.js +1568 -0
- package/dist/cjs/SqlJournal.js.map +7 -0
- package/dist/cjs/StepFact.d.ts +66 -0
- package/dist/cjs/StepFact.d.ts.map +1 -0
- package/dist/cjs/StepFact.js +68 -0
- package/dist/cjs/StepFact.js.map +7 -0
- package/dist/cjs/index.d.ts +95 -0
- package/dist/cjs/index.d.ts.map +1 -0
- package/dist/cjs/index.js +63 -0
- package/dist/cjs/index.js.map +7 -0
- package/dist/cjs/internal/JournalInternalFault.d.ts +37 -0
- package/dist/cjs/internal/JournalInternalFault.d.ts.map +1 -0
- package/dist/cjs/internal/JournalInternalFault.js +43 -0
- package/dist/cjs/internal/JournalInternalFault.js.map +7 -0
- package/dist/cjs/migrations/0001_initial.d.ts +15 -0
- package/dist/cjs/migrations/0001_initial.d.ts.map +1 -0
- package/dist/cjs/migrations/0001_initial.js +54 -0
- package/dist/cjs/migrations/0001_initial.js.map +7 -0
- package/dist/cjs/migrations/0002_checkpoints.d.ts +27 -0
- package/dist/cjs/migrations/0002_checkpoints.d.ts.map +1 -0
- package/dist/cjs/migrations/0002_checkpoints.js +48 -0
- package/dist/cjs/migrations/0002_checkpoints.js.map +7 -0
- package/dist/cjs/migrations/0003_startup_index.d.ts +15 -0
- package/dist/cjs/migrations/0003_startup_index.d.ts.map +1 -0
- package/dist/cjs/migrations/0003_startup_index.js +40 -0
- package/dist/cjs/migrations/0003_startup_index.js.map +7 -0
- package/dist/cjs/migrations/0004_dedup.d.ts +15 -0
- package/dist/cjs/migrations/0004_dedup.d.ts.map +1 -0
- package/dist/cjs/migrations/0004_dedup.js +57 -0
- package/dist/cjs/migrations/0004_dedup.js.map +7 -0
- package/dist/cjs/migrations/0005_run_event_type.d.ts +15 -0
- package/dist/cjs/migrations/0005_run_event_type.d.ts.map +1 -0
- package/dist/cjs/migrations/0005_run_event_type.js +40 -0
- package/dist/cjs/migrations/0005_run_event_type.js.map +7 -0
- package/dist/cjs/migrations/0006_consensus.d.ts +22 -0
- package/dist/cjs/migrations/0006_consensus.d.ts.map +1 -0
- package/dist/cjs/migrations/0006_consensus.js +84 -0
- package/dist/cjs/migrations/0006_consensus.js.map +7 -0
- package/dist/cjs/package.json +1 -0
- package/dist/cjs/test/Notifying.d.ts +65 -0
- package/dist/cjs/test/Notifying.d.ts.map +1 -0
- package/dist/cjs/test/Notifying.js +62 -0
- package/dist/cjs/test/Notifying.js.map +7 -0
- package/dist/cjs/test/TestJournal.d.ts +43 -0
- package/dist/cjs/test/TestJournal.d.ts.map +1 -0
- package/dist/cjs/test/TestJournal.js +43 -0
- package/dist/cjs/test/TestJournal.js.map +7 -0
- package/dist/esm/CallFact.d.ts +129 -0
- package/dist/esm/CallFact.d.ts.map +1 -0
- package/dist/esm/CallFact.js +96 -0
- package/dist/esm/CallFact.js.map +1 -0
- package/dist/esm/Consensus.d.ts +440 -0
- package/dist/esm/Consensus.d.ts.map +1 -0
- package/dist/esm/Consensus.js +454 -0
- package/dist/esm/Consensus.js.map +1 -0
- package/dist/esm/EngineEvent.d.ts +890 -0
- package/dist/esm/EngineEvent.d.ts.map +1 -0
- package/dist/esm/EngineEvent.js +614 -0
- package/dist/esm/EngineEvent.js.map +1 -0
- package/dist/esm/ExecutionFact.d.ts +216 -0
- package/dist/esm/ExecutionFact.d.ts.map +1 -0
- package/dist/esm/ExecutionFact.js +374 -0
- package/dist/esm/ExecutionFact.js.map +1 -0
- package/dist/esm/Journal.d.ts +617 -0
- package/dist/esm/Journal.d.ts.map +1 -0
- package/dist/esm/Journal.js +323 -0
- package/dist/esm/Journal.js.map +1 -0
- package/dist/esm/JournalEvent.d.ts +421 -0
- package/dist/esm/JournalEvent.d.ts.map +1 -0
- package/dist/esm/JournalEvent.js +517 -0
- package/dist/esm/JournalEvent.js.map +1 -0
- package/dist/esm/JournalGeneration.d.ts +34 -0
- package/dist/esm/JournalGeneration.d.ts.map +1 -0
- package/dist/esm/JournalGeneration.js +65 -0
- package/dist/esm/JournalGeneration.js.map +1 -0
- package/dist/esm/JournalMetrics.d.ts +72 -0
- package/dist/esm/JournalMetrics.d.ts.map +1 -0
- package/dist/esm/JournalMetrics.js +79 -0
- package/dist/esm/JournalMetrics.js.map +1 -0
- package/dist/esm/Migrations.d.ts +42 -0
- package/dist/esm/Migrations.d.ts.map +1 -0
- package/dist/esm/Migrations.js +59 -0
- package/dist/esm/Migrations.js.map +1 -0
- package/dist/esm/OwnerId.d.ts +40 -0
- package/dist/esm/OwnerId.d.ts.map +1 -0
- package/dist/esm/OwnerId.js +33 -0
- package/dist/esm/OwnerId.js.map +1 -0
- package/dist/esm/Projection.d.ts +29 -0
- package/dist/esm/Projection.d.ts.map +1 -0
- package/dist/esm/Projection.js +13 -0
- package/dist/esm/Projection.js.map +1 -0
- package/dist/esm/RedactedLogger.d.ts +121 -0
- package/dist/esm/RedactedLogger.d.ts.map +1 -0
- package/dist/esm/RedactedLogger.js +445 -0
- package/dist/esm/RedactedLogger.js.map +1 -0
- package/dist/esm/Redaction.d.ts +350 -0
- package/dist/esm/Redaction.d.ts.map +1 -0
- package/dist/esm/Redaction.js +1584 -0
- package/dist/esm/Redaction.js.map +1 -0
- package/dist/esm/SqlConsensus.d.ts +44 -0
- package/dist/esm/SqlConsensus.d.ts.map +1 -0
- package/dist/esm/SqlConsensus.js +252 -0
- package/dist/esm/SqlConsensus.js.map +1 -0
- package/dist/esm/SqlJournal.d.ts +173 -0
- package/dist/esm/SqlJournal.d.ts.map +1 -0
- package/dist/esm/SqlJournal.js +1858 -0
- package/dist/esm/SqlJournal.js.map +1 -0
- package/dist/esm/StepFact.d.ts +66 -0
- package/dist/esm/StepFact.d.ts.map +1 -0
- package/dist/esm/StepFact.js +50 -0
- package/dist/esm/StepFact.js.map +1 -0
- package/dist/esm/index.d.ts +95 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +95 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/internal/JournalInternalFault.d.ts +37 -0
- package/dist/esm/internal/JournalInternalFault.d.ts.map +1 -0
- package/dist/esm/internal/JournalInternalFault.js +28 -0
- package/dist/esm/internal/JournalInternalFault.js.map +1 -0
- package/dist/esm/migrations/0001_initial.d.ts +15 -0
- package/dist/esm/migrations/0001_initial.d.ts.map +1 -0
- package/dist/esm/migrations/0001_initial.js +32 -0
- package/dist/esm/migrations/0001_initial.js.map +1 -0
- package/dist/esm/migrations/0002_checkpoints.d.ts +27 -0
- package/dist/esm/migrations/0002_checkpoints.d.ts.map +1 -0
- package/dist/esm/migrations/0002_checkpoints.js +38 -0
- package/dist/esm/migrations/0002_checkpoints.js.map +1 -0
- package/dist/esm/migrations/0003_startup_index.d.ts +15 -0
- package/dist/esm/migrations/0003_startup_index.d.ts.map +1 -0
- package/dist/esm/migrations/0003_startup_index.js +18 -0
- package/dist/esm/migrations/0003_startup_index.js.map +1 -0
- package/dist/esm/migrations/0004_dedup.d.ts +15 -0
- package/dist/esm/migrations/0004_dedup.d.ts.map +1 -0
- package/dist/esm/migrations/0004_dedup.js +38 -0
- package/dist/esm/migrations/0004_dedup.js.map +1 -0
- package/dist/esm/migrations/0005_run_event_type.d.ts +15 -0
- package/dist/esm/migrations/0005_run_event_type.d.ts.map +1 -0
- package/dist/esm/migrations/0005_run_event_type.js +18 -0
- package/dist/esm/migrations/0005_run_event_type.js.map +1 -0
- package/dist/esm/migrations/0006_consensus.d.ts +22 -0
- package/dist/esm/migrations/0006_consensus.d.ts.map +1 -0
- package/dist/esm/migrations/0006_consensus.js +69 -0
- package/dist/esm/migrations/0006_consensus.js.map +1 -0
- package/dist/esm/test/Notifying.d.ts +65 -0
- package/dist/esm/test/Notifying.d.ts.map +1 -0
- package/dist/esm/test/Notifying.js +62 -0
- package/dist/esm/test/Notifying.js.map +1 -0
- package/dist/esm/test/TestJournal.d.ts +43 -0
- package/dist/esm/test/TestJournal.d.ts.map +1 -0
- package/dist/esm/test/TestJournal.js +27 -0
- package/dist/esm/test/TestJournal.js.map +1 -0
- package/docs/README.md +164 -0
- package/docs/api.md +639 -0
- package/docs/concepts/compaction.md +157 -0
- package/docs/concepts/idempotency.md +127 -0
- package/docs/concepts/owner-fence.md +124 -0
- package/docs/concepts/redaction.md +218 -0
- package/docs/concepts/state-event-authority.md +159 -0
- package/docs/concepts/two-channels.md +167 -0
- package/docs/guides/commit-state-and-entry.md +114 -0
- package/docs/guides/compact-a-run.md +134 -0
- package/docs/guides/fold-a-projection.md +106 -0
- package/docs/guides/read-a-run.md +139 -0
- package/docs/guides/redact-log-output.md +94 -0
- package/docs/guides/testing.md +124 -0
- package/docs/guides/write-lifecycle-events.md +110 -0
- package/docs/installation.md +133 -0
- package/docs/quickstart.md +143 -0
- package/docs/troubleshooting.md +214 -0
- package/package.json +263 -3
- package/src/CallFact.ts +117 -0
- package/src/Consensus.ts +683 -0
- package/src/EngineEvent.ts +823 -0
- package/src/ExecutionFact.ts +433 -0
- package/src/Journal.ts +688 -0
- package/src/JournalEvent.ts +654 -0
- package/src/JournalGeneration.ts +77 -0
- package/src/JournalMetrics.ts +89 -0
- package/src/Migrations.ts +62 -0
- package/src/OwnerId.ts +42 -0
- package/src/Projection.ts +31 -0
- package/src/RedactedLogger.ts +483 -0
- package/src/Redaction.ts +1784 -0
- package/src/SqlConsensus.ts +344 -0
- package/src/SqlJournal.ts +2732 -0
- package/src/StepFact.ts +69 -0
- package/src/index.ts +109 -0
- package/src/internal/JournalInternalFault.ts +40 -0
- package/src/migrations/0001_initial.ts +41 -0
- package/src/migrations/0002_checkpoints.ts +46 -0
- package/src/migrations/0003_startup_index.ts +19 -0
- package/src/migrations/0004_dedup.ts +43 -0
- package/src/migrations/0005_run_event_type.ts +19 -0
- package/src/migrations/0006_consensus.ts +83 -0
- package/src/test/Notifying.ts +101 -0
- package/src/test/TestJournal.ts +52 -0
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/RedactedLogger.ts"],
|
|
4
|
+
"sourcesContent": ["/**\n * The redacting logger: the journal's redaction rules applied to log output.\n *\n * The journal redacts on the write path, so a credential a cell logs or\n * returns never reaches a committed row (`./Redaction.ts`). The operator's\n * terminal was the other place the same credential surfaces: every built-in\n * Effect logger renders through the fiber's `Console`, so an action that hands\n * a token to `Effect.logInfo` wrote it to stderr in full and it reached\n * whatever collected that stream.\n *\n * This module closes that half with the SAME rules rather than a second rule\n * set. {@link wrap} does not re-implement redaction and does not re-format a\n * log line. It redacts the log event itself \u2014 the message, the cause, and the\n * log annotations \u2014 before the wrapped logger is handed it, and it hands that\n * logger a view of the fiber whose `Console` is a redacting console, so\n * whatever the logger renders for itself \u2014 a pretty line, a JSON document \u2014\n * passes through `Redaction.redact` on its way to the stream as well.\n *\n * Both halves carry load. Most built-in loggers write through the fiber's\n * `Console`, which is what covers the pretty line, the `--json` document, and\n * the `.flows/logs/<runId>.log` stream. But a logger is free to read the event\n * instead of rendering it, and one in Effect's own default logger set does:\n * `Logger.tracerLogger` publishes the message as a span event name and\n * `Cause.pretty` of the cause as the span's `effect.cause` attribute, and\n * never reads `Console` at all. Redacting only the console would hide a\n * credential on stderr and export it in clear to whatever OTLP collector is\n * configured.\n *\n * Cost is bounded by the rules themselves: every alternation inside a\n * repetition in `Redaction.diagnosticRules` starts its branches with disjoint\n * characters, so each rule is linear in the length of the line and no input\n * backtracks catastrophically.\n *\n * One deliberate difference from the journal write path. `Redaction.redact`\n * rebuilds an object from its own enumerable entries, which is right for a row\n * that is about to be JSON-encoded and wrong for a terminal: an `Error` keeps\n * `message` and `stack` on non-enumerable properties, so rebuilding one prints\n * `{}` where the operator expected a failure. An `Error` is rebuilt as a plain\n * `Error` instead, carrying its name, message, stack and own members with the\n * rules applied. Its class is NOT preserved. A copy built on the original's\n * prototype inherits everything the prototype defines, an own-key walk sees\n * none of it, and each of `name`, `cause`, `toJSON`, `Symbol.toStringTag` and\n * `nodejs.util.inspect.custom` carried a credential out that way.\n *\n * @since 0.1.0\n */\n\nimport * as Cause from \"effect/Cause\"\nimport * as Console from \"effect/Console\"\nimport * as Context from \"effect/Context\"\nimport * as Effect from \"effect/Effect\"\nimport type * as Fiber from \"effect/Fiber\"\nimport * as Layer from \"effect/Layer\"\nimport * as Logger from \"effect/Logger\"\nimport * as References from \"effect/References\"\nimport * as Redaction from \"./Redaction.ts\"\n\n/**\n * Marks a logger this module already wrapped.\n *\n * Both the CLI and the durable runtime install {@link layer}, and a detached\n * `smithers run` is both at once. Wrapping twice would be correct but pay the\n * rules twice per line, so a wrapped logger is returned unchanged.\n *\n * @since 0.1.0\n * @category type ids\n */\nexport const TypeId: unique symbol = Symbol.for(\"@smthrs/journal/RedactedLogger\")\n\n/**\n * Whether {@link wrap} already wrapped this logger.\n *\n * @since 0.1.0\n * @category predicates\n */\nexport const isRedacted = (logger: Logger.Logger<any, any>): boolean => TypeId in logger\n\n/**\n * Console methods that write caller-supplied values, mapped to whether their\n * arguments carry log output.\n *\n * Only `clear` and `groupEnd` are marked `false`, because those two take no\n * arguments at all: there is nothing for the rules to read and binding them\n * straight through saves a copy per call. Every other method here, `count`,\n * `countReset`, `time`, and `timeEnd` included, accepts a caller-supplied\n * LABEL and prints it, so a label of `api_key=sk-\u2026` reached the terminal\n * through all four of them. `timeLog` already redacted its label, so the pair\n * `time` / `timeLog` also disagreed about what a timer is called; redacting all\n * of them is what makes a label match itself again.\n */\nconst consoleMethods = {\n assert: true,\n clear: false,\n count: true,\n countReset: true,\n debug: true,\n dir: true,\n dirxml: true,\n error: true,\n group: true,\n groupCollapsed: true,\n groupEnd: false,\n info: true,\n log: true,\n table: true,\n time: true,\n timeEnd: true,\n timeLog: true,\n trace: true,\n warn: true\n} as const\n\n/** How deep the logger walks a value before it names it instead. */\nconst renderDepthLimit = 200\n\n/** What the logger renders in place of a value nested past the depth limit. */\nconst renderDepthMarker = \"[Deep]\"\n\n/**\n * The parts of a log message.\n *\n * Effect's logging API passes an array, one entry per argument, including for\n * a single argument. A caller that builds `LogOptions` by hand may pass the\n * message itself, so it is wrapped rather than walked.\n *\n * @since 0.1.0\n * @category redaction\n */\nconst toArray = (message: unknown): ReadonlyArray<unknown> => Array.isArray(message) ? message : [message]\n\n/**\n * Reads one piece of text off `error` and runs it through the rules.\n *\n * Everything a renderer prints about an error is read here, once, and only the\n * redacted result crosses to the copy. A caller's error can define any of these\n * as an accessor that throws, and reading one happens while a log line is\n * rendering, so a refusal costs that piece of text and nothing else.\n */\nconst redactedText = (read: () => unknown, redactor: Redaction.Redactor, fallback: string): string => {\n try {\n return String(redactor(String(read())))\n } catch {\n return fallback\n }\n}\n\n/** `error.stack` through the rules, or `undefined` when it has none to give. */\nconst redactedStack = (error: Error, redactor: Redaction.Redactor): string | undefined => {\n try {\n const stack = error.stack\n // An `Error.stack` is optional. Under `exactOptionalPropertyTypes` an\n // assignment cannot carry the `undefined` a stackless error has, so the\n // copy defines the property instead of assigning it.\n return typeof stack === \"string\" ? String(redactor(stack)) : undefined\n } catch {\n return undefined\n }\n}\n\n/**\n * A member NAME with the rules applied, replaced outright when one fires.\n *\n * The treatment `Redaction.redact` gives an object key, for the same reason: a\n * name is text a renderer prints. Rewriting one in place would change what it\n * reads as and redaction would stop being a fixed point, so a name that matches\n * becomes the placeholder whole.\n */\nconst redactedName = (key: string, redactor: Redaction.Redactor): string => {\n const redacted = String(redactor(key))\n return redacted === key ? key : Redaction.placeholder\n}\n\n/**\n * Own names the copy never carries, because a renderer CALLS them.\n *\n * `name`, `message` and `stack` are defined from the rules above instead. The\n * rest are hooks: a redacted `toString` or `valueOf` would leave a string under\n * a name the language calls, and `String(error)` would then throw from inside\n * the renderer, which is the failure mode this module exists to avoid.\n */\nconst renderHooks: ReadonlySet<string> = new Set([\n \"constructor\",\n \"message\",\n \"name\",\n \"stack\",\n \"toJSON\",\n \"toString\",\n \"valueOf\"\n])\n\n/**\n * A copy of `error` carrying the same information with the rules applied.\n *\n * A PLAIN `Error`, never a copy built on the original's prototype. A prototype\n * is an unbounded leak surface and an own-key walk never looks at one: an\n * inherited `name`, `cause`, `toJSON`, `Symbol.toStringTag` or\n * `nodejs.util.inspect.custom` each carried a credential straight to an OTLP\n * span attribute or to the operator's terminal, one per review round, and a\n * getter anywhere on the chain is the same hole with a different name. So\n * nothing inherited crosses. Only redacted text does: the name, the message,\n * the stack, and the error's own members, each read once here and stored as\n * data, since a getter carried across unchanged would hand the unredacted\n * value to whatever reads it next.\n *\n * The copy is not an instance of the original's class, so a renderer that\n * special-cases `instanceof MyError` sees a plain `Error`. That is the fidelity\n * trade the release policy already records for every other value, and it is\n * the trade the same problem's earlier, crashing form was settled with: a copy\n * on a host prototype, such as the `DOMException` an `AbortSignal` carries as\n * its reason, is an impostor whose brand check throws from inside `Cause.pretty`\n * and kills the run the line was describing.\n */\nconst redactError = (\n error: Error,\n redactor: Redaction.Redactor,\n seen: WeakMap<Error, Error>,\n depth = 0\n): Error => {\n // The memo holds the COPY, not a visited mark: returning the original on a\n // repeat reference put the unredacted error back into the output, so a\n // diamond (two fields naming one error) leaked on its second field. The copy\n // is registered before its own members are walked, so a cycle terminates on\n // it and every reference to one error is the same redacted object.\n const memoized = seen.get(error)\n if (memoized !== undefined) return memoized\n const clone = new Error()\n seen.set(error, clone)\n const define = (key: string, value: unknown, enumerable: boolean): void => {\n Object.defineProperty(clone, key, { value, writable: true, enumerable, configurable: true })\n }\n define(\"name\", redactedText(() => error.name, redactor, \"Error\"), false)\n define(\"message\", redactedText(() => error.message, redactor, \"\"), false)\n define(\"stack\", redactedStack(error, redactor), false)\n // Own NAMES, not `Reflect.ownKeys`. A symbol key never crosses: its\n // description is text no walk can rewrite in place, and the three hooks with\n // no name to skip are symbols too, `Symbol.toPrimitive`,\n // `Symbol.toStringTag`, and `nodejs.util.inspect.custom`.\n for (const key of Object.getOwnPropertyNames(error)) {\n if (renderHooks.has(key)) continue\n const descriptor = Object.getOwnPropertyDescriptor(error, key)!\n const value = \"value\" in descriptor\n ? descriptor.value\n : (error as unknown as Record<PropertyKey, unknown>)[key]\n define(\n redactedName(key, redactor),\n // A credential-named member is replaced wholesale, the way the journal's\n // own walk replaces one, so both halves of the one rule set answer alike.\n Redaction.isSensitiveKey(key)\n ? Redaction.placeholder\n // The depth cap binds under an Error exactly as it does beside one: a\n // deep value carried on a cause can exhaust the stack just as easily.\n : depth + 1 >= renderDepthLimit\n ? renderDepthMarker\n : value instanceof Error\n ? redactError(value, redactor, seen, depth + 1)\n : redactor(value),\n descriptor.enumerable === true\n )\n }\n return clone\n}\n\n/**\n * Redacts one value on its way out of the logger.\n *\n * An `Error` is rebuilt as a plain `Error` whose name, message, stack and own\n * members are redacted, so a renderer that special-cases an `Error` still gets\n * one. Everything else goes through the journal's own rules, which rebuild a\n * value from its plain data: a `Date`, a `Map`, a class instance or a host\n * object therefore reaches the operator in that plain form rather than as\n * itself.\n *\n * That collapse is deliberate, and it now covers the `Error` too. An earlier\n * version rebuilt each value on its own prototype to keep the rendering\n * faithful. Three rounds of review found three ways that could kill the run it\n * was logging, because a host class keeps state a property walk cannot see and\n * a copy of one throws the moment a brand check reads it, and four more found\n * that the prototype an `Error` copy kept was itself the leak: everything it\n * defines is read by a renderer and seen by no own-key walk. A log line is not\n * worth a run, and the rendering it buys is cosmetic.\n *\n * @since 0.1.0\n * @category redaction\n */\nexport const redactArgument = (value: unknown, redactor: Redaction.Redactor): unknown => {\n try {\n return value instanceof Error ? redactError(value, redactor, new WeakMap()) : redactor(value)\n } catch {\n // A logged value is arbitrary and a throw here happens while the line is\n // rendering, which would kill the run the line describes. The marker is\n // deliberately NOT derived from the value: an earlier fallback rendered\n // the value to text and printed it, and that text had never been through\n // the rules, so a credential reached the terminal in clear.\n return unrenderableMarker\n }\n}\n\n/** What the logger renders in place of a value that cannot be rendered. */\nconst unrenderableMarker = \"[Unrenderable]\"\n\n/**\n * A console that runs every value it is handed through `redactor` and then\n * delegates to `target`.\n *\n * @since 0.1.0\n * @category constructors\n */\nexport const redactingConsole = (target: Console.Console, redactor: Redaction.Redactor): Console.Console => {\n const methods = target as unknown as Record<string, (...args: ReadonlyArray<any>) => unknown>\n const view: Record<string, unknown> = {}\n for (const [name, redacts] of Object.entries(consoleMethods)) {\n const method = methods[name]!.bind(target)\n view[name] = redacts\n ? (...args: ReadonlyArray<unknown>) => {\n const redacted = args.map((value) => redactArgument(value, redactor))\n try {\n return method(...redacted)\n } catch {\n // The delegate refused what we handed it. Retry with markers, never\n // with a rendering of the values: a rendering has not been through\n // the rules, and printing one is how a credential reached the\n // terminal before. A delegate that refuses the markers too is out of\n // options, and a log line is not worth the run.\n try {\n return method(...redacted.map(() => unrenderableMarker))\n } catch {\n return undefined\n }\n }\n }\n : method\n }\n return view as unknown as Console.Console\n}\n\n/**\n * A view of `fiber` whose console redacts and whose log annotations are\n * already redacted.\n *\n * The view inherits from the fiber itself, so `id`, `currentSpan`, and every\n * other member a logger reads answer exactly as before; only the two\n * references a logger renders from are substituted.\n */\nconst redactedFiber = (\n fiber: Fiber.Fiber<unknown, unknown>,\n redactor: Redaction.Redactor\n): Fiber.Fiber<unknown, unknown> => {\n const view = Object.create(fiber) as Fiber.Fiber<unknown, unknown>\n Object.defineProperty(view, \"getRef\", {\n value: <X>(reference: Context.Reference<X>): X => {\n const current = fiber.getRef(reference)\n if (reference === (Console.Console as unknown as Context.Reference<X>)) {\n return redactingConsole(current as Console.Console, redactor) as X\n }\n if (reference === (References.CurrentLogAnnotations as unknown as Context.Reference<X>)) {\n // The same treatment a message part gets, so one log event obeys one\n // rule and an annotated Error is redacted like a logged one.\n return redactArgument(current, redactor) as X\n }\n return current\n }\n })\n return view\n}\n\n/**\n * Rebuilds the frame chain as redacted data. Evaluate the lazy stack here:\n * carrying its original function would defer the credential past the boundary.\n * The same depth cap as logged values also bounds cyclic parent chains.\n */\nconst redactedFrame = (\n frame: References.StackFrame | undefined,\n redactor: Redaction.Redactor,\n depth = 0\n): References.StackFrame | undefined => {\n if (frame === undefined) return undefined\n if (depth >= renderDepthLimit) {\n return { name: renderDepthMarker, stack: () => undefined, parent: undefined }\n }\n const stack = redactedText(() => frame.stack() ?? \"\", redactor, unrenderableMarker)\n return {\n name: redactedText(() => frame.name, redactor, unrenderableMarker),\n stack: () => stack,\n parent: redactedFrame(frame.parent, redactor, depth + 1)\n }\n}\n\n/**\n * The log event's cause with the rules applied to failures, defects and stack\n * annotations. `Cause.pretty` renders these frames after rendering the error;\n * the tracer exports that text without passing through the redacting console.\n * Interruptions also carry both their own and the interruptor's frame chains.\n * Rebuild reasons and annotation maps so the original cause stays untouched.\n */\nconst redactedCause = (\n cause: Cause.Cause<unknown>,\n redactor: Redaction.Redactor\n): Cause.Cause<unknown> => {\n if (cause.reasons.length === 0) return cause\n return Cause.fromReasons(cause.reasons.map((reason) => {\n const annotations = new Map(reason.annotations)\n for (const key of [Cause.StackTrace.key, Cause.InterruptorStackTrace.key]) {\n if (annotations.has(key)) {\n annotations.set(key, redactedFrame(annotations.get(key) as References.StackFrame | undefined, redactor))\n }\n }\n const copy = reason._tag === \"Fail\"\n ? Cause.makeFailReason(redactArgument(reason.error, redactor))\n : reason._tag === \"Die\"\n ? Cause.makeDieReason(redactArgument(reason.defect, redactor))\n : Cause.makeInterruptReason(reason.fiberId)\n return copy.annotate(Context.makeUnsafe(annotations))\n }))\n}\n\n/**\n * Returns `logger` with the journal's redaction rules over everything it\n * renders. A logger this module already wrapped is returned unchanged.\n *\n * @since 0.1.0\n * @category combinators\n */\nexport const wrap = <Message, Output>(\n logger: Logger.Logger<Message, Output>,\n options?: Redaction.Options\n): Logger.Logger<Message, Output> => {\n if (isRedacted(logger)) return logger\n // A logger NAMES a too-deep value rather than throwing: a throw is caught one\n // frame up and costs the operator every argument on the line, not just the\n // deep one. A log line is a diagnostic, so it takes the diagnostic rules. A\n // caller passing its own `onTooDeep` or `rules` still wins.\n const redactor = Redaction.make({ onTooDeep: \"name\", rules: Redaction.diagnosticRules, ...options })\n const wrapped = Logger.make<Message, Output>((logOptions) =>\n logger.log({\n ...logOptions,\n // The message is redacted here, not only behind the fiber's Console,\n // because a logger is free to read it directly: `Logger.tracerLogger`\n // ships in Effect's default set and publishes the message as a span\n // event name, so a Console-only substitution would export a credential\n // in clear to whatever collector is configured.\n //\n // Effect delivers the message as an array of parts, one per argument,\n // including the single-argument case; a non-array reaches here only from\n // a caller that builds `LogOptions` by hand, and `toArray` covers it\n // without a branch no test could reach through the logging API.\n message: (toArray(logOptions.message).map((part) => redactArgument(part, redactor))) as Message,\n // The cause travels the same way and for the same reason. A failure is\n // logged as a `Cause`, not as message parts (`Effect.logError(cause)`\n // moves it out of the arguments), and `Logger.tracerLogger` renders it\n // itself into the span's `effect.cause` attribute without going near the\n // console, so an error message carrying a token would leave the process\n // in clear.\n cause: redactedCause(logOptions.cause, redactor),\n fiber: redactedFiber(logOptions.fiber, redactor)\n })\n )\n Object.defineProperty(wrapped, TypeId, { value: true })\n return wrapped\n}\n\n/**\n * Replaces the active logger set with redacting wrappers of the same loggers.\n *\n * It composes over whatever loggers are already installed rather than\n * choosing one, so an operator keeps the FORMAT they had, meaning their own\n * logger and its layout, though a value inside a line is rendered from its\n * redacted plain data rather than as its own class, and a host that\n * installed its own logger keeps it too.\n *\n * @since 0.1.0\n * @category layers\n */\nexport const layer = (options?: Redaction.Options): Layer.Layer<never> =>\n Layer.effect(\n Logger.CurrentLoggers,\n Effect.withFiber((fiber) =>\n Effect.sync(() => {\n const wrapped = new Set<Logger.Logger<unknown, any>>()\n for (const logger of fiber.getRef(Logger.CurrentLoggers)) wrapped.add(wrap(logger, options))\n return wrapped\n })\n )\n )\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA+CA,YAAuB;AACvB,cAAyB;AACzB,cAAyB;AACzB,aAAwB;AAExB,YAAuB;AACvB,aAAwB;AACxB,iBAA4B;AAC5B,gBAA2B;AAYpB,MAAM,SAAwB,uBAAO,IAAI,gCAAgC;AAQzE,MAAM,aAAa,CAAC,WAA6C,UAAU;AAelF,MAAM,iBAAiB;AAAA,EACrB,QAAQ;AAAA,EACR,OAAO;AAAA,EACP,OAAO;AAAA,EACP,YAAY;AAAA,EACZ,OAAO;AAAA,EACP,KAAK;AAAA,EACL,QAAQ;AAAA,EACR,OAAO;AAAA,EACP,OAAO;AAAA,EACP,gBAAgB;AAAA,EAChB,UAAU;AAAA,EACV,MAAM;AAAA,EACN,KAAK;AAAA,EACL,OAAO;AAAA,EACP,MAAM;AAAA,EACN,SAAS;AAAA,EACT,SAAS;AAAA,EACT,OAAO;AAAA,EACP,MAAM;AACR;AAGA,MAAM,mBAAmB;AAGzB,MAAM,oBAAoB;AAY1B,MAAM,UAAU,CAAC,YAA6C,MAAM,QAAQ,OAAO,IAAI,UAAU,CAAC,OAAO;AAUzG,MAAM,eAAe,CAAC,MAAqB,UAA8B,aAA6B;AACpG,MAAI;AACF,WAAO,OAAO,SAAS,OAAO,KAAK,CAAC,CAAC,CAAC;AAAA,EACxC,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAGA,MAAM,gBAAgB,CAAC,OAAc,aAAqD;AACxF,MAAI;AACF,UAAM,QAAQ,MAAM;AAIpB,WAAO,OAAO,UAAU,WAAW,OAAO,SAAS,KAAK,CAAC,IAAI;AAAA,EAC/D,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAUA,MAAM,eAAe,CAAC,KAAa,aAAyC;AAC1E,QAAM,WAAW,OAAO,SAAS,GAAG,CAAC;AACrC,SAAO,aAAa,MAAM,MAAM,UAAU;AAC5C;AAUA,MAAM,cAAmC,oBAAI,IAAI;AAAA,EAC/C;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAwBD,MAAM,cAAc,CAClB,OACA,UACA,MACA,QAAQ,MACE;AAMV,QAAM,WAAW,KAAK,IAAI,KAAK;AAC/B,MAAI,aAAa,OAAW,QAAO;AACnC,QAAM,QAAQ,IAAI,MAAM;AACxB,OAAK,IAAI,OAAO,KAAK;AACrB,QAAM,SAAS,CAAC,KAAa,OAAgB,eAA8B;AACzE,WAAO,eAAe,OAAO,KAAK,EAAE,OAAO,UAAU,MAAM,YAAY,cAAc,KAAK,CAAC;AAAA,EAC7F;AACA,SAAO,QAAQ,aAAa,MAAM,MAAM,MAAM,UAAU,OAAO,GAAG,KAAK;AACvE,SAAO,WAAW,aAAa,MAAM,MAAM,SAAS,UAAU,EAAE,GAAG,KAAK;AACxE,SAAO,SAAS,cAAc,OAAO,QAAQ,GAAG,KAAK;AAKrD,aAAW,OAAO,OAAO,oBAAoB,KAAK,GAAG;AACnD,QAAI,YAAY,IAAI,GAAG,EAAG;AAC1B,UAAM,aAAa,OAAO,yBAAyB,OAAO,GAAG;AAC7D,UAAM,QAAQ,WAAW,aACrB,WAAW,QACV,MAAkD,GAAG;AAC1D;AAAA,MACE,aAAa,KAAK,QAAQ;AAAA;AAAA;AAAA,MAG1B,UAAU,eAAe,GAAG,IACxB,UAAU,cAGV,QAAQ,KAAK,mBACb,oBACA,iBAAiB,QACjB,YAAY,OAAO,UAAU,MAAM,QAAQ,CAAC,IAC5C,SAAS,KAAK;AAAA,MAClB,WAAW,eAAe;AAAA,IAC5B;AAAA,EACF;AACA,SAAO;AACT;AAwBO,MAAM,iBAAiB,CAAC,OAAgB,aAA0C;AACvF,MAAI;AACF,WAAO,iBAAiB,QAAQ,YAAY,OAAO,UAAU,oBAAI,QAAQ,CAAC,IAAI,SAAS,KAAK;AAAA,EAC9F,QAAQ;AAMN,WAAO;AAAA,EACT;AACF;AAGA,MAAM,qBAAqB;AASpB,MAAM,mBAAmB,CAAC,QAAyB,aAAkD;AAC1G,QAAM,UAAU;AAChB,QAAM,OAAgC,CAAC;AACvC,aAAW,CAAC,MAAM,OAAO,KAAK,OAAO,QAAQ,cAAc,GAAG;AAC5D,UAAM,SAAS,QAAQ,IAAI,EAAG,KAAK,MAAM;AACzC,SAAK,IAAI,IAAI,UACT,IAAI,SAAiC;AACrC,YAAM,WAAW,KAAK,IAAI,CAAC,UAAU,eAAe,OAAO,QAAQ,CAAC;AACpE,UAAI;AACF,eAAO,OAAO,GAAG,QAAQ;AAAA,MAC3B,QAAQ;AAMN,YAAI;AACF,iBAAO,OAAO,GAAG,SAAS,IAAI,MAAM,kBAAkB,CAAC;AAAA,QACzD,QAAQ;AACN,iBAAO;AAAA,QACT;AAAA,MACF;AAAA,IACF,IACE;AAAA,EACN;AACA,SAAO;AACT;AAUA,MAAM,gBAAgB,CACpB,OACA,aACkC;AAClC,QAAM,OAAO,OAAO,OAAO,KAAK;AAChC,SAAO,eAAe,MAAM,UAAU;AAAA,IACpC,OAAO,CAAI,cAAuC;AAChD,YAAM,UAAU,MAAM,OAAO,SAAS;AACtC,UAAI,cAAe,QAAQ,SAA6C;AACtE,eAAO,iBAAiB,SAA4B,QAAQ;AAAA,MAC9D;AACA,UAAI,cAAe,WAAW,uBAA2D;AAGvF,eAAO,eAAe,SAAS,QAAQ;AAAA,MACzC;AACA,aAAO;AAAA,IACT;AAAA,EACF,CAAC;AACD,SAAO;AACT;AAOA,MAAM,gBAAgB,CACpB,OACA,UACA,QAAQ,MAC8B;AACtC,MAAI,UAAU,OAAW,QAAO;AAChC,MAAI,SAAS,kBAAkB;AAC7B,WAAO,EAAE,MAAM,mBAAmB,OAAO,MAAM,QAAW,QAAQ,OAAU;AAAA,EAC9E;AACA,QAAM,QAAQ,aAAa,MAAM,MAAM,MAAM,KAAK,IAAI,UAAU,kBAAkB;AAClF,SAAO;AAAA,IACL,MAAM,aAAa,MAAM,MAAM,MAAM,UAAU,kBAAkB;AAAA,IACjE,OAAO,MAAM;AAAA,IACb,QAAQ,cAAc,MAAM,QAAQ,UAAU,QAAQ,CAAC;AAAA,EACzD;AACF;AASA,MAAM,gBAAgB,CACpB,OACA,aACyB;AACzB,MAAI,MAAM,QAAQ,WAAW,EAAG,QAAO;AACvC,SAAO,MAAM,YAAY,MAAM,QAAQ,IAAI,CAAC,WAAW;AACrD,UAAM,cAAc,IAAI,IAAI,OAAO,WAAW;AAC9C,eAAW,OAAO,CAAC,MAAM,WAAW,KAAK,MAAM,sBAAsB,GAAG,GAAG;AACzE,UAAI,YAAY,IAAI,GAAG,GAAG;AACxB,oBAAY,IAAI,KAAK,cAAc,YAAY,IAAI,GAAG,GAAwC,QAAQ,CAAC;AAAA,MACzG;AAAA,IACF;AACA,UAAM,OAAO,OAAO,SAAS,SACzB,MAAM,eAAe,eAAe,OAAO,OAAO,QAAQ,CAAC,IAC3D,OAAO,SAAS,QAChB,MAAM,cAAc,eAAe,OAAO,QAAQ,QAAQ,CAAC,IAC3D,MAAM,oBAAoB,OAAO,OAAO;AAC5C,WAAO,KAAK,SAAS,QAAQ,WAAW,WAAW,CAAC;AAAA,EACtD,CAAC,CAAC;AACJ;AASO,MAAM,OAAO,CAClB,QACA,YACmC;AACnC,MAAI,WAAW,MAAM,EAAG,QAAO;AAK/B,QAAM,WAAW,UAAU,KAAK,EAAE,WAAW,QAAQ,OAAO,UAAU,iBAAiB,GAAG,QAAQ,CAAC;AACnG,QAAM,UAAU,OAAO;AAAA,IAAsB,CAAC,eAC5C,OAAO,IAAI;AAAA,MACT,GAAG;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAWH,SAAU,QAAQ,WAAW,OAAO,EAAE,IAAI,CAAC,SAAS,eAAe,MAAM,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOlF,OAAO,cAAc,WAAW,OAAO,QAAQ;AAAA,MAC/C,OAAO,cAAc,WAAW,OAAO,QAAQ;AAAA,IACjD,CAAC;AAAA,EACH;AACA,SAAO,eAAe,SAAS,QAAQ,EAAE,OAAO,KAAK,CAAC;AACtD,SAAO;AACT;AAcO,MAAM,QAAQ,CAAC,YACpB,MAAM;AAAA,EACJ,OAAO;AAAA,EACP,OAAO;AAAA,IAAU,CAAC,UAChB,OAAO,KAAK,MAAM;AAChB,YAAM,UAAU,oBAAI,IAAiC;AACrD,iBAAW,UAAU,MAAM,OAAO,OAAO,cAAc,EAAG,SAAQ,IAAI,KAAK,QAAQ,OAAO,CAAC;AAC3F,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AACF;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -0,0 +1,350 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Payload redaction for durable journal writes.
|
|
3
|
+
*
|
|
4
|
+
* The journal is permanent and broadly readable: every entry is replayed to
|
|
5
|
+
* sync subscribers and to time-travel consumers. A secret that reaches
|
|
6
|
+
* `payload_json` is therefore not a transient leak, so redaction happens once,
|
|
7
|
+
* on the journal write path, rather than at each reader.
|
|
8
|
+
*
|
|
9
|
+
* Redaction is an **observability** concern and is confined to journal events
|
|
10
|
+
* and export/display surfaces. It is deliberately not applied to executable
|
|
11
|
+
* state, `flows_runs.state_json`, attempt checkpoints, errors, outcomes, and
|
|
12
|
+
* cache results, because those are decoded and re-entered on resume: a
|
|
13
|
+
* placeholder there resumes the flow with the wrong data, and replacing a
|
|
14
|
+
* non-string value with a placeholder string makes the persisted state fail
|
|
15
|
+
* schema decode outright, leaving the run undrivable (issue #72). A value
|
|
16
|
+
* that must never reach durable executable state is a `Redacted` field in the
|
|
17
|
+
* caller's own schema, not a name-suffix guess made at the storage seam.
|
|
18
|
+
*
|
|
19
|
+
* The rule set is a best-effort textual net over credential shapes seen in
|
|
20
|
+
* real bug reports, plus structural redaction by sensitive field name. It is
|
|
21
|
+
* finite, so a value that must never persist belongs in a `Redacted` field of
|
|
22
|
+
* the caller's own schema. See https://journal.smithers.sh/concepts/redaction/
|
|
23
|
+
* for the rule set and how to replace it.
|
|
24
|
+
*
|
|
25
|
+
* @since 0.1.0
|
|
26
|
+
*/
|
|
27
|
+
import * as Schema from "effect/Schema";
|
|
28
|
+
/**
|
|
29
|
+
* A textual redaction rule.
|
|
30
|
+
*
|
|
31
|
+
* `replace` is the substitution for a matched span; when omitted the whole
|
|
32
|
+
* match is replaced by the placeholder.
|
|
33
|
+
*
|
|
34
|
+
* `rewrite`, when set, rewrites the text itself instead. It is for a rule
|
|
35
|
+
* whose extent is not regular: where a credential's value ends depends on
|
|
36
|
+
* quotes, escapes and brackets a regular expression cannot count. `pattern`
|
|
37
|
+
* then names what the rule looks for, and text `pattern` does not match is
|
|
38
|
+
* left unchanged without calling `rewrite`.
|
|
39
|
+
*
|
|
40
|
+
* @since 0.1.0
|
|
41
|
+
* @category models
|
|
42
|
+
*/
|
|
43
|
+
export interface Rule {
|
|
44
|
+
readonly id: string;
|
|
45
|
+
readonly pattern: RegExp;
|
|
46
|
+
readonly replace?: string | undefined;
|
|
47
|
+
readonly rewrite?: ((text: string) => string) | undefined;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* The placeholder written in place of a redacted value.
|
|
51
|
+
*
|
|
52
|
+
* @since 0.1.0
|
|
53
|
+
* @category constants
|
|
54
|
+
*/
|
|
55
|
+
export declare const placeholder = "[REDACTED]";
|
|
56
|
+
/**
|
|
57
|
+
* Best-effort textual rules for credential shapes observed in real reports.
|
|
58
|
+
* Every replacement reaches a fixed point so replaying or exporting an entry
|
|
59
|
+
* cannot mutate it again.
|
|
60
|
+
*
|
|
61
|
+
* @since 0.1.0
|
|
62
|
+
* @category constants
|
|
63
|
+
*/
|
|
64
|
+
export declare const defaultRules: ReadonlyArray<Rule>;
|
|
65
|
+
/**
|
|
66
|
+
* The rules for a diagnostic: {@link defaultRules} and the spellings too broad
|
|
67
|
+
* for a durable row.
|
|
68
|
+
*
|
|
69
|
+
* A log line, a stderr message, and an error handed to a remote caller are
|
|
70
|
+
* read once, so a false positive costs a word of context. A journal row is
|
|
71
|
+
* permanent, so the same false positive destroys data. These rules sit on the
|
|
72
|
+
* diagnostic side of that line: an authorization header in any scheme, bare
|
|
73
|
+
* URL userinfo (`https://token@host`), a signed query parameter, and the value
|
|
74
|
+
* of a `-p` flag, which is a password to `mysql` and `sshpass` and a path to
|
|
75
|
+
* `mkdir`. A path, a port and a lowercase word attached to `-p` (`-print`,
|
|
76
|
+
* `-path`) are left alone.
|
|
77
|
+
*
|
|
78
|
+
* @since 1.0.0
|
|
79
|
+
* @category constants
|
|
80
|
+
*/
|
|
81
|
+
export declare const diagnosticRules: ReadonlyArray<Rule>;
|
|
82
|
+
/**
|
|
83
|
+
* Redacts one diagnostic value with {@link diagnosticRules}: a log line, a
|
|
84
|
+
* stderr message, an error handed back to a caller.
|
|
85
|
+
*
|
|
86
|
+
* Every diagnostic path shares this one function, and it runs on the value
|
|
87
|
+
* before anything renders or bounds it. Redacting a rendering line by line, or
|
|
88
|
+
* after a bound, is how a secret escaped: `util.inspect` splits a long string
|
|
89
|
+
* over several lines, and a bound cuts a quoted value before its closing
|
|
90
|
+
* quote. A value past {@link maxDepth} is named rather than thrown.
|
|
91
|
+
*
|
|
92
|
+
* @since 1.0.0
|
|
93
|
+
* @category redaction
|
|
94
|
+
*/
|
|
95
|
+
export declare const redactDiagnostic: (value: unknown) => unknown;
|
|
96
|
+
/**
|
|
97
|
+
* Whether a field name names a credential.
|
|
98
|
+
*
|
|
99
|
+
* Case and separators are ignored, so `api_key`, `apiKey`, and `x-api-key` are
|
|
100
|
+
* all recognised, one trailing plural `s` is stripped so `credentials` reads as
|
|
101
|
+
* `credential`, and a trailing `key` counts where it is a word of its own or
|
|
102
|
+
* where the word before it names a secret.
|
|
103
|
+
*
|
|
104
|
+
* The rule is a suffix test, not a substring test. `tokenizer`, `secretary`,
|
|
105
|
+
* `monkey`, and `idempotencyKey` are ordinary field names, and replacing their
|
|
106
|
+
* values would destroy data in a permanent row without protecting anything.
|
|
107
|
+
* That is the one place this rule is deliberately narrower than
|
|
108
|
+
* `packages/smithers/src/Bug.ts`'s substring form, which can afford the false
|
|
109
|
+
* positives because its output is a single report an operator reads once.
|
|
110
|
+
*
|
|
111
|
+
* @since 0.1.0
|
|
112
|
+
* @category predicates
|
|
113
|
+
*/
|
|
114
|
+
export declare const isSensitiveKey: (key: string) => boolean;
|
|
115
|
+
/**
|
|
116
|
+
* Maximum number of container edges traversed from a redaction root.
|
|
117
|
+
*
|
|
118
|
+
* Journal event schemas never approach 256 nested containers. This bound is
|
|
119
|
+
* far above practical payloads while keeping traversal safely below Node's
|
|
120
|
+
* call-stack limit for hostile input.
|
|
121
|
+
*
|
|
122
|
+
* @since 1.0.0
|
|
123
|
+
* @category constants
|
|
124
|
+
*/
|
|
125
|
+
export declare const maxDepth = 256;
|
|
126
|
+
declare const RedactionDepthError_base: Schema.Class<RedactionDepthError, Schema.TaggedStruct<"@smthrs/journal/RedactionDepthError", {
|
|
127
|
+
readonly code: Schema.Literal<"depth_exceeded">;
|
|
128
|
+
readonly maxDepth: Schema.Number;
|
|
129
|
+
readonly message: Schema.String;
|
|
130
|
+
}>, import("effect/Cause").YieldableError>;
|
|
131
|
+
/**
|
|
132
|
+
* A payload nested deeper than {@link maxDepth}, under `onTooDeep: "throw"`.
|
|
133
|
+
* `code` is always `depth_exceeded`; `maxDepth` is the bound that was crossed.
|
|
134
|
+
*
|
|
135
|
+
* @since 1.0.0
|
|
136
|
+
* @category errors
|
|
137
|
+
*/
|
|
138
|
+
export declare class RedactionDepthError extends RedactionDepthError_base {
|
|
139
|
+
readonly name = "RedactionDepthError";
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Options for {@link redact}.
|
|
143
|
+
*
|
|
144
|
+
* @since 0.1.0
|
|
145
|
+
* @category models
|
|
146
|
+
*/
|
|
147
|
+
export interface Options {
|
|
148
|
+
readonly rules?: ReadonlyArray<Rule> | undefined;
|
|
149
|
+
/**
|
|
150
|
+
* What a value nested past {@link maxDepth} does.
|
|
151
|
+
*
|
|
152
|
+
* `"throw"`, the default, is the journal's contract: a payload that deep is a
|
|
153
|
+
* caller bug, and a durable row quietly truncated to a marker is worse than a
|
|
154
|
+
* refused write. `"name"` is what a LOGGER wants, because a throw there is
|
|
155
|
+
* caught one frame up and replaces EVERY argument on the line with
|
|
156
|
+
* `[Unrenderable]`, so one deep member would cost the operator the whole line.
|
|
157
|
+
*/
|
|
158
|
+
readonly onTooDeep?: "throw" | "name" | undefined;
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
* How many bytes a view may hold, and how many own members {@link redact} reads
|
|
162
|
+
* off it, before it stops reading them.
|
|
163
|
+
*
|
|
164
|
+
* Enumerating a view's own properties materialises one pair per byte, so the
|
|
165
|
+
* walk costs the buffer's size even though the rendering does not. Both halves
|
|
166
|
+
* of the bound carry load, and neither is a bound on its own. A size alone is
|
|
167
|
+
* not, because `byteLength` was read as an ordinary property and an ordinary
|
|
168
|
+
* property can be shadowed: a pooled chunk that reports the bytes it has used
|
|
169
|
+
* rather than the bytes it holds is a plain pattern, not an adversarial one,
|
|
170
|
+
* and a 4 MB chunk reporting 12 walked one property per byte anyway. A count
|
|
171
|
+
* alone is not, because a caller can hang a million properties on a ten-byte
|
|
172
|
+
* view. So the size is read from the value's own internal slot, where nothing
|
|
173
|
+
* a caller writes can answer for it, and the members are counted as they are
|
|
174
|
+
* walked.
|
|
175
|
+
*
|
|
176
|
+
* @since 0.1.0
|
|
177
|
+
* @category redaction
|
|
178
|
+
*/
|
|
179
|
+
export declare const binaryWalkLimit = 65536;
|
|
180
|
+
/**
|
|
181
|
+
* The key {@link redact} files a binary view's size under.
|
|
182
|
+
*
|
|
183
|
+
* @since 0.1.0
|
|
184
|
+
* @category redaction
|
|
185
|
+
*/
|
|
186
|
+
export declare const binaryMarker = "[Binary]";
|
|
187
|
+
/**
|
|
188
|
+
* What {@link redact} writes in place of a function or a class object.
|
|
189
|
+
*
|
|
190
|
+
* @since 0.1.0
|
|
191
|
+
* @category redaction
|
|
192
|
+
*/
|
|
193
|
+
export declare const functionMarker = "[Function]";
|
|
194
|
+
/**
|
|
195
|
+
* What {@link redact} writes in place of a symbol.
|
|
196
|
+
*
|
|
197
|
+
* @since 0.1.0
|
|
198
|
+
* @category redaction
|
|
199
|
+
*/
|
|
200
|
+
export declare const symbolMarker = "[Symbol]";
|
|
201
|
+
/**
|
|
202
|
+
* What {@link redact} writes past {@link maxDepth} under `onTooDeep: "name"`.
|
|
203
|
+
*
|
|
204
|
+
* @since 0.1.0
|
|
205
|
+
* @category redaction
|
|
206
|
+
*/
|
|
207
|
+
export declare const depthMarker = "[Deep]";
|
|
208
|
+
/**
|
|
209
|
+
* Returns `value` with credentials removed.
|
|
210
|
+
*
|
|
211
|
+
* Objects and arrays are rebuilt: a field whose name {@link isSensitiveKey}
|
|
212
|
+
* is replaced wholesale, every other string is run through the textual rules,
|
|
213
|
+
* and a cycle is collapsed to `"[Circular]"` so the result always encodes.
|
|
214
|
+
* A number, a boolean, `null` and `undefined` are returned untouched, because
|
|
215
|
+
* redacting one destroys data without protecting anything. A function and a
|
|
216
|
+
* symbol are NAMED, {@link functionMarker} and {@link symbolMarker}: a body, an
|
|
217
|
+
* own property and a description are all text a renderer prints, and none of it
|
|
218
|
+
* can be rewritten in place.
|
|
219
|
+
*
|
|
220
|
+
* Traversal accepts at most {@link maxDepth} container edges. A deeper value
|
|
221
|
+
* throws by default, so the journal boundary can report a typed `invalid_event`
|
|
222
|
+
* instead of overflowing the runtime stack. {@link Options.onTooDeep} set to
|
|
223
|
+
* `"name"` writes {@link depthMarker} in its place instead, which is what a
|
|
224
|
+
* logger wants.
|
|
225
|
+
*
|
|
226
|
+
* @since 0.1.0
|
|
227
|
+
* @category redaction
|
|
228
|
+
*/
|
|
229
|
+
export declare const redact: (value: unknown, options?: Options) => unknown;
|
|
230
|
+
/**
|
|
231
|
+
* A redaction function, as the journal consumes it.
|
|
232
|
+
*
|
|
233
|
+
* @since 0.1.0
|
|
234
|
+
* @category models
|
|
235
|
+
*/
|
|
236
|
+
export type Redactor = (value: unknown) => unknown;
|
|
237
|
+
/**
|
|
238
|
+
* Builds a redactor over a rule set.
|
|
239
|
+
*
|
|
240
|
+
* @since 0.1.0
|
|
241
|
+
* @category constructors
|
|
242
|
+
*/
|
|
243
|
+
export declare const make: (options?: Options) => Redactor;
|
|
244
|
+
/**
|
|
245
|
+
* Applies a redactor to an already-encoded JSON string, returning the
|
|
246
|
+
* re-encoded result.
|
|
247
|
+
*
|
|
248
|
+
* For export and display surfaces that hold a column verbatim, a rendered
|
|
249
|
+
* `state_json`, a support bundle, where the value is already encoded and must
|
|
250
|
+
* not be decoded into the executable path. A string that does not parse is
|
|
251
|
+
* returned untouched: validation is the caller's, and rejecting here would
|
|
252
|
+
* turn a redaction concern into a schema error. Once parsing succeeds, a
|
|
253
|
+
* throwing redactor or an encoding failure returns the valid JSON string
|
|
254
|
+
* `"[REDACTED]"`; the original parsed text is never returned.
|
|
255
|
+
*
|
|
256
|
+
* @since 0.1.0
|
|
257
|
+
* @category redaction
|
|
258
|
+
*/
|
|
259
|
+
export declare const redactJsonString: (json: string, redactor: Redactor) => string;
|
|
260
|
+
/**
|
|
261
|
+
* Redacts a stream one line at a time.
|
|
262
|
+
*
|
|
263
|
+
* @since 1.0.0
|
|
264
|
+
* @category models
|
|
265
|
+
*/
|
|
266
|
+
export interface LineRedactor {
|
|
267
|
+
/**
|
|
268
|
+
* Takes the rest of the current line, without its newline, and returns the
|
|
269
|
+
* lines now safe to emit: none while a value is still open.
|
|
270
|
+
*/
|
|
271
|
+
readonly line: (line: string) => ReadonlyArray<string>;
|
|
272
|
+
/**
|
|
273
|
+
* Takes part of a line whose newline has not arrived. A line longer than
|
|
274
|
+
* {@link maxPartialLine} is never emitted: {@link omittedLine} stands for it.
|
|
275
|
+
*/
|
|
276
|
+
readonly part: (text: string) => void;
|
|
277
|
+
/** What {@link LineRedactor.flush} would emit now, without ending the stream: for a rendered snapshot. */
|
|
278
|
+
readonly peek: () => ReadonlyArray<string>;
|
|
279
|
+
/** Ends the stream and returns whatever is still held, redacted as one block. */
|
|
280
|
+
readonly flush: () => ReadonlyArray<string>;
|
|
281
|
+
}
|
|
282
|
+
/**
|
|
283
|
+
* Lines a {@link lineRedactor} holds for one open value. Past this, or past
|
|
284
|
+
* 64 KiB, it stops holding: it emits what it held, redacted, and withholds
|
|
285
|
+
* every later line until the stream ends, when one placeholder stands for
|
|
286
|
+
* them. Dropping lines from the middle instead changed which brackets and
|
|
287
|
+
* quotes were open, and released a later secret in clear.
|
|
288
|
+
*
|
|
289
|
+
* @since 1.0.0
|
|
290
|
+
* @category constants
|
|
291
|
+
*/
|
|
292
|
+
export declare const maxHeldLines = 256;
|
|
293
|
+
/**
|
|
294
|
+
* The longest line a {@link lineRedactor} reads whole. A longer line keeps
|
|
295
|
+
* its first and last 16 KiB; its middle is scanned for what it leaves open
|
|
296
|
+
* and dropped.
|
|
297
|
+
*
|
|
298
|
+
* @since 1.0.0
|
|
299
|
+
* @category constants
|
|
300
|
+
*/
|
|
301
|
+
export declare const maxPartialLine: number;
|
|
302
|
+
/**
|
|
303
|
+
* What a {@link lineRedactor} emits in place of a line longer than
|
|
304
|
+
* {@link maxPartialLine}.
|
|
305
|
+
*
|
|
306
|
+
* @since 1.0.0
|
|
307
|
+
* @category constants
|
|
308
|
+
*/
|
|
309
|
+
export declare const omittedLine = "[overlong line omitted]";
|
|
310
|
+
/**
|
|
311
|
+
* A redactor for a stream that must be emitted line by line: a live build
|
|
312
|
+
* log, a child's stderr.
|
|
313
|
+
*
|
|
314
|
+
* Redacting each line alone is the flaw that leaked a private key's body, and
|
|
315
|
+
* the tail of every string `util.inspect` split over several lines: only the
|
|
316
|
+
* line holding the name was redacted. This one asks the rules themselves
|
|
317
|
+
* whether a line leaves a value open, by checking whether the value swallows
|
|
318
|
+
* a probe placed on the next line, and holds lines until it closes. The held
|
|
319
|
+
* block is then redacted whole, exactly as {@link redact} redacts a string.
|
|
320
|
+
*
|
|
321
|
+
* A line longer than {@link maxPartialLine} is read as its first and last
|
|
322
|
+
* 16 KiB. Its middle is dropped, but a bracket, quote or key block the middle
|
|
323
|
+
* leaves open would have opened a value the kept ends cannot show, so then
|
|
324
|
+
* the rest of the stream is withheld. Such a line is never emitted, only
|
|
325
|
+
* {@link omittedLine}, and neither is any block it was held in.
|
|
326
|
+
*
|
|
327
|
+
* Its state is bounded whatever the stream does: the line still arriving is
|
|
328
|
+
* a 16 KiB head, a 16 KiB tail and at most 1024 open brackets or strings of
|
|
329
|
+
* its middle, a middle nested deeper counting as one left open; the held
|
|
330
|
+
* block is bounded by {@link maxHeldLines} and 64 KiB. Its cost is linear:
|
|
331
|
+
* past the first 16 held lines the block is re-read only once it has grown
|
|
332
|
+
* by half, on Node and on Bun alike (#3088).
|
|
333
|
+
*
|
|
334
|
+
* `rules` defaults to {@link diagnosticRules}. The array is read on every
|
|
335
|
+
* line, so a caller may add a rule, a session secret, as the stream runs.
|
|
336
|
+
*
|
|
337
|
+
* @since 1.0.0
|
|
338
|
+
* @category constructors
|
|
339
|
+
*/
|
|
340
|
+
export declare const lineRedactor: (rules?: ReadonlyArray<Rule>) => LineRedactor;
|
|
341
|
+
/**
|
|
342
|
+
* The identity redactor, for a caller that persists payloads verbatim by
|
|
343
|
+
* choice: a trusted single-tenant store, or a suite asserting on raw input.
|
|
344
|
+
*
|
|
345
|
+
* @since 0.1.0
|
|
346
|
+
* @category constructors
|
|
347
|
+
*/
|
|
348
|
+
export declare const makeNoop: () => Redactor;
|
|
349
|
+
export {};
|
|
350
|
+
//# sourceMappingURL=Redaction.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Redaction.d.ts","sourceRoot":"","sources":["../../src/Redaction.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAGH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAKvC;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAA;CAC1D;AAED;;;;;GAKG;AACH,eAAO,MAAM,WAAW,eAAe,CAAA;AA4qBvC;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,EAAE,aAAa,CAAC,IAAI,CA4G5C,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,eAAe,EAAE,aAAa,CAAC,IAAI,CAiF/C,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,OAAO,KAAG,OACY,CAAA;AA0F9D;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,MAAM,KAAG,OAI5C,CAAA;AAiFD;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ,MAAM,CAAA;;;;;;AAE3B;;;;;;GAMG;AACH,qBAAa,mBAAoB,SAAQ,wBAGxC;IACC,SAAkB,IAAI,yBAAwB;CAC/C;AAED;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,GAAG,SAAS,CAAA;IAChD;;;;;;;;OAQG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAAA;CAClD;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,eAAe,QAAS,CAAA;AA+ErC;;;;;GAKG;AACH,eAAO,MAAM,YAAY,aAAa,CAAA;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,cAAc,eAAe,CAAA;AAE1C;;;;;GAKG;AACH,eAAO,MAAM,YAAY,aAAa,CAAA;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,WAAW,WAAW,CAAA;AAEnC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,MAAM,GAAI,OAAO,OAAO,EAAE,UAAU,OAAO,KAAG,OAkI1D,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAA;AAElD;;;;;GAKG;AACH,eAAO,MAAM,IAAI,GAAI,UAAU,OAAO,KAAG,QAA6C,CAAA;AAEtF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,MAAM,EAAE,UAAU,QAAQ,KAAG,MAMnE,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,aAAa,CAAC,MAAM,CAAC,CAAA;IACtD;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IACrC,0GAA0G;IAC1G,QAAQ,CAAC,IAAI,EAAE,MAAM,aAAa,CAAC,MAAM,CAAC,CAAA;IAC1C,iFAAiF;IACjF,QAAQ,CAAC,KAAK,EAAE,MAAM,aAAa,CAAC,MAAM,CAAC,CAAA;CAC5C;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,MAAM,CAAA;AAe/B;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,QAAY,CAAA;AAEvC;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,4BAA4B,CAAA;AAiBpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,YAAY,GAAI,QAAO,aAAa,CAAC,IAAI,CAAmB,KAAG,YA6H3E,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,QAAO,QAA4B,CAAA"}
|