Skip to content

Display diff between any two commits for a single file #1117

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

Merged
merged 2 commits into from
Apr 25, 2022
Merged

Display diff between any two commits for a single file #1117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a59b3b2
Display any two commits diff for single file
fcollonval Apr 25, 2022
13dbc97
Add integration test
fcollonval Apr 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 66 additions & 36 deletions src/components/GitPanel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,47 +504,56 @@ export class GitPanel extends React.Component<IGitPanelProps, IGitPanelState> {
challengerCommit={this.state.challengerCommit}
onSelectForCompare={commit => async event => {
event.stopPropagation();
this.setState({ referenceCommit: commit });
this.setState({ referenceCommit: commit }, () => {
this._openSingleFileComparison(
event as React.MouseEvent<HTMLLIElement, MouseEvent>
);
});
}}
onCompareWithSelected={commit => async event => {
event.stopPropagation();
this.setState({ challengerCommit: commit });
this.setState({ challengerCommit: commit }, () => {
this._openSingleFileComparison(
event as React.MouseEvent<HTMLLIElement, MouseEvent>
);
});
}}
/>
{(this.state.referenceCommit || this.state.challengerCommit) && (
<CommitComparisonBox
header={this.props.trans.__(
'Compare %1 and %2',
this.state.referenceCommit
? this.state.referenceCommit.commit.substring(0, 7)
: '...',
this.state.challengerCommit
? this.state.challengerCommit.commit.substring(0, 7)
: '...'
)}
referenceCommit={this.state.referenceCommit}
challengerCommit={this.state.challengerCommit}
commands={this.props.commands}
model={this.props.model}
logger={this.props.logger}
trans={this.props.trans}
onClose={event => {
event.stopPropagation();
this.setState({
referenceCommit: null,
challengerCommit: null
});
}}
onOpenDiff={
this.state.referenceCommit && this.state.challengerCommit
? openFileDiff(this.props.commands)(
this.state.challengerCommit,
this.state.referenceCommit
)
: undefined
}
/>
)}
{this.props.model.selectedHistoryFile === null &&
(this.state.referenceCommit || this.state.challengerCommit) && (
<CommitComparisonBox
header={this.props.trans.__(
'Compare %1 and %2',
this.state.referenceCommit
? this.state.referenceCommit.commit.substring(0, 7)
: '...',
this.state.challengerCommit
? this.state.challengerCommit.commit.substring(0, 7)
: '...'
)}
referenceCommit={this.state.referenceCommit}
challengerCommit={this.state.challengerCommit}
commands={this.props.commands}
model={this.props.model}
logger={this.props.logger}
trans={this.props.trans}
onClose={event => {
event.stopPropagation();
this.setState({
referenceCommit: null,
challengerCommit: null
});
}}
onOpenDiff={
this.state.referenceCommit && this.state.challengerCommit
? openFileDiff(this.props.commands)(
this.state.challengerCommit,
this.state.referenceCommit
)
: undefined
}
/>
)}
</React.Fragment>
);
}
Expand Down Expand Up @@ -851,4 +860,25 @@ export class GitPanel extends React.Component<IGitPanelProps, IGitPanelState> {
}
return <div>{elem}</div>;
}

/**
*
*/
private _openSingleFileComparison(
event: React.MouseEvent<HTMLLIElement, MouseEvent>
): void {
if (
this.props.model.selectedHistoryFile &&
this.state.referenceCommit &&
this.state.challengerCommit
) {
openFileDiff(this.props.commands)(
this.state.challengerCommit,
this.state.referenceCommit
)(
this.props.model.selectedHistoryFile.to,
!this.props.model.selectedHistoryFile.is_binary
)(event);
}
}
}
31 changes: 29 additions & 2 deletions ui-tests/tests/commit-diff.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,10 @@ test.describe('Commits diff', () => {

// URL for merge conflict example repository
await page.goto(`tree/${tmpPath}/repository`);

await page.sidebar.openTab('jp-git-sessions');
});

test('should display commits diff from history', async ({ page }) => {
await page.sidebar.openTab('jp-git-sessions');
await page.click('button:has-text("History")');
const commits = page.locator('li[title="View commit details"]');

Expand All @@ -38,4 +37,32 @@ test.describe('Commits diff', () => {

expect(await page.waitForSelector('text=Changed')).toBeTruthy();
});

test('should display diff from single file history', async ({ page }) => {
await page.sidebar.openTab('filebrowser');
await page.pause();
await page.click('#filebrowser >> text=example.ipynb', {
button: 'right'
});
await page.hover('ul[role="menu"] >> text=Git');
await page.click('#jp-contextmenu-git >> text=History');

await page.waitForSelector('#jp-git-sessions >> ol >> text=example.ipynb');

const commits = page.locator('li[title="View file changes"]');

expect(await commits.count()).toBeGreaterThanOrEqual(2);

await commits.last().locator('button[title="Select for compare"]').click();
await commits
.first()
.locator('button[title="Compare with selected"]')
.click();

await expect(
page.locator('.nbdime-Widget >> .jp-git-diff-banner')
).toHaveText(
/2c87684a46d49989211d666daf05ab92951ba7c4[\n\s]+b6ece342cf6eefaff3232d43345191abda10727/
);
});
});