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): Prevent Organizationpage.menuLinks field from containing null primary links #17601

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Jan 22, 2025

Prevent Organizationpage.menuLinks field from containing null primary links

What

  • If a page that is referenced in a menu link is archived then we see an empty div on the web
  • To prevent this I suggest we filter out any null values

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

  • Bug Fixes
    • Improved menu link filtering to ensure only valid link groups are displayed
    • Removed empty or incomplete menu link groups from the organization page navigation

@RunarVestmann RunarVestmann requested review from a team as code owners January 22, 2025 10:22
Copy link
Contributor

coderabbitai bot commented Jan 22, 2025

Walkthrough

The pull request modifies the mapOrganizationPage function in the OrganizationPage model. The key change is an additional filtering step for menuLinks, which now ensures that only link groups with a truthy primaryLink property are retained. This adjustment refines how menu links are processed, potentially cleaning up or focusing the navigation structure by removing incomplete or invalid link groups.

Changes

File Change Summary
libs/cms/src/lib/models/organizationPage.model.ts Updated menuLinks mapping to include a .filter() method that keeps only link groups with a valid primaryLink

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • mannipje
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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
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 (1)
libs/cms/src/lib/models/organizationPage.model.ts (1)

131-133: LGTM! Consider enhancing type safety.

The filter implementation correctly removes link groups with null primary links, addressing the PR objective. However, consider making it more type-safe:

-      .filter((linkGroup) => Boolean(linkGroup?.primaryLink)),
+      .filter((linkGroup): linkGroup is LinkGroup & { primaryLink: NonNullable<LinkGroup['primaryLink']> } => 
+        Boolean(linkGroup?.primaryLink)),
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c5c9a10 and c9e9379.

📒 Files selected for processing (1)
  • libs/cms/src/lib/models/organizationPage.model.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/cms/src/lib/models/organizationPage.model.ts (1)

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

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."
🔇 Additional comments (1)
libs/cms/src/lib/models/organizationPage.model.ts (1)

Line range hint 1-150: Excellent adherence to coding guidelines.

The file structure follows best practices for shared libraries:

  • Uses TypeScript effectively with proper type definitions
  • Implements GraphQL decorators consistently
  • Exports types and functions clearly, enabling effective tree-shaking
  • Components and types are reusable across NextJS apps

Copy link

codecov bot commented Jan 22, 2025

Codecov Report

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

Project coverage is 35.57%. Comparing base (c5c9a10) to head (c9e9379).
Report is 7 commits behind head on main.

Files with missing lines Patch % Lines
libs/cms/src/lib/models/organizationPage.model.ts 0.00% 2 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17601      +/-   ##
==========================================
- Coverage   35.57%   35.57%   -0.01%     
==========================================
  Files        7030     7030              
  Lines      150471   150472       +1     
  Branches    42961    42962       +1     
==========================================
  Hits        53531    53531              
