-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Handle /page/ redirects for subprojects #12627
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
Open
ericholscher
wants to merge
2
commits into
main
Choose a base branch
from
codex/investigate-/page/-redirect-issue-in-rtd-r8px2t
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # Spike: /page/ redirects for subprojects | ||
|
|
||
| ## Background and problem | ||
|
|
||
| Users expect `/page/` URLs on subprojects to redirect to the default version, the same way they do for top-level projects. Today those requests return 404 because the redirect view only looks up subprojects by alias on the parent project. When the current request context already belongs to the subproject (for example, after middleware resolves the host to the child project) or when the stored alias differs from the slug, that lookup fails and the redirect short-circuits. | ||
|
|
||
| ## Findings | ||
|
|
||
| * The proxito URL configuration already routes `/projects/<slug>/page/<path>` to `ServePageRedirect`, so the failure happens in the view rather than URL parsing. | ||
| * `ServePageRedirect` fetched subprojects exclusively via `project.subprojects.filter(alias=...)`, which raises `Http404` when the request context is already scoped to the subproject or when an alias mismatch occurs. | ||
| * The redirect logic ultimately just needs the correct `Project` instance to resolve the default version and build the target URL; it should tolerate being invoked from either the parent or child context. | ||
|
|
||
| ## Proposed approach | ||
|
|
||
| * Expand subproject resolution in `ServePageRedirect` to handle three cases: | ||
| * If the current project already matches the requested slug, treat it as the target subproject. | ||
| * Otherwise, try to find a `ProjectRelationship` by alias and fall back to matching the child slug. | ||
| * Raise `Http404` only when no relationship matches, preserving existing behavior for invalid slugs. | ||
| * Keep the rest of the redirect flow unchanged so the spike stays low risk while we validate that subproject `/page/` redirects behave like top-level projects. | ||
|
|
||
| ## Validation plan | ||
|
|
||
| * Add a focused proxito test that requests `/projects/<subproject>/page/<file>` on the public domain and asserts a 302 to the subproject's default version. | ||
| * Run the proxito redirect tests locally to confirm the new lookup path fixes the 404 without affecting existing redirects. | ||
| Use the proxito test settings so the proxito URLConf and middleware are active: | ||
|
|
||
| ``` | ||
| DJANGO_SETTINGS_MODULE=readthedocs.settings.proxito.test \ | ||
| uv run pytest readthedocs/proxito/tests/test_old_redirects.py::InternalRedirectTests::test_page_redirect_on_subproject -vv -s | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably add a test case for a project with a custom
/projects/prefix in the URL as well.