From 4c379a02459e8feafbf4ea3faa1eeae37fb4cc69 Mon Sep 17 00:00:00 2001 From: Josh Knapp Date: Sun, 15 Nov 2026 13:09:18 -0800 Subject: [PATCH] Tiered goals: ordered milestones with unlocks, tier-aware goal bar, TIER UNLOCKED alerts, next-unlock line - Tiers\TierPolicy (pure), TierRepository (atomic reached marking), Tiers\Recorder hooked before close-at-target - Admin tiers screen; goal target derived from the final tier - Overlay goal widget shows Tier N of M and fills within the tier; alert pill; donate form 'Next unlock' - Installer DB_VERSION 4 (sg_goal_tiers) Co-Authored-By: Claude Sonnet 5.5 --- assets/donate/donate.css | 3 + assets/donate/donate.js | 16 ++- assets/overlay/overlay.css | 10 ++ assets/overlay/overlay.js | 41 ++++++- includes/Admin/Admin.php | 2 + includes/Admin/GoalsPage.php | 141 +++++++++++++++++++++- includes/Admin/Store.php | 1 + includes/Core/Installer.php | 16 ++- includes/Overlay/OverlayService.php | 5 +- includes/Overlay/Payloads.php | 65 +++++++++- includes/Overlay/TiersSource.php | 23 ++++ includes/Overlay/WpdbDataSource.php | 10 +- includes/PayPal/DonationStore.php | 7 ++ includes/Rest/DonateController.php | 26 +++- includes/Tiers/Recorder.php | 33 +++++ includes/Tiers/TierPolicy.php | 179 ++++++++++++++++++++++++++++ includes/Tiers/TierRepository.php | 151 +++++++++++++++++++++++ tests/Unit/OverlayTiersTest.php | 119 ++++++++++++++++++ tests/Unit/TierPolicyTest.php | 142 ++++++++++++++++++++++ tests/Unit/TierRepositoryTest.php | 113 ++++++++++++++++++ 20 files changed, 1089 insertions(+), 14 deletions(-) create mode 100644 includes/Overlay/TiersSource.php create mode 100644 includes/Tiers/Recorder.php create mode 100644 includes/Tiers/TierPolicy.php create mode 100644 includes/Tiers/TierRepository.php create mode 100644 tests/Unit/OverlayTiersTest.php create mode 100644 tests/Unit/TierPolicyTest.php create mode 100644 tests/Unit/TierRepositoryTest.php diff --git a/assets/donate/donate.css b/assets/donate/donate.css index 80680be..fb17372 100644 --- a/assets/donate/donate.css +++ b/assets/donate/donate.css @@ -35,3 +35,6 @@ .sg-donate label.sg-inline input[type=checkbox]{flex:none;width:22px;height:22px;margin:0} .sg-donate .sg-cover{gap:.25rem} .sg-donate .sg-act-title,.sg-donate .sg-act-desc,.sg-donate .sg-tip,.sg-donate .sg-msg,.sg-donate .sg-total{overflow-wrap:anywhere} + +.sg-donate .sg-next-unlock{margin:0 0 .9rem;padding:.5rem .75rem;border:1px solid rgba(128,128,128,.5);border-left-width:4px;border-radius:.4rem;font-weight:600;line-height:1.4;overflow-wrap:anywhere} +.sg-donate .sg-next-unlock[hidden]{display:none} diff --git a/assets/donate/donate.js b/assets/donate/donate.js index 95536e9..29405cb 100644 --- a/assets/donate/donate.js +++ b/assets/donate/donate.js @@ -82,6 +82,18 @@ var status = el('div', { 'class': 'sg-msg', role: 'status' }); var buttons = el('div', { 'class': 'sg-buttons' }); + // "Next unlock" line for tiered goals (server computes title + remaining minor units per goal). + var nextLine = el('p', { 'class': 'sg-next-unlock', 'aria-live': 'polite' }); + nextLine.hidden = true; + function showNext() { + var n = state.goal.nextUnlock; + if (!n || !n.title || !(n.remaining_minor > 0)) { nextLine.hidden = true; nextLine.textContent = ''; return; } + nextLine.textContent = String(T.nextUnlock || 'Next unlock: %1$s \u2014 %2$s to go') + .replace('%1$s', function () { return n.title; }) + .replace('%2$s', function () { return fmt(n.remaining_minor, state.goal.exp, state.goal.currency); }); + nextLine.hidden = false; + } + root.appendChild(nextLine); if (goals.length > 1) { root.appendChild(row([el('label', { 'for': uid + '-goal', text: T.goal }), goalSel])); } root.appendChild(row([el('label', { text: T.amount }), presetBox, el('label', { 'class': 'sg-sub', 'for': uid + '-amt', text: T.customAmount || 'Or enter your own amount' }), amount, hint])); var nameRow = row([el('label', { 'for': uid + '-name', text: T.name }), name]); @@ -223,9 +235,9 @@ goalSel.addEventListener('change', function () { state.goal = goals.filter(function (g) { return String(g.id) === goalSel.value; })[0] || goals[0]; - buildPresets(); refresh(); renderButtons(); + showNext(); buildPresets(); refresh(); renderButtons(); }); - buildPresets(); refresh(); renderButtons(); + showNext(); buildPresets(); refresh(); renderButtons(); } function boot() { Array.prototype.forEach.call(document.querySelectorAll('.sg-donate'), init); } diff --git a/assets/overlay/overlay.css b/assets/overlay/overlay.css index 1e88fb2..f923600 100644 --- a/assets/overlay/overlay.css +++ b/assets/overlay/overlay.css @@ -49,3 +49,13 @@ body.sg-offline #sg-root{opacity:.6} .sg-menu-track.sg-scrolling{animation:sg-scroll var(--sg-scroll-s,20s) linear infinite} @keyframes sg-scroll{from{transform:translateY(0)}to{transform:translateY(-50%)}} @media (prefers-reduced-motion:reduce){.sg-menu-track.sg-scrolling{animation:none}} + +/* Tiered goals */ +.sg-tier{font-size:.85em;font-weight:600;margin-bottom:.3em;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;color:var(--sg-accent2)} +.sg-tier[hidden]{display:none} +.sg-card.sg-tiers-done .sg-tier{font-weight:800} +.sg-card.sg-tier-up{animation:sg-tier-pop 1.1s cubic-bezier(.22,1,.36,1) 2,sg-tier-glow 1.3s ease-in-out 2} +.sg-bonus-line.sg-tier-line{background:linear-gradient(90deg,#f59e0b,#ef4444);color:#fff;border-radius:.3em;letter-spacing:.04em} +@keyframes sg-tier-pop{0%{transform:scale(1)}30%{transform:scale(1.06)}100%{transform:scale(1)}} +@keyframes sg-tier-glow{0%,100%{box-shadow:0 0 0 transparent}50%{box-shadow:0 0 1em #f59e0b,0 0 2em var(--sg-accent2)}} +@media (prefers-reduced-motion:reduce){.sg-card.sg-tier-up{animation:none;box-shadow:0 0 .8em #f59e0b}} diff --git a/assets/overlay/overlay.js b/assets/overlay/overlay.js index 6a3f9a9..8cf822c 100644 --- a/assets/overlay/overlay.js +++ b/assets/overlay/overlay.js @@ -16,26 +16,52 @@ } // ---- goal ---- - var goal = null, shownRaised = 0, raf = 0; + var goal = null, shownRaised = 0, raf = 0, lastTierKey = null, celebrateTimer = 0; function renderGoal(d) { - if (!d.active) { root.textContent = ''; goal = null; return; } + if (!d.active) { root.textContent = ''; goal = null; lastTierKey = null; return; } if (!goal) { root.textContent = ''; var card = el('div', 'sg-card'); - goal = { title: el('div', 'sg-title'), fill: el('div', 'sg-fill'), pct: el('div', 'sg-pct'), + goal = { card: card, tier: el('div', 'sg-tier'), title: el('div', 'sg-title'), fill: el('div', 'sg-fill'), pct: el('div', 'sg-pct'), raised: el('span'), target: el('span') }; var track = el('div', 'sg-track'); track.appendChild(goal.fill); track.appendChild(goal.pct); var nums = el('div', 'sg-nums'); nums.appendChild(goal.raised); nums.appendChild(goal.target); - card.appendChild(goal.title); card.appendChild(track); card.appendChild(nums); + goal.tier.hidden = true; + card.appendChild(goal.title); card.appendChild(goal.tier); card.appendChild(track); card.appendChild(nums); root.appendChild(card); } goal.title.textContent = d.title; goal.target.textContent = d.target_display; goal.fill.style.width = d.percent + '%'; goal.pct.textContent = d.percent + '%'; + renderTier(d.tiers); tweenRaised(d); } + // Tiered goals only (d.tiers present): "Tier 2 of 4 \u00b7 title" above the bar, or "All tiers unlocked!". + // Untiered goals keep the tier line hidden, so they look exactly as before. textContent only. + function renderTier(t) { + var valid = t && typeof t === 'object' && isFinite(Number(t.count)) && Number(t.count) > 0; + goal.tier.hidden = !valid; + goal.card.classList.toggle('sg-tiered', !!valid); + goal.card.classList.toggle('sg-tiers-done', !!(valid && t.all_reached)); + if (!valid) { goal.tier.textContent = ''; lastTierKey = null; return; } + var cur = t.current && typeof t.current === 'object' ? t.current : null; + goal.tier.textContent = t.all_reached || !cur + ? 'All tiers unlocked!' + : 'Tier ' + parseInt(t.index, 10) + ' of ' + parseInt(t.count, 10) + ' \u00b7 ' + String(cur.title || ''); + // Celebrate when the current tier changed between polls (never on the first poll / after a reload). + var key = (t.all_reached ? 'done' : String(t.index)) + '/' + t.count; + if (lastTierKey !== null && lastTierKey !== key) { + goal.card.classList.remove('sg-tier-up'); + void goal.card.offsetWidth; // restart the animation + goal.card.classList.add('sg-tier-up'); + clearTimeout(celebrateTimer); + var card = goal.card; + celebrateTimer = setTimeout(function () { card.classList.remove('sg-tier-up'); }, 2600); + } + lastTierKey = key; + } function tweenRaised(d) { cancelAnimationFrame(raf); var from = shownRaised, to = d.raised_minor, t0 = performance.now(), dur = 1200; @@ -203,11 +229,16 @@ } } var acts = Array.isArray(a.actions) ? a.actions : []; - if (acts.length) card.classList.add('sg-bonus'); + var tiersUnlocked = Array.isArray(a.tiers) ? a.tiers : []; + if (acts.length || tiersUnlocked.length) card.classList.add('sg-bonus'); for (var k = 0; k < acts.length; k++) { var times = parseInt(acts[k].times, 10) || 1; card.appendChild(el('div', 'sg-bonus-line', 'ACTION: ' + String(acts[k].title) + (times > 1 ? ' x' + times : ''))); } + for (var q = 0; q < tiersUnlocked.length; q++) { + var tt = tiersUnlocked[q] && tiersUnlocked[q].title; + if (tt) card.appendChild(el('div', 'sg-bonus-line sg-tier-line', 'TIER UNLOCKED: ' + String(tt))); + } if (a.message) card.appendChild(el('div', 'sg-alert-msg', a.message)); root.appendChild(card); diff --git a/includes/Admin/Admin.php b/includes/Admin/Admin.php index 2e61bc6..ac9513e 100644 --- a/includes/Admin/Admin.php +++ b/includes/Admin/Admin.php @@ -25,6 +25,8 @@ final class Admin { 'sg_rule_save' => array( GoalsPage::class, 'handleRuleSave' ), 'sg_rule_toggle' => array( GoalsPage::class, 'handleRuleToggle' ), 'sg_rule_delete' => array( GoalsPage::class, 'handleRuleDelete' ), + 'sg_tier_save' => array( GoalsPage::class, 'handleTierSave' ), + 'sg_tier_delete' => array( GoalsPage::class, 'handleTierDelete' ), 'sg_action_save' => array( ActionsPage::class, 'handleSave' ), 'sg_action_toggle' => array( ActionsPage::class, 'handleToggle' ), 'sg_action_delete' => array( ActionsPage::class, 'handleDelete' ), diff --git a/includes/Admin/GoalsPage.php b/includes/Admin/GoalsPage.php index f9ea020..29c1384 100644 --- a/includes/Admin/GoalsPage.php +++ b/includes/Admin/GoalsPage.php @@ -4,6 +4,9 @@ declare( strict_types=1 ); namespace StreamGoals\Admin; use StreamGoals\Core\Money; +use StreamGoals\Core\Settings; +use StreamGoals\Tiers\TierPolicy; +use StreamGoals\Tiers\TierRepository; /** Goals list/create/edit/status/delete, plus the per-goal rules editor. */ final class GoalsPage { @@ -17,6 +20,8 @@ final class GoalsPage { self::renderForm( 'edit' === $view ? $id : 0 ); } elseif ( 'rules' === $view && $id ) { self::renderRules( $id ); + } elseif ( 'tiers' === $view && $id ) { + self::renderTiers( $id ); } else { self::renderList(); } @@ -29,6 +34,7 @@ final class GoalsPage { echo '

