Scott Baker | 2d89798 | 2019-09-24 11:50:08 -0700 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2018-present Open Networking Foundation |
| 3 | |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package kafka |
| 17 | |
| 18 | import ( |
| 19 | "context" |
| 20 | "errors" |
| 21 | "fmt" |
| 22 | "github.com/golang/protobuf/proto" |
| 23 | "github.com/golang/protobuf/ptypes" |
| 24 | "github.com/golang/protobuf/ptypes/any" |
| 25 | "github.com/google/uuid" |
| 26 | "github.com/opencord/voltha-go/common/log" |
| 27 | ic "github.com/opencord/voltha-protos/go/inter_container" |
| 28 | "reflect" |
| 29 | "strings" |
| 30 | "sync" |
| 31 | "time" |
| 32 | ) |
| 33 | |
| 34 | // Initialize the logger - gets the default until the main function setup the logger |
| 35 | func init() { |
| 36 | log.AddPackage(log.JSON, log.DebugLevel, nil) |
| 37 | } |
| 38 | |
| 39 | const ( |
| 40 | DefaultMaxRetries = 3 |
| 41 | DefaultRequestTimeout = 10000 // 10000 milliseconds - to handle a wider latency range |
| 42 | ) |
| 43 | |
| 44 | const ( |
| 45 | TransactionKey = "transactionID" |
| 46 | FromTopic = "fromTopic" |
| 47 | ) |
| 48 | |
| 49 | // requestHandlerChannel represents an interface associated with a channel. Whenever, an event is |
| 50 | // obtained from that channel, this interface is invoked. This is used to handle |
| 51 | // async requests into the Core via the kafka messaging bus |
| 52 | type requestHandlerChannel struct { |
| 53 | requesthandlerInterface interface{} |
| 54 | ch <-chan *ic.InterContainerMessage |
| 55 | } |
| 56 | |
| 57 | // transactionChannel represents a combination of a topic and a channel onto which a response received |
| 58 | // on the kafka bus will be sent to |
| 59 | type transactionChannel struct { |
| 60 | topic *Topic |
| 61 | ch chan *ic.InterContainerMessage |
| 62 | } |
| 63 | |
| 64 | // InterContainerProxy represents the messaging proxy |
| 65 | type InterContainerProxy struct { |
| 66 | kafkaHost string |
| 67 | kafkaPort int |
| 68 | DefaultTopic *Topic |
| 69 | defaultRequestHandlerInterface interface{} |
| 70 | deviceDiscoveryTopic *Topic |
| 71 | kafkaClient Client |
| 72 | doneCh chan int |
| 73 | |
| 74 | // This map is used to map a topic to an interface and channel. When a request is received |
| 75 | // on that channel (registered to the topic) then that interface is invoked. |
| 76 | topicToRequestHandlerChannelMap map[string]*requestHandlerChannel |
| 77 | lockTopicRequestHandlerChannelMap sync.RWMutex |
| 78 | |
| 79 | // This map is used to map a channel to a response topic. This channel handles all responses on that |
| 80 | // channel for that topic and forward them to the appropriate consumers channel, using the |
| 81 | // transactionIdToChannelMap. |
| 82 | topicToResponseChannelMap map[string]<-chan *ic.InterContainerMessage |
| 83 | lockTopicResponseChannelMap sync.RWMutex |
| 84 | |
| 85 | // This map is used to map a transaction to a consumers channel. This is used whenever a request has been |
| 86 | // sent out and we are waiting for a response. |
| 87 | transactionIdToChannelMap map[string]*transactionChannel |
| 88 | lockTransactionIdToChannelMap sync.RWMutex |
| 89 | } |
| 90 | |
| 91 | type InterContainerProxyOption func(*InterContainerProxy) |
| 92 | |
| 93 | func InterContainerHost(host string) InterContainerProxyOption { |
| 94 | return func(args *InterContainerProxy) { |
| 95 | args.kafkaHost = host |
| 96 | } |
| 97 | } |
| 98 | |
| 99 | func InterContainerPort(port int) InterContainerProxyOption { |
| 100 | return func(args *InterContainerProxy) { |
| 101 | args.kafkaPort = port |
| 102 | } |
| 103 | } |
| 104 | |
| 105 | func DefaultTopic(topic *Topic) InterContainerProxyOption { |
| 106 | return func(args *InterContainerProxy) { |
| 107 | args.DefaultTopic = topic |
| 108 | } |
| 109 | } |
| 110 | |
| 111 | func DeviceDiscoveryTopic(topic *Topic) InterContainerProxyOption { |
| 112 | return func(args *InterContainerProxy) { |
| 113 | args.deviceDiscoveryTopic = topic |
| 114 | } |
| 115 | } |
| 116 | |
| 117 | func RequestHandlerInterface(handler interface{}) InterContainerProxyOption { |
| 118 | return func(args *InterContainerProxy) { |
| 119 | args.defaultRequestHandlerInterface = handler |
| 120 | } |
| 121 | } |
| 122 | |
| 123 | func MsgClient(client Client) InterContainerProxyOption { |
| 124 | return func(args *InterContainerProxy) { |
| 125 | args.kafkaClient = client |
| 126 | } |
| 127 | } |
| 128 | |
| 129 | func NewInterContainerProxy(opts ...InterContainerProxyOption) (*InterContainerProxy, error) { |
| 130 | proxy := &InterContainerProxy{ |
| 131 | kafkaHost: DefaultKafkaHost, |
| 132 | kafkaPort: DefaultKafkaPort, |
| 133 | } |
| 134 | |
| 135 | for _, option := range opts { |
| 136 | option(proxy) |
| 137 | } |
| 138 | |
| 139 | // Create the locks for all the maps |
| 140 | proxy.lockTopicRequestHandlerChannelMap = sync.RWMutex{} |
| 141 | proxy.lockTransactionIdToChannelMap = sync.RWMutex{} |
| 142 | proxy.lockTopicResponseChannelMap = sync.RWMutex{} |
| 143 | |
| 144 | return proxy, nil |
| 145 | } |
| 146 | |
| 147 | func (kp *InterContainerProxy) Start() error { |
| 148 | log.Info("Starting-Proxy") |
| 149 | |
| 150 | // Kafka MsgClient should already have been created. If not, output fatal error |
| 151 | if kp.kafkaClient == nil { |
| 152 | log.Fatal("kafka-client-not-set") |
| 153 | } |
| 154 | |
| 155 | // Create the Done channel |
| 156 | kp.doneCh = make(chan int, 1) |
| 157 | |
| 158 | // Start the kafka client |
| 159 | if err := kp.kafkaClient.Start(); err != nil { |
| 160 | log.Errorw("Cannot-create-kafka-proxy", log.Fields{"error": err}) |
| 161 | return err |
| 162 | } |
| 163 | |
| 164 | // Create the topic to response channel map |
| 165 | kp.topicToResponseChannelMap = make(map[string]<-chan *ic.InterContainerMessage) |
| 166 | // |
| 167 | // Create the transactionId to Channel Map |
| 168 | kp.transactionIdToChannelMap = make(map[string]*transactionChannel) |
| 169 | |
| 170 | // Create the topic to request channel map |
| 171 | kp.topicToRequestHandlerChannelMap = make(map[string]*requestHandlerChannel) |
| 172 | |
| 173 | return nil |
| 174 | } |
| 175 | |
| 176 | func (kp *InterContainerProxy) Stop() { |
| 177 | log.Info("stopping-intercontainer-proxy") |
| 178 | kp.doneCh <- 1 |
| 179 | // TODO : Perform cleanup |
| 180 | kp.kafkaClient.Stop() |
| 181 | //kp.deleteAllTopicRequestHandlerChannelMap() |
| 182 | //kp.deleteAllTopicResponseChannelMap() |
| 183 | //kp.deleteAllTransactionIdToChannelMap() |
| 184 | } |
| 185 | |
| 186 | // DeviceDiscovered publish the discovered device onto the kafka messaging bus |
| 187 | func (kp *InterContainerProxy) DeviceDiscovered(deviceId string, deviceType string, parentId string, publisher string) error { |
| 188 | log.Debugw("sending-device-discovery-msg", log.Fields{"deviceId": deviceId}) |
| 189 | // Simple validation |
| 190 | if deviceId == "" || deviceType == "" { |
| 191 | log.Errorw("invalid-parameters", log.Fields{"id": deviceId, "type": deviceType}) |
| 192 | return errors.New("invalid-parameters") |
| 193 | } |
| 194 | // Create the device discovery message |
| 195 | header := &ic.Header{ |
| 196 | Id: uuid.New().String(), |
| 197 | Type: ic.MessageType_DEVICE_DISCOVERED, |
| 198 | FromTopic: kp.DefaultTopic.Name, |
| 199 | ToTopic: kp.deviceDiscoveryTopic.Name, |
| 200 | Timestamp: time.Now().UnixNano(), |
| 201 | } |
| 202 | body := &ic.DeviceDiscovered{ |
| 203 | Id: deviceId, |
| 204 | DeviceType: deviceType, |
| 205 | ParentId: parentId, |
| 206 | Publisher: publisher, |
| 207 | } |
| 208 | |
| 209 | var marshalledData *any.Any |
| 210 | var err error |
| 211 | if marshalledData, err = ptypes.MarshalAny(body); err != nil { |
| 212 | log.Errorw("cannot-marshal-request", log.Fields{"error": err}) |
| 213 | return err |
| 214 | } |
| 215 | msg := &ic.InterContainerMessage{ |
| 216 | Header: header, |
| 217 | Body: marshalledData, |
| 218 | } |
| 219 | |
| 220 | // Send the message |
| 221 | if err := kp.kafkaClient.Send(msg, kp.deviceDiscoveryTopic); err != nil { |
| 222 | log.Errorw("cannot-send-device-discovery-message", log.Fields{"error": err}) |
| 223 | return err |
| 224 | } |
| 225 | return nil |
| 226 | } |
| 227 | |
| 228 | // InvokeRPC is used to send a request to a given topic |
| 229 | func (kp *InterContainerProxy) InvokeRPC(ctx context.Context, rpc string, toTopic *Topic, replyToTopic *Topic, |
| 230 | waitForResponse bool, key string, kvArgs ...*KVArg) (bool, *any.Any) { |
| 231 | |
| 232 | // If a replyToTopic is provided then we use it, otherwise just use the default toTopic. The replyToTopic is |
| 233 | // typically the device ID. |
| 234 | responseTopic := replyToTopic |
| 235 | if responseTopic == nil { |
| 236 | responseTopic = kp.DefaultTopic |
| 237 | } |
| 238 | |
| 239 | // Encode the request |
| 240 | protoRequest, err := encodeRequest(rpc, toTopic, responseTopic, key, kvArgs...) |
| 241 | if err != nil { |
| 242 | log.Warnw("cannot-format-request", log.Fields{"rpc": rpc, "error": err}) |
| 243 | return false, nil |
| 244 | } |
| 245 | |
| 246 | // Subscribe for response, if needed, before sending request |
| 247 | var ch <-chan *ic.InterContainerMessage |
| 248 | if waitForResponse { |
| 249 | var err error |
| 250 | if ch, err = kp.subscribeForResponse(*responseTopic, protoRequest.Header.Id); err != nil { |
| 251 | log.Errorw("failed-to-subscribe-for-response", log.Fields{"error": err, "toTopic": toTopic.Name}) |
| 252 | } |
| 253 | } |
| 254 | |
| 255 | // Send request - if the topic is formatted with a device Id then we will send the request using a |
| 256 | // specific key, hence ensuring a single partition is used to publish the request. This ensures that the |
| 257 | // subscriber on that topic will receive the request in the order it was sent. The key used is the deviceId. |
| 258 | //key := GetDeviceIdFromTopic(*toTopic) |
| 259 | log.Debugw("sending-msg", log.Fields{"rpc": rpc, "toTopic": toTopic, "replyTopic": responseTopic, "key": key, "xId": protoRequest.Header.Id}) |
| 260 | go kp.kafkaClient.Send(protoRequest, toTopic, key) |
| 261 | |
| 262 | if waitForResponse { |
| 263 | // Create a child context based on the parent context, if any |
| 264 | var cancel context.CancelFunc |
| 265 | childCtx := context.Background() |
| 266 | if ctx == nil { |
| 267 | ctx, cancel = context.WithTimeout(context.Background(), DefaultRequestTimeout*time.Millisecond) |
| 268 | } else { |
| 269 | childCtx, cancel = context.WithTimeout(ctx, DefaultRequestTimeout*time.Millisecond) |
| 270 | } |
| 271 | defer cancel() |
| 272 | |
| 273 | // Wait for response as well as timeout or cancellation |
| 274 | // Remove the subscription for a response on return |
| 275 | defer kp.unSubscribeForResponse(protoRequest.Header.Id) |
| 276 | select { |
| 277 | case msg, ok := <-ch: |
| 278 | if !ok { |
| 279 | log.Warnw("channel-closed", log.Fields{"rpc": rpc, "replyTopic": replyToTopic.Name}) |
| 280 | protoError := &ic.Error{Reason: "channel-closed"} |
| 281 | var marshalledArg *any.Any |
| 282 | if marshalledArg, err = ptypes.MarshalAny(protoError); err != nil { |
| 283 | return false, nil // Should never happen |
| 284 | } |
| 285 | return false, marshalledArg |
| 286 | } |
| 287 | log.Debugw("received-response", log.Fields{"rpc": rpc, "msgHeader": msg.Header}) |
| 288 | var responseBody *ic.InterContainerResponseBody |
| 289 | var err error |
| 290 | if responseBody, err = decodeResponse(msg); err != nil { |
| 291 | log.Errorw("decode-response-error", log.Fields{"error": err}) |
| 292 | } |
| 293 | return responseBody.Success, responseBody.Result |
| 294 | case <-ctx.Done(): |
| 295 | log.Debugw("context-cancelled", log.Fields{"rpc": rpc, "ctx": ctx.Err()}) |
| 296 | // pack the error as proto any type |
| 297 | protoError := &ic.Error{Reason: ctx.Err().Error()} |
| 298 | var marshalledArg *any.Any |
| 299 | if marshalledArg, err = ptypes.MarshalAny(protoError); err != nil { |
| 300 | return false, nil // Should never happen |
| 301 | } |
| 302 | return false, marshalledArg |
| 303 | case <-childCtx.Done(): |
| 304 | log.Debugw("context-cancelled", log.Fields{"rpc": rpc, "ctx": childCtx.Err()}) |
| 305 | // pack the error as proto any type |
| 306 | protoError := &ic.Error{Reason: childCtx.Err().Error()} |
| 307 | var marshalledArg *any.Any |
| 308 | if marshalledArg, err = ptypes.MarshalAny(protoError); err != nil { |
| 309 | return false, nil // Should never happen |
| 310 | } |
| 311 | return false, marshalledArg |
| 312 | case <-kp.doneCh: |
| 313 | log.Infow("received-exit-signal", log.Fields{"toTopic": toTopic.Name, "rpc": rpc}) |
| 314 | return true, nil |
| 315 | } |
| 316 | } |
| 317 | return true, nil |
| 318 | } |
| 319 | |
| 320 | // SubscribeWithRequestHandlerInterface allows a caller to assign a target object to be invoked automatically |
| 321 | // when a message is received on a given topic |
| 322 | func (kp *InterContainerProxy) SubscribeWithRequestHandlerInterface(topic Topic, handler interface{}) error { |
| 323 | |
| 324 | // Subscribe to receive messages for that topic |
| 325 | var ch <-chan *ic.InterContainerMessage |
| 326 | var err error |
| 327 | if ch, err = kp.kafkaClient.Subscribe(&topic); err != nil { |
| 328 | //if ch, err = kp.Subscribe(topic); err != nil { |
| 329 | log.Errorw("failed-to-subscribe", log.Fields{"error": err, "topic": topic.Name}) |
| 330 | return err |
| 331 | } |
| 332 | |
| 333 | kp.defaultRequestHandlerInterface = handler |
| 334 | kp.addToTopicRequestHandlerChannelMap(topic.Name, &requestHandlerChannel{requesthandlerInterface: handler, ch: ch}) |
| 335 | // Launch a go routine to receive and process kafka messages |
| 336 | go kp.waitForMessages(ch, topic, handler) |
| 337 | |
| 338 | return nil |
| 339 | } |
| 340 | |
| 341 | // SubscribeWithDefaultRequestHandler allows a caller to add a topic to an existing target object to be invoked automatically |
| 342 | // when a message is received on a given topic. So far there is only 1 target registered per microservice |
| 343 | func (kp *InterContainerProxy) SubscribeWithDefaultRequestHandler(topic Topic, initialOffset int64) error { |
| 344 | // Subscribe to receive messages for that topic |
| 345 | var ch <-chan *ic.InterContainerMessage |
| 346 | var err error |
| 347 | if ch, err = kp.kafkaClient.Subscribe(&topic, &KVArg{Key: Offset, Value: initialOffset}); err != nil { |
| 348 | log.Errorw("failed-to-subscribe", log.Fields{"error": err, "topic": topic.Name}) |
| 349 | return err |
| 350 | } |
| 351 | kp.addToTopicRequestHandlerChannelMap(topic.Name, &requestHandlerChannel{requesthandlerInterface: kp.defaultRequestHandlerInterface, ch: ch}) |
| 352 | |
| 353 | // Launch a go routine to receive and process kafka messages |
| 354 | go kp.waitForMessages(ch, topic, kp.defaultRequestHandlerInterface) |
| 355 | |
| 356 | return nil |
| 357 | } |
| 358 | |
| 359 | func (kp *InterContainerProxy) UnSubscribeFromRequestHandler(topic Topic) error { |
| 360 | return kp.deleteFromTopicRequestHandlerChannelMap(topic.Name) |
| 361 | } |
| 362 | |
| 363 | // setupTopicResponseChannelMap sets up single consumers channel that will act as a broadcast channel for all |
| 364 | // responses from that topic. |
| 365 | func (kp *InterContainerProxy) setupTopicResponseChannelMap(topic string, arg <-chan *ic.InterContainerMessage) { |
| 366 | kp.lockTopicResponseChannelMap.Lock() |
| 367 | defer kp.lockTopicResponseChannelMap.Unlock() |
| 368 | if _, exist := kp.topicToResponseChannelMap[topic]; !exist { |
| 369 | kp.topicToResponseChannelMap[topic] = arg |
| 370 | } |
| 371 | } |
| 372 | |
| 373 | func (kp *InterContainerProxy) isTopicSubscribedForResponse(topic string) bool { |
| 374 | kp.lockTopicResponseChannelMap.RLock() |
| 375 | defer kp.lockTopicResponseChannelMap.RUnlock() |
| 376 | _, exist := kp.topicToResponseChannelMap[topic] |
| 377 | return exist |
| 378 | } |
| 379 | |
| 380 | func (kp *InterContainerProxy) deleteFromTopicResponseChannelMap(topic string) error { |
| 381 | kp.lockTopicResponseChannelMap.Lock() |
| 382 | defer kp.lockTopicResponseChannelMap.Unlock() |
| 383 | if _, exist := kp.topicToResponseChannelMap[topic]; exist { |
| 384 | // Unsubscribe to this topic first - this will close the subscribed channel |
| 385 | var err error |
| 386 | if err = kp.kafkaClient.UnSubscribe(&Topic{Name: topic}, kp.topicToResponseChannelMap[topic]); err != nil { |
| 387 | log.Errorw("unsubscribing-error", log.Fields{"topic": topic}) |
| 388 | } |
| 389 | delete(kp.topicToResponseChannelMap, topic) |
| 390 | return err |
| 391 | } else { |
| 392 | return errors.New(fmt.Sprintf("%s-Topic-not-found", topic)) |
| 393 | } |
| 394 | } |
| 395 | |
| 396 | func (kp *InterContainerProxy) deleteAllTopicResponseChannelMap() error { |
| 397 | kp.lockTopicResponseChannelMap.Lock() |
| 398 | defer kp.lockTopicResponseChannelMap.Unlock() |
| 399 | var err error |
| 400 | for topic, _ := range kp.topicToResponseChannelMap { |
| 401 | // Unsubscribe to this topic first - this will close the subscribed channel |
| 402 | if err = kp.kafkaClient.UnSubscribe(&Topic{Name: topic}, kp.topicToResponseChannelMap[topic]); err != nil { |
| 403 | log.Errorw("unsubscribing-error", log.Fields{"topic": topic, "error": err}) |
| 404 | } |
| 405 | delete(kp.topicToResponseChannelMap, topic) |
| 406 | } |
| 407 | return err |
| 408 | } |
| 409 | |
| 410 | func (kp *InterContainerProxy) addToTopicRequestHandlerChannelMap(topic string, arg *requestHandlerChannel) { |
| 411 | kp.lockTopicRequestHandlerChannelMap.Lock() |
| 412 | defer kp.lockTopicRequestHandlerChannelMap.Unlock() |
| 413 | if _, exist := kp.topicToRequestHandlerChannelMap[topic]; !exist { |
| 414 | kp.topicToRequestHandlerChannelMap[topic] = arg |
| 415 | } |
| 416 | } |
| 417 | |
| 418 | func (kp *InterContainerProxy) deleteFromTopicRequestHandlerChannelMap(topic string) error { |
| 419 | kp.lockTopicRequestHandlerChannelMap.Lock() |
| 420 | defer kp.lockTopicRequestHandlerChannelMap.Unlock() |
| 421 | if _, exist := kp.topicToRequestHandlerChannelMap[topic]; exist { |
| 422 | // Close the kafka client client first by unsubscribing to this topic |
| 423 | kp.kafkaClient.UnSubscribe(&Topic{Name: topic}, kp.topicToRequestHandlerChannelMap[topic].ch) |
| 424 | delete(kp.topicToRequestHandlerChannelMap, topic) |
| 425 | return nil |
| 426 | } else { |
| 427 | return errors.New(fmt.Sprintf("%s-Topic-not-found", topic)) |
| 428 | } |
| 429 | } |
| 430 | |
| 431 | func (kp *InterContainerProxy) deleteAllTopicRequestHandlerChannelMap() error { |
| 432 | kp.lockTopicRequestHandlerChannelMap.Lock() |
| 433 | defer kp.lockTopicRequestHandlerChannelMap.Unlock() |
| 434 | var err error |
| 435 | for topic, _ := range kp.topicToRequestHandlerChannelMap { |
| 436 | // Close the kafka client client first by unsubscribing to this topic |
| 437 | if err = kp.kafkaClient.UnSubscribe(&Topic{Name: topic}, kp.topicToRequestHandlerChannelMap[topic].ch); err != nil { |
| 438 | log.Errorw("unsubscribing-error", log.Fields{"topic": topic, "error": err}) |
| 439 | } |
| 440 | delete(kp.topicToRequestHandlerChannelMap, topic) |
| 441 | } |
| 442 | return err |
| 443 | } |
| 444 | |
| 445 | func (kp *InterContainerProxy) addToTransactionIdToChannelMap(id string, topic *Topic, arg chan *ic.InterContainerMessage) { |
| 446 | kp.lockTransactionIdToChannelMap.Lock() |
| 447 | defer kp.lockTransactionIdToChannelMap.Unlock() |
| 448 | if _, exist := kp.transactionIdToChannelMap[id]; !exist { |
| 449 | kp.transactionIdToChannelMap[id] = &transactionChannel{topic: topic, ch: arg} |
| 450 | } |
| 451 | } |
| 452 | |
| 453 | func (kp *InterContainerProxy) deleteFromTransactionIdToChannelMap(id string) { |
| 454 | kp.lockTransactionIdToChannelMap.Lock() |
| 455 | defer kp.lockTransactionIdToChannelMap.Unlock() |
| 456 | if transChannel, exist := kp.transactionIdToChannelMap[id]; exist { |
| 457 | // Close the channel first |
| 458 | close(transChannel.ch) |
| 459 | delete(kp.transactionIdToChannelMap, id) |
| 460 | } |
| 461 | } |
| 462 | |
| 463 | func (kp *InterContainerProxy) deleteTopicTransactionIdToChannelMap(id string) { |
| 464 | kp.lockTransactionIdToChannelMap.Lock() |
| 465 | defer kp.lockTransactionIdToChannelMap.Unlock() |
| 466 | for key, value := range kp.transactionIdToChannelMap { |
| 467 | if value.topic.Name == id { |
| 468 | close(value.ch) |
| 469 | delete(kp.transactionIdToChannelMap, key) |
| 470 | } |
| 471 | } |
| 472 | } |
| 473 | |
| 474 | func (kp *InterContainerProxy) deleteAllTransactionIdToChannelMap() { |
| 475 | kp.lockTransactionIdToChannelMap.Lock() |
| 476 | defer kp.lockTransactionIdToChannelMap.Unlock() |
| 477 | for key, value := range kp.transactionIdToChannelMap { |
| 478 | close(value.ch) |
| 479 | delete(kp.transactionIdToChannelMap, key) |
| 480 | } |
| 481 | } |
| 482 | |
| 483 | func (kp *InterContainerProxy) DeleteTopic(topic Topic) error { |
| 484 | // If we have any consumers on that topic we need to close them |
| 485 | if err := kp.deleteFromTopicResponseChannelMap(topic.Name); err != nil { |
| 486 | log.Errorw("delete-from-topic-responsechannelmap-failed", log.Fields{"error": err}) |
| 487 | } |
| 488 | if err := kp.deleteFromTopicRequestHandlerChannelMap(topic.Name); err != nil { |
| 489 | log.Errorw("delete-from-topic-requesthandlerchannelmap-failed", log.Fields{"error": err}) |
| 490 | } |
| 491 | kp.deleteTopicTransactionIdToChannelMap(topic.Name) |
| 492 | |
| 493 | return kp.kafkaClient.DeleteTopic(&topic) |
| 494 | } |
| 495 | |
| 496 | func encodeReturnedValue(returnedVal interface{}) (*any.Any, error) { |
| 497 | // Encode the response argument - needs to be a proto message |
| 498 | if returnedVal == nil { |
| 499 | return nil, nil |
| 500 | } |
| 501 | protoValue, ok := returnedVal.(proto.Message) |
| 502 | if !ok { |
| 503 | log.Warnw("response-value-not-proto-message", log.Fields{"error": ok, "returnVal": returnedVal}) |
| 504 | err := errors.New("response-value-not-proto-message") |
| 505 | return nil, err |
| 506 | } |
| 507 | |
| 508 | // Marshal the returned value, if any |
| 509 | var marshalledReturnedVal *any.Any |
| 510 | var err error |
| 511 | if marshalledReturnedVal, err = ptypes.MarshalAny(protoValue); err != nil { |
| 512 | log.Warnw("cannot-marshal-returned-val", log.Fields{"error": err}) |
| 513 | return nil, err |
| 514 | } |
| 515 | return marshalledReturnedVal, nil |
| 516 | } |
| 517 | |
| 518 | func encodeDefaultFailedResponse(request *ic.InterContainerMessage) *ic.InterContainerMessage { |
| 519 | responseHeader := &ic.Header{ |
| 520 | Id: request.Header.Id, |
| 521 | Type: ic.MessageType_RESPONSE, |
| 522 | FromTopic: request.Header.ToTopic, |
| 523 | ToTopic: request.Header.FromTopic, |
| 524 | Timestamp: time.Now().Unix(), |
| 525 | } |
| 526 | responseBody := &ic.InterContainerResponseBody{ |
| 527 | Success: false, |
| 528 | Result: nil, |
| 529 | } |
| 530 | var marshalledResponseBody *any.Any |
| 531 | var err error |
| 532 | // Error should never happen here |
| 533 | if marshalledResponseBody, err = ptypes.MarshalAny(responseBody); err != nil { |
| 534 | log.Warnw("cannot-marshal-failed-response-body", log.Fields{"error": err}) |
| 535 | } |
| 536 | |
| 537 | return &ic.InterContainerMessage{ |
| 538 | Header: responseHeader, |
| 539 | Body: marshalledResponseBody, |
| 540 | } |
| 541 | |
| 542 | } |
| 543 | |
| 544 | //formatRequest formats a request to send over kafka and returns an InterContainerMessage message on success |
| 545 | //or an error on failure |
| 546 | func encodeResponse(request *ic.InterContainerMessage, success bool, returnedValues ...interface{}) (*ic.InterContainerMessage, error) { |
| 547 | //log.Debugw("encodeResponse", log.Fields{"success": success, "returnedValues": returnedValues}) |
| 548 | responseHeader := &ic.Header{ |
| 549 | Id: request.Header.Id, |
| 550 | Type: ic.MessageType_RESPONSE, |
| 551 | FromTopic: request.Header.ToTopic, |
| 552 | ToTopic: request.Header.FromTopic, |
| 553 | KeyTopic: request.Header.KeyTopic, |
| 554 | Timestamp: time.Now().UnixNano(), |
| 555 | } |
| 556 | |
| 557 | // Go over all returned values |
| 558 | var marshalledReturnedVal *any.Any |
| 559 | var err error |
| 560 | for _, returnVal := range returnedValues { |
| 561 | if marshalledReturnedVal, err = encodeReturnedValue(returnVal); err != nil { |
| 562 | log.Warnw("cannot-marshal-response-body", log.Fields{"error": err}) |
| 563 | } |
| 564 | break // for now we support only 1 returned value - (excluding the error) |
| 565 | } |
| 566 | |
| 567 | responseBody := &ic.InterContainerResponseBody{ |
| 568 | Success: success, |
| 569 | Result: marshalledReturnedVal, |
| 570 | } |
| 571 | |
| 572 | // Marshal the response body |
| 573 | var marshalledResponseBody *any.Any |
| 574 | if marshalledResponseBody, err = ptypes.MarshalAny(responseBody); err != nil { |
| 575 | log.Warnw("cannot-marshal-response-body", log.Fields{"error": err}) |
| 576 | return nil, err |
| 577 | } |
| 578 | |
| 579 | return &ic.InterContainerMessage{ |
| 580 | Header: responseHeader, |
| 581 | Body: marshalledResponseBody, |
| 582 | }, nil |
| 583 | } |
| 584 | |
| 585 | func CallFuncByName(myClass interface{}, funcName string, params ...interface{}) (out []reflect.Value, err error) { |
| 586 | myClassValue := reflect.ValueOf(myClass) |
| 587 | // Capitalize the first letter in the funcName to workaround the first capital letters required to |
| 588 | // invoke a function from a different package |
| 589 | funcName = strings.Title(funcName) |
| 590 | m := myClassValue.MethodByName(funcName) |
| 591 | if !m.IsValid() { |
| 592 | return make([]reflect.Value, 0), fmt.Errorf("method-not-found \"%s\"", funcName) |
| 593 | } |
| 594 | in := make([]reflect.Value, len(params)) |
| 595 | for i, param := range params { |
| 596 | in[i] = reflect.ValueOf(param) |
| 597 | } |
| 598 | out = m.Call(in) |
| 599 | return |
| 600 | } |
| 601 | |
| 602 | func (kp *InterContainerProxy) addTransactionId(transactionId string, currentArgs []*ic.Argument) []*ic.Argument { |
| 603 | arg := &KVArg{ |
| 604 | Key: TransactionKey, |
| 605 | Value: &ic.StrType{Val: transactionId}, |
| 606 | } |
| 607 | |
| 608 | var marshalledArg *any.Any |
| 609 | var err error |
| 610 | if marshalledArg, err = ptypes.MarshalAny(&ic.StrType{Val: transactionId}); err != nil { |
| 611 | log.Warnw("cannot-add-transactionId", log.Fields{"error": err}) |
| 612 | return currentArgs |
| 613 | } |
| 614 | protoArg := &ic.Argument{ |
| 615 | Key: arg.Key, |
| 616 | Value: marshalledArg, |
| 617 | } |
| 618 | return append(currentArgs, protoArg) |
| 619 | } |
| 620 | |
| 621 | func (kp *InterContainerProxy) addFromTopic(fromTopic string, currentArgs []*ic.Argument) []*ic.Argument { |
| 622 | var marshalledArg *any.Any |
| 623 | var err error |
| 624 | if marshalledArg, err = ptypes.MarshalAny(&ic.StrType{Val: fromTopic}); err != nil { |
| 625 | log.Warnw("cannot-add-transactionId", log.Fields{"error": err}) |
| 626 | return currentArgs |
| 627 | } |
| 628 | protoArg := &ic.Argument{ |
| 629 | Key: FromTopic, |
| 630 | Value: marshalledArg, |
| 631 | } |
| 632 | return append(currentArgs, protoArg) |
| 633 | } |
| 634 | |
| 635 | func (kp *InterContainerProxy) handleMessage(msg *ic.InterContainerMessage, targetInterface interface{}) { |
| 636 | |
| 637 | // First extract the header to know whether this is a request - responses are handled by a different handler |
| 638 | if msg.Header.Type == ic.MessageType_REQUEST { |
| 639 | var out []reflect.Value |
| 640 | var err error |
| 641 | |
| 642 | // Get the request body |
| 643 | requestBody := &ic.InterContainerRequestBody{} |
| 644 | if err = ptypes.UnmarshalAny(msg.Body, requestBody); err != nil { |
| 645 | log.Warnw("cannot-unmarshal-request", log.Fields{"error": err}) |
| 646 | } else { |
| 647 | log.Debugw("received-request", log.Fields{"rpc": requestBody.Rpc, "header": msg.Header}) |
| 648 | // let the callee unpack the arguments as its the only one that knows the real proto type |
| 649 | // Augment the requestBody with the message Id as it will be used in scenarios where cores |
| 650 | // are set in pairs and competing |
| 651 | requestBody.Args = kp.addTransactionId(msg.Header.Id, requestBody.Args) |
| 652 | |
| 653 | // Augment the requestBody with the From topic name as it will be used in scenarios where a container |
| 654 | // needs to send an unsollicited message to the currently requested container |
| 655 | requestBody.Args = kp.addFromTopic(msg.Header.FromTopic, requestBody.Args) |
| 656 | |
| 657 | out, err = CallFuncByName(targetInterface, requestBody.Rpc, requestBody.Args) |
| 658 | if err != nil { |
| 659 | log.Warn(err) |
| 660 | } |
| 661 | } |
| 662 | // Response required? |
| 663 | if requestBody.ResponseRequired { |
| 664 | // If we already have an error before then just return that |
| 665 | var returnError *ic.Error |
| 666 | var returnedValues []interface{} |
| 667 | var success bool |
| 668 | if err != nil { |
| 669 | returnError = &ic.Error{Reason: err.Error()} |
| 670 | returnedValues = make([]interface{}, 1) |
| 671 | returnedValues[0] = returnError |
| 672 | } else { |
| 673 | returnedValues = make([]interface{}, 0) |
| 674 | // Check for errors first |
| 675 | lastIndex := len(out) - 1 |
| 676 | if out[lastIndex].Interface() != nil { // Error |
| 677 | if goError, ok := out[lastIndex].Interface().(error); ok { |
| 678 | returnError = &ic.Error{Reason: goError.Error()} |
| 679 | returnedValues = append(returnedValues, returnError) |
| 680 | } else { // Should never happen |
| 681 | returnError = &ic.Error{Reason: "incorrect-error-returns"} |
| 682 | returnedValues = append(returnedValues, returnError) |
| 683 | } |
| 684 | } else if len(out) == 2 && reflect.ValueOf(out[0].Interface()).IsValid() && reflect.ValueOf(out[0].Interface()).IsNil() { |
| 685 | return // Ignore case - when core is in competing mode |
| 686 | } else { // Non-error case |
| 687 | success = true |
| 688 | for idx, val := range out { |
| 689 | //log.Debugw("returned-api-response-loop", log.Fields{"idx": idx, "val": val.Interface()}) |
| 690 | if idx != lastIndex { |
| 691 | returnedValues = append(returnedValues, val.Interface()) |
| 692 | } |
| 693 | } |
| 694 | } |
| 695 | } |
| 696 | |
| 697 | var icm *ic.InterContainerMessage |
| 698 | if icm, err = encodeResponse(msg, success, returnedValues...); err != nil { |
| 699 | log.Warnw("error-encoding-response-returning-failure-result", log.Fields{"error": err}) |
| 700 | icm = encodeDefaultFailedResponse(msg) |
| 701 | } |
| 702 | // To preserve ordering of messages, all messages to a given topic are sent to the same partition |
| 703 | // by providing a message key. The key is encoded in the topic name. If the deviceId is not |
| 704 | // present then the key will be empty, hence all messages for a given topic will be sent to all |
| 705 | // partitions. |
| 706 | replyTopic := &Topic{Name: msg.Header.FromTopic} |
| 707 | key := msg.Header.KeyTopic |
| 708 | log.Debugw("sending-response-to-kafka", log.Fields{"rpc": requestBody.Rpc, "header": icm.Header, "key": key}) |
| 709 | // TODO: handle error response. |
| 710 | go kp.kafkaClient.Send(icm, replyTopic, key) |
| 711 | } |
| 712 | } else if msg.Header.Type == ic.MessageType_RESPONSE { |
| 713 | log.Debugw("response-received", log.Fields{"msg-header": msg.Header}) |
| 714 | go kp.dispatchResponse(msg) |
| 715 | } else { |
| 716 | log.Warnw("unsupported-message-received", log.Fields{"msg-header": msg.Header}) |
| 717 | } |
| 718 | } |
| 719 | |
| 720 | func (kp *InterContainerProxy) waitForMessages(ch <-chan *ic.InterContainerMessage, topic Topic, targetInterface interface{}) { |
| 721 | // Wait for messages |
| 722 | for msg := range ch { |
| 723 | //log.Debugw("request-received", log.Fields{"msg": msg, "topic": topic.Name, "target": targetInterface}) |
| 724 | go kp.handleMessage(msg, targetInterface) |
| 725 | } |
| 726 | } |
| 727 | |
| 728 | func (kp *InterContainerProxy) dispatchResponse(msg *ic.InterContainerMessage) { |
| 729 | kp.lockTransactionIdToChannelMap.RLock() |
| 730 | defer kp.lockTransactionIdToChannelMap.RUnlock() |
| 731 | if _, exist := kp.transactionIdToChannelMap[msg.Header.Id]; !exist { |
| 732 | log.Debugw("no-waiting-channel", log.Fields{"transaction": msg.Header.Id}) |
| 733 | return |
| 734 | } |
| 735 | kp.transactionIdToChannelMap[msg.Header.Id].ch <- msg |
| 736 | } |
| 737 | |
| 738 | // subscribeForResponse allows a caller to subscribe to a given topic when waiting for a response. |
| 739 | // This method is built to prevent all subscribers to receive all messages as is the case of the Subscribe |
| 740 | // API. There is one response channel waiting for kafka messages before dispatching the message to the |
| 741 | // corresponding waiting channel |
| 742 | func (kp *InterContainerProxy) subscribeForResponse(topic Topic, trnsId string) (chan *ic.InterContainerMessage, error) { |
| 743 | log.Debugw("subscribeForResponse", log.Fields{"topic": topic.Name, "trnsid": trnsId}) |
| 744 | |
| 745 | // Create a specific channel for this consumers. We cannot use the channel from the kafkaclient as it will |
| 746 | // broadcast any message for this topic to all channels waiting on it. |
| 747 | ch := make(chan *ic.InterContainerMessage) |
| 748 | kp.addToTransactionIdToChannelMap(trnsId, &topic, ch) |
| 749 | |
| 750 | return ch, nil |
| 751 | } |
| 752 | |
| 753 | func (kp *InterContainerProxy) unSubscribeForResponse(trnsId string) error { |
| 754 | log.Debugw("unsubscribe-for-response", log.Fields{"trnsId": trnsId}) |
| 755 | kp.deleteFromTransactionIdToChannelMap(trnsId) |
| 756 | return nil |
| 757 | } |
| 758 | |
| 759 | //formatRequest formats a request to send over kafka and returns an InterContainerMessage message on success |
| 760 | //or an error on failure |
| 761 | func encodeRequest(rpc string, toTopic *Topic, replyTopic *Topic, key string, kvArgs ...*KVArg) (*ic.InterContainerMessage, error) { |
| 762 | requestHeader := &ic.Header{ |
| 763 | Id: uuid.New().String(), |
| 764 | Type: ic.MessageType_REQUEST, |
| 765 | FromTopic: replyTopic.Name, |
| 766 | ToTopic: toTopic.Name, |
| 767 | KeyTopic: key, |
| 768 | Timestamp: time.Now().UnixNano(), |
| 769 | } |
| 770 | requestBody := &ic.InterContainerRequestBody{ |
| 771 | Rpc: rpc, |
| 772 | ResponseRequired: true, |
| 773 | ReplyToTopic: replyTopic.Name, |
| 774 | } |
| 775 | |
| 776 | for _, arg := range kvArgs { |
| 777 | if arg == nil { |
| 778 | // In case the caller sends an array with empty args |
| 779 | continue |
| 780 | } |
| 781 | var marshalledArg *any.Any |
| 782 | var err error |
| 783 | // ascertain the value interface type is a proto.Message |
| 784 | protoValue, ok := arg.Value.(proto.Message) |
| 785 | if !ok { |
| 786 | log.Warnw("argument-value-not-proto-message", log.Fields{"error": ok, "Value": arg.Value}) |
| 787 | err := errors.New("argument-value-not-proto-message") |
| 788 | return nil, err |
| 789 | } |
| 790 | if marshalledArg, err = ptypes.MarshalAny(protoValue); err != nil { |
| 791 | log.Warnw("cannot-marshal-request", log.Fields{"error": err}) |
| 792 | return nil, err |
| 793 | } |
| 794 | protoArg := &ic.Argument{ |
| 795 | Key: arg.Key, |
| 796 | Value: marshalledArg, |
| 797 | } |
| 798 | requestBody.Args = append(requestBody.Args, protoArg) |
| 799 | } |
| 800 | |
| 801 | var marshalledData *any.Any |
| 802 | var err error |
| 803 | if marshalledData, err = ptypes.MarshalAny(requestBody); err != nil { |
| 804 | log.Warnw("cannot-marshal-request", log.Fields{"error": err}) |
| 805 | return nil, err |
| 806 | } |
| 807 | request := &ic.InterContainerMessage{ |
| 808 | Header: requestHeader, |
| 809 | Body: marshalledData, |
| 810 | } |
| 811 | return request, nil |
| 812 | } |
| 813 | |
| 814 | func decodeResponse(response *ic.InterContainerMessage) (*ic.InterContainerResponseBody, error) { |
| 815 | // Extract the message body |
| 816 | responseBody := ic.InterContainerResponseBody{} |
| 817 | if err := ptypes.UnmarshalAny(response.Body, &responseBody); err != nil { |
| 818 | log.Warnw("cannot-unmarshal-response", log.Fields{"error": err}) |
| 819 | return nil, err |
| 820 | } |
| 821 | //log.Debugw("response-decoded-successfully", log.Fields{"response-status": &responseBody.Success}) |
| 822 | |
| 823 | return &responseBody, nil |
| 824 | |
| 825 | } |