bcgov / bcgov/cas-reporting

Tech Debt: Report validation service should minimize the database queries

Open
#696 0 comments 0 reactions 0 assignees View on GitHub
BACKLOG Backlog Refinement Tech Debt
Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

#### Description of the Tech Debt

The validation service passes a `ReportVersion` object to the individual validators, which are in turn each running db queries.

By pre-fetching data we could minimize that
- either in the service directly, and hard-code the prefetches
- or have each validation module export a prefetch function that would add prefetch statements to the ReportVersion query before it's passed on

#### Tech Debt Triage

The purpose of our technical debt triage process is to analyze technical debt to determine risk level of the technical debt and the value in tackling that technical debt.

#### Risk Value Scoring:

| Level | Value |
| ------ | --------------------- |
| High |

3 |
| Medium |
2 |
| Low |
1 |

| Technical Debt - Risk Types | Level | Value |
| ----------------------------------------------------------------------------------------------------------------------------- | ----- | ----- |
| Business Area Risk - Risk of business area visibility / damage to user experience | 0 | 0 |
| Developer Fault Risk - How likely will this tech debt cause a future error related to coding on top of it | 0 | 0 |
| System Fault Risk - Risk of system errors or application downtime | 0 | 0 |
| Time Scale Risk - Compound risk effect if left alone. How much more difficult to fix or dangerous will this become over time? | 0 | 0 |
| Time Sink Risk - How much will this tech debt slow the development process down | 0 | 0 |
|

**TOTAL SCORE:** | 0 | 0 |

#### Development Checklist:

- [ ] Checklist item
- [ ] Checklist item
- [ ] Checklist item

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing the validation service, the individual validators, and the ReportVersion query to identify which database queries each validator performs. Compare the two proposed prefetch approaches and measure the current validation flow. Done means the validators retain their behavior while redundant database queries are minimized.

Written by the indexing model from the issue text.

Assessment

Domain
database
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.