Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix flaky testDisableErrorLogByDefault #2869

Merged
merged 3 commits into from
Aug 6, 2024

Conversation

GrantPSpencer
Copy link
Contributor

Issues

  • My PR addresses the following Helix issues and references them in the PR description:

#2818
testDisableErrorLogByDefault in TestStatusUpdateUtil failing intermittently

Description

  • Here are some details about my PR, including screenshots of any UI changes:
    There are 2 things at play here:
  1. TestParticipantManager's static field is setting STATEUPDATEUTIL_ERROR_PERSISTENCY_ENABLED to true. My assumption is that this code is executed early on when the JVM firsts loads these classes. This is why StatusUpdateUtil is pushing error logs to ZK in the first place
  2. Setting the static field's variable appears to not successfully propagate the changed value to the loaded class. This is why the logs are pushed to ZK despite using setFinalStatic to change the value to false. At this point I'm not sure why it fails - my very uneducated guess is that the jvm might be doing some optimization by having threads cache the variables and the change is not propagated properly. The observed behavior is that when reading the value of StatusUpdateUtil.ERROR_LOG_TO_ZK_ENABLED within TestStatusUpdateUtil will show false (set by setFinalStatic call), but the value when read within StatusUpdateUtil's publishErrorRecord will show true (original value).

I'm not sure this specific approach of having a static method to reassign the static variable is the best practice. Maybe it is better to modify StatusUpdateUtil so that it has a local variable taht can be set by its constructor, or that defaults to the system property value if no value provided.

Tests

  • The following tests are written for this issue:

testDisableErrorLogByDefault

  • The following is the result of the "mvn test" command on the appropriate module:

(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)

Commits

  • My commits all reference appropriate Apache Helix GitHub issues in their subject lines. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Code Quality

  • My diff has been formatted using helix-style.xml
    (helix-style-intellij.xml if IntelliJ IDE is used)

@@ -555,9 +564,10 @@ void publishStatusUpdateRecord(ZNRecord record, Message message, Level level,
*/
void publishErrorRecord(ZNRecord record, String instanceName, String updateSubPath,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of using this approach to define param, let's do this:

create a new function:

void publishErrorRecord(ZNRecord record, String instanceName, String updateSubPath,String updateKey, String sessionId, HelixDataAccessor accessor, boolean isController, boolean logToZK);

Put all existing logic in this one and leverage this boolean flag to check.

For the old API, you can call this by passing
ERROR_LOG_TO_ZK_ENABLED

Copy link
Contributor

@junkaixue junkaixue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good job!

@GrantPSpencer
Copy link
Contributor Author

Pull request approved @junkaixue
Commit message: Fix flaky testDisableErrorLogByDefault, update StatusUpdateUtil

@junkaixue junkaixue merged commit bb29cec into apache:master Aug 6, 2024
2 checks passed
htin1 pushed a commit to htin1/helix that referenced this pull request Aug 23, 2024
Fix flaky testDisableErrorLogByDefault, update StatusUpdateUtil
htin1 pushed a commit to htin1/helix that referenced this pull request Aug 29, 2024
Fix flaky testDisableErrorLogByDefault, update StatusUpdateUtil
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants