[Feature Branch] Implemented SavedView model #5639

HanlinMiao · 2024-04-26T17:31:32Z

Closes #1758

What's Changed

Screenshots

Implemented Saved View Model
SavedView List View

SavedView Dropdown List

SavedView modal form

TODO

Explanation of Change(s)
Added change log fragment(s) (for more information see the documentation)
Attached Screenshots, Payload Example
Unit, Integration Tests
Documentation Updates (when adding/changing features)
Example App Updates (when adding/changing features)
Outline Remaining Work, Constraints from Design

changes/1758.dependencies

nautobot/core/models/__init__.py

nautobot/core/tables.py

nautobot/core/templates/generic/object_list.html

nautobot/users/models.py

nautobot/users/navigation.py

nautobot/users/tables.py

nautobot/users/templates/users/advanced_settings_edit.html

nautobot/users/views.py

HanlinMiao · 2024-04-29T21:09:51Z

Will have tests and documentation included in another PR

nautobot/core/models/generics.py

nautobot/users/tables.py

nautobot/core/tables.py

nautobot/core/templates/generic/object_list.html

nautobot/core/templates/inc/search_panel.html

nautobot/users/views.py

nautobot/users/models.py

nautobot/users/views.py

nautobot/core/templates/utilities/templatetags/saved_view_modal.html

… into one field config

nautobot/core/templates/generic/object_list.html

nautobot/core/templates/utilities/templatetags/saved_view_modal.html

nautobot/core/templatetags/helpers.py

glennmatthews · 2024-05-01T18:16:11Z

nautobot/core/views/generic.py

+                current_saved_view = SavedView.objects.restrict(request.user, "view").get(
+                    view=list_url, pk=current_saved_view_pk
+                )


What's needed for handling in case the requested view doesn't exist or can't be accessed by the user?

Would this be a reasonable extra layer of protection? Worst case scenario current_saved_view would be None

try: current_saved_view = SavedView.objects.restrict(request.user, "view").get(view=list_url, pk=current_saved_view_pk) except ObjectDoesNotExist: pass

Worth a try - hard to say for sure without trying it myself. At the very least might be good to do a messages.error(request, "Saved view <pk> not found") or similar?

nautobot/core/views/renderers.py

nautobot/users/models.py

nautobot/users/templates/users/advanced_settings_edit.html

timizuoebideri1 · 2024-05-07T08:35:40Z

nautobot/core/templates/generic/object_list.html

+                    <li>
+                        <a href="{% url 'user:savedview' pk=request.GET.saved_view %}">
+                            <i class="mdi mdi-arrow-u-right-bottom text-danger" aria-hidden="true"></i>
+                            <span class="text-danger">Clear View</span>


This, I assume, is used to undo all unsaved modifications to the view and restore the UI to its initial view state?

If so I don't think Clear View might be the right wording here

This actually updates the saved view to make it have no filters/tableconfig/etc. I'm still not convinced this is necessary/desirable functionality, personally.

timizuoebideri1 · 2024-05-07T08:37:51Z

nautobot/core/views/generic.py

    )

    def get_filter_params(self, request):
        """Helper function - take request.GET and discard any parameters that are not used for queryset filtering."""
        filter_params = request.GET.copy()
+        print(filter_params)


timizuoebideri1 · 2024-05-07T08:49:07Z

nautobot/core/views/generic.py

+        saved_views = (
+            SavedView.objects.filter(view=list_url).restrict(request.user, "view").order_by("name").only("pk", "name")
+        )


illd suggest this?:

saved_views = ( SavedView.objects.filter(view=list_url) .restrict(request.user, "view") )

then

Line 317

current_saved_view = saved_views.get(pk=current_saved_view_pk)

and
Line 370

"saved_views": saved_views.order_by("name").only("id", "name")

Might help in reusing code

