Skip to content

Fix(*) Followup cron contact not found #486

Merged
nishant22029 merged 1 commit intodevelopfrom
fix/followup-cron
Nov 22, 2024
Merged

Fix(*) Followup cron contact not found #486
nishant22029 merged 1 commit intodevelopfrom
fix/followup-cron

Conversation

@nishant22029
Copy link
Copy Markdown
Collaborator

@nishant22029 nishant22029 commented Nov 22, 2024

Summary by CodeRabbit

  • New Features

    • Improved logging for induction activities and email notifications.
    • Enhanced error handling for reminder email sending.
  • Bug Fixes

    • Corrected variable reference in email activity handling to ensure accurate contact ID usage.

@nishant22029 nishant22029 self-assigned this Nov 22, 2024
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Nov 22, 2024

Walkthrough

The pull request introduces modifications to the InductionService class in the Civi namespace, focusing on induction activities and email notifications. Key changes include the addition of logging statements in the sendInductionRescheduleEmail method for unscheduled and not visited induction activities. The handleRescheduleEmailActivity method was updated to use the correct contact ID, and the sendRemainderEmails method now includes error handling for reminder emails. These changes enhance logging and error management related to induction activities and email notifications.

Changes

File Path Change Summary
wp-content/civi-extensions/goonjcustom/Civi/InductionService.php - Updated method signatures for handleRescheduleEmailActivity, sendInductionRescheduleEmail, and sendRemainderEmails.
- Added logging for unscheduled and not visited induction activities.
- Corrected variable in addWhere clause to use $contactId.
- Enhanced error handling in sendRemainderEmails method.

Possibly related PRs

Suggested reviewers

  • tarunnjoshi

🌟 In the realm of code where changes flow,
The InductionService shines with a new glow.
With logs for the unscheduled, and errors now caught,
Email handling's improved, and clarity sought.
So here's to the updates, both clever and bright,
Making induction a breeze, oh what a delight! 🎉


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.

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.

Copy link
Copy Markdown

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

Line range hint 1-900: Consider refactoring email sending logic to reduce duplication

The class contains multiple methods with similar email sending patterns (sendInductionEmail, sendFollowUpEmails, sendInductionRescheduleEmail, sendRemainderEmails). This leads to code duplication and potential maintenance issues.

Consider extracting the common email sending logic into a reusable private method:

+ private static function sendTemplatedEmail($contactId, $templatePattern, $customFieldToUpdate = null) {
+     $template = MessageTemplate::get(FALSE)
+         ->addSelect('id', 'msg_subject')
+         ->addWhere('msg_title', 'LIKE', $templatePattern)
+         ->execute()->single();
+
+     if (!$template) {
+         throw new \Exception("Email template not found: $templatePattern");
+     }
+
+     $emailParams = [
+         'contact_id' => $contactId,
+         'template_id' => $template['id'],
+     ];
+
+     $result = civicrm_api3('Email', 'send', $emailParams);
+
+     if ($customFieldToUpdate) {
+         Contact::update(FALSE)
+             ->addValue($customFieldToUpdate, 1)
+             ->addWhere('id', '=', $contactId)
+             ->execute();
+     }
+
+     return $result;
+ }

This would simplify the email sending methods and make the code more maintainable.


Line range hint 513-538: Consider using early returns to reduce nesting

The nested if conditions in the email sending logic make the code harder to follow. Consider using early returns to flatten the structure.

Example refactor:

- if (empty($isMailSent)) {
-     $emailParams = [
-         'contact_id' => $activity['source_contact_id'],
-         'template_id' => $template['id'],
-     ];
-     // ... more nested code
- }
+ if (!empty($isMailSent)) {
+     return;
+ }
+ 
+ $emailParams = [
+     'contact_id' => $activity['source_contact_id'],
+     'template_id' => $template['id'],
+ ];
+ // ... rest of the code at the same level

Line range hint 1-900: Consider implementing retry mechanism for email sending

The email sending operations could fail due to various reasons (network issues, server problems, etc.). Consider implementing a retry mechanism with exponential backoff.


Error handling inconsistency found in email sending operations

The codebase shows inconsistent error handling for email operations:

  • processQueuedInductionEmail() has proper try-catch with error logging
  • sendInductionEmailToVolunteer() and createInductionForTransitionedVolunteer() lack error handling
  • sendFollowUpEmails() performs email operations without error handling
  • sendInductionRescheduleEmail() lacks error handling for the email sending operation

Key locations needing attention:

  • Line ~510: sendInductionEmailToVolunteer() needs try-catch block
  • Line ~590: sendInductionEmailForTransitionedVolunteer() needs try-catch block
  • Line ~750: sendFollowUpEmails() needs try-catch around email operations
  • Line ~810: sendInductionRescheduleEmail() needs try-catch around email operations
🔗 Analysis chain

Line range hint 1-900: Verify error handling consistency across email operations

Some email sending methods have proper error handling while others don't. Let's verify the consistency of error handling.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for email sending operations without try-catch blocks
rg "civicrm_api3\('Email', 'send'" -A 5 -B 5

Length of output: 22733

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0ed8479 and 91044a5.

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

513-513: LGTM: Logging enhancement added

The addition of logging for unscheduled induction activities improves observability.


704-704: LGTM: Fixed contact ID usage

The code now correctly uses the provided contact ID parameter.

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