Add the feature for comparing two arbitrary commits #1108
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Adjust git push, pull, fetch, clone handlers, allowing `auth` and `cache_credentials` to be passed in in requests. - Allow `credential.helper` to pass through `git config` handler's filters.
Allow users to configure the value of `credential_helper` to be used in the credentials caching logic.
Implemennt methods that ensure `credential.helper` in `git config` to be used for credentials caching.
Extend git command logics (push, pull, fetch, clone) to support credentials caching when `auth` is provided.
Add tests to test the newly-implemented credentials caching logic for `git push`, `git pull`, `git fetch` and `git clone`.
Extend `Git.IAuth` and `CredentialsBox` for credentials caching. There is a checkbox for saving Git credentials temporarily. Stylings are also made for `CredentialsBox`. `jp-RedirectForm` does not work well with `input` checkboxes.
Let each of these methods also include `auth?.cacheCredentials` to POST to the backend.
Add extra class members to take care of the fetch poll when credentials are required.
Add method `fetch()` that is similar to how `push()` or `pull()` works. `_fetchRemotes()` now calls `fetch()`, and if credentials are required, blocks further calls and signals a credentials requirement status change.
`_fetchBlocked` is not needed.
This dialog now supports `fetch` operation, and upon successful authentication, unblocks the fetch poll by changing the credentials requirement state to `false`.
Also let `showGitOperationDialog()` accept `IGitExtension` `model` instead of the concrete class `GitExtension`.
The component now has a boolean for Git credentials requirement. Also add a callback connected to the model to update that boolean.
Inject the model to the component and reuse `showGitOperationDialog()` for the `fetch` operation.
Add a notification dot to the component so that it looks like the `push` (when the local branch is ahead) button and `pull` button (when the local branch is behind) on the top toolbar in the Git panel.
This method spawns a Git credential cache daemon so that the caching mechanism can work.
Let these methods check if a cache daemon is required, and invoke `ensure_git_credential_cache_daemon()` if on Linux, or else respond with an error message.
Let them return an error response if the credential helper cannot be ensured.
- Use `assert_awaited_` instead of `assert_called_` in some places. - Use `assert_has_awaits` instead of `assert_has_calls` in some places. - Use name `mock_execute` instead of `mock_authentication`. - Mock `sys.platform` as `"linux"`. - Make sure the `ensure_git_credential_cache_daemon()` is called accordingly.
This is so that the front-end can recognize this response with `IResultWithMessage`.
Add argument `cache_credentials` to assertions.
This is for compatibility with Python 3.7's `unittest`.
jupyterlab/pull/1099#pullrequestreview-919970442
- jupyterlab/pull/1099#pullrequestreview-926143691 - Remove redundant tests - Adjust tests to match changed method signatures - Add a missing `self.config()` call when ensuring Git credential helper
Also fix a minor typo.
This component displays a comparison between two commits.
These buttons allow selecting commits for comparison.
This interface is used for comparison results.
This will also be used by the commit comparison logic that will exist in `src/components/GitPanel.tsx` later.
The comparison status is invalidated when the branch status gets refreshed.
|
|
fcollonval
requested changes
Apr 15, 2022
There was a problem hiding this comment.
Thanks @quachtridat and @ZeshanFayyaz
I mainly have suggestions for a better wording (using reference/challenger instead of lhs/rhs) and a small rework to avoid storing twice the same information in the panel state.
quachtridat
commented
Apr 15, 2022
Implemented naming convention changes on jupyterlab#985
The left border width for commits being compared is 6px now.
Address the commit comparison state redundancy in `GitPanel`. jupyterlab/pull/1108#discussion_r851098378
fcollonval
reviewed
Apr 20, 2022
fcollonval
approved these changes
Apr 20, 2022
There was a problem hiding this comment.
Thanks a lot @quachtridat and @ZeshanFayyaz
This is a great addition
|
@all-contributors please add quachtridat for code |
|
I've put up a pull request to add @quachtridat! 🎉 |
|
@all-contributors please add @ZeshanFayyaz for code |
|
I've put up a pull request to add @ZeshanFayyaz! 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR resolves #985 by implementing the necessary components and logic that will allow users to select two commits in the History tab and see the Git diff for every changed file.
Details
Backend
5cee9bf
Frontend
Each entry in
Historytab now has two buttons, each with an icon of a document containing an arrow pointing right/left. Clicking one of these will make the commit comparison box pop up, and the diff will be evaluated when there are two commits selected for comparison. Stylings are similar to how theChangedsection for a commit entry inHistoryis styled.Caveats
The commit comparison box can be collapsed, but cannot be resized for now.
Demos
The commit that is selected for compare has a little red color on the left side.
The commit that is to be compared with selected has a little green color on the left side.
The comparison results are shown in the commit comparison box at the bottom of the
Historytab.The diff for the file
README.mdis shown when the diff button for that file is clicked.The commit comparison box when it is collapsed.
Notes
This PR may need more tests.
Linked issues
#985