alknet/tasks/cleanup/non-exhaustive-public-api.md at eed33967052ba265e2b69cc08bc4f5d7d6289a29

Files

glm-5.1 eed3396705 tasks: add 5 cleanup tasks from Phase 1 review, mark review complete

Review found Phase 1 approved with minor issues. Created cleanup tasks:
- napi-identity-provider-wiring (bug: NAPI bypasses IdentityProvider)
- panic-free-static-config (code smell: panic/unwrap in production path)
- non-exhaustive-public-api (future-proofing public API types)
- adr-doc-comments (doc convention: ADR references in new modules)
- ssh-session-recv-stub-doc (documentation: mark stubs as planned)

2026-06-08 04:35:52 +00:00

1.7 KiB

Raw Blame History

id, name, status, depends_on, scope, risk, impact, level

name

status

depends_on

scope

risk

impact

level

cleanup/non-exhaustive-public-api

Add

pending

review/phase1-core-modifications

narrow

low

component

implementation

Description

Several public API types introduced in Phase 1 are likely to gain variants or fields in future phases. Adding #[non_exhaustive] now prevents downstream breakage when new variants/fields are added.

Types to annotate:

ForwardingAction — may gain new actions beyond Allow/Deny
TargetPattern — may gain new pattern types
OperationType — may gain new operation kinds
InterfaceConfig — will gain new interface types (HTTP/WS, DNS)
ForwardingRule — may gain new matching fields
DynamicConfig — will gain new sections
CallError — may gain new fields

Note: TransportKind already has Dns and WebTransport as tags-only and is likely to gain variants too, but it may already be exhaustively matched in some code. Check first before annotating.

Acceptance Criteria

#[non_exhaustive] added to enums/structs listed above
All match statements on these types updated with wildcard arms where needed
All existing tests pass
No new warnings from clippy

References

crates/alknet-core/src/config/forwarding.rs — ForwardingAction, TargetPattern, ForwardingRule
crates/alknet-core/src/call/spec.rs — OperationType
crates/alknet-core/src/interface/mod.rs — InterfaceConfig
crates/alknet-core/src/config/dynamic_config.rs — DynamicConfig
crates/alknet-core/src/call/response.rs — CallError

Notes

Suggested during Phase 1 review (S1)

Summary

To be filled on completion

1.7 KiB Raw Blame History