Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarity around http filter ordering #11057

Merged
merged 2 commits into from
May 5, 2020
Merged

docs: clarity around http filter ordering #11057

merged 2 commits into from
May 5, 2020

Conversation

junr03
Copy link
Member

@junr03 junr03 commented May 5, 2020

Commit Message: add clarifying documentation about http filter ordering.
Additional Description: I still had an arcane mental model (pre #5955) where both decoder and encoder filters where invoked in the same order as the configuration order. My mind was so used to this I even failed to notice the code that prepends encoder filters into the encoder_filters_ list in the conn manager. These documentation additions are trying to make the behavior as explicit as possible so others are not confused.
Risk Level: low - doc updates, no behavior change.
Docs Changes: updated inline comments in the code I failed to notice, and in the project docs.

#5955

Signed-off-by: Jose Nino <jnino@lyft.com>
@repokitteh-read-only
Copy link

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to api/.
CC @envoyproxy/api-watchers: FYI only for changes made to api/.

🐱

Caused by: #11057 was opened by junr03.

see: more, trace.

@buildbreaker
Copy link

👏Nice @junr03 !

mattklein123
mattklein123 previously approved these changes May 5, 2020
Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@repokitteh-read-only repokitteh-read-only bot removed the api label May 5, 2020
- B
- C

The connection manager will invoke decoder filters in the order: ``A``, ``B``, ``C``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's worth mention that there have to be a terminal filter at the end, usually the router.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lizan good point! Updated, lmk what you think

alyssawilk
alyssawilk previously approved these changes May 5, 2020
Signed-off-by: Jose Nino <jnino@lyft.com>
@junr03 junr03 dismissed stale reviews from alyssawilk and mattklein123 via 7203014 May 5, 2020 17:52
@repokitteh-read-only repokitteh-read-only bot removed the api label May 5, 2020
@lizan lizan merged commit 4abe685 into envoyproxy:master May 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants