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

Pass RestClientCache as constructor param #3222

Merged
merged 2 commits into from
May 1, 2024
Merged

Pass RestClientCache as constructor param #3222

merged 2 commits into from
May 1, 2024

Conversation

dmjb
Copy link
Contributor

@dmjb dmjb commented May 1, 2024

Relates to #2845

This has been broken out of a larger PR for ease of review.

The RestCacheClient is used in several parts of the code, but is always passed as an option. In some places (which will be changed in a subsequent PR) this is used as a form of dependency injection. However, this pattern has caused problems in some of the refactoring I am doing.

This PR changes the code so that it is passed around explicitly to the constructor methods of the structs/interfaces which need it. This is an interim step - the desired end state is that the RestClientCache is hidden from most of its current clients, and only the GitHub ProviderClassManager will depend on it (along with the Github trait instances it produces). ProviderBuilder has not been changed - that is because I am working towards getting rid of that struct.

This PR also introduces a no-op implementation of the RestClientCache interface. Previously, code had to explicitly check that it was not nil before using it. In future PRs, I will get rid of some of these guards.

Summary

Provide a brief overview of the changes and the issue being addressed.
Explain the rationale and any background necessary for understanding the changes.
List dependencies required by this change, if any.

Fixes #(related issue)

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

Relates to #2845

This has been broken out of a larger PR for ease of review.

The RestCacheClient is used in several parts of the code, but is always
passed as an option. In some places (which will be changed in a
subsequent PR) this is used as a form of dependency injection. However,
this pattern has caused problems in some of the refactoring I am doing.

This PR changes the code so that it is passed around explicitly to the
constructor methods of the structs/interfaces which need it. This is an
interim step - the desired end state is that the RestClientCache is
hidden from most of its current clients, and only the GitHub
ProviderClassManager will depend on it (along with the Github trait
instances it produces).
@dmjb dmjb requested a review from a team as a code owner May 1, 2024 14:17
@coveralls
Copy link

coveralls commented May 1, 2024

Coverage Status

coverage: 50.63% (+0.01%) from 50.617%
when pulling fc2fccf on rest-cache-cleanup
into 2d28734 on main.

@dmjb dmjb merged commit b9daa61 into main May 1, 2024
21 checks passed
@dmjb dmjb deleted the rest-cache-cleanup branch May 1, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants