When performing `git blame` to identify the commit that a line of code came from, limit the blame to the commit that is currently being viewed in the UI. Before this change, the blame always occurred on the current head of the PR, causing these problems: - When you click ➕ to load the comment form, the form that is dynamically loaded would have it's commit field pulled from the current PR head. That may not actually reflect the code that you were viewing at the time you authored the comment -- it could be a newer commit that occurred by the author while you were reviewing. - When viewing a specific commit within a PR and leaving a comment, the blame would occur from the head -- if the file was changed in a later commit and the line-of-code moved up or down, the comment would be misplaced. ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. All work and communication must conform to Forgejo's [AI Agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md). There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests for Go changes - I added test coverage for Go changes... - [ ] in their respective `*_test.go` for unit tests. - [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I ran... - [ ] `make pr-go` before pushing ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [x] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change. - [ ] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change. <!--start release-notes-assistant--> ## Release notes <!--URL:https://codeberg.org/forgejo/forgejo--> - Bug fixes - [PR](https://codeberg.org/forgejo/forgejo/pulls/12055): <!--number 12055 --><!--line 0 --><!--description d2hlbiByZXZpZXdpbmcgaW4gUFJzLCBtYWtlIGNvbW1lbnRzIHJlbGF0aXZlIHRvIHRoZSB2aXNpYmxlIGNvZGUncyBjb21taXQ=-->when reviewing in PRs, make comments relative to the visible code's commit<!--description--> <!--end release-notes-assistant--> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/12055 Reviewed-by: Andreas Ahlenstorf <aahlenst@noreply.codeberg.org> Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net> Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
267 lines
15 KiB
Go HTML Template
267 lines
15 KiB
Go HTML Template
{{$showFileTree := (and (not .DiffNotAvailable) (gt .Diff.NumFiles 1))}}
|
|
<div>
|
|
<div class="diff-detail-box diff-box">
|
|
<div class="tw-flex tw-items-center tw-flex-wrap tw-gap-2 tw-ml-0.5">
|
|
{{if $showFileTree}}
|
|
<button class="diff-toggle-file-tree-button not-mobile btn interact-fg" data-show-text="{{ctx.Locale.Tr "repo.diff.show_file_tree"}}" data-hide-text="{{ctx.Locale.Tr "repo.diff.hide_file_tree"}}">
|
|
{{/* the icon meaning is reversed here, "octicon-sidebar-collapse" means show the file tree */}}
|
|
{{svg "octicon-sidebar-collapse" 20 "icon tw-hidden"}}
|
|
{{svg "octicon-sidebar-expand" 20 "icon tw-hidden"}}
|
|
</button>
|
|
<script>
|
|
// Default to true if unset
|
|
const diffTreeVisible = localStorage?.getItem('diff_file_tree_visible') !== 'false';
|
|
const diffTreeBtn = document.querySelector('.diff-toggle-file-tree-button');
|
|
const diffTreeIcon = `.octicon-sidebar-${diffTreeVisible ? 'expand' : 'collapse'}`;
|
|
diffTreeBtn.querySelector(diffTreeIcon).classList.remove('tw-hidden');
|
|
diffTreeBtn.setAttribute('data-tooltip-content', diffTreeBtn.getAttribute(diffTreeVisible ? 'data-hide-text' : 'data-show-text'));
|
|
</script>
|
|
{{end}}
|
|
{{if not .DiffNotAvailable}}
|
|
<div class="diff-detail-stats tw-flex tw-items-center tw-flex-wrap">
|
|
{{svg "octicon-diff" 16 "tw-mr-1"}}{{ctx.Locale.Tr "repo.diff.stats_desc" .Diff.NumFiles .Diff.TotalAddition .Diff.TotalDeletion}}
|
|
</div>
|
|
{{end}}
|
|
</div>
|
|
<div class="diff-detail-actions button-row">
|
|
{{if and .PageIsPullFiles $.SignedUserID (not .IsArchived) (not .DiffNotAvailable)}}
|
|
<div class="not-mobile tw-flex tw-items-center tw-flex-col tw-whitespace-nowrap tw-mr-1">
|
|
<label for="viewed-files-summary" id="viewed-files-summary-label" data-text-changed-template="{{ctx.Locale.Tr "repo.pulls.viewed_files_label"}}">
|
|
{{ctx.Locale.Tr "repo.pulls.viewed_files_label" .Diff.NumViewedFiles .Diff.NumFiles}}
|
|
</label>
|
|
<progress id="viewed-files-summary" value="{{.Diff.NumViewedFiles}}" max="{{.Diff.NumFiles}}"></progress>
|
|
</div>
|
|
{{end}}
|
|
{{template "repo/diff/whitespace_dropdown" .}}
|
|
{{template "repo/diff/options_dropdown" .}}
|
|
{{if .PageIsPullFiles}}
|
|
<div id="diff-commit-select" data-issuelink="{{$.Issue.Link}}" data-queryparams="?style={{if $.IsSplitStyle}}split{{else}}unified{{end}}&whitespace={{$.WhitespaceBehavior}}&show-outdated={{$.ShowOutdatedComments}}" data-filter_changes_by_commit="{{ctx.Locale.Tr "repo.pulls.filter_changes_by_commit"}}">
|
|
{{/*
|
|
the following will be replaced by vue component
|
|
but this avoids any loading artifacts till the vue component is initialized
|
|
*/}}
|
|
<div class="ui jump dropdown basic button custom">
|
|
{{svg "octicon-git-commit"}}
|
|
</div>
|
|
</div>
|
|
{{end}}
|
|
{{if and .PageIsPullFiles $.SignedUserID (not .IsArchived)}}
|
|
{{template "repo/diff/new_review" .}}
|
|
{{end}}
|
|
</div>
|
|
</div>
|
|
{{if not .DiffNotAvailable}}
|
|
{{if and .IsShowingOnlySingleCommit .PageIsPullFiles}}
|
|
<div class="ui info message">
|
|
<div>{{ctx.Locale.Tr "repo.pulls.showing_only_single_commit" (ShortSha .CommitID)}} - <a href="{{$.Issue.Link}}/files?style={{if $.IsSplitStyle}}split{{else}}unified{{end}}&whitespace={{$.WhitespaceBehavior}}&show-outdated={{$.ShowOutdatedComments}}">{{ctx.Locale.Tr "repo.pulls.show_all_commits"}}</a></div>
|
|
</div>
|
|
{{else if and (not .IsShowingAllCommits) .PageIsPullFiles}}
|
|
<div class="ui info message">
|
|
<div>{{ctx.Locale.Tr "repo.pulls.showing_specified_commit_range" (ShortSha .BeforeCommitID) (ShortSha .AfterCommitID)}} - <a href="{{$.Issue.Link}}/files?style={{if $.IsSplitStyle}}split{{else}}unified{{end}}&whitespace={{$.WhitespaceBehavior}}&show-outdated={{$.ShowOutdatedComments}}">{{ctx.Locale.Tr "repo.pulls.show_all_commits"}}</a></div>
|
|
</div>
|
|
{{end}}
|
|
<script id="diff-data-script" type="module">
|
|
const diffDataFiles = [{{range $i, $file := .Diff.Files}}{Name:"{{$file.Name}}",NameHash:"{{$file.NameHash}}",Type:{{$file.Type}},IsBin:{{$file.IsBin}},Addition:{{$file.Addition}},Deletion:{{$file.Deletion}},IsViewed:{{$file.IsViewed}}},{{end}}];
|
|
const diffData = {
|
|
isIncomplete: {{.Diff.IsIncomplete}},
|
|
tooManyFilesMessage: "{{ctx.Locale.Tr "repo.diff.too_many_files"}}",
|
|
binaryFileMessage: "{{ctx.Locale.Tr "repo.diff.bin"}}",
|
|
showMoreMessage: "{{ctx.Locale.Tr "repo.diff.show_more"}}",
|
|
statisticsMessage: "{{ctx.Locale.Tr "repo.diff.stats_desc_file"}}",
|
|
linkLoadMore: "?skip-to={{.Diff.End}}&file-only=true",
|
|
};
|
|
|
|
// for first time loading, the diffFileInfo is a plain object
|
|
// after the Vue component is mounted, the diffFileInfo is a reactive object
|
|
// keep in mind that this script block would be executed many times when loading more files, by "loadMoreFiles"
|
|
let diffFileInfo = window.config.pageData.diffFileInfo || {
|
|
files:[],
|
|
fileTreeIsVisible: false,
|
|
fileListIsVisible: false,
|
|
isLoadingNewData: false,
|
|
selectedItem: '',
|
|
};
|
|
diffFileInfo = Object.assign(diffFileInfo, diffData);
|
|
diffFileInfo.files.push(...diffDataFiles);
|
|
window.config.pageData.diffFileInfo = diffFileInfo;
|
|
</script>
|
|
{{end}}
|
|
<div id="diff-container">
|
|
{{if $showFileTree}}
|
|
<div id="diff-file-tree" class="tw-hidden not-mobile"></div>
|
|
<script>
|
|
if (diffTreeVisible) document.getElementById('diff-file-tree').classList.remove('tw-hidden');
|
|
</script>
|
|
{{end}}
|
|
<div id="diff-content-container">
|
|
{{if .IsShowingOnlySingleCommit}}
|
|
<div id="diff-commit-header">
|
|
{{template "repo/commit_header" .}}
|
|
</div>
|
|
{{end}}
|
|
{{if .DiffNotAvailable}}
|
|
<h4>{{ctx.Locale.Tr "repo.diff.data_not_available"}}</h4>
|
|
{{else}}
|
|
<div id="diff-file-boxes" class="sixteen wide column">
|
|
{{range $i, $file := .Diff.Files}}
|
|
{{/*notice: the index of Diff.Files should not be used for element ID, because the index will be restarted from 0 when doing load-more for PRs with a lot of files*/}}
|
|
{{$blobBase := call $.GetBlobByPathForCommit $.BeforeCommit $file.OldName}}
|
|
{{$blobHead := call $.GetBlobByPathForCommit $.HeadCommit $file.Name}}
|
|
{{$sniffedTypeBase := call $.GetSniffedTypeForBlob $blobBase}}
|
|
{{$sniffedTypeHead := call $.GetSniffedTypeForBlob $blobHead}}
|
|
{{$isImage:= or (call $.IsSniffedTypeAnImage $sniffedTypeBase) (call $.IsSniffedTypeAnImage $sniffedTypeHead)}}
|
|
{{$isCsv := (call $.IsCsvFile $file)}}
|
|
{{$showFileViewToggle := or $isImage (and (not $file.IsIncomplete) $isCsv)}}
|
|
{{$isExpandable := or (gt $file.Addition 0) (gt $file.Deletion 0) $file.IsBin}}
|
|
{{$isReviewFile := and $.IsSigned $.PageIsPullFiles (not $.IsArchived) $.IsShowingAllCommits}}
|
|
<div class="diff-file-box diff-box file-content {{TabSizeClass $.Editorconfig $file.Name}} tw-mt-0" id="diff-{{$file.NameHash}}" data-old-filename="{{$file.OldName}}" data-new-filename="{{$file.Name}}" {{if or ($file.ShouldBeHidden) (not $isExpandable)}}data-folded="true"{{end}}>
|
|
<h4 class="diff-file-header sticky-2nd-row ui top attached header tw-font-normal tw-flex tw-items-center tw-justify-between tw-flex-wrap">
|
|
<div class="diff-file-name tw-flex tw-flex-1 tw-items-center tw-gap-1 tw-flex-wrap">
|
|
<button class="fold-file btn interact-bg tw-p-1{{if not $isExpandable}} tw-invisible{{end}}">
|
|
{{if $file.ShouldBeHidden}}
|
|
{{svg "octicon-chevron-right" 18}}
|
|
{{else}}
|
|
{{svg "octicon-chevron-down" 18}}
|
|
{{end}}
|
|
</button>
|
|
<div class="tw-font-semibold tw-flex tw-items-center tw-font-mono">
|
|
{{if $file.IsBin}}
|
|
<span class="tw-ml-0.5 tw-mr-2">
|
|
{{ctx.Locale.Tr "repo.diff.bin"}}
|
|
</span>
|
|
{{else}}
|
|
{{template "repo/diff/stats" dict "file" . "root" $}}
|
|
{{end}}
|
|
</div>
|
|
<span class="file tw-flex tw-items-center tw-font-mono tw-flex-1"><a class="muted file-link" title="{{if $file.IsRenamed}}{{$file.OldName}} → {{end}}{{$file.Name}}" href="#diff-{{$file.NameHash}}">{{if $file.IsRenamed}}{{$file.OldName}} → {{end}}{{$file.Name}}</a>
|
|
{{if .IsLFSFile}} ({{ctx.Locale.Tr "repo.stored_lfs"}}){{end}}
|
|
<button class="btn interact-fg tw-p-2" data-clipboard-text="{{$file.Name}}" data-tooltip-content="{{ctx.Locale.Tr "copy_path"}}">{{svg "octicon-copy" 14}}</button>
|
|
{{if $file.IsGenerated}}
|
|
<span class="ui label">{{ctx.Locale.Tr "repo.diff.generated"}}</span>
|
|
{{end}}
|
|
{{if $file.IsVendored}}
|
|
<span class="ui label">{{ctx.Locale.Tr "repo.diff.vendored"}}</span>
|
|
{{end}}
|
|
{{if and $file.Mode $file.OldMode}}
|
|
{{$old := ctx.Locale.Tr ($file.ModeTranslationKey $file.OldMode)}}
|
|
{{$new := ctx.Locale.Tr ($file.ModeTranslationKey $file.Mode)}}
|
|
<span class="tw-mx-2 tw-font-mono tw-whitespace-nowrap">{{ctx.Locale.Tr "git.filemode.changed_filemode" $old $new}}</span>
|
|
{{else if $file.Mode}}
|
|
<span class="tw-mx-2 tw-font-mono tw-whitespace-nowrap">{{ctx.Locale.Tr ($file.ModeTranslationKey $file.Mode)}}</span>
|
|
{{end}}
|
|
</span>
|
|
</div>
|
|
<div class="diff-file-header-actions tw-flex tw-items-center button-row tw-flex-wrap">
|
|
{{if $showFileViewToggle}}
|
|
<div class="ui compact icon buttons">
|
|
<button class="ui tiny basic button file-view-toggle" data-toggle-selector="#diff-source-{{$file.NameHash}}" data-tooltip-content="{{ctx.Locale.Tr "repo.file_view_source"}}">{{svg "octicon-code"}}</button>
|
|
<button class="ui tiny basic button file-view-toggle active" data-toggle-selector="#diff-rendered-{{$file.NameHash}}" data-tooltip-content="{{ctx.Locale.Tr "repo.file_view_rendered"}}">{{svg "octicon-file"}}</button>
|
|
</div>
|
|
{{end}}
|
|
{{if $file.IsProtected}}
|
|
<span class="ui basic label">{{ctx.Locale.Tr "repo.diff.protected"}}</span>
|
|
{{end}}
|
|
{{if and $isReviewFile $file.HasChangedSinceLastReview}}
|
|
<span class="changed-since-last-review unselectable not-mobile">{{ctx.Locale.Tr "repo.pulls.has_changed_since_last_review"}}</span>
|
|
{{end}}
|
|
{{if not (or $file.IsIncomplete $file.IsBin $file.IsSubmodule)}}
|
|
<button class="ui basic tiny button unescape-button not-mobile">{{ctx.Locale.Tr "repo.unescape_control_characters"}}</button>
|
|
<button class="ui basic tiny button escape-button tw-hidden">{{ctx.Locale.Tr "repo.escape_control_characters"}}</button>
|
|
{{end}}
|
|
{{if and (not $file.IsSubmodule) (not $.PageIsWiki)}}
|
|
{{if $file.IsDeleted}}
|
|
<a class="ui basic tiny button" rel="nofollow" href="{{$.BeforeSourcePath}}/{{PathEscapeSegments .Name}}">{{ctx.Locale.Tr "repo.diff.view_file"}}</a>
|
|
{{else}}
|
|
<a class="ui basic tiny button" rel="nofollow" href="{{$.SourcePath}}/{{PathEscapeSegments .Name}}">{{ctx.Locale.Tr "repo.diff.view_file"}}</a>
|
|
{{if and $.HeadBranchIsEditable (not $file.IsLFSFile)}}
|
|
<a class="ui basic tiny button" rel="nofollow" href="{{$.SourceRepoLink}}/_edit/{{PathEscapeSegments $.HeadBranch}}/{{PathEscapeSegments .Name}}">{{ctx.Locale.Tr "repo.editor.edit_this_file"}}</a>
|
|
{{end}}
|
|
{{end}}
|
|
{{end}}
|
|
{{if $isReviewFile}}
|
|
<label data-link="{{$.Issue.Link}}/viewed-files" data-headcommit="{{$.AfterCommitID}}" class="viewed-file-form unselectable{{if $file.IsViewed}} viewed-file-checked-form{{end}}">
|
|
<input type="checkbox" name="{{$file.GetDiffFileName}}" autocomplete="off"{{if $file.IsViewed}} checked{{end}}> {{ctx.Locale.Tr "repo.pulls.has_viewed_file"}}
|
|
</label>
|
|
{{end}}
|
|
</div>
|
|
</h4>
|
|
<div class="diff-file-body ui attached unstackable table segment" {{if and $file.IsViewed $.IsShowingAllCommits}}data-folded="true"{{end}}>
|
|
<div id="diff-source-{{$file.NameHash}}" class="file-body file-code unicode-escaped code-diff{{if $.IsSplitStyle}} code-diff-split{{else}} code-diff-unified{{end}}{{if $showFileViewToggle}} tw-hidden{{end}}">
|
|
{{if or $file.IsIncomplete $file.IsBin}}
|
|
<div class="diff-file-body binary">
|
|
{{if $file.IsIncomplete}}
|
|
{{if $file.IsIncompleteLineTooLong}}
|
|
{{ctx.Locale.Tr "repo.diff.file_suppressed_line_too_long"}}
|
|
{{else}}
|
|
{{ctx.Locale.Tr "repo.diff.file_suppressed"}}
|
|
<a class="ui basic tiny button diff-load-button" data-href="?file-only=true&files={{$file.Name}}&files={{$file.OldName}}">{{ctx.Locale.Tr "repo.diff.load"}}</a>
|
|
{{end}}
|
|
{{else}}
|
|
{{ctx.Locale.Tr "repo.diff.bin_not_shown"}}
|
|
{{end}}
|
|
</div>
|
|
{{else}}
|
|
<table class="chroma" data-new-comment-url="{{$.Issue.Link}}/files/reviews/new_comment?after_commit_id={{$.AfterCommitID}}" data-path="{{$file.Name}}">
|
|
{{if $.IsSplitStyle}}
|
|
{{template "repo/diff/section_split" dict "file" . "root" $}}
|
|
{{else}}
|
|
{{template "repo/diff/section_unified" dict "file" . "root" $}}
|
|
{{end}}
|
|
</table>
|
|
{{end}}
|
|
</div>
|
|
{{if $showFileViewToggle}}
|
|
{{/* for image or CSV, it can have a horizontal scroll bar, there won't be review comment context menu (position absolute) which would be clipped by "overflow" */}}
|
|
<div id="diff-rendered-{{$file.NameHash}}" class="file-body file-code {{if $.IsSplitStyle}}code-diff-split{{else}}code-diff-unified{{end}} tw-overflow-x-scroll">
|
|
<table class="chroma tw-w-full">
|
|
{{if $isImage}}
|
|
{{template "repo/diff/image_diff" dict "file" . "root" $ "blobBase" $blobBase "blobHead" $blobHead "sniffedTypeBase" $sniffedTypeBase "sniffedTypeHead" $sniffedTypeHead}}
|
|
{{else}}
|
|
{{template "repo/diff/csv_diff" dict "file" . "root" $ "blobBase" $blobBase "blobHead" $blobHead "sniffedTypeBase" $sniffedTypeBase "sniffedTypeHead" $sniffedTypeHead}}
|
|
{{end}}
|
|
</table>
|
|
</div>
|
|
{{end}}
|
|
</div>
|
|
</div>
|
|
{{end}}
|
|
|
|
{{if .Diff.IsIncomplete}}
|
|
<div class="diff-file-box diff-box file-content tw-mt-2" id="diff-incomplete">
|
|
<h4 class="ui top attached header tw-font-normal tw-flex tw-items-center tw-justify-between">
|
|
{{ctx.Locale.Tr "repo.diff.too_many_files"}}
|
|
<a class="ui basic tiny button" id="diff-show-more-files" data-href="?skip-to={{.Diff.End}}&file-only=true">{{ctx.Locale.Tr "repo.diff.show_more"}}</a>
|
|
</h4>
|
|
</div>
|
|
{{end}}
|
|
</div>
|
|
{{end}}
|
|
</div>
|
|
</div>
|
|
|
|
{{if and (not $.Repository.IsArchived) (not .DiffNotAvailable)}}
|
|
<template id="issue-comment-editor-template">
|
|
<div class="ui comment form">
|
|
{{template "shared/combomarkdowneditor" (dict
|
|
"MarkdownPreviewUrl" (print $.Repository.Link "/markup")
|
|
"MarkdownPreviewContext" $.RepoLink
|
|
"TextareaName" "content"
|
|
"DropzoneParentContainer" ".ui.form"
|
|
)}}
|
|
{{if .IsAttachmentEnabled}}
|
|
<div class="field">
|
|
{{template "repo/upload" .}}
|
|
</div>
|
|
{{end}}
|
|
<div class="text right edit buttons">
|
|
<button class="ui cancel button" data-button-name="cancel-edit">{{ctx.Locale.Tr "repo.issues.cancel"}}</button>
|
|
<button class="ui primary save button" data-button-name="save-edit">{{ctx.Locale.Tr "repo.issues.save"}}</button>
|
|
</div>
|
|
</div>
|
|
</template>
|
|
{{end}}
|
|
{{if (not .DiffNotAvailable)}}
|
|
{{template "repo/issue/view_content/reference_issue_dialog" .}}
|
|
{{end}}
|
|
</div>
|