-
Notifications
You must be signed in to change notification settings - Fork 13.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: save database with new dynamic form #14583
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
158 changes: 158 additions & 0 deletions
158
superset-frontend/src/views/CRUD/data/database/DatabaseModal/DatabaseConnectionForm.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| import React, { FormEvent } from 'react'; | ||
| import cx from 'classnames'; | ||
| import { InputProps } from 'antd/lib/input'; | ||
| import { FormLabel, FormItem } from 'src/components/Form'; | ||
| import { Input } from 'src/common/components'; | ||
| import { StyledFormHeader, formScrollableStyles } from './styles'; | ||
| import { DatabaseForm } from '../types'; | ||
|
|
||
| export const FormFieldOrder = [ | ||
| 'host', | ||
| 'port', | ||
| 'database', | ||
| 'username', | ||
| 'password', | ||
| 'database_name', | ||
| ]; | ||
|
|
||
| const CHANGE_METHOD = { | ||
| onChange: 'onChange', | ||
| onPropertiesChange: 'onPropertiesChange', | ||
| }; | ||
|
|
||
| const FORM_FIELD_MAP = { | ||
| host: { | ||
| description: 'Host', | ||
| type: 'text', | ||
| className: 'w-50', | ||
| placeholder: 'e.g. 127.0.0.1', | ||
| changeMethod: CHANGE_METHOD.onPropertiesChange, | ||
| }, | ||
| port: { | ||
| description: 'Port', | ||
| type: 'text', | ||
| className: 'w-50', | ||
| placeholder: 'e.g. 5432', | ||
| changeMethod: CHANGE_METHOD.onPropertiesChange, | ||
| }, | ||
| database: { | ||
| description: 'Database name', | ||
| type: 'text', | ||
| label: | ||
| 'Copy the name of the PostgreSQL database you are trying to connect to.', | ||
| placeholder: 'e.g. world_population', | ||
| changeMethod: CHANGE_METHOD.onPropertiesChange, | ||
| }, | ||
| username: { | ||
| description: 'Username', | ||
| type: 'text', | ||
| placeholder: 'e.g. Analytics', | ||
| changeMethod: CHANGE_METHOD.onPropertiesChange, | ||
| }, | ||
| password: { | ||
| description: 'Password', | ||
| type: 'text', | ||
| placeholder: 'e.g. ********', | ||
| changeMethod: CHANGE_METHOD.onPropertiesChange, | ||
| }, | ||
| database_name: { | ||
| description: 'Display Name', | ||
| type: 'text', | ||
| label: 'Pick a nickname for this database to display as in Superset.', | ||
| changeMethod: CHANGE_METHOD.onChange, | ||
| }, | ||
| query: { | ||
| additionalProperties: {}, | ||
| description: 'Additional parameters', | ||
| type: 'object', | ||
| changeMethod: CHANGE_METHOD.onPropertiesChange, | ||
| }, | ||
| }; | ||
|
|
||
| const DatabaseConnectionForm = ({ | ||
| dbModel: { name, parameters }, | ||
| onParametersChange, | ||
| onChange, | ||
| }: { | ||
| dbModel: DatabaseForm; | ||
| onParametersChange: ( | ||
| event: FormEvent<InputProps> | { target: HTMLInputElement }, | ||
| ) => void; | ||
| onChange: ( | ||
| event: FormEvent<InputProps> | { target: HTMLInputElement }, | ||
| ) => void; | ||
| }) => ( | ||
| <> | ||
| <StyledFormHeader> | ||
| <h4>Enter the required {name} credentials</h4> | ||
| <p className="helper"> | ||
| Need help? Learn more about connecting to {name}. | ||
| </p> | ||
| </StyledFormHeader> | ||
| <div css={formScrollableStyles}> | ||
| {parameters && | ||
| FormFieldOrder.filter( | ||
| (key: string) => | ||
| Object.keys(parameters.properties).includes(key) || | ||
| key === 'database_name', | ||
| ).map(field => { | ||
| const { | ||
| className, | ||
| description, | ||
| type, | ||
| placeholder, | ||
| label, | ||
| changeMethod, | ||
| } = FORM_FIELD_MAP[field]; | ||
| const onEdit = | ||
| changeMethod === CHANGE_METHOD.onChange | ||
| ? onChange | ||
| : onParametersChange; | ||
| return ( | ||
| <FormItem | ||
| className={cx(className, `form-group-${className}`)} | ||
| key={field} | ||
| > | ||
| <FormLabel | ||
| htmlFor={field} | ||
| required={parameters.required.includes(field)} | ||
| > | ||
| {description} | ||
| </FormLabel> | ||
| <Input | ||
| name={field} | ||
| type={type} | ||
| id={field} | ||
| autoComplete="off" | ||
| placeholder={placeholder} | ||
| onChange={onEdit} | ||
| /> | ||
| <p className="helper">{label}</p> | ||
| </FormItem> | ||
| ); | ||
| })} | ||
| </div> | ||
| </> | ||
| ); | ||
|
|
||
| export const FormFieldMap = FORM_FIELD_MAP; | ||
|
|
||
| export default DatabaseConnectionForm; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: go with component based mapping like @betodealmeida was mentioning in our meeting this can be a later iteration but definitely think we implement this pattern
https://app.clubhouse.io/preset/story/15898/make-databaseconnectionform-tsx-have-component-based-mapping