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