Add new goal

'; echo '

Overlays and the donation form use your newest active goal(s). Pause a goal to stop accepting donations; mark it complete when you are done. A goal that has donations cannot be deleted (complete it instead), so your records stay intact.

'; $goals = Store::goals()->all(); + $tierCounts = $goals ? ( new TierRepository() )->countsByGoal() : array(); if ( ! $goals ) { echo '

No goals yet. Create your first goal or run the setup guide.

'; Admin::close(); @@ -47,6 +53,8 @@ final class GoalsPage { echo '' . esc_html( self::dateLabel( $g['starts_at'] ?? null, 'Starts' ) ) . '
' . esc_html( self::dateLabel( $g['ends_at'] ?? null, 'Ends' ) ) . ''; echo 'Edit '; echo 'Rules '; + $nt = $tierCounts[ $gid ] ?? 0; + echo 'Tiers' . ( $nt > 0 ? ' (' . (int) $nt . ')' : '' ) . ' '; foreach ( array( 'active' => array( 'paused', 'Pause' ), 'paused' => array( 'active', 'Resume' ), 'complete' => array( 'active', 'Reopen' ) ) as $from => [ $to, $lbl ] ) { if ( $g['status'] === $from ) { Admin::form( 'sg_goal_status', array( 'goal_id' => $gid, 'status' => $to ), 'sg-inline' ); @@ -80,11 +88,16 @@ final class GoalsPage { return; } $cur = $g ? Format::currency( $g['currency'] ) : Admin::currency(); + $tiered = $id && (bool) ( new TierRepository() )->forGoal( $id ); Admin::open( $g ? 'Edit goal' : 'New goal' ); Admin::form( 'sg_goal_save', array( 'goal_id' => $id ) ); echo ''; echo ''; - echo ''; + if ( $tiered ) { + echo ''; + } else { + echo ''; + } echo ''; $fmt = static fn( ?string $utc ): string => $utc ? get_date_from_gmt( $utc, 'Y-m-d\TH:i' ) : ''; echo ''; @@ -116,10 +129,12 @@ final class GoalsPage { $cur = $old ? Format::currency( $old['currency'] ) : Admin::currency(); $title = Input::text( $post['title'] ?? '', 190 ); $tgt = Input::amountToMinor( $post['target'] ?? '', $cur ); + // A goal with tiers has a derived target (its highest tier): never taken from the form. + $tiered = $id && ( new TierRepository() )->forGoal( $id ); if ( '' === $title ) { Admin::redirect( $back, 'error', 'Please give the goal a title.' ); } - if ( null === $tgt || $tgt <= 0 ) { + if ( ! $tiered && ( null === $tgt || $tgt <= 0 ) ) { Admin::redirect( $back, 'error', 'Please enter a target greater than zero, for example 250.00.' ); } $startRaw = Input::text( $post['starts_at'] ?? '', 20 ); @@ -133,6 +148,9 @@ final class GoalsPage { Admin::redirect( $back, 'error', 'The end must be after the start.' ); } $data = array( 'title' => $title, 'target_minor' => $tgt, 'starts_at' => $start, 'ends_at' => $end, 'counts_fees' => empty( $post['counts_fees'] ) ? 0 : 1, 'close_at_target' => \StreamGoals\Core\GoalTargetPolicy::flagFromPost( $post['close_at_target'] ?? null ) ); + if ( $tiered ) { + unset( $data['target_minor'] ); + } if ( $id ) { Store::goals()->update( $id, $data ); } else { @@ -171,6 +189,125 @@ final class GoalsPage { Admin::redirect( Admin::url(), 'success', 'Goal deleted.' ); } + /* ----------------------------------------------------------------- tiers */ + + private static function tiersUrl( int $goalId, array $extra = array() ): string { + return Admin::url( Admin::HOME, array_merge( array( 'view' => 'tiers', 'goal' => $goalId ), $extra ) ); + } + + private static function renderTiers( int $goalId ): void { + $g = Store::goals()->find( $goalId ); + if ( ! $g ) { + Admin::open( 'Goal not found' ); + echo '

Back to goals

'; + Admin::close(); + return; + } + $cur = Format::currency( $g['currency'] ); + $repo = new TierRepository(); + $tiers = $repo->forGoal( $goalId ); + $raised = Store::goals()->raised_minor( $goalId ); + Admin::open( 'Tiers for "' . (string) $g['title'] . '"' ); + echo '

← Back to goals

'; + echo '

Tiers turn one goal into a ladder of milestones. Each tier has a target and something you unlock or give away. When your total reaches a tier\'s target, that tier unlocks and the goal bar moves on to the next one. The goal\'s final target is your highest tier.

'; + + echo '

Your tiers

'; + echo '

Raised so far: ' . esc_html( Format::money( $raised, $cur ) ) . '. Targets are cumulative totals, not extra amounts: a tier at ' . esc_html( Format::money( 25000, $cur ) ) . ' unlocks when the goal total reaches ' . esc_html( Format::money( 25000, $cur ) ) . '.

'; + if ( ! $tiers ) { + echo '

No tiers yet. This goal works as a single target until you add one.

'; + } else { + echo '
'; + foreach ( TierPolicy::sorted( $tiers ) as $i => $t ) { + $tid = (int) $t['id']; + $status = TierPolicy::status( $tiers, $t ); + $label = 'reached' === $status ? 'Reached on ' . get_date_from_gmt( (string) $t['reached_at'], 'Y-m-d H:i' ) : ( 'current' === $status ? 'Current' : 'Upcoming' ); + echo ''; + echo ''; + } + echo '
#UnlockTargetStatusActions
' . (int) ( $i + 1 ) . '' . esc_html( $t['title'] ) . ''; + if ( '' !== $t['description'] ) { + echo '
' . esc_html( $t['description'] ) . ''; + } + echo '
' . esc_html( Format::money( (int) $t['target_minor'], $cur ) ) . '' . esc_html( $label ) . ''; + echo 'Edit '; + Admin::form( 'sg_tier_delete', array( 'goal_id' => $goalId, 'tier_id' => $tid ), 'sg-inline sg-confirm' ); + echo '
'; + } + echo ''; + + $editId = Admin::get_int( 'tier' ); + $edit = $editId ? $repo->find( $editId ) : null; + if ( $edit && (int) $edit['goal_id'] !== $goalId ) { + $edit = null; + } + $locked = $edit && TierPolicy::isReached( $edit ); + $min = Settings::effectiveMin( (int) Settings::get( 'min_donation_minor', 0 ) ); + echo '

' . ( $edit ? 'Edit tier' : 'Add a tier' ) . '

'; + Admin::form( 'sg_tier_save', array( 'goal_id' => $goalId, 'tier_id' => $edit ? (int) $edit['id'] : 0 ) ); + echo ''; + echo ''; + echo ''; + echo ''; + echo '

'; + if ( $edit ) { + echo ' Cancel'; + } + echo '

