Fix: Resolve Type Warnings for ConfigService.get() #3350

belloibrahv · 2024-12-21T02:42:19Z

Description:
TL;DR; Enhancing Type Inference, Config Consistency, and Establishing a Single Source of Truth in ConfigService

This PR significantly improves type inference in ConfigService.get(), ensuring more reliable and explicit type resolution across configurations.

It also updates the entire codebase to adhere to a single source of truth for configuration management, enhancing consistency, reliability, and maintainability.

Key improvements include:

Strengthened type inference in ConfigService.get(), introducing explicit TypeScript types and interfaces that precisely map config keys to their expected types, reducing manual casting and type mismatches.
Unified configuration values across the codebase, ensuring all components rely on a single, authoritative source of truth.
Updated default values for all global configs to align with configurations.md, enhancing correctness and consistency.
Replaced hardcoded constants with corresponding config values, reducing redundancy and improving maintainability.
Alphabetized configuration tables in configurations.md, ensuring proper documentation and organization.

These enhancements improve type safety, reliability, and maintainability, making the configuration system more robust and easier to manage across the entire codebase.

Related issue(s):
Fixes #3142

Checklist:

Documented: Added/updated relevant code comments and documentation.
Tested: Verified changes with updated and new unit tests to ensure correctness.

belloibrahv · 2024-12-21T03:04:43Z

@Nana-EC @ebadiere @quiet-node I've submitted a PR addressing issue #3142 to resolve type warnings for ConfigService.get(). It ensures type consistency across test cases by refining type usage and adding/removing the necessary casting. Let me know if further changes are needed. Thank you for reviewing!

packages/config-service/src/services/globalConfig.ts

Nana-EC

Thanks for the contribution.

packages/relay/tests/lib/config/hbarSpendingPlanConfigService.spec.ts

packages/server/tests/acceptance/conformityTests.spec.ts

packages/server/tests/acceptance/serverConfig.spec.ts

belloibrahv · 2024-12-25T08:56:34Z

@Nana-EC @acuarica @quiet-node, Could you please review my updates and let me know if further adjustments are needed?

acuarica

Hi @belloibrahv, thanks for taking the time to send this, it's looking good. Left a couple of suggestions we can continue iterating on to improve the config.

packages/config-service/tests/src/services/configService.spec.ts

acuarica · 2024-12-26T16:02:06Z

Also @belloibrahv please take a look at #3350 (comment).

quiet-node · 2024-12-26T16:57:22Z

@belloibrahv DCO is failing https://github.com/hashgraph/hedera-json-rpc-relay/pull/3350/checks?check_run_id=34857409075

belloibrahv · 2024-12-26T23:32:37Z

@quiet-node @acuarica @Nana-EC @shemnon , thank you for the suggestion. I've implemented the following changes based on your feedback:

Updated ConfigService.get to accept name: ConfigKey, removing the need for as ConfigKey assertions.
Added a missing configuration entry for SERVER_HOST in _CONFIG.
Adjusted test cases to align with the updated method definition.

Let me know if there's anything else you'd like me to address!

belloibrahv · 2024-12-26T23:36:46Z

Also @belloibrahv please take a look at #3350 (comment).

@acuarica, Thank you for the suggestion! I think adding a getString (or similar methods like getNumber, getBoolean) in ConfigService could significantly simplify casting and improve developer experience. It could also centralize type handling and reduce repetitive casting logic.

Would you suggest we implement these methods for this task or address it as a follow-up? Also, should these methods throw errors for mismatched types, or return defaults like null? Happy to explore this further and incorporate it if needed!

Nana-EC · 2024-12-27T04:54:23Z

Also @belloibrahv please take a look at #3350 (comment).

@acuarica, Thank you for the suggestion! I think adding a getString (or similar methods like getNumber, getBoolean) in ConfigService could significantly simplify casting and improve developer experience. It could also centralize type handling and reduce repetitive casting logic.

Would you suggest we implement these methods for this task or address it as a follow-up? Also, should these methods throw errors for mismatched types, or return defaults like null? Happy to explore this further and incorporate it if needed!

Let's do it in a separate PR after this.

Also appreciate the patience.
The team is on holiday for the Christmas season so things are a bit slow.

belloibrahv · 2025-01-03T03:02:32Z

Hi @quiet-node, @acuarica, @Nana-EC, @shemnon, Hope you all had a wonderful holiday! When you have a moment, please review and provide feedback on the requested changes to the PR. Thank you for your understanding!

acuarica

