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

feat(web): Pension Calculator - Display icon to left of title for 2025 preview #17251

Merged
merged 2 commits into from
Dec 16, 2024

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Dec 16, 2024

Pension Calculator - Display icon to left of title for 2025 preview

Why

Screenshots / Gifs

Screenshot 2024-12-16 at 13 50 33

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

    • Introduced a new PensionCalculatorTitle component for improved title rendering.
    • Added a new CSS class noWrap to enhance layout styling.
    • Expanded localization with a new message for an image URL related to pension calculations.
  • Bug Fixes

    • Refactored title rendering logic to improve modularity and readability in the PensionCalculatorResults component.

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

coderabbitai bot commented Dec 16, 2024

Walkthrough

The pull request introduces a new PensionCalculatorTitle component across multiple files in the Social Insurance Administration's Pension Calculator module. The changes focus on refactoring the title rendering logic, adding a new CSS style for preventing text wrapping, and including a new translation string for an icon URL. The modifications aim to improve code organization, modularity, and internationalization capabilities while maintaining the existing functionality of the pension calculator.

Changes

File Change Summary
PensionCalculator.css.ts Added noWrap style to prevent flex items from wrapping
PensionCalculator.tsx Refactored title rendering using new PensionCalculatorTitle component
PensionCalculatorResults.tsx Replaced inline title rendering with PensionCalculatorTitle component
PensionCalculatorTitle.tsx New component for rendering title with conditional image and internationalization support
translationStrings.ts Added new translation message for icon URL after September 1, 2025

Sequence Diagram

sequenceDiagram
    participant PC as PensionCalculator
    participant PCT as PensionCalculatorTitle
    participant Intl as react-intl
    
    PC->>PCT: Render with props
    PCT->>Intl: Fetch translations
    alt isNewSystemActive is true
        PCT-->>PC: Render title with image
    else
        PCT-->>PC: Render simple title
    end
Loading

Possibly related PRs

Suggested labels

deploy-feature

Suggested reviewers

  • mannipje

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request.


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.

@datadog-island-is
Copy link

datadog-island-is bot commented Dec 16, 2024

Datadog Report

All test runs 8fff4e6 🔗

4 Total Test Services: 0 Failed, 4 Passed
⬆️ Test Sessions change in coverage: 1 increased (+0.01%), 4 no change

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 2.88s 1 no change Link
application-system-api 0 0 0 46 0 2m 2.14s 1 no change Link
application-template-api-modules 0 0 0 118 0 2m 31.29s 1 increased (+0.01%) Link
web 0 0 0 84 0 32.84s 1 no change Link

Copy link

codecov bot commented Dec 16, 2024

Codecov Report

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

Project coverage is 35.73%. Comparing base (271e5d2) to head (d27a769).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...InsuranceAdministration/PensionCalculatorTitle.tsx 0.00% 6 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #17251   +/-   ##
=======================================
  Coverage   35.73%   35.73%           
=======================================
  Files        6937     6938    +1     
  Lines      148315   148305   -10     
  Branches    42331    42318   -13     
=======================================
  Hits        52999    52999           
+ Misses      95316    95306   -10     
Flag Coverage Δ
api 3.33% <ø> (ø)
application-system-api 38.73% <ø> (-0.02%) ⬇️
application-template-api-modules 27.82% <ø> (+<0.01%) ⬆️
web 2.41% <0.00%> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
...ocialInsuranceAdministration/PensionCalculator.tsx 0.00% <ø> (ø)
...suranceAdministration/PensionCalculatorResults.tsx 0.00% <ø> (ø)
...ocialInsuranceAdministration/translationStrings.ts 0.00% <ø> (ø)
...InsuranceAdministration/PensionCalculatorTitle.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 271e5d2...d27a769. 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: 1

🧹 Nitpick comments (3)
apps/web/screens/Organization/SocialInsuranceAdministration/translationStrings.ts (1)

628-634: Consider managing image URLs through a configuration file.

While the implementation works, hardcoding CDN URLs in translation strings makes it difficult to update them if needed. Consider:

  1. Moving image URLs to a separate configuration file
  2. Using the configuration values in translation strings

