Public invitations could stop after an early tunnel-process exit, and connection progress and Viewer status did not consistently describe the current attempt or Host state. This maintenance release adds bounded startup retries, aligns enhanced NAT retry feedback across entry paths, and fixes camera-preview and room-entry layout. The existing route owner and published contracts remain in place. Four-attempt progress is advertised and opted into; older readers retain supported messages. Interaction/chat experiments are outside this PR. Validation: npm run check (74 files, 1072 tests and production build), npm run check:go (including Windows capture compile), documentation/repository hygiene, 10 production Viewer-entry discovery cases, and a real public-link gate with remote HTTP/WebSocket access and shutdown cleanup all passed. Existing device/network evidence limits remain documented. ## Release notes ### 中文 这是一次维护更新,重点改善公网邀请启动、连接重试反馈和分享状态提示,并修正两处界面布局问题。 - 公网邀请服务在连接就绪前意外退出时,会自动重试,最多重试 3 次;所有尝试仍共用 30 秒启动预算。 - 增强穿透连接在首次尝试失败后最多重试 3 次,重试进度显示为 1/3、2/3、3/3。邀请链接和房间号加入都支持新版进度提示。 - 修正观众状态提示:房主离线时不再误报“没有可用的媒体线路”,服务器连接恢复与媒体恢复也会分别呈现。 - 修正电视内房间号输入界面的居中位置,以及摄像头选择预览被裁切的问题。 - 尚未确认来源声音状态时,不再提前提示“未分享来源声音”。 本次保持现有版本兼容;新版重试进度需要页面与服务端均支持。额外重试不能保证所有网络都能直连。 ### English This maintenance update improves public invitation startup, connection retry feedback, and sharing status messages, with two layout fixes. - If the public invitation service exits before connecting, Piik retries up to three times within the existing shared 30-second startup budget. - Enhanced NAT traversal now allows up to three retries after the initial attempt, shown as 1/3, 2/3, and 3/3. Both invitation links and room-code entry support the updated progress display. - Viewer status now distinguishes an offline host from an unavailable media route, and reports server reconnection separately from media recovery. - Fixed the alignment of room-code entry inside the TV and cropping in camera-selection previews. - The missing-source-audio notice now waits until the source's audio availability is known. Existing version compatibility is preserved. Updated retry progress requires support from both the page and server. Additional retries cannot guarantee a direct connection on every network.
941 lines
32 KiB
Go
941 lines
32 KiB
Go
package route
|
|
|
|
import (
|
|
"crypto/sha256"
|
|
"errors"
|
|
"math"
|
|
"sort"
|
|
"strings"
|
|
|
|
"github.com/TNTcraftHIM/Piik/internal/server/ordered"
|
|
"github.com/TNTcraftHIM/Piik/internal/server/protocol"
|
|
)
|
|
|
|
const (
|
|
maxDirectHeadStartMs int64 = 5_000
|
|
maxNatConnectionAttempts = 4
|
|
sfuOpportunityPrefix = "sfu\x00"
|
|
maxSafeInteger int64 = protocol.MaxSafeInteger
|
|
qualityEvidenceExpiryMs int64 = protocol.ViewerQualityEvidenceExpiryMs
|
|
persistentDegradedWindows = int64(protocol.PersistentNativeEdgeDegradedWindows)
|
|
)
|
|
|
|
// candidateOpportunity is one consumed-ledger entry (TS CandidateOpportunity).
|
|
type candidateOpportunity struct {
|
|
rank int
|
|
startedAttempts int
|
|
exhausted bool
|
|
}
|
|
|
|
// participant is a known peer (TS Participant). sessionID "" is the TS
|
|
// null: disconnected but in grace, or departed. Wire session IDs are
|
|
// validated opaque IDs, so an empty string never names a live session;
|
|
// bootstrapFailureReported and sfuFirstAtNextRoute are TS `true | undefined`
|
|
// and only ever compared to true, so a bool is exact.
|
|
type participant struct {
|
|
peerID string
|
|
role protocol.Role
|
|
sessionID string
|
|
departureConfirmed bool
|
|
joinOrder int64
|
|
effectiveDownstreamCapacity int
|
|
availabilityExhausted bool
|
|
consumedCandidateOpportunities ordered.Map[string, candidateOpportunity]
|
|
bootstrapFailureReported bool
|
|
sfuFirstAtNextRoute bool
|
|
}
|
|
|
|
// sessionIs ports `participant.sessionId === id`: a disconnected
|
|
// participant (TS null) never equals any session string.
|
|
func (p *participant) sessionIs(id string) bool {
|
|
return p.sessionID != "" && p.sessionID == id
|
|
}
|
|
|
|
// senderQualityIdentity is TS SenderQualityIdentity.
|
|
type senderQualityIdentity struct {
|
|
childSessionID string
|
|
parentPeerID string
|
|
parentSessionID string
|
|
connectionID string
|
|
senderIdentity string
|
|
}
|
|
|
|
// attempt is the live candidate (TS Attempt). The optional strings use ""
|
|
// for undefined (they are only ever set to non-empty values or compared
|
|
// after a truthiness check); the optional timestamps are pointers because
|
|
// 0 is a legal accepted/sample time and `!== undefined` is semantic.
|
|
type attempt struct {
|
|
tuple CandidateTuple
|
|
revision int64
|
|
connectionID string
|
|
childSessionID string
|
|
parentSessionID string
|
|
hostSessionID string
|
|
publicationGeneration string
|
|
publicationConnectionID string
|
|
reservation CandidateReservation
|
|
startedAtMs int64
|
|
transportConnected bool
|
|
mediaReady bool
|
|
connectionAttempt *ConnectionAttemptProgress
|
|
senderQualityState SenderQualityState // "" = undefined
|
|
senderQualityAcceptedAtMs *int64
|
|
senderQualityConsecutiveHealthyWindows int64 // read only through `?? 0`
|
|
senderQualityConsecutiveDegradedWindows int64 // read only through `?? 0`
|
|
senderQualitySampleTimestampMs *int64
|
|
senderQualityIdentity string // "" = undefined
|
|
relativeQualityApprovedAtMs *int64
|
|
}
|
|
|
|
// operation is the single in-flight route operation (TS ChildOperation).
|
|
type operation struct {
|
|
childPeerID string
|
|
childSessionID string
|
|
demandPeerID string
|
|
demandSessionID string
|
|
reason DemandReason
|
|
baseRevision int64
|
|
candidates []CandidatePlan
|
|
cursor int
|
|
deadlineAtMs int64
|
|
builtAtFactVersion int64
|
|
deferredParentPeerIDs []string
|
|
peerAttemptStarted bool
|
|
qualitySource *senderQualityIdentity
|
|
current *attempt
|
|
}
|
|
|
|
// planAt ports `operation.candidates[index]`: nil when out of range. It
|
|
// returns a copy because the candidate array is spliced in place and TS
|
|
// plan objects are never mutated after construction.
|
|
func (o *operation) planAt(index int) *CandidatePlan {
|
|
if index < 0 || index >= len(o.candidates) {
|
|
return nil
|
|
}
|
|
plan := o.candidates[index]
|
|
return &plan
|
|
}
|
|
|
|
// planAtOrLast ports `operation.candidates[Math.min(cursor, length - 1)]`,
|
|
// which is undefined (nil) for an empty array.
|
|
func (o *operation) planAtOrLast() *CandidatePlan {
|
|
return o.planAt(min(o.cursor, len(o.candidates)-1))
|
|
}
|
|
|
|
// currentTuple ports `operation.current?.tuple ?? operation.candidates[operation.cursor]?.tuple`.
|
|
func (o *operation) currentTuple() *CandidateTuple {
|
|
if o.current != nil {
|
|
tuple := o.current.tuple
|
|
return &tuple
|
|
}
|
|
if plan := o.planAt(o.cursor); plan != nil {
|
|
return &plan.Tuple
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// directContinuation is TS DirectContinuation; parentPeerIDs is the retry
|
|
// order and is spliced in place.
|
|
type directContinuation struct {
|
|
childSessionID string
|
|
sfuConnectionID string
|
|
publicationGeneration string
|
|
parentPeerIDs []string
|
|
}
|
|
|
|
type sfuBootstrapIntent struct {
|
|
demandPeerID string
|
|
demandSessionID string
|
|
}
|
|
|
|
type sfuBootstrapCarrier struct {
|
|
demandPeerID string
|
|
demandSessionID string
|
|
carrierPeerID string
|
|
}
|
|
|
|
// routeTimingRecord is TS RouteTimingRecord; the optional timestamps are
|
|
// pointers (undefined = never happened, distinct from 0).
|
|
type routeTimingRecord struct {
|
|
demandAtMs int64
|
|
reason DemandReason
|
|
operationStartedAtMs *int64
|
|
candidateStartedAtMs *int64
|
|
firstDecodedFrameAtMs *int64
|
|
finalAtMs *int64
|
|
finalRoute FinalRoute
|
|
rejectionBucket RejectionBucket
|
|
}
|
|
|
|
// routeQualityObservation is TS RouteQualityObservation. upstreamPeerID is
|
|
// "" for the sfu upstream (TS null); lastDecodedProgressAtMs nil is TS null.
|
|
type routeQualityObservation struct {
|
|
childSessionID string
|
|
upstreamKind UpstreamKind
|
|
upstreamPeerID string
|
|
connectionID string
|
|
presentationEpoch int64
|
|
eligibleWindows int64
|
|
eligibleDurationMs int64
|
|
freezeWindows int64
|
|
freezeCount int64
|
|
freezeDurationMs int64
|
|
pauseCount int64
|
|
pauseDurationMs int64
|
|
lastAcceptedAtMs int64
|
|
lastDecodedProgressAtMs *int64
|
|
}
|
|
|
|
// senderQualityObservation is TS SenderQualityObservation. The consumed
|
|
// ledger is a pointer because `{...previous}` copies carry the same Map.
|
|
type senderQualityObservation struct {
|
|
childSessionID string
|
|
parentPeerID string
|
|
parentSessionID string
|
|
connectionID string
|
|
senderIdentity string
|
|
state SenderQualityState
|
|
consecutiveDegradedWindows int64
|
|
lastSampleTimestampMs int64
|
|
lastAcceptedAtMs int64
|
|
consumedQualityCandidates *ordered.Map[string, int]
|
|
}
|
|
|
|
type sfuPublisherQualityObservation struct {
|
|
hostSessionID string
|
|
publicationGeneration string
|
|
state SenderQualityState
|
|
consecutiveHealthyWindows int64
|
|
lastSampleTimestampMs int64
|
|
lastAcceptedAtMs int64
|
|
}
|
|
|
|
// resourceSet is a JS Set<Resource>: pointer identity plus insertion order.
|
|
type resourceSet struct {
|
|
seen map[*Resource]struct{}
|
|
list []*Resource
|
|
}
|
|
|
|
func (s *resourceSet) add(resources ...*Resource) {
|
|
if s.seen == nil {
|
|
s.seen = make(map[*Resource]struct{})
|
|
}
|
|
for _, resource := range resources {
|
|
if _, ok := s.seen[resource]; ok {
|
|
continue
|
|
}
|
|
s.seen[resource] = struct{}{}
|
|
s.list = append(s.list, resource)
|
|
}
|
|
}
|
|
|
|
func (s *resourceSet) has(resource *Resource) bool {
|
|
_, ok := s.seen[resource]
|
|
return ok
|
|
}
|
|
|
|
// resources returns a fresh slice in insertion order (`[...set]`).
|
|
func (s *resourceSet) resources() []*Resource {
|
|
return append([]*Resource{}, s.list...)
|
|
}
|
|
|
|
// concatResources ports `[...a, ...b]` into a fresh, never-nil slice.
|
|
func concatResources(parts ...[]*Resource) []*Resource {
|
|
out := []*Resource{}
|
|
for _, part := range parts {
|
|
out = append(out, part...)
|
|
}
|
|
return out
|
|
}
|
|
|
|
// dedupeStrings ports `[...new Set(values)]`: first occurrence wins.
|
|
func dedupeStrings(values []string) []string {
|
|
seen := make(map[string]struct{}, len(values))
|
|
out := make([]string, 0, len(values))
|
|
for _, value := range values {
|
|
if _, ok := seen[value]; ok {
|
|
continue
|
|
}
|
|
seen[value] = struct{}{}
|
|
out = append(out, value)
|
|
}
|
|
return out
|
|
}
|
|
|
|
// New ports the constructor: panics with "Endpoint media copy capacity must
|
|
// be 1, 2, or 3" or "Route operation timeout must be a positive integer".
|
|
func New(options Options) *Controller {
|
|
if err := protocol.AssertEndpointMediaCopyCapacity(options.EndpointMediaCopyCapacity); err != nil {
|
|
panic(err)
|
|
}
|
|
if !isSafeInteger(options.OperationTimeoutMs) || options.OperationTimeoutMs <= 0 {
|
|
panic(errors.New("Route operation timeout must be a positive integer"))
|
|
}
|
|
c := &Controller{
|
|
hostPeerID: options.HostPeerID,
|
|
debugRoomID: options.DebugRoomID,
|
|
debugLog: options.DebugLog,
|
|
endpointMediaCopyCapacity: options.EndpointMediaCopyCapacity,
|
|
operationTimeoutMs: options.OperationTimeoutMs,
|
|
sfuEnabled: options.SfuEnabled,
|
|
qualityConvergenceEnabled: options.QualityConvergenceEnabled,
|
|
natPredictionEnabled: options.NatPredictionEnabled,
|
|
routeTimings: make(map[string]*routeTimingRecord),
|
|
qualityObservations: make(map[string]*routeQualityObservation),
|
|
senderQualityObservations: make(map[string]*senderQualityObservation),
|
|
senderQualityBaselines: make(map[string]bool),
|
|
senderQualityRegenerationBlocks: make(map[string]senderQualityIdentity),
|
|
qualityBaselinesPending: make(map[string]struct{}),
|
|
}
|
|
c.debug("controller-created",
|
|
"endpointCapacity", options.EndpointMediaCopyCapacity,
|
|
"operationTimeoutMs", options.OperationTimeoutMs,
|
|
"sfuEnabled", options.SfuEnabled,
|
|
"qualityConvergenceEnabled", options.QualityConvergenceEnabled)
|
|
return c
|
|
}
|
|
|
|
// DiagnosticParticipantLabel returns "host", "viewer-<joinOrder>" or
|
|
// "viewer-unknown" for a peer ID without exposing the ID.
|
|
func (c *Controller) DiagnosticParticipantLabel(peerID string) string {
|
|
return c.debugPeer(peerID)
|
|
}
|
|
|
|
// Revision is Snapshot().Revision without the graph copy, for the callers
|
|
// that only compare revisions before and after a mutation.
|
|
func (c *Controller) Revision() int64 { return c.revision }
|
|
|
|
// Operation is Snapshot().Operation without the graph copy: a deep copy of
|
|
// the in-flight operation, or nil when the controller is idle.
|
|
func (c *Controller) Operation() *OperationSnapshot { return c.operationSnapshot() }
|
|
|
|
// Publication is Snapshot().HostPublication without the graph copy: a copy
|
|
// of the single live SFU ingress, or nil when there is none.
|
|
func (c *Controller) Publication() *HostPublication {
|
|
if c.hostPublication == nil {
|
|
return nil
|
|
}
|
|
copied := *c.hostPublication
|
|
return &copied
|
|
}
|
|
|
|
// Snapshot returns a copy of the committed graph, the publication and the
|
|
// operation snapshot; it mutates nothing.
|
|
func (c *Controller) Snapshot() RouteSnapshot {
|
|
// The router iterates this map to build assignments.
|
|
upstream := &ordered.Map[string, CommittedEdge]{}
|
|
for id, edge := range c.upstreamByViewer.All() {
|
|
upstream.Set(id, *edge)
|
|
}
|
|
var publication *HostPublication
|
|
if c.hostPublication != nil {
|
|
copied := *c.hostPublication
|
|
publication = &copied
|
|
}
|
|
return RouteSnapshot{
|
|
Revision: c.revision,
|
|
Paused: c.paused,
|
|
FactVersion: c.factVersion,
|
|
UpstreamByViewer: upstream,
|
|
HostPublication: publication,
|
|
Operation: c.operationSnapshot(),
|
|
}
|
|
}
|
|
|
|
// RouteDiagnosticSnapshot returns the privacy-safe snapshot: connected
|
|
// viewers sorted by join order with snapshot-local ordinals and relative
|
|
// durations; operation is nil unless its demand peer has an ordinal.
|
|
func (c *Controller) RouteDiagnosticSnapshot(nowMs int64) protocol.RouteDiagnosticSnapshot {
|
|
viewers := []*participant{}
|
|
for _, current := range c.participants.Values() {
|
|
if current.role == protocol.RoleViewer && current.sessionID != "" && !current.departureConfirmed {
|
|
viewers = append(viewers, current)
|
|
}
|
|
}
|
|
sort.SliceStable(viewers, func(i, j int) bool { return compareParticipant(viewers[i], viewers[j]) < 0 })
|
|
ordinals := make(map[string]int, len(viewers))
|
|
for index, viewer := range viewers {
|
|
ordinals[viewer.peerID] = index + 1
|
|
}
|
|
children := make([]protocol.RouteDiagnosticChild, 0, len(viewers))
|
|
for _, viewer := range viewers {
|
|
edge, _ := c.upstreamByViewer.Get(viewer.peerID)
|
|
record := c.routeTimings[viewer.peerID]
|
|
finalRoute := c.currentFinalRoute(viewer.peerID)
|
|
childCount := 0
|
|
for _, childPeerID := range c.childrenOf(viewer.peerID) {
|
|
if childEdge, ok := c.upstreamByViewer.Get(childPeerID); ok && childEdge.Kind == UpstreamPeer && childEdge.PhysicalActive {
|
|
childCount++
|
|
}
|
|
}
|
|
child := protocol.RouteDiagnosticChild{
|
|
Ordinal: protocol.Int(ordinals[viewer.peerID]),
|
|
Parent: c.diagnosticParent(edge, ordinals),
|
|
EffectiveCapacity: protocol.Int(viewer.effectiveDownstreamCapacity),
|
|
ChildCount: protocol.Int(childCount),
|
|
FinalRoute: string(finalRoute),
|
|
RejectionBucket: string(RejectionNone),
|
|
Quality: c.diagnosticQuality(viewer.peerID, edge, nowMs),
|
|
}
|
|
if record != nil {
|
|
child.DemandAgeMs = elapsedMs(record.demandAtMs, nowMs)
|
|
if record.operationStartedAtMs != nil {
|
|
child.QueueWaitMs = elapsedMs(record.demandAtMs, *record.operationStartedAtMs)
|
|
}
|
|
if record.candidateStartedAtMs != nil {
|
|
child.CandidateStartMs = elapsedMs(record.demandAtMs, *record.candidateStartedAtMs)
|
|
}
|
|
if record.firstDecodedFrameAtMs != nil {
|
|
child.FirstDecodedFrameMs = elapsedMs(record.demandAtMs, *record.firstDecodedFrameAtMs)
|
|
}
|
|
if record.finalAtMs != nil {
|
|
child.FinalMs = elapsedMs(record.demandAtMs, *record.finalAtMs)
|
|
}
|
|
child.RejectionBucket = string(record.rejectionBucket)
|
|
}
|
|
if finalRoute == FinalRouteWaiting {
|
|
child.FinalRoute = string(FinalRouteWaiting)
|
|
if record != nil && record.finalRoute == FinalRouteFailed {
|
|
child.FinalRoute = string(FinalRouteFailed)
|
|
}
|
|
}
|
|
children = append(children, child)
|
|
}
|
|
var diagnosticOperation *protocol.RouteDiagnosticOperation
|
|
if op := c.operation; op != nil {
|
|
if childOrdinal, ok := ordinals[op.demandPeerID]; ok {
|
|
stage := "admission"
|
|
if op.current != nil {
|
|
stage = "first-frame"
|
|
if op.current.mediaReady {
|
|
stage = "quality-proof"
|
|
}
|
|
}
|
|
diagnosticOperation = &protocol.RouteDiagnosticOperation{
|
|
ChildOrdinal: protocol.Int(childOrdinal),
|
|
Reason: string(op.reason),
|
|
Stage: stage,
|
|
Cursor: protocol.Int(op.cursor),
|
|
CandidateCount: protocol.Int(len(op.candidates)),
|
|
}
|
|
}
|
|
}
|
|
return protocol.RouteDiagnosticSnapshot{Children: children, Operation: diagnosticOperation}
|
|
}
|
|
|
|
// UpsertParticipant adds or updates a participant, aborting an operation
|
|
// that used a replaced session; a viewer without a usable route records a
|
|
// "join" demand when nowMs is non-nil. Panics on a Host/role inconsistency.
|
|
func (c *Controller) UpsertParticipant(input ParticipantInput, nowMs *int64) []*Resource {
|
|
if (input.PeerID == c.hostPeerID) != (input.Role == protocol.RoleHost) {
|
|
panic(errors.New("Route Host identity is inconsistent"))
|
|
}
|
|
capacity := c.effectiveCapacity(input.EffectiveDownstreamCapacity)
|
|
current, _ := c.participants.Get(input.PeerID)
|
|
released := []*Resource{}
|
|
if current != nil && current.role != input.Role {
|
|
panic(errors.New("Route role cannot change"))
|
|
}
|
|
if current != nil {
|
|
changed := false
|
|
previousSessionID := current.sessionID
|
|
if previousSessionID != input.SessionID {
|
|
c.clearOpportunitiesForSessionChange(input.PeerID, input.Role)
|
|
c.clearQualityForParticipant(input.PeerID)
|
|
if c.operationUsesParticipantSession(input.PeerID) {
|
|
released = append(released, c.abortOperation(nowMs, RejectionStale)...)
|
|
}
|
|
c.directContinuations.Delete(input.PeerID)
|
|
c.clearSfuBootstrapForDemand(input.PeerID)
|
|
current.sessionID = input.SessionID
|
|
c.rebindCommittedSession(input.PeerID, input.SessionID)
|
|
changed = true
|
|
}
|
|
if current.departureConfirmed {
|
|
current.departureConfirmed = false
|
|
changed = true
|
|
}
|
|
if current.effectiveDownstreamCapacity != capacity {
|
|
current.effectiveDownstreamCapacity = capacity
|
|
changed = true
|
|
}
|
|
if changed {
|
|
c.touchFacts()
|
|
c.debug("participant-updated",
|
|
"participant", c.debugPeer(input.PeerID),
|
|
"capacity", capacity,
|
|
"sessionChanged", previousSessionID != input.SessionID)
|
|
}
|
|
if input.Role == protocol.RoleViewer && nowMs != nil && !c.usableRoute(input.PeerID) {
|
|
c.recordDemand(input.PeerID, *nowMs, DemandJoin)
|
|
}
|
|
return released
|
|
}
|
|
// A new key appends to the insertion order (TS Map.set at 573).
|
|
c.participants.Set(input.PeerID, &participant{
|
|
peerID: input.PeerID,
|
|
role: input.Role,
|
|
sessionID: input.SessionID,
|
|
effectiveDownstreamCapacity: capacity,
|
|
joinOrder: c.nextJoinOrder,
|
|
})
|
|
c.nextJoinOrder++
|
|
c.debug("participant-joined",
|
|
"participant", c.debugPeer(input.PeerID),
|
|
"role", input.Role,
|
|
"capacity", capacity)
|
|
if input.Role == protocol.RoleViewer && nowMs != nil {
|
|
c.recordDemand(input.PeerID, *nowMs, DemandJoin)
|
|
}
|
|
c.touchFacts()
|
|
return released
|
|
}
|
|
|
|
// RebindHostIdentity moves the Host to a new peer ID (same ID delegates to
|
|
// UpsertParticipant), tearing down the whole graph and returning every SFU
|
|
// subscription, the publication and the aborted reservation, deduplicated.
|
|
func (c *Controller) RebindHostIdentity(peerID, sessionID string, nowMs *int64) []*Resource {
|
|
previousPeerID := c.hostPeerID
|
|
if peerID == previousPeerID {
|
|
return c.UpsertParticipant(ParticipantInput{
|
|
PeerID: peerID,
|
|
Role: protocol.RoleHost,
|
|
SessionID: sessionID,
|
|
EffectiveDownstreamCapacity: c.endpointMediaCopyCapacity,
|
|
}, nowMs)
|
|
}
|
|
if c.participants.Has(peerID) {
|
|
panic(errors.New("Route Host identity collides with another participant"))
|
|
}
|
|
host, _ := c.participants.Get(previousPeerID)
|
|
if host == nil || host.role != protocol.RoleHost {
|
|
panic(errors.New("Route Host identity is unavailable"))
|
|
}
|
|
|
|
// Aborted reservation, then SFU edges in map
|
|
// order, then the publication, deduplicated.
|
|
released := &resourceSet{}
|
|
if c.operation != nil {
|
|
released.add(c.abortOperation(nowMs, RejectionStale)...)
|
|
}
|
|
for _, edge := range c.upstreamByViewer.Values() {
|
|
if edge.Kind == UpstreamSfu && edge.PhysicalActive {
|
|
released.add(edge.Resource)
|
|
}
|
|
}
|
|
if c.hostPublication != nil && c.hostPublication.PhysicalActive {
|
|
released.add(c.hostPublication.Resource)
|
|
}
|
|
c.upstreamByViewer.Clear()
|
|
c.hostPublication = nil
|
|
clear(c.routeTimings)
|
|
clear(c.qualityObservations)
|
|
clear(c.senderQualityObservations)
|
|
clear(c.senderQualityBaselines)
|
|
clear(c.senderQualityRegenerationBlocks)
|
|
clear(c.qualityBaselinesPending)
|
|
c.sfuPublisherQualityObservation = nil
|
|
c.directContinuations.Clear()
|
|
c.retiringPublicationGenerations.Clear()
|
|
c.sfuBootstrapIntent = nil
|
|
c.consumedSfuBootstrapOpportunities.Clear()
|
|
c.rootConvergenceRootPeerID = ""
|
|
// Demand is re-recorded in participants order.
|
|
for _, current := range c.participants.Values() {
|
|
current.availabilityExhausted = false
|
|
current.bootstrapFailureReported = false
|
|
current.sfuFirstAtNextRoute = false
|
|
current.consumedCandidateOpportunities.Clear()
|
|
if current.role == protocol.RoleViewer && current.sessionID != "" && nowMs != nil {
|
|
c.recordDemand(current.peerID, *nowMs, DemandEdgeUnavailable)
|
|
}
|
|
}
|
|
|
|
// Delete + set moves the Host to the tail of the
|
|
// insertion order while it keeps its joinOrder.
|
|
c.participants.Delete(previousPeerID)
|
|
host.peerID = peerID
|
|
host.sessionID = sessionID
|
|
host.departureConfirmed = false
|
|
c.participants.Set(peerID, host)
|
|
c.hostPeerID = peerID
|
|
c.revision = c.allocateRevision()
|
|
c.touchFacts()
|
|
c.assertGraph()
|
|
return released.resources()
|
|
}
|
|
|
|
// DisconnectSession marks the participant's exact session as gone (grace
|
|
// state, no revision change); false when the session does not match.
|
|
func (c *Controller) DisconnectSession(peerID, sessionID string) bool {
|
|
current, _ := c.participants.Get(peerID)
|
|
if current == nil || !current.sessionIs(sessionID) {
|
|
return false
|
|
}
|
|
c.clearOpportunitiesForSessionChange(peerID, current.role)
|
|
current.sessionID = ""
|
|
c.clearQualityForParticipant(peerID)
|
|
c.directContinuations.Delete(peerID)
|
|
c.clearSfuBootstrapForDemand(peerID)
|
|
c.touchFacts()
|
|
c.debug("participant-disconnected", "participant", c.debugPeer(peerID))
|
|
return true
|
|
}
|
|
|
|
// ConfirmDeparture finalises a viewer's departure (capacity 0, demand
|
|
// recorded for its children when nowMs is non-nil); false for the Host or
|
|
// an unknown peer; idempotent.
|
|
func (c *Controller) ConfirmDeparture(peerID string, nowMs *int64) bool {
|
|
current, _ := c.participants.Get(peerID)
|
|
if current == nil || current.role == protocol.RoleHost {
|
|
return false
|
|
}
|
|
delete(c.routeTimings, peerID)
|
|
if current.departureConfirmed && current.sessionID == "" && current.effectiveDownstreamCapacity == 0 {
|
|
return true
|
|
}
|
|
c.clearOpportunitiesForSessionChange(peerID, current.role)
|
|
current.sessionID = ""
|
|
c.clearQualityForParticipant(peerID)
|
|
current.departureConfirmed = true
|
|
current.effectiveDownstreamCapacity = 0
|
|
c.directContinuations.Delete(peerID)
|
|
c.clearSfuBootstrapForDemand(peerID)
|
|
if nowMs != nil {
|
|
for _, childPeerID := range c.childrenOf(peerID) {
|
|
c.recordDemand(childPeerID, *nowMs, DemandParentDeparted)
|
|
}
|
|
}
|
|
c.touchFacts()
|
|
c.debug("participant-departed", "participant", c.debugPeer(peerID))
|
|
return true
|
|
}
|
|
|
|
// SetEffectiveCapacity clamps and stores the participant's downstream
|
|
// capacity for the matching session; true even when unchanged (facts are
|
|
// touched only on change).
|
|
func (c *Controller) SetEffectiveCapacity(peerID, sessionID string, value int, nowMs *int64) bool {
|
|
current, _ := c.participants.Get(peerID)
|
|
if current == nil || !current.sessionIs(sessionID) {
|
|
return false
|
|
}
|
|
capacity := c.effectiveCapacity(value)
|
|
if current.effectiveDownstreamCapacity == capacity {
|
|
return true
|
|
}
|
|
current.effectiveDownstreamCapacity = capacity
|
|
if nowMs != nil {
|
|
for _, childPeerID := range c.overflowPeerChildren(peerID) {
|
|
c.recordDemand(childPeerID, *nowMs, DemandCapacityReduction)
|
|
}
|
|
}
|
|
c.touchFacts()
|
|
c.debug("capacity-updated", "participant", c.debugPeer(peerID), "capacity", capacity)
|
|
return true
|
|
}
|
|
|
|
// TouchExternalFacts reopens every SFU opportunity after an external fact
|
|
// change (for example a share generation) and bumps the fact version.
|
|
func (c *Controller) TouchExternalFacts() {
|
|
c.clearSfuCandidateOpportunities()
|
|
c.sfuBootstrapIntent = nil
|
|
c.touchFacts()
|
|
}
|
|
|
|
// InvalidateEdge marks the exactly identified edge unusable and records an
|
|
// "edge-unavailable" demand; true when the guard matched (idempotent).
|
|
func (c *Controller) InvalidateEdge(guard EdgeGuard, nowMs *int64) bool {
|
|
child, _ := c.participants.Get(guard.ChildPeerID)
|
|
edge, _ := c.upstreamByViewer.Get(guard.ChildPeerID)
|
|
if child == nil || !child.sessionIs(guard.ChildSessionID) || c.revision != guard.RouteRevision ||
|
|
edge == nil || edge.ConnectionID != guard.ConnectionID ||
|
|
edge.ChildSessionID != guard.ChildSessionID ||
|
|
(edge.Kind == UpstreamPeer && edge.ParentSessionID != guard.ParentSessionID) {
|
|
return false
|
|
}
|
|
if edge.Usable {
|
|
c.consumeActiveEdgeOpportunity(child, edge)
|
|
c.clearQualityForParticipant(guard.ChildPeerID)
|
|
edge.Usable = false
|
|
c.directContinuations.Delete(guard.ChildPeerID)
|
|
child.availabilityExhausted = false
|
|
child.bootstrapFailureReported = false
|
|
c.touchFacts()
|
|
if nowMs != nil {
|
|
c.recordDemand(guard.ChildPeerID, *nowMs, DemandEdgeUnavailable)
|
|
}
|
|
}
|
|
return true
|
|
}
|
|
|
|
// InvalidateDirectEdgeFromParent invalidates the first committed direct edge
|
|
// (insertion order) matching the parent-side guard.
|
|
func (c *Controller) InvalidateDirectEdgeFromParent(input ParentEdgeGuard, nowMs *int64) bool {
|
|
// First match in insertion order wins.
|
|
for childPeerID, edge := range c.upstreamByViewer.All() {
|
|
if edge.Kind == UpstreamPeer &&
|
|
edge.ParentPeerID == input.ParentPeerID &&
|
|
edge.ParentSessionID == input.ParentSessionID &&
|
|
edge.ConnectionID == input.ConnectionID {
|
|
return c.InvalidateEdge(EdgeGuard{
|
|
ChildPeerID: childPeerID,
|
|
ChildSessionID: edge.ChildSessionID,
|
|
ParentSessionID: input.ParentSessionID,
|
|
RouteRevision: input.RouteRevision,
|
|
ConnectionID: input.ConnectionID,
|
|
}, nowMs)
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// InvalidateHostPublication marks the identified publication unusable and
|
|
// records demand for every SFU child; true when the guard matched (idempotent).
|
|
func (c *Controller) InvalidateHostPublication(guard PublicationGuard, nowMs *int64) bool {
|
|
publication := c.hostPublication
|
|
if publication == nil || c.revision != guard.RouteRevision ||
|
|
publication.HostSessionID != guard.HostSessionID ||
|
|
publication.Generation != guard.Generation ||
|
|
publication.ConnectionID != guard.ConnectionID {
|
|
return false
|
|
}
|
|
if publication.Usable {
|
|
c.clearSfuQuality()
|
|
publication.Usable = false
|
|
c.directContinuations.Clear()
|
|
c.sfuBootstrapIntent = nil
|
|
if nowMs != nil {
|
|
for childPeerID, edge := range c.upstreamByViewer.All() {
|
|
if edge.Kind == UpstreamSfu {
|
|
c.recordDemand(childPeerID, *nowMs, DemandEdgeUnavailable)
|
|
}
|
|
}
|
|
}
|
|
c.touchFacts()
|
|
}
|
|
return true
|
|
}
|
|
|
|
// AdoptDirectConnection accepts a replacement for the exact active edge.
|
|
// Recovery supersedes optional preparation for that child when the replacement
|
|
// arrives. Required availability work, including capacity reduction, keeps priority.
|
|
func (c *Controller) AdoptDirectConnection(input AdoptDirectConnectionInput, nowMs int64) SettleResult {
|
|
result := SettleResult{ActiveRevision: c.revision}
|
|
edge, _ := c.upstreamByViewer.Get(input.ChildPeerID)
|
|
if c.revision != input.RouteRevision ||
|
|
edge == nil ||
|
|
edge.Kind != UpstreamPeer ||
|
|
edge.Transport != TransportDirect ||
|
|
!edge.Usable ||
|
|
!edge.PhysicalActive ||
|
|
edge.ChildSessionID != input.ChildSessionID ||
|
|
edge.ParentSessionID != input.ParentSessionID ||
|
|
edge.ConnectionID != input.ConnectionID ||
|
|
input.NewConnectionID == "" {
|
|
return result
|
|
}
|
|
if input.NewConnectionID == edge.ConnectionID {
|
|
result.Accepted = true
|
|
return result
|
|
}
|
|
if op := c.operation; op != nil && op.childPeerID == input.ChildPeerID {
|
|
if isAvailabilityOperation(op.reason) {
|
|
return result
|
|
}
|
|
result.Released = c.abortOperation(&nowMs, RejectionAborted)
|
|
}
|
|
c.clearQualityForParticipant(input.ChildPeerID)
|
|
edge.ConnectionID = input.NewConnectionID
|
|
if child, ok := c.participants.Get(input.ChildPeerID); ok {
|
|
child.availabilityExhausted = false
|
|
}
|
|
c.touchFacts()
|
|
result.Accepted = true
|
|
result.ActiveRevision = c.revision
|
|
return result
|
|
}
|
|
|
|
// RetireHostPublication retires the physically active publication and its
|
|
// subscriptions when no attempt is live and the guard matches, returning the
|
|
// subscriptions then the publication resource; empty otherwise.
|
|
func (c *Controller) RetireHostPublication(guard PublicationGuard) []*Resource {
|
|
publication := c.hostPublication
|
|
if (c.operation != nil && c.operation.current != nil) || publication == nil || !publication.PhysicalActive ||
|
|
c.revision != guard.RouteRevision ||
|
|
publication.HostSessionID != guard.HostSessionID ||
|
|
publication.Generation != guard.Generation ||
|
|
publication.ConnectionID != guard.ConnectionID {
|
|
return []*Resource{}
|
|
}
|
|
// Subscriptions in map order, then the publication.
|
|
released := []*Resource{}
|
|
for viewerPeerID, edge := range c.upstreamByViewer.All() {
|
|
if edge.Kind == UpstreamSfu && edge.PublicationGeneration == publication.Generation {
|
|
c.retireSfuEdge(viewerPeerID, edge, &released, c.retainsAnchor(viewerPeerID))
|
|
}
|
|
}
|
|
publication.PhysicalActive = false
|
|
publication.Usable = false
|
|
c.hostPublication = nil
|
|
c.clearSfuQuality()
|
|
c.revision = c.allocateRevision()
|
|
if c.operation != nil {
|
|
c.operation.baseRevision = c.revision
|
|
}
|
|
c.touchFacts()
|
|
released = append(released, publication.Resource)
|
|
c.pruneRetiringSfuAnchors()
|
|
return released
|
|
}
|
|
|
|
// SetPaused pauses (aborting the operation and clearing quality state) or
|
|
// resumes; returns the aborted reservation's resources.
|
|
func (c *Controller) SetPaused(paused bool, nowMs *int64) []*Resource {
|
|
if c.paused == paused {
|
|
return []*Resource{}
|
|
}
|
|
c.paused = paused
|
|
if paused {
|
|
clear(c.qualityObservations)
|
|
clear(c.qualityBaselinesPending)
|
|
clear(c.senderQualityObservations)
|
|
clear(c.senderQualityBaselines)
|
|
clear(c.senderQualityRegenerationBlocks)
|
|
c.sfuPublisherQualityObservation = nil
|
|
}
|
|
c.touchFacts()
|
|
if paused {
|
|
return c.abortOperation(nowMs, RejectionAborted)
|
|
}
|
|
return []*Resource{}
|
|
}
|
|
|
|
// Dispose clears all state, pauses the controller and returns the live
|
|
// reservation's resources then every committed resource, deduplicated.
|
|
func (c *Controller) Dispose() []*Resource {
|
|
// Reservation first, then committed resources.
|
|
resources := &resourceSet{}
|
|
if c.operation != nil && c.operation.current != nil {
|
|
resources.add(reservationResources(c.operation.current.reservation)...)
|
|
}
|
|
resources.add(c.committedResources()...)
|
|
c.operation = nil
|
|
c.upstreamByViewer.Clear()
|
|
clear(c.qualityObservations)
|
|
clear(c.qualityBaselinesPending)
|
|
clear(c.senderQualityObservations)
|
|
clear(c.senderQualityBaselines)
|
|
clear(c.senderQualityRegenerationBlocks)
|
|
c.sfuPublisherQualityObservation = nil
|
|
c.hostPublication = nil
|
|
c.participants.Clear()
|
|
clear(c.routeTimings)
|
|
c.directContinuations.Clear()
|
|
c.retiringPublicationGenerations.Clear()
|
|
c.sfuBootstrapIntent = nil
|
|
c.consumedSfuBootstrapOpportunities.Clear()
|
|
c.rootConvergenceRootPeerID = ""
|
|
// nextJoinOrder, revision, latestRevision and factVersion survive.
|
|
c.paused = true
|
|
return resources.resources()
|
|
}
|
|
|
|
// abortOperation finishes demand timing when nowMs is given, releases the live
|
|
// reservation and clears the operation.
|
|
func (c *Controller) abortOperation(nowMs *int64, bucket RejectionBucket) []*Resource {
|
|
if c.operation == nil {
|
|
return []*Resource{}
|
|
}
|
|
if nowMs != nil {
|
|
c.finishTiming(c.operation.demandPeerID, *nowMs, c.currentFinalRoute(c.operation.demandPeerID), bucket, false)
|
|
}
|
|
op := c.operation
|
|
released := []*Resource{}
|
|
if op.current != nil {
|
|
released = reservationResources(op.current.reservation)
|
|
c.advanceActiveRevision(op)
|
|
}
|
|
c.operation = nil
|
|
return released
|
|
}
|
|
|
|
func (c *Controller) operationUsesParticipantSession(peerID string) bool {
|
|
op := c.operation
|
|
if op == nil {
|
|
return false
|
|
}
|
|
if op.childPeerID == peerID || op.demandPeerID == peerID {
|
|
return true
|
|
}
|
|
tuple := op.currentTuple()
|
|
if tuple != nil && tuple.Kind == UpstreamPeer {
|
|
return tuple.ParentPeerID == peerID
|
|
}
|
|
return peerID == c.hostPeerID
|
|
}
|
|
|
|
// effectiveCapacity panics "Effective capacity is invalid" for
|
|
// a negative or unsafe value and clamps to the endpoint capacity.
|
|
func (c *Controller) effectiveCapacity(value int) int {
|
|
if !isSafeInteger(int64(value)) || value < 0 {
|
|
panic(errors.New("Effective capacity is invalid"))
|
|
}
|
|
return min(value, c.endpointMediaCopyCapacity)
|
|
}
|
|
|
|
func (c *Controller) touchFacts() { c.factVersion++ }
|
|
|
|
// allocateRevision bounds revisions by MAX_SAFE_INTEGER.
|
|
func (c *Controller) allocateRevision() int64 {
|
|
if c.latestRevision >= protocol.MaxMediaRouteRevision {
|
|
panic(errors.New("Media route revision space exhausted"))
|
|
}
|
|
c.latestRevision++
|
|
return c.latestRevision
|
|
}
|
|
|
|
// isSafeInteger is Number.isSafeInteger for a value that is already integral.
|
|
func isSafeInteger(value int64) bool {
|
|
return value >= -maxSafeInteger && value <= maxSafeInteger
|
|
}
|
|
|
|
// joinOrder is allocated once per participant and preserved across
|
|
// rebindHostIdentity, so two live
|
|
// participants never share one and the TS localeCompare (ICU) tiebreak is
|
|
// unreachable; strings.Compare stands in for it.
|
|
func compareParticipant(left, right *participant) int {
|
|
if left.joinOrder != right.joinOrder {
|
|
if left.joinOrder < right.joinOrder {
|
|
return -1
|
|
}
|
|
return 1
|
|
}
|
|
return strings.Compare(left.peerID, right.peerID)
|
|
}
|
|
|
|
// stablePairRank returns the first 6 bytes, big-endian, of
|
|
// sha256(child + "\0" + parent). Byte-exact: it breaks parent ties.
|
|
func stablePairRank(childPeerID, parentPeerID string) int64 {
|
|
sum := sha256.Sum256([]byte(childPeerID + "\x00" + parentPeerID))
|
|
var rank int64
|
|
for _, b := range sum[:6] {
|
|
rank = rank<<8 | int64(b)
|
|
}
|
|
return rank
|
|
}
|
|
|
|
// JS Math.round is half-up while math.Round is half-away-from-zero;
|
|
// they differ only for negative halves, which the
|
|
// `rounded < 0` branch drops either way. NaN and +/-Inf drop the window.
|
|
func safeAdd(total int64, delta float64) int64 {
|
|
rounded := math.Round(delta)
|
|
if math.IsNaN(rounded) || math.IsInf(rounded, 0) || rounded < 0 || rounded > float64(maxSafeInteger) {
|
|
return total
|
|
}
|
|
value := int64(rounded)
|
|
if value > maxSafeInteger-total {
|
|
return maxSafeInteger
|
|
}
|
|
return total + value
|
|
}
|