refactor: Optimize donor dashboard queries

jfn4th · jfn4th · commit 8c967002524b · 2025-06-17T17:36:56.000-05:00
diff --git a/src/DonorDashboards/Repositories/Donations.php b/src/DonorDashboards/Repositories/Donations.php
@@ -3,24 +3,33 @@
 namespace Give\DonorDashboards\Repositories;
 
 use Give\Framework\Database\DB;
+use Give\Framework\Support\ValueObjects\Money;
 use Give\Receipt\DonationReceipt;
 use Give\Receipt\LineItem;
-use Give\ValueObjects\Money;
 use Give_Payment;
 
 /**
  * @since 2.10.0
  */
 class Donations
 {
+    /**
+     * Array of cached donor donation ids
+     *
+     * @unreleased
+     *
+     * @var array<int, int[]>
+     */
+    private static $donationIdsCache = [];
+
     /**
      * Get donations count for donor
      *
      * @since 2.10.0
      *
      * @param int $donorId
      *
-     * @return int
+     * @return int|null
      */
     public function getDonationCount($donorId)
     {
@@ -36,7 +45,7 @@ public function getDonationCount($donorId)
      *
      * @param int $donorId
      *
-     * @return string
+     * @return string|null
      */
     public function getRevenue($donorId)
     {
@@ -45,7 +54,7 @@ public function getRevenue($donorId)
 
         return $aggregate ?
             $this->getAmountWithSeparators(
-                Money::ofMinor($aggregate->result, $currencyCode)->getAmount(),
+                (new Money($aggregate->result, $currencyCode))->formatToDecimal(),
                 $currencyCode
             ) :
             null;
@@ -58,7 +67,7 @@ public function getRevenue($donorId)
      *
      * @param int $donorId
      *
-     * @return string
+     * @return string|null
      */
     public function getAverageRevenue($donorId)
     {
@@ -67,40 +76,113 @@ public function getAverageRevenue($donorId)
 
         return $aggregate ?
             $this->getAmountWithSeparators(
-                Money::ofMinor($aggregate->result, $currencyCode)->getAmount(),
+                (new Money($aggregate->result, $currencyCode))->formatToDecimal(),
                 $currencyCode
             ) :
             null;
     }
 
     /**
-     * Generates a donation aggregate for a given donor
+     * Get formatted donations summary for a donor.
+     *
+     * This summary includes count, total revenue, and average donation amount.
+     * The revenue and average are formatted as decimal strings.
+     *
+     * @unreleased
+     *
+     * @param  int  $donorId
+     *
+     * @return array{count: int|null, revenue: string|null, average: string|null}
+     */
+    public function getFormattedDonationsSummary($donorId)
+    {
+        $summary = $this->getDonationsSummary($donorId);
+        $currencyCode = give_get_option('currency');
+
+        return [
+            'count'   => ($summary->count ?? null),
+            'revenue' => $summary->revenue ? $this->getAmountWithSeparators(
+                (new Money($summary->revenue, $currencyCode))->formatToDecimal(),
+                $currencyCode
+            ) : null,
+            'average' => $summary->average ? $this->getAmountWithSeparators(
+                (new Money($summary->average, $currencyCode))->formatToDecimal(),
+                $currencyCode
+            ) : null,
+        ];
+    }
+
+    /**
+     * Get donations summary for a donor
+     *
+     * @unreleased
+     *
+     * @param int $donorId
+     *
+     * @return object{count: int|null, revenue: string|null, average: string|null}
+     */
+    private function getDonationsSummary($donorId)
+    {
+        $summary = $this->queryDonationRevenueData(
+            $donorId,
+            'COUNT(revenue.id) AS count, SUM(revenue.amount) AS revenue, AVG(revenue.amount) AS average'
+        );
+
+        return $summary ?: (object)[
+            'count'   => null,
+            'revenue' => null,
+            'average' => null,
+        ];
+    }
+
+    /**
+     * @unreleased
      *
-     * @param string $rawAggregate raw SELECT to determine what to aggregate over
      * @param int    $donorId
+     * @param string $selectClause
      *
-     * @return object
+     * @return object|null
      */
-    private function getDonationAggregate($rawAggregate, $donorId)
+    private function queryDonationRevenueData($donorId, $selectClause)
     {
+        $donationIds = $this->getDonationIDs($donorId);
+
+        if (empty($donationIds)) {
+            return null;
+        }
+
         global $wpdb;
 
+        $formattedIds    = implode(',', array_fill(0, count($donationIds), '%d'));
+        $revenueStatuses = "'publish', 'give_subscription', 'pending'";
+
         return DB::get_row(
-            DB::prepare(
+            $wpdb->prepare(
                 "
-				SELECT {$rawAggregate} as result
-				FROM {$wpdb->give_revenue} as revenue
-					INNER JOIN {$wpdb->posts} as posts ON revenue.donation_id = posts.ID
-					INNER JOIN {$wpdb->prefix}give_donationmeta as donationmeta ON revenue.donation_id = donationmeta.donation_id
-				WHERE donationmeta.meta_key = '_give_payment_donor_id'
-					AND donationmeta.meta_value = %d
-					AND posts.post_status IN ( 'publish', 'give_subscription', 'pending' )
-			",
-                $donorId
+                SELECT {$selectClause}
+                FROM {$wpdb->give_revenue} as revenue
+                    INNER JOIN {$wpdb->posts} as posts ON revenue.donation_id = posts.ID
+                WHERE posts.ID IN ( $formattedIds )
+                    AND posts.post_status IN ( {$revenueStatuses} )
+            ",
+                $donationIds
             )
         );
     }
 
+    /**
+     * Generates a donation aggregate for a given donor
+     *
+     * @param string $rawAggregate raw SELECT to determine what to aggregate over
+     * @param int    $donorId
+     *
+     * @return object
+     */
+    private function getDonationAggregate($rawAggregate, $donorId)
+    {
+        return $this->queryDonationRevenueData($donorId, "$rawAggregate as result");
+    }
+
     /**
      * Get all donation ids by donor ID
      *
@@ -112,25 +194,33 @@ private function getDonationAggregate($rawAggregate, $donorId)
      */
     protected function getDonationIDs($donorId)
     {
+        if (isset(self::$donationIdsCache[$donorId])) {
+            return self::$donationIdsCache[$donorId];
+        }
+
         $statusKeys = give_get_payment_status_keys();
         $statusQuery = "'" . implode("','", $statusKeys) . "'";
 
         global $wpdb;
 
-        return DB::get_col(
+        $donationIds = DB::get_col(
             DB::prepare(
                 "
-				SELECT revenue.donation_id as id
-				FROM {$wpdb->give_revenue} as revenue
-					INNER JOIN {$wpdb->posts} as posts ON revenue.donation_id = posts.ID
-					INNER JOIN {$wpdb->prefix}give_donationmeta as donationmeta ON revenue.donation_id = donationmeta.donation_id
+				SELECT posts.ID as id
+				FROM {$wpdb->posts} as posts
+					INNER JOIN {$wpdb->prefix}give_donationmeta as donationmeta ON posts.ID = donationmeta.donation_id
 				WHERE donationmeta.meta_key = '_give_payment_donor_id'
 					AND donationmeta.meta_value = %d
+					AND posts.post_type = 'give_payment'
 					AND posts.post_status IN ( {$statusQuery} )
 			",
                 $donorId
             )
         );
+
+        self::$donationIdsCache[$donorId] = $donationIds;
+
+        return $donationIds;
     }
 
     /**
@@ -145,7 +235,7 @@ protected function getDonationIDs($donorId)
      */
     public function getDonations($donorId)
     {
-        $ids = $this->getDonationIds($donorId);
+        $ids = $this->getDonationIDs($donorId);
 
         if (empty($ids)) {
             return null;
@@ -252,7 +342,7 @@ protected function getReceiptInfo($payment)
         $sectionIndex = 0;
         foreach ($receipt as $section) {
             // Continue if section does not have line items.
-            if ( ! $section->getLineItems()) {
+            if (! $section->getLineItems()) {
                 continue;
             }
 
@@ -273,7 +363,7 @@ protected function getReceiptInfo($payment)
             /* @var LineItem $lineItem */
             foreach ($section as $lineItem) {
                 // Continue if line item does not have value.
-                if ( ! $lineItem->value) {
+                if (! $lineItem->value) {
                     continue;
                 }
 
diff --git a/src/DonorDashboards/Tabs/DonationHistoryTab/DonationsRoute.php b/src/DonorDashboards/Tabs/DonationHistoryTab/DonationsRoute.php
@@ -4,6 +4,7 @@
 
 use Give\DonorDashboards\Repositories\Donations as DonationsRepository;
 use Give\DonorDashboards\Tabs\Contracts\Route as RouteAbstract;
+use Give\Framework\Support\ValueObjects\Money;
 use Give\Log\Log;
 use WP_REST_Request;
 use WP_REST_Response;
@@ -60,9 +61,8 @@ protected function getData(DonationsRepository $repository, $donorId)
         // If the provided donor ID is valid, attempt to query data
         try {
             $donations = $repository->getDonations($donorId);
-            $count = $repository->getDonationCount($donorId);
-            $revenue = $repository->getRevenue($donorId);
-            $average = $repository->getAverageRevenue($donorId);
+            $summary = $repository->getFormattedDonationsSummary($donorId);
+
             $currency = [
                 'symbol' => give_currency_symbol(give_get_currency(), true),
                 'position' => give_get_currency_position(),
@@ -75,9 +75,9 @@ protected function getData(DonationsRepository $repository, $donorId)
                     'body_response' => [
                         [
                             'donations' => $donations,
-                            'count' => $count,
-                            'revenue' => $revenue,
-                            'average' => $average,
+                            'count' => $summary['count'],
+                            'revenue' => $summary['revenue'],
+                            'average' => $summary['average'],
                             'currency' => $currency,
                         ],
                     ],
