-
Notifications
You must be signed in to change notification settings - Fork 460
feat: Add ability to create a change request ignoring conflicts #6236
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
base: main
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Docker builds report
|
| title='Ignore Conflicts' | ||
| component={ | ||
| <Checkbox | ||
| label='Create this change request even if there is an existing one for the same feature' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't really related to being able to create the change request, but more about what happens when it goes live at the scheduled date.
Without this boolean enabled, a scheduled change will fail, and send a notification to the author, if another change has been made to the flag between creation of the change request, and the time it is due to go live. With this boolean enabled, it will ignore the conflict and update the flag with the information it had at the point of creation.
Based on this, we should (a) only show this if the change request is scheduled for the future, and (b) update the wording here. Perhaps something like:
"Ignore any conflicting changes when this change goes live. If disabled, and another change is made to this flag before the live date, this change will fail and a notification will be sent to the author."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could imagine a scenario where people line up these change requests without scheduling and the process is just manual - in a case where they don't know exactly when the time frame is they just know its coming.
For example this could be for maintenance but they do not know exactly when they want to turn the feature back on.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, yeah, it looks like the logic also applies there, for CRs that stay open for a while, and other changes happen in between, this would be the case too. In that scenario though, we'd probably want to have this checkbox on the 'publish' action, rather than when you create the change request itself.
The FE technically could handle that itself by checking if there are conflicts on an open CR, showing the checkbox and then sending 2 requests when the user hits publish - one to manually update the CR to set "ignore_conflicts": true, and the second to actually publish the CR.
What we'd probably want to do though is to add this same ignore_conflicts attribute to the payload on the publish endpoint.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, so this isn't needed really at all when creating change requests? One thing I noticed was we check for when the change request appears unchanged, it seems this has raised a usecase where submitting an unchanged change request is valid. I think I should just remove this check all-together and move the ignore_conflicts to the publish step?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not quite - there are 2 use cases:
- Publishing a change request
- Creating a scheduled change request
For the scheduled change, we do need this on creation of the change request.
Agreed that we should remove the hard fail on if there are no changes, but we should perhaps just show a warning message instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is done however it was a bit more complex than I thought a couple things had to be tested for regression
-
Versioned vs Non versioned environments
Since change requests use change sets for versioned environments the change detection had to differ when publishing -
Segment change detection
Detecting changes at the point of saving the feature modal is quite ugly until quite a lot of refactoring is done, I've tested this detects changes for segment changes / priority changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kyle-ssg I don't understand what's happened here. We've lost the option that was the original point of this change - there's no option anywhere on creating a scheduled change, or publishing a change request that is scheduled for the future.
To be totally clear, what I am expecting is a checkbox that says something like "Ignore any conflicts when this change goes live" to be visible in the following cases:
- When creating a scheduled change (i.e. clicking 'Schedule Update' from the feature modal)
- When publishing a change request that is scheduled for the future.
If this checkbox is checked, you should send the ignore_conflicts parameter to the change request. For the second point, this will require sending an update request to the change request before publishing.
Let me know if this isn't clear - I've also messaged on Slack to discuss in a huddle because I think we're not on the same page somewhere here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Following our discussion earlier, I've tried to document exactly how change requests and scheduled changes work in versioned / non-versioned environments here.
Based on this, the only real use case that I can see for this is to be able to select to ignore conflicts when there are no changes to the feature when the change request / scheduled change is created. I do think that we need to be clearer to the user about exactly what is going to happen, however, so I think we should implement the following:
'Create Change Request' flow
- Keep the confirmation when creating a change request with no changes from the current live version, but do not set
ignore_conflictsat this point. - If the change request is scheduled for the future, and there are no changes from the current live state, when the user chooses to publish the change request, they should be given the option to 'ignore conflicts' (and should be shown the warning text as below).
'Schedule Update' flow
- Add a confirmation when creating a scheduled update that contains no changes from the current live state (as per the current implementation for 'Create Change Request' flow
- Add a second confirmation to choose to 'Ignore conflicts' (and show the warning text as suggested below).
Suggested Warning Text
"By choosing to ignore conflicts, the change defined in this Change Request will become live regardless of any changes that happen to this feature between now and the scheduled live date. This may result in a loss of those changes, please proceed with care."
|
@kyle-ssg , this is looking better, but still missing a few pieces. I've listed out the scenarios that I've tested below with some feedback where necessary. ✅ Publishing an 'immediate' change request when there are no conflicts does not show the warning and does not send Technically the last one does kind of work, but it sends the Other Tests❌ Publishing an 'immediate' change request when there are conflicts shows the warning and sends I actually think this one isn't relevant anyway - sorry! In the BE, the Either way, the FE isn't sending the parameter (but it doesn't matter).
|

Thanks for submitting a PR! Please check the boxes below:
docs/if required so people know about the feature!Changes
Allows user to specify that they wish to ignore conflicts when creating a change request, this is useful when scheduling multiple updates to a single flag. Checking this option will also skip checks detecting that the feature state is unchanged.
How did you test this code?
Created multiple change requests for a flag