Hi @belloibrahv, hope you had a wonderful holiday too! It's looking good, left some comments.

We appreciate your patience on this. Next week the full team will be back from holidays, so you'll get more reviews.

packages/config-service/src/services/index.ts

packages/config-service/tests/src/services/configService.spec.ts

packages/relay/tests/lib/config/hbarSpendingPlanConfigService.spec.ts

packages/relay/tests/lib/eth/eth-config.ts

packages/relay/tests/lib/ethGetBlockBy.spec.ts

packages/ws-server/tests/acceptance/subscribeNewHeads.spec.ts

tools/brownie-example/LICENSE

Signed-off-by: Logan Nguyen <[email protected]>

acuarica

Thanks @belloibrahv and @quiet-node for putting the effort to get this done. Great stuff!

…h config value Signed-off-by: Logan Nguyen <[email protected]>

…ith config Signed-off-by: Logan Nguyen <[email protected]>

Signed-off-by: Logan Nguyen <[email protected]>

…h config Signed-off-by: Logan Nguyen <[email protected]>

natanasow

Fantastic work!

belloibrahv · 2025-02-05T15:10:46Z

@quiet-node @acuarica @natanasow @Nana-EC 🚀 🚀🚀 Thank You all

codecov · 2025-02-05T19:19:26Z

Codecov Report

Attention: Patch coverage is 82.27848% with 14 lines in your changes missing coverage. Please review.

Project coverage is 53.61%. Comparing base (58ab012) to head (dd09502).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/config-service/src/services/index.ts	62.50%	1 Missing and 2 partials ⚠️
...s/config-service/src/services/validationService.ts	33.33%	2 Missing ⚠️
packages/relay/src/lib/poller.ts	0.00%	2 Missing ⚠️
packages/relay/src/lib/subscriptionController.ts	66.66%	2 Missing ⚠️
packages/relay/src/lib/clients/mirrorNodeClient.ts	94.11%	0 Missing and 1 partial ⚠️
packages/relay/src/lib/eth.ts	80.00%	1 Missing ⚠️
packages/relay/src/lib/relay.ts	50.00%	0 Missing and 1 partial ⚠️
.../lib/services/ethService/ethCommonService/index.ts	0.00%	1 Missing ⚠️
packages/relay/src/lib/web3.ts	0.00%	1 Missing ⚠️

