Improvements to Admin pages for the API Section by scragly · Pull Request #289 · python-discord/site

scragly · 2019-10-19T22:28:13Z

I've added some QOL adjustments to the admin pages by defining ModelAdmin objects for ~~most~~ all of the API section's models:

Bot Settings

See details

Permissions

View	Add	Delete	Change
✅	❌	❌	✅

List View

Columns shown: name
Filter by: None

Item View

Fields: name, data (editable)

Documentation links

See details

Permissions

View	Add	Delete	Change
✅	✅	✅	✅

List View

Columns shown: package, base url (editable), inventory url (editable)
Ordered by: package (alphabetical)
Searchable by: package
Filter by: None

Item View

Fields: package, base url, inventory url

Infractions

See details

Permissions

View	Add	Delete	Change
✅	❌	✅	reason

List View

Columns shown: type, active, user, inserted, reason
Ordered by: inserted descending
Searchable by: id, user name, user id, actor name, actor id, reason, type
Filter by: type, hidden, active, actor

Item View

Fields: user, actor, type, hidden, active, inserted, expires, reason (editable)

Log entries

See details

Permissions

View	Add	Delete	Change
✅	❌	❌	❌

List View

Columns shown: timestamp, level, message
Searchable by: message
Filter by: log level, timestamp

Note: "application" has been removed from filter and columns as we no longer use this api for external logs.

Item View

No changes.

Deleted messages

See details

Permissions

View	Add	Delete	Change
✅	❌	✅	❌

List View

Columns shown: message id, author, channel id
Ordered by: id descending
Searchable by: message id, content, author name, author id, actor name, actor id
Filter by: None

Item View

Fields: id, author, channel id, content, embeds (pretty json formatting), context link, view log (link to staff.pydis log view)

Message deletion contexts

See details

Permissions

View	Add	Delete	Change
✅	❌	✅	❌

List View

Columns shown: id, creation, actor
Ordered by: most recent

Item View

Fields: actor, creation, child messages (as inline tabular view)

Nominations

See details

Permissions

View	Add	Delete	Change
✅	❌	✅	reason end reason

List View

Columns shown: username (with discrim.), active, reason, actor name (with discrim)
Ordered by: most recent
Searchable by: user name, user id, actor name, actor id, reason, end reason
Filter by: active, actor

Item View

Fields: user, active, actor, reason (editable), created, ended, end reason (editable)

Off topic channel names

See details

Permissions

See details

View	Add	Delete	Change
✅	✅	✅	✅

List View

Columns shown: name
Searchable by: name
Filter by: used

Item View

Fields: name, used

Offensive messages

See details

Permissions

View	Add	Delete	Change
✅	❌	✅	delete date

List View

Columns shown: message id, channel id, delete date
Searchable by: message id, channel id
Filter by: None

Item View

Fields: message id (value hyperlinked to discord jumplink), channel id, delete date (editable)

Roles

See details

Permissions

View	Add	Delete	Change
✅	❌	✅	❌

List View

Columns shown: name (coloured)
Ordered by: position
Searchable by: name, id
Filter by: None

Item View

Fields:

id
name
colour
- coloured text
- shown as both hex & int values
permissions
- value links to the Discord API Permissions Calc page to show all the permissions (example)
position

API User

See details

Permissions

View	Add	Delete	Change
✅	❌	✅	❌

List View

Columns shown: username (incl. discrim), top role (coloured), in guild
Ordered by: username (incl. discrim)
Searchable by: name, id, role id
Filter by: role membership, in guild

Item View

Fields: username (incl. discrim), id, in_guild, role vertical list (coloured)

…perty.

…pages.

…page.

…ive.

…d role search.

…ated first.

SebastiaanZ

Is there a way to make certain fields optional in the Admin back-end? If you, say, edit a note infraction, you won't be able to save your changes unless you set an expiry date.

I think that would be an improvement as well.

fiskenslakt · 2019-10-27T10:37:02Z

I'm in the middle of thoroughly testing this branch as I populate my local database, and I've run into an odd bug. Please tell me if you can reproduce it.

Steps to reproduce:

Go to /admin/api/tag/f-strings/change/ on production site and copy the JSON content inside the embed field.
Go to /admin/api/tag/ on your local development site and create a new tag with the ADD TAG + button
Enter a title for the tag
Paste in the copied JSON into the embed field
Click the Save and continue editing button

Expected behavior:

Tag is saved
Edit tag screen is displayed and tag markdown is rendered

What I got instead:

Tag is saved
Django raises a KeyError: snake

lemonsaurus · 2020-03-10T10:04:02Z

@scragly any idea when you'll be able to address the reviews here?

scragly · 2020-03-10T10:05:17Z

Tonight maybe. I only just got the local copy going again today.

lemonsaurus · 2020-03-10T10:08:41Z

excellent. thanks for the quick reply.

lemonsaurus · 2020-08-26T22:50:40Z

@scragly This pull request is very stale. It looks like it's like 98% done, so it'd be a shame to have to close it. I really wish you'd find some time to finish it, but otherwise I'm considering whether we should just merge it even with the reviews unaddressed. I mean, having this feature with a few bugs is probably better than never having it.

scragly · 2020-08-26T22:53:24Z

I should have a bit of time today to address the reviews and to bring the changes up to date with master. I'll try jump on after breakfast too get it sorted.

# Conflicts: # pydis_site/apps/api/admin.py

…r Message

scragly · 2020-09-18T05:52:25Z

If you, say, edit a note infraction, you won't be able to save your changes unless you set an expiry date.

The issue for non-expiring infractions being unable to save changes has been addressed coincidentally, but out of concern that the bot infraction tasks will desync if editing expiry is allowed external to the bot.

I've double checked, and turning the expiry read-only results in successful reason edits.

scragly · 2020-09-18T05:55:20Z

I'm in the middle of thoroughly testing this branch as I populate my local database, and I've run into an odd bug.

Through the power of laziness, neglect and sheer forgetfulness, much time has passed, and just as the water stream eventually erodes the rock, we have lost the presence of tags in the database, with them being stored back in repos. Hence, time is the true solution to all that is bad with the world.

scragly · 2020-09-18T06:17:28Z

I've gone through and tweaked edit permissions for certain models, and atm it's showing the following in the admin site:

Figured I'd give a bit of an update. I'll try get a proper update coming tomorrow, but unfortunately I'm absolutely wrecked and need sleep.

`avatar_hash` is no longer a field stored in the database.

Filter checks for general role membership instead of only those who have the selected role as top role. Noticed during development that we'd not be able to filter to show all Helpers otherwise, as some Helpers have different top roles such as Core Dev that wouldn't give immediately obvious behaviour to user expectations.

Without `blank=True`, admin page editable forms could not be saved if no content was in the end_reason input.

I'm unable to see any cases where this would be wanted, and instead accidental deletion would result in the system possibly breaking, as we are unable to add the setting again to replace it if it got removed. The name has also set to read only in item view, to prevent renames, effectively doing the same thing as deleting it.

lemonsaurus

An exceptionally good PR. Beautifully described, well documented code, concise, and useful.

jb3

Excellent PR

scragly added 11 commits October 20, 2019 05:14

Set default example.com dev site to pythondiscord.local:8000

6ab05d3

Set newest-first sorting for message deletion models, add log_url pro…

e2956b8

…perty.

Add message log links, improved formatting to message deletion admin …

f590d2b

…pages.

Order roles by positioning, add filters and search to api user admin …

618610f

…page.

Improve infractions admin list and page, add search and filters.

0021d4a

Improve nominations admin list and page, add search and filter by act…

1c41c8a

…ive.

Add search field to off topic admin page.

77da333

Show role colour style and add hex value, link perms to calc page, ad…

72f156f

…d role search.

Add tag search and rendered preview.

e19d34b

Adjust deleted message test to account for new ordering of newest cre…

b6d0147

…ated first.

Add new test for deleted message context log_url.

56c6c85

SebastiaanZ reviewed Oct 25, 2019

View reviewed changes

jb3 requested review from a team, MrHemlock and jerbob and removed request for a team February 2, 2020 20:20

lemonsaurus added area: API Related to or causes API changes priority: 2 - normal Normal Priority status: waiting for author type: feature New feature or request labels Feb 29, 2020

ghost added needs 2 reviews and removed status: waiting for author labels Jun 13, 2020

lemonsaurus assigned scragly Sep 6, 2020

Merge branch 'master' into admin-api-pages-improvements

357b201

# Conflicts: # pydis_site/apps/api/admin.py

scragly added 7 commits September 18, 2020 13:01

