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

Fix date filters for recurringdonation stats #1872

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

CarlosQ96
Copy link
Collaborator

@CarlosQ96 CarlosQ96 commented Nov 12, 2024

Issue: Giveth/analytics-dashboard#42

Basically the filters in our queries used the createdAt however this would excluded the data expected from the streams in the stats. We should use the updatedAt parameter because the stream is updated on every new mini donation in our db, totals will make sense now and won't be excluded.

Summary by CodeRabbit

  • New Features

    • Enhanced tracking of recurring donation updates with a new timestamp field.
    • Improved logic for handling recurring donations, focusing on the updatedAt timestamp for data queries.
  • Bug Fixes

    • Refined error handling and logging for donation creation, ensuring clearer insights into failures.
  • Refactor

    • Updated conditions and parameters in donation-related functions for improved accuracy and robustness.

Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

Walkthrough

The changes made in this pull request involve modifications to the handling of recurring donations within two files: recurringDonationRepository.ts and recurringDonationService.ts. The repository file now updates the updatedAt timestamp during donation updates, while the service file adjusts several functions to utilize this timestamp for filtering records. Additionally, the service file enhances error handling and logging in donation creation and status updates, ensuring better validation and robustness in the donation processing logic.

Changes

File Change Summary
src/repositories/recurringDonationRepository.ts Added an update to the updatedAt field to the current timestamp in the updateRecurringDonationFromTheStreamDonations function.
src/services/recurringDonationService.ts Adjusted several functions to use updatedAt for filtering donations; improved error handling in createRelatedDonationsToStream.

Possibly related PRs

Suggested reviewers

  • mohammadranjbarz
  • RamRamez

🐇 In the meadow where donations bloom,
A timestamp now chases away the gloom.
With checks and logs, we dance with delight,
Ensuring each gift is tracked just right!
So hop along, let the donations flow,
For every update, we’ll surely know! 🌼


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
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: 1

🧹 Outside diff range and nitpick comments (1)
src/services/recurringDonationService.ts (1)

Inconsistent Date Field Usage

The date field in TO_CHAR functions is using createdAt instead of updatedAt in the following lines:

  • src/services/recurringDonationService.ts: .addSelect("TO_CHAR(recurringDonation.createdAt, 'YYYY/MM')", 'date')
🔗 Analysis chain

Line range hint 532-636: Verify date field consistency across all statistics functions

Let's verify if there are any other instances where the date field needs to be updated from createdAt to updatedAt for consistency.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other instances where createdAt is used in TO_CHAR for date grouping
rg -A 2 "TO_CHAR.*createdAt.*YYYY/MM" --type ts

Length of output: 566

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between be46140 and 1e00582.

📒 Files selected for processing (2)
  • src/repositories/recurringDonationRepository.ts (1 hunks)
  • src/services/recurringDonationService.ts (3 hunks)
🔇 Additional comments (4)
src/repositories/recurringDonationRepository.ts (2)

109-110: LGTM! The updatedAt timestamp update aligns with PR objectives.

The addition of updatedAt = NOW() ensures the timestamp is updated whenever the recurring donation's amounts are recalculated from stream donations, which is essential for accurate date-based filtering.


Line range hint 182-196: Consider updating getPendingRecurringDonationsIds to use updatedAt

This function still uses createdAt for filtering pending donations. For consistency with the PR's objective of using updatedAt for date filters, consider updating this as well.

Let's verify if this is the only instance where we might need to update the filter:

Consider this change:

  return RecurringDonation.find({
    where: {
      status: RECURRING_DONATION_STATUS.PENDING,
-     createdAt: MoreThan(date),
+     updatedAt: MoreThan(date),
    },
    select: ['id'],
  });
src/services/recurringDonationService.ts (2)

532-538: LGTM! Date filter change improves accuracy of streamed totals

The change from createdAt to updatedAt in the date filters will correctly capture the total USD value of streamed donations based on when they were last updated, aligning with the PR's objective.


630-636: LGTM! Consistent date filter update for per-token totals

The change from createdAt to updatedAt in the date filters maintains consistency with other statistics functions and ensures accurate per-token totals based on when donations were streamed.

@CarlosQ96 CarlosQ96 force-pushed the hotfix_recurring_donation_totals branch from 1e00582 to 66f9699 Compare November 12, 2024 16:38
@Giveth Giveth deleted a comment from coderabbitai bot Nov 12, 2024
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

🧹 Outside diff range and nitpick comments (1)
src/services/recurringDonationService.ts (1)

Line range hint 667-693: Maintain consistency in date field usage

While most functions have been updated to use updatedAt, this function still uses createdAt for date filtering. This inconsistency could lead to mismatched results when comparing stats across different queries.

Apply this diff to maintain consistency:

  if (fromDate) {
-   query.andWhere('recurringDonation.createdAt >= :fromDate', {
+   query.andWhere('recurringDonation.updatedAt >= :fromDate', {
      fromDate: new Date(fromDate),
    });
  }

  if (toDate) {
-   query.andWhere('recurringDonation.createdAt <= :toDate', {
+   query.andWhere('recurringDonation.updatedAt <= :toDate', {
      toDate: new Date(toDate),
    });
  }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1e00582 and 66f9699.

📒 Files selected for processing (2)
  • src/repositories/recurringDonationRepository.ts (1 hunks)
  • src/services/recurringDonationService.ts (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/repositories/recurringDonationRepository.ts
🔇 Additional comments (2)
src/services/recurringDonationService.ts (2)

532-538: LGTM: Date filter changes align with PR objectives

The changes correctly update the date filters from createdAt to updatedAt in these functions, which aligns with the PR objective to fix recurring donation stats by using the timestamp that reflects updates from mini donations.

Also applies to: 578-584, 630-636


532-538: Verify cache key implementation

The cache keys for these functions include the date range parameters but don't distinguish between createdAt and updatedAt usage. This could lead to serving stale data during the transition.

Also applies to: 578-584, 630-636

Copy link
Collaborator

@kkatusic kkatusic left a comment

Choose a reason for hiding this comment

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

Great job, thx @CarlosQ96

Copy link
Collaborator

@RamRamez RamRamez left a comment

Choose a reason for hiding this comment

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

Thanks @CarlosQ96

@CarlosQ96 CarlosQ96 merged commit 6dc5c77 into staging Nov 12, 2024
5 checks passed
@CarlosQ96 CarlosQ96 deleted the hotfix_recurring_donation_totals branch November 12, 2024 21:57
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.

3 participants