Fix profile render when the README.md size is larger than 1024 bytes (#25270)

Backport #25131
This commit is contained in:
yp05327 2023-06-15 10:39:34 +09:00 committed by GitHub
parent 037366f93f
commit d686aa0d31
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 114 additions and 10 deletions

View File

@ -20,17 +20,18 @@ func (b *Blob) Name() string {
return b.name return b.name
} }
// GetBlobContent Gets the content of the blob as raw text // GetBlobContent Gets the limited content of the blob as raw text
func (b *Blob) GetBlobContent() (string, error) { func (b *Blob) GetBlobContent(limit int64) (string, error) {
if limit <= 0 {
return "", nil
}
dataRc, err := b.DataAsync() dataRc, err := b.DataAsync()
if err != nil { if err != nil {
return "", err return "", err
} }
defer dataRc.Close() defer dataRc.Close()
buf := make([]byte, 1024) buf, err := util.ReadWithLimit(dataRc, int(limit))
n, _ := util.ReadAtMost(dataRc, buf) return string(buf), err
buf = buf[:n]
return string(buf), nil
} }
// GetBlobLineCount gets line count of the blob // GetBlobLineCount gets line count of the blob

View File

@ -4,13 +4,14 @@
package util package util
import ( import (
"bytes"
"errors" "errors"
"io" "io"
) )
// ReadAtMost reads at most len(buf) bytes from r into buf. // ReadAtMost reads at most len(buf) bytes from r into buf.
// It returns the number of bytes copied. n is only less than len(buf) if r provides fewer bytes. // It returns the number of bytes copied. n is only less than len(buf) if r provides fewer bytes.
// If EOF occurs while reading, err will be nil. // If EOF or ErrUnexpectedEOF occurs while reading, err will be nil.
func ReadAtMost(r io.Reader, buf []byte) (n int, err error) { func ReadAtMost(r io.Reader, buf []byte) (n int, err error) {
n, err = io.ReadFull(r, buf) n, err = io.ReadFull(r, buf)
if err == io.EOF || err == io.ErrUnexpectedEOF { if err == io.EOF || err == io.ErrUnexpectedEOF {
@ -19,6 +20,42 @@ func ReadAtMost(r io.Reader, buf []byte) (n int, err error) {
return n, err return n, err
} }
// ReadWithLimit reads at most "limit" bytes from r into buf.
// If EOF or ErrUnexpectedEOF occurs while reading, err will be nil.
func ReadWithLimit(r io.Reader, n int) (buf []byte, err error) {
return readWithLimit(r, 1024, n)
}
func readWithLimit(r io.Reader, batch, limit int) ([]byte, error) {
if limit <= batch {
buf := make([]byte, limit)
n, err := ReadAtMost(r, buf)
if err != nil {
return nil, err
}
return buf[:n], nil
}
res := bytes.NewBuffer(make([]byte, 0, batch))
bufFix := make([]byte, batch)
eof := false
for res.Len() < limit && !eof {
bufTmp := bufFix
if res.Len()+batch > limit {
bufTmp = bufFix[:limit-res.Len()]
}
n, err := io.ReadFull(r, bufTmp)
if err == io.EOF || err == io.ErrUnexpectedEOF {
eof = true
} else if err != nil {
return nil, err
}
if _, err = res.Write(bufTmp[:n]); err != nil {
return nil, err
}
}
return res.Bytes(), nil
}
// ErrNotEmpty is an error reported when there is a non-empty reader // ErrNotEmpty is an error reported when there is a non-empty reader
var ErrNotEmpty = errors.New("not-empty") var ErrNotEmpty = errors.New("not-empty")

66
modules/util/io_test.go Normal file
View File

@ -0,0 +1,66 @@
// Copyright 2023 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package util
import (
"bytes"
"errors"
"testing"
"github.com/stretchr/testify/assert"
)
type readerWithError struct {
buf *bytes.Buffer
}
func (r *readerWithError) Read(p []byte) (n int, err error) {
if r.buf.Len() < 2 {
return 0, errors.New("test error")
}
return r.buf.Read(p)
}
func TestReadWithLimit(t *testing.T) {
bs := []byte("0123456789abcdef")
// normal test
buf, err := readWithLimit(bytes.NewBuffer(bs), 5, 2)
assert.NoError(t, err)
assert.Equal(t, []byte("01"), buf)
buf, err = readWithLimit(bytes.NewBuffer(bs), 5, 5)
assert.NoError(t, err)
assert.Equal(t, []byte("01234"), buf)
buf, err = readWithLimit(bytes.NewBuffer(bs), 5, 6)
assert.NoError(t, err)
assert.Equal(t, []byte("012345"), buf)
buf, err = readWithLimit(bytes.NewBuffer(bs), 5, len(bs))
assert.NoError(t, err)
assert.Equal(t, []byte("0123456789abcdef"), buf)
buf, err = readWithLimit(bytes.NewBuffer(bs), 5, 100)
assert.NoError(t, err)
assert.Equal(t, []byte("0123456789abcdef"), buf)
// test with error
buf, err = readWithLimit(&readerWithError{bytes.NewBuffer(bs)}, 5, 10)
assert.NoError(t, err)
assert.Equal(t, []byte("0123456789"), buf)
buf, err = readWithLimit(&readerWithError{bytes.NewBuffer(bs)}, 5, 100)
assert.ErrorContains(t, err, "test error")
assert.Empty(t, buf)
// test public function
buf, err = ReadWithLimit(bytes.NewBuffer(bs), 2)
assert.NoError(t, err)
assert.Equal(t, []byte("01"), buf)
buf, err = ReadWithLimit(bytes.NewBuffer(bs), 9999999)
assert.NoError(t, err)
assert.Equal(t, []byte("0123456789abcdef"), buf)
}

View File

@ -107,7 +107,7 @@ func Profile(ctx *context.Context) {
} }
blob, err := commit.GetBlobByPath("README.md") blob, err := commit.GetBlobByPath("README.md")
if err == nil { if err == nil {
bytes, err := blob.GetBlobContent() bytes, err := blob.GetBlobContent(setting.UI.MaxDisplayFileSize)
if err != nil { if err != nil {
ctx.ServerError("GetBlobContent", err) ctx.ServerError("GetBlobContent", err)
return return

View File

@ -203,7 +203,7 @@ func GetContents(ctx context.Context, repo *repo_model.Repository, treePath, ref
} else if entry.IsLink() { } else if entry.IsLink() {
contentsResponse.Type = string(ContentTypeLink) contentsResponse.Type = string(ContentTypeLink)
// The target of a symlink file is the content of the file // The target of a symlink file is the content of the file
targetFromContent, err := entry.Blob().GetBlobContent() targetFromContent, err := entry.Blob().GetBlobContent(1024)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@ -88,7 +88,7 @@ func testPackageCargo(t *testing.T, _ *neturl.URL) {
blob, err := commit.GetBlobByPath(path) blob, err := commit.GetBlobByPath(path)
assert.NoError(t, err) assert.NoError(t, err)
content, err := blob.GetBlobContent() content, err := blob.GetBlobContent(1024)
assert.NoError(t, err) assert.NoError(t, err)
return content return content