aboutsummaryrefslogtreecommitdiff
path: root/tests/models/thl/test_contest/test_leaderboard_contest.py
blob: 98f3215009319aeb7c9dc4c30f207295e7b235da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
from datetime import timezone
from uuid import uuid4

import pytest

from generalresearch.currency import USDCent
from generalresearch.managers.leaderboard.manager import LeaderboardManager
from generalresearch.models.thl.contest import ContestPrize
from generalresearch.models.thl.contest.definitions import (
    ContestType,
    ContestPrizeKind,
)
from generalresearch.models.thl.contest.leaderboard import (
    LeaderboardContest,
)
from generalresearch.models.thl.contest.utils import (
    distribute_leaderboard_prizes,
)
from generalresearch.models.thl.leaderboard import LeaderboardRow
from tests.models.thl.test_contest.test_contest import TestContest


class TestLeaderboardContest(TestContest):

    @pytest.fixture
    def leaderboard_contest(
        self, product, thl_redis, user_manager
    ) -> "LeaderboardContest":
        board_key = f"leaderboard:{product.uuid}:us:weekly:2025-05-26:complete_count"

        c = LeaderboardContest(
            uuid=uuid4().hex,
            product_id=product.uuid,
            contest_type=ContestType.LEADERBOARD,
            leaderboard_key=board_key,
            name="$15 1st place, $10 2nd, $5 3rd place US weekly",
            prizes=[
                ContestPrize(
                    name="$15 Cash",
                    estimated_cash_value=USDCent(15_00),
                    cash_amount=USDCent(15_00),
                    kind=ContestPrizeKind.CASH,
                    leaderboard_rank=1,
                ),
                ContestPrize(
                    name="$10 Cash",
                    estimated_cash_value=USDCent(10_00),
                    cash_amount=USDCent(10_00),
                    kind=ContestPrizeKind.CASH,
                    leaderboard_rank=2,
                ),
                ContestPrize(
                    name="$5 Cash",
                    estimated_cash_value=USDCent(5_00),
                    cash_amount=USDCent(5_00),
                    kind=ContestPrizeKind.CASH,
                    leaderboard_rank=3,
                ),
            ],
        )
        c._redis_client = thl_redis
        c._user_manager = user_manager
        return c

    def test_init(self, leaderboard_contest, thl_redis, user_1, user_2):
        model = leaderboard_contest.leaderboard_model
        assert leaderboard_contest.end_condition.ends_at is not None

        lbm = LeaderboardManager(
            redis_client=thl_redis,
            board_code=model.board_code,
            country_iso=model.country_iso,
            freq=model.freq,
            product_id=leaderboard_contest.product_id,
            within_time=model.period_start_local,
        )

        lbm.hit_complete_count(product_user_id=user_1.product_user_id)
        lbm.hit_complete_count(product_user_id=user_2.product_user_id)
        lbm.hit_complete_count(product_user_id=user_2.product_user_id)

        lb = leaderboard_contest.get_leaderboard()
        print(lb)

    def test_win(self, leaderboard_contest, thl_redis, user_1, user_2, user_3):
        model = leaderboard_contest.leaderboard_model
        lbm = LeaderboardManager(
            redis_client=thl_redis,
            board_code=model.board_code,
            country_iso=model.country_iso,
            freq=model.freq,
            product_id=leaderboard_contest.product_id,
            within_time=model.period_start_local.astimezone(tz=timezone.utc),
        )

        lbm.hit_complete_count(product_user_id=user_1.product_user_id)
        lbm.hit_complete_count(product_user_id=user_1.product_user_id)

        lbm.hit_complete_count(product_user_id=user_2.product_user_id)

        lbm.hit_complete_count(product_user_id=user_3.product_user_id)

        leaderboard_contest.end_contest()
        assert len(leaderboard_contest.all_winners) == 3

        # Prizes are $15, $10, $5. user 2 and 3 ties for 2nd place, so they split (10 + 5)
        assert leaderboard_contest.all_winners[0].awarded_cash_amount == USDCent(15_00)
        assert (
            leaderboard_contest.all_winners[0].user.product_user_id
            == user_1.product_user_id
        )
        assert leaderboard_contest.all_winners[0].prize == leaderboard_contest.prizes[0]
        assert leaderboard_contest.all_winners[1].awarded_cash_amount == USDCent(
            15_00 / 2
        )
        assert leaderboard_contest.all_winners[2].awarded_cash_amount == USDCent(
            15_00 / 2
        )


class TestLeaderboardContestPrizes:

    def test_distribute_prizes_1(self):
        prizes = [USDCent(15_00)]
        leaderboard_rows = [
            LeaderboardRow(bpuid="a", value=20, rank=1),
            LeaderboardRow(bpuid="b", value=10, rank=2),
        ]
        result = distribute_leaderboard_prizes(prizes, leaderboard_rows)

        # a gets first prize, b gets nothing.
        assert result == {
            "a": USDCent(15_00),
        }

    def test_distribute_prizes_2(self):
        prizes = [USDCent(15_00), USDCent(10_00)]
        leaderboard_rows = [
            LeaderboardRow(bpuid="a", value=20, rank=1),
            LeaderboardRow(bpuid="b", value=10, rank=2),
        ]
        result = distribute_leaderboard_prizes(prizes, leaderboard_rows)

        # a gets first prize, b gets 2nd prize
        assert result == {
            "a": USDCent(15_00),
            "b": USDCent(10_00),
        }

    def test_distribute_prizes_3(self):
        prizes = [USDCent(15_00), USDCent(10_00)]
        leaderboard_rows = [
            LeaderboardRow(bpuid="a", value=20, rank=1),
        ]
        result = distribute_leaderboard_prizes(prizes, leaderboard_rows)

        # A gets first prize, no-one gets $10
        assert result == {
            "a": USDCent(15_00),
        }

    def test_distribute_prizes_4(self):
        prizes = [USDCent(15_00)]
        leaderboard_rows = [
            LeaderboardRow(bpuid="a", value=20, rank=1),
            LeaderboardRow(bpuid="b", value=20, rank=1),
            LeaderboardRow(bpuid="c", value=20, rank=1),
            LeaderboardRow(bpuid="d", value=20, rank=1),
        ]
        result = distribute_leaderboard_prizes(prizes, leaderboard_rows)

        # 4-way tie for the $15 prize; it gets split
        assert result == {
            "a": USDCent(3_75),
            "b": USDCent(3_75),
            "c": USDCent(3_75),
            "d": USDCent(3_75),
        }

    def test_distribute_prizes_5(self):
        prizes = [USDCent(15_00), USDCent(10_00)]
        leaderboard_rows = [
            LeaderboardRow(bpuid="a", value=20, rank=1),
            LeaderboardRow(bpuid="b", value=20, rank=1),
            LeaderboardRow(bpuid="c", value=10, rank=3),
        ]
        result = distribute_leaderboard_prizes(prizes, leaderboard_rows)

        # 2-way tie for the $15 prize; the top two prizes get split. Rank 3
        # and below get nothing
        assert result == {
            "a": USDCent(12_50),
            "b": USDCent(12_50),
        }

    def test_distribute_prizes_6(self):
        prizes = [USDCent(15_00), USDCent(10_00), USDCent(5_00)]
        leaderboard_rows = [
            LeaderboardRow(bpuid="a", value=20, rank=1),
            LeaderboardRow(bpuid="b", value=10, rank=2),
            LeaderboardRow(bpuid="c", value=10, rank=2),
            LeaderboardRow(bpuid="d", value=10, rank=2),
        ]
        result = distribute_leaderboard_prizes(prizes, leaderboard_rows)

        # A gets first prize, 3 way tie for 2nd rank: they split the 2nd and
        #   3rd place prizes (10 + 5)/3
        assert result == {
            "a": USDCent(15_00),
            "b": USDCent(5_00),
            "c": USDCent(5_00),
            "d": USDCent(5_00),
        }