Ignore events that are not messages (like EPHEMERAL_SYNC_RESPONSE) #1732

rafwell · 2025-07-17T18:51:35Z

In some cases the body.key.id doesn't exists. That cause an error.

Look my log for debug purposes.

body.key.id is null or undefined in messages.edit. Full body object: {"key":{"remoteJid":"551199999999@s.whatsapp.net","fromMe":true},"type":"EPHEMERAL_SYNC_RESPONSE","ephemeralExpiration":7776000,"ephemeralSettingTimestamp":"1752775691","disappearingMode":{"initiator":"INITIATED_BY_ME","trigger":"ACCOUNT_SETTING","initiatedByMe":true}}

Summary by Sourcery

Add guard clauses to prevent errors from non-message events and missing body.key or key.id across ChatwootService methods

Bug Fixes:

Ignore events with types other than 'message' or 'conversation' in eventWhatsapp and messages.edit handlers to prevent unintended processing
Add checks in createConversation, messages.upsert, and messages.edit to handle null or undefined body.key and key.id, logging warnings and returning early instead of throwing errors

sourcery-ai · 2025-07-17T18:51:41Z

Reviewer's Guide

Enhances ChatwootService to gracefully handle non-message events and missing key properties by adding type-based filtering, null-checks with logging, and standardizing method calls to prevent runtime errors.

Sequence diagram for handling non-message events in eventWhatsapp

sequenceDiagram
    participant Client
    participant ChatwootService
    participant Logger
    participant waMonitor

    Client->>ChatwootService: eventWhatsapp(event, instance, body)
    alt body.type is not 'message' or 'conversation'
        ChatwootService->>Logger: verbose("Ignoring non-message event type: ...")
        ChatwootService-->>Client: return
    else body.type is 'message' or 'conversation'
        ChatwootService->>waMonitor: access waInstances
        Note over ChatwootService,waMonitor: Continue normal processing
    end

Sequence diagram for handling missing key in createConversation and messages.upsert

sequenceDiagram
    participant Client
    participant ChatwootService
    participant Logger

    Client->>ChatwootService: createConversation(instance, body)
    alt body.key is null or undefined
        ChatwootService->>Logger: warn("body.key is null or undefined in createConversation...")
        ChatwootService-->>Client: return null
    else body.key exists
        Note over ChatwootService: Continue normal processing
    end

    Client->>ChatwootService: eventWhatsapp('messages.upsert', instance, body)
    alt body.key is null or undefined
        ChatwootService->>Logger: warn("body.key is null or undefined...")
        ChatwootService-->>Client: return
    else body.key exists
        Note over ChatwootService: Continue normal processing
    end

Sequence diagram for handling messages.edit with missing key.id or non-message type

sequenceDiagram
    participant Client
    participant ChatwootService
    participant Logger

    Client->>ChatwootService: eventWhatsapp('messages.edit', instance, body)
    alt body.type is not 'message'
        ChatwootService->>Logger: verbose("Ignoring non-message event type: ...")
        ChatwootService-->>Client: return
    else body.key.id is null or undefined
        ChatwootService->>Logger: warn("body.key.id is null or undefined in messages.edit...")
        ChatwootService-->>Client: return
    else body.type is 'message' and body.key.id exists
        Note over ChatwootService: Continue normal processing
    end

File-Level Changes

Change	Details	Files
Add type-based filtering for non-message events	Filter out non-message types in eventWhatsapp handler Filter out non-message types in messages.edit handler	`src/api/integrations/chatbot/chatwoot/services/chatwoot.service.ts`
Add null-checks and logging for missing key data	Guard and log when body.key is missing in createConversation Guard and log when body.key is missing in messages.upsert and send.message handlers Guard and log when body.key.id is missing in messages.edit	`src/api/integrations/chatbot/chatwoot/services/chatwoot.service.ts`
Standardize getMessageByKeyId invocation	Replace optional-chained body?.key?.id with body.key.id for clarity	`src/api/integrations/chatbot/chatwoot/services/chatwoot.service.ts`

Possibly linked issues

#-1: The PR fixes TypeError: Cannot read properties of undefined by adding checks for body.key and body.key.id in message processing, directly addressing the issue's error type.

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.

KokeroO · 2025-09-05T00:36:14Z

src/api/integrations/chatbot/chatwoot/services/chatwoot.service.ts


  public async eventWhatsapp(event: string, instance: InstanceDto, body: any) {
    try {
+      // Ignore events that are not messages (like EPHEMERAL_SYNC_RESPONSE)


@DavidsonGomes Essa condição evita o recebimento de edição de mensagem.
Deve ser repensado esse tratamento.

KokeroO · 2025-09-05T00:36:44Z

@DavidsonGomes deve reverter esse PR.

Esse é o corpo da msg editada de exemplo:
{ "key": { "remoteJid": "554*******85@s.whatsapp.net", "fromMe": false, "id": "A5FFA0*******BBCE421DF79829F0F51", "senderLid": "65203*******15398@lid" }, "messageTimestamp": 1757030981, "pushName": "*******", "broadcast": false, "message": { "protocolMessage": { "key": { "remoteJid": "554*******49@s.whatsapp.net", "fromMe": true, "id": "A5E994DE1*******6AA465315D6B277" }, "type": "MESSAGE_EDIT", "editedMessage": { "extendedTextMessage": { "text": "Ok sim", "previewType": "NONE", "contextInfo": { "expiration": 7776000, "ephemeralSettingTimestamp": "1750341579", "disappearingMode": { "initiator": "CHANGED_IN_CHAT", "trigger": "UNKNOWN" } }, ........ }

rafwell added 4 commits July 17, 2025 15:29

Fix erro key

f8f2153

Fix erro key

e304b1d

Ignore events that are not messages

44d4781

Ignore events that are not messages

b3dae7a

fix lint

afd0e01

DavidsonGomes merged commit 5386d71 into EvolutionAPI:develop Jul 21, 2025
1 check passed

KokeroO reviewed Sep 5, 2025

View reviewed changes

DavidsonGomes mentioned this pull request Sep 8, 2025

Revert "Ignore events that are not messages (like EPHEMERAL_SYNC_RESPONSE)" #1919

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Ignore events that are not messages (like EPHEMERAL_SYNC_RESPONSE) #1732

Ignore events that are not messages (like EPHEMERAL_SYNC_RESPONSE) #1732

Uh oh!

rafwell commented Jul 17, 2025 •

edited

Loading

Uh oh!

sourcery-ai bot commented Jul 17, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

Uh oh!

KokeroO Sep 5, 2025

Uh oh!

KokeroO commented Sep 5, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Ignore events that are not messages (like EPHEMERAL_SYNC_RESPONSE) #1732

Ignore events that are not messages (like EPHEMERAL_SYNC_RESPONSE) #1732

Uh oh!

Conversation

rafwell commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Sequence diagram for handling non-message events in eventWhatsapp

Sequence diagram for handling missing key in createConversation and messages.upsert

Sequence diagram for handling messages.edit with missing key.id or non-message type

File-Level Changes

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

Uh oh!

KokeroO Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

KokeroO commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rafwell commented Jul 17, 2025 •

edited

Loading

sourcery-ai bot commented Jul 17, 2025 •

edited

Loading

KokeroO commented Sep 5, 2025 •

edited

Loading