Inclusão do parâmetro frame_max para compatibilidade com RabbitMQ 4.1+ by thrsouza · Pull Request #1498 · EvolutionAPI/evolution-api

thrsouza · 2025-05-25T05:48:31Z

Descrição

Este pull request atualiza a configuração da integração com o RabbitMQ para garantir compatibilidade com as versões mais recentes (4.1+).

A partir do RabbitMQ 4.1, o valor mínimo para o parâmetro frame_max foi aumentado de 4096 (4KB) para 8192 (8KB). Estávamos utilizando o valor padrão anterior de 4096, o que causava falhas de conexão com versões mais recentes do RabbitMQ.

Mudanças Implementadas

Atualização do arquivo .env.example para incluir o novo valor padrão recomendado para o parâmetro RABBITMQ_FRAME_MAX
Definição explícita do valor frame_max na criação da conexão com o RabbitMQ

Problema Resolvido

Antes desta alteração, ao tentar se conectar com servidores RabbitMQ 4.1+, a aplicação apresentava o seguinte erro nos logs:

failed to negotiate connection parameters: negotiated frame_max = 4096 is lower than the minimum allowed value (8192)

Esta modificação resolve o problema de compatibilidade, permitindo que a aplicação se conecte corretamente com servidores RabbitMQ nas versões mais recentes.

Logs Comparativos

Antes da alteração:

2025-05-25 04:37:06.500108+00:00 [info] <0.625.0> accepting AMQP connection 172.18.0.5:40676 -> 172.18.0.2:5672
2025-05-25T04:37:09.608092+00:00 error: FORMATTER CRASH: {"closing AMQP connection ~tp (~ts):~nfailed to negotiate connection parameters: ~ts",[<0.625.0>,<<"172.18.0.5:40676 -> 172.18.0.2:5672">>,"3s","negotiated frame_max = 4096 is lower than the minimum allowed value (8192)"]}

Após a alteração:

2025-05-25 05:09:59.807460+00:00 [info] <0.626.0> accepting AMQP connection 172.19.0.5:42932 -> 172.19.0.2:5672
2025-05-25 05:09:59.855587+00:00 [info] <0.626.0> connection 172.19.0.5:42932 -> 172.19.0.2:5672: user 'docker' authenticated and granted access to vhost '/'

Impacto

Esta alteração é necessária para manter a compatibilidade com as versões mais recentes do RabbitMQ e não deve causar impacto negativo em instalações existentes que utilizam RabbitMQ 4.1 ou anterior, pois o valor de 8192 é compatível com versões anteriores.

Summary by Sourcery

Ensure RabbitMQ connections negotiate a minimum frame_max of 8192 for compatibility with RabbitMQ 4.1+.

Bug Fixes:

Resolve negotiation failure by specifying frame_max >= 8192 when connecting to RabbitMQ 4.1+ servers.

Enhancements:

Introduce a FRAME_MAX configuration parameter in the env config and use it in the AMQP connection options.

Documentation:

Add RABBITMQ_FRAME_MAX to .env.example with a default of 8192.

sourcery-ai · 2025-05-25T05:48:35Z

Reviewer's Guide

Introduces explicit support for the RabbitMQ frame_max parameter (defaulting to 8192) by exposing it in the configuration, updating environment examples, and supplying it in the connection options to maintain compatibility with RabbitMQ 3.11+.

Sequence Diagram: RabbitMQ Connection with `frame_max` Parameter

sequenceDiagram
    participant Controller as RabbitmqController
    participant CfgSvc as ConfigService
    participant AMQPLib as amqp_library
    participant RMQServer as RabbitMQ Server

    Controller->>CfgSvc: Get RabbitMQ config (including FRAME_MAX)
    CfgSvc-->>Controller: Return Rabbitmq config object
    Controller->>AMQPLib: connect({protocol, hostname, port, username, password, vhost, frameMax: Rabbitmq.FRAME_MAX})
    AMQPLib->>RMQServer: Negotiate connection (using frameMax)
    RMQServer-->>AMQPLib: Connection response
    AMQPLib-->>Controller: Connection result

Class Diagram: Update to `Rabbitmq` Configuration Type

classDiagram
    class Rabbitmq {
        <<Type>>
        +URI: string
        +FRAME_MAX: number
        +EXCHANGE_NAME: string
        +ENABLED: boolean
        +GLOBAL_ENABLED: boolean
        +EVENTS: EventsRabbitmq
    }

    class ConfigService {
        +get(configPath: "RABBITMQ"): Rabbitmq
    }

    ConfigService ..> Rabbitmq : "constructs and provides"

Flow Diagram: `RABBITMQ_FRAME_MAX` Configuration Path

graph TD
    subgraph ApplicationSystem["Application System"]
        App["Application Code (RabbitmqController)"]
        ConfigSvc["ConfigService"]
    end

    EnvVars["Environment Variables (.env / process.env)"] -- "RABBITMQ_FRAME_MAX" --> ConfigSvc
    ConfigSvc -- "Reads FRAME_MAX and provides Rabbitmq object" --> App
    App -- "Uses FRAME_MAX in connection options" --> RMQServer["RabbitMQ Server"]

File-Level Changes

