Optimize search SQL query (I hope :p)

[github/Chocobozzz/PeerTube.git] / server / models / utils.ts

diff --git a/server/models/utils.ts b/server/models/utils.ts
index 1bf61d2a693021aff86a88732587dfabe3ccd87b..58a18c97a9788a2aab814f19925f7acbf8b9d820 100644 (file)
--- a/server/models/utils.ts
+++ b/server/models/utils.ts
@@ -1,6 +1,8 @@
-// Translate for example "-name" to [ 'name', 'DESC' ]
-function getSort (value: string) {
-  let field: string
+// Translate for example "-name" to [ [ 'name', 'DESC' ], [ 'id', 'ASC' ] ]
+import { Sequelize } from 'sequelize-typescript'
+
+function getSort (value: string, lastSort: string[] = [ 'id', 'ASC' ]) {
+  let field: any
   let direction: 'ASC' | 'DESC'
 
   if (value.substring(0, 1) === '-') {
@@ -11,25 +13,60 @@ function getSort (value: string) {
     field = value
   }
 
-  return [ field, direction ]
+  // Alias
+  if (field.toLowerCase() === 'match') field = Sequelize.col('similarity')
+
+  return [ [ field, direction ], lastSort ]
+}
+
+function getSortOnModel (model: any, value: string, lastSort: string[] = [ 'id', 'ASC' ]) {
+  let [ firstSort ] = getSort(value)
+
+  if (model) return [ [ model, firstSort[0], firstSort[1] ], lastSort ]
+  return [ firstSort, lastSort ]
+}
+
+function throwIfNotValid (value: any, validator: (value: any) => boolean, fieldName = 'value') {
+  if (validator(value) === false) {
+    throw new Error(`"${value}" is not a valid ${fieldName}.`)
+  }
 }
 
-function addMethodsToModel (model: any, classMethods: Function[], instanceMethods: Function[] = []) {
-  classMethods.forEach(m => model[m.name] = m)
-  instanceMethods.forEach(m => model.prototype[m.name] = m)
+function buildTrigramSearchIndex (indexName: string, attribute: string) {
+  return {
+    name: indexName,
+    fields: [ Sequelize.literal('lower(immutable_unaccent(' + attribute + '))') as any ],
+    using: 'gin',
+    operator: 'gin_trgm_ops'
+  }
 }
 
-function getSortOnModel (model: any, value: string) {
-  let sort = getSort(value)
+function createSimilarityAttribute (col: string, value: string) {
+  return Sequelize.fn(
+    'similarity',
+
+    searchTrigramNormalizeCol(col),
 
-  if (model) return [ { model: model }, sort[0], sort[1] ]
-  return sort
+    searchTrigramNormalizeValue(value)
+  )
 }
 
 // ---------------------------------------------------------------------------
 
 export {
-  addMethodsToModel,
   getSort,
-  getSortOnModel
+  getSortOnModel,
+  createSimilarityAttribute,
+  throwIfNotValid,
+  buildTrigramSearchIndex
+}
+
+// ---------------------------------------------------------------------------
+
+function searchTrigramNormalizeValue (value: string) {
+  return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', value))
+}
+
+function searchTrigramNormalizeCol (col: string) {
+  return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', Sequelize.col(col)))
 }