coriolis-web/src/plugins/endpoint/default/ConnectionSchemaPlugin.js

/*
Copyright (C) 2017  Cloudbase Solutions SRL
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

// @flow

import LabelDictionary from '../../../utils/LabelDictionary'
import Utils from '../../../utils/ObjectUtils'
import type { Schema, SchemaProperties, SchemaDefinitions } from '../../../types/Schema'
import type { Field } from '../../../types/Field'

export const defaultSchemaToFields = (schema: SchemaProperties, schemaDefinitions?: ?SchemaDefinitions, parent?: string): any[] => {
  if (!schema.properties) {
    return []
  }

  let fields = Object.keys(schema.properties).map(fieldName => {
    let properties: any = schema.properties[fieldName]

    if (typeof properties.$ref === 'string' && schemaDefinitions) {
      const definitionName = properties.$ref.substr(properties.$ref.lastIndexOf('/') + 1)
      properties = schemaDefinitions[definitionName]
      return {
        name: fieldName,
        type: properties.type ? properties.type : '',
        properties: properties.properties ? defaultSchemaToFields(properties, null, fieldName) : [],
      }
    } else if (properties.type === 'object' && properties.properties && Object.keys(properties.properties).length) {
      return {
        name: fieldName,
        type: 'object',
        properties: defaultSchemaToFields(properties, null, fieldName),
      }
    }

    const name = parent ? `${parent}/${fieldName}` : fieldName
    LabelDictionary.pushToCache({ name, title: properties.title, description: properties.description })

    return {
      ...properties,
      name,
      required: schema.required && schema.required.find(k => k === fieldName) ? true : fieldName === 'username' || fieldName === 'password',
    }
  })

  return fields
}

export const connectionSchemaToFields = (schema: SchemaProperties) => {
  let fields = defaultSchemaToFields(schema)

  let sortPriority = { username: 1, password: 2 }
  fields.sort((a, b) => {
    if (sortPriority[a.name] && sortPriority[b.name]) {
      return sortPriority[a.name] - sortPriority[b.name]
    }
    if (sortPriority[a.name] || (a.required && !b.required)) {
      return -1
    }
    if (sortPriority[b.name] || (!a.required && b.required)) {
      return 1
    }
    return a.name.localeCompare(b.name)
  })

  return fields
}

export const generateField = (name: string, label: string, required: boolean = false, type: string = 'string', defaultValue: any = null) => {
  let field = {
    name,
    label,
    type,
    required,
    default: undefined,
  }

  if (defaultValue) {
    field.default = defaultValue
  }

  return field
}

export const fieldsToPayload = (data: { [string]: mixed }, schema: SchemaProperties) => {
  let info = {}

  Object.keys(schema.properties).forEach(fieldName => {
    if (data[fieldName] && typeof data[fieldName] !== 'object') {
      info[fieldName] = Utils.trim(fieldName, data[fieldName])
    } else if (typeof schema.properties[fieldName] === 'object') {
      // $FlowIgnore
      let properties = schema.properties[fieldName] && schema.properties[fieldName].properties
      if (properties) {
        Object.keys(properties).forEach(fn => {
          let fullFn = `${fieldName}/${fn}`
          if (data[fullFn] != null) {
            if (!info[fieldName]) {
              info[fieldName] = {}
            }
            info[fieldName][fn] = Utils.trim(fn, data[fullFn])
          }
        })
      }
    } else if (
      !data[fieldName] &&
      schema.required && schema.required.find(f => f === fieldName) &&
      schema.properties[fieldName].default
    ) {
      info[fieldName] = schema.properties[fieldName].default
    }
  })

  return info
}

export default class ConnectionSchemaParser {
  static parseSchemaToFields(schema: Schema): Field[] {
    let fields = connectionSchemaToFields(schema.oneOf[0])

    fields = [
      generateField('name', 'Endpoint Name', true),
      generateField('description', 'Endpoint Description'),
      ...fields,
    ]

    return fields
  }

  static parseFieldsToPayload(data: { [string]: mixed }, schema: any) {
    let payload = {}

    payload.name = data.name
    payload.description = data.description

    let schemaRoot = schema.oneOf ? schema.oneOf[0] : schema
    payload.connection_info = fieldsToPayload(data, schemaRoot)

    if (data.secret_ref) {
      payload.connection_info.secret_ref = data.secret_ref
    }

    return payload
  }
}