Change	Details	Files
Pass frame_max in AMQP connection options	Retrieve FRAME_MAX value from config Parse the URI into protocol, host, port, credentials, and vhost Include frameMax in the options passed to amqp.connect	`src/api/integrations/event/rabbitmq/rabbitmq.controller.ts`
Expose FRAME_MAX in application configuration	Extend Rabbitmq config type to include FRAME_MAX Default FRAME_MAX in ConfigService using env var or fallback Add RABBITMQ_FRAME_MAX entry with recommended default in .env.example	`src/config/env.config.ts` `.env.example`

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 @thrsouza - I've reviewed your changes - here's some feedback:

Instead of manually parsing the URI with new URL and rebuilding connectionOptions, you can call amqp.connect(uri, { frameMax }, callback) to let the library handle URI parsing (so you don’t accidentally drop other query params).
You’re calling configService.get('RABBITMQ') multiple times—consider destructuring the Rabbitmq config once at the top of the promise to reduce repetition and improve readability.

Here's what I looked at during the review

🟡 General issues: 3 issues found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Documentation: all looks good

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

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

sourcery-ai · 2025-05-25T05:50:40Z

src/api/integrations/event/rabbitmq/rabbitmq.controller.ts

      const rabbitmqExchangeName = configService.get<Rabbitmq>('RABBITMQ').EXCHANGE_NAME;

-      amqp.connect(uri, (error, connection) => {
+      const url = new URL(uri);


suggestion (bug_risk): Parsing the URI with new URL may throw on invalid URIs

Consider adding a try/catch around new URL(uri) or validating the URI beforehand to prevent unhandled exceptions from malformed input.

sourcery-ai · 2025-05-25T05:50:40Z

src/api/integrations/event/rabbitmq/rabbitmq.controller.ts

+      const connectionOptions = {
+        protocol: url.protocol.slice(0, -1),
+        hostname: url.hostname,
+        port: url.port || 5672,


suggestion (bug_risk): Convert url.port to a number and adjust default port per protocol

url.port is a string, and the default port should be 5671 for amqps. Use port: url.port ? Number(url.port) : (url.protocol === 'amqps:' ? 5671 : 5672) to set the correct type and default value.

Suggested change

port: url.port || 5672,

port: url.port ? Number(url.port) : (url.protocol === 'amqps:' ? 5671 : 5672),

sourcery-ai · 2025-05-25T05:50:40Z

src/api/integrations/event/rabbitmq/rabbitmq.controller.ts

+        port: url.port || 5672,
+        username: url.username || 'guest',
+        password: url.password || 'guest',
+        vhost: url.pathname.slice(1) || '/', 


suggestion (bug_risk): Decode percent-encoded vhost names

Wrap url.pathname.slice(1) with decodeURIComponent() to ensure special characters in vhost names are properly decoded.

Suggested change

vhost: url.pathname.slice(1) || '/',

vhost: decodeURIComponent(url.pathname.slice(1)) || '/',

Updates the minimum frame_max value from 4096 to 8192 to meet the requirements of RabbitMQ 4.1+ servers. This resolves connection failures with newer RabbitMQ versions while maintaining backwards compatibility with older versions.

sourcery-ai bot reviewed May 25, 2025

View reviewed changes

thrsouza changed the title ~~Inclusão do parâmetro frame_max para compatibilidade com RabbitMQ 3.11+~~ Inclusão do parâmetro frame_max para compatibilidade com RabbitMQ 4.1+ May 25, 2025

thrsouza force-pushed the main branch from 2ab1c31 to 3297364 Compare May 25, 2025 06:08

DavidsonGomes changed the base branch from main to develop May 25, 2025 14:08

DavidsonGomes merged commit 623efd8 into EvolutionAPI:develop May 25, 2025
1 check failed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Inclusão do parâmetro frame_max para compatibilidade com RabbitMQ 4.1+#1498

Inclusão do parâmetro frame_max para compatibilidade com RabbitMQ 4.1+#1498
DavidsonGomes merged 1 commit intoEvolutionAPI:developfrom
thrsouza:main

thrsouza commented May 25, 2025 •

edited

Loading

Uh oh!

sourcery-ai bot commented May 25, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

sourcery-ai bot May 25, 2025

Uh oh!

sourcery-ai bot May 25, 2025

Uh oh!

sourcery-ai bot May 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	port: url.port \|\| 5672,
	port: url.port ? Number(url.port) : (url.protocol === 'amqps:' ? 5671 : 5672),

	vhost: url.pathname.slice(1) \|\| '/',
	vhost: decodeURIComponent(url.pathname.slice(1)) \|\| '/',

Conversation

thrsouza commented May 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Descrição

Mudanças Implementadas

Problema Resolvido

Logs Comparativos

Antes da alteração:

Após a alteração:

Impacto

Summary by Sourcery

Uh oh!

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

Uh oh!

Reviewer's Guide

Sequence Diagram: RabbitMQ Connection with frame_max Parameter

Class Diagram: Update to Rabbitmq Configuration Type

Flow Diagram: RABBITMQ_FRAME_MAX Configuration Path

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot May 25, 2025

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot May 25, 2025

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot May 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

thrsouza commented May 25, 2025 •

edited

Loading

sourcery-ai bot commented May 25, 2025 •

edited

Loading

Sequence Diagram: RabbitMQ Connection with `frame_max` Parameter

Class Diagram: Update to `Rabbitmq` Configuration Type

Flow Diagram: `RABBITMQ_FRAME_MAX` Configuration Path