andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Allow to use int while build MqttMessageIdVariableHeader (#10930)

Browse Source 
Motivation:

Exception occurs in the MQTT message builder class (`io.netty.handler.codec.mqtt.MqttMessageBuilders`) when trying to create a message with packetId > 32767

Modification:

-add method that takes int
- deprecate old methods that take short. 

Result:


Fixes #10929 .
This commit is contained in:
Duke Bartholomew 2021-01-21 14:40:45 +01:00 committed by GitHub
parent 60780c647e
commit f54bf7aeb0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 145 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
codec-mqtt/src/main/java/io/netty/handler/codec/mqtt/MqttMessageBuilders.java
View File

@ -524,7 +524,7 @@ public final class MqttMessageBuilders {
public static final class PubAckBuilder {
private short packetId;
private int packetId;
private byte reasonCode;
private MqttProperties properties;
@ -536,11 +536,19 @@ public final class MqttMessageBuilders {
return this;
}
public PubAckBuilder packetId(short packetId) {
public PubAckBuilder packetId(int packetId) {
this.packetId = packetId;
return this;
}
/**
* @deprecated use {@link PubAckBuilder#packetId(int)} instead
*/
@Deprecated
public PubAckBuilder packetId(short packetId) {
return packetId(packetId & 0xFFFF);
}
public PubAckBuilder properties(MqttProperties properties) {
this.properties = properties;
return this;
@ -557,18 +565,26 @@ public final class MqttMessageBuilders {
public static final class SubAckBuilder {
private short packetId;
private int packetId;
private MqttProperties properties;
private final List<MqttQoS> grantedQoses = new ArrayList<MqttQoS>();
SubAckBuilder() {
}
public SubAckBuilder packetId(short packetId) {
public SubAckBuilder packetId(int packetId) {
this.packetId = packetId;
return this;
}
/**
* @deprecated use {@link SubAckBuilder#packetId(int)} instead
*/
@Deprecated
public SubAckBuilder packetId(short packetId) {
return packetId(packetId & 0xFFFF);
}
public SubAckBuilder properties(MqttProperties properties) {
this.properties = properties;
return this;
@ -604,18 +620,26 @@ public final class MqttMessageBuilders {
public static final class UnsubAckBuilder {
private short packetId;
private int packetId;
private MqttProperties properties;
private final List<Short> reasonCodes = new ArrayList<Short>();
UnsubAckBuilder() {
}
public UnsubAckBuilder packetId(short packetId) {
public UnsubAckBuilder packetId(int packetId) {
this.packetId = packetId;
return this;
}
/**
* @deprecated use {@link UnsubAckBuilder#packetId(int)} instead
*/
@Deprecated
public UnsubAckBuilder packetId(short packetId) {
return packetId(packetId & 0xFFFF);
}
public UnsubAckBuilder properties(MqttProperties properties) {
this.properties = properties;
return this;

115
codec-mqtt/src/test/java/io/netty/handler/codec/mqtt/MqttMessageBuildersPacketIdTest.java Normal file
View File

@ -0,0 +1,115 @@
/*
* Copyright 2020 The Netty Project
*
* The Netty Project licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package io.netty.handler.codec.mqtt;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import java.util.Arrays;
import static org.junit.Assert.*;
@RunWith(value = Parameterized.class)
public class MqttMessageBuildersPacketIdTest {
@Parameterized.Parameter
public Integer id;
@Parameterized.Parameters(name = "{index}: {0}")
public static Iterable<Integer> data() {
// we take a subset of valid packetIds
return Arrays.asList(
0x0001,
0x000F,
0x00FF,
0x0FFF,
0xFFFF
);
}
@Test
public void testUnsubAckMessageIdAsShort() {
final MqttUnsubAckMessage msg = MqttMessageBuilders.unsubAck()
.packetId(id.shortValue())
.build();
assertEquals(
id.intValue(),
msg.variableHeader().messageId()
);
}
@Test
public void testSubAckMessageIdAsShort() {
final MqttSubAckMessage msg = MqttMessageBuilders.subAck()
.packetId(id.shortValue())
.build();
assertEquals(
id.intValue(),
msg.variableHeader().messageId()
);
}
@Test
public void testPubAckMessageIdAsShort() {
final MqttMessage msg = MqttMessageBuilders.pubAck()
.packetId(id.shortValue())
.build();
assertEquals(
id.intValue(),
((MqttMessageIdVariableHeader) msg.variableHeader()).messageId()
);
}
@Test
public void testUnsubAckMessageIdAsInt() {
final MqttUnsubAckMessage msg = MqttMessageBuilders.unsubAck()
.packetId(id)
.build();
assertEquals(
id.intValue(),
msg.variableHeader().messageId()
);
}
@Test
public void testSubAckMessageIdAsInt() {
final MqttSubAckMessage msg = MqttMessageBuilders.subAck()
.packetId(id)
.build();
assertEquals(
id.intValue(),
msg.variableHeader().messageId()
);
}
@Test
public void testPubAckMessageIdAsInt() {
final MqttMessage msg = MqttMessageBuilders.pubAck()
.packetId(id)
.build();
assertEquals(
id.intValue(),
((MqttMessageIdVariableHeader) msg.variableHeader()).messageId()
);
}
}