Skip to content

fix: stop adding topic and retain when writing an MQTT lastWill #47

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VisualBean merged 1 commit into from
Oct 17, 2026
Merged

fix: stop adding topic and retain when writing an MQTT lastWill #47

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
12 changes: 9 additions & 3 deletions src/ByteBard.AsyncAPI.Bindings/MQTT/LastWill.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

public class LastWill : IAsyncApiElement
{
private bool? retain;

/// <summary>
/// The topic where the Last Will and Testament message will be sent.
/// </summary>
Expand All @@ -26,7 +28,11 @@ public class LastWill : IAsyncApiElement
/// <summary>
/// Whether the broker should retain the Last Will and Testament message or not.
/// </summary>
public bool Retain { get; set; }
public bool Retain
{
get => this.retain ?? false;
set => this.retain = value;
}

public void Serialize(IAsyncApiWriter writer)
{
Expand All @@ -36,10 +42,10 @@ public void Serialize(IAsyncApiWriter writer)
}

writer.WriteStartObject();
writer.WriteRequiredProperty("topic", this.Topic);
writer.WriteOptionalProperty("topic", this.Topic);
writer.WriteOptionalProperty("qos", (int?)this.QoS);
writer.WriteOptionalProperty("message", this.Message);
writer.WriteRequiredProperty("retain", this.Retain);
writer.WriteOptionalProperty("retain", this.retain);
writer.WriteEndObject();
}
}
Expand Down
30 changes: 30 additions & 0 deletions test/ByteBard.AsyncAPI.Tests/Bindings/MQTT/MQTTBindingVariants_Should.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,5 +111,35 @@ public void OperationBinding_OmitsUnsetQosAndRetain()
var yaml = new MQTTOperationBinding().SerializeAsYaml(AsyncApiVersion.AsyncApi3_0);
yaml.Should().NotContain("qos:").And.NotContain("retain:");
}

[TestCase(AsyncApiVersion.AsyncApi2_0)]
[TestCase(AsyncApiVersion.AsyncApi3_0)]
public void LastWill_WithoutTopicAndRetain_RoundTripsWithoutAddingThem(AsyncApiVersion version)
{
var settings = new AsyncApiReaderSettings { Bindings = BindingsCollection.MQTT };
var yaml = (version == AsyncApiVersion.AsyncApi2_0 ? "url" : "host") + ": localhost\n" +
"""
protocol: mqtt
bindings:
mqtt:
lastWill:
qos: 1
""";

var server = new AsyncApiStringReader(settings).ReadFragment<AsyncApiServer>(yaml, version, out var diagnostics);
diagnostics.Errors.Should().BeEmpty();

var actual = server.SerializeAsYaml(version);
actual.Should().Contain("qos: 1").And.NotContain("topic:").And.NotContain("retain:");
}

[Test]
public void LastWill_WithExplicitRetainFalse_WritesRetain()
{
var lastWill = new LastWill { Topic = "/last-wills", Retain = false };
var server = new MQTTServerBinding { LastWill = lastWill };

server.SerializeAsYaml(AsyncApiVersion.AsyncApi3_0).Should().Contain("topic: /last-wills").And.Contain("retain: false");
}
}
}
Loading