-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #313 from VEuPathDB/issue-304
Logging improvements around plugin executions.
- Loading branch information
Showing
12 changed files
with
839 additions
and
211 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
128 changes: 128 additions & 0 deletions
128
lib/plugin-client/src/main/kotlin/vdi/component/plugin/client/PluginException.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| package vdi.component.plugin.client | ||
|
|
||
| import org.slf4j.Logger | ||
| import org.veupathdb.vdi.lib.common.field.DatasetID | ||
| import org.veupathdb.vdi.lib.common.field.ProjectID | ||
| import org.veupathdb.vdi.lib.common.field.UserID | ||
|
|
||
| open class PluginException : Exception { | ||
| val action: String | ||
| val plugin: String | ||
| val projectID: ProjectID | ||
| val userID: UserID | ||
| val datasetID: DatasetID | ||
|
|
||
| override val message: String | ||
| get() = super.message!! | ||
|
|
||
| protected constructor( | ||
| action: String, | ||
| plugin: String, | ||
| projectID: ProjectID, | ||
| userID: UserID, | ||
| datasetID: DatasetID, | ||
| message: String, | ||
| ) : super(message) { | ||
| this.action = action | ||
| this.plugin = plugin | ||
| this.projectID = projectID | ||
| this.userID = userID | ||
| this.datasetID = datasetID | ||
| } | ||
|
|
||
| protected constructor( | ||
| action: String, | ||
| plugin: String, | ||
| projectID: ProjectID, | ||
| userID: UserID, | ||
| datasetID: DatasetID, | ||
| message: String, | ||
| cause: Throwable, | ||
| ) : super(message, cause) { | ||
| this.action = action | ||
| this.plugin = plugin | ||
| this.projectID = projectID | ||
| this.userID = userID | ||
| this.datasetID = datasetID | ||
| } | ||
|
|
||
| fun log(logFn: (String, Throwable) -> Unit) { | ||
| logFn(message, this) | ||
| } | ||
|
|
||
| companion object { | ||
| @JvmStatic | ||
| fun import( | ||
| plugin: String, | ||
| userID: UserID, | ||
| datasetID: DatasetID, | ||
| message: String? = null, | ||
| cause: Throwable? = null, | ||
| ) = new("import", plugin, "N/A", userID, datasetID, message, cause) | ||
|
|
||
| @JvmStatic | ||
| fun installData( | ||
| plugin: String, | ||
| projectID: ProjectID, | ||
| userID: UserID, | ||
| datasetID: DatasetID, | ||
| message: String? = null, | ||
| cause: Throwable? = null, | ||
| ) = new("install-data", plugin, projectID, userID, datasetID, message, cause) | ||
|
|
||
| @JvmStatic | ||
| fun installMeta( | ||
| plugin: String, | ||
| projectID: ProjectID, | ||
| userID: UserID, | ||
| datasetID: DatasetID, | ||
| message: String? = null, | ||
| cause: Throwable? = null, | ||
| ) = new("install-meta", plugin, projectID, userID, datasetID, message, cause) | ||
|
|
||
| @JvmStatic | ||
| fun uninstall( | ||
| plugin: String, | ||
| projectID: ProjectID, | ||
| userID: UserID, | ||
| datasetID: DatasetID, | ||
| message: String? = null, | ||
| cause: Throwable? = null, | ||
| ) = new("uninstall", plugin, projectID, userID, datasetID, message, cause) | ||
|
|
||
| private fun new( | ||
| action: String, | ||
| plugin: String, | ||
| projectID: ProjectID, | ||
| userID: UserID, | ||
| datasetID: DatasetID, | ||
| message: String?, | ||
| cause: Throwable?, | ||
| ) = | ||
| makeMessage(action, plugin, projectID, userID, datasetID, message, cause) | ||
| .let { | ||
| if (cause == null) | ||
| PluginException(action, plugin, projectID, userID, datasetID, it) | ||
| else | ||
| PluginException(action, plugin, projectID, userID, datasetID, it, cause) | ||
| } | ||
|
|
||
| private fun makeMessage( | ||
| action: String, | ||
| plugin: String, | ||
| projectID: ProjectID, | ||
| userID: UserID, | ||
| datasetID: DatasetID, | ||
| message: String? = null, | ||
| cause: Throwable? = null, | ||
| ) = | ||
| "$action failed for dataset $userID/$datasetID in plugin $plugin targeting $projectID" + | ||
| if (message != null) | ||
| ": $message" | ||
| else if (cause != null) | ||
| ": ${cause.message}" | ||
| else | ||
| " for unknown reasons" | ||
| } | ||
| } | ||
|
|
Oops, something went wrong.