Skip to content

[Core] Make viper great again #907

@Olshansk

Description

@Olshansk

Objective

Cleanup, improve and clarify how viper work and is used throughout the codebase.

Origin Document

It started in #902 with this comment:

Screenshot 2023-07-14 at 3 50 53 PM

Then it crossed over in #891 with this comment

Screenshot 2023-07-14 at 3 50 59 PM

Goals

  • Clearer separation between CLI and API code
  • Parsing the config consistently in all CLI commands.
  • Handling flags consistently in all commands.

Deliverable

  • Refactor how viper is used to make it clear and understandable
  • Update the documentation for how & why we use viper in a certain way

Non-goals / Non-deliverables

  • Removing viper as a dependency

General issue deliverables

  • Update the appropriate CHANGELOG(s)
  • 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: @Olshansk
Co-Owners: @bryanchriswhite

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working - expected behaviour is incorrectdocumentationImprovements or additions to documentationinfraCore infrastructure - not protocol relatedtoolingtooling to support development, testing et al

    Type

    No type

    Projects

    Status

    Backlog

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions