All files / app/util query.ts

70.78% Statements 126/178
63.21% Branches 110/174
89.47% Functions 17/19
73.24% Lines 115/157

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 29593x       93x   93x 93x 93x 93x 93x 43x   22x                                                               52x 51x 50x       27x 18x 18x 12x   6x     9x 7x 7x 2x   5x     2x 1x                                                               47x     47x     47x     47x 47x 47x 47x 30x 30x 31x 31x 26x       17x   47x                     36x 36x 36x   32x 32x                     53x 53x 52x 26x       28x 28x 3x       13x         13x 2x   11x 1x     10x 8x       50x                             47x 47x 47x 44x 25x     25x 1x 1x 24x     24x 1x 1x 23x     23x 1x 22x 10x 10x 1x 1x 9x 9x 9x   12x 2x 2x 10x 2x 2x 8x 1x 7x 1x 6x 3x 3x   3x   3x   3x   3x   3x 3x             47x       5x 5x 4x 1x 1x   3x       4x 4x 4x                 4x       1x 1x 1x           1x    
import { isArray, uniq, without } from 'lodash-es';
import { DateTime, Duration } from 'luxon';
import { Filter, RefFilter, RefPageArgs, RefSort } from '../model/ref';
import { FilterConfig, TagQueryArgs, TagSort } from '../model/tag';
import { braces, fixClientQuery, hasPrefix } from './tag';
 
const DEFAULT_DESC_SUFFIXES = [':num', ':top', ':score', ':decay'];
const DEFAULT_DESC_PREFIXES = ['metadata->'];
const DEFAULT_DESC_EXACT = ['created', 'published', 'modified', 'rank'];
const DATE_SORT_FIELDS = ['created', 'modified', 'published'];
export const defaultDesc = (sort: string) =>
  DEFAULT_DESC_EXACT.includes(sort) ||
  DEFAULT_DESC_PREFIXES.some(prefix => sort.startsWith(prefix)) ||
  DEFAULT_DESC_SUFFIXES.some(suffix => sort.endsWith(suffix));
 
export type FilterItem = { filter: UrlFilter, label: string, title?: string, time?: boolean };
export type FilterGroup = { filters: FilterItem[], label: string };
export type UrlFilter = Filter |
  `!obsolete` |
  `modified/before/${string}` |
  `modified/after/${string}` |
  `published/before/${string}` |
  `published/after/${string}` |
  `created/before/${string}` |
  `created/after/${string}` |
  `response/before/${string}` |
  `response/after/${string}` |
  `sources/${string}` |
  `noSources/${string}` |
  `responses/${string}` |
  `noResponses/${string}` |
  `query/${string}` |
  `noDescendents/${string}` |
  `scheme/${string}` |
  `user/${string}` |
  `plugin/${string}` |
  `+plugin/${string}` |
  `_plugin/${string}` |
  `!plugin/${string}` |
  `!+plugin/${string}` |
  `!_plugin/${string}`;
 
export type SortItem = { value: RefSort | TagSort, label: string, title?: string };
 
export function negatable(filter: string) {
  if (!filter) return false;
  if (filter === 'obsolete') return true;
  return filter.startsWith('query/') || filter.startsWith('user/') || filter.startsWith('!') || hasPrefix(filter, 'plugin');
}
 
export function toggle(filter: UrlFilter): UrlFilter {
  if (filter.startsWith('query/')) {
    const query = filter.substring('query/'.length);
    if (query.startsWith('!(')) {
      return 'query/' + query.substring(2, query.length - 1) as UrlFilter;
    } else {
      return 'query/!(' + query + ')' as UrlFilter;
    }
  }
  if (filter.startsWith('user/')) {
    const plugin = filter.substring('user/'.length);
    if (plugin.startsWith('!')) {
      return 'user/' + plugin.substring(1) as UrlFilter;
    } else {
      return 'user/!' + plugin as UrlFilter;
    }
  }
  if (filter.startsWith('!')) return filter.substring(1) as any;
  return '!' + filter as any;
}
 
