Merge pull request #8 from bugov/add-idle-check

bugov · web-flow · commit f84136fbe5af · 2021-10-14T18:55:20.000+05:00
Add type checking for SESSION_TIME, IDLE_TIME. int and datetime.timedelta are allowed.
diff --git a/README.md b/README.md
@@ -45,17 +45,32 @@ Add to `settings.py`:
 AUTO_LOGOUT = {'IDLE_TIME': 600}  # logout after 10 minutes of downtime
 ```
 
+or the same, but with `datetime.timedelta` (more semantically):
+
+```python
+from datetime import timedelta
+
+AUTO_LOGOUT = {'IDLE_TIME': timedelta(minutes=10)}
+```
+
 ## ⌛ Limit session time
 
 Logout a user after 3600 seconds (hour) from the last login.
 
 Add to `settings.py`:
 
-
 ```python
 AUTO_LOGOUT = {'SESSION_TIME': 3600}
 ```
 
+or the same, but with `datetime.timedelta` (more semantically):
+
+```python
+from datetime import timedelta
+
+AUTO_LOGOUT = {'SESSION_TIME': timedelta(hours=1)}
+```
+
 ## ✉️ Show messages when logging out automatically
 
 Set the message that will be displayed after the user automatically logs out of the system:
@@ -95,9 +110,11 @@ in case of downtime (5 minutes or more) and not allow working within one session
 for more than half an hour:
 
 ```python
