Search implementation overhaul

app/Http/Controllers/BeatmapsetsController.php

@@ -21,6 +21,8 @@
 namespace App\Http\Controllers;
 
 use App\Jobs\NotifyBeatmapsetUpdate;
+use App\Libraries\Search\BeatmapsetSearch;
+use App\Libraries\Search\BeatmapsetSearchRequestParams;
 use App\Models\Beatmap;
 use App\Models\BeatmapDownload;
 use App\Models\BeatmapMirror;
@@ -43,11 +45,8 @@ public function index()
     {
         $languages = Language::listing();
         $genres = Genre::listing();
-        $beatmaps = json_collection(
-            Beatmapset::search($this->searchParams())['data'],
-            new BeatmapsetTransformer,
-            'beatmaps'
-        );
+
+        $beatmaps = $this->search();
 
         // temporarily put filters here
         $general = [
@@ -133,13 +132,24 @@ public function show($id)
 
     public function search()
     {
-        $user = Auth::user();
+        $params = new BeatmapsetSearchRequestParams(request(), Auth::user());
 
-        $params = $this->searchParams();
-        $beatmaps = Beatmapset::search($params)['data'];
+        $records = datadog_timing(function () use ($params) {
+            $ids = $params->fetchCacheable(
+                'search-cache:',
+                config('osu.beatmapset.es_cache_duration'),
+                function () use ($params) {
+                    $search = (new BeatmapsetSearch($params))->source('_id');
+
+                    return $search->response()->ids();
+                }
+            );
+
+            return Beatmapset::whereIn('beatmapset_id', $ids)->orderByField('beatmapset_id', $ids)->get();
+        }, config('datadog-helper.prefix_web').'.search', ['type' => 'beatmapset']);
 
         return json_collection(
-            $beatmaps,
+            $records,
             new BeatmapsetTransformer,
             'beatmaps'
         );
@@ -270,34 +280,4 @@ public function updateFavourite($id)
           'favourited' => $user->fresh()->hasFavourited($beatmapset),
         ];
     }
-
-    private function searchParams()
-    {
-        $user = Auth::user();
-
-        if ($user === null) {
-            $params = [
-                'page' => Request::input('page'),
-            ];
-        } else {
-            $params = [
-                'general' => Request::input('c'),
-                'query' => Request::input('q'),
-                'mode' => Request::input('m'),
-                'status' => Request::input('s'),
-                'genre' => Request::input('g'),
-                'language' => Request::input('l'),
-                'extra' => Request::input('e'),
-                'page' => Request::input('page'),
-                'sort' => Request::input('sort'),
-                'user' => $user,
-            ];
-
-            if ($user->isSupporter()) {
-                $params['rank'] = Request::input('r');
-            }
-        }
-
-        return $params;
-    }
 }

app/Http/Controllers/HomeController.php

@@ -22,7 +22,7 @@
 
 use App;
 use App\Libraries\CurrentStats;
-use App\Libraries\Search;
+use App\Libraries\Search\AllSearch;
 use App\Models\BeatmapDownload;
 use App\Models\Beatmapset;
 use App\Models\Forum\Post;
@@ -43,7 +43,6 @@ public function __construct()
             'only' => [
                 'downloadQuotaCheck',
                 'search',
-                'quickSearch',
             ],
         ]);
 
@@ -121,38 +120,16 @@ public function osuSupportPopup()
         return view('objects._popup_support_osu');
     }
 
-    public function quickSearch()
-    {
-        $search = new Search([
-            'query' => Request::input('query'),
-            'limit' => 5,
-        ]);
-
-        if (!$search->hasQuery()) {
-            return response([], 204);
-        }
-
-        return view('home.nav_search_result', compact('search'));
-    }
-
     public function search()
     {
         if (request('mode') === 'beatmapset') {
-            return ujs_redirect(route('beatmapsets.index', ['q' => Request::input('query')]));
+            return ujs_redirect(route('beatmapsets.index', ['q' => request('query')]));
         }
 
-        $params = array_merge(Request::all(), [
-            'user' => Auth::user(),
-        ]);
-
-        $search = new Search($params);
+        $allSearch = new AllSearch(request(), ['user' => Auth::user()]);
         $isSearchPage = true;
 
-        if ($search->mode === Search::DEFAULT_MODE) {
-            $search->params['limit'] = 8;
-        }
-
-        return view('home.search', compact('search', 'isSearchPage'));
+        return view('home.search', compact('allSearch', 'isSearchPage'));
     }
 
     public function setLocale()

app/Http/Controllers/UsersController.php

@@ -20,7 +20,8 @@
 
 namespace App\Http\Controllers;
 
-use App\Libraries\PostSearch;
+use App\Libraries\Search\PostSearch;
+use App\Libraries\Search\PostSearchRequestParams;
 use App\Libraries\UserRegistration;
 use App\Models\Achievement;
 use App\Models\Beatmap;
@@ -34,6 +35,7 @@
 use App\Models\User;
 use App\Models\UserNotFound;
 use Auth;
+use Illuminate\Pagination\LengthAwarePaginator;
 use Request;
 
 class UsersController extends Controller
@@ -216,17 +218,11 @@ public function posts($id)
             abort(404);
         }
 
-        $options = [
-            'query' => trim(request('query')),
-            'userId' => $user->getKey(),
-            'forumId' => request('forum_id'),
-            'includeSubforums' => get_bool(request('forum_children')),
-        ];
-
-        $search = new PostSearch($options);
-        $page = $search->paginate(50)->appends(request()->query());
+        $search = (new PostSearch(new PostSearchRequestParams(request(), $user)))
+            ->size(50)
+            ->page(LengthAwarePaginator::resolveCurrentPage());
 
-        return view('users.posts', compact('search', 'page', 'user'));
+        return view('users.posts', compact('search', 'user'));
     }
 
     public function kudosu($_userId)

app/Libraries/Elasticsearch/HasChildQuery.php

@@ -57,7 +57,9 @@ public function toArray() : array
             'name' => $this->name,
             'from' => $pageParams['from'],
             'size' => $pageParams['size'],
-            'sort' => $this->sort,
+            'sort' => array_map(function ($sort) {
+                return $sort->toArray();
+            }, $this->sorts),
         ];
 
         if (isset($this->highlight)) {

app/Libraries/Elasticsearch/HasSearch.php

@@ -25,8 +25,8 @@ trait HasSearch
     protected $from;
     protected $highlight;
     protected $query;
-    protected $size = 10;
-    protected $sort = [];
+    protected $size;
+    protected $sorts = [];
     protected $source;
     protected $type;
 
@@ -53,7 +53,7 @@ public function limit(?int $limit)
      */
     public function size(?int $size)
     {
-        $this->size = clamp($size ?? 50, 1, 50);
+        $this->size = $size;
 
         return $this;
     }
@@ -68,26 +68,6 @@ public function page(?int $page)
         return $this;
     }
 
-    /**
-     * page is not returned if using offset query.
-     *
-     * @return array
-     */
-    protected function getPaginationParams()
-    {
-        $params = ['size' => $this->size, 'limit' => $this->size];
-
-        // from overrides page.
-        if (isset($this->from)) {
-            $params['from'] = $this->from;
-        } else {
-            $params['page'] = max(1, $this->page ?? 1);
-            $params['from'] = ($params['page'] - 1) * $this->size;
-        }
-
-        return $params;
-    }
-
     /**
      * @param Highlight $highlight the fields and settings for highlighting. Set to null to remove.
      *
@@ -126,11 +106,19 @@ public function source($fields)
     }
 
     /**
+     * @param array|Sort $sort
+     *
      * @return $this
      */
-    public function sort(array $sort)
+    public function sort($sort)
     {
-        $this->sort[] = $sort;
+        if (is_array($sort)) {
+            foreach ($sort as $s) {
+                $this->addSort($s);
+            }
+        } else {
+            $this->addSort($sort);
+        }
 
         return $this;
     }
@@ -144,4 +132,47 @@ public function type(?string $type)
 
         return $this;
     }
+
+    protected function getDefaultSize() : int
+    {
+        return 10;
+    }
+
+    /**
+     * page is not returned if using offset query.
+     *
+     * @return array
+     */
+    protected function getPaginationParams()
+    {
+        $size = $this->getSize();
+        $params = ['size' => $size];
+
+        // from overrides page.
+        if (isset($this->from)) {
+            $params['from'] = $this->from;
+        } else {
+            $params['page'] = max(1, $this->page ?? 1);
+            $params['from'] = ($params['page'] - 1) * $size;
+        }
+
+        return $params;
+    }
+
+    /**
+     *  Gets the actual size to use in queries.
+     *
+     * @return int actual size to use.
+     */
+    protected function getSize() : int
+    {
+        return $this->size ?? $this->getDefaultSize();
+    }
+
+    private function addSort(Sort $sort)
+    {
+        if (!$sort->isBlank()) {
+            $this->sorts[] = $sort;
+        }
+    }
 }

app/Libraries/Elasticsearch/Hit.php

@@ -66,7 +66,7 @@ public function highlights(string $field, ?int $limit = null)
         }
 
         // highlights are stored in an array, so return an array as well.
-        return [html_excerpt($this['_source'][$field])];
+        return [html_excerpt($this['_source'][$field], $limit)];
     }
 
     public function innerHits(string $name)

app/Libraries/Elasticsearch/RecordSearch.php

@@ -0,0 +1,50 @@
+<?php
+
+/**
+ *    Copyright 2015-2018 ppy Pty. Ltd.
+ *
+ *    This file is part of osu!web. osu!web is distributed with the hope of
+ *    attracting more community contributions to the core ecosystem of osu!.
+ *
+ *    osu!web is free software: you can redistribute it and/or modify
+ *    it under the terms of the Affero GNU General Public License version 3
+ *    as published by the Free Software Foundation.
+ *
+ *    osu!web is distributed WITHOUT ANY WARRANTY; without even the implied
+ *    warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ *    See the GNU Affero General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Affero General Public License
+ *    along with osu!web.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace App\Libraries\Elasticsearch;
+
+abstract class RecordSearch extends Search
+{
+    protected $idField;
+    protected $recordType;
+
+    public function __construct(string $index, SearchParams $params, $recordType, $idField = '_id')
+    {
+        parent::__construct($index, $params);
+
+        $this->idField = $idField;
+        $this->recordType = $recordType;
+    }
+
+    public function data()
+    {
+        return $this->records();
+    }
+
+    public function records()
+    {
+        return $this->response()->records()->get();
+    }
+
+    public function response() : SearchResponse
+    {
+        return parent::response()->recordType($this->recordType)->idField($this->idField);
+    }
+}