misc(filters-contracts): Define contracts to validate query objects filters #2650
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
Validate query objects filters received by against a contract, this will provide a few benefits; 1. Ensure each query object filters are correctly validated before excuting the query. 2. Decouple filter validation logic form the query objects. 3. Makes explicit to developers which filters are available without having to dig into the query object implementation details.
vincent-pochet
approved these changes
Oct 3, 2024
| @@ -22,6 +22,19 @@ def initialize(organization:, pagination: DEFAULT_PAGINATION_PARAMS, filters: {} | |||
|
|
|||
| attr_reader :organization, :pagination_params, :filters, :search_term, :order | |||
|
|
|||
| def validate_filters | |||
| contract_class_name = "#{self.class.name}FiltersContract" | |||
| contract = Object.const_get(contract_class_name).new | |||
There was a problem hiding this comment.
Just a thought, do you think we could find a way to pass or assign the Contract class to the query class, to avoid doing some magic to load it?
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.
Context
Currently query objects receive a filters hash, the filters are not validated and used to build the SQL query agains Lago DB.
Also, developers need to read the query object implementation just to be aware of the available filters.
Description
This is a PoC introduces contracts to validate query objects filters, validating the filter provides a following benefits;
Ensure each query object filters are correctly validated before executing the query.
Decouple filter validation logic form the query objects.
Makes explicit to developers which filters are available without having to dig into the query object implementation details.
dry-validationis added as dependency.Bear in mind, this first contract is meant as an example an covers a simple scenario, there are other query objects with many and more complex filters available.