create schema on demand

Author: nekufa

README.md

@@ -34,6 +34,12 @@ $schema->setup();
 // later if you want to cleanup lock space, use
 $schema->tearDown();
 
+// in addition you can configure TarantoolStore to create schema on demand
+// pay attention, this option is false by default
+$store = new TarantoolStore($client, [
+    'createSchema' => true,
+]);
+
 ```
 
 # Using Store
@@ -104,5 +110,6 @@ $schema = new SchemaManager($client, [
 $store = new TarantoolStore($client, [
     'space' => 'lock',
     'initialTtl' => 300,
+    'createSchema' => false,
 ]);
 ```

src/TarantoolStore.php

@@ -19,6 +19,11 @@ class TarantoolStore implements PersistingStoreInterface
     use OptionalConstructor;
     use ExpiringStoreTrait;
 
+    /**
+     * Initialize database schema if not exists
+     */
+    protected bool $createSchema = false;
+
     /**
      * Expiration delay of locks in seconds
      */
@@ -70,8 +75,7 @@ public function delete(Key $key, ?string $token = null)
      */
     public function exists(Key $key)
     {
-        $data = $this->client
-            ->getSpace($this->space)
+        $data = $this->getSpace()
             ->select(Criteria::key([ (string) $key ]));
 
         if (count($data)) {
@@ -114,8 +118,7 @@ public function save(Key $key)
             $this->getSpace()->insert($tuple);
             $this->checkNotExpired($key);
         } catch (RequestFailed $e) {
-            $data = $this->client
-                ->getSpace($this->space)
+            $data = $this->getSpace()
                 ->select(Criteria::key([ (string) $key ]));
 
             if (count($data)) {
@@ -153,6 +156,15 @@ protected function getExpirationTimestamp(Key $key): float
 
     protected function getSpace(): Space
     {
-        return $this->client->getSpace($this->space);
+        try {
+            return $this->client->getSpace($this->space);
+        } catch (RequestFailed $e) {
+            if ($this->createSchema) {
+                $schema = new SchemaManager($this->client, [ 'space' => $this->space ]);
+                $schema->setup();
+                return $this->client->getSpace($this->space);
+            }
+            throw $e;
+        }
     }
 }

tests/TarantoolStoreTest.php

@@ -9,6 +9,7 @@
 use Symfony\Component\Lock\Key;
 use Symfony\Component\Lock\PersistingStoreInterface;
 use Tarantool\Client\Client;
+use Tarantool\Client\Exception\RequestFailed;
 use Tarantool\Client\Schema\Criteria;
 use Tarantool\SymfonyLock\Cleaner;
 use Tarantool\SymfonyLock\SchemaManager;
@@ -238,4 +239,40 @@ public function testStoreInvalidSpaceName()
 
         new TarantoolStore(Client::fromDefaults(), [ 'space' => '' ]);
     }
+
+    public function testSuccessSchemaCreation()
+    {
+        $host = getenv('TARANTOOL_CONNECTION_HOST');
+        $port = getenv('TARANTOOL_CONNECTION_PORT');
+
+        $client = Client::fromDsn("tcp://$host:$port");
+        $client->evaluate('box.session.su("admin")');
+
+        $schema = new SchemaManager($client);
+        $schema->tearDown();
+
+        $store = new TarantoolStore($client, [ 'createSchema' => true ]);
+        $store->save(new Key(uniqid(__METHOD__, true)));
+
+        $tuples = $this->client->getSpace('lock')->select(Criteria::key([]));
+        $this->assertCount(1, $tuples);
+    }
+
+    public function testDefaultSchemaCreationIsDisabled()
+    {
+        $host = getenv('TARANTOOL_CONNECTION_HOST');
+        $port = getenv('TARANTOOL_CONNECTION_PORT');
+
+        $client = Client::fromDsn("tcp://$host:$port");
+        $client->evaluate('box.session.su("admin")');
+
+        $schema = new SchemaManager($client);
+        $schema->tearDown();
+
+        $this->expectException(RequestFailed::class);
+        $this->expectExceptionMessage("Space 'lock' does not exist");
+
+        $store = new TarantoolStore($client);
+        $store->save(new Key(uniqid(__METHOD__, true)));
+    }
 }