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): Actor to draft #16356

Merged
merged 3 commits into from
Oct 10, 2024
Merged

Conversation

thordurhhh
Copy link
Member

@thordurhhh thordurhhh commented Oct 10, 2024

What

If user is in delegation, use actor. Else use user.

Why

We want the names attached to drafts. Not the ministry they are representing.

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 author assignment in the draft regulation creation process to accommodate user delegation.
    • Improved retrieval of DraftRegulations with more specific logging for non-managers.
    • Enhanced detail in the regulation retrieval process, including law chapters and impacts.
    • Updated visual representation of the propose action button for better user experience.
  • Bug Fixes

    • Refined logic for handling impacts, ensuring accurate grouping and sorting by date.

@thordurhhh thordurhhh added the automerge Merge this PR as soon as all checks pass label Oct 10, 2024
@thordurhhh thordurhhh requested a review from a team as a code owner October 10, 2024 14:24
Copy link
Contributor

coderabbitai bot commented Oct 10, 2024

Walkthrough

The changes in this pull request focus on the DraftRegulationService class within the draft_regulation.service.ts file. Key modifications include the addition of a new import, MinistrySlug, and updates to the create, getAll, and findById methods. The create method now determines the creator's national ID based on user delegation status, while logging in getAll has been clarified. The findById method has been improved to better structure the gathering of law chapters and impacts, maintaining the sorting of impacts by date.

Changes

File Change Summary
apps/services/regulations-admin-backend/src/app/modules/draft_regulation/draft_regulation.service.ts - Added import for MinistrySlug.
- Updated create method to determine creator's national ID based on delegation.
- Refined logging in getAll to specify retrieval of non-shipped DraftRegulations.
- Enhanced findById method to improve gathering and structuring of law chapters and impacts.
libs/portals/admin/regulations-admin/src/components/SaveDeleteButtons.tsx - Changed variant prop of the Button component for the propose action from "text" to "utility".

Possibly related PRs

Suggested reviewers

  • sigruntg
  • Herdismaria

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0849ac1 and 9febe76.

📒 Files selected for processing (1)
  • libs/portals/admin/regulations-admin/src/components/SaveDeleteButtons.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/portals/admin/regulations-admin/src/components/SaveDeleteButtons.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/portals/admin/regulations-admin/src/components/SaveDeleteButtons.tsx (2)

51-51: LGTM: Button variant change improves consistency

The change from variant="text" to variant="utility" for the "propose" button aligns its style with other utility buttons in the component, enhancing visual consistency. This modification adheres to the component's design principles and maintains its reusability across different NextJS apps.


Line range hint 1-95: File adheres to coding guidelines for libs//* pattern**

This component demonstrates good practices for reusable components in NextJS apps:

  1. It uses TypeScript for prop definitions (SaveDeleteButtonsProps).
  2. The component is designed for flexibility and reuse across different contexts.
  3. The code structure supports effective tree-shaking and bundling.

These practices align well with the coding guidelines for files in the libs directory.


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
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/services/regulations-admin-backend/src/app/modules/draft_regulation/draft_regulation.service.ts (1)

258-263: Address the TODO Regarding Ministry Information

There is a comment indicating that if the user is in delegation from a valid ministry, the ministry should be added to the creation data. Please confirm if this needs to be implemented.

Would you like assistance in implementing this requirement or opening a new GitHub issue to track this task?

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between df4b50b and 0849ac1.

📒 Files selected for processing (1)
  • apps/services/regulations-admin-backend/src/app/modules/draft_regulation/draft_regulation.service.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/services/regulations-admin-backend/src/app/modules/draft_regulation/draft_regulation.service.ts (2)

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

  • NestJS architecture, including modules, services, and controllers.
  • Dependency injection patterns and service encapsulation.
  • Integration and unit testing coverage and practices."

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/services/regulations-admin-backend/src/app/modules/draft_regulation/draft_regulation.service.ts (2)

31-31: Import Statement Updated Appropriately

The addition of MinistrySlug to the imports ensures that all necessary types are available.


271-271: Authors Field Now Reflects the Creator's National ID

The authors field is correctly set to include the creatorNationalId, ensuring that the author information is accurate.

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 (2)
apps/services/regulations-admin-backend/src/app/modules/draft_regulation/draft_regulation.service.ts (2)

262-262: Address the TODO about adding ministry information

There's a comment indicating that if the user is in delegation from a valid ministry, the ministry should be added to the creation data. Consider implementing this functionality or removing the comment if it's no longer needed.

Do you want me to help implement this functionality or open a GitHub issue to track this task?


258-271: Add unit tests for the new delegation logic in the 'create' method

The changes in the create method introduce new logic based on the user's delegation status. Please ensure that this new functionality is covered by unit tests to verify correct behavior under different scenarios (e.g., when user.actor is defined or not).

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between df4b50b and 0849ac1.

📒 Files selected for processing (1)
  • apps/services/regulations-admin-backend/src/app/modules/draft_regulation/draft_regulation.service.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/services/regulations-admin-backend/src/app/modules/draft_regulation/draft_regulation.service.ts (2)

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

  • NestJS architecture, including modules, services, and controllers.
  • Dependency injection patterns and service encapsulation.
  • Integration and unit testing coverage and practices."

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."

Copy link

codecov bot commented Oct 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.74%. Comparing base (dddbfb4) to head (9febe76).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #16356   +/-   ##
=======================================
  Coverage   36.73%   36.74%           
=======================================
  Files        6804     6804           
  Lines      140861   140766   -95     
  Branches    40118    40042   -76     
=======================================
- Hits        51751    51718   -33     
+ Misses      89110    89048   -62     
Flag Coverage Δ
api 3.37% <ø> (ø)
download-service 44.20% <ø> (ø)
judicial-system-web 27.94% <ø> (ø)
portals-admin-regulations-admin 1.85% <ø> (ø)

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

Files with missing lines Coverage Δ
...lations-admin/src/components/SaveDeleteButtons.tsx 0.00% <ø> (ø)

... and 12 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 dddbfb4...9febe76. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Oct 10, 2024

Datadog Report

All test runs 0c28025 🔗

4 Total Test Services: 0 Failed, 4 Passed
➡️ Test Sessions change in coverage: 8 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 3.15s 1 no change Link
download-service 0 0 0 1 0 21.77s 1 no change Link
judicial-system-web 0 0 0 338 0 1m 15.23s 1 no change Link
portals-admin-regulations-admin 0 0 0 24 0 15.97s 1 no change Link

Copy link
Member

@thorkellmani thorkellmani left a comment

Choose a reason for hiding this comment

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

lgtm

@kodiakhq kodiakhq bot merged commit 8e82475 into main Oct 10, 2024
40 checks passed
@kodiakhq kodiakhq bot deleted the regulations-admin/actor-to-draft branch October 10, 2024 17:03
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