🐛 Fix: Truncate large error messages in status conditions (OCPBUGS-59518, OCPBUGS-38567) #2169
Conversation
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Can you include some details of the messages that are too long? I feel like arbitrarily truncating the message is sort of papering over the underlying issue, which is that 30k-byte messages in conditions are a poor UX, and the real solution would be to make the message shorter to begin with. /hold |
| @@ -160,7 +160,7 @@ func ensureAllConditionsWithReason(ext *ocv1.ClusterExtension, reason v1alpha1.C | |||
| Type: condType, | |||
| Status: metav1.ConditionFalse, | |||
| Reason: string(reason), | |||
| Message: message, | |||
| Message: truncateMessage(message), | |||
There was a problem hiding this comment.
If there's a limit imposed on all condition messages, it seems like we need to make sure that we truncate all condition messages.
This is one of many places where we set condition messages, right?
We may need to implement a wrapper around the meta.SetCondition() that:
- truncates messages
- everything throughout our project uses.
There was a problem hiding this comment.
Yes, I think wrapper will be better as well +1
This comment was marked as outdated.
This comment was marked as outdated.
3fd05a8 to
9121120
Compare
9121120 to
aec2345
Compare
When upgrading operators, CRD validation errors can be very large (50KB+). Kubernetes rejects status updates over 32KB with "Too long: may not be more than 32768 bytes". This causes ClusterExtension upgrades to fail and get stuck. Assisted-by: Cursor
aec2345 to
b30dc47
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2169 +/- ##
==========================================
+ Coverage 72.71% 72.74% +0.02%
==========================================
Files 79 79
Lines 7378 7385 +7
==========================================
+ Hits 5365 5372 +7
Misses 1666 1666
Partials 347 347
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
/hold cancel Thanks Camila! +1 on solving this both ways. Truncate long messages AND try to avoid long messages in the first place! |
When upgrading operators, CRD validation errors can be very large (50KB+). Kubernetes rejects status updates over 32KB with "Too long: may not be more than 32768 bytes". This causes ClusterExtension upgrades to fail and get stuck.
Messages keep important info at the start and add "... [message truncated]" suffix. Now upgrades complete successfully even with large CRD validation errors.
Added unit tests for truncation logic and CRD error scenarios.
Reviewer Checklist