feat: validate actions configuration definition #782
Conversation
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
Thenkei
reviewed
Jul 31, 2023
packages/datasource-customizer/src/decorators/actions/collection.ts
Outdated
Show resolved
Hide resolved
Thenkei
reviewed
Jul 31, 2023
packages/datasource-customizer/src/decorators/validation/action.ts
Outdated
Show resolved
Hide resolved
Thenkei
reviewed
Jul 31, 2023
packages/datasource-customizer/src/decorators/validation/action.ts
Outdated
Show resolved
Hide resolved
Thenkei
reviewed
Jul 31, 2023
| }); | ||
|
|
||
| describe('documentation samples', () => { | ||
| test('it should validate the action at https://docs.forestadmin.com/developer-guide-agents-nodejs/agent-customization/actions#in-your-code', () => { |
There was a problem hiding this comment.
What if the documentation link change?
There was a problem hiding this comment.
Yes, this is not the best.
But I thought that validating our own doc was important, so I took the risk. Do you have another idea ?
There was a problem hiding this comment.
I think you can keep you links as comments of each test and specifically define what you are testing as I tried to do (it is not so simple) ^^
Thenkei
reviewed
Jul 31, 2023
| field: { label: 'field1', type: 'string' } as unknown as DynamicField, | ||
| error: `type must be equal to one of the allowed values ,(Boolean,Collection`, | ||
| }, | ||
| ].forEach(wrongField => { |
Thenkei
reviewed
Jul 31, 2023
Thenkei
reviewed
Jul 31, 2023
packages/datasource-customizer/src/decorators/validation/action.ts
Outdated
Show resolved
Hide resolved
Thenkei
reviewed
Jul 31, 2023
Comment on lines
+3
to
+9
| export type ActionScope = `${ActionScopeEnum}`; | ||
|
|
||
| export enum ActionScopeEnum { | ||
| Single = 'Single', | ||
| Bulk = 'Bulk', | ||
| Global = 'Global', | ||
| } |
Thenkei
reviewed
Jul 31, 2023
Comment on lines
+24
to
+39
| export type ActionFieldType = `${ActionFieldTypeEnum}`; | ||
| export enum ActionFieldTypeEnum { | ||
| Boolean = 'Boolean', | ||
| Collection = 'Collection', | ||
| Enum = 'Enum', | ||
| EnumList = 'EnumList', | ||
| File = 'File', | ||
| FileList = 'FileList', | ||
| Json = 'Json', | ||
| Number = 'Number', | ||
| NumberList = 'NumberList', | ||
| Date = 'Date', | ||
| Dateonly = 'Dateonly', | ||
| String = 'String', | ||
| StringList = 'StringList', | ||
| } |
Thenkei
reviewed
Jul 31, 2023
|
You should probably change the |
|
What about old widget definition? |
added 10 commits
July 31, 2023 14:47
It will be updated in another PR |
Thenkei
reviewed
Aug 1, 2023
| @@ -124,6 +129,14 @@ export default class CollectionCustomizer< | |||
| * }) | |||
| */ | |||
| addAction(name: string, definition: ActionDefinition<S, N>): this { | |||
| try { | |||
| ActionValidator.validateActionConfiguration(name, definition as ActionDefinition<any, any>); | |||
There was a problem hiding this comment.
Suggested change
| ActionValidator.validateActionConfiguration(name, definition as ActionDefinition<any, any>); | |
| ActionValidator.validateActionConfiguration(name, definition as unknown as ActionDefinition); |
The linter is not happy with this. 😢
Thenkei
reviewed
Aug 1, 2023
| }); | ||
|
|
||
| describe('documentation samples', () => { | ||
| test('it should validate the action at https://docs.forestadmin.com/developer-guide-agents-nodejs/agent-customization/actions#in-your-code', () => { |
There was a problem hiding this comment.
Suggested change
| test('it should validate the action at https://docs.forestadmin.com/developer-guide-agents-nodejs/agent-customization/actions#in-your-code', () => { | |
| test('it should validate the action - smallest required properties defined', () => { |
Thenkei
reviewed
Aug 1, 2023
| ActionValidator.validateActionConfiguration('Mark as live', action), | ||
| ).not.toThrow(); | ||
| }); | ||
| test('it should validate the action at https://docs.forestadmin.com/developer-guide-agents-nodejs/agent-customization/actions/scope-context#example-1-getting-data-from-the-selected-records', () => { |
There was a problem hiding this comment.
This is the same case as the previous definition.
Thenkei
reviewed
Aug 1, 2023
| ActionValidator.validateActionConfiguration('Mark as live', action), | ||
| ).not.toThrow(); | ||
| }); | ||
| test('it should validate the action at https://docs.forestadmin.com/developer-guide-agents-nodejs/agent-customization/actions/forms-static#field-configuration', () => { |
There was a problem hiding this comment.
Suggested change
| test('it should validate the action at https://docs.forestadmin.com/developer-guide-agents-nodejs/agent-customization/actions/forms-static#field-configuration', () => { | |
| test('it should validate the action - Static form definition', () => { |
Thenkei
reviewed
Aug 1, 2023
| ActionValidator.validateActionConfiguration('Mark as live', action), | ||
| ).not.toThrow(); | ||
| }); | ||
| test('it should validate the action at https://docs.forestadmin.com/developer-guide-agents-nodejs/agent-customization/actions/forms-static#references-to-records', () => { |
There was a problem hiding this comment.
Suggested change
| test('it should validate the action at https://docs.forestadmin.com/developer-guide-agents-nodejs/agent-customization/actions/forms-static#references-to-records', () => { | |
| test('it should validate the action - - Static form definition with field reference to records', () => { |
There was a problem hiding this comment.
I have implemented your suggestion
Thenkei
reviewed
Aug 1, 2023
| try { | ||
| ActionValidator.validateActionConfiguration(name, definition as ActionDefinition<any, any>); | ||
| } catch (error) { | ||
| if (error instanceof ActionConfigurationValidationError) { |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Definition of Done
General
Security