Resolve relative images when caching plugin data #796
Conversation
codemonkey800
added
the
improvement
backend/utils/markdown.py
Outdated
| url = get_raw_github_url( | ||
| self.repo, | ||
| self.branch, | ||
| src.replace(pattern, ''), |
There was a problem hiding this comment.
Would replace also work for ../ as it would have to point to the parent folder?
There was a problem hiding this comment.
It turns out we can leverage the normpath from the os.path module for handling the above issue. I was thinking through this, and here is an untested snippet that may work for our case.
If we parsed the URL into its components, we could use the base_path to update our path.
from urllib.parse import urlparse, urlunparse
url = f'https://raw.githubusercontent.com/{repo}/{branch}/'
scheme, netloc, base_path, *_ = urlparse(url)
This way, we could retain the other components (if any) from the relative path.
if src.startswith(pattern):
*_, path, params, query, fragment = urlparse(src)
complete_path = os.path.normpath(os.path.join(base_path, path))
absolute_path = urlunparse(scheme=scheme,
netloc=netloc,
path=complete_path,
params=params,
query=query,
fragment=fragment)
img.set('src', absolute_path)
backend/utils/markdown.py
Outdated
| self.branch = branch | ||
|
|
||
| def run(self, root): | ||
| for img in root.iter('img'): |
There was a problem hiding this comment.
Should we also consider adding this for the anchor tags?
codemonkey800
force-pushed
the
jeremy/markdown-relative-images
branch
2 times, most recently
from
0b23fd3 to
e31c5d6
Compare
codemonkey800
force-pushed
the
jeremy/markdown-relative-images
branch
from
e31c5d6 to
219c30b
Compare
|
closing this now since implementation was originally in S3, we would need to move this to the data workflows step if we ever decide to pick this up again |
Description
Closes #541
This PR adds relative image resolution for plugin markdown descriptions. This works by following the image resolution rules outlined here: #140 (comment)
This also handles the edge case regarding repo default branch by using the
default_branchproperty from the GitHub repo API.The only edge case that isn't handled is versioning, but since we currently do not support viewing versioned plugins on the hub, we can defer handling versioned images for later
Demo
Relative images starting with
./https://www.napari-hub.org/plugins/napari-dzi-zarr
https://dev-rel-img-frontend.dev.imaging.cziscience.com/plugins/napari-dzi-zarr
Relative images starting with
../https://www.napari-hub.org/plugins/napari-bleach-correct
https://dev-rel-img-frontend.dev.imaging.cziscience.com/plugins/napari-bleach-correct