-
-
Notifications
You must be signed in to change notification settings - Fork 102
feat(move): implement move --reparent like amend --reparent #1631
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: master
Are you sure you want to change the base?
Conversation
... into dedicated function, to be reused in the future.
claytonrcarter
left a comment
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.
Thank you for this. The code looks simple enough, and solid. And the test seems thorough enough for the questions that I came in with.
Currently --reparent conflicts with --fixup since I am not yet sure how it should be implemented
I suspect that it would be fine to make --reparent and --fixup conflict, since it's not at all clear to me what the intended result should be. (ie if you are reparenting the source commit, then you're replacing the destination commit with the source ... I think?; or would you be doing the fixup and then reparenting the original child commits of the target onto the newly squashed commit. (effectively reverting the squashed changes))
would like to test this more in real life and see if it's actually working
The tests seem to confirm the behavior, so I think this would be OK to merge (pending the review comments), but it would also be interesting to see how it works for you in real life.
|
Thank you so much for taking a look! I agree with all the review comment and will try to address them in the coming week (because of day job 😢 About the comments from the original issue #1537 (comment): yes indeed
In the (not so practical) Note that the final git-branchless/git-branchless/tests/test_move.rs Lines 6409 to 6441 in 515faad
where |
Move the `reparent` option from being specific to the `amend` command to a general option within `MoveOptions`. This allows its use across various move-related commands like `restack`, `split`, and `sync`.
Implement the new `reparent` option for the `move` command. This ensures moved subtrees are reparented to their new destination. The `fixup` option now conflicts with `reparent`.
This causes abandoned commits to be reparented to their new destination, mimicking the behavior of `amend --reparent`.
When splitting a commit with `--discard` or `--detach`, the `--reparent` option ensures that the changes from the discarded or detached portion are squashed to the child commit, just like `amend --reparent`. Reparenting is not applied to `InsertAfter` or `InsertBefore` modes as it would simply be a no-op in these cases (the descendants are not changed in the first place).
Allows `sync` to reparent commits onto the main branch, effectively "undoing" intermediate main branch commits that would otherwise be between the original parent and the new parent.
|
I have implemented the consistent behavior for |
claytonrcarter
left a comment
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.
Thank you again @bryango for working on this.
I would like us to back out the changes to sync, split and restack for now. Let's move them into a different PR for now. I think that I would prefer to add --reparent only to move for now, and then see what feedback (if any) comes in the next release before extending it into more commands.
My concern is basically the same as I mentioned before: the behavior may be surprising, especially in the commands like sync and restack that are supposed to be more automatic and/or "hands off". And since both of those commands are just special cases of move, there is still a way for users to have this behavior if they wish.
As for split, I'm left wondering if a different name for the flag may be appropriate. For example, if --discard --reparent will remove the file from one commit but leave it in the child, it may be that --commute-down may be a more descriptive name. ?? 🤷
Then again, I tend to think of commits in terms of diffs, which isn't accurate. I'm open to compromise on this though. I don't want to dampen your enthusiasm!
| /// Generate a sequence of rebase steps that cause the subtree at `source_oid` | ||
| /// to be "reparented" by `dest_oids`, namely, keeping all contents | ||
| /// of descendant commits exactly the same. | ||
| pub fn reparent_subtree( | ||
| &mut self, | ||
| source_oid: NonZeroOid, | ||
| parent_oids: Vec<NonZeroOid>, | ||
| repo: &Repo, | ||
| ) -> eyre::Result<()> { |
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.
[please clarify] Please correct me if I'm wrong, but I don't think that this comment nor the fn name match the actual behavior:
- typo: I think that "by
dest_oids"probably should be "ontoparent_oids`". - please confirm: does calling
self.replace_commit()also trigger a rebase of the original commit's descendants onto the replacement commit? Or does it just do a replacement w/o rebase, leaving the descendants remaining on the original commit? ? The comment forreplace_commit()doesn't mention anything about subtrees, which leads me to believe that this fn is also not actually triggering a rebase, but I don't know. - if
replace_commit()does trigger a rebase, then we just need to address that first typo; the it doesn't rebase, then we should rewrite the comment and fn name to match
edit: I think I've confirmed that replace_commit does not also trigger a rebase of descendants, but I would love your 2nd opinion!
| let descendant_commit = repo.find_commit_or_fail(source_oid)?; | ||
| let descendant_message = descendant_commit.get_message_raw(); | ||
| let descendant_message = descendant_message.to_str().with_context(|| { | ||
| eyre::eyre!( | ||
| "Could not decode commit message for descendant commit: {:?}", | ||
| descendant_commit | ||
| ) | ||
| })?; | ||
| let reparented_descendant_oid = repo.create_commit( | ||
| None, | ||
| &descendant_commit.get_author(), | ||
| &descendant_commit.get_committer(), | ||
| descendant_message, | ||
| &descendant_commit.get_tree()?, | ||
| parents.iter().collect(), | ||
| )?; | ||
| self.replace_commit(source_oid, reparented_descendant_oid)?; |
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.
[nitpick (subjective)] I think that these descendant_* names made sense in the original context, but probably don't make sense now. Changing them to source_* would line up better w/ the input params: eg descendant_commit → source_commit, reparented_descendant_oid → reparented_source_oid, etc
| // test --reparent with --insert | ||
| { | ||
| let (stdout, _stderr) = git.branchless( | ||
| "move", | ||
| &[ | ||
| "--source", | ||
| &test3_oid.to_string(), | ||
| "--dest", | ||
| "master", | ||
| "--reparent", | ||
| "--insert", | ||
| ], | ||
| )?; | ||
| insta::assert_snapshot!(stdout, @r" | ||
| Attempting rebase in-memory... | ||
| [1/4] Committed as: 3f0558d create test3_will_also_contain_test2_when_reparented.txt | ||
| [2/4] Committed as: e1e0b99 create test2_will_also_contain_test1_when_reparented.txt | ||
| [3/4] Committed as: 4b5cd3e create test3_will_also_contain_test2_when_reparented.txt | ||
| [4/4] Committed as: fee6ba0 create test1.txt | ||
| branchless: processing 4 rewritten commits | ||
| branchless: running command: <git-executable> checkout e1e0b9952583334793f781ef25a6ce8d861cf85f | ||
| O f777ecc (master) create initial.txt | ||
| | | ||
| o 3f0558d create test3_will_also_contain_test2_when_reparented.txt | ||
| |\ | ||
| | o fee6ba0 create test1.txt | ||
| | | ||
| @ e1e0b99 create test2_will_also_contain_test1_when_reparented.txt | ||
| | | ||
| o 4b5cd3e create test3_will_also_contain_test2_when_reparented.txt | ||
| In-memory rebase succeeded. | ||
| "); | ||
| } |
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.
[please change] This seems like a bug. If we move test3, I would expect it to be moved completely, not copied. I suspect that there is a conflict/oversight happening in the rebase planner that isn't indicating that the original test3 has been replaced w/ the new one.
| // test --reparent with --exact | ||
| { | ||
| let (stdout, _stderr) = git.branchless( | ||
| "move", | ||
| &["--exact", "e1e0b99", "--dest", "master", "--reparent"], | ||
| )?; | ||
| insta::assert_snapshot!(stdout, @r" | ||
| Attempting rebase in-memory... | ||
| [1/2] Skipped now-empty commit: 5cdb6f1 create test3_will_also_contain_test2_when_reparented.txt | ||
| [2/2] Committed as: 40ca381 create test2_will_also_contain_test1_when_reparented.txt | ||
| branchless: processing 2 rewritten commits | ||
| branchless: running command: <git-executable> checkout 3f0558d435e63ebdfd1e81f5dbd3ddfaca387864 | ||
| O f777ecc (master) create initial.txt | ||
| |\ | ||
| | o 40ca381 create test2_will_also_contain_test1_when_reparented.txt | ||
| | | ||
| @ 3f0558d create test3_will_also_contain_test2_when_reparented.txt | ||
| | | ||
| o fee6ba0 create test1.txt | ||
| In-memory rebase succeeded. | ||
| "); | ||
| } |
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.
[comment (no action needed)] When the "copied test3" bug is fixed, this test may go away, it seems.
[suggestion (non-blocking)] I think it would be easier to follow these tests if we used branch names for each of the commits. Then we could refer to (eg) test-2 instead of e1e0b99.
| if dest_oids.is_empty() { | ||
| eyre::bail!("Destination OIDs must not be empty for move_subtree"); | ||
| } |
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.
Thank you for making this change even though it was preexisting! 😄
Closes #1537. This is done in the following commits:
amend --reparentlogic into a.reparent_subtreemethod for theRebasePlanBuildermoveand possiblyrestack,splitetcin the future (currently not implemented and would be a no-op)(now implemented, see below)movecommand with a fewbuilder.reparent_subtreecalls. Currently--reparentconflicts with--fixupsinceI am not yet sure how it should be implemented (help wanted)the behavior for--fixup --parentmay be ambiguous or confusing for usersmove --reparentand showcase its intended behavior.restack --reparentsplit --reparent(for --stack or --detach)sync --reparentI would like to test this more in real life and see if it's actually working, but I think it would be good to post it here early to gather some feedback: is this feature desired? Would this be the correct way to implement it? I have very limited knowledge on the codebase so all feedbacks are much welcomed. Thank you!