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

chore(j-s): Update substances and combine drugs and prescribed medication lists #17689

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

thorhildurt
Copy link
Member

@thorhildurt thorhildurt commented Jan 28, 2025

Update substances and combine drugs and prescribed medication lists

What

  • Combining drugs and prescribed medication lists
  • Adding two new drugs to the substances: Brómazólam, Flúalprazólam

Why

  • To make it easier to maintain
    • often prescribed medications are categorized as drugs or some substances are both presribed medication and drugs.

Screenshots / Gifs

Screenshot 2025-01-28 at 11 21 56 Screenshot 2025-01-28 at 11 21 37

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

Release Notes

  • New Features

    • Added two new substances (Bromazolam and Flualprazolam) to the system's drug tracking and reference lists
    • Expanded substance enumeration for legal and prosecution-related documentation
  • Refactor

    • Reorganized substance type definitions and imports across multiple modules
    • Consolidated substance references for driving-related offenses
  • Documentation

    • Updated localization strings for new substances
    • Improved substance categorization for legal use cases

@thorhildurt thorhildurt requested a review from a team as a code owner January 28, 2025 11:33
Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

Walkthrough

This pull request introduces new substances (Bromazolam and Flualprazolam) to the judicial system's substance tracking and localization infrastructure. The changes involve updating multiple files across different modules to include these new substances in enumerations, type definitions, and localization strings. The modifications centralize substance management by creating a new Substance enum and consolidating substance references across different parts of the application.

Changes

File Change Summary
apps/judicial-system/web/src/routes/Prosecutor/Indictments/Indictment/IndictmentCountSubstanceEnum.strings.ts Added localization entries for Bromazolam and Flualprazolam
apps/judicial-system/web/src/routes/Prosecutor/Indictments/Indictment/Substances/SubstancesEnum.strings.ts Added new substance entries for Bromazolam and Flualprazolam
libs/judicial-system/types/src/index.ts Updated substance export source from indictmentCount to substances module
libs/judicial-system/types/src/lib/indictmentCount.ts Removed local Substance enum, imported substances from new module
libs/judicial-system/types/src/lib/substances.ts Created new Substance enum and ILLEGAL_DRUGS_AND_PRESCRIPTION_DRUGS_DRIVING constant

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • oddsson
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@thorhildurt thorhildurt force-pushed the j-s/update-substances branch from 4bff0d4 to 7802db8 Compare January 28, 2025 11:37
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/judicial-system/types/src/lib/substances.ts (1)

46-88: Consider documenting the criteria for inclusion in ILLEGAL_DRUGS_AND_PRESCRIPTION_DRUGS_DRIVING.

The constant excludes ALCOHOL from the list. It would be helpful to document why certain substances are included or excluded from this list.

+// This constant defines substances that are relevant for both illegal drugs and prescription
+// drugs driving offenses. Alcohol is handled separately as it belongs to a different category
+// of driving offenses.
 export const ILLEGAL_DRUGS_AND_PRESCRIPTION_DRUGS_DRIVING = [
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 283e591 and 7802db8.

📒 Files selected for processing (5)
  • apps/judicial-system/web/src/routes/Prosecutor/Indictments/Indictment/IndictmentCountSubstanceEnum.strings.ts (2 hunks)
  • apps/judicial-system/web/src/routes/Prosecutor/Indictments/Indictment/Substances/SubstancesEnum.strings.ts (1 hunks)
  • libs/judicial-system/types/src/index.ts (1 hunks)
  • libs/judicial-system/types/src/lib/indictmentCount.ts (1 hunks)
  • libs/judicial-system/types/src/lib/substances.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (5)
libs/judicial-system/types/src/lib/substances.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."
apps/judicial-system/web/src/routes/Prosecutor/Indictments/Indictment/IndictmentCountSubstanceEnum.strings.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."
libs/judicial-system/types/src/index.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/judicial-system/types/src/lib/indictmentCount.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."
apps/judicial-system/web/src/routes/Prosecutor/Indictments/Indictment/Substances/SubstancesEnum.strings.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."
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: tests (judicial-system-backend)
🔇 Additional comments (7)
libs/judicial-system/types/src/lib/indictmentCount.ts (2)

1-4: LGTM! Clean import structure.

The imports are well-organized and properly scoped.


20-23: Verify the implications of using the same list for both illegal and prescription drugs.

Using ILLEGAL_DRUGS_AND_PRESCRIPTION_DRUGS_DRIVING for both offense types might need validation to ensure this aligns with legal requirements.

✅ Verification successful

Shared substance list is appropriate and legally sound

The use of a single comprehensive list (ILLEGAL_DRUGS_AND_PRESCRIPTION_DRUGS_DRIVING) is correct because many substances can be either legal or illegal depending on prescription context. The legal distinction is properly maintained through separate offense types (ILLEGAL_DRUGS_DRIVING vs PRESCRIPTION_DRUGS_DRIVING), each with its own UI labels and incident descriptions.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if there are any existing distinctions between illegal and prescription drugs in the codebase

# Search for any existing classifications or distinctions
rg -i "illegal.*drugs|prescription.*drugs" --type ts

Length of output: 7184


Script:

#!/bin/bash
# Check the contents of the substances list
cat libs/judicial-system/types/src/lib/substances.ts

Length of output: 2443

libs/judicial-system/types/src/lib/substances.ts (1)

1-44: LGTM! Well-structured enum definition.

The Substance enum is comprehensive and maintains alphabetical ordering, making it easy to maintain.

libs/judicial-system/types/src/index.ts (1)

124-124: LGTM! Clean export restructuring.

The Substance export is properly moved to align with the new organization of substance management.

apps/judicial-system/web/src/routes/Prosecutor/Indictments/Indictment/Substances/SubstancesEnum.strings.ts (1)

22-33: LGTM! Consistent localization implementation.

The new substance entries (FLUALPRAZOLAM and BROMAZOLAM) follow the established pattern and maintain proper Icelandic character usage in their default messages.

apps/judicial-system/web/src/routes/Prosecutor/Indictments/Indictment/IndictmentCountSubstanceEnum.strings.ts (2)

84-88: LGTM! New substance entry follows established patterns.

The BROMAZOLAM entry maintains consistency with existing entries in terms of:

  • ID format
  • Message structure with {amount} placeholder
  • Unit specification (ng/ml)
  • Icelandic localization

119-123: LGTM! New substance entry follows established patterns.

The FLUALPRAZOLAM entry maintains consistency with existing entries in terms of:

  • ID format
  • Message structure with {amount} placeholder
  • Unit specification (ng/ml)
  • Icelandic localization

@thorhildurt thorhildurt marked this pull request as draft January 29, 2025 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants