Skip to content

fix(common/countdown): stabilize reset timing assertions#2120

Open
gzliudan wants to merge 1 commit intoXinFinOrg:dev-upgradefrom
gzliudan:fix-countdown-test
Open

fix(common/countdown): stabilize reset timing assertions#2120
gzliudan wants to merge 1 commit intoXinFinOrg:dev-upgradefrom
gzliudan:fix-countdown-test

Conversation

@gzliudan
Copy link
Collaborator

@gzliudan gzliudan commented Mar 1, 2026

Proposed changes

Fix flaky countdown reset tests by performing an explicit second Reset before validating the second timeout window, and using a boundary-safe time check.

Observed failure:

--- FAIL: TestCountdownShouldReset (14.00s)
countdown_test.go:53: Correctly reset the countdown once
countdown_test.go:72: Countdown did not reset correctly second time

Types of changes

What types of changes does your code introduce to XDC network?
Put an in the boxes that apply

  • build: Changes that affect the build system or external dependencies
  • ci: Changes to CI configuration files and scripts
  • chore: Changes that don't change source code or tests
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • revert: Revert something
  • style: Changes that do not affect the meaning of the code
  • test: Adding missing tests or correcting existing tests

Impacted Components

Which parts of the codebase does this PR touch?
Put an in the boxes that apply

  • Consensus
  • Account
  • Network
  • Geth
  • Smart Contract
  • External components
  • Not sure (Please specify below)

Checklist

Put an in the boxes once you have confirmed below actions (or provide reasons on not doing so) that

  • This PR has sufficient test coverage (unit/integration test) OR I have provided reason in the PR description for not having test coverage
  • Tested on a private network from the genesis block and monitored the chain operating correctly for multiple epochs.
  • Provide an end-to-end test plan in the PR description on how to manually test it on the devnet/testnet.
  • Tested the backwards compatibility.
  • Tested with XDC nodes running this version co-exist with those running the previous version.
  • Relevant documentation has been updated as part of this PR
  • N/A

Copilot AI review requested due to automatic review settings March 1, 2026 15:41
@coderabbitai
Copy link

coderabbitai bot commented Mar 1, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c312faf2-eb83-4306-8663-0fadf557e92f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR aims to reduce flakiness in common/countdown reset-related unit tests by aligning the “second window” timing with an explicit second Reset and by making the timeout boundary check tolerant of exact-equality.

Changes:

  • Add an explicit second countdown.Reset(...) before asserting the second timeout window in the reset tests.
  • Replace time.Now().After(...) with a boundary-safe !time.Now().Before(...) comparison for the second reset assertion.
Comments suppressed due to low confidence (2)

common/countdown/countdown_test.go:74

  • These tests start a CountdownTimer goroutine that runs indefinitely and keeps spawning OnTimeoutFn goroutines every 5s. Since the test never calls StopTimer, the background timer continues after the test finishes and can accumulate blocked goroutines (the called channel has no receiver once the test returns), which can destabilize the overall test suite. Consider adding a t.Cleanup/defer to stop the timer once the assertions are complete.
	countdown.Reset(fakeI, 0, 0)
	expectedTimeAfterReset := time.Now().Add(5000 * time.Millisecond)
	<-called
	// Always initilised
	assert.True(t, countdown.isInitilised())
	if !time.Now().Before(expectedTimeAfterReset) {
		t.Log("Correctly reset the countdown second time")
	} else {
		t.Fatalf("Countdown did not reset correctly second time")
	}

common/countdown/countdown_test.go:124

  • This test also leaves the countdown goroutine running after completion. Please stop/cleanup the timer (e.g., via t.Cleanup) to avoid leaking goroutines and repeated timeout callbacks after the test returns.
	countdown.Reset(fakeI, 0, 0)
	expectedTimeAfterReset := time.Now().Add(5000 * time.Millisecond)
	<-called
	// Always initilised
	assert.True(t, countdown.isInitilised())
	if !time.Now().Before(expectedTimeAfterReset) {
		t.Log("Correctly reset the countdown second time")
	} else {
		t.Fatalf("Countdown did not reset correctly second time")
	}

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@gzliudan gzliudan force-pushed the fix-countdown-test branch 2 times, most recently from 4de0793 to 1192945 Compare March 2, 2026 02:20
@gzliudan gzliudan force-pushed the fix-countdown-test branch from 1192945 to c0b6069 Compare March 3, 2026 09:36
Fix flaky countdown reset tests by performing an explicit second Reset before validating the second timeout window, and using a boundary-safe time check.

Observed failure:

--- FAIL: TestCountdownShouldReset (14.00s)
    countdown_test.go:53: Correctly reset the countdown once
    countdown_test.go:72: Countdown did not reset correctly second time
@gzliudan gzliudan force-pushed the fix-countdown-test branch from c0b6069 to d861323 Compare March 6, 2026 08:00
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.

3 participants