nocodb/packages/nc-gui/components/dashboard/settings/data-sources/EditBase.vue

<script lang="ts" setup>
import type { SourceType } from 'nocodb-sdk'
import { Form, message } from 'ant-design-vue'
import type { SelectHandler } from 'ant-design-vue/es/vc-select/Select'
import {
  type CertTypes,
  ClientType,
  type DatabricksConnection,
  type DefaultConnection,
  type ProjectCreateForm,
  type SQLiteConnection,
  SSLUsage,
  type SnowflakeConnection,
  clientTypes as _clientTypes,
} from '#imports'

const props = defineProps<{
  sourceId: string
}>()

const emit = defineEmits(['baseUpdated', 'close'])

const baseStore = useBase()
const basesStore = useBases()
const { base } = storeToRefs(baseStore)

const _projectId = inject(ProjectIdInj, undefined)
const baseId = computed(() => _projectId?.value ?? base.value?.id)

const { refreshCommandPalette } = useCommandPalette()

const useForm = Form.useForm

const testSuccess = ref(false)

const testingConnection = ref(false)

const form = ref<typeof Form>()

const { api } = useApi()

const { $e } = useNuxtApp()

const { t } = useI18n()

const editingSource = ref(false)

const clientTypes = computed(() => {
  return _clientTypes.filter((type) => {
    return ![ClientType.SNOWFLAKE, ClientType.DATABRICKS].includes(type.value)
  })
})

const formState = ref<ProjectCreateForm>({
  title: '',
  dataSource: { ...getDefaultConnectionConfig(ClientType.MYSQL) },
  inflection: {
    inflectionColumn: 'none',
    inflectionTable: 'none',
  },
  sslUse: SSLUsage.No,
  extraParameters: [],
})

const customFormState = ref<ProjectCreateForm>({
  title: '',
  dataSource: { ...getDefaultConnectionConfig(ClientType.MYSQL) },
  inflection: {
    inflectionColumn: 'none',
    inflectionTable: 'none',
  },
  sslUse: SSLUsage.No,
  extraParameters: [],
  meta: {
    readOnlySchema: true,
    readOnlyData: false,
  },
})

const validators = computed(() => {
  return {
    'title': [baseTitleValidator],
    'extraParameters': [extraParameterValidator],
    'dataSource.client': [fieldRequiredValidator()],
    ...(formState.value.dataSource.client === ClientType.SQLITE
      ? {
          'dataSource.connection.connection.filename': [fieldRequiredValidator()],
        }
      : formState.value.dataSource.client === ClientType.SNOWFLAKE
      ? {
          'dataSource.connection.account': [fieldRequiredValidator()],
          'dataSource.connection.username': [fieldRequiredValidator()],
          'dataSource.connection.password': [fieldRequiredValidator()],
          'dataSource.connection.warehouse': [fieldRequiredValidator()],
          'dataSource.connection.database': [fieldRequiredValidator()],
          'dataSource.connection.schema': [fieldRequiredValidator()],
        }
      : {
          'dataSource.connection.host': [fieldRequiredValidator()],
          'dataSource.connection.port': [fieldRequiredValidator()],
          'dataSource.connection.user': [fieldRequiredValidator()],
          'dataSource.connection.password': [fieldRequiredValidator()],
          'dataSource.connection.database': [fieldRequiredValidator()],
          ...([ClientType.PG, ClientType.MSSQL].includes(formState.value.dataSource.client) &&
          formState.value.dataSource.searchPath
            ? {
                'dataSource.searchPath.0': [fieldRequiredValidator()],
              }
            : {}),
        }),
  }
})

const { validate, validateInfos } = useForm(formState, validators)

const onClientChange = () => {
  formState.value.dataSource = { ...getDefaultConnectionConfig(formState.value.dataSource.client) }
}

const onSSLModeChange = ((mode: SSLUsage) => {
  if (formState.value.dataSource.client !== ClientType.SQLITE) {
    const connection = formState.value.dataSource.connection as DefaultConnection
    switch (mode) {
      case SSLUsage.No:
        delete connection.ssl
        break
      case SSLUsage.Allowed:
        connection.ssl = 'true'
        break
      default:
        connection.ssl = {
          ca: '',
          cert: '',
          key: '',
        }
        break
    }
  }
}) as SelectHandler

