Favorite feature #117

jrauh01 · 2025-01-03T08:57:31Z

This PR introduces the ability to mark resources as favorites in the resource lists. A star icon appears when hovering over a list item, allowing users to toggle resources as favorites. Once a favorite is added, a new list with the favorites is displayed above the main resource list, with the star icon permanently visible for these items. Favorites are stored per user. Additionally to resource uuid and username the resource's kind is stored to optimize database queries.

Planned features:

A list summarizing all favorites across all resource types
Customizable order of the favorites via drag & drop

Closes #107

library/Kubernetes/Model/Favorite.php

library/Kubernetes/Common/Links.php

application/controllers/FavoriteController.php

lippserd · 2025-01-16T19:01:06Z

application/controllers/FavoriteController.php

+                            ]
+                        );
+                    }
+                } catch (\Exception $e) {


Always catch Throwable and import it.

lippserd · 2025-01-16T19:01:17Z

application/controllers/FavoriteController.php

+                        );
+                    }
+                } catch (\Exception $e) {
+                    die($e->getMessage());


Log and rethrow.

lippserd · 2025-01-16T19:03:28Z

application/controllers/FavoriteController.php

+                } catch (\Exception $e) {
+                    die($e->getMessage());
+                }
+                $this->getResponse()->setHeader('X-Icinga-Container', 'ignore', true)->sendResponse();


Why sendResponse()? A little comment block about the 3 lines explaining their purpose would be great.

Removed superfluous sendResponse() and disableLayout().

lippserd · 2025-01-16T19:05:32Z

library/Kubernetes/Model/Favorite.php

+        ]));
+    }
+
+    public function createRelations(Relations $relations)


Can be removed as it's empty.

lippserd · 2025-01-16T19:06:42Z

library/Kubernetes/Web/CronJobListItem.php

