@kravc/dos 1.12.6 → 2.0.0-alpha.1

package/src/helpers/createContext.js

@@ -1,96 +0,0 @@
-'use strict'
-
-const { parse } = require('url')
-const { v4: uuid } = require('uuid')
-const { get, isString } = require('lodash')
-
-const createContext = (service, request, extraContext = {}) => {
-  const { logger = console } = extraContext
-
-  let httpPath
-  let httpMethod
-
-  let { operationId } = request
-
-  if (!operationId) {
-    let { path } = request
-
-    if (!path) {
-      const { url } = request
-      path = parse(url, true).pathname
-    }
-
-    const { basePath } = service
-
-    httpPath   = path.replace(basePath, '/')
-    httpMethod = (request.method || request.httpMethod).toLowerCase()
-
-    operationId = service.getOperationId(httpMethod, httpPath)
-  }
-
-  const requestId = get(request, 'requestContext.requestId', uuid())
-
-  const context = {
-    headers:   {},
-    baseUrl:   service.baseUrl,
-    validator: service.validator,
-    requestReceivedAt: new Date().toISOString(),
-    logger,
-    httpPath,
-    requestId,
-    httpMethod,
-    operationId,
-    ...extraContext,
-  }
-
-  for (const name in request.headers) {
-    context.headers[name.toLowerCase()] = request.headers[name]
-  }
-
-  const { url, queryStringParameters, body } = request
-
-  context.query = {}
-
-  if (url) {
-    context.query = parse(url, true).query
-  }
-
-  if (queryStringParameters) {
-    const keys = Object.keys(queryStringParameters)
-
-    for (const key in keys) {
-      queryStringParameters[key] = decodeURIComponent(queryStringParameters[key])
-    }
-
-    context.query = queryStringParameters
-  }
-
-  const queryKeys = Object.keys(context.query)
-
-  for (const queryKey of queryKeys) {
-    const value = context.query[queryKey]
-
-    const isJsonArray = `${value}`.startsWith('["')
-
-    if (isJsonArray) {
-      context.query[queryKey] = JSON.parse(value)
-    }
-  }
-
-  if (body) {
-    const isJSON = isString(body)
-
-    if (isJSON) {
-      context.bodyJson = body
-      context.mutation = JSON.parse(body)
-
-    } else {
-      context.mutation = body
-
-    }
-  }
-
-  return context
-}
-
-module.exports = createContext

package/src/helpers/createSchemasMap.js

@@ -1,37 +0,0 @@
-'use strict'
-
-const path      = require('path')
-const { keyBy } = require('lodash')
-const loadSync  = require('./loadSync')
-const { readdirSync, statSync } = require('fs')
-
-const SCHEMA_CLASS_NAME = 'Schema'
-
-const listFilesSync = dir =>
-  readdirSync(dir)
-    .reduce((files, file) =>
-      statSync(path.join(dir, file)).isDirectory() ?
-        files.concat(listFilesSync(path.join(dir, file))) :
-        files.concat(path.join(dir, file))
-    , [])
-
-const readSchemasSync = path =>
-  listFilesSync(path)
-    .filter(fileName => fileName.endsWith('.yaml'))
-    .map(schemaPath => loadSync(schemaPath))
-
-const createSchemasMap = (path, modules) => {
-  const yamlSchemas = readSchemasSync(path)
-  const schemasMap  = keyBy(yamlSchemas, 'id')
-
-  const schemas = modules
-    .filter(item => item.constructor.name === SCHEMA_CLASS_NAME)
-
-  for (const schema of schemas) {
-    schemasMap[schema.id] = schema
-  }
-
-  return schemasMap
-}
-
-module.exports = createSchemasMap

package/src/helpers/createSpec.js

@@ -1,196 +0,0 @@
-'use strict'
-
-const { omit, uniq } = require('lodash')
-const ZSchema       = require('z-schema')
-const { parse }     = require('url')
-const jsonSchema    = require('../../assets/schemas/oas2.json')
-const getHttpMethod = require('./getHttpMethod')
-const getSuccessStatusCode = require('./getSuccessStatusCode')
-
-const ROOT_PATH = process.cwd()
-const { name: title, version } = require(`${ROOT_PATH}/package.json`)
-
-const formatErrorResponseDescription = errors => {
-  return errors
-    .map(({ code, description }) =>  {
-      if (!description) { return `\`${code}\`` }
-
-      return `\`${code}\` — ${description}`
-    })
-    .join('\n')
-}
-
-const createSpec = (operations, schemasMap, url) => {
-  const { protocol: _protocol, host, path: basePath } = parse(url)
-  const protocol = _protocol.replace(':', '')
-
-  const spec = {
-    swagger: '2.0',
-    host,
-    basePath,
-    schemes:  [ protocol ],
-    info: {
-      title,
-      version
-    },
-    consumes: [ 'application/json' ],
-    produces: [ 'application/json' ],
-    tags: [],
-    securityDefinitions: {},
-    paths: {},
-    definitions: {}
-  }
-
-  for (const schemaId in schemasMap) {
-    const isNotInputSchema = !schemaId.endsWith('Input')
-
-    if (isNotInputSchema) {
-      const schema = schemasMap[schemaId]
-      spec.definitions[schemaId] = omit(schema.jsonSchema, [ 'id' ])
-    }
-  }
-
-  let serviceTags = []
-  for (const Operation of operations) {
-    const httpPath    = `/${Operation.id}`
-    const httpMethod  = getHttpMethod(Operation)
-    const operationId = Operation.id
-
-    const {
-      tags,
-      query,
-      errors,
-      summary,
-      security,
-      description,
-      outputSchema,
-      mutationSchema
-    } = Operation
-
-    serviceTags = serviceTags.concat(tags)
-
-    const operationSpec = {
-      tags,
-      summary,
-      description,
-      operationId
-    }
-
-    const parameters = []
-
-    for (const name in query) {
-      const queryParameter = { in: 'query', name, type: 'string', ...query[name] }
-
-      if (queryParameter.example) {
-        queryParameter['x-example'] = queryParameter.example
-        delete queryParameter.example
-      }
-
-      parameters.push(queryParameter)
-    }
-
-    if (mutationSchema) {
-      parameters.push({
-        in:       'body',
-        name:     'mutation',
-        schema:   { $ref: mutationSchema.id },
-        required: true
-      })
-    }
-
-    const hasParameters = parameters.length > 0
-
-    if (hasParameters) {
-      operationSpec.parameters = parameters
-    }
-
-    const successStatusCode = getSuccessStatusCode(Operation)
-    const success = { description: 'Successful operation execution response' }
-
-    if (outputSchema) {
-      success.schema = { $ref: outputSchema.id }
-    }
-
-    const responses = {
-      [successStatusCode]: success,
-      default: {
-        description: '`OperationError` — Default operation error',
-        schema: { $ref: 'OperationError' }
-      }
-    }
-
-    const errorsMap = {}
-
-    for (const code in errors) {
-      const { statusCode, description } = errors[code]
-
-      errorsMap[`${statusCode}`] = errorsMap[`${statusCode}`] || []
-      errorsMap[`${statusCode}`].push({ code, description })
-    }
-
-    for (const statusCode in errorsMap) {
-      const description = formatErrorResponseDescription(errorsMap[statusCode])
-
-      responses[`${statusCode}`] = {
-        schema: { $ref: 'OperationError' },
-        description
-      }
-    }
-
-    operationSpec.responses = responses
-
-    const hasSecurityRequirements = security.length > 0
-
-    if (hasSecurityRequirements) {
-      operationSpec.security = []
-
-      for (const requirements of security) {
-
-        const config = {}
-        for (const name in requirements) {
-          const { definition } = requirements[name]
-          spec.securityDefinitions[name] = definition
-
-          config[name] = []
-        }
-
-        operationSpec.security.push(config)
-      }
-    }
-
-    spec.paths[httpPath] = { [httpMethod]: operationSpec }
-  }
-
-  serviceTags = uniq(serviceTags)
-  serviceTags.sort((a, b) => {
-    const aStartsWithUpper = /^[A-Z]/.test(a)
-    const bStartsWithUpper = /^[A-Z]/.test(b)
-
-    if (aStartsWithUpper && !bStartsWithUpper) { return -1 }
-
-    if (!aStartsWithUpper && bStartsWithUpper) { return 1 }
-
-    return a.localeCompare(b)
-  })
-  spec.tags = serviceTags.map(name => ({ name }))
-
-  const json = JSON
-    .stringify(spec, null, 2)
-    .replace(/"\$ref": "/g, '"$ref": "#/definitions/')
-
-  const result = JSON.parse(json)
-
-  const validator = new ZSchema({ ignoreUnknownFormats: true })
-  const isValid = validator.validate(result, { id: 'Spec', ...jsonSchema })
-
-  if (!isValid) {
-    const validationErrors = validator.getLastErrors()
-
-    const json = JSON.stringify(validationErrors, null, 2)
-    throw new Error(`Service spec validation failed: ${json}`)
-  }
-
-  return result
-}
-
-module.exports = createSpec

package/src/helpers/defaultId.js

@@ -1,30 +0,0 @@
-'use strict'
-
-const { startCase } = require('lodash')
-const pluralize = require('pluralize')
-
-const defaultId = Operation => {
-  const { name, Component, componentAction } = Operation
-
-  const isCustom = name !== 'Operation' && name !== ''
-
-  if (isCustom) {
-    return name
-  }
-
-  if (Component && componentAction) {
-    const isIndex    = componentAction === 'index'
-    const actionName = startCase(componentAction)
-
-    if (isIndex) {
-      const componentTitlePlural = pluralize(startCase(Component.name))
-      return `${actionName}${componentTitlePlural}`
-    }
-
-    return `${actionName}${Component.name}`
-  }
-
-  throw new Error('Operation ID is undefined')
-}
-
-module.exports = defaultId

package/src/helpers/defaultSummary.js

@@ -1,15 +0,0 @@
-'use strict'
-
-const { startCase, capitalize } = require('lodash')
-
-const defaultSummary = (Component, componentAction) => {
-  if (!Component) { return '' }
-
-  const { name } = Component
-
-  const componentTitle = startCase(name).toLowerCase()
-
-  return capitalize(`${componentAction} ${componentTitle}`)
-}
-
-module.exports = defaultSummary

package/src/helpers/defaultTags.js

@@ -1,16 +0,0 @@
-'use strict'
-
-const { startCase } = require('lodash')
-const pluralize = require('pluralize')
-
-const defaultTags = Component => {
-  if (!Component) { return [] }
-
-  const { name } = Component
-
-  const componentTitlePlural = pluralize(startCase(name))
-
-  return [ componentTitlePlural ]
-}
-
-module.exports = defaultTags

package/src/helpers/getComponentTitle.js

@@ -1,22 +0,0 @@
-'use strict'
-
-const { startCase, capitalize } = require('lodash')
-const pluralize = require('pluralize')
-
-const getComponentTitle = (Component, isCapitalized = true, isPlural = false) => {
-  const { name } = Component
-
-  let componentTitle = startCase(name).toLowerCase()
-
-  if (isPlural) {
-    componentTitle = pluralize(componentTitle)
-  }
-
-  if (isCapitalized) {
-    componentTitle = capitalize(componentTitle)
-  }
-
-  return componentTitle
-}
-
-module.exports = getComponentTitle

package/src/helpers/getDefaultSchemaAttributes.js

@@ -1,32 +0,0 @@
-'use strict'
-
-const { capitalize } = require('lodash')
-const getComponentTitle = require('./getComponentTitle')
-
-const getDefaultSchemaAttributes = (Component) => {
-  const documentTitle = getComponentTitle(Component, false)
-
-  return {
-    id: {
-      description: capitalize(documentTitle) + ' ID',
-      required:    true
-    },
-    createdAt: {
-      description: `Date and time when ${documentTitle} was created`,
-      format:      'date-time',
-      required:    true
-    },
-    updatedAt: {
-      description: `Date and time when ${documentTitle} was updated`,
-      format:      'date-time'
-    },
-    createdBy: {
-      description: `ID of a user who created ${documentTitle}`
-    },
-    updatedBy: {
-      description: `ID of a user who updated ${documentTitle}`
-    }
-  }
-}
-
-module.exports = getDefaultSchemaAttributes

package/src/helpers/getHttpMethod.js

@@ -1,19 +0,0 @@
-'use strict'
-
-const getHttpMethod = ({ types: TYPES, type }) => {
-  switch (type) {
-    case TYPES.CREATE:
-      return 'post'
-
-    case TYPES.DELETE:
-      return 'delete'
-
-    case TYPES.UPDATE:
-      return 'patch'
-
-    default:
-      return 'get'
-  }
-}
-
-module.exports = getHttpMethod

package/src/helpers/getIdPrefix.js

@@ -1,7 +0,0 @@
-'use strict'
-
-const getIdPrefix = componentName => {
-  return componentName
-}
-
-module.exports = getIdPrefix

package/src/helpers/getOrFail.js

@@ -1,24 +0,0 @@
-'use strict'
-
-const lodash = require('lodash')
-
-/**
- * Returns value by path from the object, throws exception if value not defined.
- * @param {object} object - The object to pull value by path
- * @param {string} path - The path of the value within object
- * @returns {any} A value
- */
-const getOrFail = (object, path) => {
-  const value = lodash.get(object, path)
-  const isUndefined = value === undefined
-
-  /* istanbul ignore else: we should not get here in tests */
-  if (!isUndefined) {
-    return value
-  }
-
-  /* istanbul ignore next: should never be reached at runtime */
-  throw Error(`Value is undefined for "${path}"`)
-}
-
-module.exports = getOrFail

package/src/helpers/getOrFail.spec.js

@@ -1,17 +0,0 @@
-'use strict'
-
-const getOrFail = require('./getOrFail')
-const { expect } = require('chai')
-
-describe('getOrFail(object, path)', () => {
-  it('returns requested value', () => {
-    const value = getOrFail({ target: 1 }, 'target')
-    expect(value).to.exist
-  })
-
-  it('throw error if value is undefined', () => {
-    expect(
-      () => getOrFail({}, 'target')
-    ).to.throw('Value is undefined for "target"')
-  })
-})

package/src/helpers/getSuccessStatusCode.js

@@ -1,15 +0,0 @@
-'use strict'
-
-const getSuccessStatusCode = ({ outputSchema, types, type }) => {
-  if (!outputSchema) {
-    return '204'
-  }
-
-  if (type === types.CREATE) {
-    return '201'
-  }
-
-  return '200'
-}
-
-module.exports = getSuccessStatusCode

package/src/helpers/handler.js

@@ -1,21 +0,0 @@
-'use strict'
-
-const logRequest = require('./logRequest')
-const createContext = require('./createContext')
-const specMiddleware = require('./specMiddleware')
-
-const handler = (service, _createContext = createContext, _middleware = specMiddleware) => {
-  return (request, extraContext) => {
-    const context = _createContext(service, request, extraContext)
-
-    const result = _middleware(service, context)
-
-    if (result) { return result }
-
-    logRequest(context)
-
-    return service.process(context)
-  }
-}
-
-module.exports = handler

package/src/helpers/loadSync.js

@@ -1,14 +0,0 @@
-'use strict'
-
-const { load }   = require('js-yaml')
-const { Schema } = require('@kravc/schema')
-const { readFileSync } = require('fs')
-
-const loadSync = (yamlPath) => {
-  const id     = yamlPath.split('/').reverse()[0].split('.yaml')[0]
-  const source = load(readFileSync(yamlPath))
-
-  return new Schema(source, id)
-}
-
-module.exports = loadSync

package/src/helpers/logError.js

@@ -1,33 +0,0 @@
-'use strict'
-
-const { pick }    = require('lodash')
-const maskSecrets = require('./maskSecrets')
-
-const OPERATION_CONTEXT_FIELDS = [
-  'query',
-  'mutation',
-  'identity',
-  'requestId',
-  'operationId',
-  'requestReceivedAt'
-]
-
-const logError = (context, errorResponse, originalError) => {
-  const { logger } = context
-
-  errorResponse.context = maskSecrets(pick(context, OPERATION_CONTEXT_FIELDS))
-
-  let unexpectedErrorMessage = ''
-
-  if (originalError.toJSON) {
-    errorResponse.originalError = originalError
-
-  } else {
-    unexpectedErrorMessage = `, Unexpected ${originalError.stack}`
-  }
-
-  const errorResponseJson = JSON.stringify(errorResponse, null, 2)
-  logger.error(`OperationError ${errorResponseJson}${unexpectedErrorMessage}`)
-}
-
-module.exports = logError

package/src/helpers/logRequest.js

@@ -1,36 +0,0 @@
-'use strict'
-
-const isTestEnvironment = () => process.env.NODE_APP_INSTANCE === 'test'
-
-const logRequest = context => {
-  if (isTestEnvironment()) {
-    return
-  }
-
-  const {
-    operationId,
-    query,
-    logger,
-    mutation,
-    requestId,
-    headers,
-    requestReceivedAt
-  } = context
-
-  const { host } = headers
-
-  const metadata = {
-    host,
-    requestId,
-    requestReceivedAt,
-    query,
-  }
-
-  if (mutation) {
-    metadata.mutation = mutation
-  }
-
-  logger.info(`${operationId}: ${JSON.stringify(metadata, null, 2)}`)
-}
-
-module.exports = logRequest

package/src/helpers/maskSecrets.js

@@ -1,42 +0,0 @@
-'use strict'
-
-const { isObject, cloneDeep } = require('lodash')
-const { isArray } = Array
-
-const SECRET_REGEXP = /(password|code|token|authorization|cookie)/i
-
-// NOTE: Theoretically this method can be applied to every log entry. This
-//       would require refactor of logger interface.
-const maskSecrets = object => {
-  for (const key in object) {
-    const value = object[key]
-
-    if (isArray(value)) {
-      for (const item of value) {
-        maskSecrets(item)
-      }
-
-      continue
-    }
-
-    if (isObject(value)) {
-      maskSecrets(value)
-
-      continue
-    }
-
-    const isSecret = SECRET_REGEXP.test(key)
-
-    if (isSecret) {
-      object[key] = '[MASKED]'
-    }
-  }
-}
-
-module.exports = input => {
-  const object = cloneDeep(input)
-
-  maskSecrets(object)
-
-  return object
-}