http filter: Add overrideable function to http filter factory interface for specifying FilterDependencies #15157

auni53 · 2021-02-23T19:34:09Z

Commit message:

Add dependencies() function to NamedHttpFilterFactory
Add unit testing

Additional description: I thought it would be useful to add the interface itself with documentation and get that out of the way, and I noted in the release notes that validation of the dependencies is WIP.
Risk Level: Low.
See design doc attached to #14470 for more details.

Signed-off-by: Auni Ahsan <[email protected]>

auni53 · 2021-02-23T19:45:09Z

@htuch would it make sense to land chunk by itself? If so, could you help me find a reviewer to tag?

@AndresGuedez

Signed-off-by: Auni Ahsan <[email protected]>

htuch

@snowp since this filter chain validation work overlaps the filter match work you are involved with, would you be willing to be a non-Googler senior maintainer to shepherd these PRs?

htuch · 2021-02-24T02:12:23Z

docs/root/version_history/current.rst

@@ -93,6 +93,7 @@ New Features
 * http: added support for `Envoy::ScopeTrackedObject` for HTTP/1 and HTTP/2 dispatching. Crashes while inside the dispatching loop should dump debug information.
 * http: added support for :ref:`preconnecting <envoy_v3_api_msg_config.cluster.v3.Cluster.PreconnectPolicy>`. Preconnecting is off by default, but recommended for clusters serving latency-sensitive traffic, especially if using HTTP/1.1.
 * http: change frame flood and abuse checks to the upstream HTTP/2 codec to ON by default. It can be disabled by setting the `envoy.reloadable_features.upstream_http2_flood_checks` runtime key to false.
+* http filter: add function to `NamedHttpFilterConfigFactory` which can be overridden to return a :ref`FilterDependencies <envoy_api_file_envoy/extensions/filters/common/dependency/v3/dependency.proto>` specification. Config-plane validation of dependencies is currently WIP.


I think you can skip this for now, since its very internally focused. I'd add a single release note when we have the filter chain deps validation working.

Sounds good.

htuch · 2021-02-24T02:13:46Z

include/envoy/server/filter_config.h

