@botonic/plugin-contentful/src/cms/cms-error.ts

Botonic Plugin Contentful is one of the **[available](https://github.com/hubtype/botonic/tree/master/packages)** plugins for Botonic. **[Contentful](http://www.contentful.com)** is a CMS (Content Management System) which manages contents of a great variet

/* eslint-disable @typescript-eslint/unbound-method */
import { MultiError } from 'async-parallel'

import { SearchCandidate } from '../search'
import { Measure } from '../util'
import { reduceMultiError } from '../util/async'
import { AssetId, ContentId, ResourceId } from './callback'
import {
  CMS,
  ContentType,
  CustomContentType,
  DEFAULT_REFERENCES_TO_INCLUDE,
  PagingOptions,
  TopContentType,
} from './cms'
import {
  Asset,
  Button,
  Carousel,
  Chitchat,
  CommonFields,
  Content,
  Custom,
  DateRangeContent,
  Document,
  Element,
  Handoff,
  Image,
  Input,
  Payload,
  Queue,
  ScheduleContent,
  StartUp,
  Text,
  TopContent,
  Url,
  Video,
} from './contents'
import { Context, DEFAULT_CONTEXT } from './context'
import { CmsException } from './exceptions'

/**
 * It validates the individually delivered contents, but not those fetched
 * through contents/topContents
 */
export class ErrorReportingCMS implements CMS {
  private exceptionWrapper: ContentfulExceptionWrapper

  constructor(
    readonly cms: CMS,
    readonly logger?: (msg: string) => void
  ) {
    this.exceptionWrapper = new ContentfulExceptionWrapper('CMS', logger)
  }

  private validate<C extends Content>(
    content: C,
    context: Context | undefined
  ): C {
    const validation = content.validate()
    if (validation) {
      const locale = context?.locale ? ` on locale '${context.locale}'` : ''
      const msg = `${
        content.contentType
      } ${content.toString()}${locale}: ${validation}`
      if (this.logger) this.logger(msg)
      else console.error(msg)
    }
    return content
  }

  async catchAndValidate<T extends Content>(
    id: string,
    context: Context | undefined,
    contentType: ContentType,
    promise: Promise<T>
  ): Promise<T> {
    const m = new Measure('cms.' + contentType)
    try {
      const c = await promise
      m.end()
      this.validate(c, context)
      return c
    } catch (e) {
      this.handleContentError(contentType, id, context)(e)
      throw new Error('should not reach here')
    }
  }

  carousel(id: string, context?: Context): Promise<Carousel> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.CAROUSEL,
      this.cms.carousel(id, context)
    )
  }

  document(id: string, context?: Context): Promise<Document> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.DOCUMENT,
      this.cms.document(id, context)
    )
  }
  handoff(id: string, context?: Context): Promise<Handoff> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.HANDOFF,
      this.cms.handoff(id, context)
    )
  }

  input(id: string, context?: Context): Promise<Input> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.INPUT,
      this.cms.input(id, context)
    )
  }

  custom(id: string, context?: Context): Promise<Custom> {
    return this.catchAndValidate(
      id,
      context,
      CustomContentType.CUSTOM,
      this.cms.custom(id, context)
    )
  }
  text(id: string, context?: Context): Promise<Text> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.TEXT,
      this.cms.text(id, context)
    )
  }

  chitchat(id: string, context?: Context): Promise<Chitchat> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.CHITCHAT,
      this.cms.chitchat(id, context)
    )
  }

  startUp(id: string, context?: Context): Promise<StartUp> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.STARTUP,
      this.cms.startUp(id, context)
    )
  }

  url(id: string, context?: Context): Promise<Url> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.URL,
      this.cms.url(id, context)
    )
  }

  payload(id: string, context?: Context): Promise<Payload> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.PAYLOAD,
      this.cms.payload(id, context)
    )
  }

  image(id: string, context?: Context): Promise<Image> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.IMAGE,
      this.cms.image(id, context)
    )
  }

  video(id: string, context?: Context): Promise<Video> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.VIDEO,
      this.cms.video(id, context)
    )
  }

  queue(id: string, context?: Context): Promise<Queue> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.QUEUE,
      this.cms.queue(id, context)
    )
  }

  button(id: string, context?: Context): Promise<Button> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.BUTTON,
      this.cms.button(id, context)
    )
  }

  element(id: string, context?: Context): Promise<Element> {
    return this.catchAndValidate(
      id,
      context,
      ContentType.ELEMENT,
      this.cms.element(id, context)
    )
  }

  contentsWithKeywords(
    context?: Context,
    paging?: PagingOptions
  ): Promise<SearchCandidate[]> {
    return this.cms
      .contentsWithKeywords(context, paging)
      .catch(this.handleError('contentsWithKeywords', {}, context))
  }

  async topContents<T extends TopContent>(
    model: TopContentType,
    context?: Context,
    filter?: (cf: CommonFields) => boolean,
    paging?: PagingOptions
  ): Promise<T[]> {
    const m = new Measure('topContents.' + model)
    const contents = await this.cms
      .topContents<T>(model, context, filter, paging)
      .catch(this.handleError('topContents', { model }, context))
    m.end()
    return contents
  }

  content(
    id: string,
    context = DEFAULT_CONTEXT,
    referencesToInclude = DEFAULT_REFERENCES_TO_INCLUDE
  ): Promise<Content> {
    return this.cms
      .content(id, context, referencesToInclude)
      .catch(this.handleContentError('content' as ContentType, id, context))
  }

  contents<T extends Content>(
    model: ContentType,
    context?: Context,
    paging?: PagingOptions
  ): Promise<T[]> {
    return this.cms
      .contents<T>(model, context, paging)
      .catch(this.handleError('contents', { model }, context))
  }

  assets(context?: Context): Promise<Asset[]> {
    return this.cms
      .assets(context)
      .catch(this.handleError('assets', {}, context))
  }

  schedule(id: string, context?: Context): Promise<ScheduleContent> {
    return this.cms
      .schedule(id, context)
      .catch(this.handleContentError(ContentType.SCHEDULE, id, context))
  }

  dateRange(id: string, context?: Context): Promise<DateRangeContent> {
    return this.cms
      .dateRange(id, context)
      .catch(this.handleContentError(ContentType.DATE_RANGE, id, context))
  }

  asset(id: string, context?: Context): Promise<Asset> {
    return this.cms
      .asset(id, context)
      .catch(this.handleResourceError(new AssetId(id, undefined), context))
  }

  private handleContentError(
    contentType: ContentType,
    id: string,
    context: Context | undefined
  ): (reason: any) => never {
    return this.handleResourceError(ContentId.create(contentType, id), context)
  }

  private handleResourceError(
    resourceId: ResourceId,
    context: Context | undefined
  ): (reason: any) => never {
    return (reason: any) => {
      throw this.exceptionWrapper.wrap(
        reason,
        resourceId.resourceType,
        resourceId,
        {},
        context
      )
    }
  }

  private handleError(
    method: string,
    args: Record<string, any>,
    context: Context | undefined
  ): (reason: any) => never {
    return (reason: any) => {
      throw this.exceptionWrapper.wrap(reason, method, undefined, args, context)
    }
  }
}

export class ContentfulExceptionWrapper {
  // TODO add logStack in plugin config
  readonly logStack = true
  constructor(
    readonly wrappee: string,
    readonly logger = (msg: string) => {
      console.error(msg)
    }
  ) {}

  wrap(
    contentfulError: any,
    method: string,
    resourceId: ResourceId | undefined,
    args: Record<string, any>,
    context: Context | undefined
  ): CmsException {
    let content = ''
    if (context?.locale) {
      content += ` with locale '${context.locale}'`
    }
    if (resourceId) {
      content += ` on ${resourceId.toString()}`
    }
    if (Object.keys(args).length) {
      content += ` with args '${JSON.stringify(args)}'`
    }
    const msg = `Error calling ${this.wrappee}.${method}${content}`
    const exception = new CmsException(msg, contentfulError, resourceId)
    const err = this.processError(contentfulError)
    this.logger(`${msg} Due to ${err}`)

    throw exception
  }

  processError(contentfulError: Error): string {
    let err = ''
    if (contentfulError instanceof MultiError) {
      err += ' Due to:'
      for (const e of reduceMultiError(contentfulError)) {
        err += this.processError(e)
      }
    } else if (this.logStack && contentfulError.stack) {
      err += contentfulError.stack.split('\n').slice(0, 5).join('\n')
    } else {
      err += `Due to '${contentfulError.message}'`
    }
    return err
  }
}