|
| 1 | +/* |
| 2 | + * === This file is part of ALICE O² === |
| 3 | + * |
| 4 | + * LHC integration plugin: listens for BeamMode updates and notifies |
| 5 | + * the environment manager via NotifyIntegratedServiceEvent when BeamMode |
| 6 | + * (BeamMode enum change) occurs. Supports a Kafka-based client (kafka://) |
| 7 | + * or a local stub client for testing. |
| 8 | + */ |
| 9 | + |
| 10 | +package lhc |
| 11 | + |
| 12 | +import ( |
| 13 | + "context" |
| 14 | + "encoding/json" |
| 15 | + "errors" |
| 16 | + "github.com/AliceO2Group/Control/common/event/topic" |
| 17 | + "github.com/AliceO2Group/Control/common/logger/infologger" |
| 18 | + pb "github.com/AliceO2Group/Control/common/protos" |
| 19 | + "io" |
| 20 | + "sync" |
| 21 | + "time" |
| 22 | + |
| 23 | + cmnevent "github.com/AliceO2Group/Control/common/event" |
| 24 | + "github.com/AliceO2Group/Control/common/logger" |
| 25 | + "github.com/AliceO2Group/Control/common/utils/uid" |
| 26 | + "github.com/AliceO2Group/Control/core/environment" |
| 27 | + "github.com/AliceO2Group/Control/core/integration" |
| 28 | + lhcevent "github.com/AliceO2Group/Control/core/integration/lhc/event" |
| 29 | + "github.com/sirupsen/logrus" |
| 30 | + "github.com/spf13/viper" |
| 31 | +) |
| 32 | + |
| 33 | +var log = logger.New(logrus.StandardLogger(), "lhcclient") |
| 34 | +var dipClientTopic topic.Topic = "todo" |
| 35 | + |
| 36 | +// Plugin implements integration.Plugin and listens for LHC updates. |
| 37 | +type Plugin struct { |
| 38 | + endpoint string |
| 39 | + ctx context.Context |
| 40 | + //cancel context.CancelFunc |
| 41 | + //wg sync.WaitGroup |
| 42 | + mu sync.Mutex |
| 43 | + currentState *pb.BeamInfo |
| 44 | + reader cmnevent.Reader |
| 45 | +} |
| 46 | + |
| 47 | +func NewPlugin(endpoint string) integration.Plugin { |
| 48 | + |
| 49 | + return &Plugin{endpoint: endpoint, mu: sync.Mutex{}, currentState: &pb.BeamInfo{BeamMode: pb.BeamMode_UNKNOWN}} |
| 50 | +} |
| 51 | + |
| 52 | +func (p *Plugin) Init(_ string) error { |
| 53 | + |
| 54 | + // use a background context for reader loop; Destroy will Close the reader |
| 55 | + p.ctx = context.Background() |
| 56 | + |
| 57 | + p.reader = cmnevent.NewReaderWithTopic(dipClientTopic, "", true) |
| 58 | + |
| 59 | + if p.reader == nil { |
| 60 | + return errors.New("could not create a kafka reader for LHC plugin") |
| 61 | + } |
| 62 | + go p.readAndInjectLhcUpdates() |
| 63 | + |
| 64 | + log.Debug("LHC plugin initialized (client started)") |
| 65 | + return nil |
| 66 | +} |
| 67 | + |
| 68 | +func (p *Plugin) GetName() string { return "lhc" } |
| 69 | +func (p *Plugin) GetPrettyName() string { return "LHC (DIP/Kafka client)" } |
| 70 | +func (p *Plugin) GetEndpoint() string { return viper.GetString("kafkaEndpoints") } |
| 71 | + |
| 72 | +func (p *Plugin) GetConnectionState() string { |
| 73 | + if p == nil || p.reader == nil { |
| 74 | + return "UNKNOWN" |
| 75 | + } |
| 76 | + return "READY" // Unfortunately, kafka.Reader does not provide any GetStatus method |
| 77 | +} |
| 78 | + |
| 79 | +func (p *Plugin) GetData(_ []any) string { |
| 80 | + p.mu.Lock() |
| 81 | + defer p.mu.Unlock() |
| 82 | + b, _ := json.Marshal(&p.currentState) // todo see if this works like that |
| 83 | + return string(b) |
| 84 | +} |
| 85 | + |
| 86 | +func (p *Plugin) GetEnvironmentsData(envIds []uid.ID) map[uid.ID]string { |
| 87 | + // there is nothing sensible we could provide here, LHC client is not environment-specific |
| 88 | + return nil |
| 89 | +} |
| 90 | + |
| 91 | +func (p *Plugin) GetEnvironmentsShortData(envIds []uid.ID) map[uid.ID]string { |
| 92 | + return p.GetEnvironmentsData(envIds) |
| 93 | +} |
| 94 | + |
| 95 | +func (p *Plugin) ObjectStack(_ map[string]string, _ map[string]string) (stack map[string]interface{}) { |
| 96 | + return make(map[string]interface{}) |
| 97 | +} |
| 98 | +func (p *Plugin) CallStack(_ interface{}) (stack map[string]interface{}) { |
| 99 | + return make(map[string]interface{}) |
| 100 | +} |
| 101 | + |
| 102 | +func (p *Plugin) Destroy() error { |
| 103 | + // todo add mutex? |
| 104 | + if p == nil { |
| 105 | + return nil |
| 106 | + } |
| 107 | + |
| 108 | + if p.reader != nil { |
| 109 | + err := p.reader.Close() |
| 110 | + if err != nil { |
| 111 | + return err |
| 112 | + } |
| 113 | + } |
| 114 | + return nil |
| 115 | +} |
| 116 | + |
| 117 | +func (p *Plugin) readAndInjectLhcUpdates() { |
| 118 | + for { |
| 119 | + msg, err := p.reader.Next(p.ctx) |
| 120 | + if errors.Is(err, io.EOF) { |
| 121 | + // todo log healthy end of stream |
| 122 | + log.WithField(infologger.Level, infologger.IL_Support). |
| 123 | + Debug("received an EOF from Kafka reader, likely cancellation was requested, breaking") |
| 124 | + break |
| 125 | + } |
| 126 | + if err != nil { |
| 127 | + log.WithField(infologger.Level, infologger.IL_Support). |
| 128 | + WithError(err).Error("error while reading from Kafka") |
| 129 | + // in case of errors, we throttle the loop to mitigate the risk a log spam if error persists |
| 130 | + time.Sleep(time.Second * 1) |
| 131 | + continue |
| 132 | + } |
| 133 | + if msg == nil { |
| 134 | + log.WithField(infologger.Level, infologger.IL_Devel). |
| 135 | + Warn("received an empty message with no error. it's unexpected, but continuing") |
| 136 | + continue |
| 137 | + } |
| 138 | + |
| 139 | + if bmEvt := msg.GetBeamModeEvent(); bmEvt != nil && bmEvt.GetBeamInfo() != nil { |
| 140 | + beamInfo := bmEvt.GetBeamInfo() |
| 141 | + // update plugin state |
| 142 | + p.mu.Lock() |
| 143 | + p.currentState = beamInfo |
| 144 | + p.mu.Unlock() |
| 145 | + |
| 146 | + // convert to internal LHC event and notify environment manager |
| 147 | + go func(beamInfo *pb.BeamInfo) { |
| 148 | + envMan := environment.ManagerInstance() |
| 149 | + |
| 150 | + ev := &lhcevent.LhcStateChangeEvent{ |
| 151 | + IntegratedServiceEventBase: cmnevent.IntegratedServiceEventBase{ServiceName: "LHC"}, |
| 152 | + BeamInfo: lhcevent.BeamInfo{ |
| 153 | + BeamMode: beamInfo.GetBeamMode(), |
| 154 | + StableBeamsStart: beamInfo.GetStableBeamsStart(), |
| 155 | + StableBeamsEnd: beamInfo.GetStableBeamsEnd(), |
| 156 | + FillNumber: beamInfo.GetFillNumber(), |
| 157 | + FillingSchemeName: beamInfo.GetFillingSchemeName(), |
| 158 | + BeamType: beamInfo.GetBeamType(), |
| 159 | + }, |
| 160 | + } |
| 161 | + envMan.NotifyIntegratedServiceEvent(ev) |
| 162 | + }(beamInfo) |
| 163 | + continue |
| 164 | + } |
| 165 | + } |
| 166 | +} |
0 commit comments