export function convertFilter(filter: FilterConfig): FilterItem {
  if (filter.sources) {
    return { filter: `sources/${filter.sources}`, label: filter.label || filter.sources, title: filter.title };
  } else if (filter.responses) {
    return { filter: `responses/${filter.responses}`, label: filter.label || filter.responses, title: filter.title };
  } else if (filter.scheme) {
    return { filter: `scheme/${filter.scheme}`, label: filter.label || filter.scheme, title: filter.title };
  } else if (filter.query) {
    return { filter: `query/${filter.query}`, label: filter.label || filter.query, title: filter.title };
  } else if (filter.user) {
    return { filter: `user/${filter.user}`, label: filter.label || filter.user, title: filter.title };
  } else if (filter.response) {
    return { filter: filter.response, label: filter.label || filter.response, title: filter.title };
  }
  throw 'Can\'t convert filter';
}
 
export function convertSort(sort: any): SortItem {
  return { value: sort.sort as any, label: sort.label, title: sort.title };
}
 
export function getArgs(
  tagOrSimpleQuery?: string,
  sort?: RefSort | RefSort[],
  filters?: UrlFilter[],
  search?: string,
  pageNumber?: number,
  pageSize?: number
): RefPageArgs {
  Iif (filters?.includes('query/internal')) {
    filters = without(filters, 'query/!internal', 'query/internal');
  }
  Iif (filters?.includes('query/plugin/delete')) {
    filters = without(filters, 'query/!plugin/delete');
  }
  Iif (filters?.includes('user/plugin/user/hide')) {
    filters = without(filters, 'user/!plugin/user/hide');
  }
  filters = uniq(filters);
  let queryFilter = getFiltersQuery(filters);
  const query = queryFilter && tagOrSimpleQuery ? `${braces(tagOrSimpleQuery)}:${queryFilter}` : tagOrSimpleQuery || queryFilter;
  if (sort?.length) {
    sort = Array.isArray(sort) ? [...sort] : [sort];
    for (let i = 0; i < sort.length; i++) {
      const s = sort[i];
      if (!s.includes(',') && defaultDesc(s)) {
        sort[i] = s + ',DESC' as RefSort;
      }
    }
  } else {
    sort = [];
  }
  return {
    query: fixClientQuery(query),
    sort,
    search,
    page: pageNumber,
    size: pageSize,
    ...getRefFilter(filters),
  };
}
 
export function withStableDateSort(args: RefPageArgs): RefPageArgs {
  const sort = args.sort ?? [];
  const [primaryField] = sort[0]?.split(',') ?? [];
  if (!DATE_SORT_FIELDS.includes(primaryField)) return args;
 
  const sortFields = sort.map(value => value.split(',')[0]);
  return {
    ...args,
    sort: [
      ...sort,
      ...(!sortFields.includes('modified') ? ['modified,ASC' as const] : []),
      ...(!sortFields.includes('origin') ? ['origin,ASC' as const] : []),
    ],
  };
}
 
export function getFilters(filters: UrlFilter[] | UrlFilter) {
  Iif (!filters) return [];
  return (isArray(filters) ? filters : [filters])
    .filter(f => f.startsWith('query/'))
    .map(f => getFilter(f as `query/${string}`));
}
 
export function getFilter(filter: `query/${string}`) {
  const query = filter.substring('query/'.length);
  if (!query.startsWith('!(')) return query;
  return negate(query.substring(2, query.length - 1));
}
 
export function negate(query: string): string {
  Iif (query.includes('(') || query.includes(':') && query.includes('|')) {
    // TODO: Parse query to negate
    console.error('Query parsing not implemented. Bailing on negate.');
    return query;
  }
  if (query.includes(':')) {
    return braces(query.split(':').map(negate).join('|'));
  }
  if (query.includes('|')) {
    return query.split('|').map(negate).join(':');
  }
  // Single tag
  if (query.startsWith('!')) return query.substring(1);
  return '!' + query;
}
 
export function getFiltersQuery(filters: UrlFilter[] | UrlFilter){
  return getFilters(filters).map(braces).join(':');
}
 
export function parseArgs(params: any): RefPageArgs {
  params.page = params.pageNumber;
  delete params.pageNumber;
  params.size = params.pageSize;
  delete params.pageSize;
  return {
    ...params,
    ...getRefFilter(params.filter as any),
  };
}
 
