Changeset 38424

Timestamp:

2023-11-21T19:35:39+13:00 (9 days ago)

Author:

anupama

Message:

1. User comment edits (but not other document editor edits) happen before user comment deletes, as user comment deletes are based on metapositions and thus alter metapositions, which can affect user comment edits if these happened later. 2. When needed*, I'm also forcesyncing the user comment edits setMetadataArray AJAX call to perl, so that usercomment deletes (removeMetadataArray) can't happen simultaneously or in overlap with edits (setMetadataArray), which could in theory also mess up metapositions or anything else unforeseen. *When needed: Only if user comments' delete metadatapositions are earlier for any docid that has user comment edits. Still to do: if user comment rows are deleted where any of the cells are also edited, discard those pending edits (before calling setMetaArray) instead of passing them on to perl to process.

Location:

main/trunk/greenstone3/web/interfaces/default/js

Files:

• documentedit_scripts_usercomments.js (modified) (3 diffs)
• documentedit_scripts_util.js (modified) (5 diffs)

main/trunk/greenstone3/web/interfaces/default/js/documentedit_scripts_usercomments.js

@@ -61 +61 @@
     });
     }
+
+    //alert("editing: " + JSON.stringify(docArray));
     
     return docArray;
@@ -72 +74 @@
     var docids = Object.keys(docids_to_delCommentsMetapositions);
     var docArray = [];
-
     var i = 0;
     for(i = 0; i < docids.length; i++) { //if(docids.length > 0) {
       var _docid = docids[i];
-      var delCommentsMetapositions = docids_to_delCommentsMetapositions[_docid];
-      
+      var delCommentsMetapositions = docids_to_delCommentsMetapositions[_docid].sort();
+    // sort unnecessary as modmetadataaction.pm ensures (reverse) sort of metapositions
 
       // build up the data structure for all the usercomments to be deleted
@@ -105 +106 @@
     }
 
+    //alert("deleting: " + JSON.stringify(docArray));
     return docArray;
+}
+
+// Determine if the user comment edits should be a synchronous AJAX call
+function forceSyncUserCommentsEdits(editsDocArray, docids_to_delCommentsMetapositions) {
+    var forceSync = false;
+    var docids = Object.keys(docids_to_delCommentsMetapositions);
+    if(docids.length == 0) { // no user comments deletions, so can process user comment edits async
+    return false;
+    }
+    var edits = Object.keys(editsDocArray);
+    if(edits.length == 0) { // no user comments edits
+    return false;
+    }
+    
+    var i = 0;
+    for(i = 0; i < docids.length; i++) {
+    var docid = docids[i];
+
+    // sort metapositions of deletes to get at lowest metaposition for this docid
+    var metapositions = docids_to_delCommentsMetapositions[docid].sort(); // non-zero length array
+    var lowestDelMetapos = metapositions[0]; // lowest metaposition at lowest index
+    
+    // https://javascript.plainenglish.io/check-if-an-array-contains-an-object-with-a-certain-property-value-in-javascript-5325295a5820 
+    // https://stackoverflow.com/questions/237104/how-do-i-check-if-an-array-includes-a-value-in-javascript/24827594#24827594
+    // https://stackoverflow.com/questions/254302/how-can-i-determine-the-type-of-an-html-element-in-javascript
+    
+    var match_docRecord = editsDocArray.find((doc_rec) => doc_rec.docid === docid);
+    if (match_docRecord) { // defined: this docid exists in an object in array
+    //if(editsDocArray.some(item => item.docid === docid)) { // this docid exists in object
+    //if(editsDocArray[docid] !== undefined) {
+        // compare lowest metaposition of user comment to be deleted for this docid
+        // against the highest metapos of user comment being edited for this docid
+        // Metapositions array of deletes would contain metapos in ascending order
+        var metatable = match_docRecord.metatable; // array of non-zero length
+        //alert("Found docid match " + JSON.stringify(match_docRecord) + " comparing low metapos " + lowestDelMetapos);
+          
+        // https://www.digitalocean.com/community/tutorials/js-array-search-methods
+        // Get array of user comment edits that are affected by deletions happening earlier
+        // in the file (deletes that have a lower metapos than the metapos of the edit).
+        var editsAffectedByDeletes = metatable.filter(meta_rec => meta_rec.metapos >= lowestDelMetapos);
+        if(editsAffectedByDeletes.length > 0) { //if any edits affected by dels, forceSync ajax
+        forceSync = true; // ensure we process all edits first before processing deletes
+        //alert("FORCE_SYNC because " + JSON.stringify(editsAffectedByDeletes)
+        //      + " are affected by deletes starting: " + lowestDelMetapos);
+        } // else all user comment edits for this docid happen earlier (lower metapos) to deletes
+    }
+    }
+    return forceSync;
 }
 

main/trunk/greenstone3/web/interfaces/default/js/documentedit_scripts_util.js

@@ -501 +501 @@
     }
 
