Adding Endpoint for Record Validation #112
Conversation
…and Entity Context
Azher2Ali
requested review from
leoraba and
joneubank
and removed request for
leoraba
| if (!isValid) { | ||
| throw new ValidationError('INVALID_VALUE', 'The specified value was not found.'); | ||
| } |
There was a problem hiding this comment.
We could just return the error state with a status 400... won't this result in an error 500 response due to our error handler?
| const filterEntityNameSql = eq(submittedData.entityName, entityName); | ||
| const filter = eq(submittedData.systemId, studyId); //todo need to change |
There was a problem hiding this comment.
Why are these filter condition separated out from the other where conditions that are defined within the where clause (lines 33, 34)?
| const LOG_MODULE = 'VALIDATION_SERVICE'; | ||
|
|
||
| return { | ||
| validateRecord: async ({ |
There was a problem hiding this comment.
Feel like our naming could be more specific here. We aren't running validation on a record, we are checking for the existence of a record with a given property value. Should we update this name to be checkValueExists?
|
|
||
| const resultCount = await db | ||
| .select({ total: count() }) | ||
| .from(submittedData) //todo need to change |
There was a problem hiding this comment.
Not sure what needs to be changed, can you elaborate? Should probably update the PR or leave a more detailed TODO comment (preferably do this work now ;) )
This feature introduces a new endpoint for validating the existence of records within specific contexts, supporting applications that require robust data integrity. By ensuring records exist (or preventing duplicates), this endpoint enhances user experience and maintains data consistency.
Endpoint Details:
Method: GET
Path:
/validator/{categoryId}/{entityName}Query Parameters:
studyId: Identifier of the organization in Lyric, required as a string.
value: The value to validate, required as a string.
categoryId: Numeric ID of the category the record belongs to.
entityName: Name of the entity or analysis type (string) used in Song.
Example Request:
GET http://localhost:3030/validator/{categoryId}/{entityName}?studyId={studyId}&value={value}
Expected Behavior:
Record Exists: Returns 200 OK with an empty body.
Record Not Found: Returns 400 Bad Request with a response body:
Implemented Changes:
Created a new ValidatorController to manage the validation endpoint.
Developed a ValidationService to handle logic for checking records within the submitted_data table.
Added a Router for routing the new endpoint.
Defined data models for ValidationRequest and ValidationResponse.
This endpoint’s design supports configuration-based category and entityName searches, offering flexibility for different validation contexts.
This feature is essential for applications that must verify records' existence within specific categories and organizations, providing a streamlined, reliable approach to validating data before further processing.
Also there are some pending changes related to Database Query, which will be added to this PR with our upcoming changes