-
Notifications
You must be signed in to change notification settings - Fork 889
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Disable using v2 decoder to decode v3 response if usingV2WireProtocol…
… is enabled and handle unknown op in v2 request decoder Descriptions of the changes in this PR: *Problem* - response decoder should use whatever protocol that request is using to decode the response. otherwise it is making wrong assumption on response protocol. - v2 request decoder doesn't handle unknown op correctly, which will cause netty double-release bytebuf *Solution* - make sure response decoder respect the protocol that client is using for sending requests - v2 request decoder should throw exceptions when fail to decode unknown request Related issues: #198 Author: Sijie Guo <sijie@apache.org> Reviewers: Ivan Kelly <ivank@apache.org>, Enrico Olivelli <eolivelli@gmail.com>, Jia Zhai <None>, Matteo Merli <mmerli@apache.org> This closes #1240 from sijie/bookkeeper_fix_bytebuf_issues
- Loading branch information
Showing
4 changed files
with
148 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
121 changes: 121 additions & 0 deletions
121
bookkeeper-server/src/test/java/org/apache/bookkeeper/proto/BookieProtoEncodingTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF 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 | ||
| * | ||
| * http://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 org.apache.bookkeeper.proto; | ||
|
|
||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.fail; | ||
| import static org.mockito.Mockito.mock; | ||
|
|
||
| import com.google.common.collect.Lists; | ||
| import com.google.protobuf.ByteString; | ||
| import com.google.protobuf.InvalidProtocolBufferException; | ||
| import io.netty.buffer.ByteBuf; | ||
| import io.netty.buffer.UnpooledByteBufAllocator; | ||
| import io.netty.channel.ChannelHandlerContext; | ||
| import java.util.List; | ||
| import org.apache.bookkeeper.proto.BookieProtoEncoding.RequestEnDeCoderPreV3; | ||
| import org.apache.bookkeeper.proto.BookieProtoEncoding.RequestEnDecoderV3; | ||
| import org.apache.bookkeeper.proto.BookieProtoEncoding.ResponseDecoder; | ||
| import org.apache.bookkeeper.proto.BookieProtoEncoding.ResponseEnDeCoderPreV3; | ||
| import org.apache.bookkeeper.proto.BookieProtoEncoding.ResponseEnDecoderV3; | ||
| import org.apache.bookkeeper.proto.BookieProtocol.AddResponse; | ||
| import org.apache.bookkeeper.proto.BookkeeperProtocol.AddRequest.Flag; | ||
| import org.apache.bookkeeper.proto.BookkeeperProtocol.BKPacketHeader; | ||
| import org.apache.bookkeeper.proto.BookkeeperProtocol.OperationType; | ||
| import org.apache.bookkeeper.proto.BookkeeperProtocol.ProtocolVersion; | ||
| import org.apache.bookkeeper.proto.BookkeeperProtocol.StatusCode; | ||
| import org.junit.Test; | ||
|
|
||
| /** | ||
| * Unit test {@link BookieProtoEncoding}. | ||
| */ | ||
| public class BookieProtoEncodingTest { | ||
|
|
||
| @Test | ||
| public void testV3ResponseDecoderNoFallback() throws Exception { | ||
| AddResponse v2Resp = AddResponse.create( | ||
| BookieProtocol.CURRENT_PROTOCOL_VERSION, | ||
| BookieProtocol.EOK, | ||
| 1L, | ||
| 2L); | ||
|
|
||
| BookkeeperProtocol.Response v3Resp = BookkeeperProtocol.Response.newBuilder() | ||
| .setHeader(BKPacketHeader.newBuilder() | ||
| .setVersion(ProtocolVersion.VERSION_THREE) | ||
| .setTxnId(1L) | ||
| .setOperation(OperationType.ADD_ENTRY) | ||
| .build()) | ||
| .setStatus(StatusCode.EOK) | ||
| .setAddResponse(BookkeeperProtocol.AddResponse.newBuilder() | ||
| .setStatus(StatusCode.EOK) | ||
| .setLedgerId(1L) | ||
| .setEntryId(2L) | ||
| .build()) | ||
| .build(); | ||
|
|
||
| List<Object> outList = Lists.newArrayList(); | ||
|
|
||
| ResponseEnDeCoderPreV3 v2Encoder = new ResponseEnDeCoderPreV3(null); | ||
| ResponseEnDecoderV3 v3Encoder = new ResponseEnDecoderV3(null); | ||
|
|
||
| ResponseDecoder v3Decoder = new ResponseDecoder(null, false); | ||
| try { | ||
| v3Decoder.decode( | ||
| mock(ChannelHandlerContext.class), | ||
| v2Encoder.encode(v2Resp, UnpooledByteBufAllocator.DEFAULT), | ||
| outList | ||
| ); | ||
| fail("V3 response decoder should fail on decoding v2 response"); | ||
| } catch (InvalidProtocolBufferException e) { | ||
| // expected | ||
| } | ||
| assertEquals(0, outList.size()); | ||
|
|
||
| v3Decoder.decode( | ||
| mock(ChannelHandlerContext.class), | ||
| v3Encoder.encode(v3Resp, UnpooledByteBufAllocator.DEFAULT), | ||
| outList); | ||
| assertEquals(1, outList.size()); | ||
| } | ||
|
|
||
| @Test(expected = IllegalStateException.class) | ||
| public void testV2RequestDecoderThrowExceptionOnUnknownRequests() throws Exception { | ||
| RequestEnDeCoderPreV3 v2ReqEncoder = new RequestEnDeCoderPreV3(null); | ||
| RequestEnDecoderV3 v3ReqEncoder = new RequestEnDecoderV3(null); | ||
|
|
||
| BookkeeperProtocol.Request v3Req = BookkeeperProtocol.Request.newBuilder() | ||
| .setHeader(BKPacketHeader.newBuilder() | ||
| .setVersion(ProtocolVersion.VERSION_THREE) | ||
| .setTxnId(1L) | ||
| .setOperation(OperationType.ADD_ENTRY) | ||
| .build()) | ||
| .setAddRequest(BookkeeperProtocol.AddRequest.newBuilder() | ||
| .setLedgerId(1L) | ||
| .setEntryId(2L) | ||
| .setMasterKey(ByteString.copyFrom("", UTF_8)) | ||
| .setFlag(Flag.RECOVERY_ADD) | ||
| .setBody(ByteString.copyFrom("test", UTF_8))) | ||
| .build(); | ||
|
|
||
|
|
||
| v2ReqEncoder.decode((ByteBuf) v3ReqEncoder.encode(v3Req, UnpooledByteBufAllocator.DEFAULT)); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters