mirror of
https://github.com/status-im/consul.git
synced 2025-02-02 00:46:43 +00:00
b1b05f0bac
Prevent partial application of Envoy extensions Ensure that non-required extensions do not change xDS resources before exiting on failure by cloning proto messages prior to applying each extension. To support this change, also move `CanApply` checks up a layer and make them prior to attempting extension application, s.t. we avoid unnecessary copies where extensions can't be applied. Last, ensure that we do not allow panics from `CanApply` or `Extend` checks to escape the attempted extension application.
29 lines
1.1 KiB
Go
29 lines
1.1 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
package extensioncommon
|
|
|
|
import (
|
|
"github.com/hashicorp/consul/envoyextensions/xdscommon"
|
|
)
|
|
|
|
// EnvoyExtender is the interface that all Envoy extensions must implement in order
|
|
// to be dynamically executed during runtime.
|
|
type EnvoyExtender interface {
|
|
|
|
// CanApply checks whether the extension configured for this extender is eligible
|
|
// for application based on the specified RuntimeConfig.
|
|
CanApply(*RuntimeConfig) bool
|
|
|
|
// Validate ensures the data in config can successfuly be used
|
|
// to apply the specified Envoy extension.
|
|
Validate(*RuntimeConfig) error
|
|
|
|
// Extend updates indexed xDS structures to include patches for
|
|
// built-in extensions. It is responsible for applying extensions to
|
|
// the appropriate xDS resources. If any portion of this function fails,
|
|
// it will attempt continue and return an error. The caller can then determine
|
|
// if it is better to use a partially applied extension or error out.
|
|
Extend(*xdscommon.IndexedResources, *RuntimeConfig) (*xdscommon.IndexedResources, error)
|
|
}
|