Skip to content

Feature/ba 2656 be setup routing for wagtail and base app pages #313

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
wants to merge 16 commits into
base: epic/wagtail-graphql
Choose a base branch
from

Conversation

Hercilio1
Copy link
Contributor

@Hercilio1 Hercilio1 commented Aug 14, 2025

Acceptance Criteria

Investigate Solution for Router

  • Investigate how to intercept and prioritize routing requests between Wagtail and BaseApp.
  • Determine how to reliably detect matching paths in both systems and default to Wagtail when duplicates exist.
  • Validate whether Wagtail routing can reuse or hook into BaseApp’s existing middleware or router logic.
  • Validate correct routing priority: Wagtail takes precedence over BaseApp when both match.
  • Confirm that 404s are returned only when no match exists in either system.
  • Verify that Wagtail pages served via unified routing use the BaseApp metadata format consistently.

Routing Behavior

  • Given a URL path is requested that matches both a Wagtail page and a BaseApp page,
    when the routing logic is executed,
    then the Wagtail page should be served.

  • Given a URL path is requested that matches only a Wagtail page,
    when the routing logic is executed,
    then the Wagtail page should be served.

  • Given a URL path is requested that matches only a BaseApp page,
    when the routing logic is executed,
    then the BaseApp page should be served.

  • Given a URL path is requested that matches neither Wagtail nor BaseApp pages,
    when the routing logic is executed,
    then a 404 response should be returned.

  • Given a Wagtail page is served via the unified router,
    when metadata is rendered,
    then it should use the existing BaseApp metadata structure.

URLPath Syncing

  • Given a Wagtail Page is created or updated,
    when the operation completes successfully,
    then a corresponding URLPath entry should be created or updated to match the new path.

  • Given a Wagtail Page is created or updated,
    when the URLPath cannot be synced due to a validation error or path conflict,
    then a clear and descriptive error message should be returned.

  • Given a Wagtail Page is deleted,
    when the deletion is complete,
    then its associated URLPath entry should also be deleted.

URLPath Query Support

  • Given a valid URLPath exists for a Wagtail Page,
    when querying URL-based data in GraphQL,
    then the correct path, slug, and page details should be returned.

  • Given a Wagtail Page is saved with a conflicting or invalid path,
    when the system validates the path,
    then a meaningful and specific error should be returned.

Backward Compatibility

  • Given existing functionality relies on baseapp-pages.PageInterface,
    when wagtail-grapple and WagtailPageInterface are introduced,
    then all existing baseapp-pages features should continue to work without regression.

  • Given no updates are made to the legacy REST layer,
    when endpoints using baseapp-pages are called,
    then they should continue to behave as previously defined.

Documentation and Developer Guidance

- Given the integration between baseapp-pages and Wagtail has changed,
when a developer reads internal documentation,
then it should clearly explain how WagtailPageInterface reuses logic from PageInterface.

- Given a developer reviews README files or code comments,
when examining the GraphQL metadata or URL path behavior,
then the updated interface usage should be clearly documented and easy to follow.

Notes

SPIKE Deliverable

Make use of baseapp.pages.URLPath to integrate all URLs in the system and also to allow for Wagtail pages to live in the root like: domain.com/about.

Approvd:
https://app.approvd.io/silverlogic/BA/stories/36399


Setup

  • Use the template PRs for testing these changes.

Demo

https://www.loom.com/share/7b468c6cbc0b4be4b778d7b63c69bca2

PRs

Copy link

coderabbitai bot commented Aug 14, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/BA-2656-be-setup-routing-for-wagtail-and-base-app-pages

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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.

2 participants