Fix admin pages when group has no organization #9010

seanh · 2024-10-11T12:39:52Z

Fix a crash on the admin page for editing an open or restricted group
when the group has no organization.

Problem

Open and restricted groups have admin pages that let Hypothesis admins
edit the group (type, name, organization, creator, description, scopes,
members). You go to https://hypothes.is/admin/groups, search for the
open or restricted group that you want, and click on that group's name
to go to the https://hypothes.is/admin/groups/<PUBID> admin page for
editing that group.

Private groups do not have admin pages, that's why many of the group
names on the the https://hypothes.is/admin/groups admin page aren't
linked: those are private groups.

Originally the only way to create an open or restricted group was via
the https://hypothes.is/admin/groups/new admin page, and that page
forces you to choose an organization for the open or restricted group to
belong to. The https://hypothes.is/admin/groups/<PUBID> page could
therefore assume that all open or restricted groups belong to an
organization.

Recently we've enabled users to create their own open or restricted
groups via the https://hypothes.is/groups/new page and groups created by
this page do not have organizations. Private groups created by this page
have never belonged to organizations. The open and restricted groups
that can now also be created don't have organizations either. A user
could also create a private group with no organization and then turn it
into an open or restricted group.

So for the first time it's now possible to have open and restricted
groups with no organizations. But the
https://hypothes.is/admin/groups/<PUBID> admin page for editing open
or restricted groups has two problems with this:

Loading the page crashes when the group has no organization
The form forces groups to belong to an organization, there's no
option for a group to not have an organization. So when editing
a group with no organization it'll force you to choose an
organization before you can make any other changes

Solution

This commit fixes the page to not crash when a group has no organization
and also adds a "-- None --" option to the form's organization dropdown
so that it no longer forces you to select an organization when creating
or editing a group.

As a side effect of these changes admins can now also use the
https://hypothes.is/admin/groups/new admin page to create open and
restricted groups with no organization, and some further fixes were
needed to prevent this from crashing.

Testing

Use either http://localhost:5000/admin/groups/new or http://localhost:5000/groups/new to create a restricted or open group with no organization and then use http://localhost:5000/admin/groups/<PUBID> to edit the group.

seanh · 2024-10-11T12:47:45Z

h/schemas/forms/admin/group.py

+ org_labels = ["-- None --"]
+ org_pubids = [""]


Add a -- None -- option to the organization dropdown (<select>) on the admin page for creating or editing an open or restricted group.

seanh · 2024-10-11T12:48:30Z

h/schemas/forms/admin/group.py

@@ -153,6 +157,7 @@ def __init__(self, *args):
 title=_("Organization"),
 description=_("Organization which this group belongs to"),
 widget=group_organization_select_widget,
+ missing=None,


Allow organization to be missing from create/edit group admin form submissions (this is what happens if the user chooses -- None --)

seanh · 2024-10-11T12:49:58Z

h/services/group_create.py

@@ -105,7 +105,7 @@ def _create(self, name, userid, type_flags, scopes, **kwargs):

 group_scopes = [GroupScope(scope=s) for s in scopes]

- if "organization" in kwargs:
+ if kwargs.get("organization"):


Allow GroupCreateService.create_*_group() to be called with an organization=None kwarg and this will have the same effect as if it were called with no organization kwarg at all. This is convenient from the caller's point of view (the caller is the admin pages view/schema code).

seanh · 2024-10-11T12:51:41Z

h/views/admin/groups.py

@@ -71,10 +71,16 @@ def post(self):
 def on_success(appstruct):
 """Create a group on successful validation of POSTed form data."""

- organization = self.organizations[appstruct["organization"]]
+ organization = self.organizations.get(appstruct["organization"])


Fix the create group admin page to not assume that appstruct (i.e. the submitted form fields) contains an organization whose value matches one of the keys in self.organizations. If the user selects -- None -- for the organization then appstruct["organization"] will be None and the local variable organization will end up being None

seanh · 2024-10-11T12:53:00Z

h/views/admin/groups.py

+ organization.authority
+ if organization
+ else self.request.default_authority


If the user selected -- None -- for the organization then organization will be None. In that case create a group belonging to the default authority.

seanh · 2024-10-11T12:55:45Z

h/views/admin/groups.py

@@ -175,7 +181,7 @@ def update(self):
 def on_success(appstruct):
 """Update the group resource on successful form validation."""

- organization = self.organizations[appstruct["organization"]]
+ organization = self.organizations.get(appstruct["organization"])


This is when updating an existing group as opposed to creating a new one. If the group has no organization then appstruct["organization"] will be None and organization will also be None

seanh · 2024-10-11T13:02:14Z

h/views/admin/groups.py

+ "organization": (
+ group.organization.pubid if group.organization else None
+ ),


This happens when loading the group edit page. If the group has no organization then group.organization will be None in which case we now set appstruct["organization"] to None which causes the form to render with -- None -- selected for the organization, rather than crashing during page load. (This was the original crash from #9009, but fixing this page load crash then reveals the various other crashes fixed above that happen when trying to actually submit the form).

seanh · 2024-10-11T13:03:48Z

tests/unit/h/services/group_create_test.py

+ """
+ If the caller passes no organization it creates a group with no organization.
+
+ This works both if the caller omits the `organization` kwarg entirely
+ and if the caller passes `organization=None`. It's convenient for the
+ caller to be able to do it either way.
+ """
+ if pass_kwarg:
+ kwargs = {"organization": None}
+ else:
+ kwargs = {}
+
+ group = svc.create_open_group(
+ "Anteater fans", creator.userid, scopes=origins, **kwargs
+ )


Repetitive tests, but that's how the existing tests are structured and it's a result of how the code is structured. I prefer the test repetition over getting clever in the tests, and don't want to take the time to restructure the code and rewrite all the tests right now.

robertknight · 2024-10-11T13:07:39Z

tests/unit/h/views/admin/groups_test.py

+ ):
+ return on_success(
+ {
+ # No "organization" in these on_success() kwargs.


There is an "organization" field, but it is None. Is that what you meant?

Fixed the comment

seanh · 2024-10-11T13:08:49Z

tests/unit/h/views/admin/groups_test.py

+ def test_read_renders_form_if_group_has_no_organization(
+ self, pyramid_request, group
+ ):
+ group.organization = None
+ view = GroupEditViews(GroupContext(group), pyramid_request)
+
+ response = view.read()
+
+ assert response["form"]["organization"] is None


This is the test for the original page load crash in #9009

seanh · 2024-10-11T14:23:19Z

h/schemas/forms/admin/group.py


- # Get the authority from the list of organisations based on the one
- # actually picked in the form
- authority = form.bindings["organizations"][value["organization"]].authority
+ if group := form.bindings.get("group"):
+ authority = group.authority
+ elif organization := value.get("organization"):
+ # If there's no group then fall back on the organization's authority
+ # (this happens when creating a new group as opposed to editing an
+ # existing one).
+ authority = form.bindings.get("organizations")[organization].authority
+ else:
+ # If there's no group or organisation then fall back on the default authority
+ # (this happens when creating a new group and selecting no organization
+ # for the group to belong to).
+ authority = form.bindings["request"].default_authority


The local variable authority is used below to validate that the group's creator and members (both of which the user can edit in the admin form) all belong to the same authority as the group. But authority has to be derived differently in different cases. There are 4 cases here:

When editing an existing group that does have an organization: in this case group.authority will be used

When editing an existing group that does not have an organization: again group.authority will be used

When creating a new group with an organization: organization.authority will be used

When creating a new group without an organization: request.default_authority will be used

Fix a crash on the admin page for editing an open or restricted group when the group has no organization. Fixes: #9009 Problem ------- Open and restricted groups have admin pages that let Hypothesis admins edit the group (type, name, organization, creator, description, scopes, members). You go to https://hypothes.is/admin/groups, search for the open or restricted group that you want, and click on that group's name to go to the `https://hypothes.is/admin/groups/<PUBID>` admin page for editing that group. Private groups do not have admin pages, that's why many of the group names on the the https://hypothes.is/admin/groups admin page aren't linked: those are private groups. Originally the only way to create an open or restricted group was via the https://hypothes.is/admin/groups/new admin page, and that page forces you to choose an organization for the open or restricted group to belong to. The `https://hypothes.is/admin/groups/<PUBID>` page could therefore assume that all open or restricted groups belong to an organization. Recently we've enabled users to create their own open or restricted groups via the https://hypothes.is/groups/new page and groups created by this page do not have organizations. Private groups created by this page have never belonged to organizations. The open and restricted groups that can now also be created don't have organizations either. A user could also create a private group with no organization and then turn it into an open or restricted group. So for the first time it's now possible to have open and restricted groups with no organizations. But the `https://hypothes.is/admin/groups/<PUBID>` admin page for editing open or restricted groups has two problems with this: 1. Loading the page crashes when the group has no organization 2. The form forces groups to belong to an organization, there's no option for a group to not have an organization Solution -------- This commit fixes the page to not crash when a group has no organization and also adds a "-- None --" option to the form's organization dropdown so that it no longer forces you to select an organization when creating or editing a group. As a side effect of these changes admins can now also use the https://hypothes.is/admin/groups/new admin page to create open and restricted groups with no organization, and some further fixes were needed to prevent this from crashing.

seanh requested a review from robertknight October 11, 2024 12:39

seanh commented Oct 11, 2024

View reviewed changes

robertknight approved these changes Oct 11, 2024

View reviewed changes

seanh force-pushed the fix-admin-pages branch 2 times, most recently from ac9252d to e4b14bf Compare October 11, 2024 13:08

seanh commented Oct 11, 2024

View reviewed changes

seanh force-pushed the fix-admin-pages branch 3 times, most recently from 24f4774 to e01a883 Compare October 11, 2024 14:20

seanh commented Oct 11, 2024

View reviewed changes

seanh force-pushed the fix-admin-pages branch from e01a883 to e4a02ef Compare October 11, 2024 14:24

seanh force-pushed the fix-admin-pages branch from e4a02ef to 916de34 Compare October 11, 2024 15:52

seanh merged commit b88802b into main Oct 11, 2024
9 checks passed

seanh deleted the fix-admin-pages branch October 11, 2024 15:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix admin pages when group has no organization #9010

Fix admin pages when group has no organization #9010

seanh commented Oct 11, 2024 •

edited

Loading

seanh Oct 11, 2024

seanh Oct 11, 2024

seanh Oct 11, 2024

seanh Oct 11, 2024 •

edited

Loading

seanh Oct 11, 2024

seanh Oct 11, 2024

seanh Oct 11, 2024

seanh Oct 11, 2024

robertknight Oct 11, 2024

seanh Oct 11, 2024

seanh Oct 11, 2024

seanh Oct 11, 2024

Fix admin pages when group has no organization #9010

Fix admin pages when group has no organization #9010

Conversation

seanh commented Oct 11, 2024 • edited Loading

Problem

Solution

Testing

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seanh Oct 11, 2024 • 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

seanh commented Oct 11, 2024 •

edited

Loading

seanh Oct 11, 2024 •

edited

Loading