@jam-overture/loom 0.1.0 → 0.2.0
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/README.md +3 -1
- package/dist/application/application.d.ts +109 -0
- package/dist/application/application.js +97 -0
- package/dist/application/memory.d.ts +20 -0
- package/dist/application/memory.js +79 -0
- package/dist/application/store.d.ts +101 -0
- package/dist/application/store.js +25 -0
- package/dist/audience/audience.d.ts +36 -0
- package/dist/audience/audience.js +41 -0
- package/dist/cli/templates.js +19 -0
- package/dist/data/plan.js +0 -0
- package/dist/data/resolution.d.ts +23 -1
- package/dist/data/resolve.d.ts +30 -3
- package/dist/data/resolve.js +11 -3
- package/dist/ids.d.ts +10 -0
- package/dist/ids.js +11 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/patch.d.ts +54 -0
- package/dist/patch.js +44 -0
- package/dist/project/closing.d.ts +51 -0
- package/dist/project/closing.js +53 -0
- package/dist/project/memory.d.ts +20 -0
- package/dist/project/memory.js +97 -0
- package/dist/project/project.d.ts +90 -0
- package/dist/project/project.js +91 -0
- package/dist/project/store.d.ts +135 -0
- package/dist/project/store.js +41 -0
- package/dist/registered.d.ts +64 -0
- package/dist/registered.js +118 -0
- package/dist/render/behaviour-adjust.d.ts +11 -19
- package/dist/render/behaviour-adjust.js +75 -21
- package/dist/render/behaviour-present.d.ts +8 -0
- package/dist/render/behaviour-present.js +57 -6
- package/dist/render/behaviour.d.ts +98 -17
- package/dist/render/behaviour.js +91 -26
- package/dist/render/control-name.d.ts +68 -0
- package/dist/render/control-name.js +37 -0
- package/dist/render/diagnostics.d.ts +72 -0
- package/dist/render/diagnostics.js +7 -0
- package/dist/render/index.d.ts +2 -0
- package/dist/render/index.js +2 -0
- package/dist/render/reads.d.ts +11 -0
- package/dist/render/reads.js +12 -1
- package/dist/render/render.js +102 -7
- package/dist/render/slots.d.ts +52 -0
- package/dist/render/slots.js +24 -0
- package/dist/render/theme.d.ts +54 -1
- package/dist/render/theme.js +23 -1
- package/dist/render/unshown.d.ts +152 -0
- package/dist/render/unshown.js +80 -0
- package/dist/runtime/analysis.d.ts +94 -9
- package/dist/runtime/analysis.js +54 -9
- package/dist/runtime/assessment.d.ts +36 -2
- package/dist/runtime/assessment.js +27 -2
- package/dist/runtime/checks.d.ts +148 -0
- package/dist/runtime/checks.js +112 -0
- package/dist/runtime/disposition.d.ts +96 -0
- package/dist/runtime/disposition.js +46 -0
- package/dist/runtime/gate.js +22 -0
- package/dist/runtime/index.d.ts +3 -0
- package/dist/runtime/index.js +3 -0
- package/dist/runtime/irreversibility.d.ts +64 -0
- package/dist/runtime/irreversibility.js +45 -0
- package/dist/runtime/pipeline.d.ts +43 -0
- package/dist/runtime/pipeline.js +10 -2
- package/dist/runtime/policy-change.d.ts +93 -0
- package/dist/runtime/policy-change.js +299 -0
- package/dist/runtime/policy-log.d.ts +406 -0
- package/dist/runtime/policy-log.js +285 -0
- package/dist/runtime/reversibility.d.ts +11 -9
- package/dist/runtime/stakes.d.ts +129 -1
- package/dist/runtime/stakes.js +240 -26
- package/dist/runtime/vocabulary.d.ts +164 -7
- package/dist/runtime/vocabulary.js +181 -8
- package/dist/sdk/audit.d.ts +174 -3
- package/dist/sdk/audit.js +176 -17
- package/dist/sdk/catalogue.d.ts +9 -1
- package/dist/sdk/conformance.d.ts +37 -3
- package/dist/sdk/conformance.js +25 -4
- package/dist/sdk/definition.d.ts +65 -0
- package/dist/sdk/definition.js +22 -0
- package/dist/sdk/registry.d.ts +29 -2
- package/dist/sdk/registry.js +63 -1
- package/dist/signals/action-change.d.ts +507 -0
- package/dist/signals/action-change.js +265 -0
- package/dist/signals/action.d.ts +331 -0
- package/dist/signals/action.js +182 -0
- package/dist/signals/applied-window.contract.d.ts +23 -0
- package/dist/signals/applied-window.contract.js +160 -0
- package/dist/signals/arriving.d.ts +210 -0
- package/dist/signals/arriving.js +133 -0
- package/dist/signals/audiences.d.ts +528 -0
- package/dist/signals/audiences.js +255 -0
- package/dist/signals/broadcast.d.ts +8 -2
- package/dist/signals/broadcast.js +58 -8
- package/dist/signals/change.d.ts +378 -0
- package/dist/signals/change.js +327 -0
- package/dist/signals/collect.d.ts +41 -0
- package/dist/signals/collect.js +88 -7
- package/dist/signals/copy-change.d.ts +553 -0
- package/dist/signals/copy-change.js +377 -0
- package/dist/signals/copy.d.ts +337 -0
- package/dist/signals/copy.js +211 -0
- package/dist/signals/counters.d.ts +46 -0
- package/dist/signals/counters.js +102 -0
- package/dist/signals/deliver.d.ts +23 -4
- package/dist/signals/deliver.js +34 -6
- package/dist/signals/deployment-change.d.ts +371 -0
- package/dist/signals/deployment-change.js +268 -0
- package/dist/signals/deployment.d.ts +265 -0
- package/dist/signals/deployment.js +152 -0
- package/dist/signals/door.d.ts +92 -0
- package/dist/signals/door.js +53 -0
- package/dist/signals/fold.d.ts +10 -0
- package/dist/signals/fold.js +5 -1
- package/dist/signals/form-action.d.ts +302 -0
- package/dist/signals/form-action.js +169 -0
- package/dist/signals/form-copy.d.ts +523 -0
- package/dist/signals/form-copy.js +346 -0
- package/dist/signals/forms.d.ts +247 -0
- package/dist/signals/forms.js +147 -0
- package/dist/signals/funnel-change.d.ts +548 -0
- package/dist/signals/funnel-change.js +361 -0
- package/dist/signals/funnel.d.ts +532 -0
- package/dist/signals/funnel.js +216 -0
- package/dist/signals/health.d.ts +497 -0
- package/dist/signals/health.js +361 -0
- package/dist/signals/index.d.ts +41 -0
- package/dist/signals/index.js +41 -0
- package/dist/signals/ingest.d.ts +56 -1
- package/dist/signals/ingest.js +91 -1
- package/dist/signals/journal.d.ts +11 -0
- package/dist/signals/kinds.d.ts +8 -6
- package/dist/signals/kinds.js +14 -6
- package/dist/signals/library-action.d.ts +430 -0
- package/dist/signals/library-action.js +336 -0
- package/dist/signals/library-change.d.ts +477 -0
- package/dist/signals/library-change.js +335 -0
- package/dist/signals/library-copy-change.d.ts +498 -0
- package/dist/signals/library-copy-change.js +476 -0
- package/dist/signals/library-pace.d.ts +319 -0
- package/dist/signals/library-pace.js +305 -0
- package/dist/signals/library-reach-change.d.ts +636 -0
- package/dist/signals/library-reach-change.js +534 -0
- package/dist/signals/library-reach.d.ts +377 -0
- package/dist/signals/library-reach.js +227 -0
- package/dist/signals/library-word-reach-change.d.ts +567 -0
- package/dist/signals/library-word-reach-change.js +568 -0
- package/dist/signals/library.d.ts +306 -0
- package/dist/signals/library.js +178 -0
- package/dist/signals/memory.d.ts +9 -0
- package/dist/signals/memory.js +105 -14
- package/dist/signals/migrate.d.ts +17 -2
- package/dist/signals/migrate.js +122 -5
- package/dist/signals/notice.d.ts +334 -0
- package/dist/signals/notice.js +228 -0
- package/dist/signals/pace-change.d.ts +501 -0
- package/dist/signals/pace-change.js +310 -0
- package/dist/signals/pace.d.ts +296 -0
- package/dist/signals/pace.js +291 -0
- package/dist/signals/page-views.d.ts +365 -0
- package/dist/signals/page-views.js +218 -0
- package/dist/signals/parts.d.ts +344 -0
- package/dist/signals/parts.js +273 -0
- package/dist/signals/postgres.d.ts +16 -2
- package/dist/signals/postgres.js +390 -87
- package/dist/signals/progress.d.ts +212 -0
- package/dist/signals/progress.js +150 -0
- package/dist/signals/ratios.d.ts +108 -0
- package/dist/signals/ratios.js +40 -0
- package/dist/signals/reach.d.ts +309 -0
- package/dist/signals/reach.js +93 -0
- package/dist/signals/readable.d.ts +34 -0
- package/dist/signals/readable.js +34 -0
- package/dist/signals/readership.d.ts +381 -0
- package/dist/signals/readership.js +308 -0
- package/dist/signals/region-pages.d.ts +173 -0
- package/dist/signals/region-pages.js +62 -0
- package/dist/signals/region.d.ts +287 -0
- package/dist/signals/region.js +198 -0
- package/dist/signals/retention.d.ts +141 -0
- package/dist/signals/retention.js +58 -0
- package/dist/signals/rollup.d.ts +67 -3
- package/dist/signals/rollup.js +0 -0
- package/dist/signals/schema.d.ts +432 -1
- package/dist/signals/schema.js +157 -3
- package/dist/signals/signal.d.ts +237 -11
- package/dist/signals/signal.js +70 -10
- package/dist/signals/silence-census.d.ts +205 -0
- package/dist/signals/silence-census.js +87 -0
- package/dist/signals/silences.d.ts +848 -0
- package/dist/signals/silences.js +753 -0
- package/dist/signals/tally.d.ts +140 -11
- package/dist/signals/window-figures.d.ts +148 -0
- package/dist/signals/window-figures.js +42 -0
- package/dist/signals/window.d.ts +866 -0
- package/dist/signals/window.js +693 -0
- package/dist/signals/words.d.ts +24 -0
- package/dist/signals/words.js +24 -0
- package/dist/store/index.d.ts +19 -0
- package/dist/store/index.js +19 -0
- package/dist/store/memory.d.ts +2 -1
- package/dist/store/memory.js +48 -12
- package/dist/store/migrate.d.ts +80 -0
- package/dist/store/migrate.js +259 -7
- package/dist/store/postgres-applications.d.ts +4 -0
- package/dist/store/postgres-applications.js +197 -0
- package/dist/store/postgres-holds.d.ts +10 -1
- package/dist/store/postgres-holds.js +116 -101
- package/dist/store/postgres-policy-log.d.ts +14 -0
- package/dist/store/postgres-policy-log.js +240 -0
- package/dist/store/postgres-projects.d.ts +4 -0
- package/dist/store/postgres-projects.js +217 -0
- package/dist/store/postgres.d.ts +16 -1
- package/dist/store/postgres.js +59 -9
- package/dist/store/replay.d.ts +102 -1
- package/dist/store/replay.js +190 -19
- package/dist/store/reseed.d.ts +238 -0
- package/dist/store/reseed.js +308 -0
- package/dist/store/schema.d.ts +450 -2
- package/dist/store/schema.js +141 -5
- package/dist/store/store.d.ts +29 -6
- package/dist/submit/resolve.js +2 -1
- package/dist/telemetry/calibration.d.ts +25 -0
- package/dist/telemetry/calibration.js +27 -1
- package/dist/telemetry/event.d.ts +391 -33
- package/dist/telemetry/event.js +84 -20
- package/dist/telemetry/index.d.ts +1 -0
- package/dist/telemetry/index.js +1 -0
- package/dist/telemetry/journal.d.ts +72 -3
- package/dist/telemetry/journal.js +9 -0
- package/dist/telemetry/lookup.d.ts +27 -0
- package/dist/telemetry/lookup.js +18 -0
- package/dist/telemetry/memory.js +23 -0
- package/dist/telemetry/migrate.js +22 -1
- package/dist/telemetry/postgres.d.ts +10 -1
- package/dist/telemetry/postgres.js +172 -90
- package/dist/telemetry/remeasure.d.ts +78 -0
- package/dist/telemetry/remeasure.js +83 -0
- package/dist/telemetry/retention.d.ts +2 -2
- package/dist/telemetry/schema.d.ts +17 -0
- package/dist/telemetry/schema.js +27 -1
- package/dist/telemetry/sink.d.ts +2 -2
- package/dist/testing/application-contract.d.ts +14 -0
- package/dist/testing/application-contract.js +270 -0
- package/dist/testing/contracts.d.ts +12 -7
- package/dist/testing/contracts.js +12 -7
- package/dist/testing/definitions.d.ts +78 -0
- package/dist/testing/definitions.js +134 -9
- package/dist/testing/doubles.d.ts +103 -0
- package/dist/testing/doubles.js +143 -0
- package/dist/testing/index.d.ts +2 -2
- package/dist/testing/index.js +2 -2
- package/dist/testing/journal-contract.js +140 -2
- package/dist/testing/model-contract.d.ts +110 -0
- package/dist/testing/model-contract.js +150 -0
- package/dist/testing/policy-log-contract.d.ts +26 -0
- package/dist/testing/policy-log-contract.js +344 -0
- package/dist/testing/project-contract.d.ts +14 -0
- package/dist/testing/project-contract.js +266 -0
- package/dist/testing/reader-signal-contract.d.ts +27 -2
- package/dist/testing/reader-signal-contract.js +475 -5
- package/dist/testing/store-contract.d.ts +7 -1
- package/dist/testing/store-contract.js +84 -3
- package/dist/theme/apply.d.ts +20 -1
- package/dist/theme/apply.js +5 -3
- package/dist/theme/derive.d.ts +22 -0
- package/dist/theme/derive.js +54 -1
- package/dist/theme/library.js +1 -1
- package/dist/theme/measure.d.ts +34 -0
- package/dist/theme/measure.js +30 -1
- package/dist/theme/palettes.js +7 -7
- package/dist/theme/ramp.d.ts +64 -0
- package/dist/theme/ramp.js +114 -0
- package/dist/theme/registry.d.ts +9 -0
- package/dist/theme/registry.js +11 -1
- package/dist/theme/separation.d.ts +97 -3
- package/dist/theme/separation.js +75 -0
- package/dist/tree/compare.d.ts +9 -0
- package/dist/tree/compare.js +18 -0
- package/dist/write/computed.d.ts +60 -0
- package/dist/write/computed.js +61 -0
- package/dist/write/held.d.ts +59 -0
- package/dist/write/index.d.ts +5 -2
- package/dist/write/index.js +5 -2
- package/dist/write/reseed.d.ts +151 -0
- package/dist/write/reseed.js +184 -0
- package/dist/write/revert.js +2 -16
- package/package.json +98 -19
package/dist/telemetry/event.js
CHANGED
|
@@ -4,9 +4,11 @@ import { primitiveTypeSchema } from "../primitive-type.js";
|
|
|
4
4
|
import { assertNever } from "../result.js";
|
|
5
5
|
import { dispositionReasonSchema, dispositionSchema, } from "../runtime/disposition.js";
|
|
6
6
|
import { intentOriginSchema } from "../runtime/intent.js";
|
|
7
|
+
import { outOfTreeEffectTypesOf } from "../runtime/irreversibility.js";
|
|
7
8
|
import { policyFingerprintOf } from "../runtime/policy-fingerprint.js";
|
|
8
9
|
import { proposedChangeSchema } from "../runtime/proposal.js";
|
|
9
10
|
import { stakeLevelSchema } from "../runtime/stake-level.js";
|
|
11
|
+
import { stakeFactorCodeSchema } from "../runtime/stakes.js";
|
|
10
12
|
import { describeStoreError } from "../store/errors.js";
|
|
11
13
|
import { describeTreeError } from "../tree/errors.js";
|
|
12
14
|
/**
|
|
@@ -81,17 +83,72 @@ export const assessmentSummarySchema = z.object({
|
|
|
81
83
|
configuredNodeCount: z.number().int().nonnegative(),
|
|
82
84
|
touchedPrimitiveTypes: z.array(primitiveTypeSchema),
|
|
83
85
|
/**
|
|
84
|
-
* Bounded, non-identifying, a subset of the touched types, and
|
|
85
|
-
*
|
|
86
|
-
*
|
|
86
|
+
* Bounded, non-identifying, a subset of the touched types, and *which* types a
|
|
87
|
+
* removal destroyed. It was written as the input to "the only `critical` stake
|
|
88
|
+
* factor", which it no longer is — two later rules reach that level (0173,
|
|
89
|
+
* 0179), and `stakeFactorCodes` below carries all thirteen. What is left is
|
|
90
|
+
* the half a code cannot say: `protected-type-removed` says a rule fired, this
|
|
91
|
+
* says what it fired about.
|
|
87
92
|
*/
|
|
88
93
|
removedPrimitiveTypes: z.array(primitiveTypeSchema).optional(),
|
|
89
94
|
relocatedPrimitiveTypes: z.array(primitiveTypeSchema).optional(),
|
|
90
95
|
relocatedNodeCount: z.number().int().nonnegative().optional(),
|
|
91
96
|
shallowestAffectedDepth: z.number().int().nonnegative(),
|
|
97
|
+
/**
|
|
98
|
+
* How many nodes the change named, which is the one thing `broad-change`
|
|
99
|
+
* reads. `affectedNodeIds` itself is content — the ids name parts of a
|
|
100
|
+
* particular page and do not cross (0023) — and the rule compares its
|
|
101
|
+
* *length* against `breadthThreshold`, so the count is the whole of what a
|
|
102
|
+
* later reader needs and the ids never have to be journalled.
|
|
103
|
+
*/
|
|
104
|
+
affectedNodeCount: z.number().int().nonnegative().optional(),
|
|
105
|
+
/**
|
|
106
|
+
* The prop names the change set, which is the only input to
|
|
107
|
+
* `protected-prop-configured`.
|
|
108
|
+
*
|
|
109
|
+
* Names and not values: a key is vocabulary the host registered, where a value
|
|
110
|
+
* is what a visitor will read. Bounded by the declaration that accepts them,
|
|
111
|
+
* for the reason `touchedPrimitiveTypes` is bounded by the catalogue.
|
|
112
|
+
*/
|
|
113
|
+
configuredPropKeys: z.array(z.string().min(1)).optional(),
|
|
92
114
|
/** Nodes the inverse would have to carry — the content a removal destroyed. */
|
|
93
115
|
retainedNodeCount: z.number().int().nonnegative(),
|
|
94
116
|
irreversibilityReasons: z.array(z.string().min(1)),
|
|
117
|
+
/**
|
|
118
|
+
* Which of the touched types this policy declared reach outside the page.
|
|
119
|
+
*
|
|
120
|
+
* `irreversibilityReasons` above keeps the codes, and for
|
|
121
|
+
* `retention-budget-exceeded` that is almost lossless — `retainedNodeCount`
|
|
122
|
+
* is journalled beside it, so a screen can say *this one takes nine parts off
|
|
123
|
+
* the page*. For `out-of-tree-effect` the code alone leaves a reader told to
|
|
124
|
+
* go and check something and not told what, and `touchedPrimitiveTypes` above
|
|
125
|
+
* cannot answer it: it is a superset, and naming one of its members as the
|
|
126
|
+
* offender would be a guess on the screen where a guess costs most.
|
|
127
|
+
*
|
|
128
|
+
* Non-identifying for the reason `removedPrimitiveTypes` above is: a type
|
|
129
|
+
* name is vocabulary the deployment registered, not content a visitor typed.
|
|
130
|
+
* Absent when no out-of-tree reason fired, and on a record written before the
|
|
131
|
+
* field existed (0045).
|
|
132
|
+
*/
|
|
133
|
+
outOfTreeEffectTypes: z.array(primitiveTypeSchema).optional(),
|
|
134
|
+
/**
|
|
135
|
+
* Which rules the Gate raised, in the order it raised them (0198).
|
|
136
|
+
*
|
|
137
|
+
* `stakes` above is the highest level any of them reached, which is what the
|
|
138
|
+
* Gate compares against a ceiling and is not what a reader of the record wants
|
|
139
|
+
* to know. Three factors are `critical`, so *this project refused four changes
|
|
140
|
+
* as too risky* and *this project refused four changes because the model
|
|
141
|
+
* invented parts that do not exist here* were the same row, and only the
|
|
142
|
+
* second is something an operator can act on.
|
|
143
|
+
*
|
|
144
|
+
* The codes and not the factors: a code is one of thirteen fixed strings,
|
|
145
|
+
* while a factor's `detail` is a sentence naming nodes and types, which is
|
|
146
|
+
* content and does not cross (0023). The level does not cross either, because
|
|
147
|
+
* it is recoverable — twelve of the thirteen are fixed at their code, and
|
|
148
|
+
* `large-removal` is decided by `removedNodeCount` here against the
|
|
149
|
+
* `removalThresholds` of the policy `policyFingerprint` names.
|
|
150
|
+
*/
|
|
151
|
+
stakeFactorCodes: z.array(stakeFactorCodeSchema).optional(),
|
|
95
152
|
});
|
|
96
153
|
export const telemetryEventSchema = z.discriminatedUnion("type", [
|
|
97
154
|
z.object({ type: z.literal("intent-received"), intent: intentSummarySchema }),
|
|
@@ -222,23 +279,30 @@ const summariseIntent = (intent) => ({
|
|
|
222
279
|
utteranceLength: intent.utterance.length,
|
|
223
280
|
observedAt: intent.observedAt,
|
|
224
281
|
});
|
|
225
|
-
const summariseAssessment = (assessment) =>
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
282
|
+
const summariseAssessment = (assessment) => {
|
|
283
|
+
const outOfTreeEffectTypes = outOfTreeEffectTypesOf(assessment.reversibility.reasons);
|
|
284
|
+
return {
|
|
285
|
+
proposalId: assessment.proposal.proposalId,
|
|
286
|
+
stakes: assessment.stakes.level,
|
|
287
|
+
reversible: assessment.reversibility.reversible,
|
|
288
|
+
operationCount: assessment.analysis.operationCount,
|
|
289
|
+
insertedNodeCount: assessment.analysis.insertedNodeCount,
|
|
290
|
+
removedNodeCount: assessment.analysis.removedNodeCount,
|
|
291
|
+
movedNodeCount: assessment.analysis.movedNodeCount,
|
|
292
|
+
configuredNodeCount: assessment.analysis.configuredNodeCount,
|
|
293
|
+
touchedPrimitiveTypes: assessment.analysis.touchedPrimitiveTypes,
|
|
294
|
+
removedPrimitiveTypes: assessment.analysis.removedPrimitiveTypes,
|
|
295
|
+
relocatedPrimitiveTypes: assessment.analysis.relocatedPrimitiveTypes,
|
|
296
|
+
relocatedNodeCount: assessment.analysis.relocatedNodeCount,
|
|
297
|
+
shallowestAffectedDepth: assessment.analysis.shallowestAffectedDepth,
|
|
298
|
+
affectedNodeCount: assessment.analysis.affectedNodeIds.length,
|
|
299
|
+
configuredPropKeys: assessment.analysis.configuredPropKeys,
|
|
300
|
+
retainedNodeCount: assessment.reversibility.retainedNodeCount,
|
|
301
|
+
irreversibilityReasons: assessment.reversibility.reasons.map((reason) => reason.code),
|
|
302
|
+
...(outOfTreeEffectTypes.length > 0 ? { outOfTreeEffectTypes } : {}),
|
|
303
|
+
stakeFactorCodes: assessment.stakes.factors.map((factor) => factor.code),
|
|
304
|
+
};
|
|
305
|
+
};
|
|
242
306
|
/**
|
|
243
307
|
* The narrowing, as one total function. Every variant is handled and the
|
|
244
308
|
* exhaustiveness guard is what makes adding a `RuntimeEvent` a compile error
|
|
@@ -10,6 +10,7 @@ export * from "./episode.js";
|
|
|
10
10
|
export * from "./event.js";
|
|
11
11
|
export * from "./journal.js";
|
|
12
12
|
export * from "./memory.js";
|
|
13
|
+
export * from "./remeasure.js";
|
|
13
14
|
export * from "./retention.js";
|
|
14
15
|
export * from "./sink.js";
|
|
15
16
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/telemetry/index.js
CHANGED
|
@@ -10,6 +10,7 @@ export * from "./episode.js";
|
|
|
10
10
|
export * from "./event.js";
|
|
11
11
|
export * from "./journal.js";
|
|
12
12
|
export * from "./memory.js";
|
|
13
|
+
export * from "./remeasure.js";
|
|
13
14
|
export * from "./retention.js";
|
|
14
15
|
export * from "./sink.js";
|
|
15
16
|
//# sourceMappingURL=index.js.map
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import type { TreeId } from "../ids.js";
|
|
1
|
+
import type { ProposalId, TreeId } from "../ids.js";
|
|
2
2
|
import { type PageDirection, type PageEnds } from "../paging.js";
|
|
3
3
|
import type { Result } from "../result.js";
|
|
4
|
-
import type { TelemetryRecord } from "./event.js";
|
|
4
|
+
import type { AssessmentSummary, TelemetryRecord } from "./event.js";
|
|
5
5
|
/**
|
|
6
6
|
* Where the narrated runtime goes to be read later.
|
|
7
7
|
*
|
|
@@ -77,6 +77,56 @@ export type TelemetryPage = PageEnds & {
|
|
|
77
77
|
export declare const DEFAULT_TELEMETRY_LIMIT = 200;
|
|
78
78
|
export declare const MAX_TELEMETRY_LIMIT = 1000;
|
|
79
79
|
export declare const clampTelemetryLimit: (limit: number | undefined) => number;
|
|
80
|
+
/**
|
|
81
|
+
* What a consumer asks when it is holding a list of proposals and wants the
|
|
82
|
+
* Gate's reading of each one.
|
|
83
|
+
*
|
|
84
|
+
* This is the join 0225 chose over a copy. The revision log holds a
|
|
85
|
+
* `proposalId` and no judgment, because 0016 makes the log the truth about the
|
|
86
|
+
* *page* and whether a change reached outside the page is not a fact about the
|
|
87
|
+
* page. The fact is therefore reachable, and until now only by paging a journal
|
|
88
|
+
* that grows forever — which on a screen showing twenty revisions is either
|
|
89
|
+
* twenty reads or a scan of everything ever narrated about the tree.
|
|
90
|
+
*
|
|
91
|
+
* `treeId` is the same filter `read` takes and the same thing it is there: a
|
|
92
|
+
* narrowing, not a boundary. What a handle may see at all is settled when the
|
|
93
|
+
* host builds it (0020), and a `proposalId` is unique without it.
|
|
94
|
+
*/
|
|
95
|
+
export type AssessmentLookup = {
|
|
96
|
+
readonly proposalIds: readonly ProposalId[];
|
|
97
|
+
/** Absent looks across every tree the handle can see, as `read` does. */
|
|
98
|
+
readonly treeId?: TreeId;
|
|
99
|
+
};
|
|
100
|
+
/**
|
|
101
|
+
* The assessments that were found, and the ids this lookup did not reach.
|
|
102
|
+
*
|
|
103
|
+
* **A proposal nothing was recorded about is absent from the map, not an
|
|
104
|
+
* error** — the same reason there is no `not-found` above: a journal makes no
|
|
105
|
+
* claim that anything exists. A disposition without an assessment is a real
|
|
106
|
+
* history, not a fault; the Gate narrates `assessment-failed` when analysis
|
|
107
|
+
* itself fell over, and that record carries no summary to find.
|
|
108
|
+
*
|
|
109
|
+
* `unasked` exists because the alternative is a screen that quietly says
|
|
110
|
+
* nothing about a row. Every read in Loom is bounded, so a lookup naming more
|
|
111
|
+
* than `MAX_ASSESSMENT_LOOKUP` proposals cannot answer all of them in one call
|
|
112
|
+
* — and truncating silently would make *not looked up* and *nothing recorded*
|
|
113
|
+
* the same empty answer at the one place a reader is being asked to decide
|
|
114
|
+
* something. Naming the remainder costs one array and lets a caller chunk
|
|
115
|
+
* without arithmetic.
|
|
116
|
+
*/
|
|
117
|
+
export type AssessmentLookupResult = {
|
|
118
|
+
readonly assessments: ReadonlyMap<ProposalId, AssessmentSummary>;
|
|
119
|
+
readonly unasked: readonly ProposalId[];
|
|
120
|
+
};
|
|
121
|
+
/**
|
|
122
|
+
* How many proposals one lookup answers, and it is a cap rather than a clamp.
|
|
123
|
+
*
|
|
124
|
+
* Deliberately larger than `MAX_LISTING_LIMIT`, so a caller that paged
|
|
125
|
+
* revisions at the store's widest page and asked about every one of them never
|
|
126
|
+
* meets this number. It bounds a hostile or careless caller and not the real
|
|
127
|
+
* one, which is the only job it has.
|
|
128
|
+
*/
|
|
129
|
+
export declare const MAX_ASSESSMENT_LOOKUP = 400;
|
|
80
130
|
/**
|
|
81
131
|
* What a journal is asked to forget, expressed as a position rather than a rule.
|
|
82
132
|
*
|
|
@@ -94,7 +144,7 @@ export type ForgetOutcome = {
|
|
|
94
144
|
readonly removed: number;
|
|
95
145
|
};
|
|
96
146
|
/**
|
|
97
|
-
*
|
|
147
|
+
* Four operations, and the asymmetry is deliberate: writes arrive in batches
|
|
98
148
|
* because a request narrates several stages and should pay for one round trip
|
|
99
149
|
* (0024), while reads are paged because a journal only grows.
|
|
100
150
|
*
|
|
@@ -103,6 +153,12 @@ export type ForgetOutcome = {
|
|
|
103
153
|
* it: an episode missing its disposition reads as a change that was proposed
|
|
104
154
|
* and never judged, which is a fault report rather than a gap.
|
|
105
155
|
*
|
|
156
|
+
* `assessments` is the only read that is not a page, and the exception earns
|
|
157
|
+
* itself: it answers about a *set of proposals a caller already holds* rather
|
|
158
|
+
* than about a position in the journal, so a cursor would be answering a
|
|
159
|
+
* question nobody asked. It is bounded all the same — by how many ids it will
|
|
160
|
+
* look at, which is the same promise a limit makes in a different currency.
|
|
161
|
+
*
|
|
106
162
|
* `forget` is the only destructive operation anywhere in Loom's storage, and it
|
|
107
163
|
* is on the journal rather than the store for the reason 0016 gives: telemetry
|
|
108
164
|
* is narrowed from a log that keeps the truth, so forgetting it loses history
|
|
@@ -111,6 +167,19 @@ export type ForgetOutcome = {
|
|
|
111
167
|
export interface TelemetryJournal {
|
|
112
168
|
readonly record: (records: readonly TelemetryRecord[]) => Promise<Result<void, TelemetryError>>;
|
|
113
169
|
readonly read: (request?: TelemetryReadRequest) => Promise<Result<TelemetryPage, TelemetryError>>;
|
|
170
|
+
readonly assessments: (request: AssessmentLookup) => Promise<Result<AssessmentLookupResult, TelemetryError>>;
|
|
114
171
|
readonly forget: (request: ForgetRequest) => Promise<Result<ForgetOutcome, TelemetryError>>;
|
|
115
172
|
}
|
|
173
|
+
/**
|
|
174
|
+
* The halves of the journal its two in-package consumers actually use.
|
|
175
|
+
*
|
|
176
|
+
* The argument is `TreeReader`'s, and a fourth method is the event that made it
|
|
177
|
+
* worth repeating here: depending on the whole journal to prune it or to write
|
|
178
|
+
* to it makes every stub of either grow a method the code under test never
|
|
179
|
+
* calls, which is how a test starts describing the interface instead of the
|
|
180
|
+
* behaviour. A `TelemetryJournal` satisfies both, so nothing a host builds
|
|
181
|
+
* changes.
|
|
182
|
+
*/
|
|
183
|
+
export type TelemetryPruner = Pick<TelemetryJournal, "read" | "forget">;
|
|
184
|
+
export type TelemetryWriter = Pick<TelemetryJournal, "record">;
|
|
116
185
|
//# sourceMappingURL=journal.d.ts.map
|
|
@@ -8,4 +8,13 @@ export const describeTelemetryError = (error) => `telemetry is unavailable: ${er
|
|
|
8
8
|
export const DEFAULT_TELEMETRY_LIMIT = 200;
|
|
9
9
|
export const MAX_TELEMETRY_LIMIT = 1000;
|
|
10
10
|
export const clampTelemetryLimit = (limit) => clampLimit(limit, { fallback: DEFAULT_TELEMETRY_LIMIT, max: MAX_TELEMETRY_LIMIT });
|
|
11
|
+
/**
|
|
12
|
+
* How many proposals one lookup answers, and it is a cap rather than a clamp.
|
|
13
|
+
*
|
|
14
|
+
* Deliberately larger than `MAX_LISTING_LIMIT`, so a caller that paged
|
|
15
|
+
* revisions at the store's widest page and asked about every one of them never
|
|
16
|
+
* meets this number. It bounds a hostile or careless caller and not the real
|
|
17
|
+
* one, which is the only job it has.
|
|
18
|
+
*/
|
|
19
|
+
export const MAX_ASSESSMENT_LOOKUP = 400;
|
|
11
20
|
//# sourceMappingURL=journal.js.map
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { ProposalId } from "../ids.js";
|
|
2
|
+
/**
|
|
3
|
+
* The arithmetic both journals do before they go looking, kept in one place so
|
|
4
|
+
* they cannot disagree about it.
|
|
5
|
+
*
|
|
6
|
+
* Deliberately not exported from the package. What a host needs to know is the
|
|
7
|
+
* cap and that a lookup says which ids it did not reach — both of which are on
|
|
8
|
+
* the contract. How the split is computed is not a published name, and a module
|
|
9
|
+
* nothing re-exports is the only way to say so (0045 is about fields; this is
|
|
10
|
+
* the same instinct about surface).
|
|
11
|
+
*/
|
|
12
|
+
export type LookupSplit = {
|
|
13
|
+
/** Distinct, in the order the caller named them, capped. */
|
|
14
|
+
readonly asked: readonly ProposalId[];
|
|
15
|
+
readonly unasked: readonly ProposalId[];
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* Distinct first, then capped.
|
|
19
|
+
*
|
|
20
|
+
* The other order would let a caller spend its whole allowance on one id
|
|
21
|
+
* repeated four hundred times and be told the rest were unasked — true, and
|
|
22
|
+
* useless. Insertion order is kept because a caller that chunks `unasked` is
|
|
23
|
+
* walking its own list, and a lookup that reordered it would make the second
|
|
24
|
+
* call's result harder to line up than the first's.
|
|
25
|
+
*/
|
|
26
|
+
export declare const splitLookup: (proposalIds: readonly ProposalId[]) => LookupSplit;
|
|
27
|
+
//# sourceMappingURL=lookup.d.ts.map
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { MAX_ASSESSMENT_LOOKUP } from "./journal.js";
|
|
2
|
+
/**
|
|
3
|
+
* Distinct first, then capped.
|
|
4
|
+
*
|
|
5
|
+
* The other order would let a caller spend its whole allowance on one id
|
|
6
|
+
* repeated four hundred times and be told the rest were unasked — true, and
|
|
7
|
+
* useless. Insertion order is kept because a caller that chunks `unasked` is
|
|
8
|
+
* walking its own list, and a lookup that reordered it would make the second
|
|
9
|
+
* call's result harder to line up than the first's.
|
|
10
|
+
*/
|
|
11
|
+
export const splitLookup = (proposalIds) => {
|
|
12
|
+
const distinct = [...new Set(proposalIds)];
|
|
13
|
+
return {
|
|
14
|
+
asked: distinct.slice(0, MAX_ASSESSMENT_LOOKUP),
|
|
15
|
+
unasked: distinct.slice(MAX_ASSESSMENT_LOOKUP),
|
|
16
|
+
};
|
|
17
|
+
};
|
|
18
|
+
//# sourceMappingURL=lookup.js.map
|
package/dist/telemetry/memory.js
CHANGED
|
@@ -2,6 +2,7 @@ import { cursorPosition, pageEnds } from "../paging.js";
|
|
|
2
2
|
import { ok } from "../result.js";
|
|
3
3
|
import { systemClock } from "../runtime/events.js";
|
|
4
4
|
import { clampTelemetryLimit, } from "./journal.js";
|
|
5
|
+
import { splitLookup } from "./lookup.js";
|
|
5
6
|
/**
|
|
6
7
|
* The telemetry journal that keeps its records in the process.
|
|
7
8
|
*
|
|
@@ -59,6 +60,28 @@ export const memoryTelemetryJournal = (clock = systemClock) => {
|
|
|
59
60
|
}),
|
|
60
61
|
}));
|
|
61
62
|
},
|
|
63
|
+
/**
|
|
64
|
+
* A scan, because an array has no index — and the reference implementation
|
|
65
|
+
* is where the contract is written, not where it is made fast. What it has
|
|
66
|
+
* to get right is the answer: the *latest* assessment of a proposal wins, so
|
|
67
|
+
* it folds in arrival order and lets a later record overwrite an earlier
|
|
68
|
+
* one.
|
|
69
|
+
*/
|
|
70
|
+
assessments: ({ proposalIds, treeId }) => {
|
|
71
|
+
const { asked, unasked } = splitLookup(proposalIds);
|
|
72
|
+
const wanted = new Set(asked);
|
|
73
|
+
const found = new Map();
|
|
74
|
+
for (const record of records) {
|
|
75
|
+
if (treeId !== undefined && record.treeId !== treeId)
|
|
76
|
+
continue;
|
|
77
|
+
if (record.event.type !== "change-assessed")
|
|
78
|
+
continue;
|
|
79
|
+
if (!wanted.has(record.event.assessment.proposalId))
|
|
80
|
+
continue;
|
|
81
|
+
found.set(record.event.assessment.proposalId, record.event.assessment);
|
|
82
|
+
}
|
|
83
|
+
return Promise.resolve(ok({ assessments: found, unasked }));
|
|
84
|
+
},
|
|
62
85
|
/**
|
|
63
86
|
* `nextSeq` is deliberately not rewound. A forgotten position must never be
|
|
64
87
|
* handed out again: a cursor a reader is holding across a prune would
|
|
@@ -22,13 +22,34 @@ import { sql } from "drizzle-orm";
|
|
|
22
22
|
*/
|
|
23
23
|
export const TELEMETRY_DDL = [
|
|
24
24
|
`CREATE TABLE IF NOT EXISTS loom_telemetry (
|
|
25
|
+
application_id text NOT NULL DEFAULT 'app_default',
|
|
25
26
|
seq bigserial PRIMARY KEY,
|
|
26
27
|
tree_id text NOT NULL,
|
|
27
28
|
occurred_at text NOT NULL,
|
|
28
29
|
event jsonb NOT NULL,
|
|
29
30
|
recorded_at timestamptz NOT NULL DEFAULT now()
|
|
30
31
|
)`,
|
|
31
|
-
|
|
32
|
+
/*
|
|
33
|
+
* **The project, for a database that predates it (0260).** No key widens
|
|
34
|
+
* here — `seq` is a surrogate and stays unique across the deployment, for the
|
|
35
|
+
* reason `schema.ts` gives. What changes is that both indexes lead with the
|
|
36
|
+
* project, so a read inside one does not walk another's rows.
|
|
37
|
+
*
|
|
38
|
+
* Dropped by name rather than created `IF NOT EXISTS`, because the names do
|
|
39
|
+
* not change: an existing index on the old columns would be left exactly as
|
|
40
|
+
* it was, and every read would go on scanning while appearing to be indexed.
|
|
41
|
+
*/
|
|
42
|
+
`ALTER TABLE loom_telemetry ADD COLUMN IF NOT EXISTS application_id text NOT NULL DEFAULT 'app_default'`,
|
|
43
|
+
`DROP INDEX IF EXISTS loom_telemetry_tree_seq_idx`,
|
|
44
|
+
`CREATE INDEX IF NOT EXISTS loom_telemetry_tree_seq_idx ON loom_telemetry (application_id, tree_id, seq)`,
|
|
45
|
+
/**
|
|
46
|
+
* Additive, idempotent, and the only statement here that is not about the
|
|
47
|
+
* table's shape: it is what makes `assessments` on the journal a seek rather
|
|
48
|
+
* than a scan of everything ever narrated. A deployment that runs the DDL
|
|
49
|
+
* again gets it; one that never does keeps a correct journal and a slow lookup.
|
|
50
|
+
*/
|
|
51
|
+
`DROP INDEX IF EXISTS loom_telemetry_assessed_proposal_idx`,
|
|
52
|
+
`CREATE INDEX IF NOT EXISTS loom_telemetry_assessed_proposal_idx ON loom_telemetry (application_id, (event -> 'assessment' ->> 'proposalId')) WHERE event ->> 'type' = 'change-assessed'`,
|
|
32
53
|
`ALTER TABLE loom_telemetry ENABLE ROW LEVEL SECURITY`,
|
|
33
54
|
];
|
|
34
55
|
/** Idempotent, so running it against a populated database is a no-op. */
|
|
@@ -1,6 +1,15 @@
|
|
|
1
|
+
import { type StoreScope } from "../application/application.js";
|
|
1
2
|
import type { LoomDatabase } from "../store/database.js";
|
|
2
3
|
import { type TelemetryJournal } from "./journal.js";
|
|
3
4
|
export * from "./migrate.js";
|
|
4
5
|
export * from "./schema.js";
|
|
5
|
-
|
|
6
|
+
/**
|
|
7
|
+
* Every query is filtered by the project this handle speaks for (0260), and
|
|
8
|
+
* every write sets it.
|
|
9
|
+
*
|
|
10
|
+
* `seq` is not scoped and does not need to be — see `schema.ts`. What is scoped
|
|
11
|
+
* is every row this handle will ever see, so one project's gate decisions
|
|
12
|
+
* cannot appear on another's screen.
|
|
13
|
+
*/
|
|
14
|
+
export declare const postgresTelemetryJournal: (db: LoomDatabase, scope?: StoreScope) => TelemetryJournal;
|
|
6
15
|
//# sourceMappingURL=postgres.d.ts.map
|