feat(router): optional router in NavRouter and withNavRouter

[rafalmaksymiuk]

Router usage in NavRouter and withNavRouter made optional.
While change ins NavRouter is optional, as in component that uses it it can be simple removed in case flag is enabled. HOC needs it as it is difficult to use hoc conditionally in the wrapper chain.

Summary by CodeRabbit

• New Features
  • Added support for a feature flag to disable routing, allowing content to render directly without navigation routing when enabled.
• Tests
  • Enhanced tests to confirm correct rendering behavior with the router feature flag toggled on or off.
• Refactor
  • Updated components and types to accept feature configuration props, enabling conditional rendering based on feature flags.

[coderabbitai]

Walkthrough

The NavRouter and withNavRouter components now accept an optional features prop and use a feature flag to conditionally disable routing. If the 'routerDisabled.value' flag is enabled, routing is bypassed and children are rendered directly. Types and tests were updated to support and verify this new conditional behavior.

Changes

File(s)	Change Summary
src/elements/common/nav-router/NavRouter.js.flow, src/elements/common/nav-router/NavRouter.tsx	Added optional features prop, updated logic to conditionally bypass routing based on feature flag.
src/elements/common/nav-router/types.ts, src/elements/common/nav-router/withNavRouter.js.flow	Extended WithNavRouterProps type with optional features and initialEntries properties.
src/elements/common/nav-router/withNavRouter.tsx	Modified HOC to use feature flag for conditional routing, passed features prop to NavRouter.
src/elements/common/nav-router/tests/withNavRouter.test.tsx	Refactored tests to React Testing Library, added tests for feature-flagged routing disablement.
src/elements/content-sidebar/ContentSidebar.js	Passed features prop to NavRouter in render method.

Sequence Diagram(s)

sequenceDiagram
    participant Parent
    participant WithNavRouter
    participant NavRouter
    participant ChildComponent

    Parent->>WithNavRouter: render({ features })
    WithNavRouter->>WithNavRouter: isFeatureEnabled('routerDisabled.value', features)
    alt routerDisabled enabled
        WithNavRouter->>ChildComponent: render directly
    else routerDisabled not enabled
        WithNavRouter->>NavRouter: render({ features })
        NavRouter->>ChildComponent: render within router
    end

Loading

Possibly related PRs

• feat(router): optional router in withAnnotatorContext and withAnnotations #4136: Adds optional router disabling logic using feature flags within withAnnotatorContext and withAnnotations components, similar to this PR’s conditional routing disablement.

Suggested labels

ready-to-merge

Suggested reviewers

• greg-in-a-box
• jankowiakdawid

Poem

A hop and a skip, a feature appears,
Now routers may vanish, dispelling old fears.
If flags say "no routing," then plain paths you'll see,
But toggle it off, and routers run free.
With carrots of logic and lettuce of code,
This bunny ensures your routes can be towed! 🥕

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3fd107d and ac9f196.

📒 Files selected for processing (1)

• src/elements/common/nav-router/withNavRouter.tsx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/elements/common/nav-router/withNavRouter.tsx

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: lint_test_build
• GitHub Check: Summary

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• 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 src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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

Documentation and Community

• 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.