🐛 Fix: Prevent nil errors in log.Error to ensure proper logging and add sanity check and add custom linter to avoid this scenario in the future

[camilamacedo86]

Description

Solves the following issues and add a custom linter to avoid this scenario in the future:

• Closes; Fix issues with logging flag validations #1566
• Closes: Fix issues with logging flag validations #1556

Furthermore, it solves a similar scenario in the EventHandler code implementation found with the new custom linter check.

Reviewer Checklist

• API Go Documentation
• Tests: Unit Tests (and E2E Tests, if appropriate)
• Comprehensive Commit Messages
• Links to related GitHub Issue(s)

[netlify]

✅ Deploy Preview for olmv1 ready!

Name	Link
🔨 Latest commit	5a41f9f
🔍 Latest deploy log	https://app.netlify.com/sites/olmv1/deploys/67a3f0e49e3dc70008317ff0
😎 Deploy Preview	https://deploy-preview-1599--olmv1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[codecov]

Codecov Report

Attention: Patch coverage is 2.38095% with 41 lines in your changes missing coverage. Please review.

Project coverage is 67.27%. Comparing base (dcf50b8) to head (5a41f9f).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...nal/contentmanager/source/internal/eventhandler.go	3.33%	27 Missing and 2 partials ⚠️
catalogd/cmd/catalogd/main.go	0.00%	6 Missing ⚠️
cmd/operator-controller/main.go	0.00%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1599      +/-   ##
==========================================
- Coverage   67.66%   67.27%   -0.39%     
==========================================
  Files          59       59              
  Lines        4991     5012      +21     
==========================================
- Hits         3377     3372       -5     
- Misses       1367     1392      +25     
- Partials      247      248       +1     

Flag	Coverage Δ
e2e	52.98% <2.77%> (-0.40%)	⬇️
unit	55.18% <0.00%> (-0.24%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[joelanford]

golangci-lint should already be running go vet (assuming the govet linter is enabled). So I think we get this part automatically if we add the directory where we build the linter binary to the path for the golangci-lint run command.

[camilamacedo86]

See https://golangci-lint.run/contributing/new-linters/
But I could not make it work.
I would need to spend more time on that.

Could we move forward with this one as it is and then track a task for we see if we can integrate it with golangci as a follow up?

At least now we have the logs fixed + the linter

[anik120]

Pretty neat. Looks like @joelanford's already helped get this PR to a good state with his initial reviews.

/lgtm

so that Joe can approve :)

[joelanford]

Nice! You found a few other places we needed to fix as well!

[openshift-ci]

New changes are detected. LGTM label has been removed.

[camilamacedo86]

@joelanford you suggested
go build ./hack/ci/custom-linters/cmd/ -o ./bin/custom-linter
But it does not work.

.PHONY: custom-linter-build
LINTER_DIR := hack/ci/custom-linters
custom-linter-build: # HELP Build custom linter
	go build -tags '$(GO_BUILD_TAGS)' -o $(ROOT_DIR)/bin/custom-linter $(ROOT_DIR)/$(LINTER_DIR)/cmd

make custom-linter-build
go build -tags 'containers_image_openpgp' -o /Users/camilam/go/src/github/operator-framework/operator-controller/bin/custom-linter /Users/camilam/go/src/github/operator-framework/operator-controller/hack/ci/custom-linters/cmd
main module (github.com/operator-framework/operator-controller) does not contain package github.com/operator-framework/operator-controller/hack/ci/custom-linters/cmd
make: *** [custom-linter-build] Error 1

I am missing something silly here.
but anyway that does not seems to be a big deal.

[camilamacedo86]

Hi @joelanford

IHMO we can improve more here. However, wdyt is that acceptable to get merged and when we have time, can we work more on this one?