ziti/controller/handler_ctrl/circuit_confirmation.go

/*
	Copyright NetFoundry Inc.

	Licensed under the Apache License, Version 2.0 (the "License");
	you may not use this file except in compliance with the License.
	You may obtain a copy of the License at

	https://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
*/

package handler_ctrl

import (
	"time"

	"github.com/michaelquigley/pfxlog"
	"github.com/openziti/channel/v5"
	"github.com/openziti/ziti/v2/common/pb/ctrl_pb"
	"github.com/openziti/ziti/v2/controller/model"
	"github.com/openziti/ziti/v2/controller/network"
	"github.com/sirupsen/logrus"
	"google.golang.org/protobuf/proto"
)

type circuitConfirmationHandler struct {
	n *network.Network
	r *model.Router
}

func newCircuitConfirmationHandler(n *network.Network, r *model.Router) *circuitConfirmationHandler {
	return &circuitConfirmationHandler{n, r}
}

func (self *circuitConfirmationHandler) ContentType() int32 {
	return int32(ctrl_pb.ContentType_CircuitConfirmationType)
}

func (self *circuitConfirmationHandler) HandleReceive(msg *channel.Message, _ channel.Channel) {
	log := logrus.WithField("routerId", self.r.Id)
	confirm := &ctrl_pb.CircuitConfirmation{}
	if err := proto.Unmarshal(msg.Body, confirm); err == nil {
		log.WithField("circuitCount", len(confirm.CircuitIds)).Info("received circuit confirmation request")
		for _, circuitId := range confirm.CircuitIds {
			if circuit, found := self.n.GetCircuit(circuitId); found && circuit.HasRouter(self.r.Id) {
				self.checkCircuitMaxIdle(circuit, confirm)
			} else {
				go self.sendUnroute(circuitId)
			}
		}
	} else {
		log.WithError(err).Error("error unmarshalling circuit confirmation")
	}
}

func (self *circuitConfirmationHandler) checkCircuitMaxIdle(circuit *model.Circuit, confirm *ctrl_pb.CircuitConfirmation) {
	log := logrus.WithField("routerId", self.r.Id).WithField("circuitId", circuit.Id)

	service, _ := self.n.Service.Read(circuit.ServiceId)
	if service == nil {
		log.Info("service for circuit gone, removing idle circuit")
		if err := self.n.RemoveCircuit(circuit.Id, true); err != nil {
			log.WithError(err).Error("error removing idle circuit with no service")
		}
		return
	}

	idleTime, hasIdleTime := confirm.IdleTimes[circuit.Id]
	if !hasIdleTime {
		log.Debug("circuit found, no idle time reported, ignoring")
		return
	}

	log = log.WithField("idleTime", time.Duration(idleTime).String()).
		WithField("maxIdleTime", service.MaxIdleTime.String())

	if service.MaxIdleTime == 0 || time.Duration(idleTime) < service.MaxIdleTime {
		log.Debug("circuit found, max idle time not exceeded, ignoring")
		return
	}

	if !circuit.IsEndpointRouter(self.r.Id) {
		log.Debug("circuit found, max idle time exceeded, but not reported by initiating or terminating router")
		return
	}

	log.Infof("removing idle circuit, idle time of %s exceeds max idle time of %s",
		time.Duration(idleTime).String(), service.MaxIdleTime.String())

	if err := self.n.RemoveCircuit(circuit.Id, true); err != nil {
		log.WithError(err).Error("error removing idle circuit which has exceeded max idle time")
	}
}

func (self *circuitConfirmationHandler) sendUnroute(circuitId string) {
	log := pfxlog.Logger().WithField("circuitId", circuitId).WithField("routerId", self.r.Id)
	unroute := &ctrl_pb.Unroute{}
	unroute.CircuitId = circuitId
	unroute.Now = true
	if body, err := proto.Marshal(unroute); err == nil {
		msg := channel.NewMessage(int32(ctrl_pb.ContentType_UnrouteType), body)
		if err = self.r.Control.GetHighPrioritySender().Send(msg); err == nil {
			log.Debug("sent unroute to router for circuit")
		} else {
			log.WithError(err).Error("error sending unroute to router for circuit")
		}
	} else {
		log.WithError(err).Error("error marshalling unroute to router for circuit")
	}
}