ensure model ID is URL-safe

Author: limenet

.gitignore

@@ -9,3 +9,4 @@ phpstan.neon
 testbench.yaml
 vendor
 node_modules
+.phpunit.cache/

src/Index/AbstractIndex.php

@@ -5,6 +5,7 @@
 namespace Limenet\LaravelElasticaBridge\Index;
 
 use Elastica\Document;
+use Elastica\Exception\InvalidException;
 use Elastica\Exception\NotFoundException;
 use Elastica\Index;
 use Elastica\Query;
@@ -89,14 +90,13 @@ public function documentResultToElements(ResultSet $result): array
 
     public function getModelInstance(Document $document): Model
     {
-        $id = $document->getId();
-
-        if (empty($id)) {
+        try {
+            $modelClass = $document->get(self::DOCUMENT_MODEL_CLASS);
+            $modelId = $document->get(self::DOCUMENT_MODEL_ID);
+        } catch(InvalidException) {
             throw new RuntimeException();
         }
 
-        [$modelClass,$modelId] = explode('|', $id);
-
         return $modelClass::findOrFail($modelId);
     }
 

src/Model/ElasticsearchableTrait.php

@@ -11,7 +11,11 @@ trait ElasticsearchableTrait
 {
     final public function getElasticsearchId(): string
     {
-        return $this::class.'|'.$this->id;
+        return str($this::class)
+            ->replace('\\', ' ')
+            ->snake()
+            ->append('-', $this->id)
+            ->toString();
     }
 
     public function toElasticsearch(IndexInterface $indexConfig): array

tests/Unit/IndexTest.php

@@ -9,6 +9,7 @@
 use Elastica\Response;
 use Elastica\ResultSet;
 use Limenet\LaravelElasticaBridge\Exception\Index\BlueGreenIndicesIncorrectlySetupException;
+use Limenet\LaravelElasticaBridge\Index\IndexInterface;
 use Limenet\LaravelElasticaBridge\Tests\App\Elasticsearch\CustomerIndex;
 use Limenet\LaravelElasticaBridge\Tests\App\Elasticsearch\ProductIndex;
 use Limenet\LaravelElasticaBridge\Tests\App\Models\Customer;
@@ -73,7 +74,7 @@ public function test_empty_document_to_model(): void
         /** @var Customer $customer */
         $customer = Customer::first();
         $document = $customer->toElasticaDocument($this->customerIndex);
-        $document->setId(null);
+        $document->remove(IndexInterface::DOCUMENT_MODEL_ID);
 
         $this->expectException(RuntimeException::class);
         $this->customerIndex->getModelInstance($document);

tests/Unit/ModelTest.php

@@ -37,8 +37,12 @@ public function test_convert_to_elastica_document_customized(): void
                 $this->assertSame($customer->email, $document->get('email'));
                 $this->assertSame($customer->type, $document->get('type'));
 
-                $this->assertStringContainsString('|'.$customer->id, $document->getId());
-                $this->assertStringContainsString($customer::class.'|', $document->getId());
+                $this->assertStringContainsString('-'.$customer->id, $document->getId());
+                $this->assertStringContainsString(
+                    str($customer::class)->classBasename()->lower()->append('-')->toString(),
+                    $document->getId()
+                );
+                $this->assertMatchesRegularExpression('/[\w\d_-]/', $document->getId());
 
                 $this->assertSame($customer->id, $document->get(IndexInterface::DOCUMENT_MODEL_ID));
                 $this->assertSame($customer::class, $document->get(IndexInterface::DOCUMENT_MODEL_CLASS));
@@ -55,8 +59,12 @@ public function test_convert_to_elastica_document_default(): void
 
                 $this->assertSame($product->name, $document->get('name'));
 
-                $this->assertStringContainsString('|'.$product->id, $document->getId());
-                $this->assertStringContainsString($product::class.'|', $document->getId());
+                $this->assertStringContainsString('-'.$product->id, $document->getId());
+                $this->assertStringContainsString(
+                    str($product::class)->classBasename()->lower()->append('-')->toString(),
+                    $document->getId()
+                );
+                $this->assertMatchesRegularExpression('/[\w\d_-]/', $document->getId());
 
                 $this->assertSame($product->id, $document->get(IndexInterface::DOCUMENT_MODEL_ID));
                 $this->assertSame($product::class, $document->get(IndexInterface::DOCUMENT_MODEL_CLASS));