Skip to content
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.

Sign up for GitHub

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

Support for dropdown of predefined options in data sources setup #4161

Merged
merged 7 commits into from
Oct 6, 2019
Merged

Support for dropdown of predefined options in data sources setup #4161

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0affa5c
Support for predefined options in data sources
gabrieldutra Sep 21, 2019
bfd70cb
Merge branch 'master' into ds-predefined-options
gabrieldutra Sep 24, 2019
808da1f
DynamicForm Select: title -> name
gabrieldutra Sep 24, 2019
d807a85
Make it work with "enum" prop
gabrieldutra Sep 24, 2019
d40af5b
Make it work for "extendedEnum" prop
gabrieldutra Sep 24, 2019
5e7415d
Not JS
gabrieldutra Sep 24, 2019
1aa7624
Deep copy the configuration schema
gabrieldutra Sep 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions client/app/components/dynamic-form/DynamicForm.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,21 @@ class DynamicForm extends React.Component {
};

return getFieldDecorator(name, decoratorOptions)(
<Select {...props} optionFilterProp="children" loading={loading || false} mode={mode}>
{options && options.map(({ value, title }) => (
<Option key={`${value}`} value={value} disabled={readOnly}>{ title || value }</Option>
<Select
{...props}
optionFilterProp="children"
loading={loading || false}
mode={mode}
getPopupContainer={trigger => trigger.parentNode}
>
{options && options.map(option => (
<Option
key={`${option.value}`}
value={option.value}
disabled={readOnly}
>
{option.name || option.value}
</Option>
))}
</Select>,
);
Expand Down
45 changes: 34 additions & 11 deletions client/app/components/dynamic-form/dynamicFormHelper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React from 'react';
import { each, includes, isUndefined } from 'lodash';
import { each, includes, isUndefined, isEmpty, map } from 'lodash';

function orderedInputs(properties, order, targetOptions) {
const inputs = new Array(order.length);
Expand All @@ -14,6 +14,11 @@ function orderedInputs(properties, order, targetOptions) {
initialValue: targetOptions[key],
};

if (input.type === 'select') {
input.placeholder = 'Select an option';
input.options = properties[key].options;
}

if (position > -1) {
inputs[position] = input;
} else {
Expand Down Expand Up @@ -41,27 +46,45 @@ function normalizeSchema(configurationSchema) {
prop.type = 'text';
}

if (!isEmpty(prop.enum)) {
prop.type = 'select';
prop.options = map(prop.enum, value => ({ value, name: value }));
}

if (!isEmpty(prop.extendedEnum)) {
prop.type = 'select';
prop.options = prop.extendedEnum;
}

prop.required = includes(configurationSchema.required, name);
});

configurationSchema.order = configurationSchema.order || [];
}

function setDefaultValueForCheckboxes(configurationSchema, options = {}) {
if (Object.keys(options).length === 0) {
const properties = configurationSchema.properties;
Object.keys(properties).forEach((property) => {
if (!isUndefined(properties[property].default) && properties[property].type === 'checkbox') {
options[property] = properties[property].default;
}
});
}
function setDefaultValueToFields(configurationSchema, options = {}) {
const properties = configurationSchema.properties;
Object.keys(properties).forEach((key) => {
const property = properties[key];
// set default value for checkboxes
if (!isUndefined(property.default) && property.type === 'checkbox') {
options[key] = property.default;
}
// set default or first value when value has predefined options
if (property.type === 'select') {
const optionValues = map(property.options, option => option.value);
options[key] = includes(optionValues, property.default) ? property.default : optionValues[0];
}
});
}

function getFields(type = {}, target = { options: {} }) {
const configurationSchema = type.configuration_schema;
normalizeSchema(configurationSchema);
setDefaultValueForCheckboxes(configurationSchema, target.options);
const hasTargetObject = Object.keys(target.options).length > 0;
if (!hasTargetObject) {
setDefaultValueToFields(configurationSchema, target.options);
}

const isNewTarget = !target.id;
const inputs = [
Expand Down
4 changes: 2 additions & 2 deletions client/app/components/users/UserEdit.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export default class UserEdit extends React.Component {
componentDidMount() {
Group.query((groups) => {
this.setState({
groups: groups.map(({ id, name }) => ({ value: id, title: name })),
groups: groups.map(({ id, name }) => ({ value: id, name })),
loadingGroups: false,
});
});
Expand Down Expand Up @@ -165,7 +165,7 @@ export default class UserEdit extends React.Component {
<div data-test="Groups">
{groups.filter(group => includes(user.groupIds, group.value)).map((group => (
<Tag className="m-b-5 m-r-5" key={group.value}>
<a href={`groups/${group.value}`}>{group.title}</a>
<a href={`groups/${group.value}`}>{group.name}</a>
</Tag>
)))}
</div>
Expand Down
6 changes: 5 additions & 1 deletion redash/query_runner/impala_ds.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,11 @@ def configuration_schema(cls):
},
"protocol": {
"type": "string",
"title": "Please specify beeswax or hiveserver2"
"extendedEnum": [
{"value": "beeswax", "name": "Beeswax"},
{"value": "hiveserver2", "name": "Hive Server 2"}
],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This won't pass schema validation. A valid enum is:

{
    "protocol": {
        "type": "string",
        "enum": ["beeswax", "hiveserver2"]
    }
}

We might want to add our own extension to provide friendly names for options:

{
    "protocol": {
        "type": "string",
        "extendedEnum": [{"value", "beeswax", "name": "Beeswax"}, {"value": "hiveserver2", "name": "Hive Server 2"}]
    }
}

And we will transform extendedEnum into enum before passing it into jsonschema.validate call.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might want to add our own extension to provide friendly names for options

That's exactly why I went with the list of objects on that, but yeah, it does make sense to permit a simplified version.

And we will transform extendedEnum into enum before passing it into jsonschema.validate call.

That's the only thing missing in terms of backend code?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's the only thing missing in terms of backend code?

I think so.

"title": "Protocol"
},
"database": {
"type": "string"
Expand Down
5 changes: 5 additions & 0 deletions redash/utils/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ def __init__(self, config, schema=None):
self.set_schema(schema)

def set_schema(self, schema):
if isinstance(schema, dict):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not needed: schema is always a dict.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was getting a "NoneType has no attribute..." And that's why I put it 😬

for prop in schema.get('properties', {}).values():
if 'extendedEnum' in prop:
prop['enum'] = map(lambda v: v['value'], prop['extendedEnum'])
del prop['extendedEnum']
self._schema = schema

@property
Expand Down