-    // we can now process the deleted user comments, by organizing them into a single JSON
-    // so that a single call to removeMetadataArray can delete them all more efficiently
-    var docArray = getUserCommentsDeletions(
-    userCommentsMetaFields, docids_to_delCommentsMetapositions);
-   
-    if(docArray.length > 0) {
-    metadataChanges.push({type:'deleteUserComments', docArray:docArray});
-    addCollectionToBuild(collection);
-    }
-    // clear used up vars https://bobbyhadz.com/blog/javascript-clear-object-delete-all-properties
-    docArray = [];
-    docids_to_delCommentsMetapositions = {};
+    
 
   }
 
     var changes = changesToUpdate();
-  
+    // expect user comment edits to be processed async from deletes
+    var forcesync_userCommentsEdits = false;
+    
   //Clean changes
   ////editableInitStates = editableLastStates; // moved into processChangesLoop(): when all changes have successfully been processed.
@@ -594 +585 @@
         }
     }
+
     
     if(userCommentsRowsChanged.length > 0) {
@@ -605 +597 @@
     metadataChanges.push({type:'editUserComments',collection:collection,docArray:docArray});
     addCollectionToBuild(collection);
+    forcesync_userCommentsEdits = forceSyncUserCommentsEdits(docArray, docids_to_delCommentsMetapositions);
     docArray = []; // clear it
     }
+
+    // process user comment edits *before* user comment deletes,
+    // since deletes change usercomments' metapos values which would affect
+    // edits if edits were to happen after deletes
+    
+    // we can now process the deleted user comments, by organizing them into a single JSON
+    // so that a single call to removeMetadataArray can delete them all more efficiently
+    var docArray = getUserCommentsDeletions(
+    userCommentsMetaFields, docids_to_delCommentsMetapositions);
+   
+    if(docArray.length > 0) {
+    metadataChanges.push({type:'deleteUserComments', docArray:docArray});
+    addCollectionToBuild(collection);
+    }
+    // clear used up vars https://bobbyhadz.com/blog/javascript-clear-object-delete-all-properties
+    docArray = [];
+    docids_to_delCommentsMetapositions = {};
+    
     
     // Check for changes to any map editors in the document
@@ -666 +677 @@
         if (change.type == "delete") {
             gs.functions.removeArchivesMetadata(collection, gs.xsltParams.site_name, change.docID, change.name, null, encodeDelimiters(change.value), function(){callbackFunction();});
+        
+        } else if (change.type === "editUserComments") {            
+            
+            var edit_locations = "import|archives|index";
+            //alert("editUserComments: " + JSON.stringify(change.docArray));
+            gs.functions.setMetadataArray(
+            collection,
+            gs.xsltParams.site_name,
+            change.docArray,
+            "override", //metamode
+            edit_locations,
+            function(ajaxResult) {
+                console.log("Edited comments in "+edit_locations);
+                //callbackFunction();               
+                if(!hadErrorResponseOnSave(ajaxResult)) {
+                callbackFunction(); // move on to processing next & eventually rebuild
+                }
+            },
+            // if necessary, forcesync AJAX call to make sure user comments edits are
+            // all processed before deletes, as deletes can alter metapositions
+            forcesync_userCommentsEdits, // false for asynchronous, see comment in gs.usercomments.addUserComment()
+            function(ajaxError) {
+                console.log("Set usercomments meta FAILED!");
+                
+                var errData = (ajaxError.responseText) ? ajaxError.responseText : ajaxError;
+                //alert(gs.text.dse.setmeta_server_error + ". Set meta failed. Got: " + errData);
+                console.log("A server side error occurred during setMetadataArray. (Is the server running?)\nNot proceeding further with saving and rebuilding. Got error: " + JSON.stringify(errData));
+                
+                alert("A server side error occurred during setMetadataArray. (Is the server running?)\nNot proceeding further with saving and rebuilding. Got error: " + JSON.stringify(errData));
+            }
+            );          
+
         } else if (change.type === "deleteUserComments") {
             
@@ -686 +729 @@
             );          
 
-        }  else if (change.type === "editUserComments") {
-            var edit_locations = "import|archives|index";
-            //alert("editUserComments: " + JSON.stringify(change.docArray));
-            gs.functions.setMetadataArray(
-            collection,
-            gs.xsltParams.site_name,
-            change.docArray,
-            "override", //metamode
-            edit_locations,
-            function(ajaxResult) {
-                console.log("Edited comments in "+edit_locations);
-                //callbackFunction();               
-                if(!hadErrorResponseOnSave(ajaxResult)) {
-                callbackFunction(); // move on to processing next & eventually rebuild
-                }               
-            },
-            false, // false for asynchronous, see comment in gs.usercomments.addUserComment()
-            function(ajaxError) {
-                console.log("Set usercomments meta FAILED!");
-                
-                var errData = (ajaxError.responseText) ? ajaxError.responseText : ajaxError;
-                //alert(gs.text.dse.setmeta_server_error + ". Set meta failed. Got: " + errData);
-                console.log("A server side error occurred during setMetadataArray. (Is the server running?)\nNot proceeding further with saving and rebuilding. Got error: " + JSON.stringify(errData));
-                
-                alert("A server side error occurred during setMetadataArray. (Is the server running?)\nNot proceeding further with saving and rebuilding. Got error: " + JSON.stringify(errData));
-            }
-            );          
-            
         } else {
           // Checking "if(change.metapos)" doesn't work for us as it becomes false when the property doesn't exist AND when the property is 0. But metapos IS 0 for us.