spring-projects / spring-projects/spring-security

[doc issue] filter ordering

Open Beginner friendly
#19,730 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status: waiting-for-triage type: enhancement
Dominant language
Java
Stars
9.6k
Forks
6.3k
Avg merge
2d 11h
Merged PRs (30d)
52

Description

Expected Behavior

The documentation should clarify what addFilterBefore means.
For example, if the we have filter chain is A → B → C and we call addFilterBefore(X, C.class),
is the result
A → B → X → C or
A → X → B → C or
X → A → B → C .
all of them follow the rule of ( X before C ) ?
so i think we need some clarifications for addFilterBefore and addFilterAfter cases

Current Behavior

The documentation only says that

#addFilterBefore(Filter, Class<?>)adds your filter before another filter
#addFilterAfter(Filter, Class<?>) adds your filter after another filter

which does not make the exact ordering guarantee clear.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the servlet architecture documentation section on adding filters to a chain, linked in the issue, and review the descriptions of addFilterBefore and addFilterAfter. Clarify the ordering guarantee using the issue's A → B → C and X examples; done when the documentation unambiguously explains both methods' placement rules.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.