Skip to content

Commit

Permalink
clear edge cases, fine tune tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@wxiaoguang
wxiaoguang committed Jun 14, 2022
1 parent de042fc commit 62eb155
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 63 deletions.
8 changes: 5 additions & 3 deletions modules/highlight/highlight.go
View file
Expand Up @@ -40,9 +40,11 @@ var (
// NewContext loads custom highlight map from local config
func NewContext() {
once.Do(func() {
keys := setting.Cfg.Section("highlight.mapping").Keys()
for i := range keys {
highlightMapping[keys[i].Name()] = keys[i].Value()
if setting.Cfg != nil {
keys := setting.Cfg.Section("highlight.mapping").Keys()
for i := range keys {
highlightMapping[keys[i].Name()] = keys[i].Value()
}
}

// The size 512 is simply a conservative rule of thumb
Expand Down
89 changes: 59 additions & 30 deletions services/gitdiff/gitdiff.go
View file
Expand Up @@ -190,7 +190,7 @@ var (
codeTagSuffix = []byte(`</span>`)
)

func diffToHTML(hcd *HighlightCodeDiff, diffs []diffmatchpatch.Diff, lineType DiffLineType) DiffInline {
func diffToHTML(hcd *HighlightCodeDiff, diffs []diffmatchpatch.Diff, lineType DiffLineType) string {
buf := bytes.NewBuffer(nil)
if hcd != nil {
for _, tag := range hcd.lineWrapperTags {
Expand All @@ -216,7 +216,7 @@ func diffToHTML(hcd *HighlightCodeDiff, diffs []diffmatchpatch.Diff, lineType Di
buf.WriteString("</span>")
}
}
return DiffInlineWithUnicodeEscape(template.HTML(buf.String()))
return buf.String()
}

// GetLine gets a specific line by type (add or del) and file line number
Expand Down Expand Up @@ -289,7 +289,7 @@ func DiffInlineWithHighlightCode(fileName, language, code string) DiffInline {
type HighlightCodeDiff struct {
placeholderBegin rune
placeholderMaxCount int
placeholderCounter int
placeholderIndex int
placeholderTagMap map[rune]string
tagPlaceholderMap map[string]rune

Expand All @@ -305,12 +305,49 @@ func NewHighlightCodeDiff() *HighlightCodeDiff {
}
}

// nextPlaceholder returns 0 if no more placeholder can be used
func (hcd *HighlightCodeDiff) nextPlaceholder() rune {
// TODO: handle placeholder rune conflicts ( case 1: counter reaches placeholderMaxCount, case 2: there are placeholder runes in code )
r := hcd.placeholderBegin + rune(hcd.placeholderCounter%hcd.placeholderMaxCount)
hcd.placeholderCounter++
hcd.placeholderCounter %= hcd.placeholderMaxCount
return r
for hcd.placeholderIndex < hcd.placeholderMaxCount {
r := hcd.placeholderBegin + rune(hcd.placeholderIndex)
hcd.placeholderIndex++
// only use non-existing (not used by code) rune as placeholders
if _, ok := hcd.placeholderTagMap[r]; !ok {
return r
}
}
return 0 // no more available placeholder
}

func (hcd *HighlightCodeDiff) isInPlaceholderRange(r rune) bool {
return hcd.placeholderBegin <= r && r < hcd.placeholderBegin+rune(hcd.placeholderMaxCount)
}

func (hcd *HighlightCodeDiff) collectUsedRunes(code string) {
for _, r := range code {
if hcd.isInPlaceholderRange(r) {
// put the existing rune (used by code) in map, then this rune won't be used a placeholder anymore.
hcd.placeholderTagMap[r] = ""
}
}
}

func (hcd *HighlightCodeDiff) diffWithHighlight(filename, language, codeA, codeB string) []diffmatchpatch.Diff {
hcd.collectUsedRunes(codeA)
hcd.collectUsedRunes(codeB)

highlightCodeA := highlight.Code(filename, language, codeA)
highlightCodeB := highlight.Code(filename, language, codeB)

highlightCodeA = hcd.convertToPlaceholders(highlightCodeA)
highlightCodeB = hcd.convertToPlaceholders(highlightCodeB)

diffs := diffMatchPatch.DiffMain(highlightCodeA, highlightCodeB, true)
diffs = diffMatchPatch.DiffCleanupEfficiency(diffs)

for i := range diffs {
hcd.recoverOneDiff(&diffs[i])
}
return diffs
}

func (hcd *HighlightCodeDiff) convertToPlaceholders(highlightCode string) string {
Expand Down Expand Up @@ -362,12 +399,19 @@ func (hcd *HighlightCodeDiff) convertToPlaceholders(highlightCode string) string
placeholder, ok := hcd.tagPlaceholderMap[tagInMap]
if !ok {
placeholder = hcd.nextPlaceholder()
hcd.tagPlaceholderMap[tagInMap] = placeholder
hcd.placeholderTagMap[placeholder] = tagInMap
if placeholder != 0 {
hcd.tagPlaceholderMap[tagInMap] = placeholder
hcd.placeholderTagMap[placeholder] = tagInMap
}
}

res.WriteRune(placeholder) // use the placeholder to replace the tag
if placeholder != 0 {
res.WriteRune(placeholder) // use the placeholder to replace the tag
} else {
res.WriteString(tag) // unfortunately, all private use runes has been exhausted, no more placeholder could be used, so do not covert the tag
}
}

res.WriteString(s)
return res.String()
}
Expand All @@ -378,7 +422,7 @@ func (hcd *HighlightCodeDiff) recoverOneDiff(diff *diffmatchpatch.Diff) {

for _, r := range diff.Text {
tag, ok := hcd.placeholderTagMap[r]
if !ok {
if !ok || tag == "" {
sb.WriteRune(r)
continue
}
Expand Down Expand Up @@ -413,12 +457,6 @@ func (hcd *HighlightCodeDiff) recoverOneDiff(diff *diffmatchpatch.Diff) {
diff.Text = sb.String()
}

func (hcd *HighlightCodeDiff) recoverFromPlaceholders(diffs []diffmatchpatch.Diff) {
for i := range diffs {
hcd.recoverOneDiff(&diffs[i])
}
}

// GetComputedInlineDiffFor computes inline diff for the given line.
func (diffSection *DiffSection) GetComputedInlineDiffFor(diffLine *DiffLine) DiffInline {
if setting.Git.DisableDiffHighlight {
Expand Down Expand Up @@ -461,19 +499,10 @@ func (diffSection *DiffSection) GetComputedInlineDiffFor(diffLine *DiffLine) Dif
return DiffInlineWithHighlightCode(diffSection.FileName, language, diffLine.Content)
}

highlightCodeA := highlight.Code(diffSection.FileName, language, diff1[1:])
highlightCodeB := highlight.Code(diffSection.FileName, language, diff2[1:])

hcd := NewHighlightCodeDiff()
highlightCodeA = hcd.convertToPlaceholders(highlightCodeA)
highlightCodeB = hcd.convertToPlaceholders(highlightCodeB)

diffRecord := diffMatchPatch.DiffMain(highlightCodeA, highlightCodeB, true)
diffRecord = diffMatchPatch.DiffCleanupEfficiency(diffRecord)

hcd.recoverFromPlaceholders(diffRecord)

return diffToHTML(hcd, diffRecord, diffLine.Type)
diffRecord := hcd.diffWithHighlight(diffSection.FileName, language, diff1[1:], diff2[1:])
diffHTML := diffToHTML(hcd, diffRecord, diffLine.Type)
return DiffInlineWithUnicodeEscape(template.HTML(diffHTML))
}

// DiffFile represents a file diff.
Expand Down
66 changes: 36 additions & 30 deletions services/gitdiff/gitdiff_test.go
View file
Expand Up @@ -7,7 +7,6 @@ package gitdiff

import (
"fmt"
"html/template"
"strconv"
"strings"
"testing"
Expand All @@ -17,36 +16,27 @@ import (
"code.gitea.io/gitea/models/unittest"
user_model "code.gitea.io/gitea/models/user"
"code.gitea.io/gitea/modules/git"
"code.gitea.io/gitea/modules/highlight"
"code.gitea.io/gitea/modules/json"
"code.gitea.io/gitea/modules/setting"

dmp "github.com/sergi/go-diff/diffmatchpatch"
"github.com/stretchr/testify/assert"
"gopkg.in/ini.v1"
)

func assertEqual(t *testing.T, expected string, actual template.HTML) {
if expected != string(actual) {
t.Errorf("Did not receive expected results:\nExpected: %s\nActual: %s", expected, actual)
}
}

func TestDiffToHTML(t *testing.T) {
setting.Cfg = ini.Empty()
assertEqual(t, "foo <span class=\"added-code\">bar</span> biz", diffToHTML(nil, []dmp.Diff{
assert.Equal(t, "foo <span class=\"added-code\">bar</span> biz", diffToHTML(nil, []dmp.Diff{
{Type: dmp.DiffEqual, Text: "foo "},
{Type: dmp.DiffInsert, Text: "bar"},
{Type: dmp.DiffDelete, Text: " baz"},
{Type: dmp.DiffEqual, Text: " biz"},
}, DiffLineAdd).Content)
}, DiffLineAdd))

assertEqual(t, "foo <span class=\"removed-code\">bar</span> biz", diffToHTML(nil, []dmp.Diff{
assert.Equal(t, "foo <span class=\"removed-code\">bar</span> biz", diffToHTML(nil, []dmp.Diff{
{Type: dmp.DiffEqual, Text: "foo "},
{Type: dmp.DiffDelete, Text: "bar"},
{Type: dmp.DiffInsert, Text: " baz"},
{Type: dmp.DiffEqual, Text: " biz"},
}, DiffLineDel).Content)
}, DiffLineDel))
}

func TestParsePatch_skipTo(t *testing.T) {
Expand Down Expand Up @@ -654,26 +644,42 @@ func TestGetDiffRangeWithWhitespaceBehavior(t *testing.T) {
}
}

func TestDiffToHTML_14231(t *testing.T) {
setting.Cfg = ini.Empty()

func TestDiffWithHighlight(t *testing.T) {
hcd := NewHighlightCodeDiff()

highlightCodeA := highlight.Code("main.v", "", " run()\n")
highlightCodeB := highlight.Code("main.v", "", " run(db)\n")
highlightCodeA = hcd.convertToPlaceholders(highlightCodeA)
highlightCodeB = hcd.convertToPlaceholders(highlightCodeB)

diffRecord := diffMatchPatch.DiffMain(highlightCodeA, highlightCodeB, true)
diffRecord = diffMatchPatch.DiffCleanupEfficiency(diffRecord)

hcd.recoverFromPlaceholders(diffRecord)

diffs := hcd.diffWithHighlight(
"main.v", "",
" run()\n",
" run(db)\n",
)
expected := `<span class="line"><span class="cl"> <span class="n">run</span><span class="added-code"><span class="o">(</span><span class="n">db</span><span class="o">)</span></span>
</span></span>`
output := diffToHTML(hcd, diffRecord, DiffLineAdd)
output := diffToHTML(hcd, diffs, DiffLineAdd)
assert.Equal(t, expected, output)
}

assertEqual(t, expected, output.Content)
func TestDiffWithHighlightPlaceholder(t *testing.T) {
hcd := NewHighlightCodeDiff()
diffs := hcd.diffWithHighlight(
"main.js", "",
"a='\uE000'",
"a='\uF8FF'",
)
assert.Equal(t, "", hcd.placeholderTagMap[0xE000])
assert.Equal(t, "", hcd.placeholderTagMap[0xF8FF])

expected := fmt.Sprintf(`<span class="line"><span class="cl"><span class="nx">a</span><span class="o">=</span><span class="s1">&#39;</span><span class="added-code">%s</span>&#39;</span></span>`, "\uF8FF")
output := diffToHTML(hcd, diffs, DiffLineAdd)
assert.Equal(t, expected, output)

hcd = NewHighlightCodeDiff()
diffs = hcd.diffWithHighlight(
"main.js", "",
"a='\uE000'",
"a='\uF8FF'",
)
expected = fmt.Sprintf(`<span class="line"><span class="cl"><span class="nx">a</span><span class="o">=</span><span class="s1">&#39;</span><span class="removed-code">%s</span>&#39;</span></span>`, "\uE000")
output = diffToHTML(hcd, diffs, DiffLineDel)
assert.Equal(t, expected, output)
}

func TestNoCrashes(t *testing.T) {
Expand Down

0 comments on commit 62eb155

Please sign in to comment.