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

Bugfix/email security object absence #12

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

lacarmen
Copy link

@lacarmen lacarmen commented Feb 26, 2025

Summary by Sourcery

Bug Fixes:

  • Fixes a bug where email notes were displayed even when the email security object was absent.

Copy link

sourcery-ai bot commented Feb 26, 2025

Reviewer's Guide by Sourcery

This pull request introduces a check for the existence of a security object named _email before rendering email-related features. It adds a method to retrieve security objects by name and uses this method to conditionally render email notes in ChartNotesAjax.jsp and add hidden email properties in efmformadd_data.jsp and efmshowform_data.jsp. This ensures that email functionalities are only available if the corresponding security object is present.

Sequence diagram for rendering email notes in ChartNotesAjax.jsp

sequenceDiagram
    participant JSP as ChartNotesAjax.jsp
    participant EmailComposeManager
    participant SecurityInfoManager
    participant SecObjectNameDao

    JSP->>EmailComposeManager: isEmailSecurityObjectAvailable()
    EmailComposeManager->>SecurityInfoManager: getSecurityObject("_email")
    SecurityInfoManager->>SecObjectNameDao: find("_email")
    SecObjectNameDao-->>SecurityInfoManager: SecObjectName or null
    SecurityInfoManager-->>EmailComposeManager: Optional<SecObjectName>
    EmailComposeManager-->>JSP: boolean (isPresent())
    alt isPresent() == true
        JSP->>JSP: Render email note
    else isPresent() == false
        JSP->>JSP: Skip rendering email note
    end
Loading

Sequence diagram for adding hidden email properties in eform pages

sequenceDiagram
    participant JSP as eform page (efmformadd_data.jsp or efmshowform_data.jsp)
    participant EmailComposeManager
    participant SecurityInfoManager
    participant SecObjectNameDao

    JSP->>EmailComposeManager: isEmailSecurityObjectAvailable()
    EmailComposeManager->>SecurityInfoManager: getSecurityObject("_email")
    SecurityInfoManager->>SecObjectNameDao: find("_email")
    SecObjectNameDao-->>SecurityInfoManager: SecObjectName or null
    SecurityInfoManager-->>EmailComposeManager: Optional<SecObjectName>
    EmailComposeManager-->>JSP: boolean (isPresent())
    alt isPresent() == true
        JSP->>EmailComposeManager: hasValidRecipient()
        JSP->>EmailComposeManager: getEmailConsentStatus()
        JSP->>JSP: Add hidden email properties
    else isPresent() == false
        JSP->>JSP: Skip adding hidden email properties
    end
Loading

File-Level Changes

Change Details Files
Added a method to retrieve security objects by name.
  • Added a method in SecurityInfoManager interface to retrieve a security object by its name.
  • Implemented the above method in SecurityInfoManagerImpl to fetch SecObjectName from the database using SecObjectNameDao.
src/main/java/org/oscarehr/managers/SecurityInfoManager.java
src/main/java/org/oscarehr/managers/SecurityInfoManagerImpl.java
Implemented a method to check the existence of the email security object.
  • Added a method isEmailSecurityObjectAvailable in EmailComposeManager to check if the security object with name _email exists.
src/main/java/org/oscarehr/managers/EmailComposeManager.java
Conditionally render email-related features based on the existence of the email security object.
  • In ChartNotesAjax.jsp, the rendering of email notes is now conditional on the existence of the _email security object.
  • In efmformadd_data.jsp and efmshowform_data.jsp, the addition of hidden email properties is now conditional on the existence of the _email security object.
src/main/webapp/casemgmt/ChartNotesAjax.jsp
src/main/webapp/eform/efmformadd_data.jsp
src/main/webapp/eform/efmshowform_data.jsp

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @lacarmen - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider consolidating the isEmailSecurityObjectAvailable checks into a single utility method to avoid repetition.
  • The getSecurityObject method in SecurityInfoManagerImpl could be simplified to directly return Optional.ofNullable(secObjectNameDao.find(objectName)).
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@D3V41 D3V41 force-pushed the bugfix/email-security-object-absence branch 2 times, most recently from 4ce686c to a36f5b8 Compare February 28, 2025 02:41
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