Обнаружение скрытых ошибок в Scala Chimney

На чтение 3 мин Опубликовано 07.10.2024

Вопрос или проблема

Если тип A имеет поле x, а тип B имеет все, что есть у A, за исключением поля x? Например:

class A(a: int, b: String, x: Boolean)
class B(a: int, b: String)

val a = new A(1, "test", true)

a.transformInto[B] будет работать и вернет B(1, "test"), тихо игнорируя логическое значение x. Это тихая ошибка, которую я хотел бы выявить и зафиксировать в журнале.

Кто-нибудь нашел способ сделать это нативно с помощью конверсий Chimney? Или нам нужно вручную проверять типы Source и Target, обращая внимание на имена/количество полей?

Спасибо

Ответ или решение

Чтобы обнаружить скрытые ошибки при использовании библиотеки Chimney для преобразования между типами в Scala, можно воспользоваться механизмом валидации, который позволит отлавливать ситуации, когда данные теряются в процессе преобразования.

Ваша проблема в том, что при преобразовании объекта типа A в объект типа B происходит "тихое" игнорирование поля x. Чтобы это предотвратить и зафиксировать факт игнорирования, можно использовать кастомную валидацию.

Вот один из подходов, которым можно воспользоваться:

Создайте специальный метод для валидации: Мы можем создать метод, который будет проверять поле x перед преобразованием. Если поле x присутствует в объекте, но отсутствует в целевом типе, мы можем сгенерировать предупреждение или ошибку.
Используйте тип безопасности для сигнализации о нарушениях: Вы можете создать sealed trait и sealed case classes для обозначения ваших типов, чтобы обеспечить явную проверку на этапе компиляции.

Пример кода:

import com.softwaremill.chimney.dsl._

case class A(a: Int, b: String, x: Boolean)
case class B(a: Int, b: String)

object TypeCheck {
  def validateConversion(a: A): Option[String] = {
    if (a.x) Some("Поле x игнорируется при преобразовании A в B.") else None
  }

  def transform(a: A): Either[String, B] = {
    validateConversion(a) match {
      case Some(error) => Left(error)
      case None => Right(a.transformInto[B])
    }
  }
}

object Main extends App {
  val a = A(1, "test", true)

  TypeCheck.transform(a) match {
    case Left(errorMessage) => println(s"Ошибка: $errorMessage")
    case Right(b) => println(s"Преобразованный объект B: $b")
  }
}

В этом примере метод validateConversion проверяет наличие поля x и возвращает сообщение об ошибке, если оно присутствует. Метод transform использует эту валидацию перед выполнением преобразования.

Таким образом, данное решение позволяет избежать скрытых ошибок и четко сигнализировать о том, когда поле теряется при преобразовании типов. Настройте логику валидации в зависимости от ваших требований, чтобы учесть другие потенциальные ошибки, которые могут возникнуть при преобразовании.