autosync shopping list and settings

.env.template

@@ -16,6 +16,11 @@ POSTGRES_USER=djangodb
 POSTGRES_PASSWORD=
 POSTGRES_DB=djangodb
 
+# Users can set a amount of time after which the shopping list is refreshed when they are in viewing mode
+# This is the minimum interval users can set. Setting this to low will allow users to refresh very frequently which
+# might cause high load on the server. (Technically they can obviously refresh as often as they want with their own scripts)
+SHOPPING_MIN_AUTOSYNC_INTERVAL=5000
+
 # Serve mediafiles directly using gunicorn. Basically everyone recommends not doing this. Please use any of the examples
 # provided that include an additional nxginx container to handle media file serving.
 # If you know what you are doing turn this back on (1) to serve media files using djangos serve() method.

cookbook/forms.py

@@ -31,7 +31,7 @@ class UserPreferenceForm(forms.ModelForm):
 
     class Meta:
         model = UserPreference
-        fields = ('default_unit', 'theme', 'nav_color', 'default_page', 'show_recent', 'search_style', 'plan_share', 'ingredient_decimals', 'comments')
+        fields = ('default_unit', 'theme', 'nav_color', 'default_page', 'show_recent', 'search_style', 'plan_share', 'ingredient_decimals', 'shopping_auto_sync', 'comments')
 
         help_texts = {
             'nav_color': _('Color of the top navigation bar. Not all colors work with all themes, just try them out!'),
@@ -39,7 +39,10 @@ class UserPreferenceForm(forms.ModelForm):
             'plan_share': _('Default user to share newly created meal plan entries with.'),
             'show_recent': _('Show recently viewed recipes on search page.'),
             'ingredient_decimals': _('Number of decimals to round ingredients.'),
-            'comments': _('If you want to be able to create and see comments underneath recipes.')
+            'comments': _('If you want to be able to create and see comments underneath recipes.'),
+            'shopping_auto_sync': _(
+                'Setting to 0 will disable auto sync. When viewing a shopping list the list is updated every set seconds to sync changes someone else might have made. Useful when shopping with multiple people but might use a little bit '
+                'of mobile data. If lower than instance limit it is reset when saving.')
         }
 
         widgets = {

cookbook/migrations/0080_auto_20200921_2331.py

@@ -0,0 +1,24 @@
+# Generated by Django 3.0.7 on 2020-09-21 21:31
+
+import datetime
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0079_invitelink_group'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='userpreference',
+            name='shopping_auto_sync',
+            field=models.BooleanField(default=True),
+        ),
+        migrations.AlterField(
+            model_name='invitelink',
+            name='valid_until',
+            field=models.DateField(default=datetime.date(2020, 10, 5)),
+        ),
+    ]

cookbook/migrations/0081_auto_20200921_2349.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.0.7 on 2020-09-21 21:49
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cookbook', '0080_auto_20200921_2331'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='userpreference',
+            name='shopping_auto_sync',
+            field=models.IntegerField(default=5),
+        ),
+    ]

cookbook/models.py

@@ -69,6 +69,7 @@ class UserPreference(models.Model):
     plan_share = models.ManyToManyField(User, blank=True, related_name='plan_share_default')
     ingredient_decimals = models.IntegerField(default=2)
     comments = models.BooleanField(default=COMMENT_PREF_DEFAULT)
+    shopping_auto_sync = models.IntegerField(default=5)
 
     def __str__(self):
         return str(self.user)

cookbook/templates/shopping_list.html

@@ -293,8 +293,13 @@
                     }
                     this.loading = false
                 }
-            },
 
+                {% if request.user.userpreference.shopping_auto_sync > 0 %}
+                    setInterval(() => {
+                        this.loadShoppingList()
+                    }, {{ request.user.userpreference.shopping_auto_sync }} * 1000 )
+                {% endif %}
+            },
             methods: {
                 /*
                 warnPageLeave: function (event) {

cookbook/views/views.py

@@ -192,6 +192,11 @@ def user_settings(request):
                 up.plan_share.set(form.cleaned_data['plan_share'])
                 up.ingredient_decimals = form.cleaned_data['ingredient_decimals']
                 up.comments = form.cleaned_data['comments']
+
+                up.shopping_auto_sync = form.cleaned_data['shopping_auto_sync']
+                if up.shopping_auto_sync < settings.SHOPPING_MIN_AUTOSYNC_INTERVAL:
+                    up.shopping_auto_sync = settings.SHOPPING_MIN_AUTOSYNC_INTERVAL
+
                 up.save()
 
         if 'user_name_form' in request.POST:

recipes/settings.py

@@ -24,12 +24,17 @@ SECRET_KEY = os.getenv('SECRET_KEY') if os.getenv('SECRET_KEY') else 'INSECURE_S
 
 DEBUG = bool(int(os.getenv('DEBUG', True)))
 
+# allow djangos wsgi server to server mediafiles
 GUNICORN_MEDIA = bool(int(os.getenv('GUNICORN_MEDIA', True)))
 
 REVERSE_PROXY_AUTH = bool(int(os.getenv('REVERSE_PROXY_AUTH', False)))
 
+# default value for user preference 'comment'
 COMMENT_PREF_DEFAULT = bool(int(os.getenv('COMMENT_PREF_DEFAULT', True)))
 
+# minimum interval that users can set for automatic sync of shopping lists
+SHOPPING_MIN_AUTOSYNC_INTERVAL = int(os.getenv('SHOPPING_MIN_AUTOSYNC_INTERVAL', 5))
+
 ALLOWED_HOSTS = os.getenv('ALLOWED_HOSTS').split(',') if os.getenv('ALLOWED_HOSTS') else ['*']
 
 CORS_ORIGIN_ALLOW_ALL = True