pulpcore 3.87.1__tar.gz → 3.88.0__tar.gz

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

@@ -8,24 +8,36 @@
 
 [//]: # (towncrier release notes start)
 
-## 3.87.1 (2025-09-03) {: #3.87.1 }
+## 3.88.0 (2025-09-03) {: #3.88.0 }
 
-### REST API {: #3.87.1-rest-api }
+### REST API {: #3.88.0-rest-api }
 
-#### Bugfixes {: #3.87.1-rest-api-bugfix }
+#### 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.87.1-plugin-api }
+### Plugin API {: #3.88.0-plugin-api }
 
-No significant changes.
+#### Deprecations {: #3.88.0-plugin-api-deprecation }
 
-### Pulp File {: #3.87.1-pulp-file }
+- 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)
 
-No significant changes.
+### 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.87.1-pulp-cert-guard }
+### Pulp Cert Guard {: #3.88.0-pulp-cert-guard }
 
 No significant changes.
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pulpcore
-Version: 3.87.1
+Version: 3.88.0
 Summary: Pulp Django Application and Related Modules
 Author-email: Pulp Team <pulp-list@redhat.com>
 Project-URL: Homepage, https://pulpproject.org

{pulpcore-3.87.1 → pulpcore-3.88.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.88.0"
     python_package_name = "pulpcore"
     domain_compatible = True

{pulpcore-3.87.1 → pulpcore-3.88.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.88.0"
     python_package_name = "pulpcore"
     domain_compatible = True

{pulpcore-3.87.1 → pulpcore-3.88.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.88.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.88.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.88.0"
 
     # The python package name providing this app
     python_package_name = "pulpcore"

pulpcore-3.88.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.87.1 → pulpcore-3.88.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
@@ -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.
@@ -160,6 +162,8 @@ 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)
 
@@ -229,22 +233,36 @@ 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(
             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

{pulpcore-3.87.1 → pulpcore-3.88.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.88.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.88.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.88.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

{pulpcore-3.87.1 → pulpcore-3.88.0}/pulpcore/tasking/tasks.py

@@ -95,7 +95,7 @@ def _execute_task(task):
                 coro = asyncio.wait_for(coro, timeout=IMMEDIATE_TIMEOUT)
             loop = asyncio.get_event_loop()
             try:
-                loop.run_until_complete(coro)
+                result = loop.run_until_complete(coro)
             except asyncio.TimeoutError:
                 _logger.info(
                     "Immediate task %s timed out after %s seconds.", task.pk, IMMEDIATE_TIMEOUT
@@ -106,7 +106,7 @@ def _execute_task(task):
                     )
                 )
         else:
-            func(*args, **kwargs)
+            result = func(*args, **kwargs)
 
     except Exception:
         exc_type, exc, tb = sys.exc_info()
@@ -123,7 +123,7 @@ def _execute_task(task):
         _logger.info("\n".join(traceback.format_list(traceback.extract_tb(tb))))
         send_task_notification(task)
     else:
-        task.set_completed()
+        task.set_completed(result)
         execution_time = task.finished_at - task.started_at
         execution_time_us = int(execution_time.total_seconds() * 1_000_000)  # μs
         _logger.info(

{pulpcore-3.87.1 → pulpcore-3.88.0}/pulpcore/tests/functional/api/using_plugin/test_tasks.py

@@ -169,3 +169,23 @@ def test_reserved_resources_filter(setup_filter_fixture, pulpcore_bindings):
     assert set(h.pulp_href for h in prn_results.results) == task_hrefs
     mixed_results = pulpcore_bindings.TasksApi.list(exclusive_resources__in=[repo_prn, remote_prn])
     assert mixed_results.count == 0
+
+
+@pytest.mark.parallel
+def test_task_result(add_to_cleanup, file_bindings, monitor_task):
+    """
+    Test that when performing `general_create` or `ageneral_update`,
+    the result of the task is stored in the `Task.result` field.
+    """
+    # test create
+    body = {"name": str(uuid4()), "base_path": str(uuid4())}
+    task = monitor_task(file_bindings.DistributionsFileApi.create(body).task)
+    assert task.result["base_path"] == body["base_path"]
+
+    # test update
+    dist_href = task.result["pulp_href"]
+    updated_body = {"name": str(uuid4()), "base_path": str(uuid4())}
+    task_2 = monitor_task(file_bindings.DistributionsFileApi.update(dist_href, updated_body).task)
+    assert task_2.result["base_path"] == updated_body["base_path"]
+
+    add_to_cleanup(file_bindings.DistributionsFileApi, dist_href)

{pulpcore-3.87.1 → pulpcore-3.88.0}/pulpcore.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pulpcore
-Version: 3.87.1
+Version: 3.88.0
 Summary: Pulp Django Application and Related Modules
 Author-email: Pulp Team <pulp-list@redhat.com>
 Project-URL: Homepage, https://pulpproject.org

{pulpcore-3.87.1 → pulpcore-3.88.0}/pulpcore.egg-info/SOURCES.txt

@@ -210,6 +210,7 @@ pulpcore/app/migrations/0138_vulnerabilityreport.py
 pulpcore/app/migrations/0139_task_app_lock.py
 pulpcore/app/migrations/0140_require_appstatus_zdu.py
 pulpcore/app/migrations/0141_alter_appstatus_name.py
+pulpcore/app/migrations/0142_task_result.py
 pulpcore/app/migrations/__init__.py
 pulpcore/app/models/__init__.py
 pulpcore/app/models/access_policy.py

{pulpcore-3.87.1 → pulpcore-3.88.0}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = 'setuptools.build_meta'
 
 [project]
 name = "pulpcore"
-version = "3.87.1"
+version = "3.88.0"
 description = "Pulp Django Application and Related Modules"
 readme = "README.md"
 authors = [
@@ -204,7 +204,7 @@ ignore = [
 [tool.bumpversion]
 # This section is managed by the plugin template. Do not edit manually.
 
-current_version = "3.87.1"
+current_version = "3.88.0"
 commit = false
 tag = false
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<alpha>0a)?(?P<patch>\\d+)(\\.(?P<release>[a-z]+))?"