ADRs: 017-019 - Adding Impact Sections #1628
Conversation
tjohnson7021
added
the
devex/opex
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ### Positive | ||
|
|
||
| - **High Performance:** HikariCP outperforms other connection pool libraries in terms of throughput and latency, enhancing application responsiveness. |
There was a problem hiding this comment.
Consider adding specific examples or metrics to support claims about performance and scalability in the Impact section. This would provide clearer insights into the benefits of using HikariCP for connection pooling. [important]
|
|
||
| ### Risks | ||
|
|
||
| - **Migration Errors:** Incorrectly defined migration scripts could cause deployment failures or data integrity issues. |
There was a problem hiding this comment.
It might be beneficial to include a subsection under Risks about potential security concerns with migration scripts, such as exposure of sensitive data or SQL injection risks, and how to mitigate them. [important]
|
|
||
| ### Negative | ||
|
|
||
| - **Increased Complexity:** Adds another table to the database, which introduces additional queries and joins in the codebase. |
There was a problem hiding this comment.
To enhance the Negative section, consider discussing the potential increase in maintenance costs associated with managing an additional table, especially in terms of database administration and backup complexities. [medium]
PR Code Suggestions ✨No code suggestions found for the PR. |
tjohnson7021
requested review from
basiliskus,
sfradkin,
luis-pabon-tf,
JeremyIR,
halprin,
saquino0827,
somesylvie,
jorg3lopez,
jbiskie,
brick-green,
pluckyswan,
GilmoreA6,
jherrflexion and
jcrichlake
|
|
|
||
|
|
||
| - **GitHub Action Reliability:** Relying on prebuilt GitHub Actions introduces a dependency on external tools, which may have compatibility or update issues over time. | ||
|
|
There was a problem hiding this comment.
consider adding a risk here regarding changelog structure, as it can affect ability to make changes when one table is referencing another such as our message_link table referencing the received_message_id column in the metadata table (relevant liquibase documentation regarding structure https://docs.liquibase.com/start/design-liquibase-project.html)
|
|
||
| - **Schema Evolution:** Future changes to linking logic or requirements may necessitate updates to the `message_link` table structure. | ||
|
|
||
|
|
There was a problem hiding this comment.
similar to comment above on 018-sql-migrations, adding another table increases potential rollback complexity
| ### Risks | ||
|
|
||
| - **Connection Leaks:** Improperly handled connections could lead to resource exhaustion, affecting application stability. | ||
| - Incorrect Configuration: Poorly tuned settings may result in underutilized or overburdened pools. |
There was a problem hiding this comment.
Missing bold and new line.
Description
This PR covers filling in the impact sections for ADRs 017-019 so that it is understood why the decision was made at the time and what the concerns were.
This PR errs on the side of being more verbose than not so that unneeded items can be stripped away during review, so please read carefully.
Issue #1247
Checklist