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

fix(web): Organization parent subpage - Link highlighting in sidebar #17367

Merged
merged 2 commits into from
Jan 4, 2025

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Dec 30, 2024

Organization parent subpage - Link highlighting in sidebar

What

  • Allow for matching one depth short so that "child pages" keep the link highlight (see screenshots below)

Screenshots / Gifs

Before

Screenshot 2024-12-30 at 13 31 04

After

Screenshot 2024-12-30 at 13 31 27

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features

    • Enhanced navigation item generation with more flexible routing logic
    • Added support for depth-based navigation matching
  • Refactor

    • Improved navigation item generation process
    • Streamlined navigation menu creation method
    • Added more configurable navigation item generation
  • Improvements

    • Introduced more dynamic navigation menu handling
    • Enhanced routing flexibility for organization subpages

@RunarVestmann RunarVestmann added the automerge Merge this PR as soon as all checks pass label Dec 30, 2024
@RunarVestmann RunarVestmann requested a review from a team as a code owner December 30, 2024 13:33
Copy link
Contributor

coderabbitai bot commented Dec 30, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces modifications to the navigation item generation logic in the Organization subpage components. The changes involve updating the getSubpageNavList function in the SubPage.tsx file by adding a new generateNavigationItems function and modifying the existing function signature to include an optional depthOfMatch parameter. The ParentSubpage.tsx file is updated to call the modified function with an additional argument of 3.

Changes

File Change Summary
apps/web/screens/Organization/SubPage.tsx - Added generateNavigationItems function to create navigation items
- Updated getSubpageNavList function signature to include optional depthOfMatch
- Refactored navigation item generation logic
apps/web/screens/Organization/ParentSubpage.tsx - Modified getSubpageNavList function call to include third argument 3

Sequence Diagram

sequenceDiagram
    participant ParentSubpage
    participant SubPage
    participant Router

    ParentSubpage->>SubPage: Call getSubpageNavList(organizationPage, router, 3)
    SubPage->>SubPage: generateNavigationItems()
    SubPage-->>ParentSubpage: Return navigation items
Loading

Possibly related PRs

Suggested labels

deploy-feature

Suggested reviewers

  • mannipje
  • RunarVestmann

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5ea245a and e9825af.

📒 Files selected for processing (1)
  • apps/web/screens/Organization/ParentSubpage.tsx (1 hunks)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

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.

Copy link

codecov bot commented Dec 30, 2024

Codecov Report

Attention: Patch coverage is 0% with 14 lines in your changes missing coverage. Please review.

Project coverage is 35.68%. Comparing base (2699012) to head (5ea245a).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
apps/web/screens/Organization/SubPage.tsx 0.00% 14 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17367      +/-   ##
==========================================
- Coverage   35.68%   35.68%   -0.01%     
==========================================
  Files        6931     6931              
  Lines      148782   148794      +12     
  Branches    42509    42513       +4     
==========================================
  Hits        53091    53091              