- Misses      96940    96941       +1     
Flag Coverage Δ
air-discount-scheme-backend 48.15% <ø> (ø)
air-discount-scheme-web 0.00% <ø> (ø)
api 3.33% <ø> (ø)
api-catalogue-services 75.81% <ø> (ø)
api-domains-air-discount-scheme 37.90% <ø> (ø)
api-domains-assets 26.71% <ø> (ø)
api-domains-auth-admin 48.49% <ø> (ø)
api-domains-communications 39.48% <0.00%> (-0.01%) ⬇️
api-domains-criminal-record 47.81% <ø> (ø)
api-domains-driving-license 44.77% <ø> (ø)
api-domains-health-insurance 35.19% <ø> (ø)
api-domains-mortgage-certificate 34.96% <ø> (ø)
api-domains-payment-schedule 42.04% <ø> (ø)
application-api-files 61.80% <ø> (ø)
application-core 75.68% <ø> (ø)
application-system-api 38.68% <0.00%> (-0.01%) ⬇️
application-template-api-modules 27.55% <0.00%> (-0.01%) ⬇️
application-templates-accident-notification 27.60% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 25.79% <ø> (ø)
application-templates-driving-license 18.15% <ø> (ø)
application-templates-estate 13.58% <ø> (ø)
application-templates-example-payment 24.66% <ø> (ø)
application-templates-financial-aid 14.92% <ø> (ø)
application-templates-general-petition 23.11% <ø> (ø)
application-templates-inheritance-report 6.59% <ø> (ø)
application-templates-marriage-conditions 14.80% <ø> (ø)
application-templates-mortgage-certificate 43.73% <ø> (ø)
application-templates-new-primary-school 21.02% <ø> (ø)
application-templates-parental-leave 29.92% <ø> (ø)
application-types 6.47% <ø> (ø)
application-ui-components 1.17% <ø> (ø)
application-ui-shell 22.00% <ø> (ø)
auth-admin-web 2.43% <ø> (ø)
auth-nest-tools 31.69% <ø> (ø)
auth-shared 75.00% <ø> (ø)
clients-charge-fjs-v2 28.88% <ø> (ø)
clients-driving-license 40.68% <ø> (ø)
clients-driving-license-book 43.75% <ø> (ø)
clients-financial-statements-inao 49.48% <ø> (ø)
clients-license-client 1.26% <ø> (ø)
clients-regulations 42.75% <ø> (ø)
clients-rsk-company-registry 31.18% <ø> (ø)
clients-rsk-personal-tax-return 38.32% <ø> (ø)
clients-smartsolutions 12.77% <ø> (ø)
clients-syslumenn 49.18% <ø> (ø)
clients-zendesk 49.88% <ø> (ø)
cms 0.39% <0.00%> (-0.01%) ⬇️
cms-translations 38.81% <0.00%> (-0.01%) ⬇️
content-search-index-manager 95.65% <ø> (ø)
content-search-toolkit 8.16% <ø> (ø)
contentful-apps 4.56% <ø> (ø)
dokobit-signing 61.66% <ø> (ø)
email-service 59.68% <ø> (ø)
feature-flags 90.40% <ø> (ø)
file-storage 45.32% <ø> (ø)
financial-aid-backend 51.38% <ø> (ø)
financial-aid-shared 17.88% <ø> (ø)
icelandic-names-registry-backend 54.44% <ø> (ø)
infra-nest-server 48.06% <ø> (ø)
infra-tracing 69.94% <ø> (ø)
island-ui-core 30.32% <ø> (ø)
judicial-system-api 20.07% <ø> (ø)
judicial-system-audit-trail 68.53% <ø> (ø)
judicial-system-backend 55.81% <0.00%> (-0.01%) ⬇️
judicial-system-formatters 78.86% <ø> (ø)
judicial-system-message 66.29% <ø> (ø)
judicial-system-message-handler 47.89% <ø> (ø)
judicial-system-scheduler 71.24% <ø> (ø)
judicial-system-types 37.77% <ø> (ø)
judicial-system-web 27.97% <ø> (ø)
license-api 42.84% <ø> (ø)
localization 10.15% <ø> (ø)
logging 58.02% <ø> (ø)
message-queue 67.05% <ø> (ø)
nest-audit 65.78% <ø> (ø)
nest-aws 51.93% <ø> (ø)
nest-config 76.05% <ø> (ø)
nest-core 53.16% <ø> (ø)
nest-feature-flags 50.69% <ø> (ø)
nest-problem 45.64% <ø> (ø)
nest-sequelize 94.44% <ø> (ø)
nest-swagger 51.13% <ø> (ø)
nova-sms 60.96% <ø> (ø)
portals-admin-regulations-admin 1.80% <ø> (ø)
portals-core 19.60% <ø> (ø)
regulations 16.78% <ø> (ø)
residence-history 85.00% <ø> (ø)
services-auth-admin-api 52.47% <ø> (ø)
services-auth-delegation-api 58.47% <ø> (+0.08%) ⬆️
services-auth-ids-api 52.51% <ø> (ø)
services-auth-public-api 49.36% <ø> (ø)
services-sessions 65.33% <ø> (ø)
services-university-gateway 49.38% <ø> (-0.09%) ⬇️
services-user-notification 46.52% <0.00%> (-0.01%) ⬇️
services-user-profile 56.92% <ø> (ø)
shared-components 29.47% <ø> (ø)
shared-form-fields 33.36% <ø> (ø)
shared-mocking 58.64% <ø> (ø)
shared-pii 92.85% <ø> (ø)
shared-problem 87.50% <ø> (ø)
shared-utils 28.67% <ø> (ø)
skilavottord-ws 23.97% <ø> (ø)
web 2.39% <ø> (ø)

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

Files with missing lines Coverage Δ
libs/cms/src/lib/models/organizationPage.model.ts 44.70% <0.00%> (-0.54%) ⬇️

... and 1 file with indirect coverage changes


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 c5c9a10...c9e9379. Read the comment docs.

@datadog-island-is
Copy link

Datadog Report

All test runs e4955d5 🔗

10 Total Test Services: 0 Failed, 10 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.03%), 1 increased (+0.04%), 198 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
air-discount-scheme-backend 0 0 0 63 0 47.58s N/A Link
air-discount-scheme-web 0 0 0 2 0 5.93s N/A Link
api 0 0 0 4 0 2.31s N/A Link
api-catalogue-services 0 0 0 23 0 7.91s N/A Link
api-domains-air-discount-scheme 0 0 0 6 0 16.06s N/A Link
api-domains-assets 0 0 0 3 0 8.41s N/A Link
api-domains-auth-admin 0 0 0 18 0 8.61s N/A Link
api-domains-communications 0 0 0 5 0 30.94s N/A Link
api-domains-criminal-record 0 0 0 5 0 7.95s N/A Link
api-domains-driving-license 0 0 0 23 0 29.93s N/A Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • services-university-gateway - jest 45.21% (-0.03%) - Details

@RunarVestmann RunarVestmann added this pull request to the merge queue Jan 22, 2025
Merged via the queue into main with commit 5ffcc4c Jan 22, 2025
277 checks passed
@RunarVestmann RunarVestmann deleted the fix/web-organization-page-sidebar-links-taking-up-space-when-null branch January 22, 2025 15:12
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