Skip to content

feat(sqs): add support for custom base_url#2441

Merged
DavidsonGomes merged 2 commits intoEvolutionAPI:developfrom
rafaelberrocalj:feature/sqs-endpoint
Feb 24, 2026
Merged

feat(sqs): add support for custom base_url#2441
DavidsonGomes merged 2 commits intoEvolutionAPI:developfrom
rafaelberrocalj:feature/sqs-endpoint

Conversation

@rafaelberrocalj
Copy link

@rafaelberrocalj rafaelberrocalj commented Feb 24, 2026

📋 Description

This adds support for configuring a custom SQS base_url, enabling the use of LocalStack SQS in a local development environment.

🔗 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
  • 🧹 Code cleanup
  • 🔒 Security fix

🧪 Testing

  • Manual testing completed
  • Functionality verified in development environment
  • No breaking changes introduced
  • Tested with different connection types (if applicable)

📸 Screenshots (if applicable)

✅ Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have manually tested my changes thoroughly
  • I have verified the changes work with different scenarios
  • Any dependent changes have been merged and published

📝 Additional Notes

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 24, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds support for configuring a custom SQS base URL via environment/config and uses it when constructing queue URLs for event publishing.

Sequence diagram for constructing SQS URL with optional custom base_url

sequenceDiagram
    participant EventProducer
    participant SqsController
    participant ConfigService
    participant Sqs

    EventProducer->>SqsController: publishEvent(event, extra)
    SqsController->>ConfigService: getSqsConfig()
    ConfigService-->>SqsController: sqsConfig(Sqs)

    alt custom BASE_URL configured
        SqsController->>SqsController: baseUrl = sqsConfig.BASE_URL
    else no custom BASE_URL
        SqsController->>SqsController: baseUrl = https://sqs.REGION.amazonaws.com
    end

    SqsController->>SqsController: queueName = prefix_eventFormatted.fifo
    SqsController->>SqsController: sqsUrl = baseUrl/ACCOUNT_ID/queueName
    SqsController-->>EventProducer: result of publish (success/error)
Loading

File-Level Changes

Change Details Files
Allow SQS queue URLs to be constructed from a configurable base URL rather than a hardcoded AWS hostname.
  • Introduce a BASE_URL field in the Sqs config type and wire it to the SQS_BASE_URL environment variable with a default empty string.
  • Update the SQS controller to compute a baseUrl from config (falling back to the previous AWS SQS hostname format) and use it to build the final sqsUrl for queues.
  • Document the new SQS_BASE_URL environment variable in the example environment configuration file.
src/api/integrations/event/sqs/sqs.controller.ts
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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

  • Consider normalizing BASE_URL (e.g., trimming any trailing slashes) before concatenation so that sqsUrl is well-formed and doesn't end up with // when a trailing slash is present in the env var.
  • You may want to treat BASE_URL as optional in the Sqs type (e.g., BASE_URL?: string) and centralize the defaulting logic in ConfigService so that consumers can assume a non-empty, fully-formed base URL.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider normalizing `BASE_URL` (e.g., trimming any trailing slashes) before concatenation so that `sqsUrl` is well-formed and doesn't end up with `//` when a trailing slash is present in the env var.
- You may want to treat `BASE_URL` as optional in the `Sqs` type (e.g., `BASE_URL?: string`) and centralize the defaulting logic in `ConfigService` so that consumers can assume a non-empty, fully-formed base URL.

## Individual Comments

### Comment 1
<location path="src/api/integrations/event/sqs/sqs.controller.ts" line_range="126-130" />
<code_context>
             : `${event.replace('.', '_').toLowerCase()}`;
         const queueName = `${prefixName}_${eventFormatted}.fifo`;
-        const sqsUrl = `https://sqs.${sqsConfig.REGION}.amazonaws.com/${sqsConfig.ACCOUNT_ID}/${queueName}`;
+        const baseUrl = sqsConfig.BASE_URL || `https://sqs.${sqsConfig.REGION}.amazonaws.com`;
+        const sqsUrl = `${baseUrl}/${sqsConfig.ACCOUNT_ID}/${queueName}`;

         const message = {
</code_context>
<issue_to_address>
**suggestion:** Handle potential trailing slashes in `BASE_URL` to avoid double slashes in the final SQS URL.

If `SQS_BASE_URL` includes a trailing slash (e.g. `https://sqs.us-east-1.amazonaws.com/`), `sqsUrl` will end up with a double slash before the account id. Please normalize `baseUrl` first (e.g. strip a trailing `/` or use a helper to safely join URL segments) before building `sqsUrl`.

```suggestion
            ? 'singlequeue'
            : `${event.replace('.', '_').toLowerCase()}`;
        const queueName = `${prefixName}_${eventFormatted}.fifo`;
        const rawBaseUrl =
          sqsConfig.BASE_URL || `https://sqs.${sqsConfig.REGION}.amazonaws.com`;
        const baseUrl = rawBaseUrl.replace(/\/+$/, '');
        const sqsUrl = `${baseUrl}/${sqsConfig.ACCOUNT_ID}/${queueName}`;
```
</issue_to_address>

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.

@DavidsonGomes DavidsonGomes changed the base branch from main to develop February 24, 2026 15:16
@DavidsonGomes DavidsonGomes merged commit 138ff23 into EvolutionAPI:develop Feb 24, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants