Merge pull request #3 from asanikovich/v1.1

add serializers and encryption

Author: asanikovich

.dockerignore

@@ -0,0 +1,6 @@
+/vendor
+.DS_Store
+/composer.lock
+/.github
+/.idea
+/.git

.github/workflows/tests.yml

@@ -30,7 +30,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          extensions: dom, curl, libxml, mbstring, zip
+          extensions: dom, curl, libxml, mbstring, zip, igbinary, sodium
           tools: composer:v2
           coverage: xdebug
 

Dockerfile

@@ -1,30 +1,42 @@
 FROM php:8.2-cli-alpine3.17 as backend
 
 RUN --mount=type=bind,from=mlocati/php-extension-installer:1.5,source=/usr/bin/install-php-extensions,target=/usr/local/bin/install-php-extensions \
-     install-php-extensions opcache zip xsl dom exif intl pcntl bcmath sockets && \
+     install-php-extensions opcache zip xsl dom exif intl pcntl bcmath sockets igbinary sodium && \
      apk del --no-cache ${PHPIZE_DEPS} ${BUILD_DEPENDS}
 
+RUN apk add --no-cache --virtual .build-deps $PHPIZE_DEPS && \
+    apk add --update linux-headers && \
+    pecl install xdebug && \
+    docker-php-ext-enable xdebug && \
+    apk del -f .build-deps
+
 ENV COMPOSER_ALLOW_SUPERUSER=1
 COPY --from=composer:2.3 /usr/bin/composer /usr/bin/composer
 
-WORKDIR /app/laravel
+WORKDIR /app/lib
 
-COPY composer.json /app/composer.json
-COPY src /app/src
-COPY config /app/config
+COPY composer.json composer.json
+COPY src src
+COPY config config
+
+WORKDIR /app/laravel
 
 RUN composer create-project laravel/laravel /app/laravel
-RUN composer config repositories.laravel-roadrunner-cache path ../. && composer config minimum-stability dev
+RUN composer config repositories.laravel-roadrunner-cache path /app/lib && composer config minimum-stability dev
 RUN composer require asanikovich/laravel-roadrunner-cache spiral/roadrunner-cli spiral/roadrunner-http laravel/octane
 RUN composer install --optimize-autoloader --no-dev
 RUN php artisan vendor:publish --tag="laravel-roadrunner-cache-config"
 
-COPY .rr.yaml ./.rr.yaml
+COPY .rr.yaml .rr.yaml
+COPY --from=ghcr.io/roadrunner-server/roadrunner:2023.1.1 /usr/bin/rr .
+
+WORKDIR /app/php
 
-COPY --from=ghcr.io/roadrunner-server/roadrunner:2023.1.1 /usr/bin/rr /app/laravel
+COPY . .
+RUN composer install --optimize-autoloader
 
 EXPOSE 8080/tcp
 EXPOSE 6001/tcp
 
 # Run RoadRunner server
-CMD ls -al config && ./rr serve -c .rr.yaml -o http.address=0.0.0.0:8080 -o rpc.listen='tcp://0.0.0.0:6001'
+CMD ["sh", "-c", "APP_BASE_PATH=/app/laravel /app/laravel/rr serve -c .rr.yaml -o http.address=0.0.0.0:8080 -o rpc.listen='tcp://0.0.0.0:6001'"]

README.md

@@ -22,9 +22,11 @@ composer require asanikovich/laravel-roadrunner-cache
 
 ### Configuration
 
-Make sure you have in your RoadRunner config file (.rr.yaml) next sections:
-- RPC section 
-- KV section
+#### Configuration RoadRunner
+
+Make sure you have in your RoadRunner config file (`.rr.yaml`) next sections:
+- `RPC` section 
+- `KV` section
 
 Full example of RoadRunner configuration file:
 ```yaml
@@ -48,31 +50,73 @@ kv:
             interval: 1
 ```
 
+#### Publish config
 Publish the config file and setup RPC connection:
 
 ```bash
 php artisan vendor:publish --tag="laravel-roadrunner-cache-config"
 ```
 
-Add to cache configuration file (/config/cache.php) new store with driver 'roadrunner': 
+#### Serializers
+
+Package supports next serializers (should be configured in `store` config):
+- `null` - default php `serializer`
+- `igbinary` - igbinary serializer, `ext-igbinary` is required to be installed
+
+#### Encryption
+
+Package supports encryption with `sodium`, requirements:
+- `ext-sodium` required to be installed 
+- `encryption_key` filled  in `store` config (generated by `sodium_crypto_box_keypair()`)
+
+#### Setup cache config file 
+
+Add to cache configuration file (`/config/cache.php`) new store with driver `roadrunner`: 
+
+#### Config file example
 ```php
 <?php
+return [
     'default' => 'rr-memory', // Default store (optional)
 
     'stores' => [
-        'rr-memory' => [ // Your custom store name
+        'rr-memory' => [ // Custom store name with "memory" connection 
             'driver' => 'roadrunner',
-            // section name from KV plugin settings in RoadRunner config file (.rr.yaml)
-            'connection' => 'memory',
+            'connection' => 'memory', // section name from KV plugin settings in RoadRunner config file (.rr.yaml)
+            'serializer' => null, // Available options: null|igbinary
+            'encryption_key' => null, // Available options: null|string
         ],
-        'rr-boltdb' => [ // Your custom store name (another store is optional)
+        'rr-boltdb' => [ // Custom store name with "boltdb" connection (another store is optional)
             'driver' => 'roadrunner',
-            // section name from KV plugin settings in RoadRunner config file (.rr.yaml)
-            'connection' => 'boltdb',
+            'connection' => 'boltdb', // section name from KV plugin settings in RoadRunner config file (.rr.yaml)
+            'serializer' => null, // Available options: null|igbinary
+            'encryption_key' => null, // Available options: null|string
+            'prefix' => 'custom', // Custom prefix - non-empty-string
+        ],
+        'rr-memory-igbinary' => [ // Custom store name with "memory" connection and "igbinary" serializer
+            'driver' => 'roadrunner',
+            'connection' => 'memory', // section name from KV plugin settings in RoadRunner config file (.rr.yaml)
+            'serializer' => 'igbinary', // Available options: null|igbinary
+            'encryption_key' => null, // Available options: null|string
+        ],
+        'rr-memory-igbinary-encrypted' => [ // Custom store name with "memory" connection and encrypted "igbinary" serializer
+            'driver' => 'roadrunner',
+            'connection' => 'memory', // section name from KV plugin settings in RoadRunner config file (.rr.yaml)
+            'serializer' => 'igbinary', // Available options: null|igbinary
+            'encryption_key' => 'key1', // Available options: null|string
+        ],
+         'rr-memory-encrypted' => [ // Custom store name with "memory" connection and encrypted serializer
+            'driver' => 'roadrunner',
+            'connection' => 'memory', // section name from KV plugin settings in RoadRunner config file (.rr.yaml)
+            'serializer' => null, // Available options: null|igbinary
+            'encryption_key' => 'key2', // Available options: null|string
         ],
     ],
+]
 ```
 
+### Usage
+
 To use in your code:
 ```php
 <?php

composer.json

@@ -21,7 +21,8 @@
         "orchestra/testbench": "^8.0"
     },
     "suggest": {
-        "ext-igbinary": "(>3.1.6) Igbinary serailizer support"
+        "ext-igbinary": "(>3.1.6) Igbinary serailizer support",
+        "ext-sodium": "Sodium encryption support"
     },
     "autoload": {
         "psr-4": {
@@ -35,8 +36,8 @@
     },
     "scripts": {
         "phpstan": "vendor/bin/phpstan analyse --memory-limit=2G",
-        "test": "vendor/bin/phpunit",
-        "test-coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit",
+        "test": "docker-compose exec rr /bin/sh -c 'vendor/bin/phpunit'",
+        "test-coverage": "docker-compose exec rr /bin/sh -c 'XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-text'",
         "format": "vendor/bin/pint"
     },
     "config": {

docker-compose.yml

@@ -7,5 +7,4 @@ services:
       - "8080:8080"
       - "6001:6001"
     environment:
-      APP_BASE_PATH: /app/laravel
       LARAVEL_OCTANE: 1

phpunit.xml

@@ -15,18 +15,12 @@
     <coverage>
         <report>
             <html outputDirectory="build/coverage"/>
-            <text outputFile="build/coverage.txt"/>
             <clover outputFile="build/logs/clover.xml"/>
         </report>
     </coverage>
     <logging>
         <junit outputFile="build/report.junit.xml"/>
     </logging>
-    <php>
-        <env name="DB_DATABASE" value="laravel"/>
-        <env name="DB_HOST" value="127.0.0.1"/>
-        <env name="DB_USERNAME" value="root"/>
-    </php>
     <source>
         <include>
             <directory suffix=".php">./src</directory>

src/RoadRunnerFactory.php

@@ -7,6 +7,9 @@
 use Spiral\Goridge\RPC\RPC;
 use Spiral\Goridge\RPC\RPCInterface;
 use Spiral\RoadRunner\KeyValue\Factory;
+use Spiral\RoadRunner\KeyValue\Serializer\DefaultSerializer;
+use Spiral\RoadRunner\KeyValue\Serializer\IgbinarySerializer;
+use Spiral\RoadRunner\KeyValue\Serializer\SodiumSerializer;
 
 class RoadRunnerFactory
 {
@@ -21,7 +24,18 @@ public static function createRPC(): RPCInterface
      */
     public static function createLaravelCacheStore(RPCInterface $rpc, array $config): RoadRunnerCacheStore
     {
-        $storage = (new Factory($rpc))->select($config['connection']);
+        if (($config['serializer'] ?? null) === 'igbinary') {
+            $serializer = new IgbinarySerializer();
+        } else {
+            $serializer = new DefaultSerializer();
+        }
+
+        $encryptionKey = $config['encryption_key'] ?? null;
+        if ($encryptionKey !== null) {
+            $serializer = new SodiumSerializer($serializer, $encryptionKey);
+        }
+
+        $storage = (new Factory($rpc, $serializer))->select($config['connection']);
 
         /** @phpstan-ignore-next-line  */
         return new RoadRunnerCacheStore($storage, $config['prefix'] ?? config('cache.prefix', ''));