Add search filter options and schema decorators with tests for filtering functionality

Author: tacxou

src/_common/restools/index.ts

@@ -0,0 +1,2 @@
+export * from './search-filter-options.decorator'
+export * from './search-filter-schema.decorator'

src/_common/restools/search-filter-options.decorator.spec.ts

@@ -0,0 +1,129 @@
+import { DEFAULT_FILTER_OPTIONS, filterOptions } from "./search-filter-options.decorator"
+
+describe('search-filter-options', () => {
+  it('should work', () => {
+    expect(true).toBe(true)
+  })
+
+  it('sort with desc string', () => {
+    expect(
+      filterOptions({
+        sort: { 'metadata.lastUpdatedAt': 'desc' },
+      }),
+    ).toStrictEqual({
+      ...DEFAULT_FILTER_OPTIONS,
+      sort: { 'metadata.lastUpdatedAt': -1 },
+    })
+  })
+
+  it('sort with desc number', () => {
+    expect(
+      filterOptions({
+        sort: { 'metadata.lastUpdatedAt': '-1' },
+      }),
+    ).toStrictEqual({
+      ...DEFAULT_FILTER_OPTIONS,
+      sort: { 'metadata.lastUpdatedAt': -1 },
+    })
+  })
+
+  it('sort with asc string', () => {
+    expect(
+      filterOptions({
+        sort: { 'metadata.lastUpdatedAt': 'asc' },
+      }),
+    ).toStrictEqual({
+      ...DEFAULT_FILTER_OPTIONS,
+      sort: { 'metadata.lastUpdatedAt': 1 },
+    })
+  })
+
+  it('sort with asc number', () => {
+    expect(
+      filterOptions({
+        sort: { 'metadata.lastUpdatedAt': '1' },
+      }),
+    ).toStrictEqual({
+      ...DEFAULT_FILTER_OPTIONS,
+      sort: { 'metadata.lastUpdatedAt': 1 },
+    })
+  })
+
+  it('limit 69', () => {
+    expect(
+      filterOptions({
+        limit: '69',
+      }),
+    ).toStrictEqual({
+      ...DEFAULT_FILTER_OPTIONS,
+      limit: 69,
+    })
+  })
+
+  it('skip 71', () => {
+    expect(
+      filterOptions({
+        skip: '71',
+      }),
+    ).toStrictEqual({
+      ...DEFAULT_FILTER_OPTIONS,
+      skip: 71,
+    })
+  })
+
+  it('skip with other key', () => {
+    expect(
+      filterOptions({
+        jump: '71',
+      }, { skipKey: 'jump' }),
+    ).toStrictEqual({
+      ...DEFAULT_FILTER_OPTIONS,
+      skip: 71,
+    })
+  })
+
+  it('limit with other key', () => {
+    expect(
+      filterOptions({
+        quota: '71',
+      }, { limitKey: 'quota' }),
+    ).toStrictEqual({
+      ...DEFAULT_FILTER_OPTIONS,
+      limit: 71,
+    })
+  })
+
+  it('use pagination number', () => {
+    expect(
+      filterOptions({
+        page: '42',
+      }),
+    ).toStrictEqual({
+      ...DEFAULT_FILTER_OPTIONS,
+      skip: DEFAULT_FILTER_OPTIONS.limit * 41,
+    })
+  })
+
+  it('use pagination number with other key', () => {
+    expect(
+      filterOptions({
+        increment: '11',
+      }, { pageKey: 'increment' }),
+    ).toStrictEqual({
+      ...DEFAULT_FILTER_OPTIONS,
+      skip: DEFAULT_FILTER_OPTIONS.limit * 10,
+    })
+  })
+
+  it('use pagination number and conflict with skip', () => {
+    expect(
+      filterOptions({
+        page: '5',
+        skip: '50',
+      }),
+    ).toStrictEqual({
+      ...DEFAULT_FILTER_OPTIONS,
+      skip: DEFAULT_FILTER_OPTIONS.limit * 4,
+    })
+  })
+})

src/_common/restools/search-filter-options.decorator.ts

@@ -0,0 +1,87 @@
+import { BadRequestException, ExecutionContext, Logger, createParamDecorator } from '@nestjs/common'
+import { Request } from 'express'
+import { ParsedQs } from 'qs'
+
+export const DEFAULT_SEARCH_OPTIONS = {
+  loggerType: 'FilterOptionsControl',
+  defaultLimit: 10,
+  limitKey: 'limit',
+  skipKey: 'skip',
+  pageKey: 'page',
+  sortKey: 'sort',
+  allowUnlimited: false,
+}
+
+export interface FilterSearchOptions {
+  loggerType?: string
+  defaultLimit?: number
+  limitKey?: string
+  skipKey?: string
+  pageKey?: string
+  sortKey?: string
+  allowUnlimited?: boolean,
+}
+
+export interface SortOptions {
+  [key: string]: 'asc' | 'desc' | 1 | -1
+}
+
+export const DEFAULT_FILTER_OPTIONS = {
+  limit: DEFAULT_SEARCH_OPTIONS.defaultLimit,
+  skip: 0,
+  sort: {},
+}
+
+export interface FilterOptions {
+  limit: number
+  skip: number
+  sort: SortOptions
+}
+
+/* istanbul ignore next */
+export const SearchFilterOptions = createParamDecorator((options: FilterSearchOptions, ctx: ExecutionContext): FilterOptions => {
+  options = { ...DEFAULT_SEARCH_OPTIONS, ...options }
+  const req = ctx.switchToHttp().getRequest<Request>()
+
+  try {
+    return filterOptions(req.query, options)
+  } catch (error) {
+    throw new BadRequestException(error.message)
+  }
+})
+
+export function filterOptions(
+  queries: string | string[] | ParsedQs | ParsedQs[],
+  options?: FilterSearchOptions,
+): FilterOptions {
+  options = { ...DEFAULT_SEARCH_OPTIONS, ...options }
+  let limit = parseInt(`${queries[options.limitKey]}`) || options.defaultLimit
+  if (limit === -1 && options.allowUnlimited) limit = undefined
+  let skip = parseInt(`${queries[options.skipKey]}`) || 0
+
+  if (queries[options.pageKey]) {
+    if (skip > 0) Logger.debug(`Both ${options.skipKey} and ${options.pageKey} are set. ${options.skipKey} will be ignored`, options.loggerType)
+    skip = (parseInt(`${queries[options.pageKey]}`) - 1) * limit
+  }
+
+  const sort = {}
+  for (const key in <string[] | ParsedQs[]>queries[options.sortKey]) {
+    switch (`${queries[options.sortKey][key]}`.toLowerCase()) {
+      case '1':
+      case 'asc':
+        sort[key] = 1
+        break
+
+      case '-1':
+      case 'desc':
+        sort[key] = -1
+        break
+    }
+  }
+
+  return {
+    limit,
+    skip,
+    sort,
+  }
+}