+   * @return FilterDependencies specification of dependencies required or
+   * provided on the decode and encode paths.
+   */
+  virtual envoy::extensions::filters::common::dependency::v3::FilterDependencies dependencies() {


Nit: probably const&

filter_config.h:212:12: error: reference to stack memory associated with local variable 'dependency' returned [-Werror,-Wreturn-stack-address] return dependency;

I could try declaring a static helper function to return it? But I imagine this will cause problems for overriders of this function anyway, who will have to construct the proto somehow.

Oh, I see what's going on. This is more similar I think to createEmptyRouteConfigProto() above. I think you should return a unique_ptr with the allocated dependencies in this case.

I don't understand what the value of that would be; the dependency specification protos won't typically be very large, so passing it by copy seems ok to me. What do you think?

@snowp in case you have any thoughts

With the protos being small I don't think it matters a whole lot, but a unique_ptr might better future proof this in case this changes? I can imagine some filter potentially providing a lot of different dependencies even if none do so today

Right, the protos contain multiple strings and we try not copy them around in general.

This reverts commit ec1d1e4. Signed-off-by: Auni Ahsan <[email protected]>

Signed-off-by: Auni Ahsan <[email protected]>

KBaichoo · 2021-02-24T23:16:38Z

/retest

repokitteh-read-only · 2021-02-24T23:16:41Z

Retrying Azure Pipelines:
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #15157 (comment) was created by @KBaichoo.

see: more, trace.

docs/root/version_history/current.rst

snowp · 2021-02-25T18:15:15Z

include/envoy/server/filter_config.h

+   * @return FilterDependencies specification of dependencies required or
+   * provided on the decode and encode paths.
+   */
+  virtual envoy::extensions::filters::common::dependency::v3::FilterDependencies dependencies() {


With the protos being small I don't think it matters a whole lot, but a unique_ptr might better future proof this in case this changes? I can imagine some filter potentially providing a lot of different dependencies even if none do so today

Signed-off-by: Auni Ahsan <[email protected]>

auni53 · 2021-03-03T15:59:26Z

/retest

repokitteh-read-only · 2021-03-03T15:59:30Z

Retrying Azure Pipelines:
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #15157 (comment) was created by @auni53.

see: more, trace.

snowp

This looks good to me, just one nit

include/envoy/server/filter_config.h

htuch

LGTM modulo @snowp comments, will hand it over to @snowp for merge. Thanks.

Signed-off-by: Auni Ahsan <[email protected]>

auni53 · 2021-03-05T16:28:30Z

Flakes related to #12209

/retest

repokitteh-read-only · 2021-03-05T16:28:34Z

Retrying Azure Pipelines:
Check envoy-presubmit isn't fully completed, but will still attempt retrying.
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #15157 (comment) was created by @auni53.

see: more, trace.

auni53 · 2021-03-05T17:24:56Z

/retest

repokitteh-read-only · 2021-03-05T17:24:59Z

Retrying Azure Pipelines:
Check envoy-presubmit isn't fully completed, but will still attempt retrying.
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #15157 (comment) was created by @auni53.

see: more, trace.

auni53 · 2021-03-05T17:25:53Z

@snowp /retest seems to be stuck since some of the running tests are still queued, and the failure appears to be a flake.

snowp

LGTM! I restarted CI, let's see how it goes

auni53 added 2 commits February 23, 2021 19:18

Add FilterDependencies to base http filter factory interface

51513a7

Signed-off-by: Auni Ahsan <[email protected]>

Add docs

ec1d1e4

Signed-off-by: Auni Ahsan <[email protected]>

fix format

80f3d20

Signed-off-by: Auni Ahsan <[email protected]>

auni53 marked this pull request as ready for review February 23, 2021 20:32

htuch reviewed Feb 24, 2021

View reviewed changes

zuercher assigned htuch and snowp Feb 24, 2021

auni53 added 2 commits February 24, 2021 19:06

Revert "Add docs"

91364e7

This reverts commit ec1d1e4. Signed-off-by: Auni Ahsan <[email protected]>

Merge branch 'main' into filter

0bf6a1a

Signed-off-by: Auni Ahsan <[email protected]>

snowp reviewed Feb 25, 2021

View reviewed changes

htuch added the waiting label Feb 28, 2021

change dependencies() call to unique ptr

116922b

Signed-off-by: Auni Ahsan <[email protected]>

repokitteh-read-only bot removed the waiting label Mar 2, 2021

Fix typo

dcdb15e

Signed-off-by: Auni Ahsan <[email protected]>

snowp suggested changes Mar 3, 2021

View reviewed changes

include/envoy/server/filter_config.h Outdated Show resolved Hide resolved

htuch reviewed Mar 4, 2021

View reviewed changes

snowp added the waiting label Mar 4, 2021

auni53 added 2 commits March 5, 2021 14:32

Merge remote-tracking branch 'envoy/main' into filter

83358a1

Signed-off-by: Auni Ahsan <[email protected]>

Add ptr

fb8b464

Signed-off-by: Auni Ahsan <[email protected]>

repokitteh-read-only bot removed the waiting label Mar 5, 2021

snowp approved these changes Mar 5, 2021

View reviewed changes

snowp merged commit 2bb2038 into envoyproxy:main Mar 5, 2021

auni53 deleted the filter branch March 8, 2021 16:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

http filter: Add overrideable function to http filter factory interface for specifying FilterDependencies #15157

http filter: Add overrideable function to http filter factory interface for specifying FilterDependencies #15157

auni53 commented Feb 23, 2021

auni53 commented Feb 23, 2021

htuch left a comment

htuch Feb 24, 2021

auni53 Feb 24, 2021

htuch Feb 24, 2021

auni53 Feb 24, 2021

htuch Feb 25, 2021

auni53 Feb 25, 2021

snowp Feb 25, 2021

htuch Feb 28, 2021

KBaichoo commented Feb 24, 2021

repokitteh-read-only bot commented Feb 24, 2021

snowp Feb 25, 2021

auni53 commented Mar 3, 2021

repokitteh-read-only bot commented Mar 3, 2021

snowp left a comment

htuch left a comment

auni53 commented Mar 5, 2021

repokitteh-read-only bot commented Mar 5, 2021

auni53 commented Mar 5, 2021

repokitteh-read-only bot commented Mar 5, 2021

auni53 commented Mar 5, 2021

snowp left a comment

http filter: Add overrideable function to http filter factory interface for specifying FilterDependencies #15157

http filter: Add overrideable function to http filter factory interface for specifying FilterDependencies #15157

Conversation

auni53 commented Feb 23, 2021

auni53 commented Feb 23, 2021

htuch left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KBaichoo commented Feb 24, 2021

repokitteh-read-only bot commented Feb 24, 2021

Choose a reason for hiding this comment

auni53 commented Mar 3, 2021

repokitteh-read-only bot commented Mar 3, 2021

snowp left a comment

Choose a reason for hiding this comment

htuch left a comment

Choose a reason for hiding this comment

auni53 commented Mar 5, 2021

repokitteh-read-only bot commented Mar 5, 2021

auni53 commented Mar 5, 2021

repokitteh-read-only bot commented Mar 5, 2021

auni53 commented Mar 5, 2021

snowp left a comment

Choose a reason for hiding this comment