const updateSSLUse = () => {
  if (formState.value.dataSource.client !== ClientType.SQLITE) {
    const connection = formState.value.dataSource.connection as DefaultConnection
    if (connection.ssl) {
      if (typeof connection.ssl === 'string') {
        formState.value.sslUse = SSLUsage.Allowed
      } else {
        formState.value.sslUse = SSLUsage.Preferred
      }
    } else {
      formState.value.sslUse = SSLUsage.No
    }
  }
}

const addNewParam = () => {
  formState.value.extraParameters.push({ key: '', value: '' })
}

const removeParam = (index: number) => {
  formState.value.extraParameters.splice(index, 1)
}

const inflectionTypes = ['camelize', 'none']
const importURL = ref('')
const configEditDlg = ref(false)
const importURLDlg = ref(false)

const caFileInput = ref<HTMLInputElement>()
const keyFileInput = ref<HTMLInputElement>()
const certFileInput = ref<HTMLInputElement>()

const onFileSelect = (key: CertTypes, el?: HTMLInputElement) => {
  if (!el) return

  readFile(el, (content) => {
    if ('ssl' in formState.value.dataSource.connection && typeof formState.value.dataSource.connection.ssl === 'object')
      formState.value.dataSource.connection.ssl[key] = content ?? ''
  })
}

const sslFilesRequired = computed(
  () => !!formState.value.sslUse && formState.value.sslUse !== SSLUsage.No && formState.value.sslUse !== SSLUsage.Allowed,
)

function getConnectionConfig() {
  const extraParameters = Object.fromEntries(new Map(formState.value.extraParameters.map((object) => [object.key, object.value])))

  const connection = {
    ...formState.value.dataSource.connection,
    ...extraParameters,
  }

  if ('ssl' in connection && connection.ssl) {
    if (
      formState.value.sslUse === SSLUsage.No ||
      (typeof connection.ssl === 'object' && Object.values(connection.ssl).every((v) => v === null || v === undefined))
    ) {
      delete connection.ssl
    }
  }
  return connection
}

const focusInvalidInput = () => {
  form.value?.$el.querySelector('.ant-form-item-explain-error')?.parentNode?.parentNode?.querySelector('input')?.focus()
}

const editBase = async () => {
  try {
    await validate()
  } catch (e) {
    focusInvalidInput()
    return
  }

  try {
    if (!base.value?.id) return

    const connection = getConnectionConfig()

    const config = { ...formState.value.dataSource, connection }

    // todo: refactor and remove this duplicate path in config
    if (config.client === ClientType.SQLITE && config.connection?.connection?.filename) {
      config.connection.filename = config.connection.connection.filename
    }

    await api.source.update(base.value?.id, props.sourceId, {
      alias: formState.value.title,
      type: formState.value.dataSource.client,
      config,
      inflection_column: formState.value.inflection.inflectionColumn,
      inflection_table: formState.value.inflection.inflectionTable,
    })

    $e('a:source:edit:extdb')

    await basesStore.loadProject(baseId.value!, true)
    emit('baseUpdated')
    emit('close')
  } catch (e: any) {
    message.error(await extractSdkResponseErrorMsg(e))
  } finally {
    refreshCommandPalette()
  }
}

const testConnection = async () => {
  try {
    await validate()
  } catch (e) {
    focusInvalidInput()
    return
  }

  $e('a:source:edit:extdb:test-connection', [])

  try {
    testingConnection.value = true

    if (formState.value.dataSource.client === ClientType.SQLITE) {
      testSuccess.value = true
    } else {
      const connection = getConnectionConfig()

      connection.database = getTestDatabaseName(formState.value.dataSource)!

      const testConnectionConfig = {
        ...formState.value.dataSource,
        connection,
      }

      const result = await api.utils.testConnection(testConnectionConfig)

      if (result.code === 0) {
        testSuccess.value = true
      } else {
        testSuccess.value = false

        message.error(`${t('msg.error.dbConnectionFailed')} ${result.message}`)
      }
    }
  } catch (e: any) {
    testSuccess.value = false

    message.error(await extractSdkResponseErrorMsg(e))
  }

  testingConnection.value = false
}

