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(regulations-admin): Format ministry name #16822

Merged
merged 2 commits into from
Nov 13, 2024

Conversation

thordurhhh
Copy link
Member

@thordurhhh thordurhhh commented Nov 12, 2024

What

Fjármálaráðuneyti ➡️ Fjármálaráðuneytinu

Why

Ministry. þgf með greini.

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 function to update the ministry name in draft regulation PDFs, enhancing the accuracy of ministry representation.
  • Bug Fixes
    • Improved handling of the ministry name to ensure proper suffix replacement when generating draft regulation PDFs.

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

coderabbitai bot commented Nov 12, 2024

Walkthrough

The changes introduce a new function, updateMinistryName, within the RegulationDocumentsController class. This function modifies the ministry property of the draftRegulation object based on the provided ministryRaw parameter. If the parameter is absent, it returns undefined. If ministryRaw ends with 'ráðuneyti', it replaces this suffix with 'ráðuneytinu' and assigns the result to draftMinistry. The RegulationPdfInput object is then updated to use this modified draftMinistry. The control flow and error handling for the draft regulation retrieval and PDF generation remain unchanged.

Changes

File Change Summary
apps/download-service/src/app/modules/regulation-documents/regulation-documents.controller.ts Added function `updateMinistryName(ministryRaw?: string): string

Possibly related PRs

Suggested reviewers

  • thorkellmani
  • Rikkiabb

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 12, 2024

Codecov Report

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

Project coverage is 36.44%. Comparing base (0e05570) to head (1325bb0).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
...ation-documents/regulation-documents.controller.ts 0.00% 9 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #16822   +/-   ##
=======================================
  Coverage   36.44%   36.44%           
=======================================
  Files        6852     6852           
  Lines      143515   143429   -86     
  Branches    40959    40911   -48     
=======================================
- Hits        52300    52275   -25     
+ Misses      91215    91154   -61     
Flag Coverage Δ
download-service 44.13% <0.00%> (-0.11%) ⬇️

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

Files with missing lines Coverage Δ
...ation-documents/regulation-documents.controller.ts 30.00% <0.00%> (-8.71%) ⬇️

... and 14 files 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 a35f443...1325bb0. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Nov 12, 2024

Datadog Report

Branch report: regulations/draft-ministry-format
Commit report: 77a5f3e
Test service: download-service

✅ 0 Failed, 1 Passed, 0 Skipped, 19.48s Total Time
🔻 Test Sessions change in coverage: 1 decreased (-0.03%)

🔻 Code Coverage Decreases vs Default Branch (1)

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

🧹 Outside diff range and nitpick comments (1)
apps/download-service/src/app/modules/regulation-documents/regulation-documents.controller.ts (1)

72-81: Consider adding debug logging for ministry name transformation

The transformation looks correct, but adding debug logging would help track any unexpected ministry name formats.

+    console.debug(
+      `Transforming ministry name from "${draftRegulation.ministry}" to "${draftMinistry}"`,
+    )
     const input: RegulationPdfInput = {
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a89215d and fbde262.

📒 Files selected for processing (1)
  • apps/download-service/src/app/modules/regulation-documents/regulation-documents.controller.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/download-service/src/app/modules/regulation-documents/regulation-documents.controller.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."
🔇 Additional comments (1)
apps/download-service/src/app/modules/regulation-documents/regulation-documents.controller.ts (1)

58-81: Verify transformation for all ministry names in the codebase

Let's ensure this transformation works correctly for all ministry names used in the system.

✅ Verification successful

Transformation correctly applied to all ministry names

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other ministry name occurrences to verify the transformation will work
# Look for strings ending in 'ráðuneyti' in TypeScript/JavaScript files

echo "Searching for ministry names in the codebase:"
rg -t ts -t js "\\w+ráðuneyti" --no-filename | sort -u

echo -e "\nSearching for existing transformed names (should be 'ráðuneytinu'):"
rg -t ts -t js "\\w+ráðuneytinu" --no-filename | sort -u

Length of output: 39757

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

🧹 Outside diff range and nitpick comments (1)
apps/download-service/src/app/modules/regulation-documents/regulation-documents.controller.ts (1)

58-70: Consider extracting and enhancing the ministry name formatter.

While the function correctly handles the suffix replacement, consider these improvements for better maintainability and type safety:

  1. Extract the function outside the getDraftRegulationPdf method
  2. Add input validation for empty strings
  3. Define the suffixes as typed constants

Here's a suggested implementation:

const MINISTRY_SUFFIXES = {
  OLD: 'ráðuneyti',
  NEW: 'ráðuneytinu'
} as const;

function formatMinistryName(ministryRaw?: string): string | undefined {
  if (!ministryRaw?.trim()) {
    return undefined;
  }

  return ministryRaw.endsWith(MINISTRY_SUFFIXES.OLD)
    ? ministryRaw.slice(0, -MINISTRY_SUFFIXES.OLD.length) + MINISTRY_SUFFIXES.NEW
    : ministryRaw;
}
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a89215d and fbde262.

📒 Files selected for processing (1)
  • apps/download-service/src/app/modules/regulation-documents/regulation-documents.controller.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/download-service/src/app/modules/regulation-documents/regulation-documents.controller.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."
🔇 Additional comments (2)
apps/download-service/src/app/modules/regulation-documents/regulation-documents.controller.ts (2)

72-81: LGTM! Clean integration of the ministry name formatting.

The changes correctly integrate the ministry name transformation into the PDF generation flow while maintaining the existing error handling.


58-81: Verify comprehensive testing of ministry name formatting.

The implementation correctly handles the specific case of "Fjármálaráðuneyti" → "Fjármálaráðuneytinu". Let's verify other ministry names in the codebase.

Copy link
Member

@jonbjarnio jonbjarnio left a comment

Choose a reason for hiding this comment

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

🚀

@kodiakhq kodiakhq bot merged commit 8e604b7 into main Nov 13, 2024
31 checks passed
@kodiakhq kodiakhq bot deleted the regulations/draft-ministry-format branch November 13, 2024 11:48
jonnigs pushed a commit that referenced this pull request Nov 26, 2024
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
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