+from datetime import timedelta
+
 AUTO_LOGOUT = {
-    'IDLE_TIME': 300,  # 5 minutes
-    'SESSION_TIME': 1800,  # 30 minutes
+    'IDLE_TIME': timedelta(minutes=5),
+    'SESSION_TIME': timedelta(minutes=30),
     'MESSAGE': 'The session has expired. Please login again to continue.',
 }
 ```
diff --git a/README.rst b/README.rst
@@ -44,6 +44,11 @@ Add to `settings`:
 
     AUTO_LOGOUT = {'IDLE_TIME': 600}  # logout after 10 minutes of downtime
 
+or the same, but with `datetime.timedelta` (more semantically):
+
+.. code:: python
+
+    AUTO_LOGOUT = {'IDLE_TIME': timedelta(minutes=10)}
 
 Limit session time
 ------------------
@@ -56,6 +61,12 @@ Add to `settings`:
 
     AUTO_LOGOUT = {'SESSION_TIME': 3600}
 
+or the same, but with `datetime.timedelta` (more semantically):
+
+.. code:: python
+
+    AUTO_LOGOUT = {'SESSION_TIME': timedelta(hours=1)}
+
 Show messages when logging out automatically
 --------------------------------------------
 
@@ -95,8 +106,10 @@ for more than half an hour:
 
 .. code:: python
 
+    from datetime import timedelta
+
     AUTO_LOGOUT = {
-        'IDLE_TIME': 300,  # 5 minutes
-        'SESSION_TIME': 1800,  # 30 minutes
+        'IDLE_TIME': timedelta(minutes=5),
+        'SESSION_TIME': timedelta(minutes=30),
         'MESSAGE': 'The session has expired. Please login again to continue.',
     }
diff --git a/django_auto_logout/__init__.py b/django_auto_logout/__init__.py
@@ -1 +1 @@
-__version__ = '0.3.2'
+__version__ = '0.4.0'
diff --git a/django_auto_logout/middleware.py b/django_auto_logout/middleware.py
@@ -21,28 +21,41 @@ def _auto_logout(request: HttpRequest, options):
         now = datetime.now()
 
     if options.get('SESSION_TIME') is not None:
-        ttl = timedelta(seconds=options['SESSION_TIME'])
+        if isinstance(options['SESSION_TIME'], timedelta):
+            ttl = options['SESSION_TIME']
+        elif isinstance(options['SESSION_TIME'], int):
+            ttl = timedelta(seconds=options['SESSION_TIME'])
+        else:
+            raise TypeError(f"AUTO_LOGOUT['SESSION_TIME'] should be `int` or `timedelta`, "
+                            f"not `{type(options['SESSION_TIME']).__name__}`.")
+
         time_expired = user.last_login < now - ttl
         should_logout |= time_expired
         logger.debug('Check SESSION_TIME: %s < %s (%s)', user.last_login, now, time_expired)
 
     if options.get('IDLE_TIME') is not None:
-        ttl = timedelta(seconds=options['IDLE_TIME'])
+        if isinstance(options['IDLE_TIME'], timedelta):
+            ttl = options['IDLE_TIME']
+        elif isinstance(options['IDLE_TIME'], int):
+            ttl = timedelta(seconds=options['IDLE_TIME'])
+        else:
+            raise TypeError(f"AUTO_LOGOUT['IDLE_TIME'] should be `int` or `timedelta`, "
+                            f"not `{type(options['IDLE_TIME']).__name__}`.")
 
-        if 'django_auto_logout_last_touch' in request.session:
-            last_touch = datetime.fromisoformat(request.session['django_auto_logout_last_touch'])
+        if 'django_auto_logout_last_request' in request.session:
+            last_req = datetime.fromisoformat(request.session['django_auto_logout_last_request'])
         else:
-            last_touch = now
-            request.session['django_auto_logout_last_touch'] = last_touch.isoformat()
+            last_req = now
+            request.session['django_auto_logout_last_request'] = last_req.isoformat()
 
-        time_expired = last_touch < now - ttl
+        time_expired = last_req < now - ttl
         should_logout |= time_expired
-        logger.debug('Check IDLE_TIME: %s < %s (%s)', last_touch, now, time_expired)
+        logger.debug('Check IDLE_TIME: %s < %s (%s)', last_req, now, time_expired)
 
         if should_logout:
-            del request.session['django_auto_logout_last_touch']
+            del request.session['django_auto_logout_last_request']
         else:
-            request.session['django_auto_logout_last_touch'] = now.isoformat()
+            request.session['django_auto_logout_last_request'] = now.isoformat()
 
     if should_logout:
         logger.debug('Logout user %s', user)
diff --git a/example/some_app_login_required/tests.py b/example/some_app_login_required/tests.py
@@ -1,4 +1,5 @@
 from time import sleep
+from datetime import timedelta
 from django.test import TestCase
 from django.conf import settings
 from django.contrib.auth import get_user_model
@@ -24,7 +25,6 @@ def assertLoginRequiredRedirect(self):
         return resp
 
     def _logout_session_time(self):
-        settings.AUTO_LOGOUT = {'SESSION_TIME': 1}
         self.assertLoginRequiredRedirect()
 
         self.client.force_login(self.user)
@@ -34,35 +34,68 @@ def _logout_session_time(self):
         self.assertLoginRequiredRedirect()
 
     def test_logout_session_time(self):
+        settings.AUTO_LOGOUT = {'SESSION_TIME': 1}
         settings.USE_TZ = False
         self._logout_session_time()
 
     def test_logout_session_time_using_tz_utc(self):
+        settings.AUTO_LOGOUT = {'SESSION_TIME': 1}
         settings.USE_TZ = True
         self._logout_session_time()
 
     def test_logout_session_time_using_tz_non_utc(self):
+        settings.AUTO_LOGOUT = {'SESSION_TIME': 1}
         settings.USE_TZ = True
         settings.TIME_ZONE = 'Asia/Yekaterinburg'
         self._logout_session_time()
 
-    def test_logout_idle_time_no_idle(self):
-        settings.AUTO_LOGOUT = {'IDLE_TIME': 1}
+    def test_logout_session_time_timedelta(self):
+        settings.AUTO_LOGOUT = {'SESSION_TIME': timedelta(seconds=1)}
+        settings.USE_TZ = False
+        self._logout_session_time()
+
+    def test_logout_session_time_using_tz_utc_timedelta(self):
+        settings.AUTO_LOGOUT = {'SESSION_TIME': timedelta(seconds=1)}
+        settings.USE_TZ = True
+        self._logout_session_time()
+
+    def test_logout_session_time_using_tz_non_utc_timedelta(self):
+        settings.AUTO_LOGOUT = {'SESSION_TIME': timedelta(seconds=1)}
+        settings.USE_TZ = True
+        settings.TIME_ZONE = 'Asia/Yekaterinburg'
+        self._logout_session_time()
+
+    def _test_logout_idle_time_no_idle(self):
         self.client.force_login(self.user)
         self.assertLoginRequiredIsOk()
 
         for _ in range(10):
             sleep(0.5)
             self.assertLoginRequiredIsOk()
 
-    def test_logout_idle_time(self):
+    def test_logout_idle_time_no_idle(self):
         settings.AUTO_LOGOUT = {'IDLE_TIME': 1}
+        self._test_logout_idle_time_no_idle()
+
+    def test_logout_idle_time_no_idle_timedelta(self):
+        settings.AUTO_LOGOUT = {'IDLE_TIME': timedelta(seconds=1)}
+        self._test_logout_idle_time_no_idle()
+
+    def _test_logout_idle_time(self):
         self.client.force_login(self.user)
         self.assertLoginRequiredIsOk()
 
         sleep(1.5)
         self.assertLoginRequiredRedirect()
 
+    def test_logout_idle_time(self):
+        settings.AUTO_LOGOUT = {'IDLE_TIME': 1}
+        self._test_logout_idle_time()
+
+    def test_logout_idle_time_timedelta(self):
+        settings.AUTO_LOGOUT = {'IDLE_TIME': timedelta(seconds=1)}
+        self._test_logout_idle_time()
+
     def test_combine_idle_and_session_time(self):
         settings.AUTO_LOGOUT = {
             'IDLE_TIME': 1,
@@ -81,6 +114,30 @@ def test_combine_idle_and_session_time(self):
         sleep(0.5)
         self.assertLoginRequiredRedirect()
 
+    def test_session_time_config_time(self):
+        settings.AUTO_LOGOUT = {
+            'IDLE_TIME': 1,
+            'SESSION_TIME': '2',
+        }
+
+        self.client.force_login(self.user)
+
+        exc_message = "AUTO_LOGOUT['SESSION_TIME'] should be `int` or `timedelta`, not `str`."
+        with self.assertRaisesMessage(TypeError, exc_message):
+            self.client.get('/login-required/')
+
+    def test_idle_time_config_time(self):
+        settings.AUTO_LOGOUT = {
+            'IDLE_TIME': '1',
+            'SESSION_TIME': 2,
+        }
+
+        self.client.force_login(self.user)
+
+        exc_message = "AUTO_LOGOUT['IDLE_TIME'] should be `int` or `timedelta`, not `str`."
+        with self.assertRaisesMessage(TypeError, exc_message):
+            self.client.get('/login-required/')
+
     def test_combine_idle_and_session_time_but_session_less_than_idle(self):
         settings.AUTO_LOGOUT = {
             'IDLE_TIME': 2,

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = '0.3.2'`
	`1`	`+__version__ = '0.4.0'`