Example approach:

// config/images.ts
export const images = {
  pensionCalculator: {
    after1stSeptember2025Icon: 'https://images.ctfassets.net/8k0h54kbe6bj/5RIwKVet87Nm4ycltkzjnX/9c594855a9b2f90dde63766ee87a09ca/58dd40fbf365769d984be22a9b64bc29.png'
  }
}

// translationStrings.ts
import { images } from '../config/images'

export const translationStrings = defineMessages({
  after1stSeptember2025IconUrl: {
    id: 'web.pensionCalculator:after1stSeptember2025IconUrl',
    defaultMessage: images.pensionCalculator.after1stSeptember2025Icon,
    description: 'Mynd vinstra megin við titil "Reiknivél örorku- og endurhæfingargreiðslna eftir 1. september 2025"'
  }
})
apps/web/screens/Organization/SocialInsuranceAdministration/PensionCalculator.css.ts (1)

50-52: LGTM! Consider adding a comment for clarity.

The noWrap style correctly prevents flex items from wrapping, which is essential for maintaining the icon-title layout.

 export const noWrap = style({
+  // Prevents wrapping of flex items (used for icon-title layout)
   flexWrap: 'nowrap',
 })
apps/web/screens/Organization/SocialInsuranceAdministration/PensionCalculatorTitle.tsx (1)

26-31: Consider adding image dimensions to CSS.

While the width and height attributes are good for preventing layout shifts, consider moving these dimensions to CSS for better maintainability.

+const ICON_DIMENSIONS = {
+  width: 84,
+  height: 70,
+} as const;

 <img
-  width={84}
-  height={70}
+  width={ICON_DIMENSIONS.width}
+  height={ICON_DIMENSIONS.height}
   src={formatMessage(translationStrings.after1stSeptember2025IconUrl)}
   alt=""
 />
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 271e5d2 and 4c0038a.

📒 Files selected for processing (5)
  • apps/web/screens/Organization/SocialInsuranceAdministration/PensionCalculator.css.ts (1 hunks)
  • apps/web/screens/Organization/SocialInsuranceAdministration/PensionCalculator.tsx (3 hunks)
  • apps/web/screens/Organization/SocialInsuranceAdministration/PensionCalculatorResults.tsx (3 hunks)
  • apps/web/screens/Organization/SocialInsuranceAdministration/PensionCalculatorTitle.tsx (1 hunks)
  • apps/web/screens/Organization/SocialInsuranceAdministration/translationStrings.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (5)
apps/web/screens/Organization/SocialInsuranceAdministration/PensionCalculator.css.ts (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/SocialInsuranceAdministration/translationStrings.ts (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/SocialInsuranceAdministration/PensionCalculator.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/SocialInsuranceAdministration/PensionCalculatorTitle.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/SocialInsuranceAdministration/PensionCalculatorResults.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 (3)
apps/web/screens/Organization/SocialInsuranceAdministration/PensionCalculator.tsx (1)

53-53: LGTM! Clean refactoring of the title component.

The changes effectively:

  1. Extract title rendering logic into a dedicated component
  2. Maintain consistent prop usage across both instances
  3. Improve code organization and reusability

Also applies to: 558-563, 584-589

apps/web/screens/Organization/SocialInsuranceAdministration/PensionCalculatorTitle.tsx (1)

8-13: LGTM! Props interface is well-defined.

The interface clearly defines the required props with appropriate types.

apps/web/screens/Organization/SocialInsuranceAdministration/PensionCalculatorResults.tsx (1)

365-370: LGTM! Clean integration of PensionCalculatorTitle component.

The new component is consistently used in both locations where the title needs to be rendered, improving code organization and maintainability.

Also applies to: 391-396

@kodiakhq kodiakhq bot merged commit 0c7df8f into main Dec 16, 2024
45 checks passed
@kodiakhq kodiakhq bot deleted the feature/web-pension-calculator-2025-preview-icon branch December 16, 2024 14:23
kodiakhq bot pushed a commit that referenced this pull request Dec 16, 2024
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