Add MsgPack serializer support

Author: cracksalad

README.md

@@ -26,6 +26,7 @@ There are pretty much no dependencies with some exceptions:
 
 - If you want to use the `toJSONFile()` method, you need to install `ext-json` (PHP's PECL JSON extension) as well.
 - If you want to use the igbinary serializer, `ext-igbinary` is required. See [php-ext-igbinary](https://github.com/igbinary/igbinary).
+- If you want to use the msgpack serializer, `ext-msgpack` is required. See [php-ext-msgpack](https://github.com/msgpack/msgpack-php).
 - If you want to use LZ4 compression, `ext-lz4` is required. See [php-ext-lz4](https://github.com/kjdev/php-ext-lz4).
 
 ## Usage
@@ -55,9 +56,9 @@ The constructor of `LargeArrayBuffer` provides some options:
 
 1. You can set the threshold when to move the data to disk. When pushing data to the buffer, it is stored in memory until it gets too large.
     E.g.: `new LargeArrayBuffer(512);` to set a 512 MiB threshold. 
-1. You can choose either the PHP serializer or the [igbinary](https://github.com/igbinary/igbinary) serializer (PHP serializer is default).
+1. You can choose either the PHP serializer, the [igbinary](https://github.com/igbinary/igbinary) serializer or the [msgpack](https://github.com/msgpack/msgpack-php) serializer (PHP serializer is default).
     E.g.: `new LargeArrayBuffer(serializer: LargeArrayBuffer::COMPRESSION_IGBINARY);`
-1. You can enable GZIP or LZ4 compression for the serialized items. Although this is recommended only if your items are pretty big like > 1 KiB each. E.g.: `new LargeArrayBuffer(compression: LargeArrayBuffer::COMPRESSION_GZIP);`. Note, that LZ4 compression requires [ext-lz4](https://github.com/kjdev/php-ext-lz4) to be installed.
+1. You can enable GZIP or LZ4 compression for the serialized items. Although this is recommended only if your items are pretty big like > 1 KiB each. E.g.: `new LargeArrayBuffer(compression: LargeArrayBuffer::COMPRESSION_GZIP);`. Note, that LZ4 compression requires [ext-lz4](https://github.com/kjdev/php-ext-lz4) to be loaded.
 
 ### Read from the buffer
 

composer.json

@@ -14,7 +14,8 @@
     "suggest": {
         "ext-json": "Requirement of toJSONFile() method",
         "ext-lz4": "To enable support of LZ4 compression",
-        "ext-igbinary": "To enable support for igbinary serializer"
+        "ext-igbinary": "To enable support for igbinary serializer",
+        "ext-msgpack": "To enable support for msgpack serializer"
     },
     "require": {
         "php": ">=8.0"

src/LargeArrayBuffer.php

@@ -12,6 +12,7 @@ class LargeArrayBuffer implements ArrayBufferInterface {
 
   public const SERIALIZER_PHP = 1;
   public const SERIALIZER_IGBINARY = 2;
+  public const SERIALIZER_MSGPACK = 3;
 
   public const COMPRESSION_NONE = 0;
   public const COMPRESSION_GZIP = 1;
@@ -57,13 +58,16 @@ class LargeArrayBuffer implements ArrayBufferInterface {
    */
   public function __construct(int $maxMemoryMiB = 1024, int $serializer = self::SERIALIZER_PHP, int $compression = self::COMPRESSION_NONE) {
     $this->serializer = $serializer;
-    if($this->serializer === self::SERIALIZER_IGBINARY && !function_exists('igbinary_serialize')){
-      throw new \InvalidArgumentException('igbinary serializer was requested, but ext-igbinary is not installed');
+    if($this->serializer === self::SERIALIZER_IGBINARY && !extension_loaded('igbinary')){
+      throw new \InvalidArgumentException('igbinary serializer was requested, but ext-igbinary is not loaded');
+    }
+    if($this->serializer === self::SERIALIZER_MSGPACK && !extension_loaded('msgpack')){
+      throw new \InvalidArgumentException('msgpack serializer was requested, but ext-msgpack is not loaded');
     }
 
     $this->compression = $compression;
-    if($this->compression === self::COMPRESSION_LZ4 && !function_exists('lz4_compress')){
-      throw new \InvalidArgumentException('LZ4 compression was requested, but ext-lz4 is not installed');
+    if($this->compression === self::COMPRESSION_LZ4 && !extension_loaded('lz4')){
+      throw new \InvalidArgumentException('LZ4 compression was requested, but ext-lz4 is not loaded');
     }
 
     $stream = fopen('php://temp/maxmemory:'.($maxMemoryMiB * 1024 * 1024), 'r+');
@@ -80,6 +84,7 @@ public function __construct(int $maxMemoryMiB = 1024, int $serializer = self::SE
   public function push(mixed $item): void {
     $serialized = match($this->serializer){
       self::SERIALIZER_IGBINARY => igbinary_serialize($item),
+      self::SERIALIZER_MSGPACK => msgpack_serialize($item),
       default => serialize($item)
     };
     /** @var string|false $compressed */
@@ -145,6 +150,7 @@ public function current(): mixed {
     /** @psalm-var E $res */
     $res = match($this->serializer){
       self::SERIALIZER_IGBINARY => igbinary_unserialize($this->current),
+      self::SERIALIZER_MSGPACK => msgpack_unserialize($this->current),
       default => unserialize($this->current)
     };
     return $res;

test/LargeArrayBufferTest.php

@@ -5,6 +5,7 @@
 
 use LargeArrayBuffer\LargeArrayBuffer;
 use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 /**
  * @author Andreas Wahlen
@@ -31,52 +32,44 @@ public function testEmpty(): void {
     $this->assertEquals(0, $runs);
   }
 
-  public static function provideObject(): array {
-    $o = self::getObject();
-    return [
-      [$o, LargeArrayBuffer::SERIALIZER_PHP, LargeArrayBuffer::COMPRESSION_NONE],
-      [$o, LargeArrayBuffer::SERIALIZER_PHP, LargeArrayBuffer::COMPRESSION_GZIP],
+  public static function provideConfig(): \Generator {
+    $serializers = [
+      'PHP' => LargeArrayBuffer::SERIALIZER_PHP
     ];
+    if(extension_loaded('igbinary')){
+      $serializers['IGBinary'] = LargeArrayBuffer::SERIALIZER_IGBINARY;
+    }
+    if(extension_loaded('msgpack')){
+      $serializers['MsgPack'] = LargeArrayBuffer::SERIALIZER_MSGPACK;
+    }
+    $compressors = [
+      'none' => LargeArrayBuffer::COMPRESSION_NONE,
+      'GZIP' => LargeArrayBuffer::COMPRESSION_GZIP
+    ];
+    if(extension_loaded('lz4')){
+      $compressors['LZ4'] = LargeArrayBuffer::COMPRESSION_LZ4;
+    }
+    foreach($serializers as $s => $serializer){
+      foreach($compressors as $c => $compressor){
+        yield $s.'-'.$c => [$serializer, $compressor];
+      }
+    }
   }
 
-  /**
-   * @dataProvider provideObject
-   */
-  public function testReadWrite(object $o, int $serializer, int $compression): void {
-    $buf = new LargeArrayBuffer(serializer: $serializer, compression: $compression);
-    $buf->push($o);
-    $buf->rewind();
-    $buf->next();
-    $this->assertEquals($o, $buf->current());
-  }
-  
-  /**
-   * @requires extension igbinary
-   */
-  public function testReadWriteIgbinary(): void {
-    $o = self::getObject();
-    $buf = new LargeArrayBuffer(serializer: LargeArrayBuffer::SERIALIZER_IGBINARY);
-    $buf->push($o);
-    $buf->rewind();
-    $buf->next();
-    $this->assertEquals($o, $buf->current());
-  }
-  
-  /**
-   * @requires extension lz4
-   */
-  public function testReadWriteLZ4(): void {
+  #[DataProvider('provideConfig')]
+  public function testReadWrite(int $serializer, int $compression): void {
     $o = self::getObject();
-    $buf = new LargeArrayBuffer(compression: LargeArrayBuffer::COMPRESSION_LZ4);
+    $buf = new LargeArrayBuffer(serializer: $serializer, compression: $compression);
     $buf->push($o);
     $buf->rewind();
     $buf->next();
     $this->assertEquals($o, $buf->current());
   }
 
-  public function testLoop(): void {
-    $count = 15;
-    $buf = new LargeArrayBuffer();
+  #[DataProvider('provideConfig')]
+  public function testLoop(int $serializer, int $compression): void {
+    $count = 1500;
+    $buf = new LargeArrayBuffer(serializer: $serializer, compression: $compression);
     $objs = [];
     for($i=0;$i<$count;$i++){
       $o = new \stdClass();
@@ -85,22 +78,18 @@ public function testLoop(): void {
       $buf->push($o);
     }
     $this->assertCount($count, $buf);
-    $runs = 0;
+    $expIdx = 0;
     foreach($buf as $idx => $item){
-      $runs++;
-      $this->assertGreaterThanOrEqual(0, $idx);
-      $this->assertLessThan($count, $idx);
+      $this->assertEquals($expIdx, $idx);
+      $this->assertEquals($item->idx, $idx);
       $this->assertEquals($objs[$idx], $item);
+      $expIdx++;
     }
-    $this->assertEquals($count, $runs);
+    $this->assertEquals($count, $expIdx);
   }
 
   public function testToJSON(): void {
-    $o = new \stdClass();
-    $o->foo = 'hello world!'.PHP_EOL;
-    $o->bar = new \DateTimeImmutable();
-    $o->a = ['test', 123];
-    $o->str = 'hello world!\\n';
+    $o = self::getObject();
 
     $buf = new LargeArrayBuffer();
     $buf->push($o);