Automatic content syncing: preferred instance tracking and fixes

kolibri/core/content/api.py

@@ -1333,7 +1333,7 @@ def consolidate(self, items, queryset):
 
 
 class ContentRequestViewset(ReadOnlyValuesViewset, CreateModelMixin):
-    serializer_class = serializers.ContentDownloadRequestSeralizer
+    serializer_class = serializers.ContentDownloadRequestSerializer
 
     pagination_class = OptionalPageNumberPagination
 

kolibri/core/content/kolibri_plugin.py

@@ -28,19 +28,14 @@ def handle_initial(self, context):
         """
         :type context: morango.sync.context.LocalSessionContext
         """
-        from kolibri.core.device.utils import get_device_setting
-        from kolibri.core.device.utils import device_provisioned
+        from kolibri.core.content.utils.settings import automatic_download_enabled
 
         # only needs to synchronize requests when on receiving end of a sync
         self._assert(context.is_receiver)
 
         # either the device setting is enabled, or we haven't provisioned yet. If the device isn't
         # provisioned, we allow this because the default will be True after provisioning
-        self._assert(
-            get_device_setting(
-                "enable_automatic_download", default=not device_provisioned()
-            )
-        )
+        self._assert(automatic_download_enabled())
 
         dataset_id = get_dataset_id(context)
         logger.info(
@@ -69,8 +64,10 @@ def post_transfer(
         Processes content import using the post_transfer hook, outside of the sync process, but
         between push and pulls (since this processes when receiving)
         """
+        from kolibri.core.content.utils.settings import automatic_download_enabled
+
         # only process upon receiving
-        if not context.is_receiver:
+        if not context.is_receiver or not automatic_download_enabled():
             return
 
         # process metadata import for new requests without metadata

kolibri/core/content/migrations/0034_contentrequest_source_instance_id.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.29 on 2023-08-08 13:46
+from __future__ import unicode_literals
+
+import morango.models.fields.uuids
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("content", "0033_content_requests"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="contentrequest",
+            name="source_instance_id",
+            field=morango.models.fields.uuids.UUIDField(blank=True, null=True),
+        ),
+    ]

kolibri/core/content/models.py

@@ -463,6 +463,8 @@ class ContentRequest(models.Model):
     source_model = models.CharField(max_length=40)
     # the source model's PK, could be the user's ID
     source_id = UUIDField()
+    # the instance ID of the preferred device from which to source/download the content
+    source_instance_id = UUIDField(null=True, blank=True)
 
     requested_at = DateTimeTzField(default=local_now)
 

kolibri/core/content/serializers.py

@@ -265,18 +265,14 @@ class ContentDownloadRequestMetadataSerializer(serializers.Serializer):
     )
 
 
-class ContentDownloadRequestSeralizer(serializers.ModelSerializer):
-
+class ContentDownloadRequestSerializer(serializers.ModelSerializer):
+    source_instance_id = serializers.UUIDField(required=False, allow_null=True)
     metadata = ContentDownloadRequestMetadataSerializer()
 
     class Meta:
 
         model = ContentDownloadRequest
-        fields = (
-            "id",
-            "contentnode_id",
-            "metadata",
-        )
+        fields = ("id", "contentnode_id", "metadata", "source_instance_id")
 
     def create(self, validated_data):
         # if there is an existing deletion request, delete the deletion request
@@ -307,6 +303,7 @@ def create(self, validated_data):
         content_request = ContentDownloadRequest.build_for_user(user)
         content_request.metadata = validated_data["metadata"]
         content_request.contentnode_id = validated_data["contentnode_id"]
+        content_request.source_instance_id = validated_data.get("source_instance_id")
 
         content_request.save()
         automatic_resource_import.enqueue_if_not()

kolibri/core/content/tasks.py

@@ -1,4 +1,5 @@
 import requests
+from django.core.exceptions import ValidationError
 from django.core.management import call_command
 from rest_framework import serializers
 from six import with_metaclass
@@ -19,8 +20,8 @@
     RemoteChannelResourceImportManager,
 )
 from kolibri.core.content.utils.resource_import import RemoteChannelUpdateManager
+from kolibri.core.content.utils.settings import automatic_download_enabled
 from kolibri.core.content.utils.upgrade import diff_stats
-from kolibri.core.device.utils import get_device_setting
 from kolibri.core.discovery.models import NetworkLocation
 from kolibri.core.discovery.utils.network.client import NetworkClient
 from kolibri.core.discovery.utils.network.errors import IncompatibleVersionError
@@ -343,7 +344,16 @@ def remoteresourceimport(
     import_manager.run()
 
 
+class AutomaticDownloadValidator(JobValidator):
+    def validate(self, data):
+        job_data = super(AutomaticDownloadValidator, self).validate(data)
+        if not automatic_download_enabled():
+            raise ValidationError("Automatic download is not enabled")
+        return job_data
+
+
 @register_task(
+    validator=AutomaticDownloadValidator,
     queue=QUEUE,
     long_running=True,
     status_fn=get_status,
@@ -352,6 +362,8 @@ def automatic_resource_import():
     """
     Processes content download and removal requests
     """
+    if not automatic_download_enabled():
+        return
     process_content_requests()
 
 
@@ -366,16 +378,20 @@ def automatic_synchronize_content_requests_and_import():
     - Enqueues the automatic_resource_import task after synchronizing content requests.
     """
     # A safety check to see if the device settings are changed already?
-    if get_device_setting("enable_automatic_download", default=False) is True:
+    if not automatic_download_enabled():
         return
-    else:
-        dataset_ids = FacilityDataset.objects.values_list("id", flat=True)
 
-        # Synchronize content requests for each dataset
-        for dataset_id in dataset_ids:
-            synchronize_content_requests(dataset_id, None)
+    dataset_ids = FacilityDataset.objects.values_list("id", flat=True)
+
+    # Synchronize content requests for each dataset
+    for dataset_id in dataset_ids:
+        # in case it takes a long time to synchronize content requests for a dataset, we want to
+        # check if the device settings are changed
+        if not automatic_download_enabled():
+            return
+        synchronize_content_requests(dataset_id, None)
 
-        automatic_resource_import.enqueue_if_not()
+    automatic_resource_import.enqueue_if_not()
 
 
 class ExportChannelResourcesValidator(LocalMixin, ChannelResourcesValidator):

kolibri/core/content/test/test_content_app.py

@@ -553,6 +553,10 @@ class ContentNodeAPITestCase(ContentNodeAPIBase, APITestCase):
     Testcase for content API methods
     """
 
+    def setUp(self):
+        super(ContentNodeAPITestCase, self).setUp()
+        self.maxDiff = 10000
+
     def test_prerequisite_for_filter(self):
         c1_id = content.ContentNode.objects.get(title="c1").id
         response = self.client.get(
@@ -1839,6 +1843,10 @@ def tearDown(self):
 
 
 class ProxyContentMetadataTestCase(ContentNodeAPIBase, LiveServerTestCase):
+    def setUp(self):
+        super(ProxyContentMetadataTestCase, self).setUp()
+        self.maxDiff = 10000
+
     @property
     def baseurl(self):
         return self.live_server_url