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(application-system): Add support for forwarding query params through DelegationsScreen #17593

Merged
merged 2 commits into from
Jan 22, 2025

Conversation

norda-gunni
Copy link
Member

@norda-gunni norda-gunni commented Jan 21, 2025

...

Attach a link to issue if relevant

What

Allow query params to pass through the delegations screen

Why

To enable passing params to applications that use the delegation screen.

Screenshots / Gifs

Attach Screenshots / Gifs to help reviewers understand the scope of the pull request

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 delegation navigation by preserving URL search parameters when interacting with delegation items.
    • Improved URL parameter handling using React Router's useSearchParams hook.
  • Refactor

    • Updated navigation logic to maintain current search state during delegation interactions.

@norda-gunni norda-gunni requested a review from a team as a code owner January 21, 2025 15:25
Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

Walkthrough

The changes modify the DelegationsScreen component in the UI shell to enhance URL parameter handling. By introducing the useSearchParams hook from react-router-dom, the component can now capture and preserve search parameters during navigation. The handleClick function is updated to create a paramString that concatenates all current search parameters, ensuring that these parameters are maintained when a user interacts with delegation items.

Changes

File Change Summary
libs/application/ui-shell/src/components/DelegationsScreen.tsx Introduced useSearchParams hook to access URL search parameters. Updated handleClick to include paramString for navigation, preserving search parameters.

Suggested Labels

automerge

Suggested Reviewers

  • baering

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: 1

🧹 Nitpick comments (1)
libs/application/ui-shell/src/components/DelegationsScreen.tsx (1)

Line range hint 38-43: Enhance type documentation for better reusability.

While the component uses TypeScript effectively, adding JSDoc comments for the props interface would improve reusability across different NextJS apps.

Consider adding documentation:

