fix: resolve KafkaJS subscription error

[Baalmart]

Description

The application was throwing a KafkaJSNonRetriableError with the message "Cannot subscribe to topic while consumer is running". This occurred because we were attempting to subscribe to topics after the consumer had already started running, which is not allowed by KafkaJS.

Solution:
Restructured the Kafka consumer initialization to properly sequence the operations:

1. Connect to Kafka
2. Subscribe to all topics
3. Start the consumer

This ensures all topic subscriptions are completed before the consumer begins processing messages.

Changes

• ✨ Separated topic subscription logic from message consumption
• 🔧 Consolidated consumer.run() into a single call
• 🎯 Removed nested consumer initialization
• 🚀 Implemented parallel topic subscription using Promise.all
• 📝 Maintained existing message processing logic and error handling

Testing

• Tested locally
• Tested against staging environment
• Relevant tests passed: [List test names]

Affected Services

• Which services were modified:
  • Auth Service

API Documentation Updated?

• Yes, API documentation was updated
• No, API documentation does not need updating

Summary by CodeRabbit

• Chores
  • Improved the structure and clarity of the message consumption logic for better organization.
  • Removed outdated commented-out code related to the mobile app user topic.
  • Enhanced error handling to ensure proper logging during message processing.
  • Minor formatting adjustments to comments for improved readability.

[coderabbitai]

Warning

Rate limit exceeded

@Baalmart has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 49 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 90db1f5 and cd62444.

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes in this pull request focus on restructuring the message consumption logic in the kafkaConsumer function within the kafka-consumer.js file. The implementation now separates the subscription to topics from the message processing phase, enhancing clarity. Additionally, commented-out code related to a specific topic has been removed, and minor formatting adjustments have been made to improve readability. The error handling mechanisms remain unchanged, ensuring proper logging of any processing errors.

Changes

File	Change Summary
src/auth-service/bin/jobs/kafka-consumer.js	Restructured message consumption logic, removed commented-out code, and improved comment formatting.

Possibly related PRs

• just adding more logging for field activity emailing functions #3560: Modifies kafka-consumer.js to enhance error logging within email handling functions.
• just add new icons for kafka logs #3562: Updates kafka-consumer.js by adding new icons to error logs for improved logging visibility.
• Update/kafka implementations #3753: Enhances error handling and message processing in the AirQoDataUtils class, related to message consumption.
• Update/kafka implementations #3760: Updates Kafka consumer functionality focusing on consumer group management, relevant to message consumption logic.
• Update/kafka implementations #3784: Modifies the consume_from_topic method in MessageBrokerUtils, related to the message consumption process.

Suggested reviewers

• BenjaminSsempala
• Mnoble-19

🎉 In the realm of Kafka, messages flow,
Restructured logic, making clarity grow.
With errors logged and comments bright,
Our consumer shines, a true delight!
Let's celebrate this code, so fine,
A toast to changes, all in line! 🍾

---

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:

• 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.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 11 lines in your changes missing coverage. Please review.

Project coverage is 11.77%. Comparing base (90db1f5) to head (cd62444).

Files with missing lines	Patch %	Lines
src/auth-service/bin/jobs/kafka-consumer.js	0.00%	11 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##           staging    #3832   +/-   ##
========================================
  Coverage    11.77%   11.77%           
========================================
  Files          114      114           
  Lines        15205    15205           
  Branches       274      274           
========================================
  Hits          1791     1791           
  Misses       13414    13414           

Files with missing lines	Coverage Δ
src/auth-service/bin/jobs/kafka-consumer.js	18.75% <0.00%> (ø)

[github-actions]

Auth-service changes in this PR available for preview here