pulpcore 3.87.1__tar.gz → 3.89.0__tar.gz

{pulpcore-3.87.1 → pulpcore-3.89.0}/CHANGES.md

@@ -8,13 +8,70 @@
 
 [//]: # (towncrier release notes start)
 
+## 3.89.0 (2025-09-09) {: #3.89.0 }
+
+### REST API {: #3.89.0-rest-api }
+
+#### Features {: #3.89.0-rest-api-feature }
+
+- Stop using advisory locks in favor of a database column for locking on tasks.
+
+### Plugin API {: #3.89.0-plugin-api }
+
+No significant changes.
+
+### Pulp File {: #3.89.0-pulp-file }
+
+No significant changes.
+
+### Pulp Cert Guard {: #3.89.0-pulp-cert-guard }
+
+No significant changes.
+
+---
+
+## 3.88.0 (2025-09-03) {: #3.88.0 }
+
+### REST API {: #3.88.0-rest-api }
+
+#### Features {: #3.88.0-rest-api-feature }
+
+- Added a `result` JSONField to the `Task` model to store the task's return value.
+  [#6901](https://github.com/pulp/pulpcore/issues/6901)
+
+#### Bugfixes {: #3.88.0-rest-api-bugfix }
+
+- Fixed error case where worker tried to aquire the app lock for a Task that was already finished.
+  [#6899](https://github.com/pulp/pulpcore/issues/6899)
+
+### Plugin API {: #3.88.0-plugin-api }
+
+#### Deprecations {: #3.88.0-plugin-api-deprecation }
+
+- Deprecated returning non-JSON-serializable values from tasks.
+  Such values will be replaced with `None`, and this workaround will be removed in version 3.100.
+  [#6901](https://github.com/pulp/pulpcore/issues/6901)
+
+### Pulp File {: #3.88.0-pulp-file }
+
+#### Features {: #3.88.0-pulp-file-feature }
+
+- Updated tasks to always return JSON-serializable value.
+  [#6901](https://github.com/pulp/pulpcore/issues/6901)
+
+### Pulp Cert Guard {: #3.88.0-pulp-cert-guard }
+
+No significant changes.
+
+---
+
 ## 3.87.1 (2025-09-03) {: #3.87.1 }
 
 ### REST API {: #3.87.1-rest-api }
 
 #### Bugfixes {: #3.87.1-rest-api-bugfix }
 
-- Fixed error case where worker tried to aquire the app_lock for a Task that was already finished.
+- Fixed error case where worker tried to aquire the app lock for a Task that was already finished.
   [#6899](https://github.com/pulp/pulpcore/issues/6899)
 
 ### Plugin API {: #3.87.1-plugin-api }
@@ -60,7 +117,7 @@ No significant changes.
 
 #### Features {: #3.86.0-rest-api-feature }
 
-- Added a configurable bucket boundary for API request duration metric using the OTEL_PULP_API_HISTOGRAM_BUCKETS setting.
+- Added a configurable bucket boundary for API request duration metric using the `OTEL_PULP_API_HISTOGRAM_BUCKETS` setting.
   [#6845](https://github.com/pulp/pulpcore/issues/6845)
 
 #### Bugfixes {: #3.86.0-rest-api-bugfix }
@@ -73,7 +130,7 @@ No significant changes.
 
 #### Improved Documentation {: #3.86.0-rest-api-doc }
 
-- Updated documentation for the TASK_DIAGNOSTICS setting.
+- Updated documentation for the `TASK_DIAGNOSTICS` setting.
   [#6854](https://github.com/pulp/pulpcore/issues/6854)
 
 ### Plugin API {: #3.86.0-plugin-api }

{pulpcore-3.87.1 → pulpcore-3.89.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pulpcore
-Version: 3.87.1
+Version: 3.89.0
 Summary: Pulp Django Application and Related Modules
 Author-email: Pulp Team <pulp-list@redhat.com>
 Project-URL: Homepage, https://pulpproject.org
@@ -46,7 +46,7 @@ Requires-Dist: opentelemetry-api<1.37,>=1.27.0
 Requires-Dist: opentelemetry-sdk<1.37,>=1.27.0
 Requires-Dist: opentelemetry-exporter-otlp-proto-http<1.37,>=1.27.0
 Requires-Dist: protobuf<7.0,>=4.21.1
-Requires-Dist: pulp-glue<0.36,>=0.28.0
+Requires-Dist: pulp-glue<0.37,>=0.28.0
 Requires-Dist: pygtrie<=2.5.0,>=2.5
 Requires-Dist: psycopg[binary]<3.3,>=3.1.8
 Requires-Dist: pyparsing<3.3,>=3.1.0

{pulpcore-3.87.1 → pulpcore-3.89.0}/pulp_certguard/app/__init__.py

@@ -6,6 +6,6 @@ class PulpCertGuardPluginAppConfig(PulpPluginAppConfig):
 
     name = "pulp_certguard.app"
     label = "certguard"
-    version = "3.87.1"
+    version = "3.89.0"
     python_package_name = "pulpcore"
     domain_compatible = True

{pulpcore-3.87.1 → pulpcore-3.89.0}/pulp_file/app/__init__.py

@@ -8,6 +8,6 @@ class PulpFilePluginAppConfig(PulpPluginAppConfig):
 
     name = "pulp_file.app"
     label = "file"
-    version = "3.87.1"
+    version = "3.89.0"
     python_package_name = "pulpcore"
     domain_compatible = True

{pulpcore-3.87.1 → pulpcore-3.89.0}/pulp_file/app/tasks/publishing.py

@@ -13,6 +13,7 @@ from pulpcore.plugin.models import (
 )
 
 from pulp_file.app.models import FilePublication
+from pulp_file.app.serializers import FilePublicationSerializer
 from pulp_file.manifest import Entry, Manifest
 
 
@@ -51,6 +52,10 @@ def publish(manifest, repository_version_pk, checkpoint=False):
 
         log.info(_("Publication: {publication} created").format(publication=publication.pk))
 
+        publication = FilePublicationSerializer(
+            instance=publication, context={"request": None}
+        ).data
+
         return publication
 
 

{pulpcore-3.87.1 → pulpcore-3.89.0}/pulp_file/app/tasks/synchronizing.py

@@ -7,6 +7,7 @@ from urllib.parse import quote, urlparse, urlunparse
 from django.core.files import File
 
 from pulpcore.plugin.models import Artifact, ProgressReport, Remote, PublishedMetadata
+from pulpcore.plugin.serializers import RepositoryVersionSerializer
 from pulpcore.plugin.stages import (
     DeclarativeArtifact,
     DeclarativeContent,
@@ -65,6 +66,9 @@ def synchronize(remote_pk, repository_pk, mirror, url=None):
 
         log.info(_("Publication: {publication} created").format(publication=publication.pk))
 
+    if rv:
+        rv = RepositoryVersionSerializer(instance=rv, context={"request": None}).data
+
     return rv
 
 

{pulpcore-3.87.1 → pulpcore-3.89.0}/pulpcore/app/apps.py

@@ -239,7 +239,7 @@ class PulpAppConfig(PulpPluginAppConfig):
     label = "core"
 
     # The version of this app
-    version = "3.87.1"
+    version = "3.89.0"
 
     # The python package name providing this app
     python_package_name = "pulpcore"

pulpcore-3.89.0/pulpcore/app/migrations/0142_task_result.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.23 on 2025-08-29 13:34
+
+import django.core.serializers.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("core", "0141_alter_appstatus_name"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="task",
+            name="result",
+            field=models.JSONField(
+                default=None, encoder=django.core.serializers.json.DjangoJSONEncoder, null=True
+            ),
+        ),
+    ]

pulpcore-3.89.0/pulpcore/app/migrations/0143_require_app_lock_zdu.py

@@ -0,0 +1,15 @@
+# Generated by Django 4.2.23 on 2025-09-04 08:58
+
+from django.db import migrations
+from pulpcore.migrations import RequireVersion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("core", "0142_task_result"),
+    ]
+
+    operations = [
+        RequireVersion("core", "3.87"),
+    ]

{pulpcore-3.87.1 → pulpcore-3.89.0}/pulpcore/app/models/task.py

@@ -2,6 +2,7 @@
 Django models related to the Tasking system
 """
 
+import json
 import logging
 import traceback
 from datetime import timedelta
@@ -11,7 +12,7 @@ from django.conf import settings
 from django.contrib.postgres.fields import ArrayField, HStoreField
 from django.contrib.postgres.indexes import GinIndex
 from django.core.serializers.json import DjangoJSONEncoder
-from django.db import connection, models
+from django.db import models
 from django.utils import timezone
 from django_lifecycle import hook, AFTER_CREATE
 
@@ -20,10 +21,10 @@ from pulpcore.app.models import (
     BaseModel,
     GenericRelationModel,
 )
-from pulpcore.app.models.status import BaseAppStatus
+from pulpcore.app.models.status import AppStatus, BaseAppStatus
 from pulpcore.app.models.fields import EncryptedJSONField
 from pulpcore.constants import TASK_CHOICES, TASK_INCOMPLETE_STATES, TASK_STATES
-from pulpcore.exceptions import AdvisoryLockError, exception_to_dict
+from pulpcore.exceptions import exception_to_dict
 from pulpcore.app.util import get_domain_pk, current_task
 from pulpcore.app.loggers import deprecation_logger
 
@@ -114,6 +115,7 @@ class Task(BaseModel, AutoAddObjPermsMixin):
         deferred (models.BooleanField): Whether to allow defer running the task to a
             pulpcore_worker. Both `immediate` and `deferred` cannot both be `False`.
             Defaults to `True`.
+        result (models.JSONField): The result of the task
 
     Relations:
         app_lock (AppStatus): The app holding the lock on this task.
@@ -139,7 +141,7 @@ class Task(BaseModel, AutoAddObjPermsMixin):
     enc_kwargs = EncryptedJSONField(null=True, encoder=DjangoJSONEncoder)
 
     worker = models.ForeignKey("Worker", null=True, related_name="tasks", on_delete=models.SET_NULL)
-    # This field is supposed to replace the session advisory locks to protect tasks.
+    # This field is the lock to protect tasks.
     app_lock = models.ForeignKey(
         "AppStatus", null=True, related_name="tasks", on_delete=models.SET_NULL
     )
@@ -160,25 +162,11 @@ class Task(BaseModel, AutoAddObjPermsMixin):
     immediate = models.BooleanField(default=False, null=True)
     deferred = models.BooleanField(default=True, null=True)
 
+    result = models.JSONField(default=None, null=True, encoder=DjangoJSONEncoder)
+
     def __str__(self):
         return "Task: {name} [{state}]".format(name=self.name, state=self.state)
 
-    def __enter__(self):
-        self.lock = _uuid_to_advisory_lock(self.pk.int)
-        with connection.cursor() as cursor:
-            cursor.execute("SELECT pg_try_advisory_lock(%s)", [self.lock])
-            acquired = cursor.fetchone()[0]
-        if not acquired:
-            raise AdvisoryLockError("Could not acquire lock.")
-        return self
-
-    def __exit__(self, exc_type, exc_value, traceback):
-        with connection.cursor() as cursor:
-            cursor.execute("SELECT pg_advisory_unlock(%s)", [self.lock])
-            released = cursor.fetchone()[0]
-        if not released:
-            raise RuntimeError("Lock not held.")
-
     @staticmethod
     def current_id():
         """
@@ -214,7 +202,11 @@ class Task(BaseModel, AutoAddObjPermsMixin):
         This updates the :attr:`started_at` and sets the :attr:`state` to :attr:`RUNNING`.
         """
         started_at = timezone.now()
-        rows = Task.objects.filter(pk=self.pk, state=TASK_STATES.WAITING).update(
+        rows = Task.objects.filter(
+            pk=self.pk,
+            state=TASK_STATES.WAITING,
+            app_lock=AppStatus.objects.current(),
+        ).update(
             state=TASK_STATES.RUNNING,
             started_at=started_at,
         )
@@ -229,22 +221,40 @@ class Task(BaseModel, AutoAddObjPermsMixin):
                 )
             )
 
-    def set_completed(self):
+    def set_completed(self, result=None):
         """
         Set this Task to the completed state, save it, and log output in warning cases.
 
         This updates the :attr:`finished_at` and sets the :attr:`state` to :attr:`COMPLETED`.
+        If `result` is provided, the :attr:`result` contains the result of the task.
         """
+        try:
+            json.dumps(result, cls=DjangoJSONEncoder)
+        except (TypeError, ValueError):
+            deprecation_logger.warning(
+                _(
+                    "The result of the {} function is not JSON-serializable and will be "
+                    "replaced with None: {}. This will raise an error in version 3.100."
+                ).format(self.name, result)
+            )
+            result = None
+
         # Only set the state to finished if it's running. This is important for when the task has
         # been canceled, so we don't move the task from canceled to finished.
         finished_at = timezone.now()
-        rows = Task.objects.filter(pk=self.pk, state=TASK_STATES.RUNNING).update(
+        rows = Task.objects.filter(
+            pk=self.pk,
+            state=TASK_STATES.RUNNING,
+            app_lock=AppStatus.objects.current(),
+        ).update(
             state=TASK_STATES.COMPLETED,
             finished_at=finished_at,
+            result=result,
         )
         if rows == 1:
             self.state = TASK_STATES.COMPLETED
             self.finished_at = finished_at
+            self.result = result
         else:
             self.refresh_from_db()
             # If the user requested to cancel this task while the worker finished it, we leave it
@@ -271,7 +281,11 @@ class Task(BaseModel, AutoAddObjPermsMixin):
         finished_at = timezone.now()
         tb_str = "".join(traceback.format_tb(tb))
         error = exception_to_dict(exc, tb_str)
-        rows = Task.objects.filter(pk=self.pk, state=TASK_STATES.RUNNING).update(
+        rows = Task.objects.filter(
+            pk=self.pk,
+            state=TASK_STATES.RUNNING,
+            app_lock=AppStatus.objects.current(),
+        ).update(
             state=TASK_STATES.FAILED,
             finished_at=finished_at,
             error=error,
@@ -318,7 +332,11 @@ class Task(BaseModel, AutoAddObjPermsMixin):
         task_data = {}
         if reason:
             task_data["error"] = {"reason": reason}
-        rows = Task.objects.filter(pk=self.pk, state=TASK_STATES.CANCELING).update(
+        rows = Task.objects.filter(
+            pk=self.pk,
+            state=TASK_STATES.CANCELING,
+            app_lock=AppStatus.objects.current(),
+        ).update(
             state=final_state,
             finished_at=finished_at,
             **task_data,

{pulpcore-3.87.1 → pulpcore-3.89.0}/pulpcore/app/serializers/task.py

@@ -88,6 +88,10 @@ class TaskSerializer(ModelSerializer):
         help_text=_("A list of resources required by that task."),
         read_only=True,
     )
+    result = serializers.JSONField(
+        read_only=True,
+        help_text=_("The result of this task."),
+    )
 
     def get_created_by(self, obj):
         if task_user_map := self.context.get("task_user_mapping"):
@@ -115,6 +119,7 @@ class TaskSerializer(ModelSerializer):
             "progress_reports",
             "created_resources",
             "reserved_resources_record",
+            "result",
         )
 
 

{pulpcore-3.87.1 → pulpcore-3.89.0}/pulpcore/app/settings.py

@@ -216,8 +216,6 @@ TIME_ZONE = "UTC"
 
 USE_I18N = "USE_I18N", True
 
-USE_L10N = True
-
 USE_TZ = True
 
 

{pulpcore-3.87.1 → pulpcore-3.89.0}/pulpcore/app/tasks/base.py

@@ -19,7 +19,8 @@ def general_create_from_temp_file(app_label, serializer_name, temp_file_pk, *arg
     context = kwargs.pop("context", {})
     context["pulp_temp_file_pk"] = temp_file_pk
 
-    general_create(app_label, serializer_name, data=data, context=context, *args, **kwargs)
+    data = general_create(app_label, serializer_name, data=data, context=context, *args, **kwargs)
+    return data
 
 
 def general_create(app_label, serializer_name, *args, **kwargs):
@@ -33,6 +34,7 @@ def general_create(app_label, serializer_name, *args, **kwargs):
     data = kwargs.pop("data", None)
 
     context = kwargs.pop("context", {})
+    context.setdefault("request", None)
     serializer_class = get_plugin_config(app_label).named_serializers[serializer_name]
     serializer = serializer_class(data=data, context=context)
 
@@ -42,6 +44,7 @@ def general_create(app_label, serializer_name, *args, **kwargs):
         instance = instance.cast()
     resource = CreatedResource(content_object=instance)
     resource.save()
+    return serializer.data
 
 
 def general_update(instance_id, app_label, serializer_name, *args, **kwargs):
@@ -130,13 +133,17 @@ async def ageneral_update(instance_id, app_label, serializer_name, *args, **kwar
     """
     data = kwargs.pop("data", None)
     partial = kwargs.pop("partial", False)
+    context = kwargs.pop("context", {})
+    context.setdefault("request", None)
+
     serializer_class = get_plugin_config(app_label).named_serializers[serializer_name]
     instance = await serializer_class.Meta.model.objects.aget(pk=instance_id)
     if isinstance(instance, MasterModel):
         instance = await instance.acast()
-    serializer = serializer_class(instance, data=data, partial=partial)
+    serializer = serializer_class(instance, data=data, partial=partial, context=context)
     await sync_to_async(serializer.is_valid)(raise_exception=True)
     await sync_to_async(serializer.save)()
+    return await sync_to_async(lambda: serializer.data)()
 
 
 async def ageneral_delete(instance_id, app_label, serializer_name):

{pulpcore-3.87.1 → pulpcore-3.89.0}/pulpcore/content/handler.py

@@ -7,6 +7,7 @@ import socket
 import struct
 from gettext import gettext as _
 from datetime import datetime, timedelta
+from datetime import timezone as dt_timezone
 
 from aiohttp.client_exceptions import ClientResponseError, ClientConnectionError
 from aiohttp.web import FileResponse, StreamResponse, HTTPOk
@@ -115,7 +116,7 @@ class DistroListings(HTTPOk):
         if path == "":
             path = settings.CONTENT_PATH_PREFIX
         html = Handler.render_html(directory_list, path=path)
-        super().__init__(body=html, headers={"Content-Type": "text/html"})
+        super().__init__(text=html, headers={"Content-Type": "text/html"})
 
 
 class CheckpointListings(HTTPOk):
@@ -137,7 +138,7 @@ class CheckpointListings(HTTPOk):
         dates = {f"{Handler._format_checkpoint_timestamp(s)}/": s for s in checkpoints}
         directory_list = dates.keys()
         html = Handler.render_html(directory_list, dates=dates, path=path)
-        super().__init__(body=html, headers={"Content-Type": "text/html"})
+        super().__init__(text=html, headers={"Content-Type": "text/html"})
 
 
 class ArtifactNotFound(Exception):
@@ -439,9 +440,9 @@ class Handler:
         else:
             raise PathNotResolved(path)
 
-        request_timestamp = request_timestamp.replace(tzinfo=timezone.utc)
+        request_timestamp = request_timestamp.replace(tzinfo=dt_timezone.utc)
         # Future timestamps are not allowed for checkpoints
-        if request_timestamp > datetime.now(tz=timezone.utc):
+        if request_timestamp > datetime.now(tz=dt_timezone.utc):
             raise PathNotResolved(path)
         # The timestamp is truncated to seconds, so we need to cover the whole second
         request_timestamp = request_timestamp.replace(microsecond=999999)
@@ -787,7 +788,7 @@ class Handler:
                 elif dir_list:
                     return HTTPOk(
                         headers={"Content-Type": "text/html"},
-                        body=self.render_html(
+                        text=self.render_html(
                             dir_list, path=request.path, dates=dates, sizes=sizes
                         ),
                     )
@@ -862,7 +863,7 @@ class Handler:
                 elif dir_list:
                     return HTTPOk(
                         headers={"Content-Type": "text/html"},
-                        body=self.render_html(
+                        text=self.render_html(
                             dir_list, path=request.path, dates=dates, sizes=sizes
                         ),
                     )

{pulpcore-3.87.1 → pulpcore-3.89.0}/pulpcore/plugin/serializers/__init__.py

@@ -31,6 +31,7 @@ from pulpcore.app.serializers import (
     RepositorySerializer,
     RepositorySyncURLSerializer,
     RepositoryVersionRelatedField,
+    RepositoryVersionSerializer,
     SingleArtifactContentSerializer,
     SingleContentArtifactField,
     TaskGroupOperationResponseSerializer,
@@ -79,6 +80,7 @@ __all__ = [
     "RepositorySerializer",
     "RepositorySyncURLSerializer",
     "RepositoryVersionRelatedField",
+    "RepositoryVersionSerializer",
     "SingleArtifactContentSerializer",
     "SingleContentArtifactField",
     "TaskGroupOperationResponseSerializer",

{pulpcore-3.87.1 → pulpcore-3.89.0}/pulpcore/plugin/serializers/content.py

@@ -85,7 +85,7 @@ class UploadSerializerFieldsMixin(Serializer):
 
         data = super().validate(data)
 
-        if "request" in self.context:
+        if self.context.get("request") is not None:
             upload_fields = {
                 field
                 for field in self.Meta.fields