From e7de0c90a1b4800abd6dc80e2b27c4b3572850f6 Mon Sep 17 00:00:00 2001
From: Michael Genson <71845777+michael-genson@users.noreply.github.com>
Date: Thu, 10 Nov 2022 18:17:49 -0600
Subject: [PATCH] feature: live shopping list updates (#1730)

* added polling for changes every 5 seconds

* fixed demi import

* stop polling if the refresh fails too many times

* only poll for changes when the user is active
---
 frontend/pages/shopping-lists/_id.vue | 45 +++++++++++++++++++++++++--
 1 file changed, 43 insertions(+), 2 deletions(-)

diff --git a/frontend/pages/shopping-lists/_id.vue b/frontend/pages/shopping-lists/_id.vue
index 01725689f6ba..b0a4b8da6f1b 100644
--- a/frontend/pages/shopping-lists/_id.vue
+++ b/frontend/pages/shopping-lists/_id.vue
@@ -187,8 +187,8 @@
 <script lang="ts">
 import draggable from "vuedraggable";
 
-import { defineComponent, useAsync, useRoute, computed, ref, watch } from "@nuxtjs/composition-api";
-import { useToggle } from "@vueuse/core";
+import { defineComponent, useAsync, useRoute, computed, ref, watch, onUnmounted } from "@nuxtjs/composition-api";
+import { useIdle, useToggle } from "@vueuse/core";
 import { useCopyList } from "~/composables/use-copy";
 import { useUserApi } from "~/composables/api";
 import { useAsyncKey } from "~/composables/use-utils";
@@ -214,6 +214,7 @@ export default defineComponent({
     ShoppingListItemEditor,
   },
   setup() {
+    const { idle } = useIdle(5 * 60 * 1000) // 5 minutes
     const userApi = useUserApi();
 
     const edit = ref(false);
@@ -238,6 +239,46 @@ export default defineComponent({
       shoppingList.value = await fetchShoppingList();
     }
 
+    // constantly polls for changes
+    async function pollForChanges() {
+      // pause polling if the user isn't active
+      if (idle.value) {
+        return;
+      }
+
+      try {
+        await refresh();
+
+        if (shoppingList.value) {
+          attempts = 0;
+          return;
+        }
+
+        // if the refresh was unsuccessful, the shopping list will be null, so we increment the attempt counter
+        attempts ++;
+      }
+
+      catch (error) {
+        attempts ++;
+      }
+
+      // if we hit too many errors, stop polling
+      if (attempts >= maxAttempts) {
+        clearInterval(pollTimer);
+      }
+    }
+
+    // start polling
+    const pollFrequency = 5000;
+
+    let attempts = 0;
+    const maxAttempts = 3;
+
+    const pollTimer: ReturnType<typeof setInterval> = setInterval(() => { pollForChanges() }, pollFrequency);
+    onUnmounted(() => {
+      clearInterval(pollTimer);
+    });
+
     // =====================================
     // List Item CRUD