views: FAIR signposting level 1 support (HTTP Link headers) #2938
Conversation
| # then try to get the optional `link` from the custom license. | ||
| url = right.get("props", {}).get("url") or right.get("link") | ||
| if url: | ||
| licenses.append(_get_header("license", url)) |
There was a problem hiding this comment.
The FAIR Signposting docs recommends to use SPDX license identifier (e.g. https://spdx.org/licenses/CC0-1.0).
However, in Zenodo we store URLs like https://creativecommons.org/publicdomain/zero/1.0/legalcode and not spdx.org URLs.
There was a problem hiding this comment.
If props["scheme"] == "spdx" I think we can safely generate the URL like https://spdx.org/licenses/{right["id"]}. We might have licenses (or even non-SPDX licenses), in which case just using url like here would be ok.
There was a problem hiding this comment.
Unfortunately our IDs are lower-cased (e.g. antlr-pd-fallback) while the SPDX URLs are are mixed-cased and case-sensitive (e.g. https://spdx.org/licenses/ANTLR-PD-fallback.html).
There was a problem hiding this comment.
Ouch, I tried in the browser and copy-pasting URLs for some reason kept the original case... Ok, this is a bummer, I think we'll have to add the original spdx ID with the exact case as a props.spdx_id field or similar...
I think it would be fine to shelve this and just use the url, depends on whether we want to spend more time to re-import SPDX and update the existing license vocabulary (funnily, the dump we have is from more than a year ago).
|
|
||
| def _get_signposting_linkset(pid_value): | ||
| api_url = record_url_for(_app="api", pid_value=pid_value) | ||
| return _get_header("linkset", api_url, "application/linkset+json") |
There was a problem hiding this comment.
Note: this is required for level 2 support and was already added in a previous pull request.
Here we only include a link of the type "application/linkset+json", but the docs requires to also include a link of type "application/linkset".
0929cec to
15672de
Compare
| # then try to get the optional `link` from the custom license. | ||
| url = right.get("props", {}).get("url") or right.get("link") | ||
| if url: | ||
| licenses.append(_get_header("license", url)) |
There was a problem hiding this comment.
If props["scheme"] == "spdx" I think we can safely generate the URL like https://spdx.org/licenses/{right["id"]}. We might have licenses (or even non-SPDX licenses), in which case just using url like here would be ok.
| def add_signposting_content_resources(f): | ||
| """Add signposting links to the content resources view's response headers.""" | ||
|
|
||
| @wraps(f) | ||
| def view(*args, **kwargs): | ||
| response = make_response(f(*args, **kwargs)) | ||
|
|
||
| # Relies on other decorators having operated before it | ||
| pid_value = kwargs["pid_value"] | ||
| signposting_link = record_url_for(_app="api", pid_value=pid_value) | ||
|
|
||
| response.headers["Link"] = ( | ||
| f'<{signposting_link}> ; rel="linkset" ; type="application/linkset+json"' # fmt: skip | ||
| ) | ||
| signposting_headers = [ | ||
| _get_signposting_collection(pid_value), | ||
| _get_signposting_linkset(pid_value), | ||
| ] | ||
|
|
||
| response.headers["Link"] = " , ".join(signposting_headers) | ||
|
|
||
| return response | ||
|
|
||
| return view | ||
|
|
||
|
|
||
| def add_signposting_metadata_resources(f): | ||
| """Add signposting links to the metadata resources view's response headers.""" | ||
|
|
||
| @wraps(f) | ||
| def view(*args, **kwargs): | ||
| response = make_response(f(*args, **kwargs)) | ||
|
|
||
| # Relies on other decorators having operated before it | ||
| pid_value = kwargs["pid_value"] | ||
|
|
||
| signposting_headers = [ | ||
| _get_signposting_describes(pid_value), | ||
| _get_signposting_linkset(pid_value), | ||
| ] | ||
|
|
||
| response.headers["Link"] = " , ".join(signposting_headers) | ||
|
|
There was a problem hiding this comment.
Note that, unlike the Landing Page which relies on invenio_rdm_records.resources.serializers.signposting, the Content Resources and Metadata Resources are not relying on invenio_rdm_records.resources.serializers.signposting because:
ContentResourceSchemaandContentResourceSchemaexpect the record to be passed viacontext={"record_dict"}which makes it more difficult to reuse here.- The logic is pretty simple to add only the
collection,describesandlinksetheaders, so re-implementing it here is not that bad.
tests/ui/test_signposting_ui.py
Outdated
| # The test record does not have a license. | ||
| '<https://schema.org/Photograph> ; rel="type"', | ||
| '<https://schema.org/AboutPage> ; rel="type"', | ||
| f'<{api_url}> ; rel="linkset" ; type="application/linkset+json"', |
There was a problem hiding this comment.
The logic for the landing page is implemented in FAIRSignpostingProfileLvl1Serializer in invenio-rdm-records and is already tested there (see inveniosoftware/invenio-rdm-records#1908).
It stills makes sense to at least issue the HTTP call to the endpoint here, to make sure that the decorator is working properly, but maybe the assertion should be less detailed to avoid having to adapt this test every time we modify the other module?
There was a problem hiding this comment.
I agreed with myself and changed the test to write more generic assertions like:
# ...
# There should be at least 10 export formats supported (e.g. "application/dcat+xml", "application/x-bibtex", etc.).
assert sum('; rel="describedby" ;' in header for header in link_headers) >= 10
# ...2e533ed to
7861a81
Compare
|
Just rebased to trigger the tests now that inveniosoftware/invenio-rdm-records#1908 is merged and that invenio-rdm-records v17.1.0 is released. |
7861a81 to
463c09c
Compare
|
Also squashed all commits into one, since the first implementation was then replaced by one relying on |
8d64b9e to
195f53f
Compare
195f53f to
19dd2fe
Compare
❤️ Thank you for your contribution!
Description
Checklist
Ticks in all boxes and 🟢 on all GitHub actions status checks are required to merge:
Frontend
Reminder
By using GitHub, you have already agreed to the GitHub’s Terms of Service including that: