fix(user): bound avatar queries and preserve profile response contracts

[cesar-carlos]

Description

POST /user/avatar could wait for WhatsApp's default IQ timeout, and the previous eight-second timeout started only after session preparation and LID lookup. This change shares an eight-second budget across startup database work, authenticated client readiness (up to two seconds), LID resolution, and the profile-picture IQ, while propagating HTTP cancellation.

Phone and LID targets are canonicalized before the raw IQ. The authenticated instance owns both the client and the LID store; an unavailable mapping keeps the original LID, while timeout/cancellation stops the query. Preview/full selection is preserved, ExistingID stays empty, and no application-level IQ retry or image download is added.

The review also fixes a panic when binding JSON null, validates input before starting a session, preserves timeout causes, and rejects nil pictures, empty URLs, or success arriving after cancellation. Public error messages avoid exposing internal storage/session details. Invalid input, authentication failures, rate limits, and timeouts return 400, 401, 429, and 504 respectively; unavailable/hidden photos and other failures retain 500.

The success response keeps message and the existing lowercase url, id, type, direct_path, and hash fields (hash is base64 or null). Typed response DTOs make Swagger match that JSON contract. The avatar wiki, API-key header, error documentation, and generated Swagger were updated; the Makefile uses the pinned Swagger generator with dependency/internal parsing and propagates generation failures.

Client lookup/readiness uses a synchronized service-owned index with identity-aware cleanup, so a departing worker cannot remove its replacement. The launched session remains service-owned after an HTTP query ends. This protects query-side lookup; existing legacy client-map APIs outside that path are unchanged.

Related Issue

Closes #76

Related: #121 adds PictureURL to /user/info; this PR remains focused on avatar queries and does not add that feature.

Type of Change

• Bug fix
• Documentation update

Testing

Validated in Docker with Go 1.25.0, CGO enabled, and the project's pinned dependencies, both on this PR branch and after integration into local main:

• make swagger (swag v1.16.3)
• go build ./...
• go vet ./...
• go test -timeout 5m ./...
• go test -race -timeout 5m ./...
• git diff --check

Regression tests cover shared deadlines/cancellation, startup SQL cancellation, canonical PN/LID/group targets, missing/failing LID mappings, preview/full parameters, nil/empty pictures, late success, error causes, concurrent client lookup/cleanup, authentication and instance isolation through the real middleware, malformed/null requests, and exact success JSON including base64/null hashes.

Against the previous PR head (346a07f), the new HTTP regression cases reproduced the JSON-null panic and disclosure of a fake database credential in an internal-error response. Both pass with these corrections. Tests use fakes and SQL mocks; no live WhatsApp calls, real credentials, licenses, or production databases were used. No new live-response latency claim is made.

Checklist

• Existing public success contract preserved
• Changed Go files formatted and final diff reviewed
• Tests and documentation updated
• No incidental dependency updates

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Canonicalizes user JIDs before requesting profile picture info to avoid IQ timeouts and improves error logging for avatar retrieval failures.

Sequence diagram for canonical JID in avatar lookup

sequenceDiagram
  actor User
  participant ApiServer
  participant userService
  participant utils
  participant whatsappClient

  User->>ApiServer: POST /user/avatar
  ApiServer->>userService: GetAvatar(data, instance)
  userService->>userService: ParseJID(data.Phone)
  userService->>utils: CanonicalJID(jid)
  utils-->>userService: canonicalJID
  userService->>userService: ToNonAD(canonicalJID)
  userService->>whatsappClient: GetProfilePictureInfo(jid, preview)
  alt IQ succeeds
    whatsappClient-->>userService: pic
    userService-->>ApiServer: avatar URL
    ApiServer-->>User: 200 OK
  else IQ times out
    whatsappClient-->>userService: ErrIQTimedOut
    userService->>userService: fmt.Errorf("get profile picture for jid: %w", ErrIQTimedOut)
    userService-->>ApiServer: error
    ApiServer-->>User: 500 info query timed out
  end

Loading

File-Level Changes

Change	Details	Files
Canonicalize JID before calling GetProfilePictureInfo to prevent avatar info query timeouts.	Apply utils.CanonicalJID to the parsed JID in GetAvatar to strip the leading '+' and convert to non-AD form before sending the raw IQ Add explanatory comment documenting the RAW IQ behavior and its relationship to previous typing/receipts bugs	pkg/user/service/user_service.go
Improve error handling and logging when GetProfilePictureInfo fails.	Wrap GetProfilePictureInfo errors with fmt.Errorf and %w, including the JID in the message for clearer diagnostics Retain existing error logging while returning a more descriptive wrapped error	pkg/user/service/user_service.go

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#76	Fix the /user/avatar POST endpoint so that it no longer times out with HTTP 500 "info query timed out" and instead correctly returns the avatar information.	✅

Possibly linked issues

• /user/avatar #76: PR fixes the exact /user/avatar timeout described by using canonical JID before GetProfilePictureInfo.

---

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

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="pkg/user/service/user_service.go" line_range="357-358" />
<code_context>
 	if err != nil {
 		u.loggerWrapper.GetLogger(instance.Id).LogError("[%s] GetProfilePictureInfo failed: %v", instance.Id, err)
-		return nil, err
+		return nil, fmt.Errorf("get profile picture for %s: %w", jid, err)
 	}

</code_context>
<issue_to_address>
**🚨 suggestion (security):** Revisit including the JID in the wrapped error for potential PII exposure.

Embedding the JID in the returned error introduces user-identifying data that may surface in logs or external error messages. Consider omitting or masking the JID in the error text, and if you need it for debugging, log it separately at an appropriate level while keeping the returned error generic.

```suggestion
		u.loggerWrapper.GetLogger(instance.Id).LogError("[%s] GetProfilePictureInfo failed: %v", instance.Id, err)
		return nil, fmt.Errorf("get profile picture: %w", err)
```
</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.}

[sourcery-ai]

🚨 suggestion (security): Revisit including the JID in the wrapped error for potential PII exposure.

Embedding the JID in the returned error introduces user-identifying data that may surface in logs or external error messages. Consider omitting or masking the JID in the error text, and if you need it for debugging, log it separately at an appropriate level while keeping the returned error generic.

Suggested change

	u.loggerWrapper.GetLogger(instance.Id).LogError("[%s] GetProfilePictureInfo failed: %v", instance.Id, err)
	return nil, err
	return nil, fmt.Errorf("get profile picture for %s: %w", jid, err)
	u.loggerWrapper.GetLogger(instance.Id).LogError("[%s] GetProfilePictureInfo failed: %v", instance.Id, err)
	return nil, fmt.Errorf("get profile picture: %w", err)

[cesar-carlos]

Closing from the author side: these changes are already merged into our fork main for production use.

The commits remain available on the PR branch if maintainers still want to review/merge into evolution-foundation/evolution-go. Feel free to reopen if preferred.

[cesar-carlos]

Reopened — keeping this PR available for upstream review/merge.

[cesar-carlos]

Updated after production avatar failure report (Chatwoot account enrichment):

• Cap /user/avatar at 8s (request context) so clients with 12s ReadTimeout get 504 instead of hanging
• Map WhatsApp rate-overlimit → HTTP 429
• Keep canonical-JID fix for the original ~75s info query timed out (/user/avatar #76)

Please re-review the new commit on this branch.

[cesar-carlos]

Follow-up improvements from review:

• Resolve @lid → PN via LID store before profile picture IQ (when mapping exists)
• Replace fixed Sleep(2s) after StartInstance with context-aware ready poll
• Map context.Canceled → HTTP 504