Commit 98ce9e1
authored
## Summary
\`core.middlewareContainer.Use()\` previously deduped by
\`reflect.TypeOf(m).String()\`, silently dropping any second instance of
the same Go type. This was the structural root cause of
[#670](#670) (multiple
per-job webhooks collapsing into one), worked around at the webhook
layer in PR [#671](#671) with
the \`WebhookMiddleware\` composite. The composite stays — removing it
is a separate PR per the [#672 scope
guidance](#672) — but the
structural bug is now closed at the core layer.
Adds an OPTIONAL \`keyedMiddleware\` interface (\`Key() string\`).
\`Use()\` computes the dedup key via type assertion: implementer returns
a non-empty string → use it; otherwise fall back to
\`reflect.TypeOf(m).String()\`.
Closes [#672](#672).
## Design choice: opt-in via type assertion (not interface contract
change)
Considered adding \`Key()\` to the \`Middleware\` interface; rejected
because every implementer (in-repo AND downstream) would need a stub
method providing no value for the common 1-per-type case. The
assertion-based opt-in keeps the contract small and lets the type-string
fallback do the work it's always done.
**Implementer matrix:**
- \`*middlewares.Webhook\` → \`Key() = Config.Name\` (multiple per job,
distinct names coexist)
- \`Slack\`, \`Mail\`, \`Save\`, \`Overlap\`, \`WebhookMiddleware\` → no
\`Key()\` method (legacy type dedup preserved)
- Downstream custom middleware → no changes required
## Why pointer-identity dedup was rejected
The [#672 issue
body](#672 (comment))
listed pointer-identity as Option 3. Rejected because scheduler-to-job
propagation at
\`core/scheduler.go:315\`/\`:631\`/\`config_webhook.go:289\` calls
\`j.Use(s.Middlewares()...)\`: with pointer-identity dedup, a
scheduler-level Slack middleware would coexist with a job-level Slack
middleware of the same type (different pointers), causing every Slack
notification to fire twice. \`Key()\`-based dedup with type-string
fallback preserves the existing "first wins per type" semantics for
Slack/Mail/Save/Overlap and enables multi-Webhook by construction.
## Tests (TDD)
Six new test functions in \`core/middleware_container_test.go\` (plus
\`TestWebhook_Key\` in \`middlewares/webhook_test.go\`):
- \`TestMiddlewareContainer_Use_DistinctKeysKeepsBoth\` — regression
test for #670 at the core layer. Confirmed failing on pre-fix code.
- \`TestMiddlewareContainer_Use_SameKeyDedups\` — same-name propagation
contract.
- \`TestMiddlewareContainer_Use_UnkeyedFallsBackToType\` —
Slack/Mail/Save/Overlap semantics preserved.
- \`TestMiddlewareContainer_Use_KeyedAndUnkeyedCoexist\` — key-namespace
isolation.
- \`TestMiddlewareContainer_Use_EmptyKeyFallsBackToType\` — explicit
opt-out via \`Key() returning ""\` gets legacy dedup (used by
\`WebhookMiddleware\` composite if it ever needs an explicit opt-out).
- \`TestWebhook_Key\` — pins \`Webhook.Key() == Config.Name\`.
## Out of scope (follow-up PRs)
- Removing the \`WebhookMiddleware\` composite from PR #671 (the
workaround is now redundant for dedup but the composite still serves the
\`ContinueOnStop()\` execution-ordering contract — needs its own
analysis).
- Per-instance dedup for any future N-instance middleware (Slack
channels, Mail recipients, etc.) — just implement \`Key() string\`
returning the operator-supplied name.
## Test plan
- [x] \`go test ./...\` passes (full repo, 14 packages, ~58s)
- [x] \`golangci-lint run\` clean
- [x] \`go vet ./...\` clean
- [ ] CI green
## References
- Structural root cause of:
[#670](#670) (fixed at
webhook layer by [#671](#671))
- Tracks: [#672](#672)
5 files changed
Lines changed: 415 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
| 14 | + | |
| 15 | + | |
14 | 16 | | |
15 | 17 | | |
16 | 18 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
295 | 295 | | |
296 | 296 | | |
297 | 297 | | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
| 331 | + | |
| 332 | + | |
| 333 | + | |
| 334 | + | |
| 335 | + | |
| 336 | + | |
| 337 | + | |
| 338 | + | |
| 339 | + | |
| 340 | + | |
| 341 | + | |
| 342 | + | |
| 343 | + | |
| 344 | + | |
298 | 345 | | |
299 | 346 | | |
300 | 347 | | |
| |||
310 | 357 | | |
311 | 358 | | |
312 | 359 | | |
313 | | - | |
314 | | - | |
| 360 | + | |
| 361 | + | |
315 | 362 | | |
316 | 363 | | |
317 | 364 | | |
318 | | - | |
319 | | - | |
| 365 | + | |
| 366 | + | |
320 | 367 | | |
321 | 368 | | |
322 | 369 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 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 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
129 | 129 | | |
130 | 130 | | |
131 | 131 | | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
132 | 151 | | |
133 | 152 | | |
134 | 153 | | |
| |||
0 commit comments