mirror of
https://github.com/kerberos-io/onvif.git
synced 2026-08-23 15:08:33 +00:00
a1fc7832ef
Previously stream.go was a 621-line monolith holding the Stream type,
SOAP plumbing, pull loop, renew loop, recreate logic and jitter. The
test side had grown five orphan files (renew_test.go, reconnect_test.go,
soap_test.go, jitter_test.go, coverage_test.go) with no matching source
files. The mismatch made it harder than necessary to find the code
that backed a given test.
This commit splits stream.go by concern so each source file has its
own test file alongside it. Files <100 LOC (errors, jitter) were folded
into their conceptual parents rather than left as fragments.
New layout — 8 source + 8 test + helpers (test utility) + doc:
stream.go <-> stream_test.go Stream type, Options, lifecycle
soap.go <-> soap_test.go SOAP plumbing + fault detection
renew.go <-> renew_test.go Renew loop and absolute time
reconnect.go <-> reconnect_test.go Pull loop, recreate, jitter
decode.go <-> decode_test.go NotificationMessage -> Event
types.go <-> types_test.go Event types + typed errors
topics.go <-> topics_test.go Classifier table
doc.go Package godoc landing page
helpers_test.go waitFor (test-only utility)
Mergers
-------
* errors.go (typed error wrappers, 42 LOC) -> types.go. ErrPullFailed /
ErrRenewFailed / ErrRecreateFailed are part of the type system, not a
separate concern.
* jitter.go (40 LOC) -> reconnect.go. jitter is an implementation detail
of attemptRecreate, used nowhere else.
Test distribution
-----------------
* coverage_test.go was a catch-all; tests moved to the file matching
the function under test:
- Close*, NewStream_*, FakeCaller_* -> stream_test.go
- DisableReconnect_*, RecreateResets_*, PullPointMutation_* ->
reconnect_test.go
- Decode_*, ExtractState_* -> decode_test.go
* soap_test.go shed the two orphans that did not belong there:
- TestRenew_SendsAbsoluteDateTimeNotDuration -> renew_test.go
- TestClose_BoundedByTimeoutOnHungUnsubscribe -> stream_test.go
* errors_test.go's pure type tests -> types_test.go
* errors_test.go's Stream-integration tests -> reconnect_test.go
* jitter_test.go -> reconnect_test.go
No behaviour change. Test suite passes -race clean.
65 lines
2.0 KiB
Go
65 lines
2.0 KiB
Go
package stream
|
|
|
|
import (
|
|
"context"
|
|
"encoding/xml"
|
|
"fmt"
|
|
"time"
|
|
|
|
"github.com/kerberos-io/onvif/event"
|
|
"github.com/kerberos-io/onvif/xsd"
|
|
)
|
|
|
|
// renewLoop refreshes the subscription before InitialTermination expires.
|
|
// Exits when ctx is cancelled. Renew failures surface as ErrRenewFailed
|
|
// on the Errors channel; the loop continues because a permanently
|
|
// failing renew will eventually drop the subscription and the pull
|
|
// loop's reconnect path will recover (recreate is the only reliable
|
|
// recovery once a subscription is GC'd at the camera).
|
|
func (s *Stream) renewLoop(ctx context.Context) {
|
|
interval := s.opts.InitialTermination - s.opts.RenewMargin
|
|
if interval <= 0 {
|
|
// Pathological config (margin >= termination): fall back to
|
|
// renewing at half the termination so we still refresh,
|
|
// rather than busy-looping or never renewing.
|
|
interval = s.opts.InitialTermination / 2
|
|
if interval <= 0 {
|
|
interval = time.Second
|
|
}
|
|
}
|
|
ticker := time.NewTicker(interval)
|
|
defer ticker.Stop()
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
return
|
|
case <-ticker.C:
|
|
if err := renewPullPoint(s.caller, s.getPullPoint(), s.opts); err != nil {
|
|
s.surfaceError(ErrRenewFailed{Err: err})
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// renewPullPoint issues a wsnt:Renew SOAP against the given
|
|
// subscription endpoint with an absolute TerminationTime.
|
|
//
|
|
// WS-BaseNotification §6.1.1 declares TerminationTime as xsd:dateTime
|
|
// OR xsd:duration, but older Hikvision, some Dahua and some Bosch
|
|
// firmwares reject the relative-duration form. We send an absolute
|
|
// UTC datetime to match what production NVRs do.
|
|
func renewPullPoint(c caller, endpoint string, opts Options) error {
|
|
absoluteEnd := time.Now().UTC().Add(opts.InitialTermination).Format("2006-01-02T15:04:05Z")
|
|
req := event.Renew{TerminationTime: xsd.String(absoluteEnd)}
|
|
body, err := xml.Marshal(req)
|
|
if err != nil {
|
|
return fmt.Errorf("marshal Renew: %w", err)
|
|
}
|
|
resp, err := c.SendSoap(endpoint, string(body))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
_, err = readClose(resp)
|
|
return err
|
|
}
|