From 8fc8ff41a07d2328ff15a2a7caa1cf07dfb5b216 Mon Sep 17 00:00:00 2001
From: Katrine Wist <katrinew0702@gmail.com>
Date: Tue, 2 Jan 2024 10:14:49 +0100
Subject: [PATCH] Update editorNotes when concept data is changed. Fix failing
 tests.

---
 .../conceptapi/service/WriteService.scala     | 23 +++++++++++--
 .../conceptapi/service/WriteServiceTest.scala | 34 +++++++++----------
 2 files changed, 37 insertions(+), 20 deletions(-)

diff --git a/concept-api/src/main/scala/no/ndla/conceptapi/service/WriteService.scala b/concept-api/src/main/scala/no/ndla/conceptapi/service/WriteService.scala
index 5fd3c45f03..541af32152 100644
--- a/concept-api/src/main/scala/no/ndla/conceptapi/service/WriteService.scala
+++ b/concept-api/src/main/scala/no/ndla/conceptapi/service/WriteService.scala
@@ -121,6 +121,20 @@ trait WriteService {
       }
     }
 
+    private def shouldUpdateNotes(existing: domain.Concept, changed: domain.Concept): Boolean = {
+      // Function that sets values we don't want to include when comparing concepts to check if we should update notes
+      val withComparableValues =
+        (concept: domain.Concept) =>
+          concept.copy(
+            revision = None,
+            created = NDLADate.fromUnixTime(0),
+            updated = NDLADate.fromUnixTime(0),
+            responsible = None,
+            updatedBy = Seq.empty
+          )
+      withComparableValues(existing) != withComparableValues(changed)
+    }
+
     private def updateNotes(
         old: domain.Concept,
         updated: api.UpdatedConcept,
@@ -129,8 +143,11 @@ trait WriteService {
     ): domain.Concept = {
       val isNewLanguage =
         !old.supportedLanguages.contains(updated.language) && changed.supportedLanguages.contains(updated.language)
-      val newLanguageEditorNote =
-        if (isNewLanguage) Seq(s"New language '${updated.language}' added.")
+      val dataChanged = shouldUpdateNotes(old, changed);
+
+      val newEditorNote =
+        if (isNewLanguage) Seq(s"New language '${updated.language}' added")
+        else if (dataChanged) Seq(s"Updated ${old.conceptType}")
         else Seq.empty
 
       val changedResponsibleNote =
@@ -139,7 +156,7 @@ trait WriteService {
             Seq("Responsible changed")
           case _ => Seq.empty
         }
-      val allNewNotes = newLanguageEditorNote ++ changedResponsibleNote
+      val allNewNotes = newEditorNote ++ changedResponsibleNote
 
       changed.copy(editorNotes =
         changed.editorNotes ++ allNewNotes.map(domain.EditorNote(_, user.id, changed.status, clock.now()))
diff --git a/concept-api/src/test/scala/no/ndla/conceptapi/service/WriteServiceTest.scala b/concept-api/src/test/scala/no/ndla/conceptapi/service/WriteServiceTest.scala
index a45b63198d..6d31dc50c0 100644
--- a/concept-api/src/test/scala/no/ndla/conceptapi/service/WriteServiceTest.scala
+++ b/concept-api/src/test/scala/no/ndla/conceptapi/service/WriteServiceTest.scala
@@ -97,7 +97,7 @@ class WriteServiceTest extends UnitSuite with TestEnvironment {
       articleIds = Seq.empty,
       editorNotes = Some(
         Seq(
-          api.EditorNote("New language 'en' added.", "", api.Status("IN_PROGRESS", Seq.empty), today)
+          api.EditorNote("New language 'en' added", "", api.Status("IN_PROGRESS", Seq.empty), today)
         )
       )
     )
@@ -130,7 +130,7 @@ class WriteServiceTest extends UnitSuite with TestEnvironment {
       articleIds = Seq.empty,
       editorNotes = Some(
         Seq(
-          api.EditorNote("New language 'nn' added.", "", api.Status("IN_PROGRESS", Seq.empty), today)
+          api.EditorNote("New language 'nn' added", "", api.Status("IN_PROGRESS", Seq.empty), today)
         )
       )
     )
@@ -193,7 +193,7 @@ class WriteServiceTest extends UnitSuite with TestEnvironment {
       responsible = Some(api.ConceptResponsible("123", today)),
       editorNotes = Some(
         Seq(
-          api.EditorNote("New language 'en' added.", "", api.Status("IN_PROGRESS", Seq.empty), today),
+          api.EditorNote("New language 'en' added", "", api.Status("IN_PROGRESS", Seq.empty), today),
           api.EditorNote("Responsible changed", "", api.Status("IN_PROGRESS", Seq.empty), today)
         )
       )
@@ -265,24 +265,24 @@ class WriteServiceTest extends UnitSuite with TestEnvironment {
     val responsibleId = "ResponsibleId"
     val updatedApiConcept =
       api.UpdatedConcept(
-        "nb",
-        None,
-        None,
-        Right(None),
-        None,
-        None,
-        None,
-        Some(Seq.empty),
-        None,
-        None,
-        Right(Some(responsibleId)),
-        None,
-        None
+        language = "nb",
+        title = None,
+        content = None,
+        metaImage = Right(None),
+        copyright = None,
+        tags = None,
+        subjectIds = None,
+        articleIds = Some(Seq(42)),
+        status = None,
+        visualElement = None,
+        responsibleId = Right(Some(responsibleId)),
+        conceptType = None,
+        glossData = None
       )
     val expectedConcept = concept.copy(
       updated = today,
       supportedLanguages = Set("nb"),
-      articleIds = Seq.empty,
+      articleIds = Seq(42),
       responsible = Some(api.ConceptResponsible(responsibleId, today)),
       editorNotes = Some(
         Seq(