Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Channel recovery #416

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Channel recovery #416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ waker-fn = "^1.1"

[dev-dependencies]
async-global-executor = "^2.0"
async-io = "^2.0"
futures-lite = "^2.0"
serde_json = "^1.0"
waker-fn = "^1.1"
Expand Down
58 changes: 58 additions & 0 deletions examples/c.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
use futures_lite::StreamExt;
use lapin::{options::*, types::FieldTable, Connection, ConnectionProperties};
use tracing::info;

fn main() {
if std::env::var("RUST_LOG").is_err() {
unsafe { std::env::set_var("RUST_LOG", "info") };

Check warning on line 7 in examples/c.rs

View workflow job for this annotation

GitHub Actions / build_and_test (ubuntu-latest, 1.74.0) 

unnecessary `unsafe` block

Check warning on line 7 in examples/c.rs

View workflow job for this annotation

GitHub Actions / build_and_test (ubuntu-latest, 1.74.0) 

unnecessary `unsafe` block

Check warning on line 7 in examples/c.rs

View workflow job for this annotation

GitHub Actions / build_and_test (ubuntu-latest, 1.74.0) 

unnecessary `unsafe` block
}

tracing_subscriber::fmt::init();

let addr = std::env::var("AMQP_ADDR").unwrap_or_else(|_| "amqp://127.0.0.1:5672/%2f".into());

async_global_executor::block_on(async {
let conn = Connection::connect(&addr, ConnectionProperties::default())
.await
.expect("connection error");

info!("CONNECTED");

//receive channel
let channel = conn.create_channel().await.expect("create_channel");
info!(state=?conn.status().state());

let queue = channel
.queue_declare(
"hello-recover",
QueueDeclareOptions::default(),
FieldTable::default(),
)
.await
.expect("queue_declare");
info!(state=?conn.status().state());
info!(?queue, "Declared queue");

info!("will consume");
let mut consumer = channel
.basic_consume(
"hello-recover",
"my_consumer",
BasicConsumeOptions::default(),
FieldTable::default(),
)
.await
.expect("basic_consume");
info!(state=?conn.status().state());

while let Some(delivery) = consumer.next().await {
info!(message=?delivery, "received message");
if let Ok(delivery) = delivery {
delivery
.ack(BasicAckOptions::default())
.await
.expect("basic_ack");
}
}
})
}
95 changes: 95 additions & 0 deletions examples/p.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
use lapin::{options::*, types::FieldTable, BasicProperties, Connection, ConnectionProperties};
use tracing::info;

fn main() {
if std::env::var("RUST_LOG").is_err() {
std::env::set_var("RUST_LOG", "info");
}

tracing_subscriber::fmt::init();

let addr = std::env::var("AMQP_ADDR").unwrap_or_else(|_| "amqp://127.0.0.1:5672/%2f".into());
let recovery_config = lapin::experimental::RecoveryConfig::default().auto_recover_channels();

async_global_executor::block_on(async {
let conn = Connection::connect(
&addr,
ConnectionProperties::default().with_experimental_recovery_config(recovery_config),
)
.await
.expect("connection error");

info!("CONNECTED");

let channel1 = conn.create_channel().await.expect("create_channel");
channel1
.confirm_select(ConfirmSelectOptions::default())
.await
.expect("confirm_select");
channel1
.queue_declare(
"hello-recover",
QueueDeclareOptions::default(),
FieldTable::default(),
)
.await
.expect("queue_declare");

let ch = channel1.clone();
async_global_executor::spawn(async move {
loop {
async_io::Timer::after(std::time::Duration::from_secs(1)).await;
info!("Trigger failure");
assert!(ch
.queue_declare(
"fake queue",
QueueDeclareOptions {
passive: true,
..QueueDeclareOptions::default()
},
FieldTable::default(),
)
.await
.is_err());
}
})
.detach();

let mut published = 0;
let mut errors = 0;
info!("will publish");
loop {
let res = channel1
.basic_publish(
"",
"recover-test",
BasicPublishOptions::default(),
b"before",
BasicProperties::default(),
)
.await;
let res = if let Ok(res) = res {
res.await.map(|_| ())
} else {
res.map(|_| ())
};
match res {
Ok(()) => {
println!("GOT OK");
published += 1;
}
Err(err) => {
println!("GOT ERROR");
if !err.is_amqp_soft_error() {
panic!("{}", err);
}
errors += 1;
if let Some(notifier) = err.notifier() {
notifier.await
}
}
}
println!("Published {} with {} errors", published, errors);
}
});
}
120 changes: 120 additions & 0 deletions examples/t.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
use lapin::{
message::DeliveryResult, options::*, publisher_confirm::Confirmation, types::FieldTable,
BasicProperties, Connection, ConnectionProperties,
};
use tracing::info;

fn main() {
if std::env::var("RUST_LOG").is_err() {
std::env::set_var("RUST_LOG", "info");
}

tracing_subscriber::fmt::init();

let addr = std::env::var("AMQP_ADDR").unwrap_or_else(|_| "amqp://127.0.0.1:5672/%2f".into());
let recovery_config = lapin::experimental::RecoveryConfig::default().auto_recover_channels();

async_global_executor::block_on(async {
let conn = Connection::connect(
&addr,
ConnectionProperties::default().with_experimental_recovery_config(recovery_config),
)
.await
.expect("connection error");

info!("CONNECTED");

{
let channel1 = conn.create_channel().await.expect("create_channel");
let channel2 = conn.create_channel().await.expect("create_channel");
channel1
.confirm_select(ConfirmSelectOptions::default())
.await
.expect("confirm_select");
channel1
.queue_declare(
"recover-test",
QueueDeclareOptions::default(),
FieldTable::default(),
)
.await
.expect("queue_declare");

info!("will consume");
let channel = channel2.clone();
channel2
.basic_consume(
"recover-test",
"my_consumer",
BasicConsumeOptions::default(),
FieldTable::default(),
)
.await
.expect("basic_consume")
.set_delegate(move |delivery: DeliveryResult| {
let channel = channel.clone();
async move {
info!(message=?delivery, "received message");
if let Ok(Some(delivery)) = delivery {
delivery
.ack(BasicAckOptions::default())
.await
.expect("basic_ack");
if &delivery.data[..] == b"after" {
channel
.basic_cancel("my_consumer", BasicCancelOptions::default())
.await
.expect("basic_cancel");
}
}
}
});

info!("will publish");
let confirm = channel1
.basic_publish(
"",
"recover-test",
BasicPublishOptions::default(),
b"before",
BasicProperties::default(),
)
.await
.expect("basic_publish")
.await
.expect("publisher-confirms");
assert_eq!(confirm, Confirmation::Ack(None));

info!("before fail");
assert!(channel1
.queue_declare(
"fake queue",
QueueDeclareOptions {
passive: true,
..QueueDeclareOptions::default()
},
FieldTable::default(),
)
.await
.is_err());
info!("after fail");

info!("publish after");
let confirm = channel1
.basic_publish(
"",
"recover-test",
BasicPublishOptions::default(),
b"after",
BasicProperties::default(),
)
.await
.expect("basic_publish")
.await
.expect("publisher-confirms");
assert_eq!(confirm, Confirmation::Ack(None));
}

conn.run().expect("conn.run");
});
}
9 changes: 9 additions & 0 deletions src/acknowledgement.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ impl Acknowledgements {
pub(crate) fn on_channel_error(&self, error: Error) {
self.0.lock().on_channel_error(error);
}

pub(crate) fn reset(&self, error: Error) {
self.0.lock().reset(error);
}
}

impl fmt::Debug for Acknowledgements {
Expand Down Expand Up @@ -174,4 +178,9 @@ impl Inner {
}
}
}

fn reset(&mut self, error: Error) {
self.delivery_tag = IdSequence::new(false);
self.on_channel_error(error);
}
}
72 changes: 54 additions & 18 deletions src/channel.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,13 +572,17 @@
}

fn on_channel_close_ok_sent(&self, error: Option<Error>) {
self.set_closed(
error
.clone()
.unwrap_or(ErrorKind::InvalidChannelState(ChannelState::Closing).into()),
);
if let Some(error) = error {
self.error_handler.on_error(error);
if !self.recovery_config.auto_recover_channels
|| !error.as_ref().map_or(false, |e| e.is_amqp_soft_error())

Check warning on line 576 in src/channel.rs

View workflow job for this annotation

GitHub Actions / clippy

this `map_or` is redundant 

warning: this `map_or` is redundant
   --> src/channel.rs:576:17
    |
576 |             || !error.as_ref().map_or(false, |e| e.is_amqp_soft_error())
    |                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use is_some_and instead: `error.as_ref().is_some_and(|e| e.is_amqp_soft_error())`
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#unnecessary_map_or
    = note: `-W clippy::unnecessary-map-or` implied by `-W clippy::all`
    = help: to override `-W clippy::all` add `#[allow(clippy::unnecessary_map_or)]`
{
self.set_closed(
error
.clone()
.unwrap_or(ErrorKind::InvalidChannelState(ChannelState::Closing).into()),
);
if let Some(error) = error {
self.error_handler.on_error(error);
}
}
}

Expand Down Expand Up @@ -862,7 +866,19 @@
resolver: PromiseResolver<Channel>,
channel: Channel,
) -> Result<()> {
self.set_state(ChannelState::Connected);
if self.recovery_config.auto_recover_channels {
self.status.update_recovery_context(|ctx| {
ctx.set_expected_replies(self.frames.take_expected_replies(self.id));
self.frames.drop_frames_for_channel(channel.id, ctx.cause());
self.acknowledgements.reset(ctx.cause());
self.consumers.error(ctx.cause());
});
if !self.status.confirm() {
self.status.finalize_recovery();
}
} else {
self.set_state(ChannelState::Connected);
}
resolver.resolve(channel);
Ok(())
}
Expand Down Expand Up @@ -891,18 +907,38 @@
}

fn on_channel_close_received(&self, method: protocol::channel::Close) -> Result<()> {
let error = AMQPError::try_from(method.clone()).map(|error| {
error!(
channel=%self.id, ?method, ?error,
"Channel closed"
);
ErrorKind::ProtocolError(error).into()
});
self.set_closing(error.clone().ok());
let error: std::result::Result<Error, _> =
AMQPError::try_from(method.clone()).map(|error| {
error!(
channel=%self.id, ?method, ?error,
"Channel closed"
);
ErrorKind::ProtocolError(error).into()
});
match (
self.recovery_config.auto_recover_channels,
error.clone().ok(),
) {
(true, Some(error)) if error.is_amqp_soft_error() => {
self.status.set_reconnecting(error)
}
(_, err) => self.set_closing(err),
}
let error = error.map_err(|error| info!(channel=%self.id, ?method, code_to_error=%error, "Channel closed with a non-error code")).ok();
let channel = self.clone();
self.internal_rpc
.register_internal_future(async move { channel.channel_close_ok(error).await });
self.internal_rpc.register_internal_future(async move {
channel.channel_close_ok(error).await?;
if channel.recovery_config.auto_recover_channels {
let ch = channel.clone();
channel.channel_open(ch).await?;
if channel.status.confirm() {
channel
.confirm_select(ConfirmSelectOptions::default())
.await?;
}
}
Ok(())
});
Ok(())
}

Expand Down
Loading
Loading