⚠️ Create a dedicated logging package to encapsulate calls to zap

[justaugustus]

• Please check if the PR fulfills these requirements

  • Tests for the changes have been added (for bug fixes / features)

    We're roughly mimicking existing functionality and the interface may change in future. Logging usage that has changed exists in packages that already have test coverage.

    tl;dr -- If existing tests pass, we should be fine here.

  • PR title follows the guidelines defined in https://github.com/ossf/scorecard/blob/main/CONTRIBUTING.md#pr-process

• What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

  Introduces a logging package to eventually replace go.uber.org/zap.
  Here we're effectively quarantining usage of the go.uber.org/zap and go.uber.org/zap/zapcore to a single package, log.

• What is the current behavior? (You can also link to an open issue here)

  See Should scorecard be forcing users to use a zap.Logger? #1273.

• What is the new behavior (if this is a feature change)?

  Functions that create instances of zap.Logger now create instances of log.Logger:

  type Logger struct {
      Zap *zap.Logger
  }

  ...which means usage of zap will now look something like:

  logger.Zap.Info()

  As @jeffmendoza mentions in Should scorecard be forcing users to use a zap.Logger? #1273 (comment):

  Ideally CreateGitHubRepoClient() can be refactored to take a DetailLogger instead of a zap.Logger.

  the goal would to support logging without zap, opting to use DetailLogger instead.

• Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

  Consumers of functions like:

  func CreateGithubRepoClient(ctx context.Context, logger *zap.Logger) clients.RepoClient { ... }

  will need to use log.Logger as an argument:

  func CreateGithubRepoClient(ctx context.Context, logger *log.Logger) clients.RepoClient { ... }

  as well as update log calls from:

  ghClient := CreateGithubRepoClient(ctx, logger)
  logger.Info(...)

  to:

  ghClient := CreateGithubRepoClient(ctx, logger)
  logger.Zap.Info(...)

• Other information:

[github-actions]

Integration tests success for
[e22f61e]
(https://github.com/ossf/scorecard/actions/runs/1725243558)

[github-actions]

Integration tests success for
[c36a736]
(https://github.com/ossf/scorecard/actions/runs/1725374829)

[github-actions]

Integration tests success for
[37d746b]
(https://github.com/ossf/scorecard/actions/runs/1725718390)

[justaugustus]

@inferno-chromium @naveensrinivasan @azeemshaikh38 @laurentsimon @olivekl @jeffmendoza -- This is in a good place for initial review. I don't want run to far ahead in case there's something design-wise that needs fixing.

[github-actions]

Integration tests success for
[4b356a6]
(https://github.com/ossf/scorecard/actions/runs/1725867915)

[naveensrinivasan]

I had a quick look and 👍. I will let @azeemshaikh38 and @laurentsimon chime in

[justaugustus]

I had a quick look and 👍. I will let @azeemshaikh38 and @laurentsimon chime in

Thanks so much, Naveen!

[azeemshaikh38]

This looks awesome @justaugustus, thanks!

[justaugustus]

@naveensrinivasan @azeemshaikh38 -- Fixed up the reviews. Should be good to retrigger CI on :)

[naveensrinivasan]

@ naveensrinivasan @azeemshaikh38 -- Fixed up the reviews. Should be good to retrigger CI on :)

Thanks!

[github-actions]

Integration tests success for
[ac1d50f]
(https://github.com/ossf/scorecard/actions/runs/1726086387)

[codecov-commenter]

Codecov Report

Merging #1502 (ac1d50f) into main (f4e9dfd) will increase coverage by 0.01%.
The diff coverage is 41.17%.

@@            Coverage Diff             @@
##             main    #1502      +/-   ##
==========================================
+ Coverage   50.42%   50.43%   +0.01%     
==========================================
  Files          68       68              
  Lines        6071     6069       -2     
==========================================
  Hits         3061     3061              
+ Misses       2809     2807       -2     
  Partials      201      201              

[azeemshaikh38]

Thanks @justaugustus, looks good to merge to me.

[laurentsimon]

Just wanted to join and say thanks! This is a massive PR!