@celilo/cli 0.15.0 → 0.16.2
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/CELILO_SUBSYSTEMS.md +1 -0
- package/package.json +3 -3
- package/src/cli/commands/module-config.test.ts +77 -1
- package/src/cli/commands/module-config.ts +45 -3
- package/src/cli/commands/module-journal.test.ts +47 -0
- package/src/cli/commands/module-journal.ts +98 -0
- package/src/cli/completion.ts +2 -0
- package/src/cli/generate-zsh-completion.ts +4 -0
- package/src/cli/index.ts +3 -0
- package/src/module/packaging/release-metadata.test.ts +77 -3
- package/src/module/packaging/release-metadata.ts +11 -1
- package/src/services/alerting/inbound-poller.test.ts +191 -0
- package/src/services/alerting/inbound-poller.ts +31 -7
- package/src/services/alerting/inbound.test.ts +213 -2
- package/src/services/alerting/inbound.ts +161 -32
- package/src/services/alerting/interview-responder.test.ts +0 -32
- package/src/services/alerting/interview-responder.ts +6 -17
- package/src/services/alerting/tokens.ts +39 -1
- package/src/services/module-journal.test.ts +302 -0
- package/src/services/module-journal.ts +160 -0
|
@@ -12,20 +12,52 @@
|
|
|
12
12
|
* A message from an address matching no route is discarded and logged WITHOUT
|
|
13
13
|
* a reply. Replying would confirm the number is live and that this is a celilo
|
|
14
14
|
* instance, which is free reconnaissance for anyone probing.
|
|
15
|
+
*
|
|
16
|
+
* ── ORDER MATTERS: RESOLVE THE TOKEN, THEN PICK THE GRAMMAR ────────────────
|
|
17
|
+
*
|
|
18
|
+
* The same table carries alert pages and deploy questions, and they want
|
|
19
|
+
* OPPOSITE parsing. An alert reply is a token and at most a verb; anything
|
|
20
|
+
* wordier is refused, because `<token> resolve` silently acknowledging an
|
|
21
|
+
* alert the operator meant to escalate is the worst outcome here. An interview
|
|
22
|
+
* answer is a token followed by arbitrary text, because the text IS the answer.
|
|
23
|
+
*
|
|
24
|
+
* Parsing before resolving cannot serve both, and #533 is what that cost: the
|
|
25
|
+
* alert grammar ran first, read every real answer as a sentence, and rejected
|
|
26
|
+
* it before the poller could ever see it was a question. The feature was dead
|
|
27
|
+
* for months and the operator was told `unrecognised`, which reads as their
|
|
28
|
+
* typing being wrong.
|
|
29
|
+
*
|
|
30
|
+
* A delivery knows its own kind, so the token is resolved FIRST and the
|
|
31
|
+
* grammar chosen from what it named. Which rule applies was never a property
|
|
32
|
+
* of the text.
|
|
15
33
|
*/
|
|
16
34
|
|
|
17
35
|
import { eq } from 'drizzle-orm';
|
|
18
36
|
import type { DbClient } from '../../db/client';
|
|
19
37
|
import { type NotificationDelivery, type Route, routes } from '../../db/schema';
|
|
20
|
-
import {
|
|
38
|
+
import { findLiveDeliveriesByPrefix, normaliseToken } from './tokens';
|
|
21
39
|
|
|
22
40
|
/**
|
|
23
|
-
* v1 grammar: a
|
|
24
|
-
*
|
|
25
|
-
*
|
|
41
|
+
* v1 grammar: a token acknowledges. `snooze` and `resolve` verbs are deferred —
|
|
42
|
+
* ack is what an operator does at 3am, and every extra verb is another thing to
|
|
43
|
+
* mistype under stress.
|
|
26
44
|
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
45
|
+
* Deliberately forgiving about everything EXCEPT what the message means. An
|
|
46
|
+
* earlier cut accepted `<token> ack` but not `ack <token>`, so an operator who
|
|
47
|
+
* read "reply BPRJEH" and typed the natural "ack BPRJEH" was refused — the verb
|
|
48
|
+
* was parsed as the token, failed the length check, and the reply was rejected.
|
|
49
|
+
* That is a real page going unacknowledged over word order, so:
|
|
50
|
+
*
|
|
51
|
+
* - the ack verb may come BEFORE the token, AFTER it, or not at all
|
|
52
|
+
* - case never matters, for the verb or the token
|
|
53
|
+
* - the token may be shortened to any unambiguous prefix (see below)
|
|
54
|
+
*
|
|
55
|
+
* `token` here is a CANDIDATE, not necessarily a whole token: resolution
|
|
56
|
+
* against what is actually outstanding happens in `interpretInbound`, because
|
|
57
|
+
* only the database knows which prefixes are unique right now.
|
|
58
|
+
*
|
|
59
|
+
* A bare ack with no token at all is accepted when the sender has exactly one
|
|
60
|
+
* outstanding delivery, since a token adds nothing when there is no ambiguity.
|
|
29
61
|
*/
|
|
30
62
|
export type InboundIntent =
|
|
31
63
|
| { kind: 'ack'; token: string }
|
|
@@ -33,37 +65,87 @@ export type InboundIntent =
|
|
|
33
65
|
| { kind: 'unrecognised' };
|
|
34
66
|
|
|
35
67
|
const ACK_VERB = /^(ack|ok|k|👍)$/iu;
|
|
36
|
-
|
|
68
|
+
/**
|
|
69
|
+
* One to six characters of the token alphabet. Not anchored to the full
|
|
70
|
+
* length: a prefix is legal input, and whether it identifies something is a
|
|
71
|
+
* question for the delivery table, not for a regex.
|
|
72
|
+
*/
|
|
73
|
+
const TOKEN_SHAPE = /^[0-9ABCDEFGHJKMNPQRSTVWXYZ]{1,6}$/;
|
|
37
74
|
|
|
38
75
|
export function parseInbound(body: string): InboundIntent {
|
|
39
|
-
const
|
|
40
|
-
if (
|
|
76
|
+
const words = body.trim().split(/\s+/).filter(Boolean);
|
|
77
|
+
if (words.length === 0) return { kind: 'unrecognised' };
|
|
78
|
+
|
|
79
|
+
// Strip ack synonyms wherever they appear. What remains must be the token,
|
|
80
|
+
// or nothing at all.
|
|
81
|
+
const remainder = words.filter((word) => !ACK_VERB.test(word));
|
|
82
|
+
if (remainder.length === 0) return { kind: 'bare_ack' };
|
|
83
|
+
|
|
84
|
+
// More than one non-verb word is not a token with politeness around it, it
|
|
85
|
+
// is a sentence — and a sentence may be a request celilo does not implement.
|
|
86
|
+
// Guessing at it risks acknowledging an alert the operator meant to escalate:
|
|
87
|
+
// an earlier cut let `<token> resolve` silently ACK, so the operator believed
|
|
88
|
+
// they had cleared an alert that was still firing. Doing nothing and saying
|
|
89
|
+
// so is strictly better than doing the wrong thing quietly.
|
|
90
|
+
if (remainder.length > 1) return { kind: 'unrecognised' };
|
|
91
|
+
|
|
92
|
+
const token = normaliseToken(remainder[0]);
|
|
93
|
+
if (!TOKEN_SHAPE.test(token)) return { kind: 'unrecognised' };
|
|
41
94
|
|
|
42
|
-
|
|
95
|
+
return { kind: 'ack', token };
|
|
96
|
+
}
|
|
43
97
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
98
|
+
/** A message that leads with a token, and whatever text followed it. */
|
|
99
|
+
export interface TokenLedMessage {
|
|
100
|
+
token: string;
|
|
101
|
+
/** Everything after the token, trimmed. Empty when the token stood alone. */
|
|
102
|
+
rest: string;
|
|
103
|
+
}
|
|
47
104
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
105
|
+
/**
|
|
106
|
+
* Split a message that LEADS with a token, or null if it does not.
|
|
107
|
+
*
|
|
108
|
+
* This is the interview grammar and it is deliberately not the alert one: the
|
|
109
|
+
* page says `reply <TOKEN> <value>`, and the value is whatever follows,
|
|
110
|
+
* verbatim. It may contain spaces, punctuation, or a word that happens to look
|
|
111
|
+
* like a verb — second-guessing it would corrupt exactly the values an operator
|
|
112
|
+
* cannot easily retype.
|
|
113
|
+
*
|
|
114
|
+
* `parseInbound` cannot serve both. Its "more than one non-verb word is a
|
|
115
|
+
* sentence" rule is what protects an ALERT from `<token> resolve`, and it is
|
|
116
|
+
* also what made every real interview answer unrecognised (#533): a value is
|
|
117
|
+
* a sentence by construction. Which rule applies is not a property of the text
|
|
118
|
+
* — it is a property of what the token names, and only the delivery table
|
|
119
|
+
* knows that. So both readings are produced here and `interpretInbound`
|
|
120
|
+
* chooses between them AFTER resolving the token.
|
|
121
|
+
*/
|
|
122
|
+
export function parseTokenLed(body: string): TokenLedMessage | null {
|
|
123
|
+
const trimmed = body.trim();
|
|
124
|
+
if (!trimmed) return null;
|
|
59
125
|
|
|
60
|
-
|
|
126
|
+
const boundary = trimmed.search(/\s/);
|
|
127
|
+
const head = boundary === -1 ? trimmed : trimmed.slice(0, boundary);
|
|
128
|
+
const token = normaliseToken(head);
|
|
129
|
+
if (!TOKEN_SHAPE.test(token)) return null;
|
|
130
|
+
|
|
131
|
+
return { token, rest: boundary === -1 ? '' : trimmed.slice(boundary).trim() };
|
|
61
132
|
}
|
|
62
133
|
|
|
63
134
|
export type InboundOutcome =
|
|
64
135
|
| { action: 'ack'; delivery: NotificationDelivery; route: Route }
|
|
136
|
+
/** An answer to a deploy question. `value` is the operator's text, verbatim. */
|
|
137
|
+
| { action: 'answer'; delivery: NotificationDelivery; route: Route; value: string }
|
|
65
138
|
| { action: 'ignored'; reason: 'unknown_sender' }
|
|
66
|
-
| {
|
|
139
|
+
| {
|
|
140
|
+
action: 'rejected';
|
|
141
|
+
reason:
|
|
142
|
+
| 'unknown_token'
|
|
143
|
+
| 'wrong_sender'
|
|
144
|
+
| 'ambiguous'
|
|
145
|
+
| 'unrecognised'
|
|
146
|
+
/** A question was named, but no value was supplied to answer it with. */
|
|
147
|
+
| 'needs_value';
|
|
148
|
+
};
|
|
67
149
|
|
|
68
150
|
function routeForAddress(db: DbClient, senderAddress: string): Route | undefined {
|
|
69
151
|
return db.select().from(routes).where(eq(routes.address, senderAddress)).get();
|
|
@@ -91,10 +173,9 @@ export function interpretInbound(db: DbClient, context: InboundContext): Inbound
|
|
|
91
173
|
|
|
92
174
|
const intent = parseInbound(context.body);
|
|
93
175
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
176
|
+
// A bare ack names no token, so there is nothing to resolve and nothing a
|
|
177
|
+
// question could be answered with. It is an ALERT reply by construction —
|
|
178
|
+
// `outstandingForRoute` supplies alert deliveries only.
|
|
98
179
|
if (intent.kind === 'bare_ack') {
|
|
99
180
|
const outstanding = context.outstandingForRoute(route.id);
|
|
100
181
|
if (outstanding.length === 0) return { action: 'rejected', reason: 'unknown_token' };
|
|
@@ -102,11 +183,59 @@ export function interpretInbound(db: DbClient, context: InboundContext): Inbound
|
|
|
102
183
|
return { action: 'ack', delivery: outstanding[0], route };
|
|
103
184
|
}
|
|
104
185
|
|
|
105
|
-
|
|
106
|
-
|
|
186
|
+
// Both readings of the text, neither yet privileged. The alert reading is
|
|
187
|
+
// the more constrained one, so it names the token when it applies; otherwise
|
|
188
|
+
// a leading token does.
|
|
189
|
+
const led = parseTokenLed(context.body);
|
|
190
|
+
const namesAToken = intent.kind === 'ack';
|
|
191
|
+
const candidate = namesAToken ? intent.token : led?.token;
|
|
192
|
+
|
|
193
|
+
// Nothing token-shaped anywhere: not a reply celilo can act on.
|
|
194
|
+
if (!candidate) return { action: 'rejected', reason: 'unrecognised' };
|
|
195
|
+
|
|
196
|
+
// A prefix is resolved against what is LIVE right now, so how much of the
|
|
197
|
+
// token an operator must type depends on what is actually outstanding — one
|
|
198
|
+
// alert, one character. Matching is deliberately global rather than scoped to
|
|
199
|
+
// this route: it keeps `wrong_sender` a distinguishable answer below, and a
|
|
200
|
+
// globally-unique prefix is a stricter bar than a per-route one.
|
|
201
|
+
const matches = findLiveDeliveriesByPrefix(db, candidate, context.now);
|
|
202
|
+
if (matches.length === 0) {
|
|
203
|
+
// Ordinary words are token-shaped surprisingly often — the alphabet is
|
|
204
|
+
// most of the Latin one, so `what is going on` leads with a perfectly
|
|
205
|
+
// well-formed `WHAT`. Only call it a token the operator got WRONG when the
|
|
206
|
+
// alert grammar agreed it was one; otherwise this is a sentence, and
|
|
207
|
+
// saying `unknown_token` would send them hunting for a typo they did not
|
|
208
|
+
// make.
|
|
209
|
+
return { action: 'rejected', reason: namesAToken ? 'unknown_token' : 'unrecognised' };
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
// Ambiguous is its own answer, never a guess. Taking the first match would
|
|
213
|
+
// acknowledge an alert the operator did not name.
|
|
214
|
+
if (matches.length > 1) return { action: 'rejected', reason: 'ambiguous' };
|
|
215
|
+
|
|
216
|
+
const delivery = matches[0];
|
|
107
217
|
|
|
108
218
|
// Factor two: a valid token replayed from a different number is refused.
|
|
219
|
+
// Checked before the grammar so a stranger learns nothing about which of the
|
|
220
|
+
// two a token names.
|
|
109
221
|
if (delivery.routeId !== route.id) return { action: 'rejected', reason: 'wrong_sender' };
|
|
110
222
|
|
|
223
|
+
// NOW the kind is known, so the right grammar can be applied to the body.
|
|
224
|
+
if (delivery.kind === 'interview') {
|
|
225
|
+
// The value must follow the token the question was asked with; a verb-led
|
|
226
|
+
// message (`ack <TOKEN>`) names no value and is not an answer.
|
|
227
|
+
if (!led || led.token !== candidate) return { action: 'rejected', reason: 'unrecognised' };
|
|
228
|
+
// Named the question but supplied nothing to answer it with. Distinct from
|
|
229
|
+
// `unrecognised`: the operator got the token right and stopped too soon,
|
|
230
|
+
// and telling them that is the difference between retyping six characters
|
|
231
|
+
// and giving up.
|
|
232
|
+
if (!led.rest) return { action: 'rejected', reason: 'needs_value' };
|
|
233
|
+
return { action: 'answer', delivery, route, value: led.rest };
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
// An alert. The strict grammar applies, which is what keeps `<token> resolve`
|
|
237
|
+
// from silently acknowledging something the operator meant to escalate.
|
|
238
|
+
if (intent.kind !== 'ack') return { action: 'rejected', reason: 'unrecognised' };
|
|
239
|
+
|
|
111
240
|
return { action: 'ack', delivery, route };
|
|
112
241
|
}
|
|
@@ -4,7 +4,6 @@ import {
|
|
|
4
4
|
decideInterviewDelivery,
|
|
5
5
|
describeQuestion,
|
|
6
6
|
isRefusedFamily,
|
|
7
|
-
parseInterviewAnswer,
|
|
8
7
|
} from './interview-responder';
|
|
9
8
|
|
|
10
9
|
const headless = { hasTty: false, hasBidirectionalRoute: true };
|
|
@@ -98,37 +97,6 @@ describe('composeInterviewBody', () => {
|
|
|
98
97
|
});
|
|
99
98
|
});
|
|
100
99
|
|
|
101
|
-
describe('parseInterviewAnswer', () => {
|
|
102
|
-
test('takes everything after the token as the answer', () => {
|
|
103
|
-
expect(parseInterviewAnswer('K7QM2X www.example.com', 'K7QM2X')).toBe('www.example.com');
|
|
104
|
-
});
|
|
105
|
-
|
|
106
|
-
test('is case-insensitive on the token', () => {
|
|
107
|
-
expect(parseInterviewAnswer('k7qm2x www.example.com', 'K7QM2X')).toBe('www.example.com');
|
|
108
|
-
});
|
|
109
|
-
|
|
110
|
-
// An answer may legitimately contain spaces and punctuation. Second-guessing
|
|
111
|
-
// it would corrupt exactly the values that are painful to retype.
|
|
112
|
-
test('preserves an answer containing spaces and punctuation verbatim', () => {
|
|
113
|
-
expect(parseInterviewAnswer('K7QM2X my value: with, punctuation', 'K7QM2X')).toBe(
|
|
114
|
-
'my value: with, punctuation',
|
|
115
|
-
);
|
|
116
|
-
});
|
|
117
|
-
|
|
118
|
-
test('an answer that looks like a verb is still an answer', () => {
|
|
119
|
-
expect(parseInterviewAnswer('K7QM2X resolve', 'K7QM2X')).toBe('resolve');
|
|
120
|
-
});
|
|
121
|
-
|
|
122
|
-
test('a token with no value is not an answer', () => {
|
|
123
|
-
expect(parseInterviewAnswer('K7QM2X', 'K7QM2X')).toBeNull();
|
|
124
|
-
expect(parseInterviewAnswer('K7QM2X ', 'K7QM2X')).toBeNull();
|
|
125
|
-
});
|
|
126
|
-
|
|
127
|
-
test('a different token does not match', () => {
|
|
128
|
-
expect(parseInterviewAnswer('ZZZZZZ value', 'K7QM2X')).toBeNull();
|
|
129
|
-
});
|
|
130
|
-
});
|
|
131
|
-
|
|
132
100
|
/**
|
|
133
101
|
* The families disagree on payload shape, and reading the wrong field means an
|
|
134
102
|
* operator gets the raw event type instead of the question.
|
|
@@ -136,23 +136,12 @@ export function composeInterviewBody(input: {
|
|
|
136
136
|
return lines.join('\n');
|
|
137
137
|
}
|
|
138
138
|
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
* cannot easily retype.
|
|
146
|
-
*/
|
|
147
|
-
export function parseInterviewAnswer(body: string, token: string): string | null {
|
|
148
|
-
const trimmed = body.trim();
|
|
149
|
-
const upper = trimmed.toUpperCase();
|
|
150
|
-
const normalisedToken = token.toUpperCase();
|
|
151
|
-
if (!upper.startsWith(normalisedToken)) return null;
|
|
152
|
-
|
|
153
|
-
const answer = trimmed.slice(token.length).trim();
|
|
154
|
-
return answer.length > 0 ? answer : null;
|
|
155
|
-
}
|
|
139
|
+
// `parseInterviewAnswer` lived here and is gone. It was correct and had the
|
|
140
|
+
// tests to prove it, and it was never reachable: the caller only ran it for a
|
|
141
|
+
// body the ALERT grammar had already accepted, which no real answer ever was
|
|
142
|
+
// (#533). Extraction now happens in `interpretInbound` — the one place that
|
|
143
|
+
// knows a delivery's kind before it parses — so the reply grammar exists once
|
|
144
|
+
// rather than in two halves that could disagree.
|
|
156
145
|
|
|
157
146
|
/** Severity an interview question is delivered at — never a page-worthy one. */
|
|
158
147
|
export const INTERVIEW_SEVERITY: AlertSeverity = 'warning';
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { randomInt, randomUUID } from 'node:crypto';
|
|
16
|
-
import { and, eq, gt, isNull } from 'drizzle-orm';
|
|
16
|
+
import { and, eq, gt, isNull, like } from 'drizzle-orm';
|
|
17
17
|
import type { DbClient } from '../../db/client';
|
|
18
18
|
import { type NotificationDelivery, notificationDeliveries } from '../../db/schema';
|
|
19
19
|
|
|
@@ -100,6 +100,44 @@ export function findLiveDelivery(
|
|
|
100
100
|
.get();
|
|
101
101
|
}
|
|
102
102
|
|
|
103
|
+
/**
|
|
104
|
+
* Every live delivery whose token STARTS WITH `prefix`.
|
|
105
|
+
*
|
|
106
|
+
* An operator typing at 3am should not have to copy six characters exactly.
|
|
107
|
+
* They need only enough to be unambiguous, and "unambiguous" is scoped to what
|
|
108
|
+
* is actually outstanding right now — consumed and expired deliveries are not
|
|
109
|
+
* candidates, so yesterday's tokens cannot make today's prefix ambiguous.
|
|
110
|
+
*
|
|
111
|
+
* Returning every match rather than the first is the point: the caller must be
|
|
112
|
+
* able to tell "no such token" from "you were ambiguous, be more specific".
|
|
113
|
+
* Silently taking the first match would acknowledge an alert the operator did
|
|
114
|
+
* not mean, which is worse than asking again.
|
|
115
|
+
*
|
|
116
|
+
* The shortening does not weaken authentication in the way it first appears.
|
|
117
|
+
* The token was never a secret on its own — the sender address is the other
|
|
118
|
+
* factor and is unaffected — and the search space here is not 32^6 but the
|
|
119
|
+
* handful of alerts live at this moment.
|
|
120
|
+
*/
|
|
121
|
+
export function findLiveDeliveriesByPrefix(
|
|
122
|
+
db: DbClient,
|
|
123
|
+
prefix: string,
|
|
124
|
+
now: Date,
|
|
125
|
+
): NotificationDelivery[] {
|
|
126
|
+
const normalised = normaliseToken(prefix);
|
|
127
|
+
if (!normalised) return [];
|
|
128
|
+
return db
|
|
129
|
+
.select()
|
|
130
|
+
.from(notificationDeliveries)
|
|
131
|
+
.where(
|
|
132
|
+
and(
|
|
133
|
+
like(notificationDeliveries.token, `${normalised}%`),
|
|
134
|
+
isNull(notificationDeliveries.consumedAt),
|
|
135
|
+
gt(notificationDeliveries.expiresAt, now),
|
|
136
|
+
),
|
|
137
|
+
)
|
|
138
|
+
.all();
|
|
139
|
+
}
|
|
140
|
+
|
|
103
141
|
export function consumeDelivery(db: DbClient, deliveryId: string, now: Date): void {
|
|
104
142
|
db.update(notificationDeliveries)
|
|
105
143
|
.set({ consumedAt: now })
|