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

Add activity for Goonj activity #509

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

Conversation

tarunnjoshi
Copy link
Collaborator

@tarunnjoshi tarunnjoshi commented Nov 29, 2024

add activity

Summary by CodeRabbit

  • New Features
    • Introduced the GoonjActivitiesService for managing Goonj activities related to the Collection_Camp entity.
    • Added functionality for creating activities based on specific conditions and managing related tabs.
    • Implemented event subscriptions to enhance activity tracking and management within the application.

Copy link

coderabbitai bot commented Nov 29, 2024

Walkthrough

The changes introduce a new class, GoonjActivitiesService, in the Civi namespace, which extends the AutoSubscriber class. This service manages activities related to the Collection_Camp entity, specifically for the Goonj_Activities subtype. It includes methods for event subscription, tab management, and activity creation based on specific conditions, utilizing two traits, QrCodeable and CollectionSource.

Changes

File Path Change Summary
wp-content/civi-extensions/goonjcustom/Civi/GoonjActivitiesService.php Added GoonjActivitiesService class with methods: getSubscribedEvents, isViewingGoonjActivities, goonjActivitiesTabset, and createActivityForGoonjActivityCollectionCamp. Defined constants for entity identification.

Possibly related PRs

  • Refactor CollectionCampService.php and DroppingCenterService.php #352: The CollectionCampService class has been refactored to utilize the QrCodeable and CollectionSource traits, which are also used in the GoonjActivitiesService class, indicating a shared functionality related to QR code generation.
  • Show contribution count on Outcome form #496: The CollectionCampService class has been updated to include a new method for updating contribution counts, which may relate to the activity management in GoonjActivitiesService that handles activities for the Collection_Camp entity.
  • Institution Collection Camp #503: The changes in the InstitutionCollectionCampService class involve enhancements related to communication with institutions, which may connect to the activity management features in GoonjActivitiesService that handle activities related to collection camps.

Suggested labels

status : ready for review

Suggested reviewers

  • belwalshubham
  • pokhiii

🌟 In the realm of code, a new class does bloom,
GoonjActivitiesService, dispelling the gloom.
With events and tabs, it dances with grace,
Managing activities in its rightful place.
A service for Goonj, with traits it aligns,
In the world of Civi, where logic entwines! 🌟


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

@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: 3

🧹 Outside diff range and nitpick comments (2)
wp-content/civi-extensions/goonjcustom/Civi/GoonjActivitiesService.php (2)

151-217: Method createActivityForGoonjActivityCollectionCamp is too long and complex

The method spans over 60 lines and handles multiple responsibilities, including validation, data retrieval, and activity creation. This violates the Single Responsibility Principle and makes the code harder to read and maintain.

Consider refactoring the method into smaller, focused methods. For example:

  • Extract a method for validating the operation and object type.
  • Extract a method for loading and verifying the collection camp status.
  • Extract a method for processing activities and creating new entries.

This will improve readability and maintainability.


100-112: Duplicate tab titles may cause confusion in the UI

Both the 'monetaryContribution' and 'monetaryContributionForUrbanOps' tabs have the same title 'Monetary Contribution':

// Lines 100-105
'monetaryContribution' => [
    'title' => ts('Monetary Contribution'),
    // ...
],

// Lines 107-112
'monetaryContributionForUrbanOps' => [
    'title' => ts('Monetary Contribution'),
    // ...
],

This could confuse users as they may not distinguish between the two tabs.

Consider giving distinct titles to these tabs to enhance user experience, such as 'Monetary Contribution' and 'Urban Ops Contribution'.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 81711ae and 026d4aa.

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

Comment on lines +50 to +52
$subtypeId = self::getSubtypeId();

return (int) $entitySubtypeValue === $subtypeId;
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Undefined method getSubtypeId() causes fatal error

The method getSubtypeId() is called on line 50, but it's not defined within the GoonjActivitiesService class or inherited from a parent class. This will result in a fatal error during execution.

To fix this issue, define the getSubtypeId() method or ensure it's properly inherited from a parent class or included via a trait.

Comment on lines +116 to +119
$isAdmin = \CRM_Core_Permission::check('admin');
if ($key == 'monetaryContributionForUrbanOps' && $isAdmin) {
continue;
}
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Potentially incorrect permission logic for administrators

The condition on line 117 skips adding the 'monetaryContributionForUrbanOps' tab if the user has 'admin' permissions:

if ($key == 'monetaryContributionForUrbanOps' && $isAdmin) {
    continue;
}

This may unintentionally prevent administrators from accessing the 'monetaryContributionForUrbanOps' tab, which might not be the desired behavior.

Consider revising the condition to ensure that administrators have appropriate access, or clarify if administrators should indeed be restricted from this tab.

$startDate = $objectRef['Goonj_Activities.Start_Date'];
$endDate = $objectRef['Goonj_Activities.End_Date'];
$initiator = $objectRef['Collection_Camp_Core_Details.Contact_Id'];
error_log("objectRef: " . print_r($objectRef, TRUE));
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Remove debugging error_log statement from production code

An error_log statement is present on line 185:

error_log("objectRef: " . print_r($objectRef, TRUE));

Including debugging code in production can expose sensitive information and clutter log files.

Remove or comment out the error_log statement before deploying to production.

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