refact(controller): Validate listener configuration in New
With this change, the Controller is now aware of its own listeners in a more codified and structured way. The reasoning behind these changes are as follows: 1. Currently, we're iterating over these listeners in multiple spots along this initialization flow to check each listeners' purpose. By doing this once when we create a Controller and essentially storing the result, we can clean up the downstream code to use those results. 2. Initial effort to centralize Controller validation. At the moment, we are doing a lot of validation all over the `cmd` and `config` packages. From a conceptual perspective, Controller-related validation should be performed in the function that is responsible for constructing the Controller object itself. This enables any developer to look in a single place for all the constraints that we place on creating a Controller.
This commit is contained in:
1 parent
b6ee5dc9cc
commit
8d48a8515c
3 files changed
+211
-26
No files matched your search
@@ -52,6 +52,9 @@ type Controller struct {
|
||||
|
||||
workerAuthCache *sync.Map
|
||||
|
||||
apiListeners []*base.ServerListener
|
||||
clusterListener *base.ServerListener
|
||||
|
||||
// Used for testing and tracking worker health
|
||||
workerStatusUpdateTimes *sync.Map
|
||||
|
||||
@@ -125,6 +128,32 @@ func New(ctx context.Context, conf *Config) (*Controller, error) {
|
||||
}
|
||||
}
|
||||
|
||||
clusterListeners := make([]*base.ServerListener, 0)
|
||||
for i := range conf.Listeners {
|
||||
l := conf.Listeners[i]
|
||||
if l == nil || l.Config == nil || l.Config.Purpose == nil {
|
||||
continue
|
||||
}
|
||||
if len(l.Config.Purpose) != 1 {
|
||||
return nil, fmt.Errorf("found listener with multiple purposes %q", strings.Join(l.Config.Purpose, ","))
|
||||
}
|
||||
switch l.Config.Purpose[0] {
|
||||
case "api":
|
||||
c.apiListeners = append(c.apiListeners, l)
|
||||
case "cluster":
|
||||
clusterListeners = append(clusterListeners, l)
|
||||
}
|
||||
}
|
||||
if len(c.apiListeners) == 0 {
|
||||
return nil, fmt.Errorf("no api listeners found")
|
||||
}
|
||||
if len(clusterListeners) != 1 {
|
||||
// in the future, we might pick the cluster that is exposed to the outside
|
||||
// instead of limiting it to one.
|
||||
return nil, fmt.Errorf("exactly one cluster listener is required")
|
||||
}
|
||||
c.clusterListener = clusterListeners[0]
|
||||
|
||||
var pluginLogger hclog.Logger
|
||||
for _, enabledPlugin := range c.enabledPlugins {
|
||||
if pluginLogger == nil {
|
||||
|
||||
Reference in new issue
Block a user