[DPP-645][Self-service error codes] Adapt ApiConfigManagementService (#…

…11312)

CHANGELOG_BEGIN
CHANGELOG_END

ledger/error/src/main/scala/com/daml/error/ErrorCodesVersionSwitcher.scala

@@ -6,7 +6,7 @@ import io.grpc.StatusRuntimeException
 
 import scala.concurrent.Future
 
-final class ErrorCodesVersionSwitcher(enableSelfServiceErrorCodes: Boolean)
+class ErrorCodesVersionSwitcher(enableSelfServiceErrorCodes: Boolean)
     extends ValueSwitch[StatusRuntimeException](enableSelfServiceErrorCodes) {
 
   def chooseAsFailedFuture[T](

ledger/error/src/main/scala/com/daml/error/definitions/LedgerApiErrors.scala

@@ -32,6 +32,22 @@ object LedgerApiErrors extends LedgerApiErrorGroup {
         )
   }
 
+  object WriteErrors extends ErrorGroup() {
+    @Explanation("This rejection is given when a configuration entry write was rejected.")
+    @Resolution("Fetch newest configuration and/or retry.")
+    object ConfigurationEntryRejected
+        extends ErrorCode(
+          id = "CONFIGURATION_ENTRY_REJECTED",
+          ErrorCategory.InvalidGivenCurrentSystemStateOther,
+        ) {
+      case class Reject(message: String)(implicit
+          loggingContext: ContextualizedErrorLogger
+      ) extends LoggingTransactionErrorImpl(
+            cause = message
+          )
+    }
+  }
+
   object ReadErrors extends ErrorGroup() {
 
     @Explanation("This rejection is given when a package id is malformed.")

ledger/ledger-api-common/src/main/scala/com/digitalasset/platform/server/api/validation/ErrorFactories.scala

@@ -243,6 +243,15 @@ class ErrorFactories private (errorCodesVersionSwitcher: ErrorCodesVersionSwitch
     grpcError(statusBuilder.build())
   }
 
+  def configurationEntryRejected(message: String, definiteAnswer: Option[Boolean])(implicit
+      contextualizedErrorLogger: ContextualizedErrorLogger
+  ): StatusRuntimeException = {
+    errorCodesVersionSwitcher.choose(
+      v1 = aborted(message, definiteAnswer),
+      v2 = LedgerApiErrors.WriteErrors.ConfigurationEntryRejected.Reject(message).asGrpcError,
+    )
+  }
+
   // permission denied is intentionally without description to ensure we don't leak security relevant information by accident
   def permissionDenied(cause: String)(implicit
       contextualizedErrorLogger: ContextualizedErrorLogger
@@ -302,6 +311,8 @@ class ErrorFactories private (errorCodesVersionSwitcher: ErrorCodesVersionSwitch
         addDefiniteAnswerDetails(definiteAnswer, statusBuilder)
         grpcError(statusBuilder.build())
       },
+      // TODO error codes: This error group is confusing for this generic error as it can be dispatched
+      //                   from call-sites that do not involve Daml interpreter.
       v2 = LedgerApiErrors.InterpreterErrors.LookupErrors.LedgerConfigurationNotFound
         .Reject()
         .asGrpcError,

ledger/ledger-api-common/src/test/suite/scala/com/digitalasset/platform/server/api/validation/ErrorFactoriesSpec.scala

@@ -86,6 +86,20 @@ class ErrorFactoriesSpec extends AnyWordSpec with Matchers with TableDrivenPrope
       )
     }
 
+    "return the configurationEntryRejected" in {
+      assertVersionedError(_.configurationEntryRejected("message123", None))(
+        v1_code = Code.ABORTED,
+        v1_message = "message123",
+        v1_details = Seq.empty,
+        v2_code = Code.FAILED_PRECONDITION,
+        v2_message = s"CONFIGURATION_ENTRY_REJECTED(9,$correlationId): message123",
+        v2_details = Seq[ErrorDetails.ErrorDetail](
+          ErrorDetails.ErrorInfoDetail("CONFIGURATION_ENTRY_REJECTED"),
+          DefaultTraceIdRequestInfo,
+        ),
+      )
+    }
+
     "return a transactionNotFound error" in {
       assertVersionedError(_.transactionNotFound(Ref.TransactionId.assertFromString("tId")))(
         v1_code = Code.NOT_FOUND,

ledger/participant-integration-api/src/main/scala/platform/apiserver/ApiServices.scala

@@ -289,6 +289,7 @@ private[daml] object ApiServices {
           configManagementService,
           writeService,
           timeProvider,
+          errorsVersionsSwitcher,
         )
 
         val apiParticipantPruningService =

ledger/participant-integration-api/src/main/scala/platform/apiserver/services/admin/ApiConfigManagementService.scala

@@ -7,7 +7,11 @@ import java.time.{Duration => JDuration}
 import akka.stream.Materializer
 import akka.stream.scaladsl.Source
 import com.daml.api.util.{DurationConversion, TimeProvider, TimestampConversion}
-import com.daml.error.{DamlContextualizedErrorLogger, ContextualizedErrorLogger}
+import com.daml.error.{
+  ContextualizedErrorLogger,
+  DamlContextualizedErrorLogger,
+  ErrorCodesVersionSwitcher,
+}
 import com.daml.ledger.api.domain
 import com.daml.ledger.api.domain.{ConfigurationEntry, LedgerOffset}
 import com.daml.ledger.api.v1.admin.config_management_service.ConfigManagementServiceGrpc.ConfigManagementService
@@ -36,6 +40,7 @@ private[apiserver] final class ApiConfigManagementService private (
     writeService: state.WriteConfigService,
     timeProvider: TimeProvider,
     submissionIdGenerator: String => Ref.SubmissionId,
+    errorCodesVersionSwitcher: ErrorCodesVersionSwitcher,
 )(implicit
     materializer: Materializer,
     executionContext: ExecutionContext,
@@ -46,6 +51,9 @@ private[apiserver] final class ApiConfigManagementService private (
   private implicit val contextualizedErrorLogger: ContextualizedErrorLogger =
     new DamlContextualizedErrorLogger(logger, loggingContext, None)
 
+  private val errorFactories =
+    com.daml.platform.server.api.validation.ErrorFactories(errorCodesVersionSwitcher)
+
   override def close(): Unit = ()
 
   override def bindService(): ServerServiceDefinition =
@@ -60,7 +68,7 @@ private[apiserver] final class ApiConfigManagementService private (
           Future.successful(configurationToResponse(configuration))
         case None =>
           // TODO error codes: Duplicate of missingLedgerConfig
-          Future.failed(ErrorFactories.missingLedgerConfigUponRequest)
+          Future.failed(errorFactories.missingLedgerConfigUponRequest)
       }
       .andThen(logger.logErrorsOnCall[GetTimeModelResponse])
   }
@@ -106,7 +114,7 @@ private[apiserver] final class ApiConfigManagementService private (
                 logger.warn(
                   "Could not get the current time model. The index does not yet have any ledger configuration."
                 )
-                Future.failed(ErrorFactories.missingLedgerConfig(None))
+                Future.failed(errorFactories.missingLedgerConfig(None))
             }
           (ledgerEndBeforeRequest, currentConfig) = configuration
 
@@ -117,7 +125,7 @@ private[apiserver] final class ApiConfigManagementService private (
               Future.failed(
                 ValidationLogger.logFailureWithContext(
                   request,
-                  ErrorFactories.invalidArgument(None)(
+                  errorFactories.invalidArgument(None)(
                     s"Mismatching configuration generation, expected $expectedGeneration, received ${request.configurationGeneration}"
                   ),
                 )
@@ -139,6 +147,7 @@ private[apiserver] final class ApiConfigManagementService private (
               writeService,
               index,
               ledgerEndBeforeRequest,
+              errorFactories,
             ),
             timeToLive = JDuration.ofMillis(params.timeToLive.toMillis),
           )
@@ -176,7 +185,7 @@ private[apiserver] final class ApiConfigManagementService private (
         minSkew = DurationConversion.fromProto(pMinSkew),
         maxSkew = DurationConversion.fromProto(pMaxSkew),
       ) match {
-        case Failure(err) => Left(ErrorFactories.invalidArgument(None)(err.toString))
+        case Failure(err) => Left(errorFactories.invalidArgument(None)(err.toString))
         case Success(ok) => Right(ok)
       }
       // TODO(JM): The maximum record time should be constrained, probably by the current active time model?
@@ -189,7 +198,7 @@ private[apiserver] final class ApiConfigManagementService private (
       }
       maximumRecordTime <- Time.Timestamp
         .fromInstant(mrtInstant)
-        .fold(err => Left(ErrorFactories.invalidArgument(None)(err)), Right(_))
+        .fold(err => Left(errorFactories.invalidArgument(None)(err)), Right(_))
     } yield SetTimeModelParameters(newTimeModel, maximumRecordTime, timeToLive)
   }
 
@@ -201,6 +210,7 @@ private[apiserver] object ApiConfigManagementService {
       readBackend: IndexConfigManagementService,
       writeBackend: state.WriteConfigService,
       timeProvider: TimeProvider,
+      errorCodesVersionSwitcher: ErrorCodesVersionSwitcher,
       submissionIdGenerator: String => Ref.SubmissionId = augmentSubmissionId,
   )(implicit
       materializer: Materializer,
@@ -212,13 +222,15 @@ private[apiserver] object ApiConfigManagementService {
       writeBackend,
       timeProvider,
       submissionIdGenerator,
+      errorCodesVersionSwitcher,
     )
 
   private final class SynchronousResponseStrategy(
       writeConfigService: state.WriteConfigService,
       configManagementService: IndexConfigManagementService,
       ledgerEnd: LedgerOffset.Absolute,
-  )(implicit loggingContext: LoggingContext)
+      errorFactories: ErrorFactories,
+  )(implicit loggingContext: LoggingContext, contextualizedErrorLogger: ContextualizedErrorLogger)
       extends SynchronousResponse.Strategy[
         (Time.Timestamp, Configuration),
         ConfigurationEntry,
@@ -252,7 +264,7 @@ private[apiserver] object ApiConfigManagementService {
         submissionId: Ref.SubmissionId
     ): PartialFunction[ConfigurationEntry, StatusRuntimeException] = {
       case domain.ConfigurationEntry.Rejected(`submissionId`, reason, _) =>
-        ErrorFactories.aborted(reason, None)
+        errorFactories.configurationEntryRejected(reason, None)
     }
   }