PromucFlow_constructor/app/client/src/components/formControls/WhereClauseControl.tsx
Nidhi 906a7298dc
feat: Simplified Google Sheets queries (#14869)
* Client changes 1

* add DSL functionality

* Temp commit for refactoring changes

* Do I even know what I'm doing here?

* chore: Second GS layout

* Update: Visibility conditional outputs for schemas

- Added the output from conditional outputs for schema children too

* Update: Entity selector visibility control

- Added logic for controlling visibility of sub components via the JS expressions system

* Update: Passing disabled prop to toggle button

* Update: Passing disabled prop to toggle btn

* Update: Styled component for toggle button

- Added disabled styles based on the disabled prop sent to the toggle form view JSON button

* Update: configProperty role in Entity Selector

- Removed dependance of the configProperty of the entity selector children to it's parent component

* Update: type of placeholder key

- Made placeholder key from form config JSON to accept either string or an object
- Earlier only string was accepted
- This is for pagination component

* Update: Added placeholder control for pagination

* Client changes 1

* add DSL functionality

* Do I even know what I'm doing here?

* fix: updated uqi forms ui, clubbed JS switch button to ads, updated tooltip design

* fix: updated tooltip component for wrong ui on entity explore

* temp triggers

* fix: updated uqi forms ui, clubbed JS switch button to ads, updated tooltip design (#12395)

* fix: updated uqi forms ui, clubbed JS switch button to ads, updated tooltip design

* fix: updated tooltip component for wrong ui on entity explore

* fix: updated tooltip ui, where condition placement, sort by ui

* temp form data access logic

* fix: updated sorting type width ui

* fix: updated ui for spacing, width and text issues

* Update: Type for tooltip of UQI forms

- Added option to send an object to the tooltipText object.
- This allows for composite components like pagination to have tooltips for each sub component

* Update: tooltip for pagination component

- Added handling to parse the tooltip for multiple components.
- This allows for composite components like pagination to have tooltips for each sub component

* Update: Type cast for tooltip component

- Made the content passed to tooltip component as a string only

* Update: Fixed tooltip component CSS

* Update: Dropdown option component

- Added a tooltip wrapper to each option
- This is to show on hover text like disabled state

* fix: updated ẇhere clause broken ui for condition

* Add: functions to check and extract expressions

- Loop through the formConfig and find any keys that have a value that is bindable
- Used pre defined regex to check if value is a moustache binding

* Add: Types for evaluated form configs

- Added types for the form configs to be evaluated and their output post eval

* Add: Flow to run the form config

- Run the form config and update the result to the redux state

* Update: Name of the type for formconfigs

- Updated since it was clashing with a component of the same name

* Add: Function to enforce config type checks

- This is done so that the improper configs can be weeded out and the rest of the form can be shown

* Add: Function to update evaluated config

- Added option to update the config if it's values needed evaluation

* Add: Type check for schema sections

* Update: Error handling for invalid control type

- We were throwing an exception till now, changed it to a warning text

* Add: Exposed tooltip for dropdown option disabled state

* Update: switch to json mode functionality

- Added logic to convert data to a string rather than an object when the first switch to JSON mode happens

* Update: Added key to tooltip for dropdown options

* Trigger API modification

* Add: function to fetch default trigger URL

* Update: Made URL optional in dynamic trigger config

* Update: Dynamic trigger API call

- Made the API call for dynamic triggers have URL as optional field
- Added type check to the response of the API call

* Update: resp type for trigger APIs

* Update: Moved code to utils folder

- Moved functions for UQI form eval processing to utils file

* Update: passing original controltype to JS switch

* Update: config for JSON editor mode

- Updated the config to have different options for JSON mode depending on the original control type

* Update: Connected line numbers flag to config

* Revert: CSS changes for tooltip

* Refactor: Removed consle

* Add: type for the config of dynamic values

* Add: Feature to evaluate config for triggers

* Refactor: fix type check errors

* fix: dropdown ui width with text alignment

* Update: fixed selector for dynamic values

* Update: selector call for fetchDynamicValues

* Add table header index prop for columns selector

* migration partial commit

* migration partial commit

* Refactor: removed unused import

* Update: reused function for checking dynamic value

* Update: removed unused import

* Fix format JSON issues

* Retrieve binding paths from entity selector components

* Fixes 6 remaining issues with UQI implementation

* Fix dropdown issues

* Fix dropdown height issues and fixes triggering of APIs when option is deselected

* Migration changes

* Fix QA generated UQI issues

* Fix projection component height and route change logic

* Fix multi select dropdown placeholder text issue and json stringify issue with switching view types

* Reset entity type value when command value changes

* Test changes

* Review comments

* Moved migrations around

* Corrected import statement

* Added JSON schema migration

* Updated schema version

* perf improvements and filter dropdown options feature

* Fix Code mirror component config for toggleComponentToJson input fields.

* Fix prettier issues

* fix prettier issues

* Fix style issues as a result of the merged conflicts

* Fix failing test case

* Fixed a few other flows (#14225)

* Fixed a few other flows

* Review comments

* Fix generate CRUD, fix evaluation of dynamic bindings and fix various styling issues.

* More fixes (#14367)

* Factor in the root formconfig parent key.

* Fix flickering issues, and evaluatedFormConfig issues

* fix: Teeny bugs (#14455)

* Teeny bugs

* Added previous functionality as is

* Improvements in the way we fetch dynamic values

* Fix stringiification issue and cyclic dependency issues

* Resolve projection component values deletion

* Resolve merge conflicts and fix prettier issues

* fix: Tsc issues

* Fix property pane connection navigation

* updating ee locator

* updating inputfield locator

* dropdown locator update

* Merge conflict not properly resolved.

* Fix s3 spec

* Fix Mongo Spec

* Fix some more tests

* fix: prevent cyclic dependency when switching to js mode (#14668)

* add delete events for change from array to string in diff

* add test to assert absence of cyclic dependency error when switching to js in switchgroup widget

* Assert that evaluation is not disabled when no cyclic dependency happens

* Cypress test preparations for google sheets and form controls

* Fixed a few test errors (#14874)

* Add: unit tests for uqi UI updates

- view type tests
- conditional output extraction
- processing conditional output to handle view/enabled state of the component

* Add: completed isValidFormConfig test

* Update: improved tests for update config

- These tests cover the functionality to update a section config after it's components are done evaluating

* Fix failing cypress tests and cyclic dependency issue

* Fixes some more tests

* Fixed migration of row objects (#14896)

* Bumped the version of design system package

* Update: reverted change to EE selector

* Fix deletion pointer

* Update: selector for js on load spec

- Synced with changes related to ADS dropdown

* Fix mongoDBShoppingCart spec

* Remove comments

* Fix: mongo shopping cart test failures

* fix: mongo shopping cart spec

* Dummy push to retrigger vercel

* fix: mongo shopping cart spec

* Update MongoDBShoppingCart_spec.js

* fix: removed unused click away

* dummy commit

* Update: moved helper functions to separate file

* Add: added tests for saga functions

- Worked on testing for
   - extractFetchDynamicValueFormConfigs
   - extractQueueOfValuesToBeFetched

* Add if check for queueOfValuesToBeFetched

* Resolve review comments

* Empty-Commit

Co-authored-by: Irongade <adeoluayangade@yahoo.com>
Co-authored-by: Ayush Pahwa <ayush@appsmith.com>
Co-authored-by: Aman Agarwal <aman@appsmith.com>
Co-authored-by: Ayangade Adeoluwa <37867493+Irongade@users.noreply.github.com>
Co-authored-by: Aishwarya UR <aishwarya@appsmith.com>
Co-authored-by: Favour Ohanekwu <fohanekwu@gmail.com>
Co-authored-by: Albin <albin@appsmith.com>
2022-07-04 11:13:27 +05:30

445 lines
14 KiB
TypeScript

import React, { useEffect } from "react";
import FormControl from "pages/Editor/FormControl";
import Icon, { IconSize } from "components/ads/Icon";
import styled from "styled-components";
import { FieldArray, getFormValues } from "redux-form";
import { ControlProps } from "./BaseControl";
import _ from "lodash";
import { useSelector } from "react-redux";
import { getBindingOrConfigPathsForWhereClauseControl } from "entities/Action/actionProperties";
import { WhereClauseSubComponent } from "./utils";
import { TooltipComponent as Tooltip } from "design-system";
//Dropdwidth and Icon have fixed widths
const DropdownWidth = 82; //pixel value
const OperatorDropdownWidth = 100; // operators should have longer dropdown widths.
const Margin = 8; //pixel value, space between two adjacent fields
//Offsets are pixel values adjusted for Margin = 8px, and DropdownWidth = 100px
//Offsets are used to calculate flexible width of Key and Value fields
//TODO: add logic to calculate width using DropdownWidth and Margin
const Offset = [248, 406, 564, 564];
// Type of the value for each condition
export type whereClauseValueType = {
condition?: string;
children?: [whereClauseValueType];
key?: string;
value?: string;
};
// Form config for the value field
const valueFieldConfig: any = {
key: "value",
controlType: "QUERY_DYNAMIC_INPUT_TEXT",
placeholderText: "value",
};
// Form config for the key field
const keyFieldConfig: any = {
key: "key",
controlType: "QUERY_DYNAMIC_INPUT_TEXT",
placeholderText: "key",
};
// Form config for the condition field
const conditionFieldConfig: any = {
key: "operator",
controlType: "DROP_DOWN",
initialValue: "EQ",
options: [],
};
// Form config for the operator field
const logicalFieldConfig: any = {
key: "condition",
controlType: "DROP_DOWN",
initialValue: "EQ",
};
const LogicalFieldValue: any = styled.p<{ width: string | undefined }>`
${(props) => (props.width ? "width: " + props.width + ";" : "")}
height: 38px;
line-height: 36px;
margin: 4px 0px;
border: solid 1.2px transparent;
text-align: right;
color: var(--appsmith-color-black-400);
font-size: 14px;
flex-shrink: 0;
`;
// Component for the delete Icon
const CenteredIcon = styled(Icon)<{
alignSelf?: string;
top?: string;
}>`
position: relative;
margin-left: 4px;
margin-right: 8px;
align-self: ${(props) => (props.alignSelf ? props.alignSelf : "center")};
top: ${(props) => (props.top ? props.top : "0px")};
&.hide {
opacity: 0;
pointer-events: none;
}
`;
// Wrapper inside the main box, contains the dropdown and ConditionWrapper
const SecondaryBox = styled.div<{ showBorder: boolean }>`
display: flex;
flex-direction: column;
position: relative;
border: solid 1.2px #e0dede;
width: max-content;
border-width: ${(props) => (props?.showBorder ? "1.2px" : "0px")};
margin: ${(props) => (props?.showBorder ? "0px 8px" : "0px")};
padding: ${(props) => (props?.showBorder ? "8px" : "0px")};
padding-bottom: 24px;
`;
// Wrapper to contain either a ConditionComponent or ConditionBlock
const ConditionWrapper = styled.div`
display: flex;
flex-direction: row;
width: 100%;
justify-content: space-between;
`;
// Wrapper to contain a single condition statement
const ConditionBox = styled.div`
display: flex;
flex-direction: row;
width: 100%;
margin: 4px 0px;
:first-child {
margin-top: 0px;
}
`;
// Box containing the action buttons to add more filters
const ActionBox = styled.div<{ marginLeft: string }>`
display: flex;
margin-top: 16px;
flex-direction: row;
width: max-content;
justify-content: space-between;
position: absolute;
height: 24px;
text-transform: uppercase;
background-color: inherit;
bottom: 0px;
margin-left: ${(props) => props.marginLeft};
`;
// The final button to add more filters/ filter groups
const AddMoreAction = styled.div<{ isDisabled?: boolean }>`
cursor: pointer;
display: flex;
align-items: center;
font-size: 12px;
font-weight: 500;
line-height: 14px;
letter-spacing: 0.6px;
margin-right: 20px;
color: ${(props) =>
props.isDisabled ? "var(--appsmith-color-black-300)" : "#858282;"};
`;
const StyledTooltip = styled(Tooltip)`
display: flex;
align-items: center;
.bp3-tooltip.ads-global-tooltip .bp3-popover-content {
padding: 8px 12px;
line-height: 16px;
text-transform: none;
}
.bp3-tooltip.ads-global-tooltip .bp3-popover-arrow[style*="left"] {
left: auto !important;
right: 0px;
}
`;
// Component to display single line of condition, includes 2 inputs and 1 dropdown
function ConditionComponent(props: any, index: number) {
// Custom styles have to be passed as props, otherwise the UI will be disproportional
const keyPath = getBindingOrConfigPathsForWhereClauseControl(
props.field,
WhereClauseSubComponent.Key,
);
const valuePath = getBindingOrConfigPathsForWhereClauseControl(
props.field,
WhereClauseSubComponent.Value,
);
const conditionPath = getBindingOrConfigPathsForWhereClauseControl(
props.field,
WhereClauseSubComponent.Condition,
);
//flexWidth is the width of one Key or Value field
//It is a function of DropdownWidth and Margin
//fexWidth = maxWidth(set By WhereClauseControl) - Offset Values based on DropdownWidth and Margin
const flexWidth = `${props.maxWidth / 2}vw - ${Offset[
props.currentNestingLevel
] / 2}px`;
return (
<ConditionBox key={index}>
{/* Component to input the LHS for single condition */}
<FormControl
config={{
...keyFieldConfig,
customStyles: {
width: `calc(${flexWidth})`,
margin: "0 8px",
},
configProperty: keyPath,
}}
formName={props.formName}
/>
{/* Component to select the operator for the 2 inputs */}
<FormControl
config={{
...conditionFieldConfig,
customStyles: {
width: `${OperatorDropdownWidth}px`,
margin: "0 8px",
},
configProperty: conditionPath,
options: props.comparisonTypes,
initialValue: props.comparisonTypes[0].value,
}}
formName={props.formName}
/>
{/* Component to input the RHS for single component */}
<FormControl
config={{
...valueFieldConfig,
customStyles: {
width: `calc(${flexWidth})`,
margin: "0 8px",
},
configProperty: valuePath,
}}
formName={props.formName}
/>
{/* Component to render the delete icon */}
<CenteredIcon
cypressSelector={`t--where-clause-delete-[${index}]`}
name="cross"
onClick={(e) => {
e.stopPropagation();
props.onDeletePressed(index);
}}
size={IconSize.SMALL}
top="-1px"
/>
</ConditionBox>
);
}
// This is the block which contains an operator and multiple conditions/ condition blocks
function ConditionBlock(props: any) {
const formValues: any = useSelector((state) =>
getFormValues(props.formName)(state),
);
const onDeletePressed = (index: number) => {
props.fields.remove(index);
};
// sometimes, this condition runs before the appropriate formValues has been initialized with the correct query values.
useEffect(() => {
// so make sure the new formValue has been initialized with the where object,
// especially when switching between various queries across the same Query editor form.
const whereConfigValue = _.get(formValues, props.configProperty);
// if the where object exists then it means the initialization of the form has been completed.
// if the where object exists and the length of children field is less than one, add a new field.
if (props.fields.length < 1 && !!whereConfigValue) {
if (props.currentNestingLevel === 0) {
props.fields.push({
condition: props.comparisonTypes[0].value,
});
} else {
props.onDeletePressed(props.index);
}
}
}, [props.fields.length]);
let isDisabled = false;
if (props.logicalTypes.length === 1) {
isDisabled = true;
}
const logicalFieldPath = getBindingOrConfigPathsForWhereClauseControl(
props.configProperty,
WhereClauseSubComponent.Condition,
);
const logicalFieldValue = _.get(formValues, logicalFieldPath);
return (
<SecondaryBox
className={`t--${props?.configProperty}`}
showBorder={props.currentNestingLevel >= 1}
>
{props.fields &&
props.fields.length > 0 &&
props.fields.map((field: any, index: number) => {
const fieldValue: whereClauseValueType = props.fields.get(index);
return (
<ConditionWrapper key={`where-${index}`}>
{/* Component to render the joining operator between multiple conditions */}
{index == 0 ? (
<LogicalFieldValue width={`${DropdownWidth}px`}>
Where
</LogicalFieldValue>
) : index == 1 ? (
<FormControl
config={{
...logicalFieldConfig,
customStyles: {
width: `${DropdownWidth}px`,
marginTop: "4px",
},
configProperty: logicalFieldPath,
options: props.logicalTypes,
initialValue: props.logicalTypes[0].value,
isDisabled,
}}
formName={props.formName}
/>
) : (
<LogicalFieldValue width={`${DropdownWidth}px`}>
{logicalFieldValue}
</LogicalFieldValue>
)}
{!!fieldValue && "children" in fieldValue ? (
<ConditionBox>
<FieldArray
component={ConditionBlock}
key={`${field}.children`}
name={`${field}.children`}
props={{
maxWidth: props.maxWidth,
configProperty: `${field}`,
formName: props.formName,
logicalTypes: props.logicalTypes,
comparisonTypes: props.comparisonTypes,
nestedLevels: props.nestedLevels,
currentNestingLevel: props.currentNestingLevel + 1,
onDeletePressed,
index,
}}
rerenderOnEveryChange={false}
/>
<CenteredIcon
alignSelf={"start"}
cypressSelector={`t--where-clause-delete-[${index}]`}
name="cross"
onClick={(e) => {
e.stopPropagation();
onDeletePressed(index);
}}
size={IconSize.SMALL}
top={"14px"}
/>
</ConditionBox>
) : (
ConditionComponent(
{
onDeletePressed,
field,
formName: props.formName,
comparisonTypes: props.comparisonTypes,
maxWidth: props.maxWidth,
currentNestingLevel: props.currentNestingLevel,
},
index,
)
)}
</ConditionWrapper>
);
})}
<ActionBox marginLeft={`${DropdownWidth + Margin}px`}>
<AddMoreAction
className={`t--where-add-condition[${props?.currentNestingLevel}]`}
onClick={
() =>
props.fields.push({
key: "",
condition: props.comparisonTypes[0].value,
value: "",
})
// Add empty and key and value as it will required to create binding paths in getBindingPathsOfAction() at ActionProperties.ts
}
>
<Icon name="add-more-fill" size={IconSize.XL} />
<span style={{ marginLeft: "8px" }}>Add Condition</span>
</AddMoreAction>
{/* Check if the config allows more nesting, if it does, allow for adding more blocks */}
<StyledTooltip
content={
<span>
For S3 only 4 nested where <br /> condition group is allowed.
</span>
}
disabled={props.currentNestingLevel < props.nestedLevels}
donotUsePortal
position="bottom"
>
<AddMoreAction
className={`t--where-add-group-condition[${props?.currentNestingLevel}]`}
isDisabled={!(props.currentNestingLevel < props.nestedLevels)}
onClick={() => {
if (props.currentNestingLevel < props.nestedLevels) {
props.fields.push({
condition: props.logicalTypes[0].value,
children: [
{
condition: props.comparisonTypes[0].value,
},
],
});
}
}}
>
<Icon name="add-more-fill" size={IconSize.XL} />
<span style={{ marginLeft: "8px" }}>Add Group Condition</span>
</AddMoreAction>
</StyledTooltip>
</ActionBox>
</SecondaryBox>
);
}
export default function WhereClauseControl(props: WhereClauseControlProps) {
const {
comparisonTypes, // All possible keys for the comparison
configProperty, // JSON path for the where clause data
formName, // Name of the form, used by redux-form lib to store the data in redux store
logicalTypes, // All possible keys for the logical operators joining multiple conditions
nestedLevels, // Number of nested levels allowed
} = props;
// Max width is designed in a way that the proportion stays same even after nesting
const maxWidth = 60; //in vw
return (
<FieldArray
component={ConditionBlock}
key={`${configProperty}.children`}
name={`${configProperty}.children`}
props={{
configProperty,
maxWidth,
formName,
logicalTypes,
comparisonTypes,
nestedLevels,
currentNestingLevel: 0,
}}
rerenderOnEveryChange={false}
/>
);
}
export type WhereClauseControlProps = ControlProps;