feat: environment variables validation

natanasow commented 1 day ago

Description:

When updating CI we noticed with the configuration updates, that if an environment variable such as OPERATOR_ID was defined with not value, it would override the values in the .env file. This caused tests to fail when the relay tried to submit a transaction. Ideally, the relay to fail fast, during bootstrap if required environment variables are not set.

Solution:

Consolidate environment variable loading to the start of the relay. Fail to start if any required environment variables are not set. Better to fail fast.

All environment variables should be handled in one class that can also validate them, list their usage in a --help option, and exit appropriately if a validation fails.

We should also replace environment variables with a yml settings file.

Needed validations:

Make sure that CHAIN_ID, HEDERA_NETWORK, MIRROR_NODE_URL, OPERATOR_ID_MAIN, OPERATOR_KEY_MAIN, SERVER_PORT are non-empty and in the expected format
Make sure that if OPERATOR_KEY_FORMAT is not specified, the provided OPERATOR_KEY_MAIN is in the DER format
Make sure that HBAR_RATE_LIMIT_TINYBAR is more than HBAR_RATE_LIMIT_BASIC, HBAR_RATE_LIMIT_EXTENDED, HBAR_RATE_LIMIT_PRIVILEGED

Implementation Steps

[ ] Consolidate all environment variables into one service class
[ ] Add validations and exit on fail of validation, to the environment service class
[ ] Add help/usage message and option
[ ] Enhance to use yml instead of dotenv.

There are several solid proposals by @AlfredoG87 that we should take into account as well. Described here https://github.com/hashgraph/hedera-json-rpc-relay/pull/2956#pullrequestreview-2338214042.

cc: @ebadiere

Related issue(s):

Fixes #3023

Notes for reviewer:

Checklist

[ ] Documented (Code comments, README, etc.)
[ ] Tested (unit, integration, etc.)

codecov[bot] commented 1 day ago

Codecov Report

Attention: Patch coverage is 96.34146% with 3 lines in your changes missing coverage. Please review.

Project coverage is 84.82%. Comparing base (ab8d06e) to head (2b4efba).

Files with missing lines	Patch %	Lines
...kages/config-service/src/services/loggerService.ts	57.14%	3 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## 2686-capture-env-variables-into-constants #3047 +/- ## ============================================================================= - Coverage 85.01% 84.82% -0.20% ============================================================================= Files 59 46 -13 Lines 3943 3307 -636 Branches 786 650 -136 ============================================================================= - Hits 3352 2805 -547 + Misses 350 298 -52 + Partials 241 204 -37 ``` | [Flag](https://app.codecov.io/gh/hashgraph/hedera-json-rpc-relay/pull/3047/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hashgraph) | Coverage Δ | | |---|---|---| | [config-service](https://app.codecov.io/gh/hashgraph/hedera-json-rpc-relay/pull/3047/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hashgraph) | `94.79% <96.34%> (+8.12%)` | :arrow_up: | | [relay](https://app.codecov.io/gh/hashgraph/hedera-json-rpc-relay/pull/3047/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hashgraph) | `84.52% <ø> (-0.69%)` | :arrow_down: | | [server](https://app.codecov.io/gh/hashgraph/hedera-json-rpc-relay/pull/3047/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hashgraph) | `?` | | | [ws-server](https://app.codecov.io/gh/hashgraph/hedera-json-rpc-relay/pull/3047/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hashgraph) | `?` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hashgraph#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files with missing lines](https://app.codecov.io/gh/hashgraph/hedera-json-rpc-relay/pull/3047?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hashgraph) | Coverage Δ | | |---|---|---| | [packages/config-service/src/services/index.ts](https://app.codecov.io/gh/hashgraph/hedera-json-rpc-relay/pull/3047?src=pr&el=tree&filepath=packages%2Fconfig-service%2Fsrc%2Fservices%2Findex.ts&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hashgraph#diff-cGFja2FnZXMvY29uZmlnLXNlcnZpY2Uvc3JjL3NlcnZpY2VzL2luZGV4LnRz) | `90.00% <100.00%> (+3.33%)` | :arrow_up: | | [...ckages/config-service/src/services/relayConfigs.ts](https://app.codecov.io/gh/hashgraph/hedera-json-rpc-relay/pull/3047?src=pr&el=tree&filepath=packages%2Fconfig-service%2Fsrc%2Fservices%2FrelayConfigs.ts&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hashgraph#diff-cGFja2FnZXMvY29uZmlnLXNlcnZpY2Uvc3JjL3NlcnZpY2VzL3JlbGF5Q29uZmlncy50cw==) | `100.00% <100.00%> (ø)` | | | [...s/config-service/src/services/validationService.ts](https://app.codecov.io/gh/hashgraph/hedera-json-rpc-relay/pull/3047?src=pr&el=tree&filepath=packages%2Fconfig-service%2Fsrc%2Fservices%2FvalidationService.ts&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hashgraph#diff-cGFja2FnZXMvY29uZmlnLXNlcnZpY2Uvc3JjL3NlcnZpY2VzL3ZhbGlkYXRpb25TZXJ2aWNlLnRz) | `100.00% <100.00%> (ø)` | | | [...kages/config-service/src/services/loggerService.ts](https://app.codecov.io/gh/hashgraph/hedera-json-rpc-relay/pull/3047?src=pr&el=tree&filepath=packages%2Fconfig-service%2Fsrc%2Fservices%2FloggerService.ts&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hashgraph#diff-cGFja2FnZXMvY29uZmlnLXNlcnZpY2Uvc3JjL3NlcnZpY2VzL2xvZ2dlclNlcnZpY2UudHM=) | `57.14% <57.14%> (ø)` | | ... and [20 files with indirect coverage changes](https://app.codecov.io/gh/hashgraph/hedera-json-rpc-relay/pull/3047/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hashgraph)