/* Real-time Online/Offline Charging System (OCS) for Telecom & ISP environments Copyright (C) ITsysCOM GmbH This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see */ package services import ( "fmt" "sync" "time" "github.com/cgrates/cgrates/servmanager" "github.com/cgrates/cgrates/utils" ) // NewStateDependencies sets up state tracking using buffered channels, where // each service state has its own channel and they pass around a single signal. func NewStateDependencies(servStates []string) (stDeps *StateDependencies) { stDeps = &StateDependencies{stateDeps: make(map[string]chan struct{})} for _, stateID := range servStates { stDeps.stateDeps[stateID] = make(chan struct{}, 1) // non-blocking } // A single state signal is shared between all state channels. // Initially placed in SERVICE_DOWN during initialization. c, has := stDeps.stateDeps[utils.StateServiceDOWN] if !has { panic(fmt.Sprintf("missing required initial state %q", utils.StateServiceDOWN)) } c <- struct{}{} return } // StateDependencies enhances a service with state dependencies management type StateDependencies struct { stateDeps map[string]chan struct{} // listeners for various states of the service stateDepsMux sync.RWMutex // protects stateDeps } // RegisterStateDependency will be called by a service interested by specific stateID of the service func (sDs *StateDependencies) StateChan(stateID string) (retChan chan struct{}) { sDs.stateDepsMux.RLock() retChan = sDs.stateDeps[stateID] sDs.stateDepsMux.RUnlock() return } // WaitForServicesToReachState ensures each service reaches the desired state, with the timeout applied individually per service. // Returns a map of service names to their instances or an error if any service fails to reach its state within its timeout window. func WaitForServicesToReachState(state string, serviceIDs []string, registry *servmanager.ServiceRegistry, timeout time.Duration, ) (map[string]servmanager.Service, error) { services := make(map[string]servmanager.Service, len(serviceIDs)) for _, serviceID := range serviceIDs { srv, err := WaitForServiceState(state, serviceID, registry, timeout) if err != nil { return nil, err } services[srv.ServiceName()] = srv } return services, nil } // WaitForServiceState waits up to timeout duration for a service to reach the specified state. // Returns the service instance or an error if the timeout is exceeded. func WaitForServiceState(state, serviceID string, registry *servmanager.ServiceRegistry, timeout time.Duration, ) (servmanager.Service, error) { srv := registry.Lookup(serviceID) if !srv.ShouldRun() { switch serviceID { case utils.AnalyzerS: // Return disabled analyzer service immediately since dependent // services still need the instance. return srv, nil case utils.AttributeS: // Don't make DispatcherS wait when AttributeS is disabled. return srv, nil } } stateCh := srv.StateChan(state) select { case <-stateCh: stateCh <- struct{}{} return srv, nil case <-time.After(timeout): return nil, fmt.Errorf("timed out waiting for service %q state %q", serviceID, state) } }