Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions demo/pkg/subgraphs/subgraphs.go
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ func New(ctx context.Context, config *Config) (*Subgraphs, error) {

natsPubSubByProviderID := map[string]natsPubsub.Adapter{}

defaultAdapter, err := natsPubsub.NewAdapter(ctx, zap.NewNop(), url, []nats.Option{}, "hostname", "test", datasource.ProviderOpts{
defaultAdapter, err := natsPubsub.NewAdapter(ctx, zap.NewNop(), url, []nats.Option{}, "hostname", "test", false, datasource.ProviderOpts{
StreamMetricStore: rmetric.NewNoopStreamMetricStore(),
})
if err != nil {
Expand All @@ -223,7 +223,7 @@ func New(ctx context.Context, config *Config) (*Subgraphs, error) {
}
natsPubSubByProviderID["default"] = defaultAdapter

myNatsAdapter, err := natsPubsub.NewAdapter(ctx, zap.NewNop(), url, []nats.Option{}, "hostname", "test", datasource.ProviderOpts{
myNatsAdapter, err := natsPubsub.NewAdapter(ctx, zap.NewNop(), url, []nats.Option{}, "hostname", "test", false, datasource.ProviderOpts{
StreamMetricStore: rmetric.NewNoopStreamMetricStore(),
})
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion router-tests/testenv/testenv.go
Original file line number Diff line number Diff line change
Expand Up @@ -2911,7 +2911,7 @@ func subgraphOptions(ctx context.Context, t testing.TB, logger *zap.Logger, nats
}
natsPubSubByProviderID := make(map[string]pubsubNats.Adapter, len(DemoNatsProviders))
for _, sourceName := range DemoNatsProviders {
adapter, err := pubsubNats.NewAdapter(ctx, logger, natsData.Params[0].Url, natsData.Params[0].Opts, "hostname", "listenaddr", datasource.ProviderOpts{
adapter, err := pubsubNats.NewAdapter(ctx, logger, natsData.Params[0].Url, natsData.Params[0].Opts, "hostname", "listenaddr", false, datasource.ProviderOpts{
StreamMetricStore: rmetric.NewNoopStreamMetricStore(),
})
require.NoError(t, err)
Expand Down
7 changes: 4 additions & 3 deletions router/pkg/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -617,9 +617,10 @@ type NatsAuthentication struct {
}

type NatsEventSource struct {
ID string `yaml:"id,omitempty"`
URL string `yaml:"url,omitempty"`
Authentication *NatsAuthentication `yaml:"authentication,omitempty"`
ID string `yaml:"id,omitempty"`
URL string `yaml:"url,omitempty"`
Authentication *NatsAuthentication `yaml:"authentication,omitempty"`
DeleteDurableConsumersOnShutdown bool `yaml:"delete_durable_consumers_on_shutdown" envDefault:"false"`
}

func (n NatsEventSource) GetID() string {
Expand Down
5 changes: 5 additions & 0 deletions router/pkg/config/config.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2580,6 +2580,11 @@
}
}
]
},
"delete_durable_consumers_on_shutdown": {
"type": "boolean",
"description": "When enabled, all durable JetStream consumers created by this provider are deleted when the router shuts down. This prevents zombie consumers accumulating on the NATS server across Kubernetes rolling deployments where each pod has a unique hostname baked into the consumer name. Defaults to false.",
"default": false
}
}
}
Expand Down
6 changes: 4 additions & 2 deletions router/pkg/config/testdata/config_full.json
Original file line number Diff line number Diff line change
Expand Up @@ -656,7 +656,8 @@
{
"ID": "default",
"URL": "nats://localhost:4222",
"Authentication": null
"Authentication": null,
"DeleteDurableConsumersOnShutdown": false
},
{
"ID": "my-nats",
Expand All @@ -667,7 +668,8 @@
"Username": "admin"
},
"Token": null
}
},
"DeleteDurableConsumersOnShutdown": false
}
],
"Kafka": [
Expand Down
58 changes: 47 additions & 11 deletions router/pkg/pubsub/nats/adapter.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ type Adapter interface {
// Ensure ProviderAdapter implements ProviderSubscriptionHooks
var _ datasource.Adapter = (*ProviderAdapter)(nil)

type trackedConsumer struct {
streamName string
consumerName string
}

// ProviderAdapter implements the AdapterInterface for NATS pub/sub
type ProviderAdapter struct {
ctx context.Context
Expand All @@ -46,6 +51,10 @@ type ProviderAdapter struct {
opts []nats.Option
flushTimeout time.Duration
streamMetricStore metric.StreamMetricStore

deleteConsumersOnShutdown bool
trackedConsumersMu sync.Mutex
trackedConsumers []trackedConsumer
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
}

// getInstanceIdentifier returns an identifier for the current instance.
Expand Down Expand Up @@ -116,6 +125,15 @@ func (p *ProviderAdapter) Subscribe(ctx context.Context, cfg datasource.Subscrip
return datasource.NewError(fmt.Sprintf(`failed to create or update consumer for stream "%s"`, subConf.StreamConfiguration.StreamName), err)
}

if p.deleteConsumersOnShutdown {
p.trackedConsumersMu.Lock()
p.trackedConsumers = append(p.trackedConsumers, trackedConsumer{
streamName: subConf.StreamConfiguration.StreamName,
consumerName: durableConsumerName,
})
p.trackedConsumersMu.Unlock()
}

p.closeWg.Add(1)

go func() {
Expand Down Expand Up @@ -383,6 +401,23 @@ func (p *ProviderAdapter) Shutdown(ctx context.Context) error {

var shutdownErr error

// Delete durable consumers before closing the connection — the JetStream
// API requires an open connection to reach the NATS server.
if p.deleteConsumersOnShutdown && p.js != nil {
p.trackedConsumersMu.Lock()
consumers := p.trackedConsumers
p.trackedConsumersMu.Unlock()
for _, tc := range consumers {
if err := p.js.DeleteConsumer(ctx, tc.streamName, tc.consumerName); err != nil {
p.logger.Warn("failed to delete durable consumer on shutdown",
zap.String("stream", tc.streamName),
zap.String("consumer", tc.consumerName),
zap.Error(err),
)
}
}
}
Comment thread
dkorittki marked this conversation as resolved.
Outdated

fErr := p.flush(ctx)
if fErr != nil {
shutdownErr = errors.Join(shutdownErr, fErr)
Expand All @@ -407,7 +442,7 @@ func (p *ProviderAdapter) Shutdown(ctx context.Context) error {
return nil
}

func NewAdapter(ctx context.Context, logger *zap.Logger, url string, opts []nats.Option, hostName string, routerListenAddr string, providerOpts datasource.ProviderOpts) (Adapter, error) {
func NewAdapter(ctx context.Context, logger *zap.Logger, url string, opts []nats.Option, hostName string, routerListenAddr string, deleteConsumersOnShutdown bool, providerOpts datasource.ProviderOpts) (Adapter, error) {
if logger == nil {
logger = zap.NewNop()
}
Expand All @@ -422,16 +457,17 @@ func NewAdapter(ctx context.Context, logger *zap.Logger, url string, opts []nats
ctx, cancelFunc := context.WithCancel(ctx)

return &ProviderAdapter{
ctx: ctx,
cancel: cancelFunc,
logger: logger.With(zap.String("pubsub", "nats")),
closeWg: sync.WaitGroup{},
hostName: hostName,
routerListenAddr: routerListenAddr,
url: url,
opts: opts,
flushTimeout: 10 * time.Second,
streamMetricStore: store,
ctx: ctx,
cancel: cancelFunc,
logger: logger.With(zap.String("pubsub", "nats")),
closeWg: sync.WaitGroup{},
hostName: hostName,
routerListenAddr: routerListenAddr,
url: url,
opts: opts,
flushTimeout: 10 * time.Second,
streamMetricStore: store,
deleteConsumersOnShutdown: deleteConsumersOnShutdown,
}, nil
}

Expand Down
2 changes: 1 addition & 1 deletion router/pkg/pubsub/nats/provider_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ func buildProvider(ctx context.Context, provider config.NatsEventSource, logger
return nil, fmt.Errorf("failed to build options for Nats provider with ID \"%s\": %w", provider.ID, err)
}

adapter, err := NewAdapter(ctx, logger, provider.URL, options, hostName, routerListenAddr, providerOpts)
adapter, err := NewAdapter(ctx, logger, provider.URL, options, hostName, routerListenAddr, provider.DeleteDurableConsumersOnShutdown, providerOpts)
if err != nil {
return nil, fmt.Errorf("failed to create adapter for Nats provider with ID \"%s\": %w", provider.ID, err)
}
Expand Down
Loading