❌ Your project check has failed because the head coverage (53.61%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage.

❗ There is a different number of reports uploaded between BASE (58ab012) and HEAD (dd09502). Click for more details.

HEAD has 34 uploads less than BASE

Flag BASE (58ab012) HEAD (dd09502)

config-service 2 0

relay 2 0

server 2 0

ws-server 2 0

34 8

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #3350       +/-   ##
===========================================
- Coverage   85.58%   53.61%   -31.98%     
===========================================
  Files          69       65        -4     
  Lines        4753     4525      -228     
  Branches     1059      979       -80     
===========================================
- Hits         4068     2426     -1642     
- Misses        393     1700     +1307     
- Partials      292      399      +107

Flag	Coverage Δ
config-service	`?`
relay	`?`
server	`?`
ws-server	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...ckages/config-service/src/services/globalConfig.ts	`100.00% <100.00%> (ø)`
...kages/relay/src/lib/clients/cache/localLRUCache.ts	`25.37% <ø> (-67.49%)`	⬇️
packages/relay/src/lib/clients/cache/redisCache.ts	`48.14% <100.00%> (-39.13%)`	⬇️
packages/relay/src/lib/clients/sdkClient.ts	`54.31% <100.00%> (-16.08%)`	⬇️
...ay/src/lib/config/hbarSpendingPlanConfigService.ts	`25.86% <100.00%> (-66.38%)`	⬇️
packages/relay/src/lib/constants.ts	`100.00% <ø> (+5.17%)`	⬆️
packages/relay/src/lib/net.ts	`66.66% <100.00%> (-33.34%)`	⬇️
packages/relay/src/lib/precheck.ts	`48.64% <100.00%> (-40.45%)`	⬇️
...elay/src/lib/services/cacheService/cacheService.ts	`26.66% <ø> (-65.93%)`	⬇️
.../relay/src/lib/services/hapiService/hapiService.ts	`72.36% <100.00%> (-22.37%)`	⬇️
... and 13 more

... and 31 files with indirect coverage changes

Signed-off-by: Logan Nguyen <[email protected]> Revert "fix(ci): fixed ci test with fallback log level" This reverts commit 9af4396. Reapply "fix(ci): fixed ci test with fallback log level" This reverts commit bd81c5729ffa7e4e20cf07cccbec718aff61af9b. Revert "fix(ci): fixed ci test with fallback log level" This reverts commit 981cad0a66a4e487d6e396dfcc0fa1123f19296f. Reapply "fix(ci): fixed ci test with fallback log level" This reverts commit 87eb44fd5fcd09156210cd431d7a0d00e9f8e720.

Signed-off-by: Logan Nguyen <[email protected]>

sonarqubecloud · 2025-02-05T20:37:22Z

Quality Gate failed

Failed conditions
4.7% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

quiet-node · 2025-02-06T14:58:47Z

Thanks, team, for the great responses and feedback!

Congrats on the merge, @belloibrahv! Appreciate your effort and patience—looking forward to more of your contributions in the future!

belloibrahv · 2025-02-07T00:46:56Z

Thank You all for helping out, I look forward to working and collaborating on more work.

* fix: resolve type warnings for ConfigService.get() - Ensured type consistency in all affected test cases. - Removed unnecessary type casting or added necessary casting. Signed-off-by: belloibrahv <[email protected]> * fix: resolve type warnings for ConfigService.get() - Ensured type consistency in all affected test cases. - Removed unnecessary type casting or added necessary casting. Signed-off-by: belloibrahv <[email protected]> * Refactor GlobalConfig and revert header changes as per feedback Signed-off-by: belloibrahv <[email protected]> * Reverting License Header Changes Signed-off-by: belloibrahv <[email protected]> * Refinment of ConfigService.get() (to conform to newly suggested changes) Signed-off-by: belloibrahv <[email protected]> * Refactor ConfigService.get to enhance type safety and remove manual casting Signed-off-by: belloibrahv <[email protected]> * fix bugs in workflow Signed-off-by: belloibrahv <[email protected]> * Remove assesrtion Signed-off-by: belloibrahv <[email protected]> * Remove assesrtion Signed-off-by: belloibrahv <[email protected]> * Add assertion to _CONFIG (in the globalConfig.ts file) Signed-off-by: belloibrahv <[email protected]> * chore: renamed types and added explanation Signed-off-by: Logan Nguyen <[email protected]> * fix: loosen strict type checking for array types in config variables Signed-off-by: Logan Nguyen <[email protected]> * fix: modified GetTypeOfConfigKey to resolve to better types Signed-off-by: Logan Nguyen <[email protected]> * fix: updated properly default values to all global configs Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed ConfigService unit test Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed LocalLRUCache suite Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed HbarSpendingPlanConfigService suite Signed-off-by: Logan Nguyen <[email protected]> * chore: updated type explanation Signed-off-by: Logan Nguyen <[email protected]> Revert "chore: updated type explanation" This reverts commit ecd8d6e. Reapply "chore: updated type explanation" This reverts commit 6756ecb1ee558c7d20fb8f7a71e2fbee70bb75ad. * fix: modified typeCasting to always convert CHAIN_ID to hexadecimal value Signed-off-by: Logan Nguyen <[email protected]> * fix: further tighten ConfigService.get() Signed-off-by: Logan Nguyen <[email protected]> * Update web3.ts Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed test in net Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed test in web3 Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed eth_feeHistory Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed filter API Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed HbarLimitService unit test Signed-off-by: Logan Nguyen <[email protected]> Revert "fixed shouldLimit v1" This reverts commit 2f745e6f6188d7c4d84da931793544200420d073. Reapply "fixed shouldLimit v1" This reverts commit f280bbf311a4e407ed2c158d372581e2b8b36e25. s Signed-off-by: Logan Nguyen <[email protected]> Revert "fix: fixed HbarLimitService unit test" This reverts commit ec28eee. Reapply "fix: fixed HbarLimitService unit test" This reverts commit e27bae25cb51f5a49db525c5e66e08b3da2c3c15. Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed utils.spec.ts Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed BATCH_REQUESTS_ENABLED enabled by default Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed ws-server unit Signed-off-by: Logan Nguyen <[email protected]> * chore: switch MULTI_SET to false Signed-off-by: Logan Nguyen <[email protected]> * fix: fixed newHeads test Signed-off-by: Logan Nguyen <[email protected]> * fix: removed type array in GlobalConfig Signed-off-by: Logan Nguyen <[email protected]> * fix: reverted Copyright Signed-off-by: Logan Nguyen <[email protected]> * chore: converted JSDoc to TSDoc Signed-off-by: Logan Nguyen <[email protected]> * chore: replaced constant CACHE_MAX with config Signed-off-by: Logan Nguyen <[email protected]> * chore: replaced constant CACHE_TTL.ONEHOUR with config 'CACHE_TTL' Signed-off-by: Logan Nguyen <[email protected]> * chore: replaced constants.SEND_RAW_TRANSACTION_SIZE_LIMIT with config Signed-off-by: Logan Nguyen <[email protected]> * chore: replaced constants. DEFAULT_ETH_GET_LOGS_BLOCK_RANGE_LIMIT with config value Signed-off-by: Logan Nguyen <[email protected]> * chore: replaced constants.ETH_GET_TRANSACTION_COUNT_MAX_BLOCK_RANGE with config Signed-off-by: Logan Nguyen <[email protected]> * chore: replaced constants.MIRROR_NODE_RETRY_DELAY_DEFAULT with config Signed-off-by: Logan Nguyen <[email protected]> * chore: replaced constants.MIRROR_NODE_REQUEST_RETRY_COUNT_DEFAULT with config Signed-off-by: Logan Nguyen <[email protected]> * fix(ci): fixed ci test with fallback log level Signed-off-by: Logan Nguyen <[email protected]> Revert "fix(ci): fixed ci test with fallback log level" This reverts commit 9af4396. Reapply "fix(ci): fixed ci test with fallback log level" This reverts commit bd81c5729ffa7e4e20cf07cccbec718aff61af9b. Revert "fix(ci): fixed ci test with fallback log level" This reverts commit 981cad0a66a4e487d6e396dfcc0fa1123f19296f. Reapply "fix(ci): fixed ci test with fallback log level" This reverts commit 87eb44fd5fcd09156210cd431d7a0d00e9f8e720. * fix: alphabeticalized configuration tables Signed-off-by: Logan Nguyen <[email protected]> --------- Signed-off-by: belloibrahv <[email protected]> Signed-off-by: Logan Nguyen <[email protected]> Co-authored-by: Logan Nguyen <[email protected]>

belloibrahv requested review from georgi-l95, Ivo-Yankov, a team and Nana-EC as code owners December 21, 2024 02:42

belloibrahv changed the title ~~fix: resolve type warnings for ConfigService.get()~~ Fix: Resolve Type Warnings for ConfigService.get() Dec 21, 2024

belloibrahv mentioned this pull request Dec 21, 2024

Fix all typescript warnings and errors generated by type mismatching on the ConfigService.get(<envName>) method in test specs #3142

Closed

Nana-EC requested review from acuarica, konstantinabl and quiet-node December 21, 2024 03:34

Nana-EC assigned belloibrahv Dec 21, 2024

acuarica reviewed Dec 21, 2024

View reviewed changes

packages/config-service/src/services/globalConfig.ts Outdated Show resolved Hide resolved

Nana-EC reviewed Dec 21, 2024

View reviewed changes

packages/relay/tests/lib/config/hbarSpendingPlanConfigService.spec.ts Outdated Show resolved Hide resolved

packages/server/tests/acceptance/conformityTests.spec.ts Outdated Show resolved Hide resolved

packages/server/tests/acceptance/serverConfig.spec.ts Outdated Show resolved Hide resolved

quiet-node added this to the 0.64.0 milestone Dec 23, 2024

quiet-node added the internal For changes that affect the project's internal workings but not its outward-facing functionality. label Dec 23, 2024

belloibrahv requested review from a team as code owners December 25, 2024 07:55

belloibrahv requested a review from jeromy-cannon December 25, 2024 07:55

belloibrahv force-pushed the 3142-fix-configservice-get-type-warnings branch from 27253f5 to 7f440e4 Compare December 25, 2024 08:54

acuarica requested changes Dec 26, 2024

View reviewed changes

packages/config-service/tests/src/services/configService.spec.ts Outdated Show resolved Hide resolved

packages/config-service/tests/src/services/configService.spec.ts Outdated Show resolved Hide resolved

belloibrahv force-pushed the 3142-fix-configservice-get-type-warnings branch from 7f440e4 to c7e6a08 Compare December 26, 2024 23:23

acuarica reviewed Jan 3, 2025

View reviewed changes

chore: converted JSDoc to TSDoc

d30b5c7

Signed-off-by: Logan Nguyen <[email protected]>

quiet-node requested a review from acuarica February 4, 2025 18:37

quiet-node added 3 commits February 4, 2025 14:30

chore: replaced constant CACHE_MAX with config

00c22cf

Signed-off-by: Logan Nguyen <[email protected]>

chore: replaced constant CACHE_TTL.ONEHOUR with config 'CACHE_TTL'

2e313e8

Signed-off-by: Logan Nguyen <[email protected]>

chore: replaced constants.SEND_RAW_TRANSACTION_SIZE_LIMIT with config

af8ece5

Signed-off-by: Logan Nguyen <[email protected]>

acuarica previously approved these changes Feb 4, 2025

View reviewed changes

quiet-node added 4 commits February 4, 2025 15:27

chore: replaced constants. DEFAULT_ETH_GET_LOGS_BLOCK_RANGE_LIMIT wit…

a0f2181

…h config value Signed-off-by: Logan Nguyen <[email protected]>

chore: replaced constants.ETH_GET_TRANSACTION_COUNT_MAX_BLOCK_RANGE w…

25bb8d1

…ith config Signed-off-by: Logan Nguyen <[email protected]>

chore: replaced constants.MIRROR_NODE_RETRY_DELAY_DEFAULT with config

0b05cb0

Signed-off-by: Logan Nguyen <[email protected]>

chore: replaced constants.MIRROR_NODE_REQUEST_RETRY_COUNT_DEFAULT wit…

f99771a

…h config Signed-off-by: Logan Nguyen <[email protected]>

quiet-node dismissed acuarica’s stale review via f99771a February 4, 2025 21:44

natanasow previously approved these changes Feb 5, 2025

View reviewed changes

acuarica previously approved these changes Feb 5, 2025

View reviewed changes

quiet-node dismissed stale reviews from acuarica and natanasow via dd09502 February 5, 2025 19:02

quiet-node force-pushed the 3142-fix-configservice-get-type-warnings branch from fa189dd to 67a8e75 Compare February 5, 2025 19:40

fix: alphabeticalized configuration tables

9a30bf8

Signed-off-by: Logan Nguyen <[email protected]>

quiet-node approved these changes Feb 5, 2025

View reviewed changes

acuarica approved these changes Feb 5, 2025

View reviewed changes

quiet-node self-assigned this Feb 6, 2025

natanasow approved these changes Feb 6, 2025

View reviewed changes

Ferparishuertas approved these changes Feb 6, 2025

View reviewed changes

quiet-node merged commit 237b452 into hashgraph:main Feb 6, 2025
50 of 51 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Resolve Type Warnings for ConfigService.get() #3350

Fix: Resolve Type Warnings for ConfigService.get() #3350

belloibrahv commented Dec 21, 2024 •

edited by quiet-node

Loading

belloibrahv commented Dec 21, 2024

Nana-EC left a comment

belloibrahv commented Dec 25, 2024

acuarica left a comment

acuarica commented Dec 26, 2024

quiet-node commented Dec 26, 2024

belloibrahv commented Dec 26, 2024

belloibrahv commented Dec 26, 2024

Nana-EC commented Dec 27, 2024

belloibrahv commented Jan 3, 2025

acuarica left a comment •

edited

Loading

acuarica left a comment

natanasow left a comment

belloibrahv commented Feb 5, 2025

codecov bot commented Feb 5, 2025

sonarqubecloud bot commented Feb 5, 2025

quiet-node commented Feb 6, 2025

belloibrahv commented Feb 7, 2025

Fix: Resolve Type Warnings for ConfigService.get() #3350

Fix: Resolve Type Warnings for ConfigService.get() #3350

Conversation

belloibrahv commented Dec 21, 2024 • edited by quiet-node Loading

belloibrahv commented Dec 21, 2024

Nana-EC left a comment

Choose a reason for hiding this comment

belloibrahv commented Dec 25, 2024

acuarica left a comment

Choose a reason for hiding this comment

acuarica commented Dec 26, 2024

quiet-node commented Dec 26, 2024

belloibrahv commented Dec 26, 2024

belloibrahv commented Dec 26, 2024

Nana-EC commented Dec 27, 2024

belloibrahv commented Jan 3, 2025

acuarica left a comment • edited Loading

Choose a reason for hiding this comment

acuarica left a comment

Choose a reason for hiding this comment

natanasow left a comment

Choose a reason for hiding this comment

belloibrahv commented Feb 5, 2025

codecov bot commented Feb 5, 2025

Codecov Report

sonarqubecloud bot commented Feb 5, 2025

Quality Gate failed

quiet-node commented Feb 6, 2025

belloibrahv commented Feb 7, 2025

belloibrahv commented Dec 21, 2024 •

edited by quiet-node

Loading

acuarica left a comment •

edited

Loading