Skip to content

Commit

Permalink
Improve naming for tapir error handling symbols
Browse files Browse the repository at this point in the history
  • Loading branch information
jnatten committed Oct 9, 2024
1 parent 29ed0a7 commit 6910a81
Show file tree
Hide file tree
Showing 89 changed files with 208 additions and 226 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import no.ndla.articleapi.service.*
import no.ndla.articleapi.service.search.*
import no.ndla.articleapi.validation.ContentValidator
import no.ndla.articleapi.integration.SearchApiClient
import no.ndla.articleapi.model.api.ErrorHelpers
import no.ndla.articleapi.model.api.ErrorHandling
import no.ndla.articleapi.model.domain.DBArticle
import no.ndla.common.Clock
import no.ndla.common.configuration.BaseComponentRegistry
Expand Down Expand Up @@ -51,7 +51,7 @@ class ComponentRegistry(properties: ArticleApiProperties)
with WriteService
with ContentValidator
with Clock
with ErrorHelpers
with ErrorHandling
with DBArticle
with DBMigrator
with SwaggerDocControllerConfig
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import scala.util.{Failure, Success, Try}

trait ArticleControllerV2 {
this: ReadService & WriteService & ArticleSearchService & SearchConverterService & ConverterService &
ContentValidator & Props & ErrorHelpers & TapirController =>
ContentValidator & Props & ErrorHandling & TapirController =>
val articleControllerV2: ArticleControllerV2

import props._
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import no.ndla.language.Language
import no.ndla.network.tapir.NoNullJsonPrinter.jsonBody
import no.ndla.network.tapir.TapirUtil.errorOutputsFor
import no.ndla.network.tapir.auth.Permission.ARTICLE_API_WRITE
import no.ndla.network.tapir.{TapirController, TapirErrorHelpers}
import no.ndla.network.tapir.TapirController
import sttp.model.StatusCode
import sttp.tapir.*
import sttp.tapir.generic.auto.*
Expand All @@ -37,7 +37,7 @@ import scala.util.{Failure, Success}

trait InternController {
this: ReadService & WriteService & ConverterService & ArticleRepository & IndexService & ArticleIndexService &
ContentValidator & TapirErrorHelpers & Props & DBArticle & TapirController =>
ContentValidator & Props & DBArticle & TapirController =>
val internController: InternController

class InternController extends TapirController with StrictLogging {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ import no.ndla.network.tapir.{
AllErrors,
ErrorBody,
NotFoundWithSupportedLanguages,
TapirErrorHelpers,
TapirErrorHandling,
ValidationErrorBody
}
import no.ndla.search.{IndexNotFoundException, NdlaSearchException}
import org.postgresql.util.PSQLException

trait ErrorHelpers extends TapirErrorHelpers with StrictLogging {
trait ErrorHandling extends TapirErrorHandling with StrictLogging {
this: Props with Clock with DataSource =>

import ErrorHelpers._
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import no.ndla.articleapi.Props
import no.ndla.articleapi.caching.MemoizeHelpers
import no.ndla.articleapi.integration.FrontpageApiClient
import no.ndla.articleapi.model.api
import no.ndla.articleapi.model.api.{ArticleSummaryV2, ErrorHelpers, NotFoundException}
import no.ndla.articleapi.model.api.{ArticleSummaryV2, ErrorHandling, NotFoundException}
import no.ndla.articleapi.model.domain.*
import no.ndla.articleapi.model.search.SearchResult
import no.ndla.articleapi.repository.ArticleRepository
Expand All @@ -39,7 +39,7 @@ import scala.util.{Failure, Success, Try}

trait ReadService {
this: ArticleRepository & FeideApiClient & ConverterService & ArticleSearchService & SearchConverterService &
MemoizeHelpers & Props & ErrorHelpers & FrontpageApiClient =>
MemoizeHelpers & Props & ErrorHandling & FrontpageApiClient =>
val readService: ReadService

class ReadService extends StrictLogging {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import com.sksamuel.elastic4s.requests.searches.queries.compound.BoolQuery
import com.typesafe.scalalogging.StrictLogging
import no.ndla.articleapi.Props
import no.ndla.articleapi.model.api
import no.ndla.articleapi.model.api.{ArticleSummaryV2, ErrorHelpers}
import no.ndla.articleapi.model.api.{ArticleSummaryV2, ErrorHandling}
import no.ndla.articleapi.model.domain._
import no.ndla.articleapi.model.search.SearchResult
import no.ndla.articleapi.service.ConverterService
Expand All @@ -34,7 +34,7 @@ trait ArticleSearchService {
with ArticleIndexService
with ConverterService
with Props
with ErrorHelpers =>
with ErrorHandling =>
val articleSearchService: ArticleSearchService

import props._
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import no.ndla.articleapi.service.*
import no.ndla.articleapi.service.search.*
import no.ndla.articleapi.validation.ContentValidator
import no.ndla.articleapi.integration.SearchApiClient
import no.ndla.articleapi.model.api.ErrorHelpers
import no.ndla.articleapi.model.api.ErrorHandling
import no.ndla.articleapi.model.domain.DBArticle
import no.ndla.common.Clock
import no.ndla.network.NdlaClient
Expand Down Expand Up @@ -49,7 +49,7 @@ trait TestEnvironment
with WriteService
with ContentValidator
with Clock
with ErrorHelpers
with ErrorHandling
with MemoizeHelpers
with DBArticle
with Props
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ package no.ndla.audioapi
import com.zaxxer.hikari.HikariDataSource
import no.ndla.audioapi.controller.*
import no.ndla.audioapi.integration.*
import no.ndla.audioapi.model.api.ErrorHelpers
import no.ndla.audioapi.model.api.ErrorHandling
import no.ndla.audioapi.repository.{AudioRepository, SeriesRepository}
import no.ndla.audioapi.service.*
import no.ndla.audioapi.service.search.*
Expand Down Expand Up @@ -51,7 +51,7 @@ class ComponentRegistry(properties: AudioApiProperties)
with Clock
with Props
with DBMigrator
with ErrorHelpers
with ErrorHandling
with SwaggerDocControllerConfig
with NdlaS3Client {
override val props: AudioApiProperties = properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ trait AudioController {
with SearchConverterService
with ConverterService
with Props
with ErrorHelpers
with ErrorHandling
with TapirController =>
val audioApiController: AudioController

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import cats.implicits.*
import io.circe.generic.auto.*
import no.ndla.audioapi.Props
import no.ndla.audioapi.model.api
import no.ndla.audioapi.model.api.{AudioMetaDomainDump, ErrorHelpers, NotFoundException}
import no.ndla.audioapi.model.api.{AudioMetaDomainDump, ErrorHandling, NotFoundException}
import no.ndla.audioapi.model.domain.AudioMetaInformation
import no.ndla.audioapi.repository.AudioRepository
import no.ndla.audioapi.service.search.{AudioIndexService, SeriesIndexService, TagIndexService}
Expand All @@ -29,7 +29,7 @@ import scala.util.{Failure, Success}

trait InternController {
this: AudioIndexService & ConverterService & AudioRepository & AudioIndexService & SeriesIndexService &
TagIndexService & ReadService & Props & ErrorHelpers & TapirController =>
TagIndexService & ReadService & Props & ErrorHandling & TapirController =>
val internController: InternController

class InternController extends TapirController {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import scala.util.{Failure, Success, Try}

trait SeriesController {
this: ReadService & WriteService & SeriesSearchService & SearchConverterService & ConverterService & Props &
ErrorHelpers & TapirController =>
ErrorHandling & TapirController =>
val seriesController: SeriesController
class SeriesController extends TapirController {
import props.*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ import no.ndla.audioapi.integration.DataSource
import no.ndla.common.Clock
import no.ndla.common.errors.{AccessDeniedException, FileTooBigException, ValidationException}
import no.ndla.network.model.HttpRequestException
import no.ndla.network.tapir.{AllErrors, ErrorBody, TapirErrorHelpers, ValidationErrorBody}
import no.ndla.network.tapir.{AllErrors, ErrorBody, TapirErrorHandling, ValidationErrorBody}
import no.ndla.search.NdlaSearchException
import org.postgresql.util.PSQLException

trait ErrorHelpers extends TapirErrorHelpers {
trait ErrorHandling extends TapirErrorHandling {
this: Props with Clock with DataSource =>

import ErrorHelpers._
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ package no.ndla.audioapi.repository
import com.typesafe.scalalogging.StrictLogging
import no.ndla.audioapi.Props
import no.ndla.audioapi.integration.DataSource
import no.ndla.audioapi.model.api.ErrorHelpers
import no.ndla.audioapi.model.api.ErrorHandling
import no.ndla.audioapi.model.domain.{AudioMetaInformation, Series}
import no.ndla.common.CirceUtil
import org.postgresql.util.PGobject
import scalikejdbc.{DBSession, ReadOnlyAutoSession, *}
import scalikejdbc.*

import scala.util.{Failure, Success, Try}

trait AudioRepository {
this: DataSource with SeriesRepository with Props with ErrorHelpers =>
this: DataSource with SeriesRepository with Props with ErrorHandling =>
val audioRepository: AudioRepository

class AudioRepository extends StrictLogging with Repository[AudioMetaInformation] {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ import no.ndla.audioapi.integration.DataSource
import no.ndla.audioapi.model.domain.{AudioMetaInformation, Series}
import no.ndla.audioapi.model.domain
import org.postgresql.util.PGobject
import scalikejdbc.{DBSession, ReadOnlyAutoSession, *}
import scalikejdbc.*
import cats.implicits.*
import no.ndla.audioapi.Props
import no.ndla.audioapi.model.api.ErrorHelpers
import no.ndla.audioapi.model.api.ErrorHandling
import no.ndla.common.CirceUtil
import no.ndla.common.model.NDLADate

import scala.util.{Failure, Success, Try}

trait SeriesRepository {
this: DataSource with Props with ErrorHelpers =>
this: DataSource with Props with ErrorHandling =>
val seriesRepository: SeriesRepository

class SeriesRepository extends StrictLogging with Repository[Series] {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import com.sksamuel.elastic4s.ElasticDsl.*
import com.sksamuel.elastic4s.requests.searches.queries.compound.BoolQuery
import com.typesafe.scalalogging.StrictLogging
import no.ndla.audioapi.Props
import no.ndla.audioapi.model.api.ErrorHelpers
import no.ndla.audioapi.model.api.ErrorHandling
import no.ndla.audioapi.model.domain.SearchSettings
import no.ndla.audioapi.model.search.SearchableAudioInformation
import no.ndla.audioapi.model.{api, domain}
Expand All @@ -31,7 +31,7 @@ trait AudioSearchService {
with SearchConverterService
with SearchService
with Props
with ErrorHelpers =>
with ErrorHandling =>
val audioSearchService: AudioSearchService

class AudioSearchService extends StrictLogging with SearchService[api.AudioSummary] {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import com.sksamuel.elastic4s.ElasticDsl.*
import com.sksamuel.elastic4s.requests.searches.queries.compound.BoolQuery
import com.typesafe.scalalogging.StrictLogging
import no.ndla.audioapi.Props
import no.ndla.audioapi.model.api.ErrorHelpers
import no.ndla.audioapi.model.api.ErrorHandling
import no.ndla.audioapi.model.domain.SeriesSearchSettings
import no.ndla.audioapi.model.search.SearchableSeries
import no.ndla.audioapi.model.{api, domain}
Expand All @@ -33,7 +33,7 @@ trait SeriesSearchService {
with SearchService
with ConverterService
with Props
with ErrorHelpers =>
with ErrorHandling =>
val seriesSearchService: SeriesSearchService

class SeriesSearchService extends StrictLogging with SearchService[api.SeriesSummary] {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import com.sksamuel.elastic4s.requests.searches.queries.compound.BoolQuery
import com.sksamuel.elastic4s.requests.searches.sort.SortOrder
import com.typesafe.scalalogging.StrictLogging
import no.ndla.audioapi.Props
import no.ndla.audioapi.model.api.ErrorHelpers
import no.ndla.audioapi.model.api.ErrorHandling
import no.ndla.audioapi.model.domain.{SearchResult, SearchableTag}
import no.ndla.common.CirceUtil
import no.ndla.language.model.Iso639
Expand All @@ -29,7 +29,7 @@ trait TagSearchService {
with TagIndexService
with SearchConverterService
with Props
with ErrorHelpers =>
with ErrorHandling =>
val tagSearchService: TagSearchService

class TagSearchService extends StrictLogging with SearchService[String] {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ package no.ndla.audioapi
import com.zaxxer.hikari.HikariDataSource
import no.ndla.audioapi.controller.{AudioController, HealthController, InternController, SeriesController}
import no.ndla.audioapi.integration.*
import no.ndla.audioapi.model.api.ErrorHelpers
import no.ndla.audioapi.model.api.ErrorHandling
import no.ndla.audioapi.repository.{AudioRepository, SeriesRepository}
import no.ndla.audioapi.service.*
import no.ndla.audioapi.service.search.*
Expand Down Expand Up @@ -51,7 +51,7 @@ trait TestEnvironment
with MockitoSugar
with Clock
with Props
with ErrorHelpers {
with ErrorHandling {
override val props: AudioApiProperties = new AudioApiProperties

val dataSource: HikariDataSource = mock[HikariDataSource]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import com.typesafe.scalalogging.StrictLogging
import com.zaxxer.hikari.HikariDataSource
import no.ndla.conceptapi.controller.*
import no.ndla.conceptapi.integration.{ArticleApiClient, DataSource, SearchApiClient, TaxonomyApiClient}
import no.ndla.conceptapi.model.api.ErrorHelpers
import no.ndla.conceptapi.model.api.ErrorHandling
import no.ndla.conceptapi.model.search.{DraftSearchSettingsHelper, SearchSettingsHelper}
import no.ndla.conceptapi.repository.{DraftConceptRepository, PublishedConceptRepository}
import no.ndla.conceptapi.service.search.*
Expand Down Expand Up @@ -54,7 +54,7 @@ class ComponentRegistry(properties: ConceptApiProperties)
with NdlaClient
with Props
with DBMigrator
with ErrorHelpers
with ErrorHandling
with SearchSettingsHelper
with DraftSearchSettingsHelper
with TaxonomyApiClient
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ trait DraftConceptController {
with ConverterService
with Props
with ConceptControllerHelpers
with ErrorHelpers
with ErrorHandling
with TapirController =>
val draftConceptController: DraftConceptController

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ package no.ndla.conceptapi.controller

import cats.implicits.*
import no.ndla.common.model.domain.concept.Concept
import no.ndla.conceptapi.model.api.{ConceptDomainDump, ConceptImportResults, ErrorHelpers, NotFoundException}
import no.ndla.conceptapi.model.api.{ConceptDomainDump, ConceptImportResults, ErrorHandling, NotFoundException}
import no.ndla.conceptapi.repository.{DraftConceptRepository, PublishedConceptRepository}
import no.ndla.conceptapi.service.search.{DraftConceptIndexService, IndexService, PublishedConceptIndexService}
import no.ndla.conceptapi.service.{ConverterService, ImportService, ReadService}
Expand All @@ -29,7 +29,7 @@ import sttp.tapir.generic.auto.*

trait InternController {
this: IndexService & DraftConceptIndexService & PublishedConceptIndexService & ImportService & ConverterService &
ReadService & DraftConceptRepository & PublishedConceptRepository & ErrorHelpers & TapirController =>
ReadService & DraftConceptRepository & PublishedConceptRepository & ErrorHandling & TapirController =>
val internController: InternController

class InternController extends TapirController {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ trait PublishedConceptController {
with SearchConverterService
with Props
with ConceptControllerHelpers
with ErrorHelpers
with ErrorHandling
with TapirController =>
val publishedConceptController: PublishedConceptController

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ import no.ndla.common.errors.{AccessDeniedException, ValidationException}
import no.ndla.conceptapi.Props
import no.ndla.conceptapi.integration.DataSource
import no.ndla.network.model.HttpRequestException
import no.ndla.network.tapir.{AllErrors, TapirErrorHelpers}
import no.ndla.network.tapir.{AllErrors, TapirErrorHandling}
import no.ndla.search.{IndexNotFoundException, NdlaSearchException}
import org.postgresql.util.PSQLException

trait ErrorHelpers extends TapirErrorHelpers {
trait ErrorHandling extends TapirErrorHandling {
this: Props & Clock & DataSource =>

import ConceptErrorHelpers.*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ import no.ndla.common.model.domain.Tag
import no.ndla.common.model.domain.concept.Concept
import no.ndla.conceptapi.Props
import no.ndla.conceptapi.integration.DataSource
import no.ndla.conceptapi.model.api.{ConceptMissingIdException, ErrorHelpers, NotFoundException}
import no.ndla.conceptapi.model.api.{ConceptMissingIdException, ErrorHandling, NotFoundException}
import no.ndla.conceptapi.model.domain.DBConcept
import org.postgresql.util.PGobject
import scalikejdbc.*

import scala.util.{Failure, Success, Try}

trait DraftConceptRepository {
this: DataSource with Props with ErrorHelpers =>
this: DataSource with Props with ErrorHandling =>
val draftConceptRepository: DraftConceptRepository

class DraftConceptRepository extends StrictLogging with Repository[Concept] {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ package no.ndla.conceptapi.service

import no.ndla.common.model.domain.concept.{ConceptEditorNote, ConceptStatus, Status, Concept as DomainConcept}
import no.ndla.common.model.domain.{Responsible, concept}
import no.ndla.conceptapi.model.api.ErrorHelpers
import no.ndla.conceptapi.model.api.ErrorHandling
import no.ndla.common.model.domain.concept.ConceptStatus.*
import no.ndla.conceptapi.model.domain.SideEffect.SideEffect
import no.ndla.conceptapi.model.domain.StateTransition
Expand All @@ -25,7 +25,7 @@ import scala.util.{Failure, Success, Try}

trait StateTransitionRules {
this: WriteService & DraftConceptRepository & PublishedConceptRepository & WriteService & ConverterService &
ContentValidator & DraftConceptIndexService & PublishedConceptRepository & ErrorHelpers & Clock =>
ContentValidator & DraftConceptIndexService & PublishedConceptRepository & ErrorHandling & Clock =>

object StateTransitionRules {

Expand Down
Loading

0 comments on commit 6910a81

Please sign in to comment.