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

fix: stop ignoring most of the errors #745

Merged
merged 7 commits into from
May 8, 2024
Merged

fix: stop ignoring most of the errors #745

merged 7 commits into from
May 8, 2024

Conversation

Skarlso
Copy link
Contributor

@Skarlso Skarlso commented Apr 24, 2024

Description

Fixes open-component-model/ocm-project#40

What type of PR is this? (check all applicable)

  • πŸ• Feature
  • πŸŽ‡ Restructuring
  • πŸ› Bug Fix
  • πŸ“ Documentation Update
  • 🎨 Style
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ”₯ Performance Improvements
  • βœ… Test
  • πŸ€– Build
  • πŸ” CI
  • πŸ“¦ Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

  • Related Issue # (issue)
  • Closes # (issue)
  • Fixes # (issue)

Remove if not applicable

Screenshots

Added tests?

  • πŸ‘ yes
  • πŸ™… no, because they aren't needed
  • πŸ™‹ no, because I need help
  • Separate ticket for tests # (issue/pr)

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Added to documentation?

  • πŸ“œ README.md
  • πŸ™… no documentation needed

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@Skarlso Skarlso force-pushed the stop-ignoring-errors branch from 19dc594 to c5dedcb Compare April 24, 2024 11:29
@github-actions github-actions bot added the size/m Medium label Apr 24, 2024
Copy link
Contributor

github-actions bot commented Apr 24, 2024

Mend Scan Summary: ❌

Repository: open-component-model/ocm

VIOLATION DESCRIPTION NUMBER OF VIOLATIONS
HIGH/CRITICAL SECURITY VULNERABILITIES 1
MAJOR UPDATES AVAILABLE 0
LICENSE REQUIRES REVIEW 4
HIGH RISK LICENSES 9
RESTRICTIED LICENSE FOR ON-PREMISE DELIVERY 0

Detailed Logs: mend-scan-> Generate Report
Mend UI

Copy link
Contributor

ocmbot bot commented Apr 24, 2024

Integration Tests for 600f585 run with result: Success βœ…!

@morri-son morri-son requested a review from mandelsoft April 24, 2024 11:36
@Skarlso Skarlso force-pushed the stop-ignoring-errors branch from c5dedcb to 66e45a5 Compare April 24, 2024 11:40
Copy link
Contributor

ocmbot bot commented Apr 24, 2024

Integration Tests for 600f585 run with result: Success βœ…!

@Skarlso Skarlso requested a review from morri-son April 24, 2024 12:14
Copy link
Member

@hilmarf hilmarf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm quite new to go, so please bear with me.
For those cases, where the method signature doesn't allow to return an error, shouldn't we then at least log them?

@Skarlso
Copy link
Contributor Author

Skarlso commented Apr 24, 2024

I'm quite new to go, so please bear with me.

For those cases, where the method signature doesn't allow to return an error, shouldn't we then at least log them?

We can attempt to but it's not always possible because the logger is just present or it would require changing the interface to pass it in which is simply too disruptive.

@Skarlso Skarlso added this to the 2024-Q2 milestone Apr 26, 2024
@Skarlso Skarlso force-pushed the stop-ignoring-errors branch from 66e45a5 to fd91446 Compare April 26, 2024 12:56
Copy link
Contributor

ocmbot bot commented Apr 26, 2024

Integration Tests for 4b9a12f run with result: Success βœ…!

Copy link
Contributor

ocmbot bot commented Apr 26, 2024

Integration Tests for 4b9a12f run with result: Success βœ…!

@Skarlso Skarlso requested a review from hilmarf April 26, 2024 13:40
Copy link
Contributor

ocmbot bot commented May 3, 2024

Integration Tests for ea79db6 run with result: Success βœ…!

@morri-son morri-son requested a review from fabianburth May 3, 2024 13:10
Copy link
Contributor

ocmbot bot commented May 7, 2024

Integration Tests for e05a5a0 run with result: Success βœ…!

@morri-son morri-son removed their request for review May 7, 2024 15:08
@Skarlso
Copy link
Contributor Author

Skarlso commented May 8, 2024

@hilmarf can we get on with this, please? I would rather have errors handled than this being stuck in review, forever open over whether or not we log errors.

We can open a separate issue for handling logging but this is already a massive improvement on errors being completely ignored otherwise and not surfaced at all, in most of the cases.

With staff being bogged down and in low numbers, I would rather iterate fast and solve issues as they arise than be in review forever.

@hilmarf
Copy link
Member

hilmarf commented May 8, 2024

@hilmarf can we get on with this, please? I would rather have errors handled than this being stuck in review, forever open over whether or not we log errors.

We can open a separate issue for handling logging but this is already a massive improvement on errors being completely ignored otherwise and not surfaced at all, in most of the cases.

With staff being bogged down and in low numbers, I would rather iterate fast and solve issues as they arise than be in review forever.

totally fine with me, but you had a nice pattern for identifying the problematic code areas... now with handling them, but don't logging them, still my fear is, that we silently drop errors and won't even be able to find the problematic coding later on, because there is no search pattern anymore available...

so please: either try to log the errors (and yes, I don't care where those logs might appear) OR at least add a FIXME / TODO comment, where the errors are not populated up.

@Skarlso
Copy link
Contributor Author

Skarlso commented May 8, 2024

so please: either try to log the errors (and yes, I don't care where those logs might appear) OR at least add a FIXME / TODO comment, where the errors are not populated up.

πŸ‘

Copy link
Contributor

ocmbot bot commented May 8, 2024

Integration Tests for 8a4d919 run with result: Success βœ…!

@Skarlso
Copy link
Contributor Author

Skarlso commented May 8, 2024

@hilmarf Done. :)

@hilmarf hilmarf enabled auto-merge (squash) May 8, 2024 12:36
@hilmarf hilmarf disabled auto-merge May 8, 2024 12:47
@hilmarf hilmarf merged commit 7f589f7 into main May 8, 2024
15 checks passed
@hilmarf hilmarf deleted the stop-ignoring-errors branch May 8, 2024 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/m Medium
Projects
None yet
Development

Successfully merging this pull request may close these issues.

There are around ~70 or so ignored errors NOT in test files
2 participants