ovn-kubernetes/libovsdb

Don't export `client.Cache()`

Open

#181 opened on Jun 28, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (164 forks)auto 404
buggood first issue

Repository metrics

Stars
 (211 stars)
PR merge metrics
 (PR metrics pending)

Description

Since the client.Get and client.List API do most of the same thing. This ensures we don't accidentally expose something dangerous (e.g client.Cache().Purge()) to users. We'd need to ensure that we could still easily write tests without direct cache access though.

Contributor guide

Research direction
Investigate all usages of client.Cache() in the codebase, especially in tests. Understand how to hide the Cache method while still allowing test code to access cache internals (e.g., by exposing a test only interface or using internal packages).
Tech stack
go
Domain
backendapi
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gotesting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65