devpi-web 4.2.1__tar.gz → 4.2.3__tar.gz

devpi-web-4.2.3/.flake8

@@ -0,0 +1,2 @@
+[flake8]
+ignore = E501,E741,W503

{devpi-web-4.2.1 → devpi-web-4.2.3}/CHANGELOG

@@ -2,6 +2,36 @@
 
 .. towncrier release notes start
 
+4.2.3 (2024-09-19)
+==================
+
+Bug Fixes
+---------
+
+- Fix deprecation warnings from devpi-server 6.13.0.
+
+- Lazily evaluate file information. Especially with devpi-postgresql this safes many database accesses on most pages.
+
+- Guard against missing doczip files, which can happen on replicas during replication.
+
+- Increase threshold for index status from 60 s to 300 s for warnings and from 300 s to 3600 s for fatal.
+
+
+
+4.2.2 (2024-04-20)
+==================
+
+Bug Fixes
+---------
+
+- style.css: Always let content be full browser height. This also gives more height with some documentation themes when content is short.
+
+- style.css: set ``scrollbar-gutter: stable`` on ``body`` to prevent jumping content in documentation iframe.
+
+- Fix #970: overwrite fixed html/body heights like ``100%`` in documentation iframe content.
+
+
+
 4.2.1 (2023-07-02)
 ==================
 

{devpi-web-4.2.1 → devpi-web-4.2.3}/MANIFEST.in

@@ -1,4 +1,4 @@
-include CHANGELOG *.ini *.rst LICENSE
+include .flake8 CHANGELOG *.ini *.rst LICENSE
 recursive-include devpi_web/static *
 recursive-include devpi_web/templates *
 recursive-include tests *.py

