public_git/unpoller_unpoller
1
0
Fork 0
mirror of https://github.com/unpoller/unpoller.git synced 2026-10-18 22:40:03 +02:00
Code Issues Projects Releases Wiki Activity

refactor(unas): replace disable flag with enable, defaulting to off

Browse Source 
`disable = false` is a double negative, and a bool named disable cannot
express opt-in anyway: it zero-values to false, so the flag was inert and
opt-in rested entirely on the device list being empty.

`enable` defaults to false and is now the real gate -- Initialize, Metrics
and DebugInput all return early unless it is set. The two existing guards
remain: an empty device list is still a no-op, and no default URL is ever
synthesized.

Configuring devices while enable is false is always a mistake, so that
combination logs one error instead of silently collecting nothing.

Adds binding tests for the flag across toml, json, yaml and UP_UNAS_ENABLE
(the env name derives from the xml tag, not the json one), plus a test that
all three shipped examples default to off. Both were verified by mutation:
breaking a struct tag or flipping an example fails the suite.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Cody Lee
2026-08-19 09:34:02 -05:00
co-authored by Claude Opus 5
parent 3d178bed8d
commit 01ac7ca2b7
8 changed files with 129 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/plan-unas-support.md
+10 -8
View File
@@ -9,8 +9,8 @@ alexgreenbank in the package header and README.
UNAS Pro is a standalone UniFi OS console with **no Network application**: no sites, no
`/status`, its own credentials, its own host. `inputunifi`'s sites → devices → per-site flow
has nothing to offer it, and folding it in would mean bolting a second credential set onto
`Controller`. So: a new `pkg/inputunas` plugin with its own `[unas]` config block, disabled
by default and a no-op when unconfigured.
`Controller`. So: a new `pkg/inputunas` plugin with its own `[unas]` config block, off by
default and a no-op when unconfigured.
### The one real blocker
@@ -130,11 +130,13 @@ in all three example configs. `go test ./...` and `golangci-lint run` are clean.
Refinements over the plan below:
1. **The opt-in mechanism is "no devices configured", not `disable`.** `Disable` zero-values
to false, so a field named `disable` cannot make a plugin default-off. `Initialize` returns
silently when the device list is empty, and unlike `inputunifi` it does **not** synthesize
a default device from `[unas.defaults]` — doing so would poll a host the operator never
named. `disable` remains as an explicit off switch.
1. **Opt-in is `enable`, defaulting to false — not `disable`.** A field named `disable`
zero-values to false, so it cannot make a plugin default-off and reads as a double
negative; `enable bool` defaults to off and says what it does. Two further guards:
`Initialize` returns silently when the device list is empty, and unlike `inputunifi` it
does **not** synthesize a default device from `[unas.defaults]` — doing so would poll a
host the operator never named. Devices configured while `enable` is false log one error,
since that combination is always a mistake.
2. **`Metrics` returns `(metrics, nil)` whenever any console was collected.** Not politeness:
`poller.collectMetrics` uses `if result.err != nil { ... } else if result.metric != nil`,
so returning both discards every metric in that cycle. One dead console out of three would
@@ -156,7 +158,7 @@ Refinements over the plan below:
```toml
[unas]
disable = false
enable = true
[unas.defaults]
user = "unpoller"
pass = ""