final class RepairService extends NamedLogging with FlagCloseable with HasCloseContext
Implements the repair commands. Repair commands work only if the participant has disconnected from the affected domains. Every individual repair commands is executed transactionally, i.e., either all its effects are applied or none. This is achieved in the same way as for request processing:
- A request counter is allocated for the repair request (namely the clean request head) and marked as com.digitalasset.canton.participant.protocol.RequestJournal.RequestState.Pending. The repair request's timestamp is the timestamp where processing starts again upon reconnection to the domain.
- All repair effects are persisted to the stores using the repair request counter.
- The clean request prehead is advanced to the repair request counter. This commits the changes. If multiple domains are involved, transactionality is ensured via the com.digitalasset.canton.resource.TransactionalStoreUpdate mechanism.
If anything goes wrong before advancing the clean request prehead, the already persisted data will be cleaned up upon the next repair request or reconnection to the domain.
- Alphabetic
- By Inheritance
- RepairService
- HasCloseContext
- PromiseUnlessShutdownFactory
- FlagCloseable
- PerformUnlessClosing
- OnShutdownRunner
- AutoCloseable
- NamedLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new RepairService(participantId: ParticipantId, syncCrypto: SyncCryptoApiProvider, packageDependencyResolver: PackageDependencyResolver, damle: DAMLe, multiDomainEventLog: Eval[MultiDomainEventLog], syncDomainPersistentStateManager: SyncDomainPersistentStateManager, aliasManager: DomainAliasManager, parameters: ParticipantNodeParameters, threadsAvailableForWriting: PositiveInt, indexedStringStore: IndexedStringStore, isConnected: (DomainId) => Boolean, futureSupervisor: FutureSupervisor, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addContracts(domain: DomainAlias, contracts: Seq[RepairContract], ignoreAlreadyAdded: Boolean, ignoreStakeholderCheck: Boolean, hostedParties: Option[NonEmpty[Set[LfPartyId]]], workflowIdPrefix: Option[String] = None)(implicit traceContext: TraceContext): Either[String, Unit]
Participant repair utility for manually adding contracts to a domain in an offline fashion.
Participant repair utility for manually adding contracts to a domain in an offline fashion.
- domain
alias of domain to add contracts to. The domain needs to be configured, but disconnected to prevent race conditions.
- contracts
contracts to add. Relevant pieces of each contract: create-arguments (LfContractInst), template-id (LfContractInst), contractId, ledgerCreateTime, salt (to be added to SerializableContract), and witnesses, SerializableContract.metadata is only validated, but otherwise ignored as stakeholder and signatories can be recomputed from contracts.
- ignoreAlreadyAdded
whether to ignore and skip over contracts already added/present in the domain. Setting this to true (at least on retries) enables writing idempotent repair scripts.
- ignoreStakeholderCheck
do not check for stakeholder presence for the given parties
- workflowIdPrefix
If present, each transaction generated for added contracts will have a workflow ID whose prefix is the one set and the suffix is a sequential number and the number of transactions generated as part of the addition (e.g.
import-foo-1-2,import-foo-2-2)
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def awaitCleanHeadForTimestamp(domainId: DomainId, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]
Allows to wait until clean head has progressed up to a certain timestamp
- def cancelShutdownTask(token: Long): Unit
Removes a shutdown task from the list using a token returned by runOnShutdown
Removes a shutdown task from the list using a token returned by runOnShutdown
- Definition Classes
- OnShutdownRunner
- def changeDomain(contractIds: Seq[LfContractId], sourceDomainId: DomainId, targetDomainId: DomainId, skipInactive: Boolean, batchSize: PositiveInt)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
Change the association of a contract from one domain to another
Change the association of a contract from one domain to another
This function here allows us to manually insert a transfer out / in into the respective journals in order to move a contract from one domain to another. The procedure will result in a consistent state if and only if all the counter parties run the same command. Failure to do so, will results in participants reporting errors and possibly break.
- skipInactive
if true, then the migration will skip contracts in the contractId list that are inactive
- def changeDomainAwait(contractIds: Seq[LfContractId], sourceDomain: DomainAlias, targetDomain: DomainAlias, skipInactive: Boolean, batchSize: PositiveInt)(implicit traceContext: TraceContext): Either[String, Unit]
Participant repair utility for manually moving contracts from a source domain to a target domain in an offline fashion.
Participant repair utility for manually moving contracts from a source domain to a target domain in an offline fashion.
- contractIds
ids of contracts to move that reside in the sourceDomain
- sourceDomain
alias of source domain from which to move contracts
- targetDomain
alias of target domain to which to move contracts
- skipInactive
whether to only move contracts that are active in the source domain
- batchSize
how big the batches should be used during the migration
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def close(): Unit
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
- Definition Classes
- FlagCloseable → OnShutdownRunner → AutoCloseable
- implicit val closeContext: CloseContext
- Definition Classes
- HasCloseContext
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable → PerformUnlessClosing
- def containsShutdownTask(token: Long): Boolean
- Definition Classes
- OnShutdownRunner
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def ignoreEvents(domain: DomainId, from: SequencerCounter, to: SequencerCounter, force: Boolean)(implicit traceContext: TraceContext): Either[String, Unit]
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def isClosing: Boolean
Check whether we're closing.
Check whether we're closing. Susceptible to race conditions; unless you're using using this as a flag to the retry lib or you really know what you're doing, prefer
performUnlessClosingand friends.- Definition Classes
- OnShutdownRunner
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def keepTrackOfOpenFutures: Boolean
track running futures on shutdown
track running futures on shutdown
set to true to get detailed information about all futures that did not complete during shutdown. if set to false, we don't do anything.
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- RepairService → NamedLogging
- def maxSleepMillis: Long
How often to poll to check that all tasks have completed.
How often to poll to check that all tasks have completed.
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext, ec: ExecutionContext): PromiseUnlessShutdown[A]
Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.
Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.
Note: you should *not* invoke
successon the returned promise but rather usetrySuccess. The reason is that the call tosuccessmay fail in case of shutdown.- Definition Classes
- PromiseUnlessShutdownFactory
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def onClosed(): Unit
- Attributes
- protected
- Definition Classes
- RepairService → PerformUnlessClosing
- final def onFirstClose(): Unit
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
- Definition Classes
- PerformUnlessClosing → OnShutdownRunner
- Annotations
- @SuppressWarnings()
- def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
funless a shutdown has been initiated.Performs the task given by
funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, if started using this function, or one of the other variants (performUnlessClosingF and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.DO NOT CALL
this.closeas part off, because it will result in a deadlock.- f
The task to perform
- returns
scala.None$ if a shutdown has been initiated. Otherwise the result of the task.
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingCheckedT[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[Future, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[Future, A, N, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherT[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]
Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, but other tasks may execute concurrently withetf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingF). The tasks are assumed to take less than closingTimeout to complete.DO NOT CALL
this.closeas part ofetf, because it will result in a deadlock.- etf
The task to perform
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherTF[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
funless a shutdown has been initiated.Performs the Future given by
funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.DO NOT CALL
this.closeas part off, because it will result in a deadlock.- f
The task to perform
- returns
The future completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if a shutdown has been initiated. Otherwise the result of the task wrapped in com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome.
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
- Definition Classes
- PerformUnlessClosing
- def purgeContracts(domain: DomainAlias, contractIds: NonEmpty[Seq[LfContractId]], offboardedParties: Option[NonEmpty[Set[LfPartyId]]], ignoreAlreadyPurged: Boolean)(implicit traceContext: TraceContext): Either[String, Unit]
Participant repair utility for manually purging (archiving) contracts in an offline fashion.
Participant repair utility for manually purging (archiving) contracts in an offline fashion.
- domain
alias of domain to purge contracts from. The domain needs to be configured, but disconnected to prevent race conditions.
- contractIds
lf contract ids of contracts to purge
- ignoreAlreadyPurged
whether to ignore already purged contracts.
- def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long
Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask
Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask
- Definition Classes
- OnShutdownRunner
- def runOnShutdown_[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit
Register a task to run when shutdown is initiated.
Register a task to run when shutdown is initiated.
You can use this for example to register tasks that cancel long-running computations, whose termination you can then wait for in "closeAsync".
- Definition Classes
- OnShutdownRunner
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- OnShutdownRunner
- Annotations
- @VisibleForTesting()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- RepairService → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unignoreEvents(domain: DomainId, from: SequencerCounter, to: SequencerCounter, force: Boolean)(implicit traceContext: TraceContext): Either[String, Unit]
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])