Files
cgrates/ees/nats.go
ionutboangiu d0a435aa6d Migrate to new jetstream API
Upgraded go.mod nats version due to an issue caused by version mismatch
between driver and server (uncertain).

Renamed function from getProcessOptions to getProcessedOptions.

## *NatsER.Serve

- Replaced ChanQueueSubscribe with QueueSubscribe for Core NATS consumer
to handle the message processing directly.

- Since QueueSubscribe is now used regardless of jetstream status, the
message handler has been assigned to a separate variable that can be
reused.

-  The message handler is now dealing with the message processing
directly, therefore the select case listening for the channel which is
feeding NATS messages can be removed together with the channel itself
and the select. Currently, the goroutine within Serve only has to block
until the rdrExit chan is closed.

- Moved the resource check inside the handler right before starting the
message processing goroutine.

## *NatsEE.parseOpts

- Renamed function from parseOpt to parseOpts.

- Handled the error coming from GetNatsOpts function.

## *NatsEE.Connect

- Updated function to return early in case of non-nil nats.Conn value
to reduce nesting.

## *NatsEE.ExportEvent

- Use defer to release resources and RUnlock.

## *NatsEE.Close

- Use defer to Unlock.

- Update function to return early in case of nil nats.Conn value to
reduce nesting.

## ees.GetNatsOpts

- Chose switch over if else when parsing client certificate and keys
opts.

- Updated function to return the errors directly instead of assigning
them to a separate variable right before returning.

## ers.GetNatsOpts

- Chose switch over if else when parsing client certificate and keys
opts.

- Updated function to return the errors directly instead of assigning
them to a separate variable right before returning.

Removed tab from commented natsJetStreamMaxWaitProcessed option
value in config_defaults.go under ers section.

Added integration test for ERs NATS.

Updated ees/ers implementation to use the jetstream package which
separates the jetstream context from Core NATS.

Removed the jsOpts fields from the NatsEE struct. We are now using the
jetStreamMaxWait option directly through a timeout context.

Added streamName option for NATS reader since it is now required to be
specified when creating a consumer (it is not inferred based on subject
anymore).

Updated nats ers integration tests.

Updated tests to also use the new jetstream package.

Updated tests to start the nats-server using their official driver
instead of using the std go exec package. time.Sleeps are now not
required anymore to wait for the server.

In test configurations for nats readers, made sure that natsStreamName
option is populated. It is now required for consumers to know where to
subscribe.
2023-09-28 20:48:39 +02:00

189 lines
5.0 KiB
Go

/*
Real-time Online/Offline Charging System (OCS) for Telecom & ISP environments
Copyright (C) ITsysCOM GmbH
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>
*/
package ees
import (
"crypto/tls"
"crypto/x509"
"fmt"
"os"
"sync"
"time"
"github.com/cgrates/birpc/context"
"github.com/cgrates/cgrates/config"
"github.com/cgrates/cgrates/utils"
"github.com/nats-io/nats.go"
"github.com/nats-io/nats.go/jetstream"
)
// NewNatsEE creates a kafka poster
func NewNatsEE(cfg *config.EventExporterCfg, nodeID string, connTimeout time.Duration, dc *utils.SafeMapStorage) (natsPstr *NatsEE, err error) {
natsPstr = &NatsEE{
cfg: cfg,
dc: dc,
subject: utils.DefaultQueueID,
reqs: newConcReq(cfg.ConcurrentRequests),
}
err = natsPstr.parseOpts(cfg.Opts, nodeID, connTimeout)
return
}
// NatsEE is a kafka poster
type NatsEE struct {
subject string // identifier of the CDR queue where we publish
jetStream bool
opts []nats.Option
poster *nats.Conn
posterJS jetstream.JetStream
cfg *config.EventExporterCfg
dc *utils.SafeMapStorage
reqs *concReq
sync.RWMutex // protect writer
bytePreparing
}
func (pstr *NatsEE) parseOpts(opts *config.EventExporterOpts, nodeID string, connTimeout time.Duration) error {
if opts.NATSJetStream != nil {
pstr.jetStream = *opts.NATSJetStream
}
if opts.NATSSubject != nil {
pstr.subject = *opts.NATSSubject
}
var err error
pstr.opts, err = GetNatsOpts(opts, nodeID, connTimeout)
return err
}
func (pstr *NatsEE) Cfg() *config.EventExporterCfg { return pstr.cfg }
func (pstr *NatsEE) Connect() error {
pstr.Lock()
defer pstr.Unlock()
if pstr.poster != nil {
return nil
}
var err error
pstr.poster, err = nats.Connect(pstr.Cfg().ExportPath, pstr.opts...)
if err != nil {
return err
}
if pstr.jetStream {
pstr.posterJS, err = jetstream.New(pstr.poster)
}
return err
}
func (pstr *NatsEE) ExportEvent(ctx *context.Context, content, _ any) error {
pstr.reqs.get()
defer pstr.reqs.done()
pstr.RLock()
defer pstr.RUnlock()
if pstr.poster == nil {
return utils.ErrDisconnected
}
var err error
if pstr.jetStream {
ctx := context.TODO()
if pstr.cfg.Opts.NATSJetStreamMaxWait != nil {
ctx, _ = context.WithTimeout(ctx, *pstr.cfg.Opts.NATSJetStreamMaxWait)
}
_, err = pstr.posterJS.Publish(ctx, pstr.subject, content.([]byte))
} else {
err = pstr.poster.Publish(pstr.subject, content.([]byte))
}
return err
}
func (pstr *NatsEE) Close() error {
pstr.Lock()
defer pstr.Unlock()
if pstr.poster == nil {
return nil
}
err := pstr.poster.Drain()
pstr.poster = nil
return err
}
func (pstr *NatsEE) GetMetrics() *utils.SafeMapStorage { return pstr.dc }
func (pstr *NatsEE) ExtraData(ev *utils.CGREvent) any { return nil }
func GetNatsOpts(opts *config.EventExporterOpts, nodeID string, connTimeout time.Duration) ([]nats.Option, error) {
natsOpts := make([]nats.Option, 0, 7)
natsOpts = append(natsOpts, nats.Name(utils.CGRateSLwr+nodeID),
nats.Timeout(connTimeout),
nats.DrainTimeout(time.Second))
if opts.NATSJWTFile != nil {
keys := make([]string, 0, 1)
if opts.NATSSeedFile != nil {
keys = append(keys, *opts.NATSSeedFile)
}
natsOpts = append(natsOpts, nats.UserCredentials(*opts.NATSJWTFile, keys...))
}
if opts.NATSSeedFile != nil {
opt, err := nats.NkeyOptionFromSeed(*opts.NATSSeedFile)
if err != nil {
return nil, err
}
natsOpts = append(natsOpts, opt)
}
switch {
case opts.NATSClientCertificate != nil && opts.NATSClientKey != nil:
natsOpts = append(natsOpts, nats.ClientCert(*opts.NATSClientCertificate, *opts.NATSClientKey))
case opts.NATSClientCertificate != nil:
return nil, fmt.Errorf("has certificate but no key")
case opts.NATSClientKey != nil:
return nil, fmt.Errorf("has key but no certificate")
}
if opts.NATSCertificateAuthority != nil {
natsOpts = append(natsOpts,
func(o *nats.Options) error {
pool, err := x509.SystemCertPool()
if err != nil {
return err
}
rootPEM, err := os.ReadFile(*opts.NATSCertificateAuthority)
if err != nil || rootPEM == nil {
return fmt.Errorf("nats: error loading or parsing rootCA file: %v", err)
}
ok := pool.AppendCertsFromPEM(rootPEM)
if !ok {
return fmt.Errorf("nats: failed to parse root certificate from %q",
*opts.NATSCertificateAuthority)
}
if o.TLSConfig == nil {
o.TLSConfig = &tls.Config{MinVersion: tls.VersionTLS12}
}
o.TLSConfig.RootCAs = pool
o.Secure = true
return nil
})
}
return natsOpts, nil
}