Add OffensiveMessage Admin model.

8ed8b9a

Add Used filter for OffTopicChannelName Admin model.

c9671fb

Update Nomination Admin model, add actor filter.

f4c47c9

Update DeletedMessage and LogEntry Admin models, add verbose names fo…

5c2e750

…r Message

Add DocumentationLink and BotSetting Admin models.

c6e80a9

Declutter Infraction admin list, add actor list filter.

8af9e19

Don't allow expiry to be editable, due to pending bot tasks unsyncing

2c4b345

scragly requested a review from a team as a code owner September 18, 2020 05:58

scragly requested a review from ikuyarihS September 18, 2020 05:59

scragly added 4 commits September 19, 2020 01:23

Remove noqa from DeletedMessagesLogURLTests setup.

8edeb88

Update user model in DeletedMessagesLogURLTests.

520ea63

`avatar_hash` is no longer a field stored in the database.

Test username property formatting for user model.

394d1ca

scragly force-pushed the admin-api-pages-improvements branch from a3fe02a to dafca0f Compare September 19, 2020 16:06

scragly added 5 commits September 20, 2020 05:02

Allow Nomination end_reason to have a blank value for validation.

715dd46

Without `blank=True`, admin page editable forms could not be saved if no content was in the end_reason input.

Change Infraction admin to use fieldsets for better grouping of info.

d39eeb9

Change documentation link model to order by package.

9344d8a

Add migrations for nomination and doc link model changes.

1916074

scragly force-pushed the admin-api-pages-improvements branch from 3fc5aa7 to a105de7 Compare September 19, 2020 21:06

lemonsaurus approved these changes Sep 19, 2020

View reviewed changes

ghost added needs 1 approval and removed needs 2 approvals labels Sep 19, 2020

jb3 approved these changes Sep 20, 2020

View reviewed changes

ghost removed the needs 1 approval label Sep 20, 2020

jb3 merged commit 5e8b551 into master Sep 20, 2020

jb3 deleted the admin-api-pages-improvements branch September 20, 2020 00:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improvements to Admin pages for the API Section#289

Improvements to Admin pages for the API Section#289
jb3 merged 35 commits into
masterfrom
admin-api-pages-improvements

scragly commented Oct 19, 2019 •

edited

Loading

Uh oh!

SebastiaanZ left a comment

Uh oh!

fiskenslakt commented Oct 27, 2019 •

edited

Loading

Uh oh!

lemonsaurus commented Mar 10, 2020

Uh oh!

scragly commented Mar 10, 2020

Uh oh!

lemonsaurus commented Mar 10, 2020

Uh oh!

lemonsaurus commented Aug 26, 2020

Uh oh!

scragly commented Aug 26, 2020

Uh oh!

scragly commented Sep 18, 2020

Uh oh!

scragly commented Sep 18, 2020

Uh oh!

scragly commented Sep 18, 2020

Uh oh!

lemonsaurus left a comment •

edited

Loading

Uh oh!

jb3 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

scragly commented Oct 19, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bot Settings

Permissions

List View

Item View

Documentation links

Permissions

List View

Item View

Infractions

Permissions

List View

Item View

Log entries

Permissions

List View

Item View

Deleted messages

Permissions

List View

Item View

Message deletion contexts

Permissions

List View

Item View

Nominations

Permissions

List View

Item View

Off topic channel names

Permissions

List View

Item View

Offensive messages

Permissions

List View

Item View

Roles

Permissions

List View

Item View

API User

Permissions

List View

Item View

Uh oh!

SebastiaanZ left a comment

Choose a reason for hiding this comment

Uh oh!

fiskenslakt commented Oct 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lemonsaurus commented Mar 10, 2020

Uh oh!

scragly commented Mar 10, 2020

Uh oh!

lemonsaurus commented Mar 10, 2020

Uh oh!

lemonsaurus commented Aug 26, 2020

Uh oh!

scragly commented Aug 26, 2020

Uh oh!

scragly commented Sep 18, 2020

Uh oh!

scragly commented Sep 18, 2020

Uh oh!

scragly commented Sep 18, 2020

Uh oh!

lemonsaurus left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jb3 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

scragly commented Oct 19, 2019 •

edited

Loading

fiskenslakt commented Oct 27, 2019 •

edited

Loading

lemonsaurus left a comment •

edited

Loading