…g, config, and pagination values (#5682) * Make 'saved_view=...' query param imply the correct filtering, sorting, config, and pagination values * Fix update behavior and create behavior when given an existing instance * Test fix

* added factories and some documentation * added api and view tests * filter test and ruff fix * include savedview.md in nav * delete print statement * user factory modifications * fix user unittest * delete comment * address PR feedback * add additional tests * factory changes * delete output.txt * added saved view clear view * added all_filters_removed non_filter_params * added tooltip title to asterik * added user guide for creating and updating saved view * added refereneces to user guide * completed user guide * refactor create saved view * address some pr feedback * refactored SavedViewModal * attempt to fix unittests * fix screenshots * specify is_saved_view_model=False on ComponentTemplateModel * added clear_view_modal * fixed saved view edit url * address pr feedback on user guide * fix all unittests * markdownlint * fix unittest * ruff * fix factory and tests * refactored SavedViewClearView to custom action on SavedViewUIViewSet * address PR feedback * ruff fix * pylint and unittest fixes * fix unittest * address pr feedabck * refactor and remove is_saved_view_model=False on StaticGroup * ruff fix * unittests * Enforce users:change_savedview instead of users:clear_savedview * pylint

nautobot/core/jobs/__init__.py

nautobot/core/models/generics.py

glennmatthews · 2024-05-16T17:38:09Z

nautobot/core/templates/generic/object_list.html

+                    <li>
+                        <a href="{% url 'user:savedview' pk=request.GET.saved_view %}">
+                            <i class="mdi mdi-arrow-u-right-bottom text-danger" aria-hidden="true"></i>
+                            <span class="text-danger">Clear View</span>


This actually updates the saved view to make it have no filters/tableconfig/etc. I'm still not convinced this is necessary/desirable functionality, personally.

nautobot/core/templates/generic/object_list.html

nautobot/core/views/mixins.py

glennmatthews · 2024-05-16T17:47:47Z

nautobot/core/views/renderers.py

+                saved_views = (
+                    SavedView.objects.filter(view=list_url)
+                    .restrict(request.user, "view")
+                    .order_by("name")
+                    .only("pk", "name")
+                )


can/should we gate this by model.is_saved_view_model?

glennmatthews · 2024-05-16T17:51:58Z

nautobot/users/models.py

+    config = models.JSONField(
+        encoder=DjangoJSONEncoder, blank=True, default=dict, help_text="Saved Configuration on this view"
+    )


Should we have a custom clean() implementation that enforces any particular structure on the config data?

I am not sure this is feasible right now because our factory is using randomized pydict data. All those would fail to be created if I assert any structures on the config data.

nautobot/users/models.py

nautobot/users/views.py

glennmatthews · 2024-05-17T12:49:25Z

nautobot/core/models/utils.py

    """
-    Find all models that have fields with the specified names, and return them grouped by app.
+    Find all models that have fields with the specified names and/or satisfy the additional constraints when the field names are not available,


Suggested change

Find all models that have fields with the specified names and/or satisfy the additional constraints when the field names are not available,

Find all models that have fields with the specified names and satisfy the additional constraints,

glennmatthews · 2024-05-17T12:52:54Z

nautobot/users/views.py

+        messages.success(request, f"Successfully updated current view {sv.name}")
+        return redirect(list_view_url)
+
+    def create(self, request, *args, **kwargs):


Can we create a common helper function for the shared bits of logic between create, update views as well as perhaps saved_view_modal and view_changes_not_saved? Just begins to seem like a lot of repetition.

I agree that there is a lot of repeated logic but they are all subtly different in some ways and need a lot of special case handling. I can open a follow-up issue for this.

…ookup

…into u/hanlin-#1758

HanlinMiao added 9 commits April 23, 2024 17:38

first commit

5d4b3ad

model changes

7ddb4ab

various changes to make update current view working

724bcd3

create new view complete

2680d0d

change savedview to a changelogged model

e5d3d0a

hacking table_config workflow together

3faa157

material design icons update

bc8d37c

Last UI changes

9aa873a

added changelogs

e097cd5

glennmatthews reviewed Apr 26, 2024

View reviewed changes

HanlinMiao added 5 commits April 29, 2024 12:50

address feedback from standup and PR

fe5a446

more refactoring

bbbafbd

added SavedViewMixin and refactored models based on that

c67e3a8

fix unittests

1e1ddd4

ruff fix

8f1bc7e

HanlinMiao added 2 commits April 29, 2024 18:01

unittests

3bc0370

unittests

a68ff5c

glennmatthews reviewed Apr 30, 2024

View reviewed changes

HanlinMiao added 2 commits April 30, 2024 13:29

address most PR feedback

e02063f

unittests

7af92ed

glennmatthews reviewed May 1, 2024

View reviewed changes

nautobot/users/views.py Outdated Show resolved Hide resolved

HanlinMiao added 2 commits May 1, 2024 10:44

resolve merge conflict

7ddb908

address PR feedback

8b17851

glennmatthews reviewed May 1, 2024

View reviewed changes

nautobot/core/templates/utilities/templatetags/saved_view_modal.html Outdated Show resolved Hide resolved

HanlinMiao added 2 commits May 1, 2024 13:25

refactor table_config, pagination_count, filter_params and sort_order…

7ebd5e4

… into one field config

address review feedback

dd73914

glennmatthews reviewed May 1, 2024

View reviewed changes

HanlinMiao added 2 commits May 1, 2024 14:21

use urllib.parse.urlencode

bb79122

address review feedback

455c7e3

HanlinMiao added 2 commits May 3, 2024 12:59

address PR feedback

2badfae

address PR feedback

1e3b671

timizuoebideri1 reviewed May 7, 2024

View reviewed changes

timizuoebideri1 approved these changes May 7, 2024

View reviewed changes

glennmatthews mentioned this pull request May 7, 2024

Make 'saved_view=...' query param imply the correct filtering, sorting, config, and pagination values #5682

Merged

2 tasks

glennmatthews and others added 4 commits May 8, 2024 10:38

merge conflicts

095fb12

fix clear_view_modal bug

8fc7ac5

glennmatthews reviewed May 16, 2024

View reviewed changes

HanlinMiao requested a review from glennmatthews May 16, 2024 18:00

HanlinMiao added 2 commits May 16, 2024 17:25

address PR feedback

c1a98ca

add json blob on saved_view_modal

c96e492

glennmatthews approved these changes May 17, 2024

View reviewed changes

HanlinMiao added 2 commits May 17, 2024 11:51

gray out json blob on saved_view_modal

58a2fab

move get_table_class_string_from_view_name() to nautobot.core.utils.l…

95d087b

…ookup

HanlinMiao mentioned this pull request May 17, 2024

Create a common helper function for saved view related functions #5727

Open

HanlinMiao and others added 9 commits May 17, 2024 13:49

merge conflict

0209722

Merge branch 'next' into u/hanlin-#1758

d409946

update migration file

fe7c9c6

Merge branch 'u/hanlin-#1758' of https://github.com/nautobot/nautobot …

3db7ef4

…into u/hanlin-#1758

include missing savedview doc

8388972

refactor StaticGroupFactory

853e2e1

Merge branch 'next' into u/hanlin-#1758

247acf6

unittests

c663cf2

Merge branch 'u/hanlin-#1758' of https://github.com/nautobot/nautobot …

6d6c013

…into u/hanlin-#1758

HanlinMiao merged commit b9f5b38 into next May 18, 2024
17 checks passed

HanlinMiao deleted the u/hanlin-#1758 branch May 18, 2024 19:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feature Branch] Implemented SavedView model #5639

[Feature Branch] Implemented SavedView model #5639

HanlinMiao commented Apr 26, 2024 •

edited

HanlinMiao commented Apr 29, 2024

glennmatthews May 1, 2024

HanlinMiao May 1, 2024

glennmatthews May 1, 2024

timizuoebideri1 May 7, 2024

timizuoebideri1 May 7, 2024

glennmatthews May 16, 2024

timizuoebideri1 May 7, 2024

timizuoebideri1 May 7, 2024

glennmatthews May 16, 2024

glennmatthews May 16, 2024

glennmatthews May 16, 2024

HanlinMiao May 16, 2024

glennmatthews May 17, 2024

glennmatthews May 17, 2024

HanlinMiao May 17, 2024

	Find all models that have fields with the specified names and/or satisfy the additional constraints when the field names are not available,
	Find all models that have fields with the specified names and satisfy the additional constraints,

[Feature Branch] Implemented SavedView model #5639

[Feature Branch] Implemented SavedView model #5639

Conversation

HanlinMiao commented Apr 26, 2024 • edited

Closes #1758

What's Changed

Screenshots

TODO

HanlinMiao commented Apr 29, 2024

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

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

HanlinMiao commented Apr 26, 2024 •

edited