introducing dirty state of the event & video based on comparison to avoid update metadata call in opencast

Author: ferishili

lib/Models/Videos.php

@@ -719,10 +719,11 @@ public function haveCoursePerm(string $course_perm, string $user_id = null)
      * Updates the metadata related to this video in both opencast and local and runs republish-metadata workflow
      *
      * @param object $event the updated version of the event
+     * @param boolean $check_dirty_state whether to check for dirty state, meaning if any of the fields that need the opencast update has changed!
      *
      * @return boolean the result of updating process
      */
-    public function updateMetadata($event)
+    public function updateMetadata($event, $check_dirty_state = true)
     {
         $api_event_client = ApiEventsClient::getInstance($this->config_id);
 
@@ -737,21 +738,34 @@ public function updateMetadata($event)
             'subject', 'language', 'description', 'startDate'];
         $metadata = [];
 
+        // A dirty state flag to check if any of the fields that need the opencast update has changed!
+        $is_dirty = false;
+
         foreach ($allowed_metadata_fields as $field_name) {
             if (isset($event[$field_name])) {
+                $current_value = $this->getValue($field_name) ?? null;
                 $value = $event[$field_name];
                 $id = $field_name;
                 if ($field_name == 'subject') {
                     $id = 'subjects';
                     $value = [$value];
+                    $current_value = [$current_value];
                 }
                 if ($field_name == 'presenters') {
                     $id = 'creator';
-                    $value = array_map('trim', explode(',', $value));
+                    $value = array_filter(array_map('trim', explode(',', $value)));
+                    $current_value = array_filter(array_map('trim', explode(',', $current_value)));
                 }
                 if ($field_name == 'contributors') {
                     $id = 'contributor';
-                    $value = array_map('trim', explode(',', $value));
+                    $value = array_filter(array_map('trim', explode(',', $value)));
+                    $current_value = array_filter(array_map('trim', explode(',', $current_value)));
+                }
+
+                // If it is not yet marked dirty, check for dirty state!
+                if (!$is_dirty) {
+                    // Assuming that the current value is not the same as the requested value!
+                    $is_dirty = !(json_encode($current_value) === json_encode($value));
                 }
 
                 $metadata[] = [
@@ -761,6 +775,11 @@ public function updateMetadata($event)
             }
         }
 
+        if ($check_dirty_state && !$is_dirty) {
+            // nothing changed, no need to update!
+            return true;
+        }
+
         $success = false;
         $response = $api_event_client->updateMetadata($this->episode, $metadata);
         $republish = in_array($response['code'], [200, 204]) === true;

lib/Routes/Video/VideoUpdate.php

@@ -91,13 +91,6 @@ public function __invoke(Request $request, Response $response, $args)
             'text' => _('Das Video wurde erfolgreich aktualisiert.')
         ];
 
-        // If changes are only related to local event properties, we don't need to update the metadata on the Opencast server.
-        if (isset($event['has_metadata_changes']) && $event['has_metadata_changes'] === false) {
-            return $this->createResponse([
-                'message' => $message,
-            ], $response->withStatus(200));
-        }
-
         $update = $video->updateMetadata($event);
 
         if ($update !== true) {

vueapp/components/Videos/Actions/VideoEdit.vue

@@ -139,7 +139,6 @@ export default {
             visibility: null,
             visible_timestamp: null,
             use_timestamp: false,
-            originalEvent: null
         }
     },
 
@@ -182,24 +181,6 @@ export default {
                 };
             }
 
-            // Decide whether the actual metadata has been changed or not, in order to check if the update metadata against opencast server is needed.
-            let has_metadata_changes = false;
-            let non_metadata_fields = ['tags', 'seminar_visibility', 'cid', 'playlist_token']; // These fields are not part of the metadata.
-            for (const field in this.event) {
-                if (non_metadata_fields.includes(field)) {
-                    continue;
-                }
-
-                let event_value = JSON.stringify(this.event[field]);
-                let original_event_value = JSON.stringify(this.originalEvent[field]);
-                if (event_value !== original_event_value) {
-                    has_metadata_changes = true;
-                    break;
-                }
-            }
-
-            this.event.has_metadata_changes = has_metadata_changes;
-
             await this.$store.dispatch('updateVideo', this.event)
             .then(({ data }) => {
                 this.$store.dispatch('addMessage', data.message);
@@ -257,8 +238,6 @@ export default {
         this.visibility = this.event.seminar_visibility?.visibility;
         this.visible_timestamp = this.event.seminar_visibility?.visible_timestamp;
         this.checkVisibility();
-        // Make sure originalEvent is a non-reactive copy of the event.
-        this.originalEvent = JSON.parse(JSON.stringify(this.event));
     }
 }
 </script>