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

[OTE-846] Bazooka sequential clear #2423

Merged
merged 3 commits into from
Oct 1, 2024
Merged

Conversation

jerryfan01234
Copy link
Contributor

@jerryfan01234 jerryfan01234 commented Oct 1, 2024

Changelist

[Describe or list the changes made in this PR]

Test Plan

Multiple dev environments and staging were getting this error when running bazooka. Uploaded this image to env and updated bazooka. Ran bazooka successfully.

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • Bug Fixes

    • Improved the Kafka topic clearing process to prevent errors caused by concurrent execution.
    • Updated logic to sequentially clear topics, enhancing reliability.
  • Documentation

    • Revised comments to clarify the rationale behind the changes made to the Kafka topic clearing method.

@jerryfan01234 jerryfan01234 requested a review from a team as a code owner October 1, 2024 20:33
Copy link

linear bot commented Oct 1, 2024

Copy link
Contributor

coderabbitai bot commented Oct 1, 2024

Walkthrough

The changes involve the clearKafkaTopics function in the indexer/services/bazooka/src/index.ts file, which now uses a sequential for...of loop instead of Promise.all to clear Kafka topics. This adjustment addresses a TypeError encountered during concurrent execution. The function's method signature remains the same, but the internal logic has been modified to ensure each topic is cleared one at a time. Comments have been updated to clarify the reasoning behind this change.

Changes

File Path Change Summary
indexer/services/bazooka/src/index.ts Modified clearKafkaTopics to use a sequential approach for clearing Kafka topics, updating comments for clarity.

Poem

In the land of code where rabbits play,
A function changed its clearing way.
One by one, the topics clear,
No more errors, let’s all cheer!
Hopping through logic, neat and bright,
Our Kafka's clean, all feels just right! 🐇✨


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
🪧 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 resolve resolve all the CodeRabbit review comments.
  • @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.

@jerryfan01234 jerryfan01234 force-pushed the bazooka_sequential_clear branch from 4b866ae to d67a95d Compare October 1, 2024 20:35
@jerryfan01234 jerryfan01234 force-pushed the bazooka_sequential_clear branch from d67a95d to aa17e0b Compare October 1, 2024 20:36
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (1)
indexer/services/bazooka/src/index.ts (1)

267-268: Clarify the Error Handling in Comments

The comments explain that concurrent calls caused a TypeError, but it's unclear why this error occurs. Providing more context or referencing any relevant issues could help future maintainers understand the root cause.

Consider updating the comment:

-// Concurrent calls to clear all topics caused the failure:
-// TypeError: Cannot destructure property 'partitions' of 'high.pop(...)' as it is undefined.
+// Concurrent calls to `clearKafkaTopic` caused a TypeError due to race conditions 
+// when accessing topic metadata. Switching to sequential calls prevents this error.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 93e44ff and aa17e0b.

📒 Files selected for processing (1)
  • indexer/services/bazooka/src/index.ts (1 hunks)

Comment on lines +271 to +276
1,
config.CLEAR_KAFKA_TOPIC_RETRY_MS,
config.CLEAR_KAFKA_TOPIC_MAX_RETRIES,
existingKafkaTopics,
topic,
);
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Inconsistency in Parameter Defaults

In the call to clearKafkaTopic, the attempt parameter is explicitly set to 1, but the function clearKafkaTopic already defaults attempt to 1. Similarly, retryMs and maxRetries default to the same values in the function signature.

You can simplify the function call by relying on the default parameter values:

 await clearKafkaTopic(
-  1,
-  config.CLEAR_KAFKA_TOPIC_RETRY_MS,
-  config.CLEAR_KAFKA_TOPIC_MAX_RETRIES,
   existingKafkaTopics,
   topic,
 );

If you need to override the defaults, ensure that the arguments are necessary.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
1,
config.CLEAR_KAFKA_TOPIC_RETRY_MS,
config.CLEAR_KAFKA_TOPIC_MAX_RETRIES,
existingKafkaTopics,
topic,
);
await clearKafkaTopic(
existingKafkaTopics,
topic,
);

Comment on lines +269 to +277
for (const topic of KAFKA_TOPICS) {
await clearKafkaTopic(
1,
config.CLEAR_KAFKA_TOPIC_RETRY_MS,
config.CLEAR_KAFKA_TOPIC_MAX_RETRIES,
existingKafkaTopics,
topic,
);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Potential Performance Impact of Sequential Topic Clearing

Changing from concurrent to sequential clearing of Kafka topics resolves the TypeError, but it may introduce performance bottlenecks, especially when dealing with a large number of topics. Consider implementing controlled concurrency to improve performance while avoiding the error.

You can use a concurrency control utility like p-limit to limit the number of concurrent operations. Here's how you might adjust the code:

+import pLimit from 'p-limit';

 async function clearKafkaTopics(
   existingKafkaTopics: string[],
 ): Promise<void> {
+  const limit = pLimit(5); // Adjust the concurrency level as appropriate
+
   // Concurrent calls to clear all topics caused the failure:
   // TypeError: Cannot destructure property 'partitions' of 'high.pop(...)' as it is undefined.
-  for (const topic of KAFKA_TOPICS) {
-    await clearKafkaTopic(
-      1,
-      config.CLEAR_KAFKA_TOPIC_RETRY_MS,
-      config.CLEAR_KAFKA_TOPIC_MAX_RETRIES,
-      existingKafkaTopics,
-      topic,
-    );
-  }
+  const clearTopicPromises = KAFKA_TOPICS.map((topic) =>
+    limit(() =>
+      clearKafkaTopic(
+        1,
+        config.CLEAR_KAFKA_TOPIC_RETRY_MS,
+        config.CLEAR_KAFKA_TOPIC_MAX_RETRIES,
+        existingKafkaTopics,
+        topic,
+      ),
+    ),
+  );
+  await Promise.all(clearTopicPromises);
 }

This approach balances performance with reliability by limiting the number of concurrent operations.

Committable suggestion was skipped due to low confidence.

@jerryfan01234 jerryfan01234 merged commit b57eb4c into main Oct 1, 2024
16 checks passed
@jerryfan01234 jerryfan01234 deleted the bazooka_sequential_clear branch October 1, 2024 21:28
@jerryfan01234
Copy link
Contributor Author

@Mergifyio backport release/indexer/v7.x

Copy link
Contributor

mergify bot commented Oct 7, 2024

backport release/indexer/v7.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Oct 7, 2024
@jerryfan01234
Copy link
Contributor Author

@Mergifyio release/indexer/v6.x

Copy link
Contributor

mergify bot commented Oct 7, 2024

release /indexer/v6.x

❌ Sorry but I didn't understand the command. Please consult the commands documentation 📚.

@jerryfan01234
Copy link
Contributor Author

https://github.com/Mergifyio backport release/indexer/v6.x

Copy link
Contributor

mergify bot commented Oct 7, 2024

backport release/indexer/v6.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Oct 7, 2024
jerryfan01234 added a commit that referenced this pull request Oct 7, 2024
jerryfan01234 added a commit that referenced this pull request Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants