feat: Integrate Comprehensive E2E Testing for GoChat (#1906)

* feat: create e2e test readme

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

* feat: fix markdown file

* feat: add openim make lint

* feat: add git chglog pull request

* feat: add git chglog pull request

* fix: fix openim api err code

* fix: fix openim api err code

* fix: fix openim api err code

* feat: Improve CICD

* feat: Combining GitHub and Google Workspace for Effective Project Management'

* feat: fix openim tools error code

* feat: fix openim tools error code

* feat: add openim error handle

* feat: add openim error handle

* feat: optimize tim white prom code return err

* feat: fix openim tools error code

* style: format openim server code style

* feat: add openim optimize commit code

* feat: add openim optimize commit code

* feat: add openim auto format code

* feat: add openim auto format code

* feat: add openim auto format code

* feat: add openim auto format code

* feat: add openim auto format code

* feat: format openim code

* feat: Some of the notes were translated

* feat: Some of the notes were translated

* feat: update openim server code

* feat: optimize openim reset code

* feat: optimize openim reset code

---------

Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>

pkg/common/db/s3/aws/aws.go

@@ -58,10 +58,10 @@ func NewAWS() (s3.Interface, error) {
 	credential := credentials.NewStaticCredentials(
 		conf.AccessKeyID,     // accessKey
 		conf.AccessKeySecret, // secretKey
-		"")                   // sts的临时凭证
+		"")                   // stoken
 
 	sess, err := session.NewSession(&aws.Config{
-		Region:      aws.String(conf.Region), // 桶所在的区域
+		Region:      aws.String(conf.Region), // The area where the bucket is located
 		Credentials: credential,
 	})
 

pkg/common/db/s3/cont/consts.go

@@ -15,10 +15,24 @@
 package cont
 
 const (
-	hashPath            = "openim/data/hash/"
-	tempPath            = "openim/temp/"
-	DirectPath          = "openim/direct"
-	UploadTypeMultipart = 1 // 分片上传
-	UploadTypePresigned = 2 // 预签名上传
-	partSeparator       = ","
+	// hashPath defines the storage path for hash data within the 'openim' directory.
+	hashPath = "openim/data/hash/"
+
+	// tempPath specifies the directory for temporary files in the 'openim' structure.
+	tempPath = "openim/temp/"
+
+	// DirectPath indicates the directory for direct uploads or access within the 'openim' structure.
+	DirectPath = "openim/direct"
+
+	// UploadTypeMultipart represents the identifier for multipart uploads,
+	// allowing large files to be uploaded in chunks.
+	UploadTypeMultipart = 1
+
+	// UploadTypePresigned signifies the use of presigned URLs for uploads,
+	// facilitating secure, authorized file transfers without requiring direct access to the storage credentials.
+	UploadTypePresigned = 2
+
+	// partSeparator is used as a delimiter in multipart upload processes,
+	// separating individual file parts.
+	partSeparator = ","
 )

pkg/common/db/s3/cont/controller.go

@@ -114,7 +114,7 @@ func (c *Controller) InitiateUpload(ctx context.Context, hash string, size int64
 		return nil, err
 	}
 	if size <= partSize {
-		// 预签名上传
+		// Pre-signed upload
 		key := path.Join(tempPath, c.NowPath(), fmt.Sprintf("%s_%d_%s.presigned", hash, size, c.UUID()))
 		rawURL, err := c.impl.PresignedPutObject(ctx, key, expire)
 		if err != nil {
@@ -139,7 +139,7 @@ func (c *Controller) InitiateUpload(ctx context.Context, hash string, size int64
 			},
 		}, nil
 	} else {
-		// 分片上传
+		// Fragment upload
 		upload, err := c.impl.InitiateMultipartUpload(ctx, c.HashPath(hash))
 		if err != nil {
 			return nil, err
@@ -206,7 +206,7 @@ func (c *Controller) CompleteUpload(ctx context.Context, uploadID string, partHa
 				ETag:       part,
 			}
 		}
-		// todo: 验证大小
+		// todo: Validation size
 		result, err := c.impl.CompleteMultipartUpload(ctx, upload.ID, upload.Key, parts)
 		if err != nil {
 			return nil, err
@@ -225,7 +225,7 @@ func (c *Controller) CompleteUpload(ctx context.Context, uploadID string, partHa
 		if md5val := hex.EncodeToString(md5Sum[:]); md5val != upload.Hash {
 			return nil, errs.ErrArgs.Wrap(fmt.Sprintf("md5 mismatching %s != %s", md5val, upload.Hash))
 		}
-		// 防止在这个时候，并发操作，导致文件被覆盖
+		// Prevents concurrent operations at this time that cause files to be overwritten
 		copyInfo, err := c.impl.CopyObject(ctx, uploadInfo.Key, upload.Key+"."+c.UUID())
 		if err != nil {
 			return nil, err

pkg/common/db/s3/cont/structs.go

@@ -17,9 +17,14 @@ package cont
 import "github.com/openimsdk/open-im-server/v3/pkg/common/db/s3"
 
 type InitiateUploadResult struct {
-	UploadID string             `json:"uploadID"` // 上传ID
-	PartSize int64              `json:"partSize"` // 分片大小
-	Sign     *s3.AuthSignResult `json:"sign"`     // 分片信息
+	// UploadID uniquely identifies the upload session for tracking and management purposes.
+	UploadID string `json:"uploadID"`
+
+	// PartSize specifies the size of each part in a multipart upload. This is relevant for breaking down large uploads into manageable pieces.
+	PartSize int64 `json:"partSize"`
+
+	// Sign contains the authentication and signature information necessary for securely uploading each part. This could include signed URLs or tokens.
+	Sign *s3.AuthSignResult `json:"sign"`
 }
 
 type UploadResult struct {

pkg/common/db/s3/minio/image.go

@@ -42,79 +42,51 @@ func ImageWidthHeight(img image.Image) (int, int) {
 	return bounds.X, bounds.Y
 }
 
+// resizeImage resizes an image to a specified maximum width and height, maintaining the aspect ratio.
+// If both maxWidth and maxHeight are set to 0, the original image is returned.
+// If both are non-zero, the image is scaled to fit within the constraints while maintaining aspect ratio.
+// If only one of maxWidth or maxHeight is non-zero, the image is scaled accordingly.
 func resizeImage(img image.Image, maxWidth, maxHeight int) image.Image {
 	bounds := img.Bounds()
-	imgWidth := bounds.Max.X
-	imgHeight := bounds.Max.Y
+	imgWidth, imgHeight := bounds.Dx(), bounds.Dy()
 
-	// 计算缩放比例
-	scaleWidth := float64(maxWidth) / float64(imgWidth)
-	scaleHeight := float64(maxHeight) / float64(imgHeight)
-
-	// 如果都为0，则不缩放，返回原始图片
+	// Return original image if no resizing is needed.
 	if maxWidth == 0 && maxHeight == 0 {
 		return img
 	}
 
-	// 如果宽度和高度都大于0，则选择较小的缩放比例，以保持宽高比
+	var scale float64 = 1
 	if maxWidth > 0 && maxHeight > 0 {
-		scale := scaleWidth
-		if scaleHeight < scaleWidth {
-			scale = scaleHeight
-		}
-
-		// 计算缩略图尺寸
-		thumbnailWidth := int(float64(imgWidth) * scale)
-		thumbnailHeight := int(float64(imgHeight) * scale)
-
-		// 使用"image"库的Resample方法生成缩略图
-		thumbnail := image.NewRGBA(image.Rect(0, 0, thumbnailWidth, thumbnailHeight))
-		for y := 0; y < thumbnailHeight; y++ {
-			for x := 0; x < thumbnailWidth; x++ {
-				srcX := int(float64(x) / scale)
-				srcY := int(float64(y) / scale)
-				thumbnail.Set(x, y, img.At(srcX, srcY))
-			}
-		}
-
-		return thumbnail
+		scaleWidth := float64(maxWidth) / float64(imgWidth)
+		scaleHeight := float64(maxHeight) / float64(imgHeight)
+		// Choose the smaller scale to fit both constraints.
+		scale = min(scaleWidth, scaleHeight)
+	} else if maxWidth > 0 {
+		scale = float64(maxWidth) / float64(imgWidth)
+	} else if maxHeight > 0 {
+		scale = float64(maxHeight) / float64(imgHeight)
 	}
 
-	// 如果只指定了宽度或高度，则根据最大不超过的规则生成缩略图
-	if maxWidth > 0 {
-		thumbnailWidth := maxWidth
-		thumbnailHeight := int(float64(imgHeight) * scaleWidth)
+	newWidth := int(float64(imgWidth) * scale)
+	newHeight := int(float64(imgHeight) * scale)
 
-		// 使用"image"库的Resample方法生成缩略图
-		thumbnail := image.NewRGBA(image.Rect(0, 0, thumbnailWidth, thumbnailHeight))
-		for y := 0; y < thumbnailHeight; y++ {
-			for x := 0; x < thumbnailWidth; x++ {
-				srcX := int(float64(x) / scaleWidth)
-				srcY := int(float64(y) / scaleWidth)
-				thumbnail.Set(x, y, img.At(srcX, srcY))
-			}
+	// Resize the image by creating a new image and manually copying pixels.
+	thumbnail := image.NewRGBA(image.Rect(0, 0, newWidth, newHeight))
+	for y := 0; y < newHeight; y++ {
+		for x := 0; x < newWidth; x++ {
+			srcX := int(float64(x) / scale)
+			srcY := int(float64(y) / scale)
+			thumbnail.Set(x, y, img.At(srcX, srcY))
 		}
-
-		return thumbnail
 	}
 
-	if maxHeight > 0 {
-		thumbnailWidth := int(float64(imgWidth) * scaleHeight)
-		thumbnailHeight := maxHeight
-
-		// 使用"image"库的Resample方法生成缩略图
-		thumbnail := image.NewRGBA(image.Rect(0, 0, thumbnailWidth, thumbnailHeight))
-		for y := 0; y < thumbnailHeight; y++ {
-			for x := 0; x < thumbnailWidth; x++ {
-				srcX := int(float64(x) / scaleHeight)
-				srcY := int(float64(y) / scaleHeight)
-				thumbnail.Set(x, y, img.At(srcX, srcY))
-			}
-		}
-
-		return thumbnail
-	}
-
-	// 默认情况下，返回原始图片
-	return img
+	return thumbnail
+}
+
+// min returns the smaller of x or y.
+func min(x, y float64) float64 {
+	if x < y {
+		return x
+	}
+	return y
 }

pkg/common/db/s3/oss/oss.go

@@ -30,6 +30,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/OpenIMSDK/tools/errs"
 	"github.com/aliyun/aliyun-oss-go-sdk/oss"
 
 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
@@ -60,7 +61,7 @@ const successCode = http.StatusOK
 func NewOSS() (s3.Interface, error) {
 	conf := config.Config.Object.Oss
 	if conf.BucketURL == "" {
-		return nil, errors.New("bucket url is empty")
+		return nil, errs.Wrap(errors.New("bucket url is empty"))
 	}
 	client, err := oss.New(conf.Endpoint, conf.AccessKeyID, conf.AccessKeySecret)
 	if err != nil {
@@ -68,7 +69,7 @@ func NewOSS() (s3.Interface, error) {
 	}
 	bucket, err := client.Bucket(conf.Bucket)
 	if err != nil {
-		return nil, err
+		return nil, errs.Wrap(err, "ali-oss bucket error")
 	}
 	if conf.BucketURL[len(conf.BucketURL)-1] != '/' {
 		conf.BucketURL += "/"
@@ -138,10 +139,10 @@ func (o *OSS) CompleteMultipartUpload(ctx context.Context, uploadID string, name
 
 func (o *OSS) PartSize(ctx context.Context, size int64) (int64, error) {
 	if size <= 0 {
-		return 0, errors.New("size must be greater than 0")
+		return 0, errs.Wrap(errors.New("size must be greater than 0"))
 	}
 	if size > maxPartSize*maxNumSize {
-		return 0, fmt.Errorf("OSS size must be less than the maximum allowed limit")
+		return 0, errs.Wrap(errors.New("size must be less than the maximum allowed limit"))
 	}
 	if size <= minPartSize*maxNumSize {
 		return minPartSize, nil
@@ -196,25 +197,25 @@ func (o *OSS) StatObject(ctx context.Context, name string) (*s3.ObjectInfo, erro
 	}
 	res := &s3.ObjectInfo{Key: name}
 	if res.ETag = strings.ToLower(strings.ReplaceAll(header.Get("ETag"), `"`, ``)); res.ETag == "" {
-		return nil, errors.New("StatObject etag not found")
+		return nil, errs.Wrap(errors.New("StatObject etag not found"))
 	}
 	if contentLengthStr := header.Get("Content-Length"); contentLengthStr == "" {
 		return nil, errors.New("StatObject content-length not found")
 	} else {
 		res.Size, err = strconv.ParseInt(contentLengthStr, 10, 64)
 		if err != nil {
-			return nil, fmt.Errorf("StatObject content-length parse error: %w", err)
+			return nil, errs.Wrap(err, "StatObject content-length parse error")
 		}
 		if res.Size < 0 {
-			return nil, errors.New("StatObject content-length must be greater than 0")
+			return nil, errs.Wrap(errors.New("StatObject content-length must be greater than 0"))
 		}
 	}
 	if lastModified := header.Get("Last-Modified"); lastModified == "" {
-		return nil, errors.New("StatObject last-modified not found")
+		return nil, errs.Wrap(errors.New("StatObject last-modified not found"))
 	} else {
 		res.LastModified, err = time.Parse(http.TimeFormat, lastModified)
 		if err != nil {
-			return nil, fmt.Errorf("StatObject last-modified parse error: %w", err)
+			return nil, errs.Wrap(err, "StatObject last-modified parse error")
 		}
 	}
 	return res, nil
@@ -227,7 +228,7 @@ func (o *OSS) DeleteObject(ctx context.Context, name string) error {
 func (o *OSS) CopyObject(ctx context.Context, src string, dst string) (*s3.CopyObjectInfo, error) {
 	result, err := o.bucket.CopyObject(src, dst)
 	if err != nil {
-		return nil, err
+		return nil, errs.Wrap(err, "CopyObject error")
 	}
 	return &s3.CopyObjectInfo{
 		Key:  dst,
@@ -261,7 +262,7 @@ func (o *OSS) ListUploadedParts(ctx context.Context, uploadID string, name strin
 		Bucket:   o.bucket.BucketName,
 	}, oss.MaxUploads(100), oss.MaxParts(maxParts), oss.PartNumberMarker(partNumberMarker))
 	if err != nil {
-		return nil, err
+		return nil, errs.Wrap(err, "ListUploadedParts error")
 	}
 	res := &s3.ListUploadedPartsResult{
 		Key:           result.Key,
@@ -286,7 +287,7 @@ func (o *OSS) AccessURL(ctx context.Context, name string, expire time.Duration,
 	var opts []oss.Option
 	if opt != nil {
 		if opt.Image != nil {
-			// 文档地址: https://help.aliyun.com/zh/oss/user-guide/resize-images-4?spm=a2c4g.11186623.0.0.4b3b1e4fWW6yji
+			// Docs Address: https://help.aliyun.com/zh/oss/user-guide/resize-images-4?spm=a2c4g.11186623.0.0.4b3b1e4fWW6yji
 			var format string
 			switch opt.Image.Format {
 			case
@@ -329,7 +330,7 @@ func (o *OSS) AccessURL(ctx context.Context, name string, expire time.Duration,
 	}
 	rawParams, err := oss.GetRawParams(opts)
 	if err != nil {
-		return "", err
+		return "", errs.Wrap(err, "AccessURL error")
 	}
 	params := getURLParams(*o.bucket.Client.Conn, rawParams)
 	return getURL(o.um, o.bucket.BucketName, name, params).String(), nil
@@ -351,12 +352,12 @@ func (o *OSS) FormData(ctx context.Context, name string, size int64, contentType
 	}
 	policyJson, err := json.Marshal(policy)
 	if err != nil {
-		return nil, err
+		return nil, errs.Wrap(err, "Marshal json error")
 	}
 	policyStr := base64.StdEncoding.EncodeToString(policyJson)
 	h := hmac.New(sha1.New, []byte(o.credentials.GetAccessKeySecret()))
 	if _, err := io.WriteString(h, policyStr); err != nil {
-		return nil, err
+		return nil, errs.Wrap(err, "WriteString error")
 	}
 	fd := &s3.FormData{
 		URL:     o.bucketURL,