server/models/utils.ts

   1 import { Sequelize } from 'sequelize-typescript'
   2
   3 type SortType = { sortModel: any, sortValue: string }
   4
   5 // Translate for example "-name" to [ [ 'name', 'DESC' ], [ 'id', 'ASC' ] ]
   6 function getSort (value: string, lastSort: string[] = [ 'id', 'ASC' ]) {
   7   const { direction, field } = buildDirectionAndField(value)
   8
   9   return [ [ field, direction ], lastSort ]
  10 }
  11
  12 function getVideoSort (value: string, lastSort: string[] = [ 'id', 'ASC' ]) {
  13   let { direction, field } = buildDirectionAndField(value)
  14
  15   // Alias
  16   if (field.toLowerCase() === 'match') field = Sequelize.col('similarity')
  17
  18   // Sort by aggregation
  19   if (field.toLowerCase() === 'trending') {
  20     return [
  21       [ Sequelize.fn('COALESCE', Sequelize.fn('SUM', Sequelize.col('VideoViews.views')), '0'), direction ],
  22
  23       [ Sequelize.col('VideoModel.views'), direction ],
  24
  25       lastSort
  26     ]
  27   }
  28
  29   return [ [ field, direction ], lastSort ]
  30 }
  31
  32 function getSortOnModel (model: any, value: string, lastSort: string[] = [ 'id', 'ASC' ]) {
  33   let [ firstSort ] = getSort(value)
  34
  35   if (model) return [ [ model, firstSort[0], firstSort[1] ], lastSort ]
  36   return [ firstSort, lastSort ]
  37 }
  38
  39 function throwIfNotValid (value: any, validator: (value: any) => boolean, fieldName = 'value') {
  40   if (validator(value) === false) {
  41     throw new Error(`"${value}" is not a valid ${fieldName}.`)
  42   }
  43 }
  44
  45 function buildTrigramSearchIndex (indexName: string, attribute: string) {
  46   return {
  47     name: indexName,
  48     fields: [ Sequelize.literal('lower(immutable_unaccent(' + attribute + '))') as any ],
  49     using: 'gin',
  50     operator: 'gin_trgm_ops'
  51   }
  52 }
  53
  54 function createSimilarityAttribute (col: string, value: string) {
  55   return Sequelize.fn(
  56     'similarity',
  57
  58     searchTrigramNormalizeCol(col),
  59
  60     searchTrigramNormalizeValue(value)
  61   )
  62 }
  63
  64 // ---------------------------------------------------------------------------
  65
  66 export {
  67   SortType,
  68   getSort,
  69   getVideoSort,
  70   getSortOnModel,
  71   createSimilarityAttribute,
  72   throwIfNotValid,
  73   buildTrigramSearchIndex
  74 }
  75
  76 // ---------------------------------------------------------------------------
  77
  78 function searchTrigramNormalizeValue (value: string) {
  79   return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', value))
  80 }
  81
  82 function searchTrigramNormalizeCol (col: string) {
  83   return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', Sequelize.col(col)))
  84 }
  85
  86 function buildDirectionAndField (value: string) {
  87   let field: any
  88   let direction: 'ASC' | 'DESC'
  89
  90   if (value.substring(0, 1) === '-') {
  91     direction = 'DESC'
  92     field = value.substring(1)
  93   } else {
  94     direction = 'ASC'
  95     field = value
  96   }
  97
  98   return { direction, field }
  99 }