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.

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: add control event to all state references with change event #388

Merged
merged 1 commit into from
Feb 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -5159,6 +5159,56 @@ export default function SocialA(props: SocialAProps): React.ReactElement {
"
`;

exports[`amplify render tests mutations controls an input that is modified by a button 1`] = `
Object {
"componentText": "/* eslint-disable */
import React from \\"react\\";
import {
EscapeHatchProps,
getOverrideProps,
} from \\"@aws-amplify/ui-react/internal\\";
import { Button, Flex, FlexProps, TextField } from \\"@aws-amplify/ui-react\\";
import { useStateMutationAction } from \\"../mock-helpers\\";

export type InputMutationOnClickProps = React.PropsWithChildren<
Partial<FlexProps> & {
overrides?: EscapeHatchProps | undefined | null;
}
>;
export default function InputMutationOnClick(
props: InputMutationOnClickProps
): React.ReactElement {
const { overrides, ...rest } = props;
const [myInputValue, setMyInputValue] = useStateMutationAction(undefined);
const setInputButtonClick = () => {
setMyInputValue(\\"Razor Crest\\");
};
return (
/* @ts-ignore: TS2322 */
<Flex {...rest} {...getOverrideProps(overrides, \\"InputMutationOnClick\\")}>
<TextField
value={myInputValue}
onChange={(event: SyntheticEvent) => {
setMyInputValue(event.target.value);
}}
{...getOverrideProps(overrides, \\"MyInput\\")}
></TextField>
<Button
children=\\"Change Input\\"
onClick={() => {
setInputButtonClick();
}}
{...getOverrideProps(overrides, \\"SetInputButton\\")}
></Button>
</Flex>
);
}
",
"declaration": undefined,
"renderComponentToFilesystem": [Function],
}
`;

exports[`amplify render tests mutations form 1`] = `
Object {
"componentText": "/* eslint-disable */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,10 @@ describe('amplify render tests', () => {
it('modifies text in component on input change', () => {
expect(generateWithAmplifyRenderer('workflow/inputToTextChange')).toMatchSnapshot();
});

it('controls an input that is modified by a button', () => {
expect(generateWithAmplifyRenderer('workflow/inputMutationOnClick')).toMatchSnapshot();
});
});

describe('default value', () => {
Expand Down
16 changes: 16 additions & 0 deletions packages/codegen-ui-react/lib/primitive.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,19 @@ export const PrimitiveTypeParameter: Partial<
export function isBuiltInIcon(componentType: string): boolean {
return iconset.has(componentType);
}

/*
* temporary list of Primitives with a change event. Final implementation will pull from amplify UI
*/
export const PrimitivesWithChangeEvent: Set<Primitive> = new Set([
Primitive.CheckboxField,
Primitive.PasswordField,
Primitive.PhoneNumberField,
Primitive.RadioGroupField,
Primitive.SearchField,
Primitive.SelectField,
Primitive.SliderField,
Primitive.StepperField,
Primitive.SwitchField,
Primitive.TextField,
]);
25 changes: 15 additions & 10 deletions packages/codegen-ui-react/lib/workflow/mutation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import {
getSetStateName,
} from '../react-component-render-helper';
import { ImportCollection, ImportValue } from '../imports';
import Primitive, { PrimitivesWithChangeEvent } from '../primitive';
import { mapGenericEventToReact } from './events';
import { getChildPropMappingForComponentName } from './utils';

Expand Down Expand Up @@ -246,17 +247,21 @@ export function filterStateReferencesForComponent(
): MutationReferences {
return stateReferences
.filter(({ componentName }) => componentName === component.name)
.reduce(mutationReferenceReducer, {});
.reduce(mutationReferenceReducerWithComponentType(component.componentType), {});
}

function mutationReferenceReducer(
mutationReferences: MutationReferences,
stateReference: StateReference,
): MutationReferences {
const propertyReferences =
stateReference.property in mutationReferences ? mutationReferences[stateReference.property] : [];
return {
...mutationReferences,
[stateReference.property]: propertyReferences.concat([{ addControlEvent: !('set' in stateReference) }]),
function mutationReferenceReducerWithComponentType(componentType: string) {
return function mutationReferenceReducer(
mutationReferences: MutationReferences,
stateReference: StateReference,
): MutationReferences {
const propertyReferences =
stateReference.property in mutationReferences ? mutationReferences[stateReference.property] : [];
return {
...mutationReferences,
[stateReference.property]: propertyReferences.concat([
{ addControlEvent: PrimitivesWithChangeEvent.has(componentType as Primitive) || !('set' in stateReference) },
]),
};
};
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"id": "1234-5678-9010",
"componentType": "Flex",
"name": "InputMutationOnClick",
"properties": {},
"children": [
{
"componentType": "TextField",
"name": "MyInput",
"properties": {}
},
{
"componentType": "Button",
"name": "SetInputButton",
"events": {
"click": {
"action": "Amplify.Mutation",
"parameters": {
"state": {
"componentName": "MyInput",
"property": "value",
"set": {
"value": "Razor Crest"
}
}
}
}
},
"properties": {
"children": {
"value": "Change Input"
}
}
}
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ const EXPECTED_SUCCESSFUL_CASES = new Set([
'FormWithState',
'InternalMutation',
'TwoWayBindings',
'InputMutationOnClick',
]);
const EXPECTED_INVALID_INPUT_CASES = new Set([
'ComponentMissingProperties',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,18 @@ describe('Workflow', () => {
cy.get('#NoInitialDisplayBlockButton').click();
cy.get('#NoInitialTextDisplay').should('be.visible');
});

it('supports mutations on controlled components', () => {
cy.get('#input-mutation-on-click').within(() => {
cy.get('input').should('have.attr', 'value', '');
cy.get('button').click();
cy.get('input').should('have.attr', 'value', 'Razor Crest');
cy.get('input').type(' blew up');
cy.get('input').should('have.attr', 'value', 'Razor Crest blew up');
cy.get('button').click();
cy.get('input').should('have.attr', 'value', 'Razor Crest');
});
});
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import {
DataStoreActions,
FormWithState,
SimpleUserCollection,
InputMutationOnClick,
} from './ui-components'; // eslint-disable-line import/extensions

type AuthState = 'LoggedIn' | 'LoggedOutLocally' | 'LoggedOutGlobally' | 'Error';
Expand Down Expand Up @@ -216,6 +217,7 @@ export default function ComplexTests() {
<MutationWithSyntheticProp />
<SetStateWithoutInitialValue />
<UpdateVisibility />
<InputMutationOnClick />
</View>
</AmplifyProvider>
);
Expand Down
1 change: 1 addition & 0 deletions packages/test-generator/lib/components/workflow/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ export { default as UpdateVisibility } from './updateVisibility.json';
export { default as DataStoreActions } from './dataStoreActions.json';
export { default as FormWithState } from './formWithState.json';
export { default as TwoWayBindings } from './twoWayBindings.json';
export { default as InputMutationOnClick } from './inputMutationOnClick.json';
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"id": "1234-5678-9010",
"componentType": "Flex",
"name": "InputMutationOnClick",
"properties": {
"id": {
"value": "input-mutation-on-click"
}
},
"children": [
{
"componentType": "TextField",
"name": "MyInput",
"properties": {}
},
{
"componentType": "Button",
"name": "SetInputButton",
"events": {
"click": {
"action": "Amplify.Mutation",
"parameters": {
"state": {
"componentName": "MyInput",
"property": "value",
"set": {
"value": "Razor Crest"
}
}
}
}
},
"properties": {
"children": {
"value": "Change Input"
}
}
}
]
}