letsencrypt / letsencrypt/boulder

Separate sa package into gRPC and non-gRPC public interfaces

Open
#6,507 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
5.8k
Forks
649
Avg merge
3d 23h
Merged PRs (30d)
24

Description

The //sa package (and saImpl object, I think) currently exposes both gRPC and non-gRPC public methods. This is because some boulder components use the SA via gRPC, while others import the SA package directly and use their own database connections.

We should split these two uses into two separate packages, so the //sa package itself only exposes a gRPC impl and something else exposes the other functions.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the //sa package and the saImpl object, then inventory which callers use gRPC and which import the package directly. The work is complete when those uses are exposed through separate packages, with //sa limited to the gRPC implementation and the non-gRPC functions moved to the other interface.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.