[chores] Added support for user expiration reminders #608

- Added celery beat schedule for expiration reminder emails
- Added support for openwisp_users expiration tasks
- Added configurable reminder email schedule variable

Closes #608

Author: pandafy

defaults/main.yml

@@ -17,6 +17,9 @@ openwisp2_radius_version: "openwisp-radius @ https://github.com/openwisp/openwis
 openwisp2_django_version: "django~=5.2.0"
 openwisp2_extra_python_packages:
   - bpython
+  # TODO: Remove before merging
+  - "openwisp-radius[openvpn_status] @ https://github.com/openwisp/openwisp-radius/tarball/issues/706-user-expiration"
+  - "openwisp-users @ https://github.com/openwisp/openwisp-users/tarball/issues/499-user-expiration"
 openwisp2_extra_django_apps: []
 openwisp2_extra_django_settings: {}
 openwisp2_extra_django_settings_instructions: []
@@ -212,7 +215,8 @@ freeradius_eap_openwisp_site_template_src: freeradius/eap/openwisp_site.j2
 freeradius_eap_inner_tunnel_template_src: freeradius/eap/inner_tunnel.j2
 freeradius_eap_template_src: freeradius/eap/eap.j2
 cron_delete_old_notifications: "'hour': 0, 'minute': 0"
-cron_deactivate_expired_users: "'hour': 0, 'minute': 5"
+cron_expiration_reminder_email: "'hour': 0, 'minute': 3"
+cron_deactivate_expired_users: "'hour': 0, 'minute': 1"
 cron_delete_old_radiusbatch_users: "'hour': 0, 'minute': 10"
 cron_cleanup_stale_radacct: "'hour': 0, 'minute': 20"
 cron_delete_old_postauth: "'hour': 0, 'minute': 30"

docs/user/role-variables.rst

@@ -447,7 +447,8 @@ take a look at `the default values of these variables
         # Defaults to "templates/freeradius/eap/eap.j2" shipped in the role.
         freeradius_eap_template_src: custom_eap.j2
         cron_delete_old_notifications: "'hour': 0, 'minute': 0"
-        cron_deactivate_expired_users: "'hour': 0, 'minute': 5"
+        cron_expiration_reminder_email: "'hour': 0, 'minute': 3"
+        cron_deactivate_expired_users: "'hour': 0, 'minute': 1"
         cron_delete_old_radiusbatch_users: "'hour': 0, 'minute': 10"
         cron_cleanup_stale_radacct: "'hour': 0, 'minute': 20"
         cron_delete_old_postauth: "'hour': 0, 'minute': 30"

templates/openwisp2/settings.py

@@ -245,14 +245,22 @@
 CELERY_BROKER_TRANSPORT_OPTIONS = {
     "max_retries": {{ openwisp2_celery_broker_max_tries }},
 }
-
 CELERY_BEAT_SCHEDULE = {
 {% if openwisp2_users_user_password_expiration or openwisp2_users_staff_user_password_expiration %}
     "password_expiry_email": {
         "task": "openwisp_users.tasks.password_expiration_email",
         "schedule": crontab(**{ {{ cron_password_expiration_email }} }),
     },
 {% endif %}
+    "deactivate_expired_users": {
+        "task": "openwisp_users.tasks.deactivate_expired_users",
+        "schedule": crontab(**{ {{ cron_deactivate_expired_users }} }),
+        "args": None,
+    },
+    "expiration_reminder_email": {
+        "task": "openwisp_users.tasks.expiration_reminder_email",
+        "schedule": crontab(**{ {{ cron_expiration_reminder_email }} }),
+    },
 {% if openwisp2_notifications_delete_old_notifications %}
     "delete_old_notifications": {
         "task": "openwisp_notifications.tasks.delete_old_notifications",
@@ -267,12 +275,6 @@
     },
 {% endif %}
 {% if openwisp2_radius and openwisp2_radius_periodic_tasks %}
-    "deactivate_expired_users": {
-        "task": "openwisp_radius.tasks.deactivate_expired_users",
-        "schedule": crontab(**{ {{ cron_deactivate_expired_users }} }),
-        "args": None,
-        "relative": True,
-    },
     "delete_old_radiusbatch_users": {
         "task": "openwisp_radius.tasks.delete_old_radiusbatch_users",
         "schedule": crontab(**{ {{ cron_delete_old_radiusbatch_users }} }),
@@ -415,6 +417,7 @@
 
 LANGUAGE_CODE = "{{ openwisp2_language_code }}"
 TIME_ZONE = "{{ openwisp2_time_zone }}"
+CELERY_TIMEZONE = TIME_ZONE
 {% if openwisp2_internationalization %}
 USE_I18N = True
 {% endif %}