[epilogue] allow arrays with @Logged types to be logged #7499
+127
−14
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
SamCarlberg
reviewed
Dec 7, 2024
| if (arrayElement.getModifiers().contains(Modifier.FINAL)) { | ||
| return m_loggableHandler.isLoggableType(componentType); | ||
| } else { | ||
| m_processingEnv |
There was a problem hiding this comment.
Note that this will cause two messages to be emitted: one for the general "not a loggable type", and this message
Comment on lines
76
to
78
| "[EPILOGUE] Excluded from logs because array " | ||
| + arrayElement | ||
| + " isn't marked as final(or is returned from a method).", |
There was a problem hiding this comment.
You could check the type of the element to be VariableElement or ExecutableElement to provide a more specific message
epilogue-processor/src/main/java/edu/wpi/first/epilogue/processor/LoggableHandler.java
Outdated
Show resolved
Hide resolved
epilogue-processor/src/main/java/edu/wpi/first/epilogue/processor/LoggableHandler.java
Outdated
Show resolved
Hide resolved
epilogue-processor/src/test/java/edu/wpi/first/epilogue/processor/AnnotationProcessorTest.java
Outdated
Show resolved
Hide resolved
Daniel1464
changed the title
|
Is there anything left for this pr? |
|
idts, @SamCarlberg just hasn't approved it yet |
SamCarlberg
requested changes
Jan 20, 2025
epilogue-processor/src/main/java/edu/wpi/first/epilogue/processor/ArrayHandler.java
Outdated
Show resolved
Hide resolved
|
|
||
| @Logged | ||
| class Example { | ||
| final SubLoggable[] x = new SubLoggable[] {}; // logged |
There was a problem hiding this comment.
Adding a test case for private final would be useful, too
Comment on lines
+111
to
+113
| logInvocation.replaceAll( | ||
| "backend\\.getNested\\(\".*\"\\)", | ||
| "backend.getNested(\"%s/\" + i)".formatted(loggedName(element))); |
There was a problem hiding this comment.
This regex replace still seems hacky, but it appears to work well enough
Co-authored-by: Sam Carlberg <[email protected]>
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.
This feature is only be restricted to final arrays; as variable-size containers would cause data to become stale and misrepresent what is being logged.