Clarify cookie mechanism

Author: aminedhobb

app/helpers/user_list_upload/invitation_attempts_helper.rb

@@ -60,9 +60,8 @@ def invitation_format_checked?(format, user_list_upload_id)
   end
 
   def selected_invitation_formats(user_list_upload_id)
-    selected_invitation_formats =
-      cookies["selected_invitation_formats_#{user_list_upload_id}"] || %w[sms email]
-    selected_invitation_formats = JSON.parse(selected_invitation_formats) if selected_invitation_formats.is_a?(String)
-    selected_invitation_formats
+    cookie_data = JSON.parse(cookies["user_list_uploads"] || "{}") rescue {}
+    formats = cookie_data.dig(user_list_upload_id.to_s, "selected_invitation_formats")
+    formats.is_a?(Array) ? formats : %w[sms email]
   end
 end

app/helpers/user_list_upload/user_list_upload_helper.rb

@@ -151,7 +151,8 @@ def show_row_attribute?(attribute_name, user_list_upload)
   end
 
   def checkbox_to_select_all_checked?(attribute_name, user_list_upload_id)
-    cookies["checkbox_to_select_all_#{attribute_name}_checked_#{user_list_upload_id}"] != "false"
+    cookie_data = JSON.parse(cookies["user_list_uploads"] || "{}") rescue {}
+    cookie_data.dig(user_list_upload_id.to_s, "checkbox_all", attribute_name.to_s) != false
   end
 end
 # rubocop:enable Metrics/ModuleLength

app/javascript/controllers/select_user_rows_controller.js

@@ -17,11 +17,22 @@ export default class extends Controller {
     this.checkboxTargets.forEach(checkbox => {
       checkbox.checked = checkbox.disabled ? false : event.target.checked
     })
-    Cookies.set(
-      `checkbox_to_select_all_${this.attributeToToggle}_checked_${this.userListUploadId}`,
-      event.target.checked,
-      { path: "/", expires: 0.01 } // ~10 minutes
-    )
+
+    // We set the state of the checkbox in the cookie
+    const cookieData = this.#getUserListUploadsCookie();
+
+    if (!cookieData[this.userListUploadId]) {
+      cookieData[this.userListUploadId] = {};
+    }
+    if (!cookieData[this.userListUploadId].checkbox_all) {
+      cookieData[this.userListUploadId].checkbox_all = {};
+    }
+
+    cookieData[this.userListUploadId].checkbox_all[this.attributeToToggle] = event.target.checked;
+
+    // We save the updated cookie
+    this.#updateUserListUploadsCookie(cookieData);
+
     this.#batchUpdateUserRows(this.attributeToToggle)
   }
 
@@ -34,6 +45,40 @@ export default class extends Controller {
     this.#updateRow(url, this.attributeToToggle, isChecked)
   }
 
+  handleFormatOptionChange(event) {
+    const selectedFormats = this.invitationFormatOptionTargets.filter(option => option.checked).map(option => option.dataset.format)
+
+    // We set the selected formats in the cookie
+    const cookieData = this.#getUserListUploadsCookie();
+
+    if (!cookieData[this.userListUploadId]) {
+      cookieData[this.userListUploadId] = {};
+    }
+
+    cookieData[this.userListUploadId].selected_invitation_formats = selectedFormats;
+
+    this.#updateUserListUploadsCookie(cookieData);
+
+    if (event.target.checked) {
+      // we just reload the page if we are enabling the invitation format
+      window.Turbo.visit(window.location.href, { action: "replace" });
+      return
+    }
+
+    this.checkboxTargets.forEach(checkbox => {
+      const isInvitable = selectedFormats.length > 0 &&
+        (selectedFormats.includes("email") && checkbox.dataset.userEmail) ||
+        (selectedFormats.includes("sms") && checkbox.dataset.userPhone)
+
+      if (!isInvitable) {
+        checkbox.checked = false
+        checkbox.disabled = true
+      }
+    })
+
+    this.#batchUpdateUserRows()
+  }
+
   #batchUpdateUserRows() {
     const url = `/user_list_uploads/${this.userListUploadId}/user_rows/batch_update`
 
@@ -86,33 +131,18 @@ export default class extends Controller {
     document.body.removeChild(form)
   }
 
-  handleFormatOptionChange(event) {
-    const selectedFormats = this.invitationFormatOptionTargets.filter(option => option.checked).map(option => option.dataset.format)
 
-    Cookies.set(
-      `selected_invitation_formats_${this.userListUploadId}`,
-      JSON.stringify(selectedFormats),
-      { path: "/", expires: 0.01 }
-    )
-
-    if (event.target.checked) {
-      // we just reload the page if we are enabling the invitation format
-      window.Turbo.visit(window.location.href, { action: "replace" });
-      return
-    }
-
-    this.checkboxTargets.forEach(checkbox => {
-      const isInvitable = selectedFormats.length > 0 &&
-        (selectedFormats.includes("email") && checkbox.dataset.userEmail) ||
-        (selectedFormats.includes("sms") && checkbox.dataset.userPhone)
-
-      if (!isInvitable) {
-        checkbox.checked = false
-        checkbox.disabled = true
-      }
-    })
+  #getUserListUploadsCookie() {
+    const cookieData = Cookies.get("user_list_uploads");
+    return cookieData ? JSON.parse(cookieData) : {};
+  }
 
-    this.#batchUpdateUserRows()
+  #updateUserListUploadsCookie(newData) {
+    Cookies.set(
+      "user_list_uploads",
+      JSON.stringify(newData),
+      { path: "/", expires: 1/24 } // 1 hour
+    );
   }
 }
 

spec/features/agent_can_upload_user_list_spec.rb

@@ -235,6 +235,10 @@
       expect(page).to have_css("input[type='checkbox'][data-user-row-id='#{christian_row.id}']:not(:checked)")
       expect(page).to have_css("input[type='checkbox'][data-user-row-id='#{hernan_row.id}']:not(:checked)")
 
+      # All rows selection is preserved after page refresh
+      page.refresh
+      expect(page).to have_css("input[type='checkbox'][data-action='click->select-user-rows#toggleAll']:not(:checked)")
+
       # Check all rows
       check_all_button.click