feat(statistics): support for custom date ranges (#3622)

* feat: backend support for statistics custom date ranges * feat: use seconds-based timestamps on backend instead * feat: add frontend date selection option * feat: add tests for lifetime and timed stats * fix: add error alert when end date is after start date * fix: wrong label * fix: no data when start and end date are same day * fix: use utc dayjs for formatting custom date range on widget * chore: add dayjs as project dep * fix: make end date inclusive * feat: add integration test for custom date period * fix: incorrect ts expect error comment * fix: add missing type * fix: typing errors * fix(tests): remove type from class attribute definition * fix: extract default values to function body * fix: typo * chore: use small modal * fix: add missing `FormControl` class * fix: cast url params to int to enforce type * chore: `yarn format` Signed-off-by: Sami Mazouz <sychocouldy@gmail.com> Co-authored-by: Sami Mazouz <sychocouldy@gmail.com>
2025-08-06 08:27:42 +02:00 · 2022-09-29 12:12:54 +01:00
parent 973ec32e13
commit 76788efaba
9 changed files with 678 additions and 37 deletions
--- a/extensions/statistics/tests/integration/api/CanRequestLifetimeStatisticsTest.php
+++ b/extensions/statistics/tests/integration/api/CanRequestLifetimeStatisticsTest.php
@@ -0,0 +1,85 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * For detailed copyright and license information, please view the
+ * LICENSE file that was distributed with this source code.
+ */
+
+namespace Flarum\Statistics\tests\integration\api;
+
+use Carbon\Carbon;
+use Flarum\Testing\integration\RetrievesAuthorizedUsers;
+use Flarum\Testing\integration\TestCase;
+
+class CanRequestLifetimeStatisticsTest extends TestCase
+{
+    use RetrievesAuthorizedUsers;
+
+    /**
+     * @var Carbon
+     */
+    protected $nowTime;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->nowTime = Carbon::now();
+
+        $this->extension('flarum-statistics');
+
+        $this->prepareDatabase($this->getDatabaseData());
+    }
+
+    protected function getDatabaseData(): array
+    {
+        return [
+            'users' => [
+                ['id' => 1, 'username' => 'Muralf', 'email' => 'muralf@machine.local', 'is_email_confirmed' => 1],
+                ['id' => 2, 'username' => 'normal', 'email' => 'normal@machine.local', 'is_email_confirmed' => 1, 'joined_at' => $this->nowTime->subDays(1)],
+            ],
+            'discussions' => [
+                ['id' => 1, 'title' => __CLASS__, 'created_at' => $this->nowTime, 'last_posted_at' => Carbon::now(), 'user_id' => 1, 'first_post_id' => 1, 'comment_count' => 1],
+                ['id' => 2, 'title' => __CLASS__, 'created_at' => $this->nowTime->subDays(1), 'last_posted_at' => Carbon::now(), 'user_id' => 1, 'first_post_id' => 1, 'comment_count' => 1],
+                ['id' => 3, 'title' => __CLASS__, 'created_at' => $this->nowTime->subDays(1), 'last_posted_at' => Carbon::now(), 'user_id' => 1, 'first_post_id' => 1, 'comment_count' => 1],
+                ['id' => 4, 'title' => __CLASS__, 'created_at' => $this->nowTime->subDays(2), 'last_posted_at' => Carbon::now(), 'user_id' => 1, 'first_post_id' => 1, 'comment_count' => 1],
+            ],
+            'posts' => [
+                ['id' => 1, 'discussion_id' => 1, 'user_id' => 1, 'type' => 'comment', 'content' => '<t><p>Text</p></t>', 'is_private' => 0, 'number' => 1],
+                ['id' => 2, 'discussion_id' => 2, 'user_id' => 1, 'type' => 'comment', 'content' => '<t><p>Text</p></t>', 'is_private' => 0, 'number' => 1],
+                ['id' => 3, 'discussion_id' => 3, 'user_id' => 1, 'type' => 'comment', 'content' => '<t><p>Text</p></t>', 'is_private' => 0, 'number' => 1],
+                ['id' => 4, 'discussion_id' => 4, 'user_id' => 1, 'type' => 'comment', 'content' => '<t><p>Text</p></t>', 'is_private' => 0, 'number' => 1],
+                ['id' => 5, 'discussion_id' => 1, 'user_id' => 2, 'type' => 'comment', 'content' => '<t><p>Text</p></t>', 'is_private' => 0, 'number' => 2],
+            ],
+        ];
+    }
+
+    /**
+     * @test
+     */
+    public function can_request_lifetime_stats()
+    {
+        $response = $this->send(
+            $this->request('GET', '/api/statistics', ['authenticatedAs' => 1])->withQueryParams([
+                'period' => 'lifetime',
+            ])
+        );
+
+        $body = json_decode($response->getBody()->getContents(), true);
+
+        $db = $this->getDatabaseData();
+
+        $this->assertEquals(200, $response->getStatusCode());
+
+        $this->assertEqualsCanonicalizing(
+            [
+                'users' => count($db['users']),
+                'discussions' => count($db['discussions']),
+                'posts' => count($db['posts']),
+            ],
+            $body
+        );
+    }
+}