1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
|
// Copyright (c) 2021 VMware, Inc. or its affiliates. All Rights Reserved.
// Copyright (c) 2012-2021, Sean Treadway, SoundCloud Ltd.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package amqp091_test
import (
"context"
"errors"
"log"
"os"
"sync"
"time"
amqp "github.com/rabbitmq/amqp091-go"
)
// This exports a Client object that wraps this library. It
// automatically reconnects when the connection fails, and
// blocks all pushes until the connection succeeds. It also
// confirms every outgoing message, so none are lost.
// It doesn't automatically ack each message, but leaves that
// to the parent process, since it is usage-dependent.
//
// Try running this in one terminal, and rabbitmq-server in another.
//
// Stop & restart RabbitMQ to see how the queue reacts.
func Example_publish() {
queueName := "job_queue"
addr := "amqp://guest:guest@localhost:5672/"
queue := New(queueName, addr)
message := []byte("message")
ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(time.Second*20))
defer cancel()
loop:
for {
select {
// Attempt to push a message every 2 seconds
case <-time.After(time.Second * 2):
if err := queue.Push(message); err != nil {
log.Printf("Push failed: %s\n", err)
} else {
log.Println("Push succeeded!")
}
case <-ctx.Done():
if err := queue.Close(); err != nil {
log.Printf("Close failed: %s\n", err)
}
break loop
}
}
}
func Example_consume() {
queueName := "job_queue"
addr := "amqp://guest:guest@localhost:5672/"
queue := New(queueName, addr)
// Give the connection sometime to set up
<-time.After(time.Second)
ctx, cancel := context.WithTimeout(context.Background(), time.Second*30)
defer cancel()
deliveries, err := queue.Consume()
if err != nil {
log.Printf("Could not start consuming: %s\n", err)
return
}
// This channel will receive a notification when a channel closed event
// happens. This must be different from Client.notifyChanClose because the
// library sends only one notification and Client.notifyChanClose already has
// a receiver in handleReconnect().
// Recommended to make it buffered to avoid deadlocks
chClosedCh := make(chan *amqp.Error, 1)
queue.channel.NotifyClose(chClosedCh)
for {
select {
case <-ctx.Done():
err := queue.Close()
if err != nil {
log.Printf("Close failed: %s\n", err)
}
return
case amqErr := <-chClosedCh:
// This case handles the event of closed channel e.g. abnormal shutdown
log.Printf("AMQP Channel closed due to: %s\n", amqErr)
deliveries, err = queue.Consume()
if err != nil {
// If the AMQP channel is not ready, it will continue the loop. Next
// iteration will enter this case because chClosedCh is closed by the
// library
log.Println("Error trying to consume, will try again")
continue
}
// Re-set channel to receive notifications
// The library closes this channel after abnormal shutdown
chClosedCh = make(chan *amqp.Error, 1)
queue.channel.NotifyClose(chClosedCh)
case delivery := <-deliveries:
// Ack a message every 2 seconds
log.Printf("Received message: %s\n", delivery.Body)
if err := delivery.Ack(false); err != nil {
log.Printf("Error acknowledging message: %s\n", err)
}
<-time.After(time.Second * 2)
}
}
}
// Client is the base struct for handling connection recovery, consumption and
// publishing. Note that this struct has an internal mutex to safeguard against
// data races. As you develop and iterate over this example, you may need to add
// further locks, or safeguards, to keep your application safe from data races
type Client struct {
m *sync.Mutex
queueName string
logger *log.Logger
connection *amqp.Connection
channel *amqp.Channel
done chan bool
notifyConnClose chan *amqp.Error
notifyChanClose chan *amqp.Error
notifyConfirm chan amqp.Confirmation
isReady bool
}
const (
// When reconnecting to the server after connection failure
reconnectDelay = 5 * time.Second
// When setting up the channel after a channel exception
reInitDelay = 2 * time.Second
// When resending messages the server didn't confirm
resendDelay = 5 * time.Second
)
var (
errNotConnected = errors.New("not connected to a server")
errAlreadyClosed = errors.New("already closed: not connected to the server")
errShutdown = errors.New("client is shutting down")
)
// New creates a new consumer state instance, and automatically
// attempts to connect to the server.
func New(queueName, addr string) *Client {
client := Client{
m: &sync.Mutex{},
logger: log.New(os.Stdout, "", log.LstdFlags),
queueName: queueName,
done: make(chan bool),
}
go client.handleReconnect(addr)
return &client
}
// handleReconnect will wait for a connection error on
// notifyConnClose, and then continuously attempt to reconnect.
func (client *Client) handleReconnect(addr string) {
for {
client.m.Lock()
client.isReady = false
client.m.Unlock()
client.logger.Println("Attempting to connect")
conn, err := client.connect(addr)
if err != nil {
client.logger.Println("Failed to connect. Retrying...")
select {
case <-client.done:
return
case <-time.After(reconnectDelay):
}
continue
}
if done := client.handleReInit(conn); done {
break
}
}
}
// connect will create a new AMQP connection
func (client *Client) connect(addr string) (*amqp.Connection, error) {
conn, err := amqp.Dial(addr)
if err != nil {
return nil, err
}
client.changeConnection(conn)
client.logger.Println("Connected!")
return conn, nil
}
// handleReInit will wait for a channel error
// and then continuously attempt to re-initialize both channels
func (client *Client) handleReInit(conn *amqp.Connection) bool {
for {
client.m.Lock()
client.isReady = false
client.m.Unlock()
err := client.init(conn)
if err != nil {
client.logger.Println("Failed to initialize channel. Retrying...")
select {
case <-client.done:
return true
case <-client.notifyConnClose:
client.logger.Println("Connection closed. Reconnecting...")
return false
case <-time.After(reInitDelay):
}
continue
}
select {
case <-client.done:
return true
case <-client.notifyConnClose:
client.logger.Println("Connection closed. Reconnecting...")
return false
case <-client.notifyChanClose:
client.logger.Println("Channel closed. Re-running init...")
}
}
}
// init will initialize channel & declare queue
func (client *Client) init(conn *amqp.Connection) error {
ch, err := conn.Channel()
if err != nil {
return err
}
err = ch.Confirm(false)
if err != nil {
return err
}
_, err = ch.QueueDeclare(
client.queueName,
false, // Durable
false, // Delete when unused
false, // Exclusive
false, // No-wait
nil, // Arguments
)
if err != nil {
return err
}
client.changeChannel(ch)
client.m.Lock()
client.isReady = true
client.m.Unlock()
client.logger.Println("Setup!")
return nil
}
// changeConnection takes a new connection to the queue,
// and updates the close listener to reflect this.
func (client *Client) changeConnection(connection *amqp.Connection) {
client.connection = connection
client.notifyConnClose = make(chan *amqp.Error, 1)
client.connection.NotifyClose(client.notifyConnClose)
}
// changeChannel takes a new channel to the queue,
// and updates the channel listeners to reflect this.
func (client *Client) changeChannel(channel *amqp.Channel) {
client.channel = channel
client.notifyChanClose = make(chan *amqp.Error, 1)
client.notifyConfirm = make(chan amqp.Confirmation, 1)
client.channel.NotifyClose(client.notifyChanClose)
client.channel.NotifyPublish(client.notifyConfirm)
}
// Push will push data onto the queue, and wait for a confirmation.
// This will block until the server sends a confirmation. Errors are
// only returned if the push action itself fails, see UnsafePush.
func (client *Client) Push(data []byte) error {
client.m.Lock()
if !client.isReady {
client.m.Unlock()
return errors.New("failed to push: not connected")
}
client.m.Unlock()
for {
err := client.UnsafePush(data)
if err != nil {
client.logger.Println("Push failed. Retrying...")
select {
case <-client.done:
return errShutdown
case <-time.After(resendDelay):
}
continue
}
confirm := <-client.notifyConfirm
if confirm.Ack {
client.logger.Printf("Push confirmed [%d]!", confirm.DeliveryTag)
return nil
}
}
}
// UnsafePush will push to the queue without checking for
// confirmation. It returns an error if it fails to connect.
// No guarantees are provided for whether the server will
// receive the message.
func (client *Client) UnsafePush(data []byte) error {
client.m.Lock()
if !client.isReady {
client.m.Unlock()
return errNotConnected
}
client.m.Unlock()
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
return client.channel.PublishWithContext(
ctx,
"", // Exchange
client.queueName, // Routing key
false, // Mandatory
false, // Immediate
amqp.Publishing{
ContentType: "text/plain",
Body: data,
},
)
}
// Consume will continuously put queue items on the channel.
// It is required to call delivery.Ack when it has been
// successfully processed, or delivery.Nack when it fails.
// Ignoring this will cause data to build up on the server.
func (client *Client) Consume() (<-chan amqp.Delivery, error) {
client.m.Lock()
if !client.isReady {
client.m.Unlock()
return nil, errNotConnected
}
client.m.Unlock()
if err := client.channel.Qos(
1, // prefetchCount
0, // prefetchSize
false, // global
); err != nil {
return nil, err
}
return client.channel.Consume(
client.queueName,
"", // Consumer
false, // Auto-Ack
false, // Exclusive
false, // No-local
false, // No-Wait
nil, // Args
)
}
// Close will cleanly shut down the channel and connection.
func (client *Client) Close() error {
client.m.Lock()
// we read and write isReady in two locations, so we grab the lock and hold onto
// it until we are finished
defer client.m.Unlock()
if !client.isReady {
return errAlreadyClosed
}
close(client.done)
err := client.channel.Close()
if err != nil {
return err
}
err = client.connection.Close()
if err != nil {
return err
}
client.isReady = false
return nil
}
|