Improve search config usage.

pmatseykanets · pmatseykanets · commit 5153783c5c08 · 2017-01-15T18:11:22.000-05:00
Make sure that a search config can be set globbaly or per Model.
Fallback to the default config by using `get_current_ts_config()`.
Use prepared statements rather than interpolating query strings.
diff --git a/src/PostgresEngine.php b/src/PostgresEngine.php
@@ -109,21 +109,30 @@ protected function toVector(Model $model)
                 return $value === null ? '' : $value;
             });
 
-        $searchConfigString = $this->getSearchConfigString();
+        $bindings = collect([]);
 
-        $select = $fields->keys()
-            ->map(function ($key) use ($model, $searchConfigString) {
-                $vector = "to_tsvector($searchConfigString ?)";
-                if ($label = $this->rankFieldWeightLabel($model, $key)) {
-                    $vector = "setweight($vector, '$label')";
-                }
+        // The choices of parser, dictionaries and which types of tokens to index are determined
+        // by the selected text search configuration which can be set globally in config/scout.php
+        // file or individually for each model in searchableOptions()
+        // See https://www.postgresql.org/docs/current/static/textsearch-controls.html
+        $vector = "to_tsvector(COALESCE(?, get_current_ts_config()), ?)";
 
-                return $vector;
-            })->implode(' || ');
+        $select = $fields->map(function ($value, $key) use ($model, $vector, $bindings) {
+            $bindings->push($this->searchConfig($model) ?: null)
+                ->push($value);
+
+            // Set a field weight if it was specified in Model's searchableOptions()
+            if ($label = $this->rankFieldWeightLabel($model, $key)) {
+                $vector = "setweight($vector, ?)";
+                $bindings->push($label);
+            }
+
+            return $vector;
+        })->implode(' || ');
 
         return $this->database
             ->query()
-            ->selectRaw("$select AS tsvector", $fields->values()->all())
+            ->selectRaw("$select AS tsvector", $bindings->all())
             ->value('tsvector');
     }
 
@@ -209,12 +218,20 @@ protected function performSearch(Builder $builder, $perPage = 0, $page = 1)
 
         $indexColumn = $this->getIndexColumn($builder->model);
 
-        $searchConfigString = $this->getSearchConfigString();
+        $bindings = collect([]);
+
+        // The choices of parser, dictionaries and which types of tokens to index are determined
+        // by the selected text search configuration which can be set globally in config/scout.php
+        // file or individually for each model in searchableOptions()
+        // See https://www.postgresql.org/docs/current/static/textsearch-controls.html
+        $tsQuery = 'plainto_tsquery(COALESCE(?, get_current_ts_config()), ?) AS query';
+        $bindings->push($this->searchConfig($builder->model) ?: null)
+            ->push($builder->query);
 
         // Build the query
         $query = $this->database
             ->table($builder->index ?: $builder->model->searchableAs())
-            ->crossJoin($this->database->raw("plainto_tsquery($searchConfigString ?) query"))
+            ->crossJoin($this->database->raw($tsQuery))
             ->select($builder->model->getKeyName())
             ->selectRaw("{$this->rankingExpression($builder->model, $indexColumn)} AS rank")
             ->selectRaw('COUNT(*) OVER () AS total_count')
@@ -227,8 +244,7 @@ protected function performSearch(Builder $builder, $perPage = 0, $page = 1)
                 ->limit($perPage);
         }
 
-        $bindings = collect([$builder->query]);
-
+        // Transfer the where clauses that were set on the builder instance if any
         foreach ($builder->wheres as $key => $value) {
             $query->where($key, $value);
             $bindings->push($value);
@@ -461,15 +477,14 @@ protected function preserveModel(Model $model)
         $this->model = $model;
     }
 
-    protected function getSearchConfigString()
+    /**
+     * Returns a search config name for a model.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @return string
+     */
+    protected function searchConfig(Model $model)
     {
-        $searchConfig = $this->config('search_configuration');
-
-        $searchConfigString = '';
-        if ($searchConfig !== null) {
-            $searchConfigString = "'".$searchConfig."',";
-        }
-
-        return $searchConfigString;
+        return $this->option($model, 'config', $this->config('config', ''));
     }
 }
diff --git a/tests/PostgresEngineTest.php b/tests/PostgresEngineTest.php
@@ -26,7 +26,10 @@ public function test_update_adds_object_to_index()
         $db->shouldReceive('query')
             ->andReturn($query = Mockery::mock('stdClass'));
         $query->shouldReceive('selectRaw')
-            ->with("to_tsvector( ?) || setweight(to_tsvector( ?), 'B') AS tsvector", ['Foo', ''])
+            ->with(
+                "to_tsvector(COALESCE(?, get_current_ts_config()), ?) || setweight(to_tsvector(COALESCE(?, get_current_ts_config()), ?), ?) AS tsvector",
+                [null, 'Foo', null, '', 'B']
+            )
             ->andReturnSelf();
         $query->shouldReceive('value')
             ->with('tsvector')
@@ -88,34 +91,62 @@ public function test_search()
         $limit = 5;
         $table = $this->setDbExpectations($db, $skip, $limit);
 
+        $table->shouldReceive('skip')
+                ->with($skip)
+                ->andReturnSelf()
+            ->shouldReceive('limit')
+                ->with($limit)
+                ->andReturnSelf()
+            ->shouldReceive('where')
+                ->with('bar', 1);
+
+        $db->shouldReceive('select')
+            ->with(null, [null, 'foo', 1]);
+
+        $builder = new Builder(new TestModel(), 'foo');
+        $builder->where('bar', 1)->take(5);
+
+        $engine->search($builder);
+    }
+
+    public function test_search_with_global_config()
+    {
+        list($engine, $db) = $this->getEngine(['config' => 'simple']);
+
+        $skip = 0;
+        $limit = 5;
+        $table = $this->setDbExpectations($db);
+
         $table->shouldReceive('skip')->with($skip)->andReturnSelf()
             ->shouldReceive('limit')->with($limit)->andReturnSelf()
             ->shouldReceive('where')->with('bar', 1);
 
-        $db->shouldReceive('select')->with(null, ['foo', 1]);
+        $db->shouldReceive('select')->with(null, ['simple', 'foo', 1]);
 
         $builder = new Builder(new TestModel(), 'foo');
         $builder->where('bar', 1)->take(5);
 
         $engine->search($builder);
     }
 
-    public function test_search_configuration()
+    public function test_search_with_model_config()
     {
-        $searchConfig = 'simple';
-        list($engine, $db) = $this->getEngine(['search_configuration' => $searchConfig]);
+        list($engine, $db) = $this->getEngine(['config' => 'simple']);
 
         $skip = 0;
         $limit = 5;
-        $table = $this->setDbExpectations($db, $skip, $limit, "'".$searchConfig."',");
+        $table = $this->setDbExpectations($db);
 
         $table->shouldReceive('skip')->with($skip)->andReturnSelf()
             ->shouldReceive('limit')->with($limit)->andReturnSelf()
             ->shouldReceive('where')->with('bar', 1);
 
-        $db->shouldReceive('select')->with(null, ['foo', 1]);
+        $db->shouldReceive('select')->with(null, ['english', 'foo', 1]);
 
-        $builder = new Builder(new TestModel(), 'foo');
+        $model = new TestModel();
+        $model->searchableOptions['config'] = 'english';
+
+        $builder = new Builder($model, 'foo');
         $builder->where('bar', 1)->take(5);
 
         $engine->search($builder);
@@ -175,21 +206,34 @@ protected function getEngine($config = [])
         return [new PostgresEngine($resolver, $config), $db];
     }
 
-    protected function setDbExpectations($db, $skip = 0, $limit = 5, $searchConfiguration = '')
+    protected function setDbExpectations($db)
     {
         $db->shouldReceive('table')
             ->andReturn($table = Mockery::mock('stdClass'));
         $db->shouldReceive('raw')
-            ->with("plainto_tsquery($searchConfiguration ?) query")
-            ->andReturn("plainto_tsquery($searchConfiguration ?) query");
-
-        $table->shouldReceive('crossJoin')->with("plainto_tsquery($searchConfiguration ?) query")->andReturnSelf()
-            ->shouldReceive('select')->with('id')->andReturnSelf()
-            ->shouldReceive('selectRaw')->with('ts_rank(searchable,query) AS rank')->andReturnSelf()
-            ->shouldReceive('selectRaw')->with('COUNT(*) OVER () AS total_count')->andReturnSelf()
-            ->shouldReceive('whereRaw')->andReturnSelf()
-            ->shouldReceive('orderBy')->with('rank', 'desc')->andReturnSelf()
-            ->shouldReceive('orderBy')->with('id')->andReturnSelf()
+            ->with("plainto_tsquery(COALESCE(?, get_current_ts_config()), ?) AS query")
+            ->andReturn("plainto_tsquery(COALESCE(?, get_current_ts_config()), ?) AS query");
+
+        $table->shouldReceive('crossJoin')
+                ->with("plainto_tsquery(COALESCE(?, get_current_ts_config()), ?) AS query")
+                ->andReturnSelf()
+            ->shouldReceive('select')
+                ->with('id')
+                ->andReturnSelf()
+            ->shouldReceive('selectRaw')
+                ->with('ts_rank(searchable,query) AS rank')
+                ->andReturnSelf()
+            ->shouldReceive('selectRaw')
+                ->with('COUNT(*) OVER () AS total_count')
+                ->andReturnSelf()
+            ->shouldReceive('whereRaw')
+                ->andReturnSelf()
+            ->shouldReceive('orderBy')
+                ->with('rank', 'desc')
+                ->andReturnSelf()
+            ->shouldReceive('orderBy')
+                ->with('id')
+                ->andReturnSelf()
             ->shouldReceive('toSql');
 
         return $table;
@@ -200,17 +244,22 @@ class TestModel extends Model
 {
     public $id = 1;
 
-    public $text = 'Foo';
+//    public $text = 'Foo';
 
-    protected $searchableOptions = [
+    public $searchableOptions = [
         'rank' => [
             'fields' => [
                 'nullable' => 'B',
             ],
         ],
     ];
 
-    protected $searchableAdditionalArray = [];
+    public $searchableArray = [
+        'text' => 'Foo',
+        'nullable' => null,
+    ];
+
+    public $searchableAdditionalArray = [];
 
     public function searchableAs()
     {
@@ -234,10 +283,7 @@ public function getTable()
 
     public function toSearchableArray()
     {
-        return [
-            'text' => $this->text,
-            'nullable' => null,
-        ];
+        return $this->searchableArray;
     }
 
     public function searchableOptions()
