Name carry()'s retry condition and what ends its loop
Test / lint (pull_request) Successful in 23s
Mirror / push (push) Has been cancelled
Test / test (22) (pull_request) Successful in 32s
Test / test (24) (pull_request) Successful in 31s
Test / test (18) (pull_request) Successful in 31s
Test / test (20) (pull_request) Successful in 30s
Test / test (26) (pull_request) Successful in 32s

This commit is contained in:
2026-09-28 01:45:31 +02:00
parent bfd0ed1b98
commit 696562daec
6 changed files with 33 additions and 13 deletions
+2 -2
View File
@@ -762,11 +762,11 @@ rule and an index of the titles below.
out unbound and come back `ESME_RINVBNDSTS`. `LinkGate` owns the answer instead — `shut(returning)` out unbound and come back `ESME_RINVBNDSTS`. `LinkGate` owns the answer instead — `shut(returning)`
on every teardown, `open()` only once `comeBackUp()` has a bound link — and on every teardown, `open()` only once `comeBackUp()` has a bound link — and
`OutgoingRequests.canCarry()` reads it rather than `closed`. The bind itself cannot wait for what it `OutgoingRequests.canCarry()` reads it rather than `closed`. The bind itself cannot wait for what it
creates, so `pastDrain()` lets the three bind commands past the gate and the window, the same door creates, so `carry()` lets the three bind commands past the gate and the window, the same door
`unbind()` takes through `now()`. The gate is told what happened and never reads back into the `unbind()` takes through `now()`. The gate is told what happened and never reads back into the
session: a collaborator that has to ask does not own its decision, which is how the first cut ended session: a collaborator that has to ask does not own its decision, which is how the first cut ended
up answering the same question two different ways at admit and at release. For the same reason the up answering the same question two different ways at admit and at release. For the same reason the
retry in `pastDrain()` asks `gate.isUp()` rather than `canCarry()`, which also reads the socket — a retry in `carry()` asks `gate.awaitsNextLink()` rather than `canCarry()`, which also reads the socket — a
condition that loops on something the gate does not gate on spins against a gate that admits it condition that loops on something the gate does not gate on spins against a gate that admits it
straight back. `LinkGate.returning` is a copy of `retrying()` taken at teardown, and stays true straight back. `LinkGate.returning` is a copy of `retrying()` taken at teardown, and stays true
only because nothing stops the reconnect loop without `emitClose()` following it: `drain()` and only because nothing stops the reconnect loop without `emitClose()` following it: `drain()` and
+5
View File
@@ -42,6 +42,11 @@ export class LinkGate {
return this.up; return this.up;
} }
/** Shut, with another link on its way to reopen it. */
awaitsNextLink(): boolean {
return !this.up && this.returning;
}
/** Why the gate will never admit a request, or undefined while one may still get through. */ /** Why the gate will never admit a request, or undefined while one may still get through. */
refusal(): Error | undefined { refusal(): Error | undefined {
return this.up || this.returning ? undefined : over(); return this.up || this.returning ? undefined : over();
+13 -5
View File
@@ -93,11 +93,14 @@ export class OutgoingRequests {
return Promise.resolve({ err: new Error('Session is shutting down') }); return Promise.resolve({ err: new Error('Session is shutting down') });
} }
return this.pastDrain(input, options); return this.carry(input, options);
} }
/** The same path without that refusal, which a receipt for a held message has to take. */ /**
async pastDrain( * The same path without the drain's refusal, which a receipt for a held message has to take.
* It ends with the first attempt that reached the socket, or once no next link will carry it.
*/
async carry(
input: PduObjectInput, input: PduObjectInput,
options: SendOptions, options: SendOptions,
): Promise<Result<{ pduObj: PduObject }>> { ): Promise<Result<{ pduObj: PduObject }>> {
@@ -125,8 +128,7 @@ export class OutgoingRequests {
const attempt = await this.attempt(input, options).finally(() => { this.window.release(); }); const attempt = await this.attempt(input, options).finally(() => { this.window.release(); });
// Nothing reached the socket, so the next link carries it instead of the caller resending. if (!this.retriesOnNextLink(attempt)) return attempt.result;
if (!attempt.retryOnNextLink || this.gate.isUp() || this.gate.refusal()) return attempt.result;
} }
} }
@@ -151,6 +153,12 @@ export class OutgoingRequests {
return { err: new Error(`Shut down with ${String(unfinished)} request(s) unfinished`) }; return { err: new Error(`Shut down with ${String(unfinished)} request(s) unfinished`) };
} }
/** Nothing reached the socket, so the next link carries it instead of the caller resending. */
private retriesOnNextLink(attempt: Attempt): boolean {
// Until the gate is shut it admits the retry straight back onto the dead socket, and the loop spins.
return attempt.retryOnNextLink && this.gate.awaitsNextLink();
}
/** Why a request cannot go out at all, as opposed to not yet. */ /** Why a request cannot go out at all, as opposed to not yet. */
private refuse(input: PduObjectInput, options: SendOptions): Error | undefined { private refuse(input: PduObjectInput, options: SendOptions): Error | undefined {
// Before the gate and the window, or an aborted call waits for what it will never use. // Before the gate and the window, or an aborted call waits for what it will never use.
+1 -1
View File
@@ -261,7 +261,7 @@ export class Session extends EventEmitter<SessionEvents> {
reportError: err => { this.emit('sessionError', err); }, reportError: err => { this.emit('sessionError', err); },
reportMessageDlr: merged => { this.emit('messageDlr', merged); }, reportMessageDlr: merged => { this.emit('messageDlr', merged); },
send: input => this.send(input), send: input => this.send(input),
sendPastDrain: input => this.outgoing.pastDrain(input, {}), sendPastDrain: input => this.outgoing.carry(input, {}),
smsListeners: () => this.listenerCount('sms'), smsListeners: () => this.listenerCount('sms'),
}; };
} }
+12
View File
@@ -1448,6 +1448,18 @@ describe('LinkGate', () => {
assert.match(held.err?.message ?? '', /Aborted while waiting for a link/); assert.match(held.err?.message ?? '', /Aborted while waiting for a link/);
}); });
test('awaits the next link only while shut with one on its way', () => {
const gate = new LinkGate({ log: silentLog, timeout: 100 });
assert.equal(gate.awaitsNextLink(), false, 'up');
gate.shut(true);
assert.equal(gate.awaitsNextLink(), true, 'shut, returning');
gate.open();
assert.equal(gate.awaitsNextLink(), false, 'reopened');
gate.shut(false);
assert.equal(gate.awaitsNextLink(), false, 'shut for good');
});
}); });
describe('SendWindow', () => { describe('SendWindow', () => {
-5
View File
@@ -199,11 +199,6 @@ next work ([decision](docs/decisions.md#internals-and-tests)).
### Locality — next, ahead of everything below; 5–6 today, and the gate is 7 ### Locality — next, ahead of everything below; 5–6 today, and the gate is 7
- [ ] **Name `pastDrain()`'s retry condition and what makes the loop end.** The exit is a
three-term disjunction over two collaborators, whose comment covers the first term only, and
the method is named for what it bypasses. Do not change what it asks: `gate.isUp()` rather than
`canCarry()` is deliberate and recorded.
- [ ] **Replace `resolveBody`'s `settles` boolean with the decision it stands for.** One boolean - [ ] **Replace `resolveBody`'s `settles` boolean with the decision it stands for.** One boolean
chooses both whether to overwrite `data_coding` and which params to read it from, across four chooses both whether to overwrite `data_coding` and which params to read it from, across four
helpers all named some abstraction of "body". Return a named source — `'short_message' | helpers all named some abstraction of "body". Return a named source — `'short_message' |