1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
//! What upstream responses say about a subscription's credential.
//!
//! Split from `refresh.rs` to stay inside the per-file line limit. This is the
//! evidence `/health/subscriptions`, `/metrics` and `model_routing` all read
//! (issues #318, #319).
use super::{CredentialEvidence, SubscriptionProvider, SubscriptionToken, TokenCache};
impl TokenCache {
/// Announce a terminal credential failure once, at `ERROR`.
///
/// A router that cannot serve a configured subscription, and cannot fix it
/// without a human in a browser, is in an error state by any definition.
/// Logged at `WARN` it sat below every ordinary `level>=ERROR` pipeline,
/// so a twelve-hour outage produced a log with zero errors in it, and the
/// one meaningful line was buried under 146 repetitions of its consequence
/// (issue #321).
///
/// Repeats are suppressed until the provider recovers, because the
/// condition is already known and restating it hides new events.
pub(super) fn log_terminal_once(&self, provider: SubscriptionProvider, message: &str) {
if self.take_terminal_announcement(provider) {
tracing::error!(
"{provider} subscription is unusable and cannot recover on its own: {message}"
);
} else {
tracing::debug!("{provider} subscription is still unusable: {message}");
}
}
/// Claim the right to announce this provider's terminal failure.
///
/// True exactly once per outage, so the transition is reported and its
/// restatements are not.
pub(super) fn take_terminal_announcement(&self, provider: SubscriptionProvider) -> bool {
self.announced_terminal
.lock()
.is_ok_and(|mut guard| guard.insert(provider))
}
/// Forget that a provider's terminal failure was announced, so a later one
/// is reported again.
pub(super) fn clear_terminal_announcement(&self, provider: SubscriptionProvider) {
if let Ok(mut guard) = self.announced_terminal.lock() {
guard.remove(&provider);
}
}
/// Record what an upstream status code says about `provider`'s credential.
///
/// This is the evidence [`crate::model_routing::healthy_providers`] trusts
/// over `expiresAt`: a served request proves the credential works even when
/// its timestamp says otherwise, and only a 401/403 proves it does not.
/// Every other status describes the request, not the credential.
pub fn record_status(&self, provider: SubscriptionProvider, status: u16) {
if status == 401 || status == 403 {
self.record_credential_rejected(provider);
// The third producer of the same state, and the one that was
// silent. A credential rejected while serving a request makes the
// provider unusable exactly as a rejected refresh does (#321).
self.announce_unusable(
provider,
&format!("an upstream request was refused with HTTP {status}"),
);
} else if (200..300).contains(&status) {
self.record_credential_working(provider);
}
}
/// Record that an upstream rejected `provider`'s credential (401/403).
/// Announce that a provider became unusable, whichever path discovered it.
///
/// `Rejected` is the single state that drives `/health/subscriptions` to
/// 503, the `/metrics` gauge to 0, and removal from routing. It was set
/// from three places at three severities — once at `ERROR`, once at
/// `WARN`, and once silently — so a subscription revoked between refresh
/// ticks produced a 503 with no error line anywhere, which is the outage
/// shape issue #321 exists to prevent.
pub(crate) fn announce_unusable(&self, provider: SubscriptionProvider, reason: &str) {
self.log_terminal_once(provider, reason);
}
pub fn record_credential_rejected(&self, provider: SubscriptionProvider) {
self.record_evidence(provider, CredentialEvidence::Rejected);
}
/// Record that a refresh for `account` was refused for `credential` itself.
///
/// The evidence recorded alongside this is per *provider*, which is right
/// for routing a vendor away but wrong for reporting one account of a pool:
/// several accounts share a provider, and one revoked chain must not make
/// its healthy neighbours look revoked too (issue #245).
pub fn record_refresh_refused(
&self,
provider: SubscriptionProvider,
account: &str,
credential: &SubscriptionToken,
) {
self.rejections.record(provider, account, credential);
}
/// Persist refusals in `data_dir`, so a later process can read them.
pub fn persist_rejections_in(&self, data_dir: &std::path::Path) {
self.rejections.persist_in(data_dir);
}
/// Whether a refresh has already been refused for exactly this credential.
///
/// `false` once the file on disk differs from the one that was refused: a
/// rejection is a fact about one chain link, not about the account, so a
/// credential rotated forward by another holder is reported as recoverable
/// again with no restart (issue #239).
#[must_use]
pub fn refresh_was_refused(
&self,
provider: SubscriptionProvider,
account: &str,
credential: &SubscriptionToken,
) -> bool {
self.rejections.was_refused(provider, account, credential)
}
/// The most recent upstream verdict for `provider`, if any call was made.
#[must_use]
pub fn evidence(&self, provider: SubscriptionProvider) -> Option<CredentialEvidence> {
self.evidence
.lock()
.ok()
.and_then(|guard| guard.get(&provider).copied())
}
/// The most recent refresh failure for `provider`, if the last attempt failed.
#[must_use]
pub fn last_refresh_error(&self, provider: SubscriptionProvider) -> Option<String> {
self.refresh_errors
.lock()
.ok()
.and_then(|guard| guard.get(&provider).cloned())
}
pub(super) fn record_evidence(
&self,
provider: SubscriptionProvider,
evidence: CredentialEvidence,
) {
if let Ok(mut guard) = self.evidence.lock() {
guard.insert(provider, evidence);
}
}
pub(super) fn record_refresh_error(&self, provider: SubscriptionProvider, error: &str) {
if let Ok(mut guard) = self.refresh_errors.lock() {
guard.insert(provider, error.to_string());
}
}
/// Seed the cache with an already-refreshed token for `provider`/`account`.
///
/// Used by callers that obtained a token outside [`Self::get_fresh_for`]
/// (and by tests) so a subsequent lookup reuses it instead of exchanging
/// the refresh token again.
pub fn store_refreshed(
&self,
provider: SubscriptionProvider,
account: &str,
token: SubscriptionToken,
) {
self.store_for(provider, account, token);
}
}