@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
@@ -0,0 +1,48 @@
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
+
8
+ import * as Context from "effect/Context"
9
+ import type * as Effect from "effect/Effect"
10
+ import type { RunId } from "../JournalEvent.ts"
11
+
12
+ /**
13
+ * Read-only observations of one journal instance.
14
+ *
15
+ * @category internal
16
+ * @since 1.0.0
17
+ */
18
+ export interface Observations {
19
+ readonly barrierCount: () => number
20
+ readonly policyRunCount: () => number
21
+ readonly admission: (runId: RunId) => Effect.Effect<
22
+ {
23
+ readonly gateClosed: boolean
24
+ readonly permitAvailable: boolean
25
+ } | undefined
26
+ >
27
+ }
28
+
29
+ /**
30
+ * Hooks installed before a journal instance is constructed.
31
+ *
32
+ * @category internal
33
+ * @since 1.0.0
34
+ */
35
+ export interface Observer {
36
+ readonly opened: (observations: Observations) => void
37
+ readonly drainRegistered: (runId: RunId) => void
38
+ }
39
+
40
+ /**
41
+ * Absent in ordinary use; tests inject their own instance-scoped observer.
42
+ *
43
+ * @category internal
44
+ * @since 1.0.0
45
+ */
46
+ export const JournalTestObserver = Context.Reference<Observer | undefined>("@smthrs/journal/JournalTestObserver", {
47
+ defaultValue: () => undefined
48
+ })
@@ -0,0 +1,31 @@
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
+
8
+ import * as Context from "effect/Context"
9
+
10
+ const encoder = new TextEncoder()
11
+
12
+ /**
13
+ * Real text operations, shared by snapshots unless a fiber provides its own.
14
+ *
15
+ * @category internal
16
+ * @since 1.0.0
17
+ */
18
+ export const operations = {
19
+ charCodeAt: (value: string, index: number): number => value.charCodeAt(index),
20
+ encode: (value: string): Uint8Array<ArrayBuffer> => encoder.encode(value)
21
+ }
22
+
23
+ /**
24
+ * Fiber-local text operations for measuring the work of a real snapshot.
25
+ *
26
+ * @category internal
27
+ * @since 1.0.0
28
+ */
29
+ export const TelemetryText = Context.Reference<typeof operations>("@smthrs/journal/TelemetryText", {
30
+ defaultValue: () => operations
31
+ })