- Misses      95691    95703      +12     
Flag Coverage Δ
air-discount-scheme-backend 48.24% <ø> (ø)
air-discount-scheme-web 0.00% <ø> (ø)
api 3.33% <ø> (ø)
api-catalogue-services 75.81% <ø> (ø)
api-domains-air-discount-scheme 37.99% <ø> (ø)
api-domains-assets 26.71% <ø> (ø)
api-domains-auth-admin 48.49% <ø> (ø)
api-domains-communications 39.42% <ø> (ø)
api-domains-criminal-record 48.03% <ø> (ø)
api-domains-driving-license 44.86% <ø> (ø)
api-domains-education 31.27% <ø> (ø)
api-domains-health-insurance 35.47% <ø> (ø)
api-domains-mortgage-certificate 35.24% <ø> (+0.10%) ⬆️
api-domains-payment-schedule 42.12% <ø> (ø)
application-api-files 61.90% <ø> (ø)
application-core 75.72% <ø> (ø)
application-system-api 38.73% <ø> (+<0.01%) ⬆️
application-template-api-modules 27.67% <ø> (-0.02%) ⬇️
application-templates-accident-notification 27.61% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 25.83% <ø> (ø)
application-templates-driving-license 18.15% <ø> (ø)
application-templates-estate 13.66% <ø> (ø)
application-templates-example-payment 24.69% <ø> (ø)
application-templates-financial-aid 14.45% <ø> (ø)
application-templates-general-petition 23.12% <ø> (ø)
application-templates-inheritance-report 6.59% <ø> (ø)
application-templates-marriage-conditions 15.18% <ø> (ø)
application-templates-mortgage-certificate 43.68% <ø> (ø)
application-templates-parental-leave 29.95% <ø> (ø)
application-types 6.51% <ø> (ø)
application-ui-components 1.22% <ø> (ø)
application-ui-shell 22.26% <ø> (ø)
auth-admin-web 2.43% <ø> (ø)
auth-nest-tools 31.52% <ø> (ø)
clients-charge-fjs-v2 28.88% <ø> (ø)
clients-driving-license 40.91% <ø> (ø)
clients-driving-license-book 43.92% <ø> (ø)
clients-financial-statements-inao 49.70% <ø> (ø)
clients-license-client 1.26% <ø> (ø)
clients-middlewares 73.50% <ø> (+0.57%) ⬆️
clients-regulations 43.00% <ø> (ø)
clients-rsk-company-registry 31.18% <ø> (ø)
clients-rsk-personal-tax-return 38.32% <ø> (ø)
clients-smartsolutions 12.77% <ø> (ø)
clients-syslumenn 49.47% <ø> (ø)
clients-zendesk 50.58% <ø> (ø)
cms 0.39% <ø> (ø)
cms-translations 38.75% <ø> (ø)
content-search-toolkit 8.16% <ø> (ø)
dokobit-signing 62.18% <ø> (ø)
email-service 60.15% <ø> (ø)
file-storage 45.97% <ø> (ø)
financial-aid-backend 51.42% <ø> (ø)
financial-aid-shared 17.88% <ø> (ø)
icelandic-names-registry-backend 54.33% <ø> (ø)
infra-nest-server 48.06% <ø> (ø)
infra-tracing 69.94% <ø> (ø)
island-ui-core 30.42% <ø> (ø)
judicial-system-api 20.20% <ø> (ø)
judicial-system-audit-trail 69.02% <ø> (ø)
judicial-system-backend 55.98% <ø> (ø)
judicial-system-message 66.60% <ø> (ø)
judicial-system-message-handler 48.33% <ø> (ø)
judicial-system-scheduler 71.15% <ø> (ø)
judicial-system-web 27.72% <ø> (ø)
license-api 42.87% <ø> (ø)
localization 10.15% <ø> (ø)
logging 58.02% <ø> (ø)
message-queue 67.05% <ø> (ø)
nest-audit 65.78% <ø> (ø)
nest-aws 51.93% <ø> (ø)
nest-config 76.45% <ø> (ø)
nest-core 53.16% <ø> (ø)
nest-feature-flags 51.06% <ø> (ø)
nest-problem 45.64% <ø> (ø)
nest-sequelize 94.44% <ø> (ø)
nest-swagger 51.13% <ø> (ø)
nova-sms 61.52% <ø> (ø)
portals-admin-regulations-admin 1.80% <ø> (ø)
portals-core 19.58% <ø> (ø)
services-auth-admin-api 52.54% <ø> (+0.01%) ⬆️
services-auth-delegation-api 58.46% <ø> (-0.09%) ⬇️
services-auth-ids-api 52.56% <ø> (+<0.01%) ⬆️
services-auth-public-api 49.42% <ø> (ø)
services-sessions 65.36% <ø> (+0.04%) ⬆️
services-university-gateway 49.46% <ø> (-0.06%) ⬇️
services-user-notification 46.51% <ø> (-0.03%) ⬇️
services-user-profile 56.97% <ø> (+0.08%) ⬆️
shared-components 29.49% <ø> (ø)
shared-form-fields 33.38% <ø> (ø)
shared-utils 27.69% <ø> (ø)
skilavottord-ws 24.26% <ø> (ø)
web 2.40% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
apps/web/screens/Organization/ParentSubpage.tsx 0.00% <ø> (ø)
apps/web/screens/Organization/SubPage.tsx 0.00% <0.00%> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 56493cc...5ea245a. Read the comment docs.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
apps/web/screens/Organization/ParentSubpage.tsx (1)

71-71: Consider making the depth value configurable or documented.

Using a hard-coded value of 3 might be obscure without additional context. If multiple sites or sections require different depths, consider extracting this to a constant with a meaningful name or referencing a config value to enhance clarity.

apps/web/screens/Organization/SubPage.tsx (1)

242-242: Document the depthOfMatch parameter.

The depthOfMatch parameter is a great addition, but its behavior and meaning aren’t obvious at first glance. Consider adding JSDoc or inline documentation to explain how this parameter affects path construction.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 56493cc and 5ea245a.

📒 Files selected for processing (2)
  • apps/web/screens/Organization/ParentSubpage.tsx (1 hunks)
  • apps/web/screens/Organization/SubPage.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
apps/web/screens/Organization/ParentSubpage.tsx (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
apps/web/screens/Organization/SubPage.tsx (1)

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
🔇 Additional comments (4)
apps/web/screens/Organization/SubPage.tsx (4)

218-237: Looks good: Enhanced readability and modularity.

The new helper function generateNavigationItems clearly separates link generation logic and improves readability. Good job making the code more modular.


245-247: Guard condition looks correct.

The condition to bypass slicing the path when depthOfMatch is absent (or null) is straightforward and clear.


249-256: Verify the boundary conditions for path slicing.

When slicing the path based on depthOfMatch + 1, ensure that calling pages with fewer segments do not cause unexpected behavior or empty slices. If needed, add an extra check or test for short URL segments.


257-257: Return statement is clean and self-explanatory.

Returning items directly maintains straightforward control flow. No issues noted.

@datadog-island-is
Copy link

datadog-island-is bot commented Dec 30, 2024

Datadog Report

Branch report: fix/web-organization-parent-subpage-link-match
Commit report: 2c9e3fe
Test service: web

✅ 0 Failed, 84 Passed, 0 Skipped, 24.65s Total Time
➡️ Test Sessions change in coverage: 1 no change

@kodiakhq kodiakhq bot merged commit 1f091a0 into main Jan 4, 2025
26 of 27 checks passed
@kodiakhq kodiakhq bot deleted the fix/web-organization-parent-subpage-link-match branch January 4, 2025 06:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants