|
| 1 | +"""Helpers for repository package catalog, metrics, and rebuild collapse.""" |
| 2 | + |
| 3 | +from collections import defaultdict |
| 4 | + |
| 5 | +from django.db.models import CharField, Func, Max, Min, Q, Value |
| 6 | +from django.db.models.functions import Coalesce |
| 7 | + |
| 8 | +from pulp_python.app.models import PythonPackageContent |
| 9 | +from pulp_python.app.versions import ( |
| 10 | + BUILD_SUFFIX_PATTERN, |
| 11 | + normalize_package_index_ordering, |
| 12 | + version_sort_key, |
| 13 | +) |
| 14 | + |
| 15 | + |
| 16 | +def base_version_annotation(field_name="version"): |
| 17 | + """SQL expression that strips a trailing rebuild suffix from ``version``. |
| 18 | +
|
| 19 | + Uses ``versions.BUILD_SUFFIX_PATTERN`` (POSIX) so Python ``strip_build_suffix`` |
| 20 | + and this ``REGEXP_REPLACE`` stay aligned. Implemented with ``REGEXP_REPLACE`` |
| 21 | + so it does not depend on Django's ``RegexpReplace`` (not present in every |
| 22 | + Django 4.2/5.2 packaging Pulp uses). |
| 23 | + """ |
| 24 | + return Func( |
| 25 | + field_name, |
| 26 | + Value(BUILD_SUFFIX_PATTERN), |
| 27 | + Value(""), |
| 28 | + function="REGEXP_REPLACE", |
| 29 | + output_field=CharField(), |
| 30 | + ) |
| 31 | + |
| 32 | + |
| 33 | +def collapse_python_builds(queryset): |
| 34 | + """Keep one content unit per ``(name_normalized, base_version)``. |
| 35 | +
|
| 36 | + ``base_version`` is ``version`` with a trailing rebuild suffix stripped. |
| 37 | + The unit with the latest ``pulp_created`` is kept. Callers that want one |
| 38 | + row per logical version (not per wheel/sdist) should also filter |
| 39 | + ``packagetype``. |
| 40 | + """ |
| 41 | + return ( |
| 42 | + queryset.prefetch_related(None) |
| 43 | + .annotate(_collapse_base_version=base_version_annotation()) |
| 44 | + .order_by("name_normalized", "_collapse_base_version", "-pulp_created") |
| 45 | + .distinct("name_normalized", "_collapse_base_version") |
| 46 | + ) |
| 47 | + |
| 48 | + |
| 49 | +def python_packages_in_version(repository_version): |
| 50 | + """Python package content contained in ``repository_version``.""" |
| 51 | + if repository_version is None: |
| 52 | + return PythonPackageContent.objects.none() |
| 53 | + return PythonPackageContent.objects.filter(pk__in=repository_version.content) |
| 54 | + |
| 55 | + |
| 56 | +def apply_package_prefix_filters( |
| 57 | + queryset, |
| 58 | + name_normalized_prefix=None, |
| 59 | + name_prefix=None, |
| 60 | + name_normalized_contains=None, |
| 61 | +): |
| 62 | + """Apply case-insensitive name filters used by the package index.""" |
| 63 | + if name_normalized_prefix: |
| 64 | + queryset = queryset.filter(name_normalized__startswith=name_normalized_prefix) |
| 65 | + if name_normalized_contains: |
| 66 | + queryset = queryset.filter(name_normalized__contains=name_normalized_contains) |
| 67 | + if name_prefix: |
| 68 | + queryset = queryset.filter(name__istartswith=name_prefix) |
| 69 | + return queryset |
| 70 | + |
| 71 | + |
| 72 | +def membership_in_version_q(repository, repository_version): |
| 73 | + """Q-object matching RepositoryContent rows present in ``repository_version``.""" |
| 74 | + return Q( |
| 75 | + version_memberships__repository=repository, |
| 76 | + version_memberships__version_added__number__lte=repository_version.number, |
| 77 | + ) & ( |
| 78 | + Q(version_memberships__version_removed__isnull=True) |
| 79 | + | Q(version_memberships__version_removed__number__gt=repository_version.number) |
| 80 | + ) |
| 81 | + |
| 82 | + |
| 83 | +def last_updated_annotation(repository, repository_version): |
| 84 | + """Newest repository-membership time among all package units for a name. |
| 85 | +
|
| 86 | + Uses ``RepositoryContent.pulp_created`` (any rebuild/build), falling back to |
| 87 | + the content unit's ``pulp_created``. |
| 88 | + """ |
| 89 | + return Coalesce( |
| 90 | + Max( |
| 91 | + "version_memberships__pulp_created", |
| 92 | + filter=membership_in_version_q(repository, repository_version), |
| 93 | + ), |
| 94 | + Max("pulp_created"), |
| 95 | + ) |
| 96 | + |
| 97 | + |
| 98 | +def distinct_package_names_qs(content_qs, repository, repository_version, ordering=None): |
| 99 | + """One row per distinct ``name_normalized``, ordered for stable pagination.""" |
| 100 | + if ordering is None: |
| 101 | + ordering = normalize_package_index_ordering([]) |
| 102 | + qs = content_qs.order_by().values("name_normalized").annotate(name=Max("name")) |
| 103 | + if repository_version is None: |
| 104 | + qs = qs.annotate(last_updated=Max("pulp_created")) |
| 105 | + else: |
| 106 | + qs = qs.annotate(last_updated=last_updated_annotation(repository, repository_version)) |
| 107 | + return qs.order_by(*ordering) |
| 108 | + |
| 109 | + |
| 110 | +def assemble_package_index(content_qs, name_rows, repository, repository_version): |
| 111 | + """Build package-index dicts for ``name_rows``. |
| 112 | +
|
| 113 | + ``versions`` and ``latest_releases`` are distinct logical versions, newest |
| 114 | + first (PEP 440). ``created_at`` is the earliest repository-membership time |
| 115 | + (``RepositoryContent.pulp_created``) of any file of that logical version |
| 116 | + in ``repository_version``, falling back to the content unit's ``pulp_created``. |
| 117 | + ``last_updated`` is the newest membership among all units for the package |
| 118 | + (any rebuild), taken from ``name_rows`` when annotated. |
| 119 | + """ |
| 120 | + if not name_rows or repository_version is None: |
| 121 | + return [] |
| 122 | + |
| 123 | + names = [row["name_normalized"] for row in name_rows] |
| 124 | + name_by_normalized = {row["name_normalized"]: row["name"] for row in name_rows} |
| 125 | + |
| 126 | + in_this_version = membership_in_version_q(repository, repository_version) |
| 127 | + |
| 128 | + release_rows = ( |
| 129 | + content_qs.filter(name_normalized__in=names) |
| 130 | + .annotate(_base_version=base_version_annotation()) |
| 131 | + .values("name_normalized", "_base_version") |
| 132 | + .annotate( |
| 133 | + membership_created=Min( |
| 134 | + "version_memberships__pulp_created", |
| 135 | + filter=in_this_version, |
| 136 | + ), |
| 137 | + unit_created=Min("pulp_created"), |
| 138 | + ) |
| 139 | + ) |
| 140 | + |
| 141 | + releases_by_name = defaultdict(list) |
| 142 | + for rel in release_rows: |
| 143 | + releases_by_name[rel["name_normalized"]].append(rel) |
| 144 | + |
| 145 | + result = [] |
| 146 | + for row in name_rows: |
| 147 | + normalized = row["name_normalized"] |
| 148 | + rels = sorted( |
| 149 | + releases_by_name.get(normalized, []), |
| 150 | + key=lambda item: version_sort_key(item["_base_version"]), |
| 151 | + reverse=True, |
| 152 | + ) |
| 153 | + versions = [item["_base_version"] for item in rels] |
| 154 | + latest_releases = [ |
| 155 | + { |
| 156 | + "version": item["_base_version"], |
| 157 | + "release": "", |
| 158 | + "created_at": item["membership_created"] or item["unit_created"], |
| 159 | + } |
| 160 | + for item in rels |
| 161 | + ] |
| 162 | + result.append( |
| 163 | + { |
| 164 | + "name": name_by_normalized[normalized], |
| 165 | + "name_normalized": normalized, |
| 166 | + "last_updated": row.get("last_updated"), |
| 167 | + "versions": versions, |
| 168 | + "latest_releases": latest_releases, |
| 169 | + } |
| 170 | + ) |
| 171 | + return result |
| 172 | + |
| 173 | + |
| 174 | +def repository_metrics(content_qs): |
| 175 | + """Distinct package / logical-version / build counts for package content. |
| 176 | +
|
| 177 | + Identity is always ``PythonPackageContent`` (not filtered by packagetype): |
| 178 | +
|
| 179 | + * ``package_count``: distinct ``name_normalized`` |
| 180 | + * ``version_count``: distinct ``(name_normalized, base_version)`` |
| 181 | + * ``build_count``: distinct ``(name_normalized, version)`` |
| 182 | +
|
| 183 | + Until rebuild suffixes exist, ``version_count`` equals ``build_count``. |
| 184 | + """ |
| 185 | + content_qs = content_qs.order_by() |
| 186 | + return { |
| 187 | + "package_count": content_qs.values("name_normalized").distinct().count(), |
| 188 | + "version_count": ( |
| 189 | + content_qs.annotate(_base_version=base_version_annotation()) |
| 190 | + .values("name_normalized", "_base_version") |
| 191 | + .distinct() |
| 192 | + .count() |
| 193 | + ), |
| 194 | + "build_count": content_qs.values("name_normalized", "version").distinct().count(), |
| 195 | + } |
0 commit comments