Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Utility] Adjust default configuration based on the user-defined configuration #858

Open
11 tasks
adshmh opened this issue Jun 25, 2023 · 0 comments
Open
11 tasks
Assignees
Labels
utility Utility specific changes

Comments

@adshmh
Copy link
Contributor

adshmh commented Jun 25, 2023

Objective

Default configuration should not result in errors. More specifically, there seems to be some scenarios where user-defined configuration should result in a modified default configuration. For example, currently if the user enables fisherman, the default servicer configuration will still be applied, resulting in an error when initializing the utility module, because fisherman and servicer cannot both be enabled.

Origin Document

Encountered this in #803, after adding a default servicer configuration.

image

and the corresponding set of unit tests that would fail if a servicer default config is added:

image

Goals

  • The default configuration should take into account the user-defined configuration, see the above description for an example.

Deliverable

  • Updated Code to implement the required adjustments: involves using viper differently (or changing to a different config library)
  • Updated README/documentation to list all invalid combinations along with the corresponding reasons.
  • Allow the default servicer config to be applied when there are no contradictions with the user-defined configuration.

Non-goals / Non-deliverables

General issue deliverables

  • Update any relevant local/global README(s)
  • Update relevant source code tree explanations
  • Add or update any relevant or supporting mermaid diagrams

Testing Methodology

  • Task specific tests or benchmarks: make ...
  • New tests or benchmarks: make ...
  • All tests: make test_all
  • LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md
  • k8s LocalNet: verify a k8s LocalNet is still functioning correctly by following the instructions here

Creator: [@adshmh]
Co-Owners: [@Olshansk]

@adshmh adshmh added the utility Utility specific changes label Jun 25, 2023
@adshmh adshmh self-assigned this Jun 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
utility Utility specific changes
Projects
Status: Backlog
Development

No branches or pull requests

1 participant