diff --git a/src/Internal/Buffer/ByteBuffer.php b/src/Internal/Buffer/ByteBuffer.php index 468206e..2630bbb 100644 --- a/src/Internal/Buffer/ByteBuffer.php +++ b/src/Internal/Buffer/ByteBuffer.php @@ -4,24 +4,19 @@ namespace Thesis\Protobuf\Internal\Buffer; -use Thesis\Protobuf\Exception\BufferUnderflow; - /** + * An append-only output buffer. + * * @internal */ final class ByteBuffer implements WriteBuffer, - ReadBuffer, \Stringable { /** @var non-negative-int */ - private int $length; + private int $length = 0; - public function __construct( - private string $buffer = '', - ) { - $this->length = \strlen($this->buffer); - } + private string $buffer = ''; #[\Override] public function write(string $value): void @@ -30,35 +25,6 @@ public function write(string $value): void $this->length += \strlen($value); } - #[\Override] - public function peek(int $n): string - { - $value = substr($this->buffer, 0, $n); - if ($value === '') { - throw new BufferUnderflow('Buffer is empty.'); - } - - return $value; - } - - #[\Override] - public function read(int $n): string - { - if ($this->length < $n) { - throw new BufferUnderflow("Expected '{$n}' bytes, but the buffer only has '{$this->length}' bytes."); - } - - /** @var non-empty-string $buffer */ - $buffer = substr($this->buffer, 0, $n); - $this->buffer = substr($this->buffer, $n); - - /** @phpstan-ignore assign.propertyType */ - $this->length -= $n; - - return $buffer; - } - - #[\Override] public function flush(): string { $buffer = $this->buffer; diff --git a/src/Internal/Buffer/ReadBuffer.php b/src/Internal/Buffer/ReadBuffer.php index d301005..0e20d6d 100644 --- a/src/Internal/Buffer/ReadBuffer.php +++ b/src/Internal/Buffer/ReadBuffer.php @@ -31,5 +31,13 @@ public function peek(int $n): string; */ public function read(int $n): string; - public function flush(): string; + /** + * Limits the buffer to the next `length` bytes, e.g. to the body of a nested message: count() and reads + * see only them. Returns the previous limit to restore with popLimit() once they are read. + * + * @throws BufferUnderflow if fewer than `length` bytes are left + */ + public function pushLimit(int $length): int; + + public function popLimit(int $limit): void; } diff --git a/src/Internal/Buffer/Reader.php b/src/Internal/Buffer/Reader.php new file mode 100644 index 0000000..a61af6d --- /dev/null +++ b/src/Internal/Buffer/Reader.php @@ -0,0 +1,85 @@ +limit = \strlen($bytes); + } + + #[\Override] + public function peek(int $n): string + { + if ($this->offset >= $this->limit) { + throw new BufferUnderflow('Buffer is empty.'); + } + + /** @var non-empty-string */ + return substr($this->bytes, $this->offset, min($n, $this->limit - $this->offset)); + } + + #[\Override] + public function read(int $n): string + { + $available = $this->limit - $this->offset; + if ($available < $n) { + throw new BufferUnderflow("Expected '{$n}' bytes, but the buffer only has '{$available}' bytes."); + } + + /** @var non-empty-string $value */ + $value = substr($this->bytes, $this->offset, $n); + $this->offset += $n; + + return $value; + } + + #[\Override] + public function pushLimit(int $length): int + { + $available = $this->limit - $this->offset; + if ($length < 0 || $length > $available) { + throw new BufferUnderflow("Expected '{$length}' bytes, but the buffer only has '{$available}' bytes."); + } + + $limit = $this->limit; + $this->limit = $this->offset + $length; + + return $limit; + } + + #[\Override] + public function popLimit(int $limit): void + { + // A limit pushed later, or restored out of order, would lie behind the cursor or past the input. + \assert($limit >= $this->offset && $limit <= \strlen($this->bytes), 'Limits must be restored in reverse order.'); + + $this->limit = $limit; + } + + #[\Override] + public function count(): int + { + // The cursor never passes the limit: read() and pushLimit() check the bytes available. + /** @var non-negative-int */ + return $this->limit - $this->offset; + } +} diff --git a/src/Internal/Buffer/buffer.php b/src/Internal/Buffer/buffer.php index 0a2234d..c75e793 100644 --- a/src/Internal/Buffer/buffer.php +++ b/src/Internal/Buffer/buffer.php @@ -10,9 +10,11 @@ use Thesis\Protobuf\Internal\Wire; /** + * Writes the contents of `src` to `dst` as a length-delimited record. + * * @internal */ -function copy(ReadBuffer $src, WriteBuffer $dst): void +function copy(ByteBuffer $src, WriteBuffer $dst): void { $written = $src->flush(); SerdeVarint::T->serialize($dst, new Number(\strlen($written))); @@ -22,17 +24,13 @@ function copy(ReadBuffer $src, WriteBuffer $dst): void } /** + * Reads the length of a length-delimited record and limits the buffer to its body. + * * @internal + * @return int the previous limit, to restore with popLimit() once the body is read * @throws MalformedMessage */ -function slice(ReadBuffer $src): ReadBuffer +function enterRecord(ReadBuffer $buffer): int { - $dst = new ByteBuffer(); - $length = (int) Wire\readVarint($src)->value; - - if ($length > 0) { - $dst->write($src->read($length)); - } - - return $dst; + return $buffer->pushLimit((int) Wire\readVarint($buffer)->value); } diff --git a/src/Internal/Serde/DeserializeList.php b/src/Internal/Serde/DeserializeList.php index aeb9ea0..e2a1a91 100644 --- a/src/Internal/Serde/DeserializeList.php +++ b/src/Internal/Serde/DeserializeList.php @@ -31,11 +31,13 @@ public function deserialize(ReadBuffer $buffer): array $values = []; if ($this->isPacked) { - $buffer = Buffer\slice($buffer); + $limit = Buffer\enterRecord($buffer); while (\count($buffer) > 0) { $values[] = $this->deserializer->deserialize($buffer); } + + $buffer->popLimit($limit); } else { $values[] = $this->deserializer->deserialize($buffer); diff --git a/src/Internal/Serde/DeserializeMessage.php b/src/Internal/Serde/DeserializeMessage.php index ddd17e6..f46deea 100644 --- a/src/Internal/Serde/DeserializeMessage.php +++ b/src/Internal/Serde/DeserializeMessage.php @@ -26,7 +26,7 @@ public function __construct( #[\Override] public function deserialize(ReadBuffer $buffer): Message { - $buffer = Buffer\slice($buffer); + $limit = Buffer\enterRecord($buffer); /** @var list> $descriptors */ $descriptors = []; @@ -65,6 +65,8 @@ public function deserialize(ReadBuffer $buffer): Message ); } + $buffer->popLimit($limit); + return new Message($descriptors, $unknowns); } } diff --git a/src/Serializer.php b/src/Serializer.php index f0042ed..ac3eb69 100644 --- a/src/Serializer.php +++ b/src/Serializer.php @@ -6,6 +6,7 @@ use Thesis\Protobuf\Exception\MalformedMessage; use Thesis\Protobuf\Internal\Buffer\ByteBuffer; +use Thesis\Protobuf\Internal\Buffer\Reader; use Thesis\Protobuf\Internal\Serde\UnknownEnumValue; use Thesis\Protobuf\Internal\Wire; use Thesis\Protobuf\Type\MessageT; @@ -45,7 +46,7 @@ public function serialize(Message $message): string */ public function deserialize(MessageT $type, string $bytes): Message { - $buffer = new ByteBuffer($bytes); + $buffer = new Reader($bytes); /** @var list> $descriptors */ $descriptors = []; diff --git a/tests/BufferTest.php b/tests/BufferTest.php new file mode 100644 index 0000000..39913c7 --- /dev/null +++ b/tests/BufferTest.php @@ -0,0 +1,127 @@ +peek(2)); + self::assertCount(4, $buffer); + self::assertSame('test', $buffer->peek(5)); + self::assertCount(4, $buffer); + self::assertSame('test', $buffer->read(4)); + self::assertCount(0, $buffer); + } + + public function testPeekAtTheEndFails(): void + { + $buffer = new Reader('t'); + $buffer->read(1); + + $this->expectExceptionObject(new BufferUnderflow('Buffer is empty.')); + $buffer->peek(1); + } + + public function testReadMovesTheCursor(): void + { + $buffer = new Reader('test'); + self::assertSame('te', $buffer->read(2)); + self::assertSame('st', $buffer->read(2)); + + $this->expectExceptionObject(new BufferUnderflow("Expected '1' bytes, but the buffer only has '0' bytes.")); + $buffer->read(1); + } + + public function testLimitNarrowsAndRestoresTheBuffer(): void + { + $buffer = new Reader('abcdef'); + self::assertSame('a', $buffer->read(1)); + + $limit = $buffer->pushLimit(3); + self::assertCount(3, $buffer); + self::assertSame('bcd', $buffer->peek(10), 'peek stops at the limit'); + self::assertSame('bc', $buffer->read(2)); + + $inner = $buffer->pushLimit(1); + self::assertSame('d', $buffer->read(1)); + self::assertCount(0, $buffer); + $buffer->popLimit($inner); + self::assertCount(0, $buffer, 'the outer limit is reached too'); + + $buffer->popLimit($limit); + self::assertCount(2, $buffer); + self::assertSame('ef', $buffer->read(2)); + } + + public function testReadBeyondTheLimitFails(): void + { + $buffer = new Reader('abcdef'); + $buffer->pushLimit(2); + + $this->expectExceptionObject(new BufferUnderflow("Expected '3' bytes, but the buffer only has '2' bytes.")); + $buffer->read(3); + } + + public function testLimitBeyondTheEndFails(): void + { + $buffer = new Reader('abc'); + $buffer->read(1); + + $this->expectExceptionObject(new BufferUnderflow("Expected '3' bytes, but the buffer only has '2' bytes.")); + $buffer->pushLimit(3); + } + + public function testNegativeLimitFails(): void + { + $this->expectException(BufferUnderflow::class); + + new Reader('abc')->pushLimit(-1); + } + + public function testLimitsRestoredOutOfOrderAreCaught(): void + { + $buffer = new Reader('abcdef'); + $buffer->pushLimit(4); + $inner = $buffer->pushLimit(2); + $buffer->read(2); + $buffer->popLimit($inner); + $buffer->read(1); + + // The inner limit (2) is behind the cursor (3) now: restoring it again is a bug. + $this->expectException(\AssertionError::class); + $this->expectExceptionMessage('Limits must be restored in reverse order.'); + $buffer->popLimit(2); + } + + public function testLimitPastTheInputIsCaught(): void + { + $this->expectException(\AssertionError::class); + + new Reader('abc')->popLimit(4); + } + + public function testWriterAppendsAndFlushes(): void + { + $buffer = new ByteBuffer(); + $buffer->write('te'); + $buffer->write('st'); + self::assertCount(4, $buffer); + self::assertSame('test', (string) $buffer); + self::assertSame('test', $buffer->flush()); + self::assertCount(0, $buffer); + self::assertSame('', (string) $buffer); + } +} diff --git a/tests/ByteBufferTest.php b/tests/ByteBufferTest.php deleted file mode 100644 index e8a9a46..0000000 --- a/tests/ByteBufferTest.php +++ /dev/null @@ -1,43 +0,0 @@ -peek(2)); - self::assertCount(4, $buffer); - self::assertSame('test', $buffer->peek(5)); - self::assertCount(4, $buffer); - self::assertSame('test', $buffer->read(4)); - self::assertCount(0, $buffer); - } - - public function testRead(): void - { - $buffer = new ByteBuffer('test'); - self::assertSame('te', $buffer->read(2)); - self::assertSame('st', $buffer->read(2)); - self::expectException(BufferUnderflow::class); - $buffer->read(1); - } - - public function testFlush(): void - { - $buffer = new ByteBuffer('test'); - self::assertCount(4, $buffer); - self::assertSame('test', $buffer->flush()); - self::assertCount(0, $buffer); - } -} diff --git a/tests/ScalarCardinalityTest.php b/tests/ScalarCardinalityTest.php index 025a3bf..f143701 100644 --- a/tests/ScalarCardinalityTest.php +++ b/tests/ScalarCardinalityTest.php @@ -9,6 +9,7 @@ use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\TestCase; use Thesis\Protobuf\Internal\Buffer\ByteBuffer; +use Thesis\Protobuf\Internal\Buffer\Reader; use Thesis\Protobuf\Internal\Serde\SerdeBool; use Thesis\Protobuf\Internal\Serde\SerdeDouble; use Thesis\Protobuf\Internal\Serde\SerdeFixed32; @@ -47,7 +48,7 @@ final class ScalarCardinalityTest extends TestCase #[DataProvider('provideRoundTripCases')] public function testRoundTrip(ScalarTestData $data): void { - $buffer = new ByteBuffer((string) hex2bin($data->hex)); + $buffer = new Reader((string) hex2bin($data->hex)); $type = $data->value->type; $expected = $data->value->value; @@ -69,11 +70,12 @@ public function testRoundTrip(ScalarTestData $data): void self::assertCount(0, $buffer); + $output = new ByteBuffer(); $type ->accept(new TypeSerializerVisitor($tag)) ->without(SerializeTag::class) - ->serialize($buffer, $expected); - self::assertSame($data->hex, bin2hex((string) $buffer)); + ->serialize($output, $expected); + self::assertSame($data->hex, bin2hex((string) $output)); } /**