@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.
- package/CHANGELOG.md +20 -0
- package/README.md +26 -8
- package/dist/cjs/CallFact.d.ts +8 -8
- package/dist/cjs/Consensus.d.ts +26 -6
- package/dist/cjs/Consensus.d.ts.map +1 -1
- package/dist/cjs/Consensus.js +63 -22
- package/dist/cjs/Consensus.js.map +2 -2
- package/dist/cjs/EngineEvent.d.ts +23 -23
- package/dist/cjs/EngineEvent.d.ts.map +1 -1
- package/dist/cjs/EngineEvent.js +3 -2
- package/dist/cjs/EngineEvent.js.map +2 -2
- package/dist/cjs/ExecutionFact.d.ts +5 -5
- package/dist/cjs/Journal.d.ts +77 -2
- package/dist/cjs/Journal.d.ts.map +1 -1
- package/dist/cjs/Journal.js +1 -0
- package/dist/cjs/Journal.js.map +2 -2
- package/dist/cjs/JournalGeneration.d.ts +1 -1
- package/dist/cjs/JournalGeneration.d.ts.map +1 -1
- package/dist/cjs/JournalGeneration.js +10 -1
- package/dist/cjs/JournalGeneration.js.map +2 -2
- package/dist/cjs/JournalMetrics.d.ts +41 -5
- package/dist/cjs/JournalMetrics.d.ts.map +1 -1
- package/dist/cjs/JournalMetrics.js +10 -1
- package/dist/cjs/JournalMetrics.js.map +2 -2
- package/dist/cjs/RedactedLogger.d.ts.map +1 -1
- package/dist/cjs/RedactedLogger.js +5 -3
- package/dist/cjs/RedactedLogger.js.map +2 -2
- package/dist/cjs/Redaction.d.ts +18 -1
- package/dist/cjs/Redaction.d.ts.map +1 -1
- package/dist/cjs/Redaction.js +142 -12
- package/dist/cjs/Redaction.js.map +3 -3
- package/dist/cjs/SqlConsensus.d.ts +4 -3
- package/dist/cjs/SqlConsensus.d.ts.map +1 -1
- package/dist/cjs/SqlConsensus.js +92 -59
- package/dist/cjs/SqlConsensus.js.map +2 -2
- package/dist/cjs/SqlJournal.d.ts.map +1 -1
- package/dist/cjs/SqlJournal.js +370 -131
- package/dist/cjs/SqlJournal.js.map +3 -3
- package/dist/cjs/StepFact.d.ts +1 -1
- package/dist/cjs/TelemetryLog.d.ts +241 -0
- package/dist/cjs/TelemetryLog.d.ts.map +1 -0
- package/dist/cjs/TelemetryLog.js +349 -0
- package/dist/cjs/TelemetryLog.js.map +7 -0
- package/dist/cjs/index.d.ts +5 -0
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +3 -1
- package/dist/cjs/index.js.map +2 -2
- package/dist/cjs/internal/EventTally.d.ts +31 -0
- package/dist/cjs/internal/EventTally.d.ts.map +1 -0
- package/dist/cjs/internal/EventTally.js +32 -0
- package/dist/cjs/internal/EventTally.js.map +7 -0
- package/dist/cjs/internal/JournalDigest.d.ts +24 -0
- package/dist/cjs/internal/JournalDigest.d.ts.map +1 -0
- package/dist/cjs/internal/JournalDigest.js +44 -0
- package/dist/cjs/internal/JournalDigest.js.map +7 -0
- package/dist/cjs/internal/JournalTestObserver.d.ts +41 -0
- package/dist/cjs/internal/JournalTestObserver.d.ts.map +1 -0
- package/dist/cjs/internal/JournalTestObserver.js +38 -0
- package/dist/cjs/internal/JournalTestObserver.js.map +7 -0
- package/dist/cjs/internal/TelemetryText.d.ts +28 -0
- package/dist/cjs/internal/TelemetryText.d.ts.map +1 -0
- package/dist/cjs/internal/TelemetryText.js +44 -0
- package/dist/cjs/internal/TelemetryText.js.map +7 -0
- package/dist/esm/CallFact.d.ts +8 -8
- package/dist/esm/Consensus.d.ts +26 -6
- package/dist/esm/Consensus.d.ts.map +1 -1
- package/dist/esm/Consensus.js +102 -21
- package/dist/esm/Consensus.js.map +1 -1
- package/dist/esm/EngineEvent.d.ts +23 -23
- package/dist/esm/EngineEvent.d.ts.map +1 -1
- package/dist/esm/EngineEvent.js +4 -2
- package/dist/esm/EngineEvent.js.map +1 -1
- package/dist/esm/ExecutionFact.d.ts +5 -5
- package/dist/esm/Journal.d.ts +77 -2
- package/dist/esm/Journal.d.ts.map +1 -1
- package/dist/esm/Journal.js +4 -1
- package/dist/esm/Journal.js.map +1 -1
- package/dist/esm/JournalGeneration.d.ts +1 -1
- package/dist/esm/JournalGeneration.d.ts.map +1 -1
- package/dist/esm/JournalGeneration.js +9 -1
- package/dist/esm/JournalGeneration.js.map +1 -1
- package/dist/esm/JournalMetrics.d.ts +41 -5
- package/dist/esm/JournalMetrics.d.ts.map +1 -1
- package/dist/esm/JournalMetrics.js +38 -6
- package/dist/esm/JournalMetrics.js.map +1 -1
- package/dist/esm/RedactedLogger.d.ts.map +1 -1
- package/dist/esm/RedactedLogger.js +9 -5
- package/dist/esm/RedactedLogger.js.map +1 -1
- package/dist/esm/Redaction.d.ts +18 -1
- package/dist/esm/Redaction.d.ts.map +1 -1
- package/dist/esm/Redaction.js +199 -16
- package/dist/esm/Redaction.js.map +1 -1
- package/dist/esm/SqlConsensus.d.ts +4 -3
- package/dist/esm/SqlConsensus.d.ts.map +1 -1
- package/dist/esm/SqlConsensus.js +34 -22
- package/dist/esm/SqlConsensus.js.map +1 -1
- package/dist/esm/SqlJournal.d.ts.map +1 -1
- package/dist/esm/SqlJournal.js +410 -108
- package/dist/esm/SqlJournal.js.map +1 -1
- package/dist/esm/StepFact.d.ts +1 -1
- package/dist/esm/TelemetryLog.d.ts +241 -0
- package/dist/esm/TelemetryLog.d.ts.map +1 -0
- package/dist/esm/TelemetryLog.js +519 -0
- package/dist/esm/TelemetryLog.js.map +1 -0
- package/dist/esm/index.d.ts +5 -0
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +5 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/internal/EventTally.d.ts +31 -0
- package/dist/esm/internal/EventTally.d.ts.map +1 -0
- package/dist/esm/internal/EventTally.js +27 -0
- package/dist/esm/internal/EventTally.js.map +1 -0
- package/dist/esm/internal/JournalDigest.d.ts +24 -0
- package/dist/esm/internal/JournalDigest.d.ts.map +1 -0
- package/dist/esm/internal/JournalDigest.js +27 -0
- package/dist/esm/internal/JournalDigest.js.map +1 -0
- package/dist/esm/internal/JournalTestObserver.d.ts +41 -0
- package/dist/esm/internal/JournalTestObserver.d.ts.map +1 -0
- package/dist/esm/internal/JournalTestObserver.js +17 -0
- package/dist/esm/internal/JournalTestObserver.js.map +1 -0
- package/dist/esm/internal/TelemetryText.d.ts +28 -0
- package/dist/esm/internal/TelemetryText.d.ts.map +1 -0
- package/dist/esm/internal/TelemetryText.js +28 -0
- package/dist/esm/internal/TelemetryText.js.map +1 -0
- package/docs/README.md +6 -5
- package/docs/api.md +244 -49
- package/docs/concepts/owner-fence.md +4 -1
- package/docs/concepts/redaction.md +45 -2
- package/docs/concepts/state-event-authority.md +5 -4
- package/docs/concepts/two-channels.md +3 -2
- package/docs/guides/read-a-run.md +8 -6
- package/docs/guides/redact-log-output.md +4 -2
- package/docs/guides/testing.md +4 -2
- package/docs/installation.md +23 -9
- package/docs/quickstart.md +58 -3
- package/docs/troubleshooting.md +4 -2
- package/package.json +21 -9
- package/src/Consensus.ts +118 -28
- package/src/EngineEvent.ts +6 -2
- package/src/Journal.ts +85 -2
- package/src/JournalGeneration.ts +13 -1
- package/src/JournalMetrics.ts +53 -6
- package/src/RedactedLogger.ts +10 -4
- package/src/Redaction.ts +252 -16
- package/src/SqlConsensus.ts +135 -83
- package/src/SqlJournal.ts +604 -179
- package/src/TelemetryLog.ts +597 -0
- package/src/index.ts +6 -0
- package/src/internal/EventTally.ts +39 -0
- package/src/internal/JournalDigest.ts +30 -0
- package/src/internal/JournalTestObserver.ts +48 -0
- package/src/internal/TelemetryText.ts +31 -0
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The open `JournalMetrics.tally` scopes of the current fiber.
|
|
3
|
+
*
|
|
4
|
+
* @since 1.0.0
|
|
5
|
+
*/
|
|
6
|
+
import { Context, Effect } from "effect";
|
|
7
|
+
/**
|
|
8
|
+
* One open tally: the entries committed inside it so far.
|
|
9
|
+
*
|
|
10
|
+
* @category internal
|
|
11
|
+
* @since 1.0.0
|
|
12
|
+
*/
|
|
13
|
+
export interface Accumulator {
|
|
14
|
+
events: number;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Every tally the current fiber runs inside, innermost last. A fiber forked
|
|
18
|
+
* inside a tally inherits it, so its entries count too.
|
|
19
|
+
*
|
|
20
|
+
* @category internal
|
|
21
|
+
* @since 1.0.0
|
|
22
|
+
*/
|
|
23
|
+
export declare const Current: Context.Reference<readonly Accumulator[]>;
|
|
24
|
+
/**
|
|
25
|
+
* Adds `events` committed entries to every open tally.
|
|
26
|
+
*
|
|
27
|
+
* @category internal
|
|
28
|
+
* @since 1.0.0
|
|
29
|
+
*/
|
|
30
|
+
export declare const record: (events: number) => Effect.Effect<void>;
|
|
31
|
+
//# sourceMappingURL=EventTally.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"EventTally.d.ts","sourceRoot":"","sources":["../../../src/internal/EventTally.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAExC;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,2CAElB,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAGtD,CAAA"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The open `JournalMetrics.tally` scopes of the current fiber.
|
|
3
|
+
*
|
|
4
|
+
* @since 1.0.0
|
|
5
|
+
*/
|
|
6
|
+
import { Context, Effect } from "effect";
|
|
7
|
+
/**
|
|
8
|
+
* Every tally the current fiber runs inside, innermost last. A fiber forked
|
|
9
|
+
* inside a tally inherits it, so its entries count too.
|
|
10
|
+
*
|
|
11
|
+
* @category internal
|
|
12
|
+
* @since 1.0.0
|
|
13
|
+
*/
|
|
14
|
+
export const Current = Context.Reference("@smthrs/journal/EventTally", {
|
|
15
|
+
defaultValue: () => []
|
|
16
|
+
});
|
|
17
|
+
/**
|
|
18
|
+
* Adds `events` committed entries to every open tally.
|
|
19
|
+
*
|
|
20
|
+
* @category internal
|
|
21
|
+
* @since 1.0.0
|
|
22
|
+
*/
|
|
23
|
+
export const record = (events) => Effect.gen(function* () {
|
|
24
|
+
for (const accumulator of yield* Current)
|
|
25
|
+
accumulator.events += events;
|
|
26
|
+
});
|
|
27
|
+
//# sourceMappingURL=EventTally.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"EventTally.js","sourceRoot":"","sources":["../../../src/internal/EventTally.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAYxC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAA6B,4BAA4B,EAAE;IACjG,YAAY,EAAE,GAAG,EAAE,CAAC,EAAE;CACvB,CAAC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,MAAc,EAAuB,EAAE,CAC5D,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,KAAK,MAAM,WAAW,IAAI,KAAK,CAAC,CAAC,OAAO;QAAE,WAAW,CAAC,MAAM,IAAI,MAAM,CAAA;AACxE,CAAC,CAAC,CAAA","sourcesContent":["/**\n * The open `JournalMetrics.tally` scopes of the current fiber.\n *\n * @since 1.0.0\n */\n\nimport { Context, Effect } from \"effect\"\n\n/**\n * One open tally: the entries committed inside it so far.\n *\n * @category internal\n * @since 1.0.0\n */\nexport interface Accumulator {\n events: number\n}\n\n/**\n * Every tally the current fiber runs inside, innermost last. A fiber forked\n * inside a tally inherits it, so its entries count too.\n *\n * @category internal\n * @since 1.0.0\n */\nexport const Current = Context.Reference<ReadonlyArray<Accumulator>>(\"@smthrs/journal/EventTally\", {\n defaultValue: () => []\n})\n\n/**\n * Adds `events` committed entries to every open tally.\n *\n * @category internal\n * @since 1.0.0\n */\nexport const record = (events: number): Effect.Effect<void> =>\n Effect.gen(function*() {\n for (const accumulator of yield* Current) accumulator.events += events\n })\n"]}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The fingerprint digest dependency, injectable for failure-path tests.
|
|
3
|
+
*
|
|
4
|
+
* @since 1.0.0
|
|
5
|
+
*/
|
|
6
|
+
import * as Context from "effect/Context";
|
|
7
|
+
import * as Effect from "effect/Effect";
|
|
8
|
+
/**
|
|
9
|
+
* Hashes the canonical journal content with SHA-256.
|
|
10
|
+
*
|
|
11
|
+
* @category internal
|
|
12
|
+
* @since 1.0.0
|
|
13
|
+
*/
|
|
14
|
+
export declare const digest: (bytes: Uint8Array<ArrayBuffer>) => Effect.Effect<ArrayBuffer, unknown>;
|
|
15
|
+
/**
|
|
16
|
+
* Defaults to the real digest; a faulty service can refuse a fingerprint.
|
|
17
|
+
*
|
|
18
|
+
* @category internal
|
|
19
|
+
* @since 1.0.0
|
|
20
|
+
*/
|
|
21
|
+
export declare const JournalDigest: Context.Reference<{
|
|
22
|
+
readonly digest: typeof digest;
|
|
23
|
+
}>;
|
|
24
|
+
//# sourceMappingURL=JournalDigest.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"JournalDigest.d.ts","sourceRoot":"","sources":["../../../src/internal/JournalDigest.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC;;;;;GAKG;AACH,eAAO,MAAM,MAAM,GAAI,OAAO,UAAU,CAAC,WAAW,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAItF,CAAA;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,aAAa;qBAAwC,OAAO,MAAM;EAE7E,CAAA"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The fingerprint digest dependency, injectable for failure-path tests.
|
|
3
|
+
*
|
|
4
|
+
* @since 1.0.0
|
|
5
|
+
*/
|
|
6
|
+
import * as Context from "effect/Context";
|
|
7
|
+
import * as Effect from "effect/Effect";
|
|
8
|
+
/**
|
|
9
|
+
* Hashes the canonical journal content with SHA-256.
|
|
10
|
+
*
|
|
11
|
+
* @category internal
|
|
12
|
+
* @since 1.0.0
|
|
13
|
+
*/
|
|
14
|
+
export const digest = (bytes) => Effect.tryPromise({
|
|
15
|
+
try: () => crypto.subtle.digest("SHA-256", bytes),
|
|
16
|
+
catch: (cause) => cause
|
|
17
|
+
});
|
|
18
|
+
/**
|
|
19
|
+
* Defaults to the real digest; a faulty service can refuse a fingerprint.
|
|
20
|
+
*
|
|
21
|
+
* @category internal
|
|
22
|
+
* @since 1.0.0
|
|
23
|
+
*/
|
|
24
|
+
export const JournalDigest = Context.Reference("@smthrs/journal/JournalDigest", {
|
|
25
|
+
defaultValue: () => ({ digest })
|
|
26
|
+
});
|
|
27
|
+
//# sourceMappingURL=JournalDigest.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"JournalDigest.js","sourceRoot":"","sources":["../../../src/internal/JournalDigest.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAA8B,EAAuC,EAAE,CAC5F,MAAM,CAAC,UAAU,CAAC;IAChB,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC;IACjD,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK;CACxB,CAAC,CAAA;AAEJ;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CAAqC,+BAA+B,EAAE;IAClH,YAAY,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;CACjC,CAAC,CAAA","sourcesContent":["/**\n * The fingerprint digest dependency, injectable for failure-path tests.\n *\n * @since 1.0.0\n */\n\nimport * as Context from \"effect/Context\"\nimport * as Effect from \"effect/Effect\"\n\n/**\n * Hashes the canonical journal content with SHA-256.\n *\n * @category internal\n * @since 1.0.0\n */\nexport const digest = (bytes: Uint8Array<ArrayBuffer>): Effect.Effect<ArrayBuffer, unknown> =>\n Effect.tryPromise({\n try: () => crypto.subtle.digest(\"SHA-256\", bytes),\n catch: (cause) => cause\n })\n\n/**\n * Defaults to the real digest; a faulty service can refuse a fingerprint.\n *\n * @category internal\n * @since 1.0.0\n */\nexport const JournalDigest = Context.Reference<{ readonly digest: typeof digest }>(\"@smthrs/journal/JournalDigest\", {\n defaultValue: () => ({ digest })\n})\n"]}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Instance-scoped observations for journal scheduling tests.
|
|
3
|
+
* No mutable journal objects escape through this service.
|
|
4
|
+
*
|
|
5
|
+
* @since 1.0.0
|
|
6
|
+
*/
|
|
7
|
+
import * as Context from "effect/Context";
|
|
8
|
+
import type * as Effect from "effect/Effect";
|
|
9
|
+
import type { RunId } from "../JournalEvent.ts";
|
|
10
|
+
/**
|
|
11
|
+
* Read-only observations of one journal instance.
|
|
12
|
+
*
|
|
13
|
+
* @category internal
|
|
14
|
+
* @since 1.0.0
|
|
15
|
+
*/
|
|
16
|
+
export interface Observations {
|
|
17
|
+
readonly barrierCount: () => number;
|
|
18
|
+
readonly policyRunCount: () => number;
|
|
19
|
+
readonly admission: (runId: RunId) => Effect.Effect<{
|
|
20
|
+
readonly gateClosed: boolean;
|
|
21
|
+
readonly permitAvailable: boolean;
|
|
22
|
+
} | undefined>;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Hooks installed before a journal instance is constructed.
|
|
26
|
+
*
|
|
27
|
+
* @category internal
|
|
28
|
+
* @since 1.0.0
|
|
29
|
+
*/
|
|
30
|
+
export interface Observer {
|
|
31
|
+
readonly opened: (observations: Observations) => void;
|
|
32
|
+
readonly drainRegistered: (runId: RunId) => void;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Absent in ordinary use; tests inject their own instance-scoped observer.
|
|
36
|
+
*
|
|
37
|
+
* @category internal
|
|
38
|
+
* @since 1.0.0
|
|
39
|
+
*/
|
|
40
|
+
export declare const JournalTestObserver: Context.Reference<Observer | undefined>;
|
|
41
|
+
//# sourceMappingURL=JournalTestObserver.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"JournalTestObserver.d.ts","sourceRoot":"","sources":["../../../src/internal/JournalTestObserver.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAE/C;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,YAAY,EAAE,MAAM,MAAM,CAAA;IACnC,QAAQ,CAAC,cAAc,EAAE,MAAM,MAAM,CAAA;IACrC,QAAQ,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,MAAM,CAAC,MAAM,CACjD;QACE,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAA;QAC5B,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAA;KAClC,GAAG,SAAS,CACd,CAAA;CACF;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,MAAM,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,IAAI,CAAA;IACrD,QAAQ,CAAC,eAAe,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;CACjD;AAED;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,yCAE9B,CAAA"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Instance-scoped observations for journal scheduling tests.
|
|
3
|
+
* No mutable journal objects escape through this service.
|
|
4
|
+
*
|
|
5
|
+
* @since 1.0.0
|
|
6
|
+
*/
|
|
7
|
+
import * as Context from "effect/Context";
|
|
8
|
+
/**
|
|
9
|
+
* Absent in ordinary use; tests inject their own instance-scoped observer.
|
|
10
|
+
*
|
|
11
|
+
* @category internal
|
|
12
|
+
* @since 1.0.0
|
|
13
|
+
*/
|
|
14
|
+
export const JournalTestObserver = Context.Reference("@smthrs/journal/JournalTestObserver", {
|
|
15
|
+
defaultValue: () => undefined
|
|
16
|
+
});
|
|
17
|
+
//# sourceMappingURL=JournalTestObserver.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"JournalTestObserver.js","sourceRoot":"","sources":["../../../src/internal/JournalTestObserver.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAgCzC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,OAAO,CAAC,SAAS,CAAuB,qCAAqC,EAAE;IAChH,YAAY,EAAE,GAAG,EAAE,CAAC,SAAS;CAC9B,CAAC,CAAA","sourcesContent":["/**\n * Instance-scoped observations for journal scheduling tests.\n * No mutable journal objects escape through this service.\n *\n * @since 1.0.0\n */\n\nimport * as Context from \"effect/Context\"\nimport type * as Effect from \"effect/Effect\"\nimport type { RunId } from \"../JournalEvent.ts\"\n\n/**\n * Read-only observations of one journal instance.\n *\n * @category internal\n * @since 1.0.0\n */\nexport interface Observations {\n readonly barrierCount: () => number\n readonly policyRunCount: () => number\n readonly admission: (runId: RunId) => Effect.Effect<\n {\n readonly gateClosed: boolean\n readonly permitAvailable: boolean\n } | undefined\n >\n}\n\n/**\n * Hooks installed before a journal instance is constructed.\n *\n * @category internal\n * @since 1.0.0\n */\nexport interface Observer {\n readonly opened: (observations: Observations) => void\n readonly drainRegistered: (runId: RunId) => void\n}\n\n/**\n * Absent in ordinary use; tests inject their own instance-scoped observer.\n *\n * @category internal\n * @since 1.0.0\n */\nexport const JournalTestObserver = Context.Reference<Observer | undefined>(\"@smthrs/journal/JournalTestObserver\", {\n defaultValue: () => undefined\n})\n"]}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Text operations used by a synchronous telemetry snapshot.
|
|
3
|
+
* Tests decorate the real operations in one fiber without patching globals.
|
|
4
|
+
*
|
|
5
|
+
* @since 1.0.0
|
|
6
|
+
*/
|
|
7
|
+
import * as Context from "effect/Context";
|
|
8
|
+
/**
|
|
9
|
+
* Real text operations, shared by snapshots unless a fiber provides its own.
|
|
10
|
+
*
|
|
11
|
+
* @category internal
|
|
12
|
+
* @since 1.0.0
|
|
13
|
+
*/
|
|
14
|
+
export declare const operations: {
|
|
15
|
+
charCodeAt: (value: string, index: number) => number;
|
|
16
|
+
encode: (value: string) => Uint8Array<ArrayBuffer>;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* Fiber-local text operations for measuring the work of a real snapshot.
|
|
20
|
+
*
|
|
21
|
+
* @category internal
|
|
22
|
+
* @since 1.0.0
|
|
23
|
+
*/
|
|
24
|
+
export declare const TelemetryText: Context.Reference<{
|
|
25
|
+
charCodeAt: (value: string, index: number) => number;
|
|
26
|
+
encode: (value: string) => Uint8Array<ArrayBuffer>;
|
|
27
|
+
}>;
|
|
28
|
+
//# sourceMappingURL=TelemetryText.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"TelemetryText.d.ts","sourceRoot":"","sources":["../../../src/internal/TelemetryText.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAIzC;;;;;GAKG;AACH,eAAO,MAAM,UAAU;wBACD,MAAM,SAAS,MAAM,KAAG,MAAM;oBAClC,MAAM,KAAG,UAAU,CAAC,WAAW,CAAC;CACjD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa;wBAVJ,MAAM,SAAS,MAAM,KAAG,MAAM;oBAClC,MAAM,KAAG,UAAU,CAAC,WAAW,CAAC;EAWhD,CAAA"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Text operations used by a synchronous telemetry snapshot.
|
|
3
|
+
* Tests decorate the real operations in one fiber without patching globals.
|
|
4
|
+
*
|
|
5
|
+
* @since 1.0.0
|
|
6
|
+
*/
|
|
7
|
+
import * as Context from "effect/Context";
|
|
8
|
+
const encoder = new TextEncoder();
|
|
9
|
+
/**
|
|
10
|
+
* Real text operations, shared by snapshots unless a fiber provides its own.
|
|
11
|
+
*
|
|
12
|
+
* @category internal
|
|
13
|
+
* @since 1.0.0
|
|
14
|
+
*/
|
|
15
|
+
export const operations = {
|
|
16
|
+
charCodeAt: (value, index) => value.charCodeAt(index),
|
|
17
|
+
encode: (value) => encoder.encode(value)
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* Fiber-local text operations for measuring the work of a real snapshot.
|
|
21
|
+
*
|
|
22
|
+
* @category internal
|
|
23
|
+
* @since 1.0.0
|
|
24
|
+
*/
|
|
25
|
+
export const TelemetryText = Context.Reference("@smthrs/journal/TelemetryText", {
|
|
26
|
+
defaultValue: () => operations
|
|
27
|
+
});
|
|
28
|
+
//# sourceMappingURL=TelemetryText.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"TelemetryText.js","sourceRoot":"","sources":["../../../src/internal/TelemetryText.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAEzC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAA;AAEjC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,UAAU,EAAE,CAAC,KAAa,EAAE,KAAa,EAAU,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC;IAC7E,MAAM,EAAE,CAAC,KAAa,EAA2B,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;CAC1E,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CAAoB,+BAA+B,EAAE;IACjG,YAAY,EAAE,GAAG,EAAE,CAAC,UAAU;CAC/B,CAAC,CAAA","sourcesContent":["/**\n * Text operations used by a synchronous telemetry snapshot.\n * Tests decorate the real operations in one fiber without patching globals.\n *\n * @since 1.0.0\n */\n\nimport * as Context from \"effect/Context\"\n\nconst encoder = new TextEncoder()\n\n/**\n * Real text operations, shared by snapshots unless a fiber provides its own.\n *\n * @category internal\n * @since 1.0.0\n */\nexport const operations = {\n charCodeAt: (value: string, index: number): number => value.charCodeAt(index),\n encode: (value: string): Uint8Array<ArrayBuffer> => encoder.encode(value)\n}\n\n/**\n * Fiber-local text operations for measuring the work of a real snapshot.\n *\n * @category internal\n * @since 1.0.0\n */\nexport const TelemetryText = Context.Reference<typeof operations>(\"@smthrs/journal/TelemetryText\", {\n defaultValue: () => operations\n})\n"]}
|
package/docs/README.md
CHANGED
|
@@ -4,9 +4,10 @@ description: "An append-only event history for Effect applications: a lossless l
|
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
`@smthrs/journal` records what a long-running piece of work did, in order, in
|
|
7
|
-
SQLite
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
SQLite or PostgreSQL. Appends leave existing event rows unchanged. A checkpoint
|
|
8
|
+
replaces saved state at the same run and sequence, and `compact` deletes older
|
|
9
|
+
event rows. A process that dies halfway through leaves behind the committed
|
|
10
|
+
history that has not been compacted.
|
|
10
11
|
|
|
11
12
|
It is a set of [Effect](https://effect.website) services: every write returns a
|
|
12
13
|
typed receipt or a typed failure, and the database arrives as a layer you
|
|
@@ -17,7 +18,7 @@ own: no other Smithers package is required.
|
|
|
17
18
|
npm install @smthrs/journal@next effect
|
|
18
19
|
```
|
|
19
20
|
|
|
20
|
-
`effect` is a peer dependency at exactly `4.
|
|
21
|
+
`effect` is a peer dependency at exactly `4.1.1`. Two copies of `effect`
|
|
21
22
|
in one program are two sets of service tags, so a journal layer built against
|
|
22
23
|
one copy cannot be provided to a program holding the other.
|
|
23
24
|
|
|
@@ -55,7 +56,7 @@ can replay the history instead of parsing it.
|
|
|
55
56
|
## One run, both channels
|
|
56
57
|
|
|
57
58
|
This program writes a lifecycle event and a telemetry event to the same run,
|
|
58
|
-
then reads the run back. It needs Node.js
|
|
59
|
+
then reads the run back. It needs Node.js 22.19.0 or later, where the built-in
|
|
59
60
|
SQLite module lives, and it writes a real `history.db` in the working
|
|
60
61
|
directory:
|
|
61
62
|
|