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

send receipt to Institution Material contribution #881

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

belwalshubham
Copy link
Collaborator

@belwalshubham belwalshubham commented Jan 27, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved data retrieval for institution relationships by explicitly selecting additional contact information.

Copy link

coderabbitai bot commented Jan 27, 2025

Walkthrough

The pull request introduces a minor modification to the getInstitutionRelationships method in the InstitutionMaterialContributionService class. The change involves adding a select statement to explicitly retrieve the contact_id_b field during a Relationship API query. This enhancement ensures more comprehensive data retrieval when fetching institution relationships based on an organization ID, without altering the method's core logic or error handling.

Changes

File Change Summary
wp-content/civi-extensions/goonjcustom/Civi/InstitutionMaterialContributionService.php Added contact_id_b to the select fields in getInstitutionRelationships method

Possibly related PRs

Poem

🔍 A line of code, so small yet bright,
contact_id_b now comes to light!
In relationships, we now can see
The hidden link, now plain as can be
Data's secret, no longer shy 🕵️‍♀️


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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@belwalshubham belwalshubham changed the title send receipt to material contribution send receipt to Institution Material contribution Jan 27, 2025
Copy link

@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 comments (1)
wp-content/civi-extensions/goonjcustom/Civi/InstitutionMaterialContributionService.php (1)

Line range hint 134-144: Add error handling for email operations.

The email sending process lacks error handling for:

  1. File operations when reading images
  2. Email sending failures
   private static function sendInstitutionMaterialContributionEmails(array $contacts, string $description, string $deliveredBy, string $deliveredByContact, string $activityDate) {
     foreach ($contacts as $contact) {
+      try {
         $email = $contact['email'];
         $name = $contact['name'];
         $phone = $contact['phone'];

         $subject = 'Acknowledgement for your material contribution to Goonj';
         $body = self::generateEmailBody($name);
         $html = self::generateContributionReceiptHtml($email, $phone, $description, $name, $deliveredBy, $deliveredByContact, $activityDate);
         $attachments = [\CRM_Utils_Mail::appendPDF('institution_material_contribution.pdf', $html)];
         $params = self::prepareEmailParams($subject, $body, $attachments, $email);

         \CRM_Utils_Mail::send($params);
+      } catch (\Exception $e) {
+        \Civi::log()->error('Failed to send material contribution email to ' . $email . ': ' . $e->getMessage());
+      }
     }
   }
🧹 Nitpick comments (2)
wp-content/civi-extensions/goonjcustom/Civi/InstitutionMaterialContributionService.php (2)

Line range hint 93-102: Consider adding error handling and type hints.

The method could benefit from:

  1. Error handling for API failures
  2. Parameter and return type hints
  3. Input validation
-  private static function getInstitutionRelationships($organizationId) {
+  /**
+   * Fetches institution POC relationships for a given organization.
+   *
+   * @param int $organizationId The ID of the organization
+   * @return array<string, array{email: string, phone: string, name: string}> Array of contacts indexed by email
+   * @throws \Civi\API\Exception\UnauthorizedException
+   */
+  private static function getInstitutionRelationships(int $organizationId): array {
     $contacts = [];
+    if ($organizationId <= 0) {
+      return $contacts;
+    }
+
+    try {
       $relationship = Relationship::get(FALSE)
         ->addSelect('contact_id_b')
         ->addWhere('contact_id_a', '=', $organizationId)
         ->addWhere('relationship_type_id:name', '=', 'Institution POC of')
         ->execute()
         ->first();
+    } catch (\Exception $e) {
+      \Civi::log()->error('Failed to fetch institution relationships: ' . $e->getMessage());
+      return $contacts;
+    }

Line range hint 1-391: Consider splitting the class to follow Single Responsibility Principle.

The class currently handles multiple concerns:

  1. Event subscription
  2. Data fetching
  3. Email generation
  4. PDF generation

Consider extracting these into separate services:

  • InstitutionRelationshipRepository for data fetching
  • MaterialContributionEmailService for email operations
  • MaterialContributionPdfGenerator for PDF generation

This would improve maintainability and testability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6786181 and 46e680a.

📒 Files selected for processing (1)
  • wp-content/civi-extensions/goonjcustom/Civi/InstitutionMaterialContributionService.php (1 hunks)
🔇 Additional comments (1)
wp-content/civi-extensions/goonjcustom/Civi/InstitutionMaterialContributionService.php (1)

94-94: LGTM! Explicit field selection improves code clarity.

The addition of explicit contact_id_b selection makes the code more maintainable by clearly indicating which fields are required.

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.

1 participant