@@ -110,6 +114,28 @@ protected function assembleTitle(BaseHtmlElement $title): void

    protected function assembleVisual(BaseHtmlElement $visual): void
    {
-        $visual->addHtml(new StateBall('none', StateBall::SIZE_MEDIUM));
+        $size = match ($this->getViewMode()) {
+            ViewModeSwitcher::VIEW_MODE_MINIMAL, ViewModeSwitcher::VIEW_MODE_COMMON => 'sm',


I would split the lines here.

lippserd · 2025-01-16T19:15:03Z

library/Kubernetes/Web/DetailState.php

+
+    protected $tag = 'span';
+
+    public function __construct(string $state)


Use constructor property promotion everywhere.

lippserd · 2025-01-16T19:17:33Z

library/Kubernetes/Web/ListController.php

@@ -94,8 +97,42 @@ public function indexAction(): void
        $this->addControl($viewModeSwitcher);
        $this->addControl($searchBar);

+        $favorites = Favorite::on(Database::connection())->execute();


No need to call execute(). Also for the other places in this file. Do you know why?

It also loads every favorite for every resource type. This is not good. The implementation should be changed so that the favorites can be differentiated per resource type. This would allow favorites to be loaded as follows:

SELECT * FROM pod WHERE pod.uuid IN (SELECT resource_uuid FROM favorite WHERE kind = "pod") AND ...

execute() is not necessary because ::on() returns a Query which implements IteratorAggregate. The implemented method getIterator() executes the query.

~~Regarding the sql statement, I think we could also do it as follows, so we don't have to change the schema and save the kind:~~
~~SELECT * FROM favorite WHERE favorite.reference_uuid IN (SELECT uuid FROM pod) AND ...~~

~~Would like to hear your opinion.~~

lippserd · 2025-01-16T19:23:17Z

library/Kubernetes/Web/ListController.php

+            $favoriteResources = $modelClass::on(Database::connection())
+                ->filter(
+                    Filter::all(
+                        $filter,


Filter for username missing, right?

lippserd · 2025-01-16T19:27:22Z

library/Kubernetes/Web/ListController.php

+                ->execute();
+        } else {
+            // Get empty ResultSet, otherwise all resources would be displayed as favorites
+            $favoriteResources = $modelClass::on(Database::connection())->filter(Filter::equal('uuid', 0))->execute();


Why do you add the favorites HTML if there are no favorites?

jrauh01 self-assigned this Jan 3, 2025

cla-bot bot added the cla/signed CLA is signed by all contributors of a PR label Jan 3, 2025

jrauh01 force-pushed the favorites branch from fcc72ab to b78f1e0 Compare January 3, 2025 13:24

jrauh01 changed the base branch from main to viewmodes January 3, 2025 13:25

jrauh01 changed the title ~~Favorites~~ Add favorite feature Jan 3, 2025

jrauh01 force-pushed the favorites branch 3 times, most recently from 19dfc74 to 942c6cd Compare January 7, 2025 15:40

jrauh01 changed the title ~~Add favorite feature~~ Favorite feature Jan 8, 2025

jrauh01 requested a review from lippserd January 8, 2025 08:09

lippserd requested a review from jhoxhaa January 13, 2025 07:18

jrauh01 force-pushed the favorites branch from 942c6cd to 130d4b2 Compare January 15, 2025 14:03

jrauh01 force-pushed the viewmodes branch 2 times, most recently from ea8dcfc to 3f467af Compare January 15, 2025 14:22

jrauh01 force-pushed the favorites branch 2 times, most recently from af500ea to 570585b Compare January 15, 2025 14:36

jhoxhaa requested changes Jan 15, 2025

View reviewed changes

library/Kubernetes/Model/Favorite.php Outdated Show resolved Hide resolved

library/Kubernetes/Common/Links.php Outdated Show resolved Hide resolved

application/controllers/FavoriteController.php Outdated Show resolved Hide resolved

jrauh01 force-pushed the favorites branch from 570585b to 6bb1d39 Compare January 16, 2025 09:19

jrauh01 requested a review from jhoxhaa January 16, 2025 09:19

jhoxhaa approved these changes Jan 16, 2025

View reviewed changes

jrauh01 force-pushed the favorites branch 2 times, most recently from f56cd0b to f0d7090 Compare January 16, 2025 13:06

lippserd requested changes Jan 16, 2025

View reviewed changes

jrauh01 requested a review from lippserd January 20, 2025 09:02

jrauh01 force-pushed the favorites branch from 7f17fcc to efa6f47 Compare January 23, 2025 07:05

jrauh01 force-pushed the viewmodes branch from d41c6cd to 3d7e2b3 Compare January 23, 2025 07:18

jrauh01 added 4 commits January 23, 2025 08:19

Use DetailState in resource details

ff58e77

Use only own action list

192e6dd

Add model for favorites

1ad1a80

Add feature to toggle favorites

da581cf

jrauh01 added 27 commits January 23, 2025 08:19

Show favorites in resource lists

3937ae9

Show favorite toggle only on hover

f4691a2

Add favorite toggle to all relevant resources

8a7a30e

Add favorite toggle to detailed view

5c1caea

Support view modes

5d0138c

Build data-icinga-detail-url out of names without dashes

7e3bd1c

Remove list titles

982980c

Show star icon permanently in favorite list

8c9f7b5

Show active list items correctly

c54b8d4

Remove multi select for action lists

7508870

Adjust visuals for view modes

59d2408

Adjust non-clickable header to new class

b5324b6

Fix license headers

c02f4c1

Add parameter type

94b4850

Use and log Throwable

4c85ea5

Remove empty function

29459d3

Split lines in match expressions

297b2fd

Use constructor property promotion

51df638

Add docs

bb2fa76

Add filter for username

1a0ce7e

Don't add empty favorites html

abd8cf5

Don't execute queries

90a976d

Add kind to favorite table

1b12ac6

Add docs

ab4febb

Adjust default traits for list item visuals

975fc43

Use canonicalized kind names

f073eed

Use size constants from StateBall

60e6fe8

jrauh01 force-pushed the favorites branch from efa6f47 to 60e6fe8 Compare January 23, 2025 07:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Favorite feature #117

Favorite feature #117

jrauh01 commented Jan 3, 2025 •

edited

Loading

lippserd Jan 16, 2025

lippserd Jan 16, 2025

lippserd Jan 16, 2025

jrauh01 Jan 17, 2025

lippserd Jan 16, 2025

lippserd Jan 16, 2025

lippserd Jan 16, 2025

lippserd Jan 16, 2025

lippserd Jan 16, 2025

jrauh01 Jan 20, 2025

jrauh01 Jan 20, 2025 •

edited

Loading

lippserd Jan 16, 2025

lippserd Jan 16, 2025


		protected $tag = 'span';

		public function __construct(string $state)

Favorite feature #117

Are you sure you want to change the base?

Favorite feature #117

Conversation

jrauh01 commented Jan 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jrauh01 Jan 20, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jrauh01 commented Jan 3, 2025 •

edited

Loading

jrauh01 Jan 20, 2025 •

edited

Loading