📝 [#498] Document that keys need to remain in sync

backend/src/openarchiefbeheer/destruction/utils.py

@@ -262,6 +262,11 @@ def attach_report_to_zaak(
 def get_selection_key_for_review(
     destruction_list: "DestructionList", context: str
 ) -> str:
+    """
+    Warning! This key needs to remain in sync with the key created by the frontend,
+    since the frontend need to be able to retrieve the pre-populates selection
+    in the review page. See github issue #498
+    """
     return f"destruction-list-{context}-{destruction_list.uuid}-{ListStatus.ready_to_review}"
 
 

frontend/src/pages/destructionlist/review/DestructionListReview.tsx

@@ -32,6 +32,11 @@ import { ReviewDestructionListAction } from "./DestructionListReview.action";
 import "./DestructionListReview.css";
 import { DestructionListReviewContext } from "./DestructionListReview.loader";
 
+/**
+ * Warning! This key needs to remain in sync with the key created by the backend,
+ * since the backend can pre-populate the selection after a review is processed by
+ * the record manager. See github issue #498
+ */
 export const getDestructionListReviewKey = (id: string, status: string) =>
   `destruction-list-review-${id}-${status}`;