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

[Code Health] Mitigate import cycles in pkg/client #664

Open
6 tasks
bryanchriswhite opened this issue Jul 5, 2024 · 3 comments
Open
6 tasks

[Code Health] Mitigate import cycles in pkg/client #664

bryanchriswhite opened this issue Jul 5, 2024 · 3 comments
Assignees
Labels
code health Cleans up some code

Comments

@bryanchriswhite
Copy link
Contributor

bryanchriswhite commented Jul 5, 2024

Objective

Mitigate looming dependency cycles in pkg/client.

Origin Document

image

See: #655 (comment).

image

See: #662 (comment)

Goals

  • Enumerate potential long-term & general solutions.
  • Resolve tension caused by current import cycle workaround.
  • Systematically prevent future import cycles in pkg/client.

Deliverables

  • A comment or link to a notion page which outlines the possible solutions, their pros and cons.
  • One or more PRs which implement the chosen solution

Non-goals / Non-deliverables

  • Unrelated refactoring or re-organization.

General deliverables

  • Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
  • Testing: Add new tests (unit and/or E2E) to the test suite.
  • Makefile: Add new targets to the Makefile to make the new functionality easier to use.
  • Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: @bryanchriswhite
Co-Owners: @Olshansk

@bryanchriswhite bryanchriswhite added the code health Cleans up some code label Jul 5, 2024
@bryanchriswhite bryanchriswhite self-assigned this Jul 5, 2024
@Olshansk Olshansk changed the title [Code Health] Mitigate import cycles [Code Health] Mitigate import cycles in pkg/client Aug 5, 2024
@Olshansk
Copy link
Member

Olshansk commented Aug 5, 2024

@bryanchriswhite Is this still relevant or can we close it out?

@red-0ne
Copy link
Contributor

red-0ne commented Aug 6, 2024

@bryanchriswhite Is this still relevant or can we close it out?

It is still relevant but depends on the outcome of #697 (comment) to move forward.

@Olshansk
Copy link
Member

Olshansk commented Aug 7, 2024

This does not seem urgent w.r.t to all the other feature work. Please lmk if this is a Shanno Beta TestNet Launch action item or a quality of life that can be done post mainnet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code health Cleans up some code
Projects
Status: 📋 Backlog
Development

No branches or pull requests

3 participants