initial commit

Author: nekufa

.gitignore

@@ -0,0 +1,3 @@
+composer.lock
+composer.phar
+vendor

.travis.yml

@@ -0,0 +1,35 @@
+language: php
+
+sudo: required
+
+php:
+  - 7.4
+  - nightly
+  - master
+
+env:
+  - TARANTOOL_VERSION=1.10
+  - TARANTOOL_VERSION=2.0
+  - TARANTOOL_VERSION=2.1
+  - TARANTOOL_VERSION=2.2
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - php: nightly
+    - php: master
+
+services:
+  - docker
+
+before_script:
+  - docker run -d -p 3301:3301 progaudi/tarantool:$TARANTOOL_VERSION
+  - composer install --no-interaction --prefer-source --optimize-autoloader
+
+script: vendor/bin/phpunit
+
+after_script:
+  - if [[ -f coverage.clover ]]; then
+      curl -sSOL https://scrutinizer-ci.com/ocular.phar &&
+      php ocular.phar code-coverage:upload --format=php-clover coverage.clover;
+    fi

README.md

@@ -0,0 +1,108 @@
+# Tarantool symfony-lock
+[![License](https://poser.pugx.org/tarantool/symfony-lock/license.png)](https://packagist.org/packages/tarantool/symfony-lock)
+[![Build Status](https://travis-ci.org/tarantool-php/symfony-lock.svg?branch=master)](https://travis-ci.org/tarantool-php/symfony-lock)
+[![Latest Version](https://img.shields.io/github/release/tarantool-php/symfony-lock.svg?style=flat-square)](https://github.com/tarantool-php/symfony-lock/releases)
+[![Total Downloads](https://img.shields.io/packagist/dt/tarantool/symfony-lock.svg?style=flat-square)](https://packagist.org/packages/tarantool/symfony-lock)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/tarantool-php/symfony-lock/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/tarantool-php/symfony-lock/?branch=master)
+[![Code Coverage](https://scrutinizer-ci.com/g/tarantool-php/symfony-lock/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/tarantool-php/symfony-lock/?branch=master)
+
+# About
+
+The `TarantoolStore` implements symfony `PersistingStoreInterface` and persist locks using Tarantool Database.
+
+# Installation
+
+The recommended way to install the library is through [Composer](http://getcomposer.org):
+```
+$ composer require tarantool/symfony-lock
+```
+
+# Prepare Tarantool
+
+To start working on locking you need to create schema, the package contains schema manager that can be used for that. For additional documentation on client configuration see [tarantool/client repository](https://github.com/tarantool-php/client#creating-a-client).
+
+```php
+use Tarantool\Client\Client;
+use Tarantool\SymfonyLock\SchemaManager;
+
+$client = Client::fromDefaults();
+$schema = new SchemaManager($client);
+
+// create spaces and indexes
+$schema->setup();
+
+// later if you want to cleanup lock space, use
+$schema->tearDown();
+
+```
+
+# Using Store
+
+For additional examples on lock factory usage follow [symfony/lock docs](https://symfony.com/doc/current/components/lock.html) 
+
+```php
+use Symfony\Component\Lock\LockFactory;
+use Tarantool\Client\Client;
+use Tarantool\SymfonyLock\TarantoolStore;
+
+$client = Client::fromDefaults();
+$store = new TarantoolStore($client);
+$factory = new LockFactory($store);
+
+$lock = $factory->createLock('pdf-invoice-generation');
+
+if ($lock->acquire()) {
+    // The resource "pdf-invioce-generation" is locked.
+    // You can compute and generate invoice safely here.
+    $lock->release();
+}
+
+```
+
+# Expiration helper
+
+When key is expired it will be removed on acquiring new lock with same name. If your key names are not unique, you can use expiration daemon to cleanup your database.
+
+```php
+use Tarantool\Client\Client;
+use Tarantool\SymfonyLock\ExpirationDaemon;
+
+$client = Client::fromDefaults();
+$expiration = new ExpirationDaemon($client);
+
+// cleanup keys that are expired
+$expiration->process();
+
+// by default expiration daemon will clean upto 100 items
+// you can override it via optional configuration
+$expiration = new ExpirationDaemon($client, [
+    'limit' => 10,
+]);
+
+```
+
+# Customization
+ Out of the box all classes are using space named `lock`. If you want - you can override it via options configuration. All available options and default values are listed below:
+
+```php
+use Tarantool\Client\Client;
+use Tarantool\SymfonyLock\ExpirationDaemon;
+use Tarantool\SymfonyLock\SchemaManager;
+use Tarantool\SymfonyLock\TarantoolStore;
+
+$client = Client::fromDefaults();
+$expiration = new ExpirationDaemon($client, [
+    'space' => 'lock',
+    'limit' => '100',
+]);
+
+$schema = new SchemaManager($client, [
+    'engine' => 'memtx',
+    'space' => 'lock',
+]);
+
+$store = new TarantoolStore($client, [
+    'space' => 'lock',
+    'initialTtl' => 300,
+]);
+```

composer.json

@@ -0,0 +1,37 @@
+{
+    "name": "tarantool/symfony-lock",
+    "description": "Symfony lock Tarantool store",
+    "keywords": ["tarantool", "client", "pure", "nosql", "mapper"],
+    "type": "library",
+    "license": "MIT",
+    "require": {
+        "php": "^7.4",
+        "symfony/lock": "^5.0",
+        "tarantool/client": "^0.7"
+    },
+    "suggest": {
+        "ext-msgpack": "For using PeclPacker.",
+        "rybakit/msgpack": "For using PurePacker."
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^6.5.4",
+        "rybakit/msgpack": "^0.6.1"
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "": "tests"
+        },
+        "classmap": ["tests"]
+    },
+    "autoload": {
+        "psr-4": {
+            "Tarantool\\SymfonyLock\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Dmitry Krokhin",
+            "email": "[email protected]"
+        }
+    ]
+}

phpunit.xml.dist

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit backupGlobals="false"
+     backupStaticAttributes="false"
+     colors="true"
+     convertErrorsToExceptions="true"
+     convertNoticesToExceptions="true"
+     convertWarningsToExceptions="true"
+     processIsolation="false"
+     stopOnFailure="false"
+     syntaxCheck="false"
+     verbose="true"
+     bootstrap="./vendor/autoload.php"
+>
+    <php>
+        <env name="TARANTOOL_CONNECTION_HOST" value="127.0.0.1" />
+        <env name="TARANTOOL_CONNECTION_PORT" value="3301" />
+    </php>
+
+    <testsuites>
+        <testsuite name="Tests">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <logging>
+        <log type="coverage-clover" target="coverage.clover"/>
+    </logging>
+
+    <filter>
+        <whitelist>
+            <directory>src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/ExpirationDaemon.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Tarantool\SymfonyLock;
+
+use Tarantool\Client\Client;
+use InvalidArgumentException;
+
+class ExpirationDaemon
+{
+    use OptionalConstructor;
+
+    /**
+     * Dropped rows counter limit
+     */
+    protected int $limit = 100;
+
+    /**
+     * Space name
+     */
+    protected string $space = 'lock';
+
+    protected function validateOptions()
+    {
+        if ($this->limit <= 0) {
+            $message = sprintf(
+                'limit expects a strictly positive TTL. Got %d.',
+                $this->limit
+            );
+            throw new InvalidArgumentException($message);
+        }
+        if ($this->space == '') {
+            throw new InvalidArgumentException("Space should be defined");
+        }
+    }
+
+    public function process(): int
+    {
+        $script = <<<LUA
+        local limit, timestamp = ...
+        local counter = 0
+        box.begin()
+        box.space.$this->space.index.expire:pairs()
+            :take_while(function(tuple) return counter < limit end)
+            :take_while(function(tuple) return tuple.expire <= timestamp end)
+            :each(function(tuple)
+                box.space.$this->space:delete( tuple.key )
+                counter = counter + 1
+            end)
+        box.commit()
+        return counter
+        LUA;
+
+        [$counter] = $this->client->evaluate($script, $this->limit, microtime(true));
+
+        return $counter;
+    }
+}

src/OptionalConstructor.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Tarantool\SymfonyLock;
+
+use Tarantool\Client\Client;
+
+trait OptionalConstructor
+{
+    private Client $client;
+
+    public function __construct(Client $client, array $options = [])
+    {
+        foreach ($options as $k => $v) {
+            if (property_exists($this, $k)) {
+                $this->$k = $options[$k];
+            }
+        }
+
+        $this->client = $client;
+
+        $this->validateOptions();
+    }
+}

src/SchemaManager.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace Tarantool\SymfonyLock;
+
+use Tarantool\Client\Client;
+use InvalidArgumentException;
+
+class SchemaManager
+{
+    use OptionalConstructor;
+
+    /**
+     * what engine should be used
+     */
+    protected string $engine = 'memtx';
+
+    /**
+     * space name
+     */
+    protected string $space = 'lock';
+
+    public function validateOptions()
+    {
+        if ($this->engine == '') {
+            throw new InvalidArgumentException("Engine should be defined");
+        }
+        if ($this->space == '') {
+            throw new InvalidArgumentException("Space should be defined");
+        }
+    }
+    /**
+     * setup database schema
+     */
+    public function setup()
+    {
+        $this->client->evaluate('box.schema.create_space(...)', $this->space, [
+            'engine' => $this->engine,
+            'if_not_exists' => true,
+            'format' => [
+                [
+                    'name' => 'key',
+                    'type' => 'string',
+                ],
+                [
+                    'name' => 'token',
+                    'type' => 'string',
+                ],
+                [
+                    'name' => 'expire',
+                    'type' => 'number',
+                ],
+            ],
+        ]);
+
+        $this->client->call("box.space.{$this->space}:create_index", "key", [
+            'type' => 'hash',
+            'if_not_exists' => true,
+            'unique' => true,
+            'parts' => ['key'],
+        ]);
+
+        $this->client->call("box.space.{$this->space}:create_index", "token_key", [
+            'type' => 'hash',
+            'if_not_exists' => true,
+            'unique' => true,
+            'parts' => ['token', 'key'],
+        ]);
+
+        $this->client->call("box.space.{$this->space}:create_index", "expire", [
+            'type' => 'tree',
+            'if_not_exists' => true,
+            'unique' => false,
+            'parts' => ['expire'],
+        ]);
+    }
+
+    /**
+     * rollback lock store schema
+     */
+    public function tearDown()
+    {
+        $script = <<<LUA
+        if box.space.$this->space then
+            box.space.$this->space:drop()
+        end
+        LUA;
+
+        $this->client->evaluate($script);
+    }
+}