feathers-trigger/src/hooks/trigger.ts

Add triggers and actions to your feathers app.

import { checkContext } from 'feathers-hooks-common'
import type { ManipulateParams, Change } from './changesById.js'
import {
  changesByIdBefore,
  changesByIdAfter,
  getOrFindByIdParams,
} from './changesById.js'
import sift from 'sift'
import _set from 'lodash/set.js'

import type {
  HookContext,
  Id,
  NextFunction,
  Paginated,
  ServiceInterface,
} from '@feathersjs/feathers'
import type { MaybeArray, Promisable } from '../types.internal.js'

export type ActionOptions<H extends HookContext = HookContext, T = any> = {
  subscription: Subscription<H, T>
  items: Change<T>[]
  context: H
}

export type Action<H extends HookContext = HookContext, T = any> = (
  change: Change<T>,
  options: ActionOptions<H, T>,
) => Promisable<void>

export type BatchAction<H extends HookContext = HookContext, T = any> = (
  changes: [change: Change<T>, options: ActionOptions<H, T>][],
  context: H,
) => Promisable<void>

export type HookTriggerOptions<H extends HookContext = HookContext, T = any> =
  | MaybeArray<Subscription<H, T>>
  | ((context: H) => Promisable<MaybeArray<Subscription<H, T>>>)

export type Condition<
  H extends HookContext = HookContext,
  T = Record<string, any>,
> =
  | Record<string, any>
  | ((item: T, context: H) => Promisable<boolean | Record<string, any>>)

export type ConditionChange<
  H extends HookContext = HookContext,
  T = Record<string, any>,
> =
  | Record<string, any>
  | ((
      change: {
        item: T
        before: T | undefined
      },
      context: H,
    ) => Promisable<boolean | Record<string, any>>)

export interface SubscriptionBase<
  H extends HookContext = HookContext,
  T = Record<string, any>,
> {
  /**
   * The name of the subscription
   *
   * Can be used to filter subscriptions
   */
  name?: string
  service?: string | string[]
  method?: string | string[]

  data?: Condition<H, T>
  result?: ConditionChange<H, T>
  before?: Condition<H, T>
  params?: Condition<H, T>

  manipulateParams?: ManipulateParams
  /**
   * @default true
   */
  isBlocking?: boolean
  /**
   * @default false
   */
  fetchBefore?: boolean

  /**
   * @default false
   */
  debug?: boolean
}

export type SubscriptionSingleAction<
  H extends HookContext = HookContext,
  T = Record<string, any>,
> = {
  action: Action<H, T>
} & SubscriptionBase<H, T>

export type SubscriptionBatchAction<
  H extends HookContext = HookContext,
  T = Record<string, any>,
> = {
  batchAction: BatchAction<H, T>
} & SubscriptionBase<H, T>

export type Subscription<
  H extends HookContext = HookContext,
  T = Record<string, any>,
> = SubscriptionSingleAction<H, T> | SubscriptionBatchAction<H, T>

export type SubscriptionResolved<
  H extends HookContext = HookContext,
  T = Record<string, any>,
> = Subscription<H, T> & {
  identifier?: string
  paramsResolved?: Record<string, any>
}

export const trigger = <
  H extends HookContext,
  T = H extends HookContext<any, infer S>
    ? S extends ServiceInterface<infer TT>
      ? TT extends Paginated<infer TTT>
        ? TTT
        : TT extends Array<infer TTT>
          ? TTT
          : TT
      : any
    : any,
>(
  options: HookTriggerOptions<H, T>,
) => {
  if (!options) {
    throw new Error('You should define subscriptions')
  }

  return async (context: H, next?: NextFunction): Promise<H> => {
    checkContext(
      context,
      null,
      ['create', 'update', 'patch', 'remove'],
      'trigger',
    )

    if (context.type === 'before') {
      return await triggerBefore(context, options)
    } else if (context.type === 'after') {
      return await triggerAfter(context)
    } else if (context.type === 'around' && next) {
      context = await triggerBefore(context, options)
      await next()
      context = await triggerAfter(context)
      return context
    } else {
      return context
    }
  }
}

const makeDebug = (sub: Subscription, context: HookContext) => {
  if (!sub.debug) {
    return () => {}
  }

  const prepend = [
    '[FEATHERS_TRIGGER DEBUG]',
    ...(sub.name ? [sub.name] : []),
    context.type,
    `service('${context.path}').${context.method}()`,
  ]

  return console.log.bind(console, ...prepend)
}

const triggerBefore = async <H extends HookContext, T = Record<string, any>>(
  context: H,
  options: HookTriggerOptions<H, T>,
): Promise<H> => {
  let subs = await getSubscriptions(context, options)

  if (!subs?.length) {
    return context
  }

  let debug = false

  if (!Array.isArray(context.data)) {
    const result: Subscription<H, T>[] = []
    await Promise.all(
      subs.map(async (sub) => {
        if (sub.debug) {
          debug = true
        }
        const log = makeDebug(sub as any, context)
        if (!('action' in sub) && !('batchAction' in sub)) {
          log('skipping because no action provided')
          return
        }

        if (
          sub.name &&
          context.params.skipTrigger &&
          (context.params.skipTrigger === sub.name ||
            (Array.isArray(context.params.skipTrigger) &&
              context.params.skipTrigger.includes(sub.name)))
        ) {
          log('skipping because of context.params.skipTrigger')
          return
        }

        // test data
        if (
          sub.data !== undefined &&
          !(await testCondition({
            condition: sub.data,
            item: context.data,
            context,
          }))
        ) {
          log('skipping because of data mismatch')
          return
        }

        // test params
        if (
          sub.params !== undefined &&
          !(await testCondition({
            condition: sub.params,
            item: context.params,
            context,
          }))
        ) {
          log('skipping because of params mismatch')
          return
        }

        result.push(sub)
      }),
    )
    subs = result
  }

  if (!subs?.length) {
    if (debug) {
      console.log(
        '[FEATHERS_TRIGGER DEBUG]',
        context.path,
        context.method,
        'skipping because no subscriptions left',
      )
    }
    return context
  }

  for (const sub of subs) {
    const log = makeDebug(sub as any, context)

    sub.paramsResolved =
      (await getOrFindByIdParams(context, {
        params: sub.manipulateParams,
        deleteParams: ['trigger'],
        type: 'before',
        skipHooks: false,
      })) ?? {}

    sub.identifier = JSON.stringify(sub.paramsResolved.query || {})
    if (context.params.changesById?.[sub.identifier]?.itemsBefore) {
      continue
    }

    log("fetching before with 'changesByIdBefore'")

    const before = await changesByIdBefore(context, {
      skipHooks: false,
      params: () => (sub.paramsResolved ? sub.paramsResolved : null),
      deleteParams: ['trigger'],
      fetchBefore: sub.fetchBefore || !!sub.before,
    })

    _set(
      context,
      ['params', 'changesById', sub.identifier, 'itemsBefore'],
      before,
    )
  }

  setConfig(context, subs)

  return context
}

const triggerAfter = async <H extends HookContext>(context: H): Promise<H> => {
  const subs = getConfig(context)
  if (!subs?.length) {
    return context
  }

  const promises: Promisable<any>[] = []

  for (const sub of subs) {
    const log = makeDebug(sub, context)

    if (
      sub.name &&
      context.params.skipTrigger &&
      (context.params.skipTrigger === sub.name ||
        (Array.isArray(context.params.skipTrigger) &&
          context.params.skipTrigger.includes(sub.name)))
    ) {
      log('skipping because of context.params.skipTrigger')
      return context
    }

    const itemsBefore = sub.identifier
      ? context.params.changesById?.[sub.identifier]?.itemsBefore
      : undefined
    let changesById: Record<Id, Change> | undefined
    if (sub.identifier && itemsBefore) {
      log("fetching after with 'changesByIdAfter'")

      changesById = await changesByIdAfter(context, itemsBefore, null, {
        name: ['changesById', sub.identifier],
        params: sub.manipulateParams,
        skipHooks: false,
        deleteParams: ['trigger'],
        fetchBefore: sub.fetchBefore,
      })

      _set(context, ['params', 'changesById', sub.identifier], changesById)
    }

    changesById = sub.identifier
      ? context.params.changesById?.[sub.identifier]
      : undefined

    if (!changesById) {
      log('no changesById')
      continue
    }

    const changes = Object.values(changesById)

    const batchActionArguments: [change: Change, options: ActionOptions][] = []

    for (const change of changes) {
      const { before } = change
      const { item } = change

      const changeForSub = change
      if (
        sub.result !== undefined &&
        !(await testCondition({
          item,
          before,
          withBefore: true,
          condition: sub.result,
          context,
        }))
      ) {
        log('skipping because of result mismatch')
        continue
      }

      if (
        sub.before !== undefined &&
        !(await testCondition({
          item,
          before,
          testItem: 'before',
          condition: sub.before,
          context,
        }))
      ) {
        log('skipping because of before mismatch', before)
        continue
      }

      if (isSubscriptionInBatchMode(sub)) {
        log('adding to batchActionArguments')
        batchActionArguments.push([
          changeForSub,
          {
            subscription: sub,
            items: changes,
            context,
          },
        ])
      } else if (isSubscriptionNormalMode(sub)) {
        const _action = sub.action

        log('running action')

        const promise = _action(changeForSub, {
          subscription: sub,
          items: changes,
          context,
        })

        if (sub.isBlocking) {
          promises.push(promise)
        }
      }
    }

    if (isSubscriptionInBatchMode(sub) && batchActionArguments.length) {
      log('running batch action')
      const promise = sub.batchAction(batchActionArguments, context)

      if (sub.isBlocking) {
        promises.push(promise)
      }
    }
  }

  await Promise.all(promises)

  return context
}

const CONFIG_KEY = 'subscriptions' as const

function setConfig(
  context: HookContext,
  val: SubscriptionResolved<any, any>[],
): void {
  context.params.trigger = context.params.trigger || {}
  context.params.trigger[CONFIG_KEY] = val
}

function getConfig(
  context: HookContext,
): SubscriptionResolved<any, any>[] | undefined {
  return context.params.trigger?.[CONFIG_KEY]
}

const getSubscriptions = async <H extends HookContext, T = any>(
  context: H,
  options: HookTriggerOptions<H, T>,
): Promise<undefined | SubscriptionResolved<H, T>[]> => {
  const _subscriptionOrSubscriptions =
    typeof options === 'function' ? await options(context) : options

  if (!_subscriptionOrSubscriptions) {
    return
  }

  const _subscriptions = Array.isArray(_subscriptionOrSubscriptions)
    ? _subscriptionOrSubscriptions
    : [_subscriptionOrSubscriptions]

  const subscriptions = _subscriptions.map(
    (x) =>
      ({ isBlocking: true, fetchBefore: false, ...x }) as SubscriptionResolved<
        H,
        T
      >,
  )

  const { path, method } = context

  return subscriptions.filter((sub) => {
    if (
      sub.service &&
      ((typeof sub.service === 'string' && sub.service !== path) ||
        (Array.isArray(sub.service) && !sub.service.includes(path)))
    ) {
      return false
    }
    if (
      sub.method &&
      ((typeof sub.method === 'string' && sub.method !== method) ||
        (Array.isArray(sub.method) && !sub.method.includes(method)))
    ) {
      return false
    }

    return true
  })
}

const isSubscriptionInBatchMode = (
  sub: Subscription,
): sub is SubscriptionBatchAction => 'batchAction' in sub

const isSubscriptionNormalMode = (
  sub: Subscription,
): sub is SubscriptionSingleAction => 'action' in sub

type TestConditionOptions = {
  item: any
  testItem?: 'item' | 'before'
  before?: any
  withBefore?: boolean
  condition: Condition | ConditionChange | undefined
  context: HookContext
}

const testCondition = async (
  options: TestConditionOptions,
): Promise<boolean> => {
  if (options.condition === undefined) {
    return true
  }

  const { item, before, context, testItem = 'item' } = options

  let condition: Record<string, any> | boolean

  if (typeof options.condition === 'function') {
    const data = options.withBefore ? { item, before } : item
    condition = await options.condition(data, context)
  } else {
    condition = options.condition
  }

  if (typeof condition === 'boolean') {
    return condition
  }

  const sifter = (sift as any)(condition)

  return sifter(options[testItem])
}