Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle 500+ status codes when requesting a SoUD sync #8446

Merged
merged 1 commit into from
Sep 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
70 changes: 63 additions & 7 deletions kolibri/core/device/test/test_syncqueue.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import json
import time
from uuid import uuid4

import mock
from django.test import TestCase
from requests.exceptions import ConnectionError

from kolibri.core.auth.models import Facility
from kolibri.core.auth.models import FacilityUser
Expand Down Expand Up @@ -113,18 +113,74 @@ def test_request_soud_sync(
get_dataset_id.return_value = self.facility.dataset_id

requests_mock.post.return_value.status_code = 200
requests_mock.post.return_value.content = json.dumps({"action": SYNC})
requests_mock.post.return_value.json.return_value = {"action": SYNC}

network_connection = mock.Mock()
controller = MorangoProfileController.return_value
controller.create_network_connection.return_value = network_connection

request_soud_sync("http://whatever:8000", self.test_user.id)
scheduler.enqueue_in.call_count == 0
self.assertEqual(scheduler.enqueue_in.call_count, 0)

requests_mock.post.return_value.status_code = 200
requests_mock.post.return_value.content = json.dumps(
{"action": QUEUED, "keep_alive": "5", "id": str(uuid4())}
)
requests_mock.post.return_value.json.return_value = {
"action": QUEUED,
"keep_alive": "5",
"id": str(uuid4()),
}
request_soud_sync("whatever_server", self.test_user.id)
scheduler.enqueue_in.call_count == 1
self.assertEqual(scheduler.enqueue_in.call_count, 1)

@mock.patch("kolibri.core.public.utils.scheduler")
@mock.patch("kolibri.core.public.utils.requests")
@mock.patch("kolibri.core.tasks.api.MorangoProfileController")
@mock.patch("kolibri.core.tasks.api.get_client_and_server_certs")
@mock.patch("kolibri.core.tasks.api.get_dataset_id")
def test_request_soud_sync_server_error(
self,
get_dataset_id,
get_client_and_server_certs,
MorangoProfileController,
requests_mock,
scheduler,
):

get_client_and_server_certs.return_value = None
get_dataset_id.return_value = self.facility.dataset_id

requests_mock.post.return_value.status_code = 500

network_connection = mock.Mock()
controller = MorangoProfileController.return_value
controller.create_network_connection.return_value = network_connection

request_soud_sync("http://whatever:8000", self.test_user.id)

self.assertEqual(scheduler.enqueue_in.call_count, 1)

@mock.patch("kolibri.core.public.utils.scheduler")
@mock.patch("kolibri.core.public.utils.requests")
@mock.patch("kolibri.core.tasks.api.MorangoProfileController")
@mock.patch("kolibri.core.tasks.api.get_client_and_server_certs")
@mock.patch("kolibri.core.tasks.api.get_dataset_id")
def test_request_soud_sync_connection_error(
self,
get_dataset_id,
get_client_and_server_certs,
MorangoProfileController,
requests_mock,
scheduler,
):

get_client_and_server_certs.return_value = None
get_dataset_id.return_value = self.facility.dataset_id

requests_mock.post.side_effect = ConnectionError

network_connection = mock.Mock()
controller = MorangoProfileController.return_value
controller.create_network_connection.return_value = network_connection

request_soud_sync("http://whatever:8000", self.test_user.id)

self.assertEqual(scheduler.enqueue_in.call_count, 1)
6 changes: 4 additions & 2 deletions kolibri/core/public/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from django.core.urlresolvers import reverse
from django.utils import timezone
from morango.models import InstanceIDModel
from requests.exceptions import ConnectionError
from rest_framework import status

import kolibri
Expand Down Expand Up @@ -222,8 +223,9 @@ def request_soud_sync(server, user, queue_id=None, ttl=4):
# got a place in the queue to sync with this server, so we can be
# more sure that the server is actually available.
response = requests.put(server_url, json=data, timeout=30)

except requests.exceptions.ConnectionError:
if response.status_code >= status.HTTP_500_INTERNAL_SERVER_ERROR:
raise ConnectionError()
rtibbles marked this conversation as resolved.
Show resolved Hide resolved
except ConnectionError:
# Algorithm to try several times if the server is not responding
# Randomly it can be trying it up to 1560 seconds (26 minutes)
# before desisting
Expand Down