Skip to content

fn: fix flake in TestPropForEachConcOutperformsMapWhenExpensive #9659

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fn: fix flake in TestPropForEachConcOutperformsMapWhenExpensive #9659

wants to merge 2 commits into from

Conversation

Abdulkbk
Copy link
Contributor

@Abdulkbk Abdulkbk commented Mar 31, 2025 •
edited
Loading

Fixes #9578 and #9510

Change Description

As mentioned in the comment:

The test TestPropForEachConcOutperformsMapWhenExpensive compares the speed of Map and ForEachConc functions when executing an expensive operation on a slice. In this case, the expensive operation is time.Sleep(time.Millisecond).
Since the Map function operates sequentially, we expect ForEachConc to always complete first because it runs concurrently.
However ForEachConc has some overheads including creating and managing goroutines, semaphore acquisition & release, and waitgroup operations (which I think are non-deterministic).

The non-deterministic nature of ForEachConc, along with its overhead, can cause the Map function to sometimes finish executing before it, which results in CI failures.

This PR replaces the flaky test, comparing two functions, Map and ForEachConc, under expensive operations, with a benchmark.

Steps to Test

cd fn && go test -bench=BenchmarkMapVsForEachConc

Pull Request Checklist

Testing

  • Your PR passes all CI checks.
  • Tests covering the positive and negative (error paths) are included.
  • Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

📝 Please see our Contribution Guidelines for further guidance.

Abdulkbk added 2 commits March 31, 2025 21:17
@Abdulkbk
fn: add benchmark for Map and ForEachConc fns
63e156b
@Abdulkbk
fn: remove flaky test
cb19c19 
In this commit, we remove TestPropForEachConcOutperformsMapWhenExpensive
as it's flaky and causes the CI to fail. The previous commit intro-
duced a replacement, which benchmarked the functions.
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 31, 2025

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • llm-review

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.

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

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@Abdulkbk Abdulkbk changed the title Replace a flaky test with a benchmark fn: fix flaky test with a benchmark Apr 1, 2025
@Abdulkbk Abdulkbk mentioned this pull request Apr 1, 2025
Open
@Abdulkbk Abdulkbk changed the title fn: fix flaky test with a benchmark fn: fix flake in TestPropForEachConcOutperformsMapWhenExpensive Apr 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[bug]: fn/v2: test flake in TestPropForEachConcOutperformsMapWhenExpensive
1 participant
@Abdulkbk