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