'; + Admin::close(); + } + + public static function handleTierSave(): void { + Admin::guard( 'sg_tier_save' ); + $post = Admin::post_raw(); + $goalId = isset( $post['goal_id'] ) ? absint( $post['goal_id'] ) : 0; + $tierId = isset( $post['tier_id'] ) ? absint( $post['tier_id'] ) : 0; + $g = $goalId ? Store::goals()->find( $goalId ) : null; + if ( ! $g ) { + Admin::redirect( Admin::url(), 'error', 'That goal no longer exists.' ); + } + $back = self::tiersUrl( $goalId, $tierId ? array( 'tier' => $tierId ) : array() ); + $cur = Format::currency( $g['currency'] ); + $repo = new TierRepository(); + $min = Settings::effectiveMin( (int) Settings::get( 'min_donation_minor', 0 ) ); + $res = TierPolicy::validate( + $repo->forGoal( $goalId ), + $tierId ?: null, + Input::amountToMinor( $post['target'] ?? '', $cur ), + Input::text( $post['title'] ?? '', 200 ), + Input::text( $post['description'] ?? '', 400 ), + Store::goals()->raised_minor( $goalId ), + $min, + Format::money( $min, $cur ) + ); + if ( null === $res['data'] ) { + Admin::redirect( $back, 'error', (string) $res['error'] ); + } + if ( $tierId ) { + $repo->update( $tierId, $goalId, $res['data'] ); + } elseif ( $repo->create( $goalId, $res['data'] ) <= 0 ) { + Admin::redirect( $back, 'error', 'The tier could not be saved. Another tier may already have that target.' ); + } + $repo->syncGoalTarget( $goalId ); + $msg = 'Tier saved. The goal target is now ' . Format::money( TierPolicy::derivedGoalTarget( $repo->forGoal( $goalId ) ), $cur ) . '.'; + if ( 'complete' === ( $g['status'] ?? '' ) ) { + $msg .= ' This goal is marked complete; use "Reopen" on the goals list if you want donations to continue.'; + } + Admin::redirect( self::tiersUrl( $goalId ), 'success', $msg ); + } + + public static function handleTierDelete(): void { + Admin::guard( 'sg_tier_delete' ); + $post = Admin::post_raw(); + $goalId = isset( $post['goal_id'] ) ? absint( $post['goal_id'] ) : 0; + if ( $goalId && Store::goals()->find( $goalId ) ) { + $repo = new TierRepository(); + $repo->delete( isset( $post['tier_id'] ) ? absint( $post['tier_id'] ) : 0, $goalId ); + $repo->syncGoalTarget( $goalId ); // no-op when the last tier was removed: the goal keeps its current target (editable again) + } + Admin::redirect( self::tiersUrl( $goalId ), 'success', 'Tier deleted.' ); + } + /* ----------------------------------------------------------------- rules */ private static function renderRules( int $goalId ): void { diff --git a/includes/Admin/Store.php b/includes/Admin/Store.php index 04b4825..8edbadb 100644 --- a/includes/Admin/Store.php +++ b/includes/Admin/Store.php @@ -87,6 +87,7 @@ final class Store { self::deleteRule( (int) $r['id'], $goalId ); } $wpdb->delete( self::t( 'state' ), array( 'goal_id' => $goalId ), array( '%d' ) ); + $wpdb->delete( self::t( 'goal_tiers' ), array( 'goal_id' => $goalId ), array( '%d' ) ); return self::goals()->delete( $goalId ); } diff --git a/includes/Core/Installer.php b/includes/Core/Installer.php index 5ff4780..741ec3e 100644 --- a/includes/Core/Installer.php +++ b/includes/Core/Installer.php @@ -8,7 +8,7 @@ namespace StreamGoals\Core; */ final class Installer { - public const DB_VERSION = '3'; + public const DB_VERSION = '4'; public static function activate(): void { self::install_schema(); @@ -143,6 +143,20 @@ final class Installer { KEY goal_enabled (goal_id,enabled) ) $c;" ); + dbDelta( "CREATE TABLE {$p}goal_tiers ( + id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT, + goal_id BIGINT UNSIGNED NOT NULL, + target_minor BIGINT UNSIGNED NOT NULL, + title VARCHAR(120) NOT NULL, + description VARCHAR(255) NOT NULL DEFAULT '', + reached_at DATETIME NULL, + reached_donation_id BIGINT UNSIGNED NULL, + created_at DATETIME NOT NULL, + PRIMARY KEY (id), + UNIQUE KEY goal_target (goal_id,target_minor), + KEY reached_donation (reached_donation_id) + ) $c;" ); + update_option( 'sg_db_version', self::DB_VERSION ); } } diff --git a/includes/Overlay/OverlayService.php b/includes/Overlay/OverlayService.php index 4d5dac8..ba1ec41 100644 --- a/includes/Overlay/OverlayService.php +++ b/includes/Overlay/OverlayService.php @@ -31,7 +31,8 @@ final class OverlayService { $gid = $goal ? (int) $goal['id'] : 0; switch ( $widget ) { case 'goal': - return Payloads::goal( $goal, $goal ? $this->source->raisedMinor( $goal ) : 0 ); + $tiers = ( $gid && $this->source instanceof TiersSource ) ? $this->source->tiersFor( $gid ) : array(); + return Payloads::goal( $goal, $goal ? $this->source->raisedMinor( $goal ) : 0, $tiers ?: null ); case 'timer': return Payloads::timer( $gid ? $this->source->stateValue( $gid, 'timer_ends_at' ) : null, @@ -55,9 +56,11 @@ final class OverlayService { $ids = array_values( array_filter( array_map( static fn( $r ) => (int) ( $r['id'] ?? 0 ), $rows ) ) ); $bonuses = ( ( $recent || null !== $since ) && $ids ) ? $this->source->bonusesFor( $ids ) : array(); $actions = ( ( $recent || null !== $since ) && $ids && $this->source instanceof ActionsSource ) ? $this->source->actionsFor( $ids ) : array(); + $tiers = ( ( $recent || null !== $since ) && $ids && $this->source instanceof TiersSource ) ? $this->source->tiersReachedFor( $ids ) : array(); foreach ( $rows as $i => $r ) { $rows[ $i ]['bonuses'] = $bonuses[ (int) ( $r['id'] ?? 0 ) ] ?? array(); $rows[ $i ]['actions'] = $actions[ (int) ( $r['id'] ?? 0 ) ] ?? array(); + $rows[ $i ]['tiers'] = $tiers[ (int) ( $r['id'] ?? 0 ) ] ?? array(); } $mediaFor = null; $defs = ( $recent || null !== $since ) ? $this->defs() : array(); diff --git a/includes/Overlay/Payloads.php b/includes/Overlay/Payloads.php index 0f9e1e5..bf59f98 100644 --- a/includes/Overlay/Payloads.php +++ b/includes/Overlay/Payloads.php @@ -4,6 +4,7 @@ declare( strict_types=1 ); namespace StreamGoals\Overlay; use StreamGoals\Core\Money; +use StreamGoals\Tiers\TierPolicy; /** * Pure, WordPress-free payload builders. Everything returned here is public-safe. @@ -31,7 +32,10 @@ final class Payloads { return max( 0, min( 100, intdiv( max( 0, $raised ) * 100, $target ) ) ); } - public static function goal( ?array $goal, int $raised ): array { + /** + * @param array>|null $tiers Raw sg_goal_tiers rows; null/empty = an ordinary (untiered) goal, payload unchanged. + */ + public static function goal( ?array $goal, int $raised, ?array $tiers = null ): array { if ( null === $goal ) { return array( 'active' => false, 'title' => '', 'raised_minor' => 0, 'target_minor' => 0, 'percent' => 0, 'currency' => 'USD', 'raised_display' => '', 'target_display' => '' ); @@ -39,6 +43,9 @@ final class Payloads { $cur = strtoupper( (string) ( $goal['currency'] ?? 'USD' ) ); $target = max( 0, (int) ( $goal['target_minor'] ?? 0 ) ); $raised = max( 0, $raised ); + if ( $tiers ) { + return self::tieredGoal( $goal, $raised, $cur, $tiers ); + } return array( 'active' => true, 'title' => (string) ( $goal['title'] ?? '' ), @@ -51,6 +58,40 @@ final class Payloads { ); } + /** + * Tiered goal: raised stays cumulative; target/percent describe the CURRENT tier (percent is within the tier). + * When every tier is reached the bar is full at the top tier's target. + */ + private static function tieredGoal( array $goal, int $raised, string $cur, array $tiers ): array { + $sorted = TierPolicy::sorted( $tiers ); + $current = TierPolicy::currentTier( $sorted ); + $all = null === $current; + $target = $all ? TierPolicy::derivedGoalTarget( $sorted ) : max( 0, (int) $current['target_minor'] ); + $floor = TierPolicy::floorMinor( $sorted ); + return array( + 'active' => true, + 'title' => (string) ( $goal['title'] ?? '' ), + 'raised_minor' => $raised, + 'target_minor' => $target, + 'percent' => TierPolicy::percentFor( $sorted, $raised ), + 'currency' => $cur, + 'raised_display' => self::money( $raised, $cur ), + 'target_display' => self::money( $target, $cur ), + 'tiers' => array( + 'count' => count( $sorted ), + 'index' => TierPolicy::currentIndex( $sorted ), + 'current' => $all ? null : array( + 'title' => self::text( $current['title'] ?? '', 120 ), + 'description' => self::text( $current['description'] ?? '', 255 ), + 'target_minor' => $target, + 'target_display' => self::money( $target, $cur ), + 'floor_minor' => $floor, + ), + 'all_reached' => $all, + ), + ); + } + /** * @param string|null $endsAt sg_state `timer_ends_at` (epoch seconds, or a UTC datetime string). * @param string|null $pausedRemaining sg_state `paused_remaining` seconds; non-null means paused. @@ -132,6 +173,7 @@ final class Payloads { 'message' => (string) ( $r['message'] ?? '' ), 'bonuses' => self::bonuses( $r['bonuses'] ?? array() ), 'actions' => self::actionEvents( $r['actions'] ?? array() ), + 'tiers' => self::tierEvents( $r['tiers'] ?? array() ), 'media' => $mediaFor ? $mediaFor( $r, $pub, $disp ) : null, ); } @@ -200,6 +242,27 @@ final class Payloads { return $out; } + /** + * Tiers a donation unlocked, for the "TIER UNLOCKED" pill: [ {title} ]. At most 5, titles capped at 80 chars, blanks dropped. + * + * @param mixed $events + * @return array + */ + public static function tierEvents( mixed $events ): array { + $out = array(); + foreach ( is_array( $events ) ? $events : array() as $e ) { + $title = self::text( is_array( $e ) ? ( $e['title'] ?? '' ) : '', 80 ); + if ( '' === $title ) { + continue; + } + $out[] = array( 'title' => $title ); + if ( count( $out ) >= 5 ) { + break; + } + } + return $out; + } + /** * The on-stream reward menu for the active goal. Empty list means "render nothing". * diff --git a/includes/Overlay/TiersSource.php b/includes/Overlay/TiersSource.php new file mode 100644 index 0000000..818dc2c --- /dev/null +++ b/includes/Overlay/TiersSource.php @@ -0,0 +1,23 @@ +> + */ + public function tiersFor( int $goalId ): array; + + /** + * Tiers unlocked by each donation, ONE lookup for the whole page: donation id => [ {title} ]. + * + * @param int[] $donationIds + * @return array>> + */ + public function tiersReachedFor( array $donationIds ): array; +} diff --git a/includes/Overlay/WpdbDataSource.php b/includes/Overlay/WpdbDataSource.php index ebcb801..35802c1 100644 --- a/includes/Overlay/WpdbDataSource.php +++ b/includes/Overlay/WpdbDataSource.php @@ -4,7 +4,7 @@ declare( strict_types=1 ); namespace StreamGoals\Overlay; /** $wpdb adapter reading sg_goals, sg_donations, sg_state, sg_rules directly. */ -final class WpdbDataSource implements OverlayDataSource, RecentDonationsSource, ActionsSource, AlertMediaSource { +final class WpdbDataSource implements OverlayDataSource, RecentDonationsSource, ActionsSource, AlertMediaSource, TiersSource { /** @var array */ private array $attachments = array(); @@ -120,6 +120,14 @@ final class WpdbDataSource implements OverlayDataSource, RecentDonationsSource, return $out; } + public function tiersFor( int $goalId ): array { + return ( new \StreamGoals\Tiers\TierRepository( $GLOBALS['wpdb'] ) )->forGoal( $goalId ); + } + + public function tiersReachedFor( array $donationIds ): array { + return ( new \StreamGoals\Tiers\TierRepository( $GLOBALS['wpdb'] ) )->reachedByDonation( $donationIds ); + } + public function alertDefs(): array { return ( new \StreamGoals\Alerts\DefRepository( $GLOBALS['wpdb'] ) )->enabled(); } diff --git a/includes/PayPal/DonationStore.php b/includes/PayPal/DonationStore.php index dea7dbe..ebfbdbf 100644 --- a/includes/PayPal/DonationStore.php +++ b/includes/PayPal/DonationStore.php @@ -93,6 +93,13 @@ final class DonationStore { } catch ( \Throwable $e ) { error_log( 'StreamGoals: Recorder failed for donation ' . $id . ': ' . $e->getMessage() ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions } + // Goal tiers: unlock every tier this donation reaches. MUST run before the close-at-target check below + // (the final tier's target is the goal target). Own try/catch; never throws, never delays a capture. + try { + \StreamGoals\Tiers\Recorder::forDonation( $id ); + } catch ( \Throwable $e ) { + error_log( 'StreamGoals: tier unlock failed for donation ' . $id . ': ' . $e->getMessage() ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions + } self::close_goal_if_target_reached( $id ); } diff --git a/includes/Rest/DonateController.php b/includes/Rest/DonateController.php index 6718838..96934f3 100644 --- a/includes/Rest/DonateController.php +++ b/includes/Rest/DonateController.php @@ -162,7 +162,8 @@ final class DonateController { if ( $pinned && (int) $g['id'] !== $pinned ) { continue; } - $goals[] = array( + $next = self::next_unlock( $g ); + $goals[] = ( null === $next ? array() : array( 'nextUnlock' => $next ) ) + array( 'id' => (int) $g['id'], 'title' => (string) $g['title'], 'currency' => strtoupper( (string) $g['currency'] ), @@ -206,6 +207,8 @@ final class DonateController { 'customPlaceholder' => __( 'Other amount', 'streamgoals-donate' ), /* translators: %s: formatted amount, e.g. $5.00 */ 'everyLabel' => __( 'Every %s', 'streamgoals-donate' ), + /* translators: 1: item/unlock title, 2: formatted amount still needed, e.g. $106.00 */ + 'nextUnlock' => __( 'Next unlock: %1$s — %2$s to go', 'streamgoals-donate' ), 'actionsHint' => __( 'Pick a reward, or enter your own amount below.', 'streamgoals-donate' ), /* translators: %s: formatted minimum amount, e.g. $1.00 */ 'minHint' => __( 'Minimum donation: %s', 'streamgoals-donate' ), @@ -222,6 +225,27 @@ final class DonateController { /* ------------------------------------------------------------- Helpers */ + /** + * "Next unlock" hint for a tiered goal: the current (first unreached) tier's title and the amount still needed, in minor units. + * Null for goals without tiers or with every tier reached. Computed when the page renders. + * + * @return array{title:string,remaining_minor:int}|null + */ + private static function next_unlock( array $goal ): ?array { + try { + global $wpdb; + $tiers = ( new \StreamGoals\Tiers\TierRepository( $wpdb ) )->forGoal( (int) $goal['id'] ); + $cur = $tiers ? \StreamGoals\Tiers\TierPolicy::currentTier( $tiers ) : null; + if ( null === $cur ) { + return null; + } + $raised = ( new \StreamGoals\Core\GoalRepository( $wpdb ) )->raised_minor( (int) $goal['id'] ); + return array( 'title' => (string) $cur['title'], 'remaining_minor' => max( 1, (int) $cur['target_minor'] - $raised ) ); + } catch ( \Throwable $e ) { + return null; + } + } + /** * Enabled actions per goal id (rows with goal_id 0 apply to every goal), at or above the effective minimum. * Public-safe fields only. One query; reads sg_actions directly. diff --git a/includes/Tiers/Recorder.php b/includes/Tiers/Recorder.php new file mode 100644 index 0000000..a45ce9d --- /dev/null +++ b/includes/Tiers/Recorder.php @@ -0,0 +1,33 @@ +get_row( $wpdb->prepare( 'SELECT id, goal_id, status FROM ' . $wpdb->prefix . 'sg_donations WHERE id = %d', $donationId ), ARRAY_A ); + if ( ! is_array( $row ) || 'completed' !== ( $row['status'] ?? '' ) || (int) $row['goal_id'] <= 0 ) { + return array(); + } + $goalId = (int) $row['goal_id']; + $repo = new TierRepository( $wpdb ); + if ( ! $repo->forGoal( $goalId ) ) { + return array(); + } + $raised = ( new \StreamGoals\Core\GoalRepository( $wpdb ) )->raised_minor( $goalId ); + return $repo->markReached( $goalId, $raised, $donationId ); + } catch ( \Throwable $e ) { + error_log( 'StreamGoals: tier unlock failed for donation ' . $donationId . ': ' . $e->getMessage() ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions + return array(); + } + } +} diff --git a/includes/Tiers/TierPolicy.php b/includes/Tiers/TierPolicy.php new file mode 100644 index 0000000..10d2d33 --- /dev/null +++ b/includes/Tiers/TierPolicy.php @@ -0,0 +1,179 @@ + ( (int) $a['target_minor'] <=> (int) $b['target_minor'] ) ?: ( (int) ( $a['id'] ?? 0 ) <=> (int) ( $b['id'] ?? 0 ) ) + ); + return $tiers; + } + + public static function isReached( array $tier ): bool { + return ! empty( $tier['reached_at'] ); + } + + /** The first tier (by target) that is not reached yet, or null (no tiers, or all reached). */ + public static function currentTier( array $tiers ): ?array { + foreach ( self::sorted( $tiers ) as $t ) { + if ( ! self::isReached( $t ) ) { + return $t; + } + } + return null; + } + + /** True when there is at least one tier and every tier is reached. */ + public static function allReached( array $tiers ): bool { + return $tiers && null === self::currentTier( $tiers ); + } + + /** 1-based position of the current tier; when all are reached, the count; 0 without tiers. */ + public static function currentIndex( array $tiers ): int { + $sorted = self::sorted( $tiers ); + foreach ( $sorted as $i => $t ) { + if ( ! self::isReached( $t ) ) { + return $i + 1; + } + } + return count( $sorted ); + } + + /** Start of the current tier's range: the previous tier's target (0 for the first / when none is current). */ + public static function floorMinor( array $tiers ): int { + $prev = 0; + foreach ( self::sorted( $tiers ) as $t ) { + if ( ! self::isReached( $t ) ) { + return $prev; + } + $prev = (int) $t['target_minor']; + } + return $prev; // all reached: the top tier's target + } + + /** Progress inside a tier, 0..100 (clamped). Below the floor = 0, at or above the target = 100. */ + public static function percent( int $raised, int $floor, int $target ): int { + if ( $target <= $floor ) { + return $raised >= $target && $target > 0 ? 100 : 0; + } + $p = intdiv( ( $raised - $floor ) * 100, $target - $floor ); + return max( 0, min( 100, $p ) ); + } + + /** Percent within the current tier for the given tiers and raised total (100 when all reached, 0 without tiers). */ + public static function percentFor( array $tiers, int $raised ): int { + $cur = self::currentTier( $tiers ); + if ( null === $cur ) { + return $tiers ? 100 : 0; + } + return self::percent( $raised, self::floorMinor( $tiers ), (int) $cur['target_minor'] ); + } + + /** Money still needed to reach the current tier (0 when none). */ + public static function remainingMinor( array $tiers, int $raised ): int { + $cur = self::currentTier( $tiers ); + return null === $cur ? 0 : max( 0, (int) $cur['target_minor'] - $raised ); + } + + /** Every unreached tier whose target is at or below the raised total, in target order. A big donation can unlock several. @return array[] */ + public static function newlyReached( array $tiers, int $raised ): array { + $out = array(); + foreach ( self::sorted( $tiers ) as $t ) { + if ( ! self::isReached( $t ) && (int) $t['target_minor'] <= $raised ) { + $out[] = $t; + } + } + return $out; + } + + /** The goal's target when it has tiers: the highest tier target (0 when no tiers). */ + public static function derivedGoalTarget( array $tiers ): int { + $max = 0; + foreach ( $tiers as $t ) { + $max = max( $max, (int) ( $t['target_minor'] ?? 0 ) ); + } + return $max; + } + + /** + * Validate a tier form submission. + * + * @param array $tiers All tiers of the goal (including the one being edited). + * @param int|null $editId Tier id when editing, null when adding. + * @param int|null $target Parsed target in minor units (null = not a valid amount). + * @param int $raised Goal raised total (minor units). + * @param int $minMinor Settings::effectiveMin(). + * @return array{data:?array{target_minor:int,title:string,description:string},error:?string} + */ + public static function validate( array $tiers, ?int $editId, ?int $target, string $title, string $description, int $raised, int $minMinor, string $minLabel = '' ): array { + $fail = static fn( string $m ): array => array( 'data' => null, 'error' => $m ); + $title = trim( $title ); + $desc = trim( $description ); + if ( '' === $title ) { + return $fail( 'Please name what unlocks at this tier, for example "New microphone".' ); + } + if ( self::len( $title ) > self::TITLE_MAX ) { + return $fail( 'The title can be at most ' . self::TITLE_MAX . ' characters.' ); + } + if ( self::len( $desc ) > self::DESC_MAX ) { + return $fail( 'The description can be at most ' . self::DESC_MAX . ' characters.' ); + } + $existing = null; + if ( null !== $editId ) { + foreach ( $tiers as $t ) { + if ( (int) ( $t['id'] ?? 0 ) === $editId ) { + $existing = $t; + } + } + if ( null === $existing ) { + return $fail( 'That tier no longer exists.' ); + } + } + if ( null !== $existing && self::isReached( $existing ) ) { + // Reached tiers: the target is locked, only the text can change. + return array( 'data' => array( 'target_minor' => (int) $existing['target_minor'], 'title' => $title, 'description' => $desc ), 'error' => null ); + } + if ( null === $target || $target <= 0 ) { + return $fail( 'Please enter a target greater than zero, for example 250.00.' ); + } + if ( $target < $minMinor ) { + return $fail( 'The target must be at least the minimum donation' . ( '' !== $minLabel ? ' (' . $minLabel . ')' : '' ) . '.' ); + } + foreach ( $tiers as $t ) { + if ( (int) ( $t['id'] ?? 0 ) !== (int) $editId && (int) $t['target_minor'] === $target ) { + return $fail( 'Another tier already has that target. Each tier needs its own amount.' ); + } + } + $unchanged = null !== $existing && (int) $existing['target_minor'] === $target; + if ( ! $unchanged && $target <= $raised ) { + return $fail( 'This goal has already raised more than that, so the tier would unlock instantly. Choose a target above the current total.' ); + } + return array( 'data' => array( 'target_minor' => $target, 'title' => $title, 'description' => $desc ), 'error' => null ); + } + + /** Display status of a tier given the sorted list: 'reached' | 'current' | 'upcoming'. */ + public static function status( array $tiers, array $tier ): string { + if ( self::isReached( $tier ) ) { + return 'reached'; + } + $cur = self::currentTier( $tiers ); + return $cur && (int) $cur['id'] === (int) $tier['id'] ? 'current' : 'upcoming'; + } + + private static function len( string $s ): int { + return function_exists( 'mb_strlen' ) ? mb_strlen( $s ) : strlen( $s ); + } +} diff --git a/includes/Tiers/TierRepository.php b/includes/Tiers/TierRepository.php new file mode 100644 index 0000000..414d3f4 --- /dev/null +++ b/includes/Tiers/TierRepository.php @@ -0,0 +1,151 @@ +db = $db ?? $GLOBALS['wpdb']; + } + + private function t( string $name ): string { + return $this->db->prefix . 'sg_' . $name; + } + + /** @return array{id:int,goal_id:int,target_minor:int,title:string,description:string,reached_at:?string,reached_donation_id:?int,created_at:string} */ + private static function cast( array $r ): array { + return array( + 'id' => (int) ( $r['id'] ?? 0 ), + 'goal_id' => (int) ( $r['goal_id'] ?? 0 ), + 'target_minor' => (int) ( $r['target_minor'] ?? 0 ), + 'title' => (string) ( $r['title'] ?? '' ), + 'description' => (string) ( $r['description'] ?? '' ), + 'reached_at' => isset( $r['reached_at'] ) && '' !== (string) $r['reached_at'] ? (string) $r['reached_at'] : null, + 'reached_donation_id' => isset( $r['reached_donation_id'] ) && null !== $r['reached_donation_id'] ? (int) $r['reached_donation_id'] : null, + 'created_at' => (string) ( $r['created_at'] ?? '' ), + ); + } + + /** Tiers of a goal ordered by target ascending. @return array[] */ + public function forGoal( int $goalId ): array { + $rows = $this->db->get_results( + $this->db->prepare( 'SELECT * FROM ' . $this->t( 'goal_tiers' ) . ' WHERE goal_id = %d ORDER BY target_minor ASC, id ASC', $goalId ), + ARRAY_A + ); + return array_map( array( self::class, 'cast' ), (array) $rows ); + } + + public function find( int $id ): ?array { + $row = $this->db->get_row( $this->db->prepare( 'SELECT * FROM ' . $this->t( 'goal_tiers' ) . ' WHERE id = %d', $id ), ARRAY_A ); + return $row ? self::cast( $row ) : null; + } + + /** Tier counts per goal id (one query) for the goals list. @return array */ + public function countsByGoal(): array { + $rows = $this->db->get_results( 'SELECT goal_id, COUNT(*) AS n FROM ' . $this->t( 'goal_tiers' ) . ' GROUP BY goal_id', ARRAY_A ); + $out = array(); + foreach ( (array) $rows as $r ) { + $out[ (int) $r['goal_id'] ] = (int) $r['n']; + } + return $out; + } + + /** @param array{target_minor:int,title:string,description:string} $d @return int new id (0 on failure, e.g. duplicate target) */ + public function create( int $goalId, array $d ): int { + $ok = $this->db->insert( + $this->t( 'goal_tiers' ), + array( + 'goal_id' => $goalId, + 'target_minor' => (int) $d['target_minor'], + 'title' => (string) $d['title'], + 'description' => (string) $d['description'], + 'created_at' => gmdate( 'Y-m-d H:i:s' ), + ), + array( '%d', '%d', '%s', '%s', '%s' ) + ); + return $ok ? (int) $this->db->insert_id : 0; + } + + public function update( int $id, int $goalId, array $d ): void { + $this->db->update( + $this->t( 'goal_tiers' ), + array( 'target_minor' => (int) $d['target_minor'], 'title' => (string) $d['title'], 'description' => (string) $d['description'] ), + array( 'id' => $id, 'goal_id' => $goalId ), + array( '%d', '%s', '%s' ), + array( '%d', '%d' ) + ); + } + + public function delete( int $id, int $goalId ): void { + $this->db->delete( $this->t( 'goal_tiers' ), array( 'id' => $id, 'goal_id' => $goalId ), array( '%d', '%d' ) ); + } + + /** + * Mark every unreached tier of the goal with target <= $raised as reached by $donationId. One atomic + * UPDATE per tier (WHERE reached_at IS NULL): replays and concurrent callers cannot re-mark a tier. + * + * @return int[] ids of the tiers THIS call marked. + */ + public function markReached( int $goalId, int $raised, int $donationId ): array { + $marked = array(); + if ( $goalId <= 0 || $donationId <= 0 ) { + return $marked; + } + $now = gmdate( 'Y-m-d H:i:s' ); + foreach ( TierPolicy::newlyReached( $this->forGoal( $goalId ), $raised ) as $tier ) { + $n = $this->db->query( + $this->db->prepare( + 'UPDATE ' . $this->t( 'goal_tiers' ) . ' SET reached_at = %s, reached_donation_id = %d WHERE id = %d AND reached_at IS NULL', + $now, + $donationId, + (int) $tier['id'] + ) + ); + if ( 1 === (int) $n ) { + $marked[] = (int) $tier['id']; + } + } + return $marked; + } + + /** + * Tiers unlocked by each donation, one query for the whole page: donation id => [ {title}, ... ] in target order. + * + * @param int[] $donationIds + * @return array> + */ + public function reachedByDonation( array $donationIds ): array { + $ids = array_values( array_unique( array_filter( array_map( 'intval', $donationIds ), static fn( $i ) => $i > 0 ) ) ); + if ( ! $ids ) { + return array(); + } + $in = implode( ',', array_fill( 0, count( $ids ), '%d' ) ); + $rows = $this->db->get_results( + $this->db->prepare( 'SELECT reached_donation_id, title FROM ' . $this->t( 'goal_tiers' ) . " WHERE reached_donation_id IN ($in) ORDER BY target_minor ASC, id ASC", ...$ids ), + ARRAY_A + ); + $out = array(); + foreach ( (array) $rows as $r ) { + $out[ (int) $r['reached_donation_id'] ][] = array( 'title' => (string) $r['title'] ); + } + return $out; + } + + /** + * Keep sg_goals.target_minor equal to the highest tier target. Leaves the goal untouched when it has no tiers. + * + * @return bool true when the goal row was set from tiers. + */ + public function syncGoalTarget( int $goalId ): bool { + $max = $this->db->get_var( $this->db->prepare( 'SELECT MAX(target_minor) FROM ' . $this->t( 'goal_tiers' ) . ' WHERE goal_id = %d', $goalId ) ); + if ( null === $max || (int) $max <= 0 ) { + return false; + } + $this->db->query( $this->db->prepare( 'UPDATE ' . $this->t( 'goals' ) . ' SET target_minor = %d WHERE id = %d', (int) $max, $goalId ) ); + return true; + } +} diff --git a/tests/Unit/OverlayTiersTest.php b/tests/Unit/OverlayTiersTest.php new file mode 100644 index 0000000..7a21e58 --- /dev/null +++ b/tests/Unit/OverlayTiersTest.php @@ -0,0 +1,119 @@ + array( 'id' => $r[0], 'target_minor' => $r[1], 'title' => $r[2], 'description' => 'd' . $r[0], 'reached_at' => in_array( $r[0], $reached, true ) ? '2026-01-01 00:00:00' : null ), $rows ); + } + + private function svc( array $tiers, int $raised, array $db = array(), array $unlocked = array(), ?object &$probe = null ): OverlayService { + $probe = new class( $tiers, $raised, $db, $unlocked ) implements OverlayDataSource, RecentDonationsSource, TiersSource { + public int $reachedQueries = 0; + public function __construct( private array $tiers, private int $raised, private array $db, private array $unlocked ) {} + public function activeGoal(): ?array { return array( 'id' => 7, 'title' => 'Stream', 'currency' => 'USD', 'target_minor' => 50000 ); } + public function raisedMinor( array $goal ): int { return $this->raised; } + public function stateValue( int $goalId, string $key ): ?string { return null; } + public function counter( int $goalId ): array { return array( 'label' => '', 'value' => 0 ); } + public function bonusesFor( array $ids ): array { return array(); } + public function donations( ?int $sinceId, int $limit ): array { return $this->db; } + public function recentDonations( int $limit ): array { return $this->db; } + public function tiersFor( int $goalId ): array { return $this->tiers; } + public function tiersReachedFor( array $ids ): array { ++$this->reachedQueries; return $this->unlocked; } + }; + return new OverlayService( $probe ); + } + + private function row( int $id ): array { + return array( 'id' => $id, 'base_minor' => 2500, 'currency' => 'USD', 'donor_name' => 'Al', 'is_anonymous' => 0, 'message' => '', 'status' => 'completed', 'moderation' => 'approved' ); + } + + public function test_untiered_goal_payload_is_unchanged(): void { + $g = Payloads::goal( array( 'title' => 'G', 'currency' => 'USD', 'target_minor' => 20000 ), 5000 ); + $this->assertArrayNotHasKey( 'tiers', $g ); + $this->assertSame( 25, $g['percent'] ); + $this->assertSame( $g, Payloads::goal( array( 'title' => 'G', 'currency' => 'USD', 'target_minor' => 20000 ), 5000, array() ) ); + $this->assertArrayNotHasKey( 'tiers', $this->svc( array(), 100 )->payload( 'goal', 1 ) ); + } + + public function test_tiered_goal_percent_is_within_tier_and_displays(): void { + $g = $this->svc( $this->tiers( array( 1 ) ), 17500 )->payload( 'goal', 1 ); + $this->assertSame( 50, $g['percent'] ); + $this->assertSame( 17500, $g['raised_minor'] ); + $this->assertSame( '$175.00', $g['raised_display'] ); + $this->assertSame( 25000, $g['target_minor'] ); + $this->assertSame( '$250.00', $g['target_display'] ); + $t = $g['tiers']; + $this->assertSame( 3, $t['count'] ); + $this->assertSame( 2, $t['index'] ); + $this->assertFalse( $t['all_reached'] ); + $this->assertSame( array( 'title' => 'Microphone', 'description' => 'd2', 'target_minor' => 25000, 'target_display' => '$250.00', 'floor_minor' => 10000 ), $t['current'] ); + } + + public function test_tiered_goal_below_first_tier_and_all_reached(): void { + $g = $this->svc( $this->tiers(), 2500 )->payload( 'goal', 1 ); + $this->assertSame( 25, $g['percent'] ); + $this->assertSame( 1, $g['tiers']['index'] ); + $this->assertSame( 0, $g['tiers']['current']['floor_minor'] ); + $all = $this->svc( $this->tiers( array( 1, 2, 3 ) ), 60000 )->payload( 'goal', 1 ); + $this->assertSame( 100, $all['percent'] ); + $this->assertTrue( $all['tiers']['all_reached'] ); + $this->assertNull( $all['tiers']['current'] ); + $this->assertSame( 3, $all['tiers']['index'] ); + $this->assertSame( '$500.00', $all['target_display'] ); + $this->assertSame( '$600.00', $all['raised_display'] ); + } + + public function test_tier_text_is_sanitized(): void { + $t = $this->tiers(); + $t[0]['title'] = 'Hi' . str_repeat( 'a', 300 ); + $g = $this->svc( $t, 0 )->payload( 'goal', 1 ); + $this->assertStringNotContainsString( '<', $g['tiers']['current']['title'] ); + $this->assertLessThanOrEqual( 120, mb_strlen( $g['tiers']['current']['title'] ) ); + } + + public function test_alert_tiers_in_since_and_recent_with_one_query(): void { + $probe = null; + $svc = $this->svc( array(), 0, array( $this->row( 3 ), $this->row( 4 ) ), array( 3 => array( array( 'title' => 'Giveaway' ), array( 'title' => 'Microphone' ) ) ), $probe ); + $since = $svc->payload( 'alerts', 1, 0 ); + $this->assertSame( 1, $probe->reachedQueries ); + $recent = $svc->payload( 'alerts', 1, null, true ); + $this->assertSame( 2, $probe->reachedQueries ); + $this->assertSame( $since['alerts'], $recent['alerts'] ); + $this->assertSame( array( array( 'title' => 'Giveaway' ), array( 'title' => 'Microphone' ) ), $recent['alerts'][0]['tiers'] ); + $this->assertSame( array(), $recent['alerts'][1]['tiers'] ); + $svc->payload( 'alerts', 1, null ); // baseline poll: no lookup + $this->assertSame( 2, $probe->reachedQueries ); + } + + public function test_alert_tier_events_sanitized_and_capped(): void { + $ev = array( array( 'title' => 'Hi' ), array( 'title' => '' ), 'junk', array( 'title' => str_repeat( 'é', 200 ) ) ); + for ( $i = 0; $i < 9; $i++ ) { + $ev[] = array( 'title' => "T$i" ); + } + $out = Payloads::tierEvents( $ev ); + $this->assertCount( 5, $out ); + $this->assertSame( array( 'title' => 'Hi' ), $out[0] ); + $this->assertSame( 80, mb_strlen( $out[1]['title'] ) ); + $this->assertSame( array(), Payloads::tierEvents( 'nope' ) ); + } + + public function test_etag_changes_when_a_tier_unlocks_or_current_tier_moves(): void { + $a = Payloads::etag( $this->svc( array(), 0, array( $this->row( 3 ) ) )->payload( 'alerts', 1, null, true ) ); + $b = Payloads::etag( $this->svc( array(), 0, array( $this->row( 3 ) ), array( 3 => array( array( 'title' => 'X' ) ) ) )->payload( 'alerts', 1, null, true ) ); + $this->assertNotSame( $a, $b ); + $g1 = Payloads::etag( $this->svc( $this->tiers(), 9000 )->payload( 'goal', 1 ) ); + $g2 = Payloads::etag( $this->svc( $this->tiers( array( 1 ) ), 10000 )->payload( 'goal', 1 ) ); + $this->assertNotSame( $g1, $g2 ); + } +} diff --git a/tests/Unit/TierPolicyTest.php b/tests/Unit/TierPolicyTest.php new file mode 100644 index 0000000..66322fc --- /dev/null +++ b/tests/Unit/TierPolicyTest.php @@ -0,0 +1,142 @@ + $id, 'target_minor' => $t, 'title' => $title, 'description' => '', 'reached_at' => in_array( $id, $reachedIds, true ) ? '2026-01-01 00:00:00' : null ); + } + return array_reverse( $out ); // unsorted on purpose + } + + public function test_current_tier_and_index(): void { + $this->assertSame( 1, TierPolicy::currentTier( $this->tiers() )['id'] ); + $this->assertSame( 1, TierPolicy::currentIndex( $this->tiers() ) ); + $this->assertSame( 3, TierPolicy::currentTier( $this->tiers( array( 1, 2 ) ) )['id'] ); + $this->assertSame( 3, TierPolicy::currentIndex( $this->tiers( array( 1, 2 ) ) ) ); + $this->assertNull( TierPolicy::currentTier( $this->tiers( array( 1, 2, 3 ) ) ) ); + $this->assertSame( 3, TierPolicy::currentIndex( $this->tiers( array( 1, 2, 3 ) ) ) ); + $this->assertTrue( TierPolicy::allReached( $this->tiers( array( 1, 2, 3 ) ) ) ); + $this->assertFalse( TierPolicy::allReached( $this->tiers( array( 1 ) ) ) ); + $this->assertFalse( TierPolicy::allReached( array() ) ); + $this->assertSame( 0, TierPolicy::currentIndex( array() ) ); + } + + public function test_floor(): void { + $this->assertSame( 0, TierPolicy::floorMinor( $this->tiers() ) ); + $this->assertSame( 10000, TierPolicy::floorMinor( $this->tiers( array( 1 ) ) ) ); + $this->assertSame( 25000, TierPolicy::floorMinor( $this->tiers( array( 1, 2 ) ) ) ); + $this->assertSame( 50000, TierPolicy::floorMinor( $this->tiers( array( 1, 2, 3 ) ) ), 'all reached: top target' ); + } + + public function test_percent_within_tier_clamped(): void { + $this->assertSame( 0, TierPolicy::percent( 0, 0, 10000 ) ); + $this->assertSame( 50, TierPolicy::percent( 5000, 0, 10000 ) ); + $this->assertSame( 50, TierPolicy::percent( 17500, 10000, 25000 ) ); + $this->assertSame( 0, TierPolicy::percent( 10000, 10000, 25000 ), 'exactly at the floor' ); + $this->assertSame( 0, TierPolicy::percent( 500, 10000, 25000 ), 'raised below the floor clamps to 0' ); + $this->assertSame( 100, TierPolicy::percent( 25000, 10000, 25000 ), 'exactly at the target' ); + $this->assertSame( 100, TierPolicy::percent( 99999, 10000, 25000 ), 'above clamps to 100' ); + $this->assertSame( 0, TierPolicy::percent( 5, 100, 100 ), 'degenerate range, not reached' ); + $this->assertSame( 100, TierPolicy::percent( 100, 100, 100 ), 'degenerate range, reached' ); + } + + public function test_percent_for_walks_the_ladder(): void { + $this->assertSame( 25, TierPolicy::percentFor( $this->tiers(), 2500 ) ); + $this->assertSame( 0, TierPolicy::percentFor( $this->tiers( array( 1 ) ), 10000 ) ); + $this->assertSame( 50, TierPolicy::percentFor( $this->tiers( array( 1 ) ), 17500 ) ); + $this->assertSame( 100, TierPolicy::percentFor( $this->tiers( array( 1, 2, 3 ) ), 60000 ) ); + $this->assertSame( 0, TierPolicy::percentFor( array(), 500 ) ); + $this->assertSame( 7500, TierPolicy::remainingMinor( $this->tiers(), 2500 ) ); + $this->assertSame( 0, TierPolicy::remainingMinor( $this->tiers( array( 1, 2, 3 ) ), 60000 ) ); + } + + public function test_newly_reached_several_in_one_donation_in_order(): void { + $ids = array_column( TierPolicy::newlyReached( $this->tiers(), 30000 ), 'id' ); + $this->assertSame( array( 1, 2 ), $ids ); + $this->assertSame( array( 1, 2, 3 ), array_column( TierPolicy::newlyReached( $this->tiers(), 50000 ), 'id' ), 'exactly at the last target counts' ); + $this->assertSame( array(), TierPolicy::newlyReached( $this->tiers(), 9999 ) ); + $this->assertSame( array( 2 ), array_column( TierPolicy::newlyReached( $this->tiers( array( 1 ) ), 30000 ), 'id' ), 'reached ones are skipped' ); + } + + public function test_replay_is_idempotent_at_policy_level(): void { + $tiers = $this->tiers(); + $first = TierPolicy::newlyReached( $tiers, 30000 ); + foreach ( $tiers as &$t ) { + if ( in_array( $t['id'], array_column( $first, 'id' ), true ) ) { + $t['reached_at'] = '2026-02-02 00:00:00'; + } + } + unset( $t ); + $this->assertSame( array(), TierPolicy::newlyReached( $tiers, 30000 ) ); + $this->assertSame( array(), TierPolicy::newlyReached( $tiers, 12000 ), 'a lower total (refund) never un-reaches or re-reaches' ); + } + + public function test_derived_target_is_highest(): void { + $this->assertSame( 50000, TierPolicy::derivedGoalTarget( $this->tiers() ) ); + $this->assertSame( 0, TierPolicy::derivedGoalTarget( array() ) ); + } + + public function test_status(): void { + $t = $this->tiers( array( 1 ) ); + $by = array(); + foreach ( $t as $row ) { + $by[ $row['id'] ] = TierPolicy::status( $t, $row ); + } + $this->assertSame( array( 3 => 'upcoming', 2 => 'current', 1 => 'reached' ), $by ); + } + + /* ------------------------------------------------------------ validation */ + + private function v( ?int $target, string $title = 'Mic', string $desc = '', ?int $edit = null, int $raised = 0, ?array $tiers = null ): array { + return TierPolicy::validate( $tiers ?? $this->tiers( array( 1 ) ), $edit, $target, $title, $desc, $raised, 100, '$1.00' ); + } + + public function test_valid_new_tier(): void { + $r = $this->v( 70000, ' New desk ', ' nice ', null, 12000 ); + $this->assertNull( $r['error'] ); + $this->assertSame( array( 'target_minor' => 70000, 'title' => 'New desk', 'description' => 'nice' ), $r['data'] ); + } + + public function test_rejects_bad_values(): void { + $this->assertNotNull( $this->v( null )['error'] ); + $this->assertNotNull( $this->v( 0 )['error'] ); + $this->assertStringContainsString( 'minimum', (string) $this->v( 50 )['error'] ); + $this->assertStringContainsString( 'title', (string) $this->v( 70000, ' ' )['error'] . ' title' ); + $this->assertNotNull( $this->v( 70000, ' ' )['error'] ); + $this->assertNotNull( $this->v( 70000, str_repeat( 'a', 121 ) )['error'] ); + $this->assertNull( $this->v( 70000, str_repeat( 'a', 120 ) )['error'] ); + $this->assertNotNull( $this->v( 70000, 'x', str_repeat( 'd', 256 ) )['error'] ); + $this->assertNull( $this->v( 70000, 'x', str_repeat( 'd', 255 ) )['error'] ); + } + + public function test_target_must_be_unique_and_above_raised(): void { + $this->assertStringContainsString( 'already', (string) $this->v( 25000 )['error'] ); + $this->assertStringContainsString( 'already raised', (string) $this->v( 20000, 'x', '', null, 20000 )['error'], 'equal to raised unlocks instantly' ); + $this->assertNull( $this->v( 20001, 'x', '', null, 20000 )['error'] ); + } + + public function test_reached_tier_target_is_locked_but_text_editable(): void { + $r = $this->v( 999999, 'Renamed', 'd', 1, 12000 ); + $this->assertNull( $r['error'] ); + $this->assertSame( 10000, $r['data']['target_minor'] ); + $this->assertSame( 'Renamed', $r['data']['title'] ); + $r2 = $this->v( null, 'Renamed', '', 1, 12000 ); + $this->assertSame( 10000, $r2['data']['target_minor'] ); + } + + public function test_edit_unreached_keeps_or_moves_target(): void { + $this->assertNull( $this->v( 25000, 'Mic2', '', 2, 12000 )['error'], 'unchanged target is fine' ); + $this->assertNull( $this->v( 30000, 'Mic', '', 2, 12000 )['error'] ); + $this->assertStringContainsString( 'already', (string) $this->v( 50000, 'Mic', '', 2, 12000 )['error'] ); + $this->assertStringContainsString( 'no longer', (string) $this->v( 30000, 'Mic', '', 99, 12000 )['error'] ); + } +} diff --git a/tests/Unit/TierRepositoryTest.php b/tests/Unit/TierRepositoryTest.php new file mode 100644 index 0000000..df90101 --- /dev/null +++ b/tests/Unit/TierRepositoryTest.php @@ -0,0 +1,113 @@ +sql[] = $q; return array_shift( $this->queryResults ) ?? 1; } + public function get_results( string $q, $o = null ): array { $this->sql[] = $q; return $this->rows; } + public function get_var( string $q ) { $this->sql[] = $q; return $this->var; } + public function insert( string $t, array $d, array $f ) { $this->sql[] = 'INSERT ' . $t . ' ' . json_encode( $d ); return 1; } + }; + } + + private function row( int $id, int $target, ?string $reached = null ): array { + return array( 'id' => (string) $id, 'goal_id' => '7', 'target_minor' => (string) $target, 'title' => "T$id", 'description' => '', 'reached_at' => $reached, 'reached_donation_id' => null, 'created_at' => '2026-01-01 00:00:00' ); + } + + public function test_for_goal_orders_by_target_and_casts(): void { + $db = $this->fake( array( $this->row( 1, 10000 ) ) ); + $rows = ( new TierRepository( $db ) )->forGoal( 7 ); + $this->assertStringContainsString( 'WHERE goal_id = 7 ORDER BY target_minor ASC', $db->sql[0] ); + $this->assertSame( 10000, $rows[0]['target_minor'] ); + $this->assertNull( $rows[0]['reached_at'] ); + } + + public function test_mark_reached_is_atomic_per_tier_and_only_for_reachable(): void { + $db = $this->fake( array( $this->row( 1, 10000 ), $this->row( 2, 25000 ), $this->row( 3, 50000 ), $this->row( 4, 5000, '2026-01-01 00:00:00' ) ) ); + $marked = ( new TierRepository( $db ) )->markReached( 7, 30000, 55 ); + $this->assertSame( array( 1, 2 ), $marked ); + $updates = array_values( array_filter( $db->sql, static fn( $q ) => str_starts_with( $q, 'UPDATE' ) ) ); + $this->assertCount( 2, $updates ); + foreach ( $updates as $q ) { + $this->assertStringContainsString( 'reached_at IS NULL', $q ); + $this->assertStringContainsString( 'reached_donation_id = 55', $q ); + $this->assertStringContainsString( 'UPDATE wp_sg_goal_tiers', $q ); + } + } + + public function test_mark_reached_replay_loses_race_and_reports_nothing(): void { + $db = $this->fake( array( $this->row( 1, 10000 ) ) ); + $db->queryResults = array( 0 ); // someone else already marked it + $this->assertSame( array(), ( new TierRepository( $db ) )->markReached( 7, 30000, 55 ) ); + } + + public function test_mark_reached_ignores_invalid_ids(): void { + $db = $this->fake( array( $this->row( 1, 10000 ) ) ); + $this->assertSame( array(), ( new TierRepository( $db ) )->markReached( 0, 30000, 55 ) ); + $this->assertSame( array(), ( new TierRepository( $db ) )->markReached( 7, 30000, 0 ) ); + $this->assertSame( array(), $db->sql ); + } + + public function test_reached_by_donation_is_one_query_and_grouped(): void { + $db = $this->fake( array( array( 'reached_donation_id' => '5', 'title' => 'A' ), array( 'reached_donation_id' => '5', 'title' => 'B' ), array( 'reached_donation_id' => '6', 'title' => 'C' ) ) ); + $out = ( new TierRepository( $db ) )->reachedByDonation( array( 5, 6, 6, 0, -1 ) ); + $this->assertCount( 1, $db->sql ); + $this->assertStringContainsString( 'reached_donation_id IN (5,6)', $db->sql[0] ); + $this->assertSame( array( 5 => array( array( 'title' => 'A' ), array( 'title' => 'B' ) ), 6 => array( array( 'title' => 'C' ) ) ), $out ); + $this->assertSame( array(), ( new TierRepository( $this->fake() ) )->reachedByDonation( array() ) ); + } + + public function test_sync_goal_target_sets_highest_and_skips_untiered(): void { + $db = $this->fake( array(), '50000' ); + $this->assertTrue( ( new TierRepository( $db ) )->syncGoalTarget( 7 ) ); + $this->assertStringContainsString( 'MAX(target_minor)', $db->sql[0] ); + $this->assertStringContainsString( 'UPDATE wp_sg_goals SET target_minor = 50000 WHERE id = 7', $db->sql[1] ); + $none = $this->fake( array(), null ); + $this->assertFalse( ( new TierRepository( $none ) )->syncGoalTarget( 7 ) ); + $this->assertCount( 1, $none->sql, 'no UPDATE when the goal has no tiers' ); + } + + public function test_installer_defines_tier_table_unique_key_and_version(): void { + $src = (string) file_get_contents( dirname( __DIR__, 2 ) . '/includes/Core/Installer.php' ); + $this->assertSame( 1, preg_match( "/DB_VERSION = '(\\d+)'/", $src, $m ) ); + $this->assertGreaterThanOrEqual( 4, (int) $m[1] ); + $this->assertStringContainsString( 'CREATE TABLE {$p}goal_tiers (', $src ); + $this->assertStringContainsString( 'UNIQUE KEY goal_target (goal_id,target_minor)', $src ); + $this->assertStringContainsString( 'reached_donation_id BIGINT UNSIGNED NULL', $src ); + } + + public function test_donation_store_marks_tiers_before_close_at_target(): void { + $src = (string) file_get_contents( dirname( __DIR__, 2 ) . '/includes/PayPal/DonationStore.php' ); + $start = strpos( $src, 'function notify_applied' ); + $body = substr( $src, $start, strpos( $src, 'function close_goal_if_target_reached' ) - $start ); + $a = strpos( $body, 'Recorder::forDonation' ); + $tier = strpos( $body, 'Tiers\\Recorder::forDonation' ); + $close = strpos( $body, 'self::close_goal_if_target_reached' ); + $this->assertNotFalse( $tier ); + $this->assertNotFalse( $a ); + $this->assertLessThan( $tier, strpos( $body, 'call_engine' ), 'engine first' ); + $this->assertLessThan( $close, $tier, 'tiers before the close check' ); + } +}