function getRefFilter(filter?: UrlFilter[]): RefFilter {
  Iif (!filter) return {};
  let result: RefFilter = {};
  for (const f of filter) {
    if (f.startsWith('query/')) continue;
    Iif (f.startsWith('noDescendents/')) {
      if (result.noDescendents) console.warn('Multiple noDescendents filters (last wins)');
      result.noDescendents = f.substring('noDescendents/'.length)
    } else if (f.startsWith('sources/')) {
      Iif (result.sources) console.warn('Multiple sources filters (last wins)');
      result.sources = f.substring('sources/'.length)
    I} else if (f.startsWith('noSources/')) {
      if (result.noSources) console.warn('Multiple noSources filters (last wins)');
      result.noSources = f.substring('noSources/'.length)
    } else if (f.startsWith('responses/')) {
      Iif (result.responses) console.warn('Multiple response filters (last wins)');
      result.responses = f.substring('responses/'.length)
    I} else if (f.startsWith('noResponses/')) {
      if (result.noResponses) console.warn('Multiple noResponses filters (last wins)');
      result.noResponses = f.substring('noResponses/'.length)
    } else if (f.startsWith('scheme/')) {
      result.scheme = f.substring('scheme/'.length)
    } else if (f.startsWith('user/')) {
      const p = f.substring('user/'.length);
      if (hasPrefix(p, 'plugin')) {
        result.userResponse ||= [];
        result.userResponse.push(p);
      E} else if (p.startsWith('!') && hasPrefix(p.substring(1), 'plugin')) {
        result.noUserResponse ||= [];
        result.noUserResponse.push(p.substring(1));
      }
    } else if (hasPrefix(f, 'plugin')) {
      result.pluginResponse ||= [];
      result.pluginResponse.push(f);
    } else if (f.startsWith('!') && hasPrefix(f.substring(1), 'plugin')) {
      result.noPluginResponse ||= [];
      result.noPluginResponse.push(f.substring(1));
    } else if (f.startsWith('modified/before/')) {
      result.modifiedBefore = fixDateTime(f.substring('modified/before/'.length));
    } else if (f.startsWith('modified/after/')) {
      result.modifiedAfter = fixDateTime(f.substring('modified/after/'.length));
    } else if (f.startsWith('published/before/')) {
      result.publishedBefore = fixDateTime(f.substring('published/before/'.length));
    I} else if (f.startsWith('published/after/')) {
      result.publishedAfter = fixDateTime(f.substring('published/after/'.length));
    I} else if (f.startsWith('created/before/')) {
      result.createdBefore = fixDateTime(f.substring('created/before/'.length));
    I} else if (f.startsWith('created/after/')) {
      result.createdAfter = fixDateTime(f.substring('created/after/'.length));
    I} else if (f.startsWith('response/before/')) {
      result.responseBefore = fixDateTime(f.substring('response/before/'.length));
    I} else if (f.startsWith('response/after/')) {
      result.responseAfter = fixDateTime(f.substring('response/after/'.length));
    } else if (f === '!obsolete') {
      result['obsolete'] = null as any;
    E} else if (f.startsWith('!')) {
      result[f.substring(1) as Filter] = false;
    } else {
      result[f as Filter] = true;
    }
  }
  return result;
}
 
export function fixDateTime(t: string) {
  const relative = t.toUpperCase();
  if (relative === 'NOW') return DateTime.now().toUTC().toISO()!;
  if (relative.startsWith('P') && /\d/.test(relative)) {
    const duration = Duration.fromISO(relative);
    Eif (duration.isValid) return DateTime.now().minus(duration).toUTC().toISO()!;
  }
  return DateTime.fromISO(t).toUTC().toISO()!;
}
 
export function getTagFilter(filter?: UrlFilter[]): TagQueryArgs {
  Iif (!filter) return {};
  let result: TagQueryArgs = {};
  for (const f of filter) {
    if (f.startsWith('modified/before/')) {
      result.modifiedBefore = f.substring('modified/before/'.length);
    } else if (f.startsWith('modified/after/')) {
      result.modifiedAfter = f.substring('modified/after/'.length);
    } else if (f == 'plugin/delete') {
      result.deleted = true;
    }
  }
  return result;
}
 
export function getTagQueryFilter(query: string, filter?: UrlFilter[]): string {
  Iif (!filter) return query;
  let result = query;
  for (const f of filter) {
    if (f.startsWith('query/')) {
      if (result) result += ':';
      result += braces(getFilter(f as `query/${string}`));
    }
  }
  return result;
}