{devpi-web-4.2.1 → devpi-web-4.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devpi-web
-Version: 4.2.1
+Version: 4.2.3
 Summary: devpi-web: a web view for devpi-server
 Home-page: https://devpi.net
 Maintainer: Florian Schulze
@@ -27,6 +27,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.4
 License-File: LICENSE
 License-File: AUTHORS
@@ -76,80 +77,80 @@ Changelog
 
 .. towncrier release notes start
 
-4.2.1 (2023-07-02)
+4.2.3 (2024-09-19)
 ==================
 
 Bug Fixes
 ---------
 
-- Fix #953: Exception when browsers send ETag for documentation pages.
+- Fix deprecation warnings from devpi-server 6.13.0.
 
-- Fix #980: Remove long deprecated backward compatibility for old pluggy versions to fix error with pluggy 1.1.0.
+- Lazily evaluate file information. Especially with devpi-postgresql this safes many database accesses on most pages.
 
+- Guard against missing doczip files, which can happen on replicas during replication.
 
-4.2.0 (2022-12-05)
-==================
+- Increase threshold for index status from 60 s to 300 s for warnings and from 300 s to 3600 s for fatal.
 
-Features
---------
 
-- Set ETag header to the doczip hash and max-age to 60 seconds for all documentation files.
-
-- Add ``--keep-docs-packed`` option.
 
+4.2.2 (2024-04-20)
+==================
 
 Bug Fixes
 ---------
 
-- common.js, macros.pt: Fix #823: Remove moment.js and update jquery to 3.6.0.
+- style.css: Always let content be full browser height. This also gives more height with some documentation themes when content is short.
 
-- common.js: Fix #764: Jumping to anchors with whitespace in documentation now works.
+- style.css: set ``scrollbar-gutter: stable`` on ``body`` to prevent jumping content in documentation iframe.
 
-- doc.pt, docview.js, style.css: Fix #764: Rewrote setting height of documentation iframe which also fixes scrolling to anchors generated by JavaScript.
+- Fix #970: overwrite fixed html/body heights like ``100%`` in documentation iframe content.
 
-- Fix project names from mirrors with devpi-server >= 6.8.0.
 
-- Fix exception in not found page of project URLs.
 
-- toxresults.pt, version.pt: Fix anchor generation for toxresults URLs.
-
-
-4.1.1 (2022-09-28)
+4.2.1 (2023-07-02)
 ==================
 
-
 Bug Fixes
 ---------
 
-- Generalize GET redirect from URLs with trailing slash to ones without for consistency.
+- Fix #953: Exception when browsers send ETag for documentation pages.
+
+- Fix #980: Remove long deprecated backward compatibility for old pluggy versions to fix error with pluggy 1.1.0.
 
 
-4.1.0 (2022-08-16)
+4.2.0 (2022-12-05)
 ==================
 
 Features
 --------
 
-- Support original project names for mirrors with devpi-server 6.6.0.
-
-- project.pt: Fix #601: add refresh button to project page.
+- Set ETag header to the doczip hash and max-age to 60 seconds for all documentation files.
 
-- project.pt: add navigation links to original project page for mirrors and to "Simple page" of projects.
+- Add ``--keep-docs-packed`` option.
 
 
 Bug Fixes
 ---------
 
-- Fix #880: explicitly register views for GET method, so there is a 404 on POSTs, like when using twine with wrong upload url.
+- common.js, macros.pt: Fix #823: Remove moment.js and update jquery to 3.6.0.
 
-- Fix #867: AttributeError during ``devpi-import`` and maybe other commands.
+- common.js: Fix #764: Jumping to anchors with whitespace in documentation now works.
 
+- doc.pt, docview.js, style.css: Fix #764: Rewrote setting height of documentation iframe which also fixes scrolling to anchors generated by JavaScript.
 
-4.0.8 (2021-08-12)
+- Fix project names from mirrors with devpi-server >= 6.8.0.
+
+- Fix exception in not found page of project URLs.
+
+- toxresults.pt, version.pt: Fix anchor generation for toxresults URLs.
+
+
+4.1.1 (2022-09-28)
 ==================
 
+
 Bug Fixes
 ---------
 
-- On startup loop over mirror indexes last to avoid filling up the indexing queue, which processes non mirror indexes first.
+- Generalize GET redirect from URLs with trailing slash to ones without for consistency.
 

devpi-web-4.2.3/devpi_web/__init__.py

@@ -0,0 +1 @@
+__version__ = '4.2.3'

{devpi-web-4.2.1 → devpi-web-4.2.3}/devpi_web/clear_index.py

@@ -31,7 +31,8 @@ def clear_index(argv=None):
         configure_cli_logging(config.args)
         xom = xom_from_config(config)
         log = xom.log
-        log.warn("You should stop devpi-server before running this command.")
+        log.warn(  # noqa: G010 - this is actually TagLogger from devpi-server, but devpi-web still needs to support older devpi-server versions
+            "You should stop devpi-server before running this command.")
         ix = get_indexer(xom)
         ix.delete_index()
         log.info("Index deleted, start devpi-server again to let the index rebuild automatically.")

devpi-web-4.2.3/devpi_web/compat.py

@@ -0,0 +1,42 @@
+try:
+    from devpi_server.filestore import get_hashes
+
+    def get_default_hash_spec(content_or_file):
+        return get_hashes(content_or_file).get_default_spec()
+except ImportError:
+    from devpi_server.filestore import get_default_hash_spec  # noqa: F401
+
+
+try:
+    from devpi_server.main import Fatal
+
+    def fatal(msg, *, exc=None):
+        raise Fatal(msg) from exc
+except ImportError:
+    from devpi_server.main import fatal  # noqa: F401
+
+
+def get_entry_hash_spec(entry):
+    return (
+        entry.best_available_hash_spec
+        if hasattr(entry, 'best_available_hash_spec') else
+        entry.hash_spec)
+
+
+def get_entry_hash_value(entry):
+    return (
+        entry.best_available_hash_value
+        if hasattr(entry, 'best_available_hash_value') else
+        entry.hash_value)
+
+
+def read_transaction(keyfs):
+    if hasattr(keyfs, 'read_transaction'):
+        return keyfs.read_transaction()
+    return keyfs.transaction(write=False)
+
+
+def write_transaction(keyfs):
+    if hasattr(keyfs, 'write_transaction'):
+        return keyfs.write_transaction()
+    return keyfs.transaction(write=True)

{devpi-web-4.2.1 → devpi-web-4.2.3}/devpi_web/doczip.py

@@ -1,22 +1,25 @@
-from collections.abc import MutableMapping as DictMixin
 from bs4 import BeautifulSoup
+from collections.abc import MutableMapping as DictMixin
 from contextlib import contextmanager
 from devpi_common.archive import Archive
 from devpi_common.types import cached_property
 from devpi_common.validation import normalize_name
 from devpi_server.log import threadlog
+from devpi_web.compat import get_entry_hash_spec
+import json
+import py
+
+
 try:
     import fcntl
 except ImportError:
-    fcntl = None  # type: ignore
-import json
-import py
+    fcntl = None  # type: ignore[assignment]
 
 
 def get_unpack_path(stage, name, version):
     path = stage.xom.config.args.documentation_path
     if path is None:
-        path = stage.keyfs.basedir
+        path = py.path.local(stage.keyfs.base_path) if hasattr(stage.keyfs, "base_path") else stage.keyfs.basedir
     else:
         path = py.path.local(path)
     return path.join(
@@ -90,7 +93,7 @@ def unpack_docs(stage, name, version, entry):
     # we are not losing the original zip file anyway
     with locked_unpack_path(stage, name, version) as (hash_file, unpack_path):
         hash_file.seek(0)
-        if hash_file.read().strip() == entry.hash_spec:
+        if hash_file.read().strip() == get_entry_hash_spec(entry):
             return unpack_path
         if unpack_path.exists():
             try:
@@ -98,11 +101,13 @@ def unpack_docs(stage, name, version, entry):
             except py.error.ENOENT:
                 # there is a rare possibility of a race condition here
                 pass
+        if not entry.file_exists():
+            return unpack_path
         with entry.file_open_read() as f:
             with Archive(f) as archive:
                 archive.extract(unpack_path)
         hash_file.seek(0)
-        hash_file.write(entry.hash_spec)
+        hash_file.write(get_entry_hash_spec(entry))
         hash_file.truncate()
         threadlog.debug("%s: unpacked %s-%s docs to %s",
                         stage.name, name, version, unpack_path)

{devpi-web-4.2.1 → devpi-web-4.2.3}/devpi_web/main.py

@@ -1,14 +1,15 @@
 from chameleon.config import AUTO_RELOAD
+from chameleon.config import DEBUG_MODE
 from collections.abc import Mapping
 from devpi_common.metadata import get_latest_version
 from devpi_common.validation import normalize_name
+from devpi_web.compat import fatal
 from devpi_web.config import add_indexer_backend_option
 from devpi_web.config import get_pluginmanager
 from devpi_web.doczip import remove_docs
 from devpi_web.indexing import ProjectIndexingInfo
 from devpi_web.indexing import is_project_cached
 from devpi_server.log import threadlog
-from devpi_server.main import fatal
 from pluggy import HookimplMarker
 from pyramid.renderers import get_renderer
 from pyramid_chameleon.renderer import ChameleonRendererLookup
@@ -121,6 +122,7 @@ def query_docs_html(request):
 
 class ThemeChameleonRendererLookup(ChameleonRendererLookup):
     auto_reload = AUTO_RELOAD
+    debug = DEBUG_MODE
 
     def __call__(self, info):
         # if the template exists in the theme, we will use it instead of the

{devpi-web-4.2.1 → devpi-web-4.2.3}/devpi_web/static/docview.js

@@ -12,6 +12,7 @@ function onIFrameLoad(event) {
         $iframe = $(iframe),
         $doc = $(iframe.contentWindow.document),
         $docHtml = $doc.find('html'),
+        $docBody = $docHtml.find('body'),
         scrolled_to_anchor = false,
         iframeResizeObserver = new ResizeObserver((entries) => {
             for (const entry of entries) {
@@ -28,6 +29,10 @@ function onIFrameLoad(event) {
             }
         });
 
+    $docHtml.css('height', 'auto');
+    $docHtml.css('overflow-y', 'hidden');
+    $docBody.css('height', 'auto');
+    $docBody.css('overflow-y', 'hidden');
     // make keyboard actions affect the actual documentation
     // in the iframe by default
     iframe.contentWindow.focus();

{devpi-web-4.2.1 → devpi-web-4.2.3}/devpi_web/static/style.css

@@ -7,6 +7,17 @@ body, html {
     padding: 0;
 }
 
+html {
+    height: 100%;
+}
+
+body {
+    min-height: 100%;
+    display: flex;
+    flex-direction: column;
+    scrollbar-gutter: stable;
+}
+
 pre, table {
     font-size: inherit;
 }
@@ -23,6 +34,10 @@ a:hover {
     text-decoration: underline;
 }
 
+#content {
+    flex: auto;
+}
+
 form, #content, #navigation, .searchresults {
     position: relative;
     margin: 0 1em;
@@ -545,10 +560,16 @@ table.projectinfos .closed .value:after,
 }
 
 div.iframe {
+    flex: auto;
     margin: 0;
+    display: flex;
+}
+
+div.iframe iframe {
+    flex: auto;
 }
 
-div.iframe, iframe {
+div.iframe, div.iframe iframe {
     width: 100%;
     border: 0;
 }

{devpi-web-4.2.1 → devpi-web-4.2.3}/devpi_web/views.py

@@ -2,12 +2,15 @@ from defusedxml.xmlrpc import DefusedExpatParser
 from devpi_common.metadata import Version
 from devpi_common.metadata import get_pyversion_filetype
 from devpi_common.metadata import get_sorted_versions
+from devpi_common.types import cached_property
 from devpi_common.validation import normalize_name
 from devpi_common.viewhelp import iter_toxresults
 from devpi_server.log import threadlog as log
 from devpi_server.readonly import SeqViewReadonly
 from devpi_server.views import StatusView, url_for_entrypath
 from devpi_server.views import PyPIView
+from devpi_web.compat import get_entry_hash_spec
+from devpi_web.compat import get_entry_hash_value
 from devpi_web.description import get_description
 from devpi_web.doczip import Docs
 from devpi_web.doczip import docs_exist
@@ -151,7 +154,7 @@ def get_doc_info(context, request, version=None, check_content=True):
         if not relpath_exists:
             raise HTTPNotFound("File %s not found in documentation." % relpath)
     result = dict(
-        etag=entry.hash_value,
+        etag=get_entry_hash_value(entry),
         relpath=relpath,
         doc_version=doc_version,
         version_mismatch=doc_version != navigation_version(context))
@@ -215,7 +218,7 @@ def doc_show(context, request):
                 project=name, version='latest', relpath="index.html")))
     try:
         stable_doc_info = get_doc_info(context, request, version='stable', check_content=False)
-        if stable_doc_info['doc_version'] != doc_info['doc_version'] and stable_doc_info['doc_version'] != latest_doc_info['doc_version']:
+        if stable_doc_info['doc_version'] not in (doc_info['doc_version'], latest_doc_info['doc_version']):
             version_links.append(dict(
                 title="Stable documentation",
                 url=request.route_url(
@@ -331,47 +334,88 @@ def make_history_view_item(request, log_item):
     return result
 
 
-def get_files_info(request, linkstore, show_toxresults=False):
-    files = []
-    filedata = linkstore.get_links(rel='releasefile')
-    if not filedata:
-        log.warn("project %r version %r has no files",
-                 linkstore.project, linkstore.version)
-    for link in sorted(filedata, key=attrgetter('basename')):
-        url = url_for_entrypath(request, link.entrypath)
-        entry = link.entry
-        if entry.hash_spec:
-            url += "#" + entry.hash_spec
-        py_version, file_type = get_pyversion_filetype(link.basename)
-        if py_version == 'source':
-            py_version = ''
-        size = ''
-        if entry.file_exists():
-            size = "%.0f %s" % sizeof_fmt(entry.file_size())
+class FileInfo:
+    def __init__(self, request, link, linkstore, show_toxresults):
+        self.entry = link.entry
+        self.link = link
+        self.linkstore = linkstore
+        self.request = request
+        self.show_toxresults = show_toxresults
+
+    @cached_property
+    def basename(self):
+        return self.entry.basename
+
+    @cached_property
+    def dist_type(self):
+        (py_version, file_type) = self.pyversion_filetype
+        return dist_file_types.get(file_type, '')
+
+    def get(self, key, default=None):
+        return getattr(self, key, default)
+
+    @cached_property
+    def hash_spec(self):
+        return get_entry_hash_spec(self.entry)
+
+    @cached_property
+    def history(self):
         try:
-            history = [
-                make_history_view_item(request, x)
-                for x in link.get_logs()]
+            return [
+                make_history_view_item(self.request, x)
+                for x in self.link.get_logs()]
         except AttributeError:
-            history = []
-        last_modified = format_timetuple(parsedate(entry.last_modified))
-        fileinfo = dict(
-            title=link.basename,
-            url=url,
-            basename=link.basename,
-            hash_spec=entry.hash_spec,
-            dist_type=dist_file_types.get(file_type, ''),
-            py_version=py_version,
-            last_modified=last_modified,
-            history=history,
-            size=size)
-        if show_toxresults:
-            toxresults = get_toxresults_info(linkstore, link)
-            if toxresults:
-                fileinfo['toxresults'] = toxresults
-                fileinfo['toxresults_state'] = get_toxresults_state(toxresults)
-        files.append(fileinfo)
-    return files
+            return []
+
+    @cached_property
+    def last_modified(self):
+        return format_timetuple(parsedate(self.entry.last_modified))
+
+    @cached_property
+    def py_version(self):
+        (py_version, file_type) = self.pyversion_filetype
+        return '' if py_version == 'source' else py_version
+
+    @cached_property
+    def pyversion_filetype(self):
+        return get_pyversion_filetype(self.basename)
+
+    @cached_property
+    def size(self):
+        if self.entry.file_exists():
+            (value, unit) = sizeof_fmt(self.entry.file_size())
+            return f"{value:.0f} {unit}"
+        return ''
+
+    @cached_property
+    def title(self):
+        return self.basename
+
+    @cached_property
+    def toxresults(self):
+        if not self.show_toxresults:
+            return []
+        return get_toxresults_info(self.linkstore, self.link)
+
+    @cached_property
+    def toxresults_state(self):
+        return get_toxresults_state(self.toxresults)
+
+    @cached_property
+    def url(self):
+        url = url_for_entrypath(self.request, self.entry.relpath)
+        if self.hash_spec:
+            url = f"{url}#{self.hash_spec}"
+        return url
+
+
+def get_files_info(request, linkstore, *, show_toxresults=False):
+    filedata = sorted(
+        linkstore.get_links(rel='releasefile'),
+        key=attrgetter('basename'))
+    return [
+        FileInfo(request, link, linkstore, show_toxresults)
+        for link in filedata]
 
 
 def load_toxresult(link):
@@ -559,7 +603,7 @@ def index_get(context, request):
                 request.route_url, "toxresults",
                 user=stage.user.name, index=stage.index,
                 project=name, version=ver),
-            files=get_files_info(request, linkstore, show_toxresults),
+            files=get_files_info(request, linkstore, show_toxresults=show_toxresults),
             docs=get_docs_info(request, stage, linkstore),
             _version_data=verdata))
     packages.sort(key=lambda x: x["info"]["title"])
@@ -728,7 +772,7 @@ def version_get(context, request):
         infos.append((escape(key), value))
     show_toxresults = (stage.ixconfig['type'] != 'mirror')
     linkstore = stage.get_linkstore_perstage(name, version)
-    files = get_files_info(request, linkstore, show_toxresults)
+    files = get_files_info(request, linkstore, show_toxresults=show_toxresults)
     docs = get_docs_info(request, stage, linkstore)
     home_page = verdata.get("home_page")
     nav_links = []
@@ -856,23 +900,28 @@ def statusview(request):
             in_request=replica.get('in-request', 'unknown'),
             last_request=format_timestamp(
                 replica.get('last-request', 'unknown'))))
+    primary_url = status.get('primary-url', status.get('master-url'))
+    primary_uuid = status.get('primary-uuid', status.get('master-uuid'))
+    primary_serial = status.get('primary-serial', status.get('master-serial'))
+    primary_serial_ts = status.get('primary-serial-timestamp', status.get('master-serial-timestamp'))
+    update_from_primary_at = status.get('update-from-primary-at', status.get('update-from-master-at'))
     return dict(
         msgs=request.status_info['msgs'],
         info=dict(
             uuid=status.get('uuid', 'unknown'),
             role=status.get('role', 'unknown'),
             outside_url=status.get('outside-url', 'unknown'),
-            master_url=status.get('master-url'),
-            master_uuid=status.get('master-uuid'),
-            master_serial=status.get('master-serial'),
+            master_url=primary_url,
+            master_uuid=primary_uuid,
+            master_serial=primary_serial,
             master_serial_timestamp=format_timestamp(
-                status.get('master-serial-timestamp'), unset_value="never"),
+                primary_serial_ts, unset_value="never"),
             replica_started_at=format_timestamp(
                 status.get('replica-started-at')),
             replica_in_sync_at=format_timestamp(
                 status.get('replica-in-sync-at'), unset_value="never"),
             update_from_master_at=format_timestamp(
-                status.get('update-from-master-at'), unset_value="never"),
+                update_from_primary_at, unset_value="never"),
             serial=status.get('serial', 'unknown'),
             last_commit_timestamp=format_timestamp(
                 status.get('last-commit-timestamp', 'unknown')),