dnrops
/
swift-nio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add unprocessedBytes property on NIOSingleStepByteToMessageProcessor (#2419)

This commit is contained in:
Fabian Fett 2023-05-03 18:19:13 +02:00 committed by GitHub
parent 014812aab6
commit 546eaa261e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 45 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Sources/NIOCore/SingleStepByteToMessageDecoder.swift
View File

@ -281,6 +281,12 @@ extension NIOSingleStepByteToMessageProcessor: Sendable {}
// MARK: NIOSingleStepByteToMessageProcessor Public API
extension NIOSingleStepByteToMessageProcessor {
/// The number of bytes that are currently not processed by the ``process(buffer:_:)`` method. Having unprocessed
/// bytes may result from receiving only partial messages or from receiving multiple messages at once.
public var unprocessedBytes: Int {
self._buffer?.readableBytes ?? 0
}
/// Feed data into the `NIOSingleStepByteToMessageProcessor`
///
/// - parameters:

52
Tests/NIOCoreTests/SingleStepByteToMessageDecoderTest.swift
View File

@ -30,19 +30,6 @@ public final class NIOSingleStepByteToMessageDecoderTest: XCTestCase {
}
}
private final class ForeverDecoder: NIOSingleStepByteToMessageDecoder {
typealias InboundOut = Never
func decode(buffer: inout ByteBuffer) throws -> InboundOut? {
return nil
}
func decodeLast(buffer: inout ByteBuffer, seenEOF: Bool) throws -> InboundOut? {
XCTAssertTrue(seenEOF)
return try self.decode(buffer: &buffer)
}
}
private final class LargeChunkDecoder: NIOSingleStepByteToMessageDecoder {
typealias InboundOut = ByteBuffer
@ -227,14 +214,19 @@ public final class NIOSingleStepByteToMessageDecoderTest: XCTestCase {
var buffer = allocator.buffer(capacity: 16)
buffer.clear()
buffer.writeStaticString("1")
XCTAssertEqual(processor.unprocessedBytes, 0)
XCTAssertNoThrow(try processor.process(buffer: buffer, messageReceiver.receiveMessage))
XCTAssertEqual(processor.unprocessedBytes, 1)
buffer.clear()
buffer.writeStaticString("23")
XCTAssertNoThrow(try processor.process(buffer: buffer, messageReceiver.receiveMessage))
XCTAssertEqual(processor.unprocessedBytes, 1)
buffer.clear()
buffer.writeStaticString("4567890x")
XCTAssertNoThrow(try processor.process(buffer: buffer, messageReceiver.receiveMessage))
XCTAssertEqual(processor.unprocessedBytes, 1)
XCTAssertNoThrow(try processor.finishProcessing(seenEOF: false, messageReceiver.receiveMessage))
XCTAssertEqual(processor.unprocessedBytes, 1)
XCTAssertEqual("12", messageReceiver.retrieveMessage().map {
String(decoding: $0.readableBytesView, as: Unicode.UTF8.self)
@ -495,4 +487,38 @@ public final class NIOSingleStepByteToMessageDecoderTest: XCTestCase {
XCTAssertEqual(processor.decoder.reclaimHits, 1)
XCTAssertEqual(processor._buffer!.readableBytes, 1)
}
func testUnprocessedBytes() {
let allocator = ByteBufferAllocator()
let processor = NIOSingleStepByteToMessageProcessor(LargeChunkDecoder()) // reads slices of 512 bytes
let messageReceiver: MessageReceiver<ByteBuffer> = MessageReceiver()
// We're going to send in 128 bytes. This will be held.
var buffer = allocator.buffer(capacity: 128)
buffer.writeBytes(Array(repeating: 0x04, count: 128))
XCTAssertNoThrow(try processor.process(buffer: buffer, messageReceiver.receiveMessage))
XCTAssertEqual(0, messageReceiver.count)
XCTAssertEqual(processor.unprocessedBytes, 128)
// Adding 513 bytes, will cause a message to be returned and an extra byte to be saved.
buffer.clear()
buffer.writeBytes(Array(repeating: 0x04, count: 513))
XCTAssertNoThrow(try processor.process(buffer: buffer, messageReceiver.receiveMessage))
XCTAssertEqual(1, messageReceiver.count)
XCTAssertEqual(processor.unprocessedBytes, 129)
// Adding 255 bytes, will cause 255 more bytes to be held.
buffer.clear()
buffer.writeBytes(Array(repeating: 0x04, count: 255))
XCTAssertNoThrow(try processor.process(buffer: buffer, messageReceiver.receiveMessage))
XCTAssertEqual(1, messageReceiver.count)
XCTAssertEqual(processor.unprocessedBytes, 384)
// Adding 128 bytes, will cause another message to be returned and the buffer to be empty.
buffer.clear()
buffer.writeBytes(Array(repeating: 0x04, count: 128))
XCTAssertNoThrow(try processor.process(buffer: buffer, messageReceiver.receiveMessage))
XCTAssertEqual(2, messageReceiver.count)
XCTAssertEqual(processor.unprocessedBytes, 0)
}
}