[req-changes] Moved zerotier tasks and changed 'exc' to 'e' for consistency

Author: Aryamanz29

openwisp_controller/config/base/vpn.py

@@ -23,9 +23,8 @@
 from .. import settings as app_settings
 from ..api.zerotier_service import ZerotierService
 from ..signals import vpn_peers_changed, vpn_server_modified
-from ..tasks import (
-    create_vpn_dh,
-    trigger_vpn_server_endpoint,
+from ..tasks import create_vpn_dh, trigger_vpn_server_endpoint
+from ..tasks_zerotier import (
     trigger_zerotier_server_delete,
     trigger_zerotier_server_join,
     trigger_zerotier_server_update,
@@ -263,7 +262,7 @@ def save(self, *args, **kwargs):
                 self._create_zerotier_server(config)
         try:
             super().save(*args, **kwargs)
-        except Exception as exc:
+        except Exception as e:
             # If the db transaction for zt vpn server creation fails
             # for any reason, we should delete the recently
             # created zt network to prevent duplicate networks
@@ -274,7 +273,7 @@ def save(self, *args, **kwargs):
                     network_id=self.network_id,
                     vpn_id=self.pk,
                 )
-            raise exc
+            raise e
         if create_dh:
             transaction.on_commit(lambda: create_vpn_dh.delay(self.id))
         if not created and self._send_vpn_modified_after_save:

openwisp_controller/config/tasks.py

@@ -1,114 +1,17 @@
 import logging
-from http import HTTPStatus
-from time import sleep
 
 import requests
 from celery import shared_task
 from celery.exceptions import SoftTimeLimitExceeded
 from django.conf import settings
-from django.core.cache import cache
 from django.core.exceptions import ObjectDoesNotExist
-from openwisp_notifications.signals import notify
-from requests.exceptions import RequestException
 from swapper import load_model
 
-from openwisp_controller.config.api.zerotier_service import ZerotierService
 from openwisp_utils.tasks import OpenwispCeleryTask
 
-from .settings import API_TASK_RETRY_OPTIONS
-
 logger = logging.getLogger(__name__)
 
 
-class OpenwispApiTask(OpenwispCeleryTask):
-
-    _RECOVERABLE_API_CODES = [
-        HTTPStatus.TOO_MANY_REQUESTS,  # 429
-        HTTPStatus.INTERNAL_SERVER_ERROR,  # 500
-        HTTPStatus.BAD_GATEWAY,  # 502
-        HTTPStatus.SERVICE_UNAVAILABLE,  # 503
-        HTTPStatus.GATEWAY_TIMEOUT,  # 504
-    ]
-
-    def _send_api_task_notification(self, type, **kwargs):
-        vpn = kwargs.get('instance')
-        action = kwargs.get('action').replace('_', ' ')
-        status_code = kwargs.get('status_code')
-        # Adding some delay here to prevent overlapping
-        # of the django success message container
-        # with the ow-notification container
-        # https://github.com/openwisp/openwisp-notifications/issues/264
-        sleep(2)
-        notify.send(
-            type=f'api_task_{type}',
-            sender=vpn,
-            target=vpn,
-            action=action,
-            status_code=status_code,
-        )
-
-    def handle_api_call(self, fn, *args, send_notification=True, **kwargs):
-        """
-        This method handles API calls and their responses
-        and triggers appropriate web notifications, which include:
-
-        Error notification
-          - Sent on any unrecoverable API call failure
-        Recovery notification
-          - Sent only when an error notification was previously triggered
-
-        Also raises an exception for recoverable
-        API calls leading to the retrying of the API task
-
-        NOTE: The method utilizes a cache key
-        to prevent flooding of similar task notifications
-
-        Parameters:
-            fn: API service method
-            *args: Arguments for the API service method
-            send_notification: If True, send notifications for API tasks
-            **kwargs: Arguments used by the _send_api_task_notification method
-        """
-        updated_config = None
-        err_msg = kwargs.get('err')
-        info_msg = kwargs.get('info')
-        vpn = kwargs.get('instance')
-        if send_notification:
-            task_key = f'{self.name}_{vpn.pk.hex}_last_operation'
-        # Execute API call and get response
-        response = fn(*args)
-        if isinstance(response, tuple):
-            response, updated_config = response
-        try:
-            response.raise_for_status()
-            logger.info(info_msg)
-            if send_notification:
-                task_result = cache.get(task_key)
-                if task_result == 'error':
-                    self._send_api_task_notification('recovery', **kwargs)
-                    cache.set(task_key, 'success', None)
-        except RequestException as exc:
-            if response.status_code in self._RECOVERABLE_API_CODES:
-                retry_logger = logger.warn
-                # When retry limit is reached, use error logging
-                if self.request.retries == self.max_retries:
-                    retry_logger = logger.error
-                retry_logger(
-                    f'Try [{self.request.retries}/{self.max_retries}] '
-                    f'{err_msg}, Error: {exc}'
-                )
-                raise exc
-            logger.error(f'{err_msg}, Error: {exc}')
-            if send_notification:
-                task_result = cache.get(task_key)
-                if task_result in (None, 'success'):
-                    cache.set(task_key, 'error', None)
-                    self._send_api_task_notification(
-                        'error', status_code=response.status_code, **kwargs
-                    )
-        return (response, updated_config) if updated_config else response
-
-
 @shared_task(soft_time_limit=7200)
 def update_template_related_config_status(template_pk):
     """
@@ -211,150 +114,6 @@ def trigger_vpn_server_endpoint(endpoint, auth_token, vpn_id):
         )
 
 
-@shared_task(
-    bind=True,
-    base=OpenwispApiTask,
-    autoretry_for=(RequestException,),
-    **API_TASK_RETRY_OPTIONS,
-)
-def trigger_zerotier_server_update(self, config, vpn_id):
-    Vpn = load_model('config', 'Vpn')
-    vpn = Vpn.objects.get(pk=vpn_id)
-    service_method = ZerotierService(
-        vpn.host, vpn.auth_token, vpn.subnet.subnet
-    ).update_network
-    response, updated_config = self.handle_api_call(
-        service_method,
-        config,
-        vpn.network_id,
-        instance=vpn,
-        action='update',
-        info=(
-            f'Successfully updated the configuration of '
-            f'ZeroTier VPN Server with UUID: {vpn_id}'
-        ),
-        err=(
-            f'Failed to update ZeroTier VPN Server configuration, '
-            f'VPN Server UUID: {vpn_id}'
-        ),
-    )
-    if response.status_code == 200:
-        vpn.network_id = updated_config.pop('id', None)
-        vpn.config = {**vpn.config, 'zerotier': [updated_config]}
-        # Update zerotier network controller
-        trigger_zerotier_server_update_member.delay(vpn_id)
-
-
-@shared_task(
-    bind=True,
-    base=OpenwispApiTask,
-    autoretry_for=(RequestException,),
-    **API_TASK_RETRY_OPTIONS,
-)
-def trigger_zerotier_server_update_member(self, vpn_id):
-    Vpn = load_model('config', 'Vpn')
-    vpn = Vpn.objects.get(pk=vpn_id)
-    service_method = ZerotierService(
-        vpn.host,
-        vpn.auth_token,
-    ).update_network_member
-    self.handle_api_call(
-        service_method,
-        vpn.node_id,
-        vpn.network_id,
-        vpn.ip.ip_address,
-        instance=vpn,
-        action='update_member',
-        info=(
-            f'Successfully updated ZeroTier network member: {vpn.node_id}, '
-            f'ZeroTier network: {vpn.network_id}, '
-            f'ZeroTier VPN server UUID: {vpn_id}'
-        ),
-        err=(
-            f'Failed to update ZeroTier network member: {vpn.node_id}, '
-            f'ZeroTier network: {vpn.network_id}, '
-            f'ZeroTier VPN server UUID: {vpn_id}'
-        ),
-    )
-
-
-@shared_task(
-    bind=True,
-    base=OpenwispApiTask,
-    autoretry_for=(RequestException,),
-    **API_TASK_RETRY_OPTIONS,
-)
-def trigger_zerotier_server_join(self, vpn_id):
-    Vpn = load_model('config', 'Vpn')
-    vpn = Vpn.objects.get(pk=vpn_id)
-    service_method = ZerotierService(
-        vpn.host,
-        vpn.auth_token,
-    ).join_network
-    response = self.handle_api_call(
-        service_method,
-        vpn.network_id,
-        instance=vpn,
-        action='network_join',
-        info=(
-            f'Successfully joined the ZeroTier network: {vpn.network_id}, '
-            f'ZeroTier VPN Server UUID: {vpn_id}'
-        ),
-        err=(
-            f'Failed to join ZeroTier network: {vpn.network_id}, '
-            f'VPN Server UUID: {vpn_id}'
-        ),
-    )
-    if response.ok:
-        # Update zerotier network controller
-        trigger_zerotier_server_update_member.delay(vpn_id)
-
-
-@shared_task(
-    bind=True,
-    base=OpenwispApiTask,
-    autoretry_for=(RequestException,),
-    **API_TASK_RETRY_OPTIONS,
-)
-def trigger_zerotier_server_delete(self, host, auth_token, network_id, vpn_id):
-    service_method = ZerotierService(host, auth_token).delete_network
-    response = self.handle_api_call(
-        service_method,
-        network_id,
-        info=(
-            f'Successfully deleted the ZeroTier VPN Server '
-            f'with UUID: {vpn_id}, Network ID: {network_id}'
-        ),
-        err=(
-            'Failed to delete ZeroTier VPN Server '
-            f'with UUID: {vpn_id}, Network ID: {network_id}, '
-            'as it does not exist on the ZeroTier Controller Networks'
-        ),
-        send_notification=False,
-    )
-    # In case of successful deletion of the network
-    # we should also remove controller node from the network
-    if response.status_code == 200:
-        trigger_zerotier_server_leave.delay(host, auth_token, network_id)
-
-
-@shared_task(
-    bind=True,
-    base=OpenwispApiTask,
-    autoretry_for=(RequestException,),
-    **API_TASK_RETRY_OPTIONS,
-)
-def trigger_zerotier_server_leave(self, host, auth_token, network_id):
-    service_method = ZerotierService(host, auth_token).leave_network
-    self.handle_api_call(
-        service_method,
-        network_id,
-        info=f'Successfully left the ZeroTier Network with ID: {network_id}',
-        err=f'Failed to leave ZeroTier Network with ID: {network_id}',
-        send_notification=False,
-    )
-
-
 @shared_task(base=OpenwispCeleryTask)
 def change_devices_templates(instance_id, model_name, **kwargs):
     Device = load_model('config', 'Device')