Use authenticated user name when creating log entries from save&restore #3876
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -22,14 +22,18 @@ | |
| import org.phoebus.applications.saveandrestore.model.Node; | ||
| import org.phoebus.applications.saveandrestore.model.RestoreResult; | ||
| import org.phoebus.applications.saveandrestore.model.Tag; | ||
| import org.phoebus.applications.saveandrestore.model.authentication.SaveAndRestoreAuthenticationScope; | ||
| import org.phoebus.applications.saveandrestore.model.event.SaveAndRestoreEventReceiver; | ||
| import org.phoebus.framework.selection.SelectionService; | ||
| import org.phoebus.framework.workbench.ApplicationService; | ||
| import org.phoebus.logbook.LogEntry; | ||
| import org.phoebus.logbook.LogbookPreferences; | ||
| import org.phoebus.security.store.SecureStore; | ||
| import org.phoebus.security.tokens.ScopedAuthenticationToken; | ||
|
|
||
| import java.util.List; | ||
| import java.util.function.Consumer; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| /** | ||
|
|
@@ -59,7 +63,7 @@ public void snapshotSaved(Node node, Consumer<String> errorHandler) { | |
| SaveSnapshotActionInfo saveSnapshotActionInfo = new SaveSnapshotActionInfo(); | ||
| saveSnapshotActionInfo.setSnapshotUniqueId(node.getUniqueId()); | ||
| saveSnapshotActionInfo.setSnapshotCreatedDate(node.getCreated()); | ||
| saveSnapshotActionInfo.setActionPerformedBy(getUser()); | ||
| saveSnapshotActionInfo.setComment(node.getDescription()); | ||
| saveSnapshotActionInfo.setSnapshotName(node.getName()); | ||
| SelectionService.getInstance().setSelection("SaveAndRestoreLogging", List.of(saveSnapshotActionInfo)); | ||
|
|
@@ -84,12 +88,25 @@ public void snapshotRestored(Node node, List<RestoreResult> failedPVs, Consumer< | |
| RestoreSnapshotActionInfo restoreSnapshotActionInfo = new RestoreSnapshotActionInfo(); | ||
| restoreSnapshotActionInfo.setSnapshotUniqueId(node.getUniqueId()); | ||
| restoreSnapshotActionInfo.setSnapshotCreatedDate(node.getCreated()); | ||
| restoreSnapshotActionInfo.setActionPerformedBy(getUser()); | ||
| restoreSnapshotActionInfo.setComment(node.getDescription()); | ||
| restoreSnapshotActionInfo.setGolden(node.hasTag(Tag.GOLDEN)); | ||
| restoreSnapshotActionInfo.setSnapshotName(node.getName()); | ||
| restoreSnapshotActionInfo.setFailedPVs(failedPVs.stream().map(restoreResult -> restoreResult.getSnapshotItem().getConfigPv().getPvName()).toList()); | ||
| SelectionService.getInstance().setSelection("SaveAndRestoreLogging", List.of(restoreSnapshotActionInfo)); | ||
| Platform.runLater(() -> ApplicationService.createInstance("logbook")); | ||
| } | ||
|
|
||
| private String getUser(){ | ||
| try { | ||
| SecureStore store = new SecureStore(); | ||
| ScopedAuthenticationToken scopedAuthenticationToken = store.getScopedAuthenticationToken(new SaveAndRestoreAuthenticationScope()); | ||
| if (scopedAuthenticationToken != null) { | ||
| return scopedAuthenticationToken.getUsername(); | ||
| } | ||
| } catch (Exception e){ | ||
| logger.log(Level.WARNING, "Unable to get Authentication Token.", e); | ||
| } | ||
| return "<Not Available>"; | ||
|
Collaborator
There was a problem hiding this comment. If the retrieval of the authentication token is not successful, shouldn't that be an error, and the log message should not be written? @georgweiss @kasemir I am not familiar with the way authentication is handled; could you provide your input?
Collaborator
There was a problem hiding this comment. In this case an error dialog would be a bit confusing in the context of the workflow as it is not obvious why it is shown. Moreover, the exception would be a corner case as logging of an action is relevant only when a user has been signed-in. |
||
| } | ||
| } | ||
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this line also have an additional check for
null(analogous to the one added on the preceding line) oflogEntry.getSource()?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually there is no need for a null check.