Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

fix(channels): support WhatsApp gateways through Docker (#22032)

Sbaaoui Idriss338817ffad2f
diff --git a/internal/channels/egress.go b/internal/channels/egress.go
index 75daff5f9b..fc313b49cc 100644
--- a/internal/channels/egress.go
+++ b/internal/channels/egress.go
@@ -330,10 +330,26 @@ func resolveAllowedLocalChannelDestination(parsed *url.URL, policy channelURLPol
return "", "", "", false
}
baseHost, err := normalizeChannelHost(base.Hostname())
- if err != nil || !isLocalChannelHost(baseHost) {
+ if err != nil {
+ return "", "", "", false
+ }
+ actualHost, err := normalizeChannelHost(parsed.Hostname())
+ if err != nil {
+ return "", "", "", false
+ }
+ var resolvedIP string
+ switch {
+ case actualHost == baseHost && isLocalChannelHost(baseHost):
+ resolvedIP, err = lookupLoopbackChannelHost(base.Hostname())
+ case baseHost == "127.0.0.1" && base.Port() == "3005" && actualHost == "host.docker.internal":
+ var privateOnly bool
+ resolvedIP, privateOnly, err = lookupChannelHost(parsed.Hostname())
+ if err == nil && !privateOnly {
+ return "", "", "", false
+ }
+ default:
return "", "", "", false
}
- resolvedIP, err := lookupLoopbackChannelHost(base.Hostname())
if err != nil {
return "", "", "", false
}
@@ -346,8 +362,7 @@ func resolveAllowedLocalChannelDestination(parsed *url.URL, policy channelURLPol
expectedScheme = "wss"
}
}
- actualHost, err := normalizeChannelHost(parsed.Hostname())
- if err != nil || !strings.EqualFold(parsed.Scheme, expectedScheme) || actualHost != baseHost || channelURLPort(parsed) != channelURLPort(base) {
+ if !strings.EqualFold(parsed.Scheme, expectedScheme) || channelURLPort(parsed) != channelURLPort(base) {
return "", "", "", false
}
return actualHost, resolvedIP, channelURLPort(parsed), true
diff --git a/internal/channels/egress_test.go b/internal/channels/egress_test.go
index 0ceb36128e..e33f7bfbd4 100644
--- a/internal/channels/egress_test.go
+++ b/internal/channels/egress_test.go
@@ -230,20 +230,42 @@ func TestOperatorAllowedChannelRejectsLinkLocalForAllSchemes(t *testing.T) {
func TestWhatsAppDefaultGatewayExceptionIsPathScoped(t *testing.T) {
t.Setenv(channelAllowedHostsEnv, "")
+ originalLookup := common.LookupHost
+ t.Cleanup(func() { common.LookupHost = originalLookup })
+ common.LookupHost = func(host string) ([]string, error) {
+ if host == "host.docker.internal" {
+ return []string{"172.17.0.1"}, nil
+ }
+ return originalLookup(host)
+ }
policy := channelURLPolicy{
localBaseURL: defaultGatewayBaseURL,
localPathPrefix: "/whatsapp/",
}
- allowed, err := url.Parse("ws://127.0.0.1:3005/whatsapp/test/events/ws")
- if err != nil {
- t.Fatal(err)
- }
- if _, _, _, err := resolveChannelDestination(allowed, policy, true); err != nil {
- t.Fatalf("default WhatsApp gateway rejected: %v", err)
+ for _, testCase := range []struct {
+ name string
+ scheme string
+ websocket bool
+ path string
+ }{
+ {name: "HTTP", scheme: "http", path: "/whatsapp/test/start"},
+ {name: "WebSocket", scheme: "ws", websocket: true, path: "/whatsapp/test/events/ws"},
+ } {
+ t.Run(testCase.name, func(t *testing.T) {
+ allowed, err := url.Parse(testCase.scheme + "://host.docker.internal:3005" + testCase.path)
+ if err != nil {
+ t.Fatal(err)
+ }
+ if _, ip, _, err := resolveChannelDestination(allowed, policy, testCase.websocket); err != nil {
+ t.Fatalf("default WhatsApp gateway rejected: %v", err)
+ } else if ip != "172.17.0.1" {
+ t.Fatalf("default WhatsApp gateway resolved to %q, want pinned host gateway IP", ip)
+ }
+ })
}
for _, path := range []string{"/admin", "/whatsapp/../admin", "/whatsapp/%2e%2e/admin", "/whatsapp/%2fadmin"} {
- disallowed, err := url.Parse("ws://127.0.0.1:3005" + path)
+ disallowed, err := url.Parse("ws://host.docker.internal:3005" + path)
if err != nil {
t.Fatal(err)
}
@@ -251,12 +273,25 @@ func TestWhatsAppDefaultGatewayExceptionIsPathScoped(t *testing.T) {
t.Errorf("default WhatsApp exception accepted unsafe path %q", path)
}
}
+
+ for _, address := range []string{"93.184.216.34", "169.254.169.254"} {
+ common.LookupHost = func(string) ([]string, error) { return []string{address}, nil }
+ gateway, err := url.Parse("http://host.docker.internal:3005/whatsapp/test/start")
+ if err != nil {
+ t.Fatal(err)
+ }
+ if _, _, _, err := resolveChannelDestination(gateway, policy, false); err == nil {
+ t.Errorf("default WhatsApp exception accepted non-private address %q", address)
+ }
+ }
}
func TestWhatsAppExplicitDefaultGatewayIsAllowed(t *testing.T) {
- channel := newWhatsAppChannel(whatsappAccount{GatewayBaseURL: defaultGatewayBaseURL})
- if !channel.allowDefaultGateway {
- t.Fatal("explicit default gateway was not recognized as the built-in local gateway")
+ for _, gatewayURL := range []string{defaultGatewayBaseURL, dockerGatewayBaseURL} {
+ channel := newWhatsAppChannel(whatsappAccount{GatewayBaseURL: gatewayURL})
+ if !channel.allowDefaultGateway {
+ t.Errorf("explicit gateway %q was not recognized as the built-in WhatsApp gateway", gatewayURL)
+ }
}
}
diff --git a/internal/channels/whatsapp-gateway/README.md b/internal/channels/whatsapp-gateway/README.md
index 78417f67af..89d0cdff0d 100644
--- a/internal/channels/whatsapp-gateway/README.md
+++ b/internal/channels/whatsapp-gateway/README.md
@@ -6,7 +6,7 @@ This directory contains a minimal WhatsApp gateway built on top of
## Install
```bash
-cd api/channels/whatsapp/gateway-node
+cd internal/channels/whatsapp-gateway
npm install
```
diff --git a/internal/channels/whatsapp.go b/internal/channels/whatsapp.go
index e7bab71687..d818ad8938 100644
--- a/internal/channels/whatsapp.go
+++ b/internal/channels/whatsapp.go
@@ -39,6 +39,7 @@ import (
const (
defaultGatewayBaseURL = "http://127.0.0.1:3005"
+ dockerGatewayBaseURL = "http://host.docker.internal:3005"
defaultTimeout = 30 * time.Second
startTimeout = 2 * time.Minute
wsHandshakeTimeout = 2 * time.Minute
@@ -101,7 +102,8 @@ var liveWhatsAppChannels sync.Map
// newWhatsAppChannel creates a WhatsApp channel instance with default runtime settings filled in.
func newWhatsAppChannel(account whatsappAccount) *whatsappChannel {
account.GatewayBaseURL = strings.TrimSpace(account.GatewayBaseURL)
- allowDefaultGateway := account.GatewayBaseURL == "" || strings.TrimRight(account.GatewayBaseURL, "/") == defaultGatewayBaseURL
+ baseURL := strings.TrimRight(account.GatewayBaseURL, "/")
+ allowDefaultGateway := baseURL == "" || baseURL == defaultGatewayBaseURL || baseURL == dockerGatewayBaseURL
if account.GatewayBaseURL == "" {
account.GatewayBaseURL = defaultGatewayBaseURL
}
diff --git a/web/src/pages/user-setting/chat-channel/constant/index.tsx b/web/src/pages/user-setting/chat-channel/constant/index.tsx
index 0134344008..87db784d92 100644
--- a/web/src/pages/user-setting/chat-channel/constant/index.tsx
+++ b/web/src/pages/user-setting/chat-channel/constant/index.tsx
@@ -690,7 +690,14 @@ export const ChatChannelFormFields: Record<ChatChannelKey, FormFieldConfig[]> =
values?.config?.credential?.connection_type !== 'websocket',
},
],
- [ChatChannelKey.WHATSAPP]: [],
+ [ChatChannelKey.WHATSAPP]: [
+ {
+ label: 'Gateway URL',
+ name: 'config.credential.gateway_base_url',
+ type: FormFieldType.Text,
+ required: true,
+ },
+ ],
[ChatChannelKey.YUANBAO]: [
{
label: 'App Key',
@@ -762,6 +769,9 @@ export const ChatChannelFormDefaultValues: Record<
// googlechat carries a non-credential discriminator (auth_mode).
ChatChannelFormDefaultValues[ChatChannelKey.GOOGLECHAT].config.auth_mode =
'webhook_url';
+ChatChannelFormDefaultValues[
+ ChatChannelKey.WHATSAPP
+].config.credential.gateway_base_url = 'http://host.docker.internal:3005';
ChatChannelFormDefaultValues[
ChatChannelKey.WECOM
].config.credential.connection_type = 'webhook';