const handleImportURL = async () => {
  if (!importURL.value || importURL.value === '') return

  const connectionConfig = await api.utils.urlToConfig({ url: importURL.value })

  if (connectionConfig) {
    formState.value.dataSource.client = connectionConfig.client
    formState.value.dataSource.connection = { ...connectionConfig.connection }
  } else {
    message.error(t('msg.error.invalidURL'))
  }
  importURLDlg.value = false
  updateSSLUse()
}

const handleEditJSON = () => {
  customFormState.value = formState.value
  configEditDlg.value = true
}

const handleOk = () => {
  formState.value = customFormState.value
  configEditDlg.value = false
  updateSSLUse()
}

// reset test status on config change
watch(
  () => formState.value.dataSource,
  () => (testSuccess.value = false),
  { deep: true },
)

// load source config
onMounted(async () => {
  if (base.value?.id) {
    const definedParameters = ['host', 'port', 'user', 'password', 'database']

    const activeBase = (await api.source.read(base.value?.id, props.sourceId)) as SourceType

    const tempParameters = Object.entries(activeBase.config.connection)
      .filter(([key]) => !definedParameters.includes(key))
      .map(([key, value]) => ({ key: key as string, value: value as string }))

    formState.value = {
      title: activeBase.alias || '',
      dataSource: activeBase.config,
      inflection: {
        inflectionColumn: activeBase.inflection_column,
        inflectionTable: activeBase.inflection_table,
      },
      extraParameters: tempParameters,
      sslUse: SSLUsage.No,
    }
    updateSSLUse()
  }
})

// if searchPath is null/undefined reset it to empty array when necessary
watch(
  () => formState.value.dataSource.searchPath,
  (val) => {
    if ([ClientType.PG, ClientType.MSSQL].includes(formState.value.dataSource.client) && !val) {
      formState.value.dataSource.searchPath = []
    }
  },
  {
    immediate: true,
  },
)
</script>

<template>
  <div class="edit-source bg-white relative flex flex-col justify-start gap-2 w-full p-2">
    <h1 class="prose-2xl font-bold self-start">{{ $t('activity.editSource') }}</h1>

    <a-form ref="form" :model="formState" name="external-base-create-form" layout="horizontal" no-style :label-col="{ span: 8 }">
      <div
        class="nc-scrollbar-md"
        :style="{
          maxHeight: '60vh',
        }"
      >
        <a-form-item label="Source Name" v-bind="validateInfos.title">
          <a-input v-model:value="formState.title" class="nc-extdb-proj-name" />
        </a-form-item>

        <a-form-item :label="$t('labels.dbType')" v-bind="validateInfos['dataSource.client']">
          <a-select
            v-model:value="formState.dataSource.client"
            class="nc-extdb-db-type"
            dropdown-class-name="nc-dropdown-ext-db-type"
            @change="onClientChange"
          >
            <a-select-option v-for="client in clientTypes" :key="client.value" :value="client.value"
              >{{ client.text }}
            </a-select-option>
          </a-select>
        </a-form-item>

        <!-- SQLite File -->
        <a-form-item
          v-if="formState.dataSource.client === ClientType.SQLITE"
          :label="$t('labels.sqliteFile')"
          v-bind="validateInfos['dataSource.connection.connection.filename']"
        >
          <a-input v-model:value="(formState.dataSource.connection as SQLiteConnection).connection.filename" />
        </a-form-item>

        <template v-else-if="formState.dataSource.client === ClientType.SNOWFLAKE">
          <!-- Account -->
          <a-form-item :label="$t('labels.account')" v-bind="validateInfos['dataSource.connection.account']">
            <a-input
              v-model:value="(formState.dataSource.connection as SnowflakeConnection).account"
              class="nc-extdb-host-address"
            />
          </a-form-item>

          <!-- Username -->
          <a-form-item :label="$t('labels.username')" v-bind="validateInfos['dataSource.connection.username']">
            <a-input
              v-model:value="(formState.dataSource.connection as SnowflakeConnection).username"
              class="nc-extdb-host-user"
            />
          </a-form-item>

          <!-- Password -->
          <a-form-item :label="$t('labels.password')" v-bind="validateInfos['dataSource.connection.password']">
            <a-input-password
              v-model:value="(formState.dataSource.connection as SnowflakeConnection).password"
              class="nc-extdb-host-password"
            />
          </a-form-item>

          <!-- Warehouse -->
          <a-form-item label="Warehouse" v-bind="validateInfos['dataSource.connection.warehouse']">
            <a-input
              v-model:value="(formState.dataSource.connection as SnowflakeConnection).warehouse"
              class="nc-extdb-host-database"
            />
          </a-form-item>

          <!-- Database -->
          <a-form-item :label="$t('labels.database')" v-bind="validateInfos['dataSource.connection.database']">
            <a-input
              v-model:value="(formState.dataSource.connection as SnowflakeConnection).database"
              class="nc-extdb-host-database"
            />
          </a-form-item>

          <!-- Schema -->
          <a-form-item label="Schema" v-bind="validateInfos['dataSource.connection.schema']">
            <a-input
              v-model:value="(formState.dataSource.connection as SnowflakeConnection).schema"
              class="nc-extdb-host-database"
            />
          </a-form-item>
        </template>

        <template v-else-if="formState.dataSource.client === ClientType.DATABRICKS">
          <a-form-item label="Token" v-bind="validateInfos['dataSource.connection.token']">
            <a-input
              v-model:value="(formState.dataSource.connection as DatabricksConnection).token"
              class="nc-extdb-host-token"
            />
          </a-form-item>

          <a-form-item label="Host" v-bind="validateInfos['dataSource.connection.host']">
            <a-input
              v-model:value="(formState.dataSource.connection as DatabricksConnection).host"
              class="nc-extdb-host-address"
            />
          </a-form-item>

          <a-form-item label="Path" v-bind="validateInfos['dataSource.connection.path']">
            <a-input v-model:value="(formState.dataSource.connection as DatabricksConnection).path" class="nc-extdb-host-path" />
          </a-form-item>

          <a-form-item label="Database" v-bind="validateInfos['dataSource.connection.database']">
            <a-input
              v-model:value="(formState.dataSource.connection as DatabricksConnection).database"
              class="nc-extdb-host-database"
            />
          </a-form-item>

          <a-form-item label="Schema" v-bind="validateInfos['dataSource.connection.schema']">
            <a-input
              v-model:value="(formState.dataSource.connection as DatabricksConnection).schema"
              class="nc-extdb-host-schema"
            />
          </a-form-item>
        </template>

        <template v-else>
          <!-- Host Address -->
          <a-form-item :label="$t('labels.hostAddress')" v-bind="validateInfos['dataSource.connection.host']">
            <a-input v-model:value="(formState.dataSource.connection as DefaultConnection).host" class="nc-extdb-host-address" />
          </a-form-item>

          <!-- Port Number -->
          <a-form-item :label="$t('labels.port')" v-bind="validateInfos['dataSource.connection.port']">
            <a-input-number
              v-model:value="(formState.dataSource.connection as DefaultConnection).port"
              class="!w-full nc-extdb-host-port"
            />
          </a-form-item>

          <!-- Username -->
          <a-form-item :label="$t('labels.username')" v-bind="validateInfos['dataSource.connection.user']">
            <a-input v-model:value="(formState.dataSource.connection as DefaultConnection).user" class="nc-extdb-host-user" />
          </a-form-item>

          <!-- Password -->
          <a-form-item :label="$t('labels.password')">
            <a-input-password
              v-model:value="(formState.dataSource.connection as DefaultConnection).password"
              class="nc-extdb-host-password"
            />
          </a-form-item>

          <!-- Database -->
          <a-form-item :label="$t('labels.database')" v-bind="validateInfos['dataSource.connection.database']">
            <!-- Database : create if not exists -->
            <a-input
              v-model:value="formState.dataSource.connection.database"
              :placeholder="$t('labels.dbCreateIfNotExists')"
              class="nc-extdb-host-database"
            />
          </a-form-item>

          <!-- Schema name -->
          <a-form-item
            v-if="[ClientType.MSSQL, ClientType.PG].includes(formState.dataSource.client) && formState.dataSource.searchPath"
            :label="$t('labels.schemaName')"
            v-bind="validateInfos['dataSource.searchPath.0']"
          >
            <a-input v-model:value="formState.dataSource.searchPath[0]" />
          </a-form-item>

          <a-form-item label="Readonly Schema">
            <a-switch v-model:checked="formState.meta.readOnlySchema" size="small"></a-switch>
          </a-form-item>
          <a-form-item label="Readonly Data">
            <a-switch v-model:checked="formState.meta.readOnlyData" size="small"></a-switch>
          </a-form-item>

          <!--                Use Connection URL -->
          <div class="flex justify-end gap-2">
            <NcButton size="small" type="ghost" class="nc-extdb-btn-import-url !rounded-md" @click.stop="importURLDlg = true">
              {{ $t('activity.useConnectionUrl') }}
            </NcButton>
          </div>
          <a-collapse ghost expand-icon-position="right" class="!mt-6">
            <a-collapse-panel key="1">
              <template #header>
                <div class="flex items-center gap-2">
                  <span>{{ $t('title.advancedParameters') }}</span>
                </div>
              </template>
              <a-form-item label="SSL mode">
                <a-select v-model:value="formState.sslUse" dropdown-class-name="nc-dropdown-ssl-mode" @select="onSSLModeChange">
                  <a-select-option v-for="opt in Object.values(SSLUsage)" :key="opt" :value="opt">{{ opt }}</a-select-option>
                </a-select>
              </a-form-item>

              <a-form-item label="SSL keys">
                <div class="flex gap-2">
                  <a-tooltip placement="top">
                    <!-- Select .cert file -->
                    <template #title>
                      <span>{{ $t('tooltip.clientCert') }}</span>
                    </template>

                    <NcButton size="small" :disabled="!sslFilesRequired" class="shadow" @click="certFileInput?.click()">
                      {{ $t('labels.clientCert') }}
                    </NcButton>
                  </a-tooltip>

                  <a-tooltip placement="top">
                    <!-- Select .key file -->
                    <template #title>
                      <span>{{ $t('tooltip.clientKey') }}</span>
                    </template>
                    <NcButton size="small" :disabled="!sslFilesRequired" class="shadow" @click="keyFileInput?.click()">
                      {{ $t('labels.clientKey') }}
                    </NcButton>
                  </a-tooltip>

                  <a-tooltip placement="top">
                    <!-- Select CA file -->
                    <template #title>
                      <span>{{ $t('tooltip.clientCA') }}</span>
                    </template>

                    <NcButton size="small" :disabled="!sslFilesRequired" class="shadow" @click="caFileInput?.click()">
                      {{ $t('labels.serverCA') }}
                    </NcButton>
                  </a-tooltip>
                </div>
              </a-form-item>

              <input ref="caFileInput" type="file" class="!hidden" @change="onFileSelect(CertTypes.ca, caFileInput)" />

              <input ref="certFileInput" type="file" class="!hidden" @change="onFileSelect(CertTypes.cert, certFileInput)" />

              <input ref="keyFileInput" type="file" class="!hidden" @change="onFileSelect(CertTypes.key, keyFileInput)" />

              <a-divider />

              <!--            Extra connection parameters -->
              <a-form-item class="mb-2" :label="$t('labels.extraConnectionParameters')" v-bind="validateInfos.extraParameters">
                <a-card>
                  <div v-for="(item, index) of formState.extraParameters" :key="index">
                    <div class="flex py-1 items-center gap-1">
                      <a-input v-model:value="item.key" />

                      <span>:</span>

                      <a-input v-model:value="item.value" />

                      <component
                        :is="iconMap.close"
                        :style="{ 'font-size': '1.5em', 'color': 'red' }"
                        @click="removeParam(index)"
                      />
                    </div>
                  </div>
                  <NcButton size="small" type="dashed" class="w-full caption mt-2" @click="addNewParam">
                    <div class="flex items-center justify-center"><component :is="iconMap.plus" /></div>
                  </NcButton>
                </a-card>
              </a-form-item>

              <a-divider />

              <a-form-item :label="$t('labels.inflection.tableName')">
                <a-select
                  v-model:value="formState.inflection.inflectionTable"
                  dropdown-class-name="nc-dropdown-inflection-table-name"
                >
                  <a-select-option v-for="tp in inflectionTypes" :key="tp" :value="tp">{{ tp }}</a-select-option>
                </a-select>
              </a-form-item>

              <a-form-item :label="$t('labels.inflection.columnName')">
                <a-select
                  v-model:value="formState.inflection.inflectionColumn"
                  dropdown-class-name="nc-dropdown-inflection-column-name"
                >
                  <a-select-option v-for="tp in inflectionTypes" :key="tp" :value="tp">{{ tp }}</a-select-option>
                </a-select>
              </a-form-item>

              <div class="flex justify-end">
                <NcButton size="small" type="primary" class="!rounded-md" @click="handleEditJSON()">
                  <!-- Edit connection JSON -->
                  {{ $t('activity.editConnJson') }}
                </NcButton>
              </div>
            </a-collapse-panel>
          </a-collapse>
        </template>
      </div>

      <a-form-item class="flex justify-end !mt-5">
        <div class="flex justify-end gap-2">
          <NcButton
            :type="testSuccess ? 'ghost' : 'primary'"
            size="small"
            class="nc-extdb-btn-test-connection !rounded-md"
            :loading="testingConnection"
            @click="testConnection"
          >
            <GeneralIcon v-if="testSuccess" icon="circleCheck" class="text-primary mr-2" />
            {{ $t('activity.testDbConn') }}
          </NcButton>

          <NcButton
            class="nc-extdb-btn-submit !rounded-md"
            size="small"
            type="primary"
            :disabled="!testSuccess"
            :loading="editingSource"
            @click="editBase"
          >
            {{ $t('general.submit') }}
          </NcButton>
        </div>
      </a-form-item>
      <div class="w-full flex items-center mt-2 text-[#e65100]">
        <component :is="iconMap.warning" class="mr-2 mb-5.9" />
        <div>{{ $t('msg.warning.dbValid') }}</div>
      </div>
    </a-form>

    <a-modal
      v-model:visible="configEditDlg"
      :title="$t('activity.editConnJson')"
      width="500px"
      wrap-class-name="nc-modal-edit-connection-json"
      @ok="handleOk"
    >
      <MonacoEditor v-if="configEditDlg" v-model="customFormState" class="h-[400px] w-full" />
    </a-modal>

    <!--    Use Connection URL -->
    <a-modal
      v-model:visible="importURLDlg"
      :title="$t('activity.useConnectionUrl')"
      width="600px"
      :ok-text="$t('general.ok')"
      :cancel-text="$t('general.cancel')"
      wrap-class-name="nc-modal-connection-url"
      @ok="handleImportURL"
    >
      <a-input v-model:value="importURL" />
    </a-modal>
  </div>
</template>

<style lang="scss" scoped>
:deep(.ant-collapse-header) {
  @apply !pr-10 !-mt-4 text-right justify-end;
}

:deep(.ant-collapse-content-box) {
  @apply !px-0;
}

:deep(.ant-form-item-explain-error) {
  @apply !text-xs;
}

:deep(.ant-form-item) {
  @apply mb-2;
}

:deep(.ant-form-item-with-help .ant-form-item-explain) {
  @apply !min-h-0;
}

.edit-source {
  :deep(.ant-input-affix-wrapper),
  :deep(.ant-input),
  :deep(.ant-select) {
    @apply !appearance-none border-solid rounded;
  }

  :deep(.ant-input-password) {
    input {
      @apply !border-none my-0;
    }
  }
}
</style>