Introduce SaveableListener#onDeleted
#9743
Open
+77
−18
Conversation
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
Usually `Saveable` objects are written, but it can happen on occasion that they get deleted, and it wasn't generating an event for every case. This provides a more fine-grained event that can be handled by implemented listeners. In my case, I have a use case in CloudBees CI where I need to clear a cache entry when a Saveable gets deleted from disk.
jglick
reviewed
Sep 17, 2024
| Logger.getLogger(SaveableListener.class.getName()).log(Level.WARNING, null, t); | ||
| } | ||
| } | ||
| Listeners.notify(SaveableListener.class, false, l -> l.onChange(o, file)); |
There was a problem hiding this comment.
Note that the false is crucial here for things like auditing.
jglick
reviewed
Sep 17, 2024
| @@ -556,7 +556,7 @@ public void delete() throws IOException { | |||
| loggers.forEach(Target::disable); | |||
|
|
|||
| getParent().getRecorders().forEach(logRecorder -> logRecorder.getLoggers().forEach(Target::enable)); | |||
| SaveableListener.fireOnChange(this, getConfigFile()); | |||
| SaveableListener.fireOnDeleted(this, getConfigFile()); | |||
There was a problem hiding this comment.
Incompatible, I guess, but unlikely to be a problem?
There was a problem hiding this comment.
Yes, I guess it is unlikely enough.
jglick
reviewed
Sep 17, 2024
| @@ -815,6 +815,7 @@ public void delete() throws IOException, InterruptedException { | |||
| ItemDeletion.deregister(this); | |||
| } | |||
| } | |||
| SaveableListener.fireOnDeleted(this, getConfigFile()); | |||
There was a problem hiding this comment.
A related oddity FTR: #9304 (comment)
jglick
approved these changes
Sep 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Usually
Saveableobjects are written, but it can happen on occasion that they get deleted, and it wasn't generating an event for every case.This provides a more fine-grained event that can be handled by implemented listeners.
In my case, I have a use case in CloudBees CI where I need to clear a cache entry when a
Saveablegets deleted from disk.See JENKINS-XXXXX.
Testing done
Proposed changelog entries
SaveableListener#onDeletedcan be implemented by plugins to be notified aboutSaveabledeletion.Proposed upgrade guidelines
N/A
Submitter checklist
Desired reviewers
@mention
Before the changes are marked as
ready-for-merge:Maintainer checklist