+/**
+ * Props for the DelegationsScreen component
+ * @property {Array<{nationalId: string}>} alternativeSubjects - Optional list of alternative subjects
+ * @property {Dispatch<SetStateAction<boolean>>} checkDelegation - Callback to update delegation check state
+ * @property {string} slug - The application slug used to determine the type
+ */
interface DelegationsScreenProps {
  alternativeSubjects?: { nationalId: string }[]
  checkDelegation: Dispatch<SetStateAction<boolean>>
  slug: string
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4215671 and 5d05be8.

📒 Files selected for processing (1)
  • libs/application/ui-shell/src/components/DelegationsScreen.tsx (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/application/ui-shell/src/components/DelegationsScreen.tsx (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/application/ui-shell/src/components/DelegationsScreen.tsx (1)

192-192: LGTM! Verify parameter forwarding in different scenarios.

The navigation logic successfully forwards query parameters while maintaining the delegationChecked state.

Run this script to verify parameter handling in different scenarios:

✅ Verification successful

Parameter handling implementation follows codebase patterns

The navigation logic with query parameter forwarding is consistent with similar implementations across the codebase, particularly in delegation-related components and admin modules.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify parameter handling patterns in the codebase
# Look for other navigation calls that might need similar parameter forwarding

# Search for navigation patterns
rg "navigate\(" --type typescript

# Search for useSearchParams usage to ensure consistent parameter handling
rg "useSearchParams" --type typescript

Length of output: 144


Script:

#!/bin/bash
# Search for navigation patterns and parameter handling in TypeScript files
rg "navigate\(" -t ts -t tsx -A 2

# Look for useSearchParams usage and parameter handling
rg "useSearchParams" -t ts -t tsx -A 2

# Search for query parameter manipulation patterns
rg "searchParams" -t ts -t tsx -A 2

Length of output: 194


Script:

#!/bin/bash
# Find TypeScript/React files containing navigation patterns
fd "\.(ts|tsx)$" | xargs rg "navigate\(" -l

# Look for parameter handling patterns
fd "\.(ts|tsx)$" | xargs rg "useSearchParams|searchParams|paramString" -l

# Get detailed context around parameter handling
fd "\.(ts|tsx)$" | xargs rg "(\?.*=.*\$\{.*\}|\${paramString})" -A 2 -B 2

Length of output: 6533

Copy link

codecov bot commented Jan 21, 2025

Codecov Report

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

Project coverage is 35.57%. Comparing base (4215671) to head (0e7b6a9).
Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
...tion/ui-shell/src/components/DelegationsScreen.tsx 0.00% 6 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #17593      +/-   ##
==========================================
- Coverage   35.57%   35.57%   -0.01%     
==========================================
  Files        7030     7030              
  Lines      150466   150471       +5     
  Branches    42959    42961       +2     
==========================================
+ Hits        53533    53534       +1     
- Misses      96933    96937       +4     
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.49% <ø> (ø)
api-domains-criminal-record 47.81% <ø> (ø)
api-domains-driving-license 44.77% <ø> (ø)
api-domains-education 31.09% <ø> (ø)
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.01%) ⬆️
application-template-api-modules 27.57% <ø> (ø)
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.99% <ø> (+0.07%) ⬆️
application-types 6.47% <ø> (ø)
application-ui-components 1.17% <ø> (ø)
application-ui-shell 22.00% <0.00%> (-0.02%) ⬇️
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-middlewares 73.39% <ø> (+0.32%) ⬆️
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% <ø> (ø)
cms-translations 38.82% <ø> (ø)
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% <ø> (ø)
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.97% <ø> (+0.05%) ⬆️
localization 10.15% <ø> (ø)
logging 58.02% <ø> (ø)
message-queue 67.76% <ø> (ø)
nest-audit 65.78% <ø> (ø)
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% <ø> (+<0.01%) ⬆️
services-auth-public-api 49.36% <ø> (ø)
services-sessions 65.28% <ø> (ø)
services-university-gateway 49.38% <ø> (ø)
services-user-notification 46.53% <ø> (+0.02%) ⬆️
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 Δ
...tion/ui-shell/src/components/DelegationsScreen.tsx 0.00% <0.00%> (ø)

... 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 4215671...0e7b6a9. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Jan 21, 2025

Datadog Report

All test runs 4760e7e 🔗

10 Total Test Services: 0 Failed, 10 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.29%), 2 increased, 197 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 51.34s N/A Link
air-discount-scheme-web 0 0 0 2 0 6.5s N/A Link
api 0 0 0 4 0 2.27s N/A Link
api-catalogue-services 0 0 0 23 0 7.71s N/A Link
api-domains-air-discount-scheme 0 0 0 6 0 16.28s N/A Link
api-domains-assets 0 0 0 3 0 7.99s N/A Link
api-domains-auth-admin 0 0 0 18 0 8.67s N/A Link
api-domains-communications 0 0 0 5 0 32.93s N/A Link
api-domains-criminal-record 0 0 0 5 0 8.49s N/A Link
api-domains-driving-license 0 0 0 23 0 29.15s N/A Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • clients-middlewares - jest 75.57% (-0.29%) - Details

@norda-gunni norda-gunni added the deploy-feature Deploys features to dev label Jan 22, 2025
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/application/ui-shell/src/components/DelegationsScreen.tsx (1)

192-192: Consider using URLSearchParams for robust URL construction.

While the current implementation works, using URLSearchParams would provide a more robust solution for handling URL parameters.

-      navigate(`?delegationChecked=true${paramString}`)
+      const newParams = new URLSearchParams(searchParams)
+      newParams.set('delegationChecked', 'true')
+      navigate(`?${newParams.toString()}`)

This approach:

  • Maintains all existing parameters
  • Handles parameter encoding consistently
  • Follows web standards for URL manipulation
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5d05be8 and 0e7b6a9.

📒 Files selected for processing (1)
  • libs/application/ui-shell/src/components/DelegationsScreen.tsx (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/application/ui-shell/src/components/DelegationsScreen.tsx (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 (2)
libs/application/ui-shell/src/components/DelegationsScreen.tsx (2)

25-25: LGTM! Clean integration of URL parameter handling.

The addition of useSearchParams hook and its usage follows React conventions and aligns with the PR objective.

Also applies to: 56-57


58-63: Well-implemented URL parameter handling.

The implementation follows best practices by:

  • Properly handling empty searchParams
  • Using URL encoding for parameter values
  • Efficiently constructing the parameter string

Copy link
Contributor

Affected services are: application-system-form,
Feature deployment of your services will begin shortly. Your feature will be accessible here:
https://as-delegation-param-forward-beta.dev01.devland.is/umsoknir

Deployed services: application-system-form.
Excluded services: ``

@norda-gunni norda-gunni added this pull request to the merge queue Jan 22, 2025
Merged via the queue into main with commit c5c9a10 Jan 22, 2025
546 of 555 checks passed
@norda-gunni norda-gunni deleted the as-delegation-param-forward branch January 22, 2025 10:02
thoreyjona pushed a commit that referenced this pull request Jan 22, 2025
…ugh DelegationsScreen (#17593)

* fix(application-system): Add support for forwarding query params through DelegationsScreen

* PR comment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy-feature Deploys features to dev
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants