sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [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 | */ |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 16 | |
| 17 | package afrouter |
| 18 | |
| 19 | import ( |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 20 | "errors" |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 21 | "fmt" |
| 22 | "github.com/opencord/voltha-go/common/log" |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 23 | "google.golang.org/grpc" |
| 24 | "google.golang.org/grpc/metadata" |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 25 | ) |
| 26 | |
| 27 | const NoMeta = "nometa" |
| 28 | |
| 29 | type MethodRouter struct { |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 30 | name string |
| 31 | service string |
| 32 | methodRouter map[string]map[string]Router // map of [metadata][method] |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 33 | } |
| 34 | |
| 35 | func newMethodRouter(config *RouterConfig) (Router, error) { |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 36 | mr := MethodRouter{name: config.Name, service: config.ProtoService, methodRouter: make(map[string]map[string]Router)} |
| 37 | mr.methodRouter[NoMeta] = make(map[string]Router) // For routes not needing metadata (all expcept binding at this time) |
sslobodr | 1d1e50b | 2019-03-14 09:17:40 -0400 | [diff] [blame] | 38 | log.Debugf("Processing MethodRouter config %v", *config) |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 39 | if len(config.Routes) == 0 { |
| 40 | return nil, errors.New(fmt.Sprintf("Router %s must have at least one route", config.Name)) |
| 41 | } |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 42 | for _, rtv := range config.Routes { |
sslobodr | 1d1e50b | 2019-03-14 09:17:40 -0400 | [diff] [blame] | 43 | //log.Debugf("Processing route: %v",rtv) |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 44 | var idx1 string |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 45 | r, err := newSubRouter(config, &rtv) |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 46 | if err != nil { |
| 47 | return nil, err |
| 48 | } |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 49 | if rtv.Type == RouteTypeBinding { |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 50 | idx1 = rtv.Binding.Field |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 51 | if _, ok := mr.methodRouter[idx1]; !ok { // /First attempt on this key |
| 52 | mr.methodRouter[idx1] = make(map[string]Router) |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 53 | } |
| 54 | } else { |
| 55 | idx1 = NoMeta |
| 56 | } |
| 57 | switch len(rtv.Methods) { |
| 58 | case 0: |
| 59 | return nil, errors.New(fmt.Sprintf("Route for router %s must have at least one method", config.Name)) |
| 60 | case 1: |
| 61 | if rtv.Methods[0] == "*" { |
| 62 | return r, nil |
| 63 | } else { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 64 | log.Debugf("Setting router '%s' for single method '%s'", r.Name(), rtv.Methods[0]) |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 65 | if _, ok := mr.methodRouter[idx1][rtv.Methods[0]]; !ok { |
| 66 | mr.methodRouter[idx1][rtv.Methods[0]] = r |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 67 | } else { |
| 68 | err := errors.New(fmt.Sprintf("Attempt to define method %s for 2 routes: %s & %s", rtv.Methods[0], |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 69 | r.Name(), mr.methodRouter[idx1][rtv.Methods[0]].Name())) |
sslobodr | 1d1e50b | 2019-03-14 09:17:40 -0400 | [diff] [blame] | 70 | log.Error(err) |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 71 | return mr, err |
| 72 | } |
| 73 | } |
| 74 | default: |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 75 | for _, m := range rtv.Methods { |
sslobodr | 1d1e50b | 2019-03-14 09:17:40 -0400 | [diff] [blame] | 76 | log.Debugf("Processing Method %s", m) |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 77 | if _, ok := mr.methodRouter[idx1][m]; !ok { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 78 | log.Debugf("Setting router '%s' for method '%s'", r.Name(), m) |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 79 | mr.methodRouter[idx1][m] = r |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 80 | } else { |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 81 | err := errors.New(fmt.Sprintf("Attempt to define method %s for 2 routes: %s & %s", m, r.Name(), mr.methodRouter[idx1][m].Name())) |
sslobodr | 1d1e50b | 2019-03-14 09:17:40 -0400 | [diff] [blame] | 82 | log.Error(err) |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 83 | return mr, err |
| 84 | } |
| 85 | } |
| 86 | } |
| 87 | } |
| 88 | |
| 89 | return mr, nil |
| 90 | } |
| 91 | |
| 92 | func (mr MethodRouter) Name() string { |
| 93 | return mr.name |
| 94 | } |
| 95 | |
| 96 | func (mr MethodRouter) Service() string { |
| 97 | return mr.service |
| 98 | } |
| 99 | |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 100 | func (mr MethodRouter) GetMetaKeyVal(serverStream grpc.ServerStream) (string, string, error) { |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 101 | var rtrnK = NoMeta |
| 102 | var rtrnV = "" |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 103 | |
| 104 | // Get the metadata from the server stream |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 105 | md, ok := metadata.FromIncomingContext(serverStream.Context()) |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 106 | if !ok { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 107 | return rtrnK, rtrnV, errors.New("Could not get a server stream metadata") |
| 108 | } |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 109 | |
| 110 | // Determine if one of the method routing keys exists in the metadata |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 111 | for k := range mr.methodRouter { |
| 112 | if _, ok := md[k]; ok { |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 113 | rtrnV = md[k][0] |
| 114 | rtrnK = k |
| 115 | break |
| 116 | } |
| 117 | } |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 118 | return rtrnK, rtrnV, nil |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 119 | |
| 120 | } |
| 121 | |
| 122 | func (mr MethodRouter) ReplyHandler(sel interface{}) error { |
| 123 | switch sl := sel.(type) { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 124 | case *sbFrame: |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 125 | if r, ok := mr.methodRouter[NoMeta][sl.method]; ok { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 126 | return r.ReplyHandler(sel) |
| 127 | } |
| 128 | // TODO: this case should also be an error |
| 129 | default: //TODO: This should really be a big error |
| 130 | // A reply handler should only be called on the sbFrame |
| 131 | return nil |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 132 | } |
| 133 | return nil |
| 134 | } |
| 135 | |
| 136 | func (mr MethodRouter) Route(sel interface{}) *backend { |
| 137 | switch sl := sel.(type) { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 138 | case *nbFrame: |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 139 | if r, ok := mr.methodRouter[sl.metaKey][sl.methodInfo.method]; ok { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 140 | return r.Route(sel) |
| 141 | } |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 142 | log.Errorf("Attept to route on non-existent method '%s'", sl.methodInfo.method) |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 143 | return nil |
| 144 | default: |
| 145 | return nil |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 146 | } |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 147 | } |
| 148 | |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 149 | func (mr MethodRouter) BackendCluster(mthd string, metaKey string) (*cluster, error) { |
| 150 | if r, ok := mr.methodRouter[metaKey][mthd]; ok { |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 151 | return r.BackendCluster(mthd, metaKey) |
| 152 | } |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 153 | err := errors.New(fmt.Sprintf("No backend cluster exists for method '%s' using meta key '%s'", mthd, metaKey)) |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 154 | log.Error(err) |
| 155 | return nil, err |
| 156 | } |
| 157 | |
Kent Hagerman | 1e9061e | 2019-05-21 16:01:21 -0400 | [diff] [blame] | 158 | func (mr MethodRouter) FindBackendCluster(beName string) *cluster { |
| 159 | for _, meta := range mr.methodRouter { |
Kent Hagerman | 0ab4cb2 | 2019-04-24 13:13:35 -0400 | [diff] [blame] | 160 | for _, r := range meta { |
| 161 | if rtrn := r.FindBackendCluster(beName); rtrn != nil { |
sslobodr | 392ebd5 | 2019-01-18 12:41:49 -0500 | [diff] [blame] | 162 | return rtrn |
| 163 | } |
| 164 | } |
| 165 | } |
| 166 | return nil |
| 167 | } |