Subject tag changes #10138

jimchamp · 2024-12-09T17:43:42Z

Supplants #9843

General Tag Changes

Only two general tag types are now defined:
- Collection tags
  - Tag type: collection
- Subject tags
  - Tag types: subject, person, place, time
- work-type tags have been removed
All tag types now have a body property
- This will be rendered both on tag views and subject pages.

`Tag` model

Tag.find() updated to return multiple values
- Now returns a list of matching tag keys
- tag_type no longer a required parameter
Tag.create() updated to take a dict representation of a Tag
- Tag dict validations are expected to occur before create is called
- Tag.create() now returns the newly created Tag object (instead of a key)
  - Prevents redundant calls to Infogami

`Tag` page templates

General Tag view - `/templates/type/tag/view.html`

Updated means of deriving a related subject_key
Renders Tag.body to the page (if the tag is a subject tag)
Sanitizes and formats the tag's description and body before rendering

Tag `edit` and `add` views have been consolidated as `/templates/type/tag/form.html`

Subject page

Disambiguation section added
- Included links to the Tag views of subject tags with a similar name

`addtag.py`

unflatten calls on patron input have been removed
- unflatten is used specifically for book edit form data
Added type-specific validation functions
Added handler for type-specific edits

Missing from this PR

Subject tag body is not automatically generated
- Attempted to add the same components that are used by the subject page, but HTML becomes malformed after sanitize and format calls
Types in URLs (/tags/OL123T/{tag_type}/{tag_label})
- Requires refactor of ReadableUrlProcessor

Technical

Testing

Screenshot

Stakeholders

Removes `work` tag type, and adds four distinct subject types. Adds `body` input to the "add tag" form. Fixes bug where incorrect subject page link is rendered on tag page. Replace subject page "Edit" button with "Tag" button, when no associated tag is found. If there is a tag, a link to the tag page is included beneath the tag description. Update the Tag.create method to take a `tag` dictionary, and to return the newly created tag.

Creates handler for paths like `/tag/{tag_type}/add`, and new templates for adding and editing specific tag types. The generic "Add Tag" form template has been updated to show and hide the appropriate form elements whenever the selected tag type is changed. Additionally, existing tag form templates have been updated to take a `page` object (instead of one parameter for each property a `Tag` may have). The subject page "Tag" link has been updated to point to `/tag/{tag_type}/add`, where `tag_type` is one of our four subject types. Patron's who follow the link will be served the form for adding subject tags (instead of the generalized add tag form, available at `/tag/add`).

The subject page handler now makes a call to fetch related tags after the subject has been returned from Solr. Data fetched from the `/subjects` `json` endpoint are no longer decorated with tag data.

Adds new `validate_subject_tag` and `create_tag` functions. Updates existing `create_subject_tag` function to take a dictionary. Updates existing handlers to use the correct tag validation and creation methods.

Form would fail to submit when `collection` type was chosen and all fields filled. The issue was the required subject tag body, which is only required for subject tags. Inputs specific to a tag sub-type are now removed if that tag type is not selected.

- Sanitize tag description in tag view - Update subject key derivation in tag view - Reduce number of DB calls required to decorate a subject page with tags - Tag edit `GET` handler returns edit form specific to the existing tag's type - Use correct sub-type validations on tag edit - Remove `utils.unflatten` call when creating tag - `utils.unflatten` is made specifically for processing the book edit form

codecov-commenter · 2024-12-09T18:48:04Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 17.44%. Comparing base (347bff9) to head (0ed861a).
Report is 170 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #10138      +/-   ##
==========================================
+ Coverage   17.12%   17.44%   +0.31%     
==========================================
  Files          89       89              
  Lines        4752     4792      +40     
  Branches      831      848      +17     
==========================================
+ Hits          814      836      +22     
- Misses       3428     3436       +8     
- Partials      510      520      +10

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

- Disambiguation links now point to subject pages - Disambiguation link for current page is no longer included

- Move disambiguation section - Add tag body to top of `contentBody` div

- Require `body` for all tag types - Add duplicate tag validations - Reload page with flash message when duplicate tag exists - Update flash messages to render hyperlinks

jimchamp · 2024-12-18T00:58:16Z

Outstanding tasks:

Subject type localization
Add history table to Tag view

jimchamp · 2024-12-18T01:01:43Z

openlibrary/plugins/upstream/addtag.py

+SUBJECT_SUB_TYPES = ["subject", "person", "place", "time"]
+TAG_TYPES = SUBJECT_SUB_TYPES + ["collection"]


This are being used as display strings. get_subject_tag_types and get_tag_types will need to be updated such that they return lists of localized tag type strings.

jimchamp · 2024-12-18T23:45:23Z

openlibrary/core/models.py

-        match = list(web.ctx.site.things(q))
-        return match[0] if match else None
+    def find(cls, tag_name, tag_type=None):
+        """Returns a Tag key for a given tag name."""


Suggested change

"""Returns a Tag key for a given tag name."""

"""Returns a list of keys for Tags that match the search criteria."""

accesslint

There are accessibility issues in these changes.

accesslint · 2024-12-20T23:41:42Z

openlibrary/templates/type/tag/tag_form_inputs.html

 <div class="formElement">
    <div class="label"><label for="tag_type">$_("Tag type")</label></div>
    <div class="input">
-        <select name="tag_type" id="tag_type" required>
+        <select name="tag_type" required>


Looks like this element is missing an accessible name or label. That makes it hard for people using screen readers or voice control to use the control.

for more information, see https://pre-commit.ci

jimchamp added 10 commits December 9, 2024 09:49

Remove tag query from get_subjects()

5f5f078

The subject page handler now makes a call to fetch related tags after the subject has been returned from Solr. Data fetched from the `/subjects` `json` endpoint are no longer decorated with tag data.

Update validation and tag creation functions

91e2f60

Adds new `validate_subject_tag` and `create_tag` functions. Updates existing `create_subject_tag` function to take a dictionary. Updates existing handlers to use the correct tag validation and creation methods.

Require body for subject tags

a8b787e

Add disambiguations section to subject page

6bd18d3

Add tag search endpoint

94b6ce1

Remove inline JS

1c17c70

jimchamp force-pushed the subject-tag-changes branch from e52b1fe to 1c17c70 Compare December 9, 2024 18:44

jimchamp force-pushed the subject-tag-changes branch from 01aaaf0 to 7f45814 Compare December 9, 2024 18:54

Update type hints

4678c5b

jimchamp force-pushed the subject-tag-changes branch 4 times, most recently from 53a99e9 to 7e861fd Compare December 9, 2024 19:58

Updates the order of Python imports

12fca88

jimchamp force-pushed the subject-tag-changes branch from fe8c8a4 to 12fca88 Compare December 9, 2024 21:34

jimchamp added 2 commits December 9, 2024 13:54

Fix missing-i18n test failure

be7be99

Remove redundant subject form inputs

0d81650

jimchamp force-pushed the subject-tag-changes branch from c6dc94f to 0d81650 Compare December 9, 2024 21:55

jimchamp added 4 commits December 12, 2024 15:27

Disambiguation updates

cef31a2

- Disambiguation links now point to subject pages - Disambiguation link for current page is no longer included

Return to subject page after tag creation or edit

69404a7

Update subject page

95f67e5

- Move disambiguation section - Add tag body to top of `contentBody` div

Update tag validations

8224657

- Require `body` for all tag types - Add duplicate tag validations - Reload page with flash message when duplicate tag exists - Update flash messages to render hyperlinks

jimchamp marked this pull request as draft December 13, 2024 23:43

jimchamp marked this pull request as ready for review December 13, 2024 23:43

jimchamp added the Needs: Submitter Input Waiting on input from the creator of the issue/pr [managed] label Dec 13, 2024

jimchamp added 2 commits December 13, 2024 18:03

Add body field to all add and edit tag forms

7d697be

Add tag_type to tag view

1b8ad73

mekarpeles self-assigned this Dec 16, 2024

mekarpeles added the Priority: 1 Do this week, receiving emails, time sensitive, . [managed] label Dec 16, 2024

Consolidate tag edit/add forms

2b2e593

jimchamp force-pushed the subject-tag-changes branch from 0f30126 to 2b2e593 Compare December 17, 2024 00:21

github-actions bot removed the Needs: Submitter Input Waiting on input from the creator of the issue/pr [managed] label Dec 17, 2024

Fix up for ruff

860a95e

jimchamp force-pushed the subject-tag-changes branch from 0370a6d to 860a95e Compare December 17, 2024 22:21

jimchamp commented Dec 18, 2024

View reviewed changes

jimchamp added the On testing.openlibrary.org This PR has been deployed to testing.openlibrary.org for testing label Dec 18, 2024

jimchamp commented Dec 18, 2024

View reviewed changes

Require tag_description

5ba6a4b

jimchamp force-pushed the subject-tag-changes branch from 4468b30 to 5ba6a4b Compare December 20, 2024 23:41

accesslint bot reviewed Dec 20, 2024

View reviewed changes

[pre-commit.ci] auto fixes from pre-commit.com hooks

0ed861a

for more information, see https://pre-commit.ci

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Subject tag changes #10138

Subject tag changes #10138

jimchamp commented Dec 9, 2024 •

edited

Loading

codecov-commenter commented Dec 9, 2024 •

edited

Loading

jimchamp commented Dec 18, 2024

jimchamp Dec 18, 2024

jimchamp Dec 18, 2024

accesslint bot left a comment

accesslint bot Dec 20, 2024

		SUBJECT_SUB_TYPES = ["subject", "person", "place", "time"]
		TAG_TYPES = SUBJECT_SUB_TYPES + ["collection"]

	"""Returns a Tag key for a given tag name."""
	"""Returns a list of keys for Tags that match the search criteria."""

Subject tag changes #10138

Are you sure you want to change the base?

Subject tag changes #10138

Conversation

jimchamp commented Dec 9, 2024 • edited Loading

General Tag Changes

Tag model

Tag page templates

General Tag view - /templates/type/tag/view.html

Tag edit and add views have been consolidated as /templates/type/tag/form.html

Subject page

addtag.py

Missing from this PR

Technical

Testing

Screenshot

Stakeholders

codecov-commenter commented Dec 9, 2024 • edited Loading

Codecov Report

jimchamp commented Dec 18, 2024

jimchamp Dec 18, 2024

Choose a reason for hiding this comment

jimchamp Dec 18, 2024

Choose a reason for hiding this comment

accesslint bot left a comment

Choose a reason for hiding this comment

accesslint bot Dec 20, 2024

Choose a reason for hiding this comment

jimchamp commented Dec 9, 2024 •

edited

Loading

`Tag` model

`Tag` page templates

General Tag view - `/templates/type/tag/view.html`

Tag `edit` and `add` views have been consolidated as `/templates/type/tag/form.html`

`addtag.py`

codecov-commenter commented Dec 9, 2024 •

edited

Loading