article-api + draft-api: Make use of OptLanguageFields for disclaimer

This patch adds a migration of disclaimer to `OptLanguageFields` as well as retypes the `diclaimer` of the domain type to `OptLanguageFields`.
NDLANO · Jan 16, 2025 · e6063c9 · e6063c9
1 parent 4889725
commit e6063c9
Show file tree

Hide file tree

Showing 30 changed files with 303 additions and 107 deletions.
diff --git a/article-api/src/main/scala/no/ndla/articleapi/db/HtmlMigration.scala b/article-api/src/main/scala/no/ndla/articleapi/db/HtmlMigration.scala
@@ -28,7 +28,7 @@ abstract class HtmlMigration extends DocumentMigration {
     jsoupDocumentToString(converted)
   }
 
-  protected def convertColumn(document: String): String = {
+  def convertColumn(document: String): String = {
     val oldArticle = parser.parse(document).flatMap(_.as[Article]).toTry.get
     val convertedContent = oldArticle.content.map(c => {
       val converted = convertContent(c.content, c.language)

diff --git a/...-api/src/main/scala/no/ndla/articleapi/db/migration/V56__DisclaimerToLanguageFields.scala b/...-api/src/main/scala/no/ndla/articleapi/db/migration/V56__DisclaimerToLanguageFields.scala
@@ -0,0 +1,17 @@
+/*
+ * Part of NDLA article-api
+ * Copyright (C) 2025 NDLA
+ *
+ * See LICENSE
+ *
+ */
+
+package no.ndla.articleapi.db.migration
+
+import no.ndla.database.LanguageFieldMigration
+
+class V56__DisclaimerToLanguageFields extends LanguageFieldMigration {
+  override val columnName: String = "document"
+  override val tableName: String  = "contentdata"
+  override val fieldName: String  = "disclaimer"
+}
diff --git a/article-api/src/main/scala/no/ndla/articleapi/service/ConverterService.scala b/article-api/src/main/scala/no/ndla/articleapi/service/ConverterService.scala
@@ -260,8 +260,8 @@ trait ConverterService {
         val metaImage = findByLanguageOrBestEffort(article.metaImage, language).map(toApiArticleMetaImage)
         val copyright = toApiCopyright(article.copyright)
         val disclaimer = article.disclaimer
-          .flatMap(d => findByLanguageOrBestEffort(d, language))
-          .map(d => DisclaimerDTO(d.disclaimer, d.language))
+          .findByLanguageOrBestEffort(language)
+          .map(DisclaimerDTO.fromLanguageValue)
 
         Success(
           api.ArticleV2DTO(

diff --git a/article-api/src/main/scala/no/ndla/articleapi/validation/ContentValidator.scala b/article-api/src/main/scala/no/ndla/articleapi/validation/ContentValidator.scala
@@ -14,6 +14,7 @@ import no.ndla.common.errors.{ValidationException, ValidationMessage}
 import no.ndla.common.model.NDLADate
 import no.ndla.common.model.domain.article.{Article, Copyright}
 import no.ndla.common.model.domain.*
+import no.ndla.common.model.domain.language.OptLanguageFields
 import no.ndla.language.model.{Iso639, LanguageField}
 import no.ndla.mapping.License.getLicense
 import no.ndla.validation.HtmlTagRules.{allLegalTags, stringToJsoupDocument}
@@ -50,7 +51,7 @@ trait ContentValidator {
     def validateArticle(article: Article, isImported: Boolean): Try[Article] = {
       val validationErrors = validateArticleContent(article.content) ++
         article.introduction.flatMap(i => validateIntroduction(i)) ++
-        validateArticleDisclaimer(article.disclaimer.getOrElse(Seq.empty)) ++
+        validateArticleDisclaimer(article.disclaimer) ++
         validateMetaDescription(article.metaDescription, isImported) ++
         validateTitle(article.title) ++
         validateCopyright(article.copyright) ++
@@ -90,12 +91,12 @@ trait ContentValidator {
       }) ++ validateNonEmpty("content", contents)
     }
 
-    private def validateArticleDisclaimer(disclaimers: Seq[Disclaimer]): Seq[ValidationMessage] = {
-      disclaimers.flatMap(disclaimer => {
+    private def validateArticleDisclaimer(disclaimers: OptLanguageFields[String]): Seq[ValidationMessage] = {
+      disclaimers.mapExisting { disclaimer =>
         val field = s"disclaimer.${disclaimer.language}"
-        TextValidator.validate(field, disclaimer.disclaimer, allLegalTags).toList ++
-          validateLanguage("content.language", disclaimer.language)
-      })
+        TextValidator.validate(field, disclaimer.value, allLegalTags).toList ++
+          validateLanguage("disclaimer.language", disclaimer.language)
+      }.flatten
     }
 
     private def rootElementContainsOnlySectionBlocks(field: String, html: String): Option[ValidationMessage] = {
@@ -149,7 +150,7 @@ trait ContentValidator {
 
     private def validateTitle(titles: Seq[LanguageField[String]]): Seq[ValidationMessage] = {
       titles.flatMap(title => {
-        val field = s"title.$language"
+        val field = s"title.language"
         TextValidator.validate(field, title.value, inlineHtmlTags).toList ++
           validateLanguage("title.language", title.language) ++
           validateLength("title", title.value, 256)

diff --git a/article-api/src/test/scala/no/ndla/articleapi/TestData.scala b/article-api/src/test/scala/no/ndla/articleapi/TestData.scala
@@ -15,6 +15,7 @@ import no.ndla.common.model
 import no.ndla.common.model.NDLADate
 import no.ndla.common.model.domain.article.{Article, Copyright}
 import no.ndla.common.model.domain.*
+import no.ndla.common.model.domain.language.OptLanguageFields
 import no.ndla.mapping.License
 
 trait TestData {
@@ -155,7 +156,7 @@ trait TestData {
       relatedContent = Seq.empty,
       revisionDate = Some(NDLADate.now().withNano(0)),
       slug = None,
-      disclaimer = None
+      disclaimer = OptLanguageFields.empty
     )
 
     val sampleDomainArticle: Article = Article(
@@ -181,7 +182,7 @@ trait TestData {
       relatedContent = Seq.empty,
       revisionDate = None,
       slug = None,
-      disclaimer = None
+      disclaimer = OptLanguageFields.empty
     )
 
     val sampleDomainArticle2: Article = Article(
@@ -207,7 +208,7 @@ trait TestData {
       relatedContent = Seq.empty,
       revisionDate = None,
       slug = None,
-      disclaimer = None
+      disclaimer = OptLanguageFields.empty
     )
 
     val sampleArticleWithByNcSa: Article      = sampleArticleWithPublicDomain.copy(copyright = byNcSaCopyright)
@@ -245,7 +246,7 @@ trait TestData {
       relatedContent = Seq.empty,
       revisionDate = None,
       slug = None,
-      disclaimer = None
+      disclaimer = OptLanguageFields.empty
     )
 
     val apiArticleWithHtmlFaultV2: api.ArticleV2DTO = api.ArticleV2DTO(
@@ -316,7 +317,7 @@ trait TestData {
         relatedContent = Seq.empty,
         revisionDate = None,
         slug = None,
-        disclaimer = None
+        disclaimer = OptLanguageFields.empty
       )
     }
 

diff --git a/.../src/test/scala/no/ndla/articleapi/db/migration/V55__DisclaimerToLanguageFieldsTest.scala b/.../src/test/scala/no/ndla/articleapi/db/migration/V55__DisclaimerToLanguageFieldsTest.scala
@@ -0,0 +1,38 @@
+/*
+ * Part of NDLA article-api
+ * Copyright (C) 2024 NDLA
+ *
+ * See LICENSE
+ */
+
+package no.ndla.articleapi.db.migration
+
+import no.ndla.articleapi.{TestEnvironment, UnitSuite}
+import no.ndla.common.model.domain.{ArticleContent, Title}
+
+class V55__DisclaimerToLanguageFieldsTest extends UnitSuite with TestEnvironment {
+  test("That old disclaimers are migrated to new language fields") {
+    val oldDocument =
+      """{"disclaimer":[{"disclaimer":"Dette er bokmål","language":"nb"},{"disclaimer":"Dette er nynorsk","language":"nn"}]}"""
+    val expectedResult = """{"disclaimer":{"nb":"Dette er bokmål","nn":"Dette er nynorsk"}}"""
+    val migration      = new V56__DisclaimerToLanguageFields
+    val result         = migration.convertColumn(oldDocument)
+    result should be(expectedResult)
+  }
+
+  test("That no old disclaimers are migrated to new language fields") {
+    val oldDocument    = """{}"""
+    val expectedResult = """{"disclaimer":{}}"""
+    val migration      = new V56__DisclaimerToLanguageFields
+    val result         = migration.convertColumn(oldDocument)
+    result should be(expectedResult)
+  }
+
+  test("That null disclaimers are migrated to new language fields") {
+    val oldDocument    = """{"disclaimer":null}"""
+    val expectedResult = """{"disclaimer":{}}"""
+    val migration      = new V56__DisclaimerToLanguageFields
+    val result         = migration.convertColumn(oldDocument)
+    result should be(expectedResult)
+  }
+}
diff --git a/article-api/src/test/scala/no/ndla/articleapi/validation/ContentValidatorTest.scala b/article-api/src/test/scala/no/ndla/articleapi/validation/ContentValidatorTest.scala
@@ -22,6 +22,7 @@ import no.ndla.common.model.domain.{
   Title
 }
 import no.ndla.common.model.domain.article.Copyright
+import no.ndla.common.model.domain.language.OptLanguageFields
 import no.ndla.mapping.License.{CC_BY_SA, NA}
 
 import scala.util.Failure
@@ -83,7 +84,7 @@ class ContentValidatorTest extends UnitSuite with TestEnvironment {
   test("validateArticle should throw an error if disclaimer contains illegal HTML tags") {
     val article = TestData.sampleArticleWithByNcSa.copy(
       content = Seq(ArticleContent(validDocument, "nb")),
-      disclaimer = Some(Seq(Disclaimer("<p><hallo>hei</hallo></p>", "nb")))
+      disclaimer = OptLanguageFields.withValue("<p><hallo>hei</hallo></p>", "nb")
     )
 
     val Failure(error: ValidationException) = contentValidator.validateArticle(article, false)
@@ -98,22 +99,15 @@ class ContentValidatorTest extends UnitSuite with TestEnvironment {
   test("validateArticle should not throw an error if disclaimer contains legal HTML tags") {
     val article = TestData.sampleArticleWithByNcSa.copy(
       content = Seq(ArticleContent(validDocument, "nb")),
-      disclaimer = Some(
-        Seq(
-          Disclaimer(
-            validDisclaimer,
-            "nb"
-          )
-        )
-      )
+      disclaimer = OptLanguageFields.withValue(validDisclaimer, "nb")
     )
     contentValidator.validateArticle(article, false).isSuccess should be(true)
   }
 
   test("validateArticle should not throw an error if disclaimer contains plain text") {
     val article = TestData.sampleArticleWithByNcSa.copy(
       content = Seq(ArticleContent(validDocument, "nb")),
-      disclaimer = Some(Seq(Disclaimer("disclaimer", "nb")))
+      disclaimer = OptLanguageFields.withValue("disclaimer", "nb")
     )
     contentValidator.validateArticle(article, false).isSuccess should be(true)
   }

diff --git a/common/src/main/scala/no/ndla/common/model/api/DisclaimerDTO.scala b/common/src/main/scala/no/ndla/common/model/api/DisclaimerDTO.scala
@@ -10,6 +10,7 @@ package no.ndla.common.model.api
 
 import io.circe.generic.semiauto.{deriveDecoder, deriveEncoder}
 import io.circe.{Decoder, Encoder}
+import no.ndla.language.model.WithLanguageAndValue
 import sttp.tapir.Schema.annotations.description
 
 case class DisclaimerDTO(
@@ -18,6 +19,8 @@ case class DisclaimerDTO(
 )
 
 object DisclaimerDTO {
+  def fromLanguageValue(lv: WithLanguageAndValue[String]): DisclaimerDTO = DisclaimerDTO(lv.value, lv.language)
+
   implicit def encoder: Encoder[DisclaimerDTO] = deriveEncoder
   implicit def decoder: Decoder[DisclaimerDTO] = deriveDecoder
 }
diff --git a/common/src/main/scala/no/ndla/common/model/domain/article/Article.scala b/common/src/main/scala/no/ndla/common/model/domain/article/Article.scala
@@ -11,8 +11,9 @@ package no.ndla.common.model.domain.article
 import io.circe.generic.semiauto.{deriveDecoder, deriveEncoder}
 import io.circe.{Decoder, Encoder}
 import no.ndla.common.model.{NDLADate, RelatedContentLink}
-import no.ndla.common.model.domain._
-import no.ndla.common.implicits._
+import no.ndla.common.model.domain.*
+import no.ndla.common.implicits.*
+import no.ndla.common.model.domain.language.OptLanguageFields
 
 case class Article(
     id: Option[Long],
@@ -37,7 +38,7 @@ case class Article(
     relatedContent: Seq[RelatedContent],
     revisionDate: Option[NDLADate],
     slug: Option[String],
-    disclaimer: Option[Seq[Disclaimer]]
+    disclaimer: OptLanguageFields[String]
 ) extends Content
 
 object Article {

diff --git a/common/src/main/scala/no/ndla/common/model/domain/draft/Draft.scala b/common/src/main/scala/no/ndla/common/model/domain/draft/Draft.scala
@@ -9,9 +9,10 @@ package no.ndla.common.model.domain.draft
 
 import io.circe.{Decoder, Encoder}
 import io.circe.generic.semiauto.{deriveDecoder, deriveEncoder}
-import no.ndla.common.implicits._
+import no.ndla.common.implicits.*
 import no.ndla.common.model.{NDLADate, RelatedContentLink}
-import no.ndla.common.model.domain._
+import no.ndla.common.model.domain.*
+import no.ndla.common.model.domain.language.OptLanguageFields
 import no.ndla.language.Language.getSupportedLanguages
 
 case class Draft(
@@ -46,7 +47,7 @@ case class Draft(
     priority: Priority,
     started: Boolean,
     qualityEvaluation: Option[QualityEvaluation],
-    disclaimer: Option[Seq[Disclaimer]]
+    disclaimer: OptLanguageFields[String]
 ) extends Content {
 
   def supportedLanguages: Seq[String] =

diff --git a/common/src/main/scala/no/ndla/common/model/domain/language/LanguageFields.scala b/common/src/main/scala/no/ndla/common/model/domain/language/LanguageFields.scala
@@ -1,5 +1,5 @@
 /*
- * Part of NDLA backend.common.main
+ * Part of NDLA common
  * Copyright (C) 2025 NDLA
  *
  * See LICENSE
@@ -13,7 +13,7 @@ import io.circe.syntax.EncoderOps
 import no.ndla.language.Language
 import no.ndla.language.model.{BaseWithLanguageAndValue, WithLanguageAndValue}
 
-case class LanguageFields[T: Encoder: Decoder](internal: Map[String, T]) {
+case class LanguageFields[T](internal: Map[String, T]) {
   def getWithLanguageFields: Seq[WithLanguageAndValue[T]] = internal.map { case (language, value) =>
     BaseWithLanguageAndValue(language, value)
   }.toSeq
@@ -24,16 +24,14 @@ case class LanguageFields[T: Encoder: Decoder](internal: Map[String, T]) {
 }
 
 object LanguageFields {
-  def empty[T: Encoder: Decoder]: LanguageFields[T] = LanguageFields(Map.empty)
-  def fromFields[T](
-      fields: Seq[WithLanguageAndValue[T]]
-  )(implicit encoder: Encoder[T], decoder: Decoder[T]): LanguageFields[T] = {
+  def empty[T]: LanguageFields[T] = LanguageFields(Map.empty)
+  def fromFields[T](fields: Seq[WithLanguageAndValue[T]]): LanguageFields[T] = {
     val underlyingMap = fields.map(f => f.language -> f.value).toMap
     LanguageFields(underlyingMap)
   }
 
   implicit def encoder[T: Encoder]: Encoder[LanguageFields[T]] = Encoder.instance { lf => lf.internal.asJson }
-  implicit def decoder[T: Decoder: Encoder]: Decoder[LanguageFields[T]] = Decoder.instance { json =>
+  implicit def decoder[T: Decoder]: Decoder[LanguageFields[T]] = Decoder.instance { json =>
     json.as[Map[String, T]].map { m => LanguageFields(m) }
 
   }