Add #loser command — worst packet delivery record over directed sends (v0.21.9)
CI / build + unit (pull_request) Successful in 48s
CI / build + unit (pull_request) Successful in 48s
This commit is contained in:
@@ -13,7 +13,11 @@ import {
|
||||
KAMIL_NUM,
|
||||
} from '../mesh/fake-bridge.js';
|
||||
import { BROADCAST_ADDR } from '../mesh/codec.js';
|
||||
import type { MeshService } from '../mesh/mesh.service.js';
|
||||
import type {
|
||||
MessageRecord,
|
||||
MeshService,
|
||||
NodeSummary,
|
||||
} from '../mesh/mesh.service.js';
|
||||
import { MeshService as RealMeshService } from '../mesh/mesh.service.js';
|
||||
import { CommandService } from './command.service.js';
|
||||
|
||||
@@ -47,6 +51,7 @@ describe('CommandService.onRx', () => {
|
||||
expect(mesh.respond).toHaveBeenCalledTimes(1); // one packet — not one per line
|
||||
const text = mesh.respond.mock.calls[0][1];
|
||||
expect(text).toContain('#ping');
|
||||
expect(text).toContain('#loser');
|
||||
expect(text).toContain('#rss');
|
||||
});
|
||||
|
||||
@@ -205,6 +210,125 @@ describe('CommandService.onRx', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('#loser', () => {
|
||||
const tx = (
|
||||
id: number,
|
||||
to: number,
|
||||
status: MessageRecord['status'],
|
||||
): MessageRecord => ({
|
||||
id,
|
||||
dir: 'tx',
|
||||
to,
|
||||
text: 'hi',
|
||||
channel: 3,
|
||||
at: Date.now(),
|
||||
status,
|
||||
});
|
||||
|
||||
const makeLoserMesh = (
|
||||
messages: MessageRecord[],
|
||||
nodes: NodeSummary[],
|
||||
): [CommandService, MeshService] => {
|
||||
const mesh = {
|
||||
sendText: vi.fn(),
|
||||
respond: vi.fn().mockResolvedValue({ id: 1 }),
|
||||
messages: () => messages,
|
||||
nodes: async () => nodes,
|
||||
} as unknown as MeshService;
|
||||
return [new CommandService(mesh), mesh];
|
||||
};
|
||||
|
||||
it('reports the node with the most failures — named via longName, broadcasts and pending sends excluded', async () => {
|
||||
const messages = [
|
||||
tx(10, BROADCAST_ADDR, 'failed'), // firmware quirk: a broadcast NACK is never a real destination
|
||||
tx(9, 222, 'failed'), // Alice: 3 failed / 0 delivered → loser
|
||||
tx(8, 111, 'delivered'), // Bob: 1 failed / 2 delivered
|
||||
tx(7, 222, 'failed'),
|
||||
tx(6, 111, 'failed'),
|
||||
tx(5, 333, 'pending'), // no final status yet — ignored
|
||||
tx(4, 222, 'failed'),
|
||||
{
|
||||
id: 3,
|
||||
dir: 'rx',
|
||||
from: 999,
|
||||
text: 'hello',
|
||||
channel: 0,
|
||||
at: Date.now(),
|
||||
},
|
||||
];
|
||||
const nodes = [
|
||||
{ num: 111, shortName: 'Bob', lastHeard: null },
|
||||
{ num: 222, longName: 'Alice', lastHeard: null },
|
||||
];
|
||||
const [svc, mesh] = makeLoserMesh(messages, nodes);
|
||||
|
||||
await svc.onRx(2, '#loser', 42, 7);
|
||||
|
||||
expect(mesh.respond).toHaveBeenCalledWith(
|
||||
7,
|
||||
'worst delivery: Alice (@!000000de) - 3 failed / 0 delivered',
|
||||
);
|
||||
expect(mesh.sendText).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('says no failed sends when the directed history is all delivered', async () => {
|
||||
const messages = [tx(2, 5, 'delivered'), tx(1, 6, 'delivered')];
|
||||
const [svc, mesh] = makeLoserMesh(messages, []);
|
||||
|
||||
await svc.onRx(2, '#loser', 42, 7);
|
||||
|
||||
expect(mesh.respond).toHaveBeenCalledWith(
|
||||
7,
|
||||
'no failed sends yet - everyone delivers :)',
|
||||
);
|
||||
});
|
||||
|
||||
it('explains the directed-only rule when there is no final-status data at all', async () => {
|
||||
const messages = [tx(2, BROADCAST_ADDR, 'pending'), tx(1, 5, 'pending')];
|
||||
const [svc, mesh] = makeLoserMesh(messages, []);
|
||||
|
||||
await svc.onRx(2, '#loser', 42, 7);
|
||||
|
||||
expect(mesh.respond).toHaveBeenCalledWith(
|
||||
7,
|
||||
'not enough data yet - only directed sends count (broadcasts have no acks)',
|
||||
);
|
||||
});
|
||||
|
||||
it('falls back to the @!hex mention when the worst node has no known name', async () => {
|
||||
const messages = [tx(1, 600, 'failed')];
|
||||
const nodes = [{ num: 5, longName: 'Someone Else', lastHeard: null }];
|
||||
const [svc, mesh] = makeLoserMesh(messages, nodes);
|
||||
|
||||
await svc.onRx(2, '#loser', 42, 7);
|
||||
|
||||
expect(mesh.respond).toHaveBeenCalledWith(
|
||||
7,
|
||||
'worst delivery: @!00000258 - 1 failed / 0 delivered',
|
||||
);
|
||||
});
|
||||
|
||||
it('tie-breaks equal failure counts by the worse failure ratio', async () => {
|
||||
const messages = [
|
||||
// node 7: 1 failed / 9 delivered (ratio 0.1) — not the loser
|
||||
tx(16, 8, 'failed'), // node 8: 1 failed / 1 delivered (ratio 0.5) → loser
|
||||
tx(15, 8, 'delivered'),
|
||||
tx(14, 7, 'failed'),
|
||||
...Array.from({ length: 9 }, (_, i) =>
|
||||
tx(i + 1, 7, 'delivered' as const),
|
||||
),
|
||||
];
|
||||
const [svc, mesh] = makeLoserMesh(messages, []);
|
||||
|
||||
await svc.onRx(2, '#loser', 42, 7);
|
||||
|
||||
expect(mesh.respond).toHaveBeenCalledWith(
|
||||
7,
|
||||
'worst delivery: @!00000008 - 1 failed / 1 delivered',
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('#rss prefix dispatch', () => {
|
||||
let dir: string | undefined;
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
import { Injectable, Logger } from '@nestjs/common';
|
||||
// pure formatting helper (no cycle: battery → mesh only)
|
||||
import { mention } from '../battery/battery.service.js';
|
||||
import { BROADCAST_ADDR } from '../mesh/codec.js';
|
||||
// type-only: the instances come from DI (command.module.ts factory) or direct construction in tests — no runtime import cycles with src/mesh / src/rss
|
||||
import type { MeshService } from '../mesh/mesh.service.js';
|
||||
@@ -43,10 +45,12 @@ export class CommandService {
|
||||
rss?: RssService,
|
||||
) {
|
||||
this.register('ping', () => '#pong!');
|
||||
this.register('loser', () => this.loserReply());
|
||||
// single multi-line string = ONE packet — not an array, which would drip-feed one spaced packet per line
|
||||
this.register('help', () =>
|
||||
[
|
||||
'#ping - alive check',
|
||||
'#loser - worst delivery record',
|
||||
'#rss help - rss subcommands',
|
||||
'#rss add <url> <name> - add feed with AI tags',
|
||||
'#rss remove <name> - drop feed',
|
||||
@@ -57,6 +61,52 @@ export class CommandService {
|
||||
if (rss) this.registerPrefix('rss', (ctx) => rss.handle(ctx));
|
||||
}
|
||||
|
||||
/**
|
||||
* #loser — worst packet delivery record, over directed sends only. Meshtastic shares no mesh-wide
|
||||
* loss stats, so the only real data is our own tx history: group by destination, count delivered vs
|
||||
* failed per node; broadcasts are excluded (firmware strips want_ack pre-TX, they stay pending — and
|
||||
* the broadcast addr is never a real destination even if a NACK ever lands on it). Loser = most
|
||||
* failures, tie-break worse failure ratio. One reply line, ≤ ~180 chars.
|
||||
*/
|
||||
private async loserReply(): Promise<string> {
|
||||
const mesh = this.mesh;
|
||||
if (!mesh)
|
||||
return 'not enough data yet - only directed sends count (broadcasts have no acks)';
|
||||
const stats = new Map<number, { failed: number; delivered: number }>();
|
||||
for (const m of mesh.messages()) {
|
||||
if (m.dir !== 'tx' || m.to === undefined || m.to === BROADCAST_ADDR)
|
||||
continue; // directed sends only
|
||||
if (m.status !== 'delivered' && m.status !== 'failed') continue; // pending = no final status yet
|
||||
const s = stats.get(m.to) ?? { failed: 0, delivered: 0 };
|
||||
if (m.status === 'failed') s.failed += 1;
|
||||
else s.delivered += 1;
|
||||
stats.set(m.to, s);
|
||||
}
|
||||
if (stats.size === 0)
|
||||
return 'not enough data yet - only directed sends count (broadcasts have no acks)';
|
||||
let worst: { num: number; failed: number; total: number } | undefined;
|
||||
for (const [num, s] of stats) {
|
||||
if (s.failed === 0) continue; // zero-failure nodes can't be the loser
|
||||
const total = s.failed + s.delivered;
|
||||
// most failures first, then worse failure ratio on a tie
|
||||
if (
|
||||
!worst ||
|
||||
s.failed > worst.failed ||
|
||||
(s.failed === worst.failed &&
|
||||
s.failed / total > worst.failed / worst.total)
|
||||
) {
|
||||
worst = { num, failed: s.failed, total };
|
||||
}
|
||||
}
|
||||
if (!worst) return 'no failed sends yet - everyone delivers :)';
|
||||
const names = new Map(
|
||||
(await mesh.nodes()).map((n) => [n.num, n.longName ?? n.shortName]),
|
||||
);
|
||||
const name = names.get(worst.num);
|
||||
const who = name ? `${name} (${mention(worst.num)})` : mention(worst.num);
|
||||
return `worst delivery: ${who} - ${worst.failed} failed / ${worst.total - worst.failed} delivered`;
|
||||
}
|
||||
|
||||
/** Register a command handler (names are case-sensitive; the leading `#` is stripped before lookup). */
|
||||
register(name: string, fn: CommandHandler): void {
|
||||
this.commands.set(name, fn);
|
||||
|
||||
Reference in New Issue
Block a user