android-sms-gateway icon indicating copy to clipboard operation
android-sms-gateway copied to clipboard

[messages] add some logging to the worker

Open capcom6 opened this issue 11 months ago โ€ข 1 comments

capcom6 avatar Mar 12 '25 12:03 capcom6

๐Ÿค– Pull request artifacts

file commit
app-release.apk 1ba3dcfd3096541542a9090ba8e6f8c25b154396
app-release.aab 1ba3dcfd3096541542a9090ba8e6f8c25b154396
app-insecure.apk 1ba3dcfd3096541542a9090ba8e6f8c25b154396
app-insecure.aab 1ba3dcfd3096541542a9090ba8e6f8c25b154396

github-actions[bot] avatar Mar 12 '25 12:03 github-actions[bot]

Walkthrough

Adds a LogsService dependency to SendMessagesWorker and instruments the worker with DEBUG and ERROR LogEntry calls around start, completion, and exception handling; preserves the single call to messagesSvc.sendPendingMessages() and returns Result.success() or Result.retry(); no public API changes.

Changes

Cohort / File(s) Summary of changes
SendMessagesWorker โ€” logging instrumentation
app/src/main/java/me/capcom/smsgateway/modules/messages/workers/SendMessagesWorker.kt
- Injected LogsService and added private logsService field
- Added LogEntry-based DEBUG logs for worker start and successful completion
- Added LogEntry-based ERROR log on exception with the exception message
- Retained single messagesSvc.sendPendingMessages() call in doWork() and preserved Result.success() / Result.retry() behavior
- Added imports for LogsService and LogEntry

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant WM as WorkManager
  participant W as SendMessagesWorker
  participant MS as MessagesService
  participant LS as LogsService

  WM->>W: startWork()
  W->>LS: log(DEBUG: "Worker started")
  W->>MS: sendPendingMessages()
  alt success (no exception)
    W->>LS: log(DEBUG: "Completed successfully")
    W-->>WM: Result.success()
  else exception
    W->>LS: log(ERROR: "Failure: <err.message>")
    W-->>WM: Result.retry()
  end

Estimated code review effort

๐ŸŽฏ 3 (Moderate) | โฑ๏ธ ~20 minutes


๐Ÿ“œ Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

๐Ÿ’ก Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

๐Ÿ“ฅ Commits

Reviewing files that changed from the base of the PR and between d44224d2673bbc48a20f8a109142ddd8f3f9650b and 1ba3dcfd3096541542a9090ba8e6f8c25b154396.

๐Ÿ“’ Files selected for processing (1)
  • app/src/main/java/me/capcom/smsgateway/modules/messages/workers/SendMessagesWorker.kt (2 hunks)
๐Ÿšง Files skipped from review as they are similar to previous changes (1)
  • app/src/main/java/me/capcom/smsgateway/modules/messages/workers/SendMessagesWorker.kt
โฐ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Build release / build-apk
  • GitHub Check: Build insecure / build-apk
โœจ Finishing Touches
  • [ ] ๐Ÿ“ Generate Docstrings
๐Ÿงช Generate unit tests
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment
  • [ ] Commit unit tests in branch messages/add-worker-logging

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.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbit 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:
    • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbit or @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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

coderabbitai[bot] avatar Aug 28 '25 05:08 coderabbitai[bot]

On device...

capcom6 avatar Aug 29 '25 02:08 capcom6