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(work-accident-notification): fixing duplicate message ids #16935

Merged
merged 1 commit into from
Nov 19, 2024

Conversation

sigruntg
Copy link
Member

@sigruntg sigruntg commented Nov 19, 2024

Fixing duplicate message ids

Attach a link to issue if relevant

What

Specify what you're trying to achieve

Why

Specify why you need to achieve this

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

    • Updated message identifiers for improved clarity in the employee, information, and overview sections.
    • Enhanced semantic accuracy for messages related to employment, workday start, and accident details.
  • Bug Fixes

    • Corrected message IDs to reflect their intended context, ensuring accurate display and access throughout the application.

@sigruntg sigruntg added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Nov 19, 2024
@sigruntg sigruntg requested a review from a team as a code owner November 19, 2024 11:19
Copy link
Contributor

coderabbitai bot commented Nov 19, 2024

Walkthrough

The pull request introduces updates to message identifiers across three files related to employee, information, and overview messages. Specifically, it modifies the id properties of various message definitions to enhance semantic clarity and ensure accurate representation of their contexts. The changes do not affect the overall structure or functionality of the objects involved.

Changes

File Change Summary
libs/application/templates/aosh/work-accident-notification/src/lib/messages/employee.ts Updated message IDs for employmentRate and startOfWorkdayDate to improve clarity.
libs/application/templates/aosh/work-accident-notification/src/lib/messages/information.ts Changed pageTitle ID from company context to general context.
libs/application/templates/aosh/work-accident-notification/src/lib/messages/overview.ts Updated multiple message IDs in the labels section for improved specificity regarding their content.

Possibly related PRs

  • fix(work-accident-notification): alert message #16925: This PR modifies the employee messages in the employee.ts file, including updates to existing message definitions and the addition of a new alert message, which directly relates to the changes made in the main PR that also involves modifications to the employee object in the same file.

Suggested reviewers

  • Ballioli

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 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 Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.45%. Comparing base (01c8d4d) to head (55077cf).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #16935   +/-   ##
=======================================
  Coverage   36.45%   36.45%           
=======================================
  Files        6903     6903           
  Lines      144598   144598           
  Branches    41288    41288           
=======================================
  Hits        52720    52720           
  Misses      91878    91878           
Flag Coverage Δ
air-discount-scheme-web 0.00% <ø> (ø)
api 3.34% <ø> (ø)
application-api-files 62.35% <ø> (ø)
application-core 71.06% <ø> (ø)
application-system-api 41.02% <ø> (ø)
application-template-api-modules 27.72% <ø> (ø)
application-templates-accident-notification 28.98% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 25.87% <ø> (ø)
application-templates-driving-license 18.14% <ø> (ø)
application-templates-estate 12.14% <ø> (ø)
application-templates-example-payment 24.80% <ø> (ø)
application-templates-financial-aid 15.48% <ø> (ø)
application-templates-general-petition 23.07% <ø> (ø)
application-templates-inheritance-report 6.52% <ø> (ø)
application-templates-marriage-conditions 15.04% <ø> (ø)
application-templates-mortgage-certificate 43.36% <ø> (ø)
application-templates-parental-leave 29.74% <ø> (-0.12%) ⬇️
application-types 6.60% <ø> (ø)
application-ui-components 1.27% <ø> (ø)
application-ui-shell 20.82% <ø> (ø)
clients-charge-fjs-v2 24.11% <ø> (ø)
judicial-system-web 27.16% <ø> (ø)
services-endorsements-api 53.21% <ø> (ø)
web 1.77% <ø> (ø)

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


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 01c8d4d...55077cf. Read the comment docs.

---- 🚨 Try these New Features:

@datadog-island-is
Copy link

Datadog Report

All test runs 401484c 🔗

23 Total Test Services: 0 Failed, 22 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.1%), 95 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-web 0 0 0 2 0 6.96s 1 no change Link
api 0 0 0 4 0 2.35s 1 no change Link
application-api-files 0 0 0 2 0 4.29s 1 no change Link
application-core 0 0 0 97 0 14.76s 1 no change Link
application-system-api 0 0 0 112 2 3m 20.26s 1 no change Link
application-template-api-modules 0 0 0 116 0 2m 1.07s 1 no change Link
application-templates-accident-notification 0 0 0 148 0 15.44s 1 no change Link
application-templates-criminal-record 0 0 0 2 0 10.14s 1 no change Link
application-templates-driving-license 0 0 0 13 0 15.73s 1 no change Link
application-templates-example-payment 0 0 0 2 0 11.66s 1 no change Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • application-templates-parental-leave - jest 34.9% (-0.1%) - Details

@kodiakhq kodiakhq bot merged commit 53378fd into main Nov 19, 2024
105 of 114 checks passed
@kodiakhq kodiakhq bot deleted the fix/work-accident-duplicate-message-id branch November 19, 2024 11:32
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: 3

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 01c8d4d and 55077cf.

📒 Files selected for processing (3)
  • libs/application/templates/aosh/work-accident-notification/src/lib/messages/employee.ts (2 hunks)
  • libs/application/templates/aosh/work-accident-notification/src/lib/messages/information.ts (1 hunks)
  • libs/application/templates/aosh/work-accident-notification/src/lib/messages/overview.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
libs/application/templates/aosh/work-accident-notification/src/lib/messages/employee.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."
libs/application/templates/aosh/work-accident-notification/src/lib/messages/information.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."
libs/application/templates/aosh/work-accident-notification/src/lib/messages/overview.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 (4)
libs/application/templates/aosh/work-accident-notification/src/lib/messages/employee.ts (1)

82-82: Verify usage of the updated message ID aosh.wan.application:employee.startOfWorkdayDate

The ID change from time to startOfWorkdayDate provides better semantic clarity for the workday start date context.

Let's verify that all usages of this message ID have been updated:

libs/application/templates/aosh/work-accident-notification/src/lib/messages/information.ts (1)

17-20: Potential duplicate message definitions

There appear to be two message definitions with the same defaultMessage: 'Tilkynningaraðili':

  1. information.general.pageTitle
  2. information.labels.company.pageTitle

This could lead to maintenance issues and confusion. Consider:

  1. Using different messages if they serve different purposes
  2. Consolidating them if they serve the same purpose

Also applies to: 28-32

libs/application/templates/aosh/work-accident-notification/src/lib/messages/overview.ts (2)

50-82: LGTM! The message ID changes fix the duplicate ID issue.

The changes correctly resolve the duplicate message IDs by giving each field its own unique identifier that matches its content.


Line range hint 1-1: Verify message ID uniqueness across the codebase.

Let's ensure there are no remaining duplicate message IDs in other files.

@@ -69,7 +69,7 @@ export const employee = {
description: 'Employment time in the same job',
},
employmentRate: {
id: 'aosh.wan.application:employee.employmentTime',
id: 'aosh.wan.application:employee.employmentRate',
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Update required: Inconsistent message ID usage found

The verification revealed an inconsistency in the codebase:

  • libs/application/templates/aosh/work-accident-notification/src/forms/WorkAccidentNotificationForm/EmployeeSection/employee.ts is still using the old field name employmentTime while the message ID has been updated to employmentRate
  • This mismatch needs to be fixed to maintain consistency between the message definitions and their usage
🔗 Analysis chain

Verify usage of the updated message ID aosh.wan.application:employee.employmentRate

The ID change from employmentTime to employmentRate better reflects the message's purpose for employment rate percentage.

Let's verify that all usages of this message ID have been updated:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining references to the old message ID
rg "aosh\.wan\.application:employee\.employmentTime"

# Search for references to the new message ID to ensure it's being used
rg "aosh\.wan\.application:employee\.employmentRate"

Length of output: 630


Script:

#!/bin/bash
# Search for any remaining references to the old message ID (employmentTime)
rg "aosh\.wan\.application:employee\.employmentTime" || echo "No matches found for old ID (employmentTime)"

# Search for references to the new message ID (employmentRate)
rg "aosh\.wan\.application:employee\.employmentRate" || echo "No matches found for new ID (employmentRate)"

# Search for files that might be using these message IDs
fd -e ts -e tsx -e js -e jsx | xargs grep -l "employee\." || echo "No files found with employee messages"

Length of output: 2223


Script:

#!/bin/bash
# Let's check the content of files that might be using these message IDs
rg -A 2 -B 2 "employmentTime|employmentRate" libs/application/templates/aosh/work-accident-notification/src/forms/WorkAccidentNotificationForm/EmployeeSection/employee.ts libs/application/templates/aosh/work-accident-notification/src/fields/Overview/index.tsx libs/application/templates/aosh/work-accident-notification/src/fields/PdfOverview/pdfDocument.tsx

Length of output: 2280

Comment on lines +17 to 20
id: 'aosh.wan.application:information.general.pageTitle',
defaultMessage: 'Tilkynningaraðili',
description: 'Title of company information section',
},
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Update description to match the general context

The message ID has been moved from 'company' to 'general' context, but the description still references "company information section". This mismatch could cause confusion for other developers.

  pageTitle: {
    id: 'aosh.wan.application:information.general.pageTitle',
    defaultMessage: 'Tilkynningaraðili',
-   description: 'Title of company information section',
+   description: 'Title of general information section',
  },
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
id: 'aosh.wan.application:information.general.pageTitle',
defaultMessage: 'Tilkynningaraðili',
description: 'Title of company information section',
},
id: 'aosh.wan.application:information.general.pageTitle',
defaultMessage: 'Tilkynningaraðili',
description: 'Title of general information section',
},

Comment on lines +50 to 82
id: 'aosh.wan.application:overview.labels.didAoshCome',
defaultMessage: 'Kom Vinnueftirlitið?',
description: 'Date and time label',
},
didPoliceCome: {
id: 'aosh.wan.application:overview.labels.dateAndTime',
id: 'aosh.wan.application:overview.labels.didPoliceCome',
defaultMessage: 'Kom Lögreglan?',
description: 'Date and time label',
},
injuredAmount: {
id: 'aosh.wan.application:overview.labels.dateAndTime',
id: 'aosh.wan.application:overview.labels.injuredAmount',
defaultMessage: 'Fjöldi slasaðra',
description: 'Date and time label',
},
municipality: {
id: 'aosh.wan.application:overview.labels.dateAndTime',
id: 'aosh.wan.application:overview.labels.municipality',
defaultMessage: 'Sveitarfélag þar sem slysið átti sér stað',
description: 'Date and time label',
},
exactLocation: {
id: 'aosh.wan.application:overview.labels.dateAndTime',
id: 'aosh.wan.application:overview.labels.exactLocation',
defaultMessage: 'Nákvæm staðsetning slyssins',
description: 'Date and time label',
},
accidentDescription: {
id: 'aosh.wan.application:overview.labels.dateAndTime',
id: 'aosh.wan.application:overview.labels.accidentDescription',
defaultMessage: 'Tildrög slyssins',
description: 'Date and time label',
},
locationOfAccident: {
id: 'aosh.wan.application:overview.labels.dateAndTime',
id: 'aosh.wan.application:overview.labels.locationOfAccident',
defaultMessage: 'Vettvangur slyssins',
description: 'Date and time label',
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Update the description fields to match their respective messages.

The description field for several messages still incorrectly states "Date and time label". Each description should accurately reflect its corresponding message content.

Apply this diff to fix the descriptions:

     didAoshCome: {
       id: 'aosh.wan.application:overview.labels.didAoshCome',
       defaultMessage: 'Kom Vinnueftirlitið?',
-      description: 'Date and time label',
+      description: 'Label for whether AOSH came to the accident site',
     },
     didPoliceCome: {
       id: 'aosh.wan.application:overview.labels.didPoliceCome',
       defaultMessage: 'Kom Lögreglan?',
-      description: 'Date and time label',
+      description: 'Label for whether police came to the accident site',
     },
     injuredAmount: {
       id: 'aosh.wan.application:overview.labels.injuredAmount',
       defaultMessage: 'Fjöldi slasaðra',
-      description: 'Date and time label',
+      description: 'Label for number of injured people',
     },
     municipality: {
       id: 'aosh.wan.application:overview.labels.municipality',
       defaultMessage: 'Sveitarfélag þar sem slysið átti sér stað',
-      description: 'Date and time label',
+      description: 'Label for municipality where accident occurred',
     },
     exactLocation: {
       id: 'aosh.wan.application:overview.labels.exactLocation',
       defaultMessage: 'Nákvæm staðsetning slyssins',
-      description: 'Date and time label',
+      description: 'Label for exact location of accident',
     },
     accidentDescription: {
       id: 'aosh.wan.application:overview.labels.accidentDescription',
       defaultMessage: 'Tildrög slyssins',
-      description: 'Date and time label',
+      description: 'Label for accident description',
     },
     locationOfAccident: {
       id: 'aosh.wan.application:overview.labels.locationOfAccident',
       defaultMessage: 'Vettvangur slyssins',
-      description: 'Date and time label',
+      description: 'Label for accident location type',
     },
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
id: 'aosh.wan.application:overview.labels.didAoshCome',
defaultMessage: 'Kom Vinnueftirlitið?',
description: 'Date and time label',
},
didPoliceCome: {
id: 'aosh.wan.application:overview.labels.dateAndTime',
id: 'aosh.wan.application:overview.labels.didPoliceCome',
defaultMessage: 'Kom Lögreglan?',
description: 'Date and time label',
},
injuredAmount: {
id: 'aosh.wan.application:overview.labels.dateAndTime',
id: 'aosh.wan.application:overview.labels.injuredAmount',
defaultMessage: 'Fjöldi slasaðra',
description: 'Date and time label',
},
municipality: {
id: 'aosh.wan.application:overview.labels.dateAndTime',
id: 'aosh.wan.application:overview.labels.municipality',
defaultMessage: 'Sveitarfélag þar sem slysið átti sér stað',
description: 'Date and time label',
},
exactLocation: {
id: 'aosh.wan.application:overview.labels.dateAndTime',
id: 'aosh.wan.application:overview.labels.exactLocation',
defaultMessage: 'Nákvæm staðsetning slyssins',
description: 'Date and time label',
},
accidentDescription: {
id: 'aosh.wan.application:overview.labels.dateAndTime',
id: 'aosh.wan.application:overview.labels.accidentDescription',
defaultMessage: 'Tildrög slyssins',
description: 'Date and time label',
},
locationOfAccident: {
id: 'aosh.wan.application:overview.labels.dateAndTime',
id: 'aosh.wan.application:overview.labels.locationOfAccident',
defaultMessage: 'Vettvangur slyssins',
description: 'Date and time label',
id: 'aosh.wan.application:overview.labels.didAoshCome',
defaultMessage: 'Kom Vinnueftirlitið?',
description: 'Label for whether AOSH came to the accident site',
},
didPoliceCome: {
id: 'aosh.wan.application:overview.labels.didPoliceCome',
defaultMessage: 'Kom Lögreglan?',
description: 'Label for whether police came to the accident site',
},
injuredAmount: {
id: 'aosh.wan.application:overview.labels.injuredAmount',
defaultMessage: 'Fjöldi slasaðra',
description: 'Label for number of injured people',
},
municipality: {
id: 'aosh.wan.application:overview.labels.municipality',
defaultMessage: 'Sveitarfélag þar sem slysið átti sér stað',
description: 'Label for municipality where accident occurred',
},
exactLocation: {
id: 'aosh.wan.application:overview.labels.exactLocation',
defaultMessage: 'Nákvæm staðsetning slyssins',
description: 'Label for exact location of accident',
},
accidentDescription: {
id: 'aosh.wan.application:overview.labels.accidentDescription',
defaultMessage: 'Tildrög slyssins',
description: 'Label for accident description',
},
locationOfAccident: {
id: 'aosh.wan.application:overview.labels.locationOfAccident',
defaultMessage: 'Vettvangur slyssins',
description: 'Label for accident location type',

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated:automerge (Disabled) Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants