Skip to content

Fix DefaultDataBuffer#getNativeBuffer() to set correct limit #32009

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.

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

Closed
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -37,6 +37,7 @@
* @author Arjen Poutsma
* @author Juergen Hoeller
* @author Brian Clozel
* @author Injae Kim
* @since 5.0
* @see DefaultDataBufferFactory
*/
@@ -81,12 +82,12 @@ static DefaultDataBuffer fromEmptyByteBuffer(DefaultDataBufferFactory dataBuffer
/**
* Directly exposes the native {@code ByteBuffer} that this buffer is based
* on also updating the {@code ByteBuffer's} position and limit to match
* the current {@link #readPosition()} and {@link #readableByteCount()}.
* the current {@link #readPosition()} and {@link #writePosition()}.
* @return the wrapped byte buffer
*/
public ByteBuffer getNativeBuffer() {
this.byteBuffer.position(this.readPosition);
this.byteBuffer.limit(readableByteCount());
this.byteBuffer.limit(this.writePosition);
Copy link
Contributor Author

@injae-kim injae-kim Jan 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0  1  2  3  4  5  6  7  8  9
                     ^        ^
                   read     write

When readPosition: 7 and writePosition: 10,
Current getNativebuffer return bytebuffer with limit: 3 (readableByteCount(), writePos - readPos)

But I think we should set limit: 10 (writePos) correctly.

Like this commit, maybe we set redableByteCount() as length on bytebuffer's limit by mistake 😅

return this.byteBuffer;
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
/*
* Copyright 2024-2024 the original author or authors.
*
* Licensed 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 org.springframework.core.io.buffer;

import java.nio.ByteBuffer;
import java.nio.charset.StandardCharsets;

import org.junit.jupiter.api.Test;

import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.core.io.buffer.DataBufferUtils.release;

/**
* Tests for {@link DefaultDataBuffer}.
*
* @author Injae Kim
* @since 6.2
*/
class DefaultDataBufferTests {

private final DefaultDataBufferFactory bufferFactory = new DefaultDataBufferFactory();

@Test // gh-30967
void getNativeBuffer() {
Comment on lines +37 to +38
Copy link
Contributor Author

@injae-kim injae-kim Jan 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

FYI) with current getNativeBuffer() logic, this test failed~!

DefaultDataBuffer buffer = bufferFactory.allocateBuffer(256);
buffer.write("0123456789", StandardCharsets.UTF_8);

byte[] result = new byte[7];
buffer.read(result);
assertThat(result).isEqualTo("0123456".getBytes(StandardCharsets.UTF_8));

ByteBuffer nativeBuffer = buffer.getNativeBuffer();
assertThat(nativeBuffer.position()).isEqualTo(7);
assertThat(buffer.readPosition()).isEqualTo(7);
assertThat(nativeBuffer.limit()).isEqualTo(10);
assertThat(buffer.writePosition()).isEqualTo(10);

release(buffer);
}

}