SetPresence

[brunobeise]

Description

Related Issue

Closes #(issue_number)

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Refactoring (no functional changes)
• Performance improvement

Testing

• Manual testing completed
• Functionality verified in development environment
• No breaking changes introduced

Screenshots (if applicable)

Checklist

• My code follows the project's style guidelines
• I have performed a self-review of my code
• I have tested my changes thoroughly
• Any dependent changes have been merged and published

Additional Notes

Summary by Sourcery

Add support for managing WhatsApp presence state via the API and fix message editing compatibility with previously sent messages.

New Features:

• Expose an HTTP endpoint to set an instance's presence state to available or unavailable without disconnecting the session.

Bug Fixes:

• Adjust message editing to use ExtendedTextMessage so edits are applied correctly to messages originally sent as extended text.

Enhancements:

• Extend the instance service and handler interfaces to support presence management and wire the new presence route into the API router.

[sourcery-ai]

Reviewer's Guide

Adds a new presence management capability for WhatsApp instances via an HTTP endpoint and fixes message editing to use the same message type as original sends so edits are honored by WhatsApp.

Sequence diagram for the new /instance/presence HTTP endpoint

sequenceDiagram
    actor ApiClient
    participant GinRouter
    participant InstanceHandler
    participant InstanceService
    participant WhatsmeowClient
    participant Logger

    ApiClient->>GinRouter: POST /instance/presence { state }
    GinRouter->>InstanceHandler: SetPresence(ctx)
    InstanceHandler->>InstanceHandler: ctx.MustGet(instance)
    InstanceHandler->>InstanceHandler: ctx.ShouldBindJSON(SetPresenceStruct)
    InstanceHandler->>InstanceService: SetPresence(data, instance)

    InstanceService->>InstanceService: ensureClientConnected(instance.Id)
    InstanceService->>WhatsmeowClient: IsConnected()
    InstanceService->>WhatsmeowClient: IsLoggedIn()
    InstanceService->>WhatsmeowClient: SendPresence(state)
    WhatsmeowClient-->>InstanceService: result

    InstanceService->>Logger: LogInfo("Presence set to state")
    InstanceService-->>InstanceHandler: nil
    InstanceHandler-->>ApiClient: 200 { message: success, state }

Loading

File-Level Changes

Change	Details	Files
Expose WhatsApp presence control as a service method and HTTP endpoint.	Extend InstanceService interface with a SetPresence method that accepts a state payload. Introduce SetPresenceStruct to validate incoming presence state as required JSON field. Implement instances.SetPresence to ensure client is connected/logged-in, map string state to whatsmeow Presence values, send presence, and log success/failure. Add SetPresence handler that resolves the instance from context, binds/validates JSON payload, delegates to service, and returns appropriate HTTP responses. Register POST /instance/presence route to the new handler in the routes configuration.	pkg/instance/service/instance_service.go pkg/instance/handler/instance_handler.go pkg/routes/routes.go
Align EditMessage behavior with SendText by using ExtendedTextMessage instead of Conversation so edits are applied.	Change the EditMessage implementation to send a waE2E.Message with ExtendedTextMessage.Text instead of Conversation when editing messages. Preserve existing logging and error handling behavior around the SendMessage call.	pkg/message/service/message_service.go

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've found 1 issue, and left some high level feedback:

• In SetPresence, invalid presence state values currently bubble up from the service as a 500; consider classifying this as a client error (e.g., validate in the handler or inspect the error and return 400) so the API contract better reflects misuse vs server failure.
• The new SetPresence and EditMessage flows use context.Background() for WhatsApp client calls; passing a request-scoped context (e.g., derived from the gin context) would allow cancellations/timeouts to propagate correctly.
• The log message in EditMessage still says error revoking message, which is misleading for an edit operation; update the message to reflect that the edit failed.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- In `SetPresence`, invalid presence state values currently bubble up from the service as a 500; consider classifying this as a client error (e.g., validate in the handler or inspect the error and return 400) so the API contract better reflects misuse vs server failure.
- The new `SetPresence` and `EditMessage` flows use `context.Background()` for WhatsApp client calls; passing a request-scoped context (e.g., derived from the gin context) would allow cancellations/timeouts to propagate correctly.
- The log message in `EditMessage` still says `error revoking message`, which is misleading for an edit operation; update the message to reflect that the edit failed.

## Individual Comments

### Comment 1
<location path="pkg/instance/handler/instance_handler.go" line_range="237-238" />
<code_context>
+		return
+	}
+
+	if err := i.instanceService.SetPresence(&data, instance); err != nil {
+		ctx.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
+		return
+	}
</code_context>
<issue_to_address>
**🚨 issue (security):** Map validation-style errors to 4xx and avoid returning raw internal error messages to clients.

Currently any `SetPresence` error results in a 500 with `err.Error()` in the response. That causes two problems: user-input errors (e.g. invalid state) should be 4xx and are documented as 400 in Swagger, and exposing `err.Error()` may leak internal details.

It’d be better to distinguish validation vs internal errors (e.g. via sentinel errors or a small error type), then:
- return 400 with a client-facing message for invalid input/state, and
- return 500 with a generic message for unexpected/internal errors, logging the detailed error server-side instead of returning it.
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}