chore: improves code readability of e2e benchmark tests

[staheri14]

Closes #3669

[staheri14]

Markdown linter is complaining about

  ERROR: 1 dead links found!
  [✖] https://github.com/celestiaorg/go-square/tree/main/shares

which should be resolved by #3668

[coderabbitai]

Walkthrough

Walkthrough

The updates improve code readability in end-to-end benchmark tests. Changes include refining logic for size checking in BenchmarkTest and updating log statements in throughput.go for better output readability by switching logger.Printf to logger.Println.

Changes

Files	Change Summaries
test/e2e/benchmark/benchmark.go	Updated BenchmarkTest to check maxBlockSize for reaching target size instead of current block size.
test/e2e/benchmark/throughput.go	Updated TwoNodeSimple and runBenchmarkTest to use logger.Println for logging.

Sequence Diagram(s)

The generation of the sequence diagrams is not applicable for these changes as they are primarily focused on logic refinements and logging updates.

Assessment against linked issues

Objective (Issue #3669)	Addressed	Explanation
Improve code readability of the e2e benchmark tests	✅
Address comments from #3612 related to code readability (https://...7098)	✅
Address comments from #3612 related to code readability (https://...6690)	✅

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 34cd4b3 and 810bf33.

Files selected for processing (2)

• test/e2e/benchmark/benchmark.go (1 hunks)
• test/e2e/benchmark/throughput.go (2 hunks)

Files skipped from review due to trivial changes (2)

• test/e2e/benchmark/benchmark.go
• test/e2e/benchmark/throughput.go

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[cmwaters]

I feel this is kind of needless but I'm also happy to merge it.

If you wanted to simplify things, you could put:

if size >= expectedBlockSizeBytes {
	return nil
}

Then you also wouldn't need the if statement at the end and the targetSizeReached variable