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.

Sign up for GitHub

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

Jump to bottom

feat: improve StatefulSet immutable field error messages #21209

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

feat: improve StatefulSet immutable field error messages #21209

wants to merge 4 commits into from
+48 −1

Conversation

aali309
Copy link
Contributor

@aali309 aali309 commented Dec 17, 2024 •
edited
Loading

Checklist:

Fixes: #20899
Depends on: 654

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

Before:
Screenshot 2024-12-13 at 8 30 35 PM

After:
Screenshot 2024-12-18 at 2 31 48 PM

@bunnyshell Bunnyshell
Copy link

bunnyshell bot commented Dec 17, 2024 •
edited
Loading

🔴 Preview Environment stopped on Bunnyshell

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

  • 🔵 /bns:start to start the environment
  • 🚀 /bns:deploy to redeploy the environment
  • ❌ /bns:delete to remove the environment

@aali309 aali309 mentioned this pull request Dec 17, 2024
Open
@aali309
Copy link
Contributor Author

aali309 commented Dec 18, 2024 •
edited
Loading

How to test locally

  1. See changes made on the gitops-engine repo

  2. checkout to this PR

  3. Add this line at the bottom of the go.mod file:
    replace github.com/argoproj/gitops-engine => github.com/aali309/gitops-engine 1751d55cb526803d9d8684a08fc8d28b56e56be5

  4. run make mod-download-local && make mod-vendor-local

this should change the above added replace github...... to something similar to the below screenshot

Screenshot 2024-12-18 at 2 52 36 PM

  1. Run the server locally and make changes to any immutable fields and try to sync. The error should provide the exact field that was changed with the old and new values.

@aali309 aali309 marked this pull request as ready for review December 18, 2024 20:36
@aali309 aali309 requested a review from a team as a code owner December 18, 2024 20:36
pasha-codefresh
pasha-codefresh requested changes Dec 19, 2024
View reviewed changes
ui/src/app/applications/components/application-operation-state/application-operation-state.tsx Outdated
}

// Format immutable fields error message
if (cleanMessage.includes('attempting to change immutable fields:')) {
Copy link
Member

Choose a reason for hiding this comment

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

maybe it will be better to move this part to some formatter util that will cover such cases and use it here? i am sure we probably will want cover other formatting cases in future

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrii-korotkov-verkada andrii-korotkov-verkada andrii-korotkov-verkada approved these changes

@pasha-codefresh pasha-codefresh Awaiting requested review from pasha-codefresh

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
ready-for-review
Projects
Argo CD Review
Status: Ready for final review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Report the field that violated the updates to fields are forbidden constraint
3 participants
@aali309 @pasha-codefresh @andrii-korotkov-verkada