add PutObjectResponse (#365)

* add PutObjectResponse

* fix PutObject to use emptyStringSha256

* fix example

* update requestOption

---------

Co-authored-by: zhengqianyi <zhengqianyi.zqy@alibaba-inc.com>

Author: zqyi

client_interface.go

@@ -345,7 +345,7 @@ type ClientInterface interface {
 
 	// #################### Object Operations #####################
 	// PutObject put an object to the specified logstore
-	PutObject(project, logstore, objectName string, content []byte, headers map[string]string) error
+	PutObject(project, logstore, objectName string, content []byte, headers map[string]string) (*PutObjectResponse, error)
 	// GetObject get an object from the specified logstore
 	GetObject(project, logstore, objectName string) (*GetObjectResponse, error)
 

client_object.go

@@ -1,5 +1,20 @@
 package sls
 
+import "net/http"
+
+// PutObjectResponse defines response from PutObject call
+type PutObjectResponse struct {
+	Headers map[string]string
+}
+
+func (resp *PutObjectResponse) GetETag() string {
+	if resp.Headers == nil {
+		return ""
+	}
+	return resp.Headers[http.CanonicalHeaderKey("Etag")]
+}
+
+// GetObjectResponse defines response from GetObject call
 type GetObjectResponse struct {
 	Body    []byte
 	Headers map[string]string
@@ -9,17 +24,17 @@ func (resp *GetObjectResponse) GetETag() string {
 	if resp.Headers == nil {
 		return ""
 	}
-	return resp.Headers["Etag"]
+	return resp.Headers[http.CanonicalHeaderKey("Etag")]
 }
 
 func (resp *GetObjectResponse) GetContentType() string {
 	if resp.Headers == nil {
 		return ""
 	}
-	return resp.Headers["Content-Type"]
+	return resp.Headers[http.CanonicalHeaderKey("Content-Type")]
 }
 
-func (c *Client) PutObject(project, logstore, objectName string, content []byte, headers map[string]string) error {
+func (c *Client) PutObject(project, logstore, objectName string, content []byte, headers map[string]string) (*PutObjectResponse, error) {
 	ls := convertLogstore(c, project, logstore)
 	return ls.PutObject(objectName, content, headers)
 }

example/multimodal/multimodal_example.go

@@ -20,7 +20,7 @@ func main() {
 	client.SetAuthVersion(sls.AuthV4)
 	client.SetRegion("cn-hangzhou")
 
-	fmt.Println("=== Multimodal Configuration Example ===\n")
+	fmt.Println("=== Multimodal Configuration Example ===")
 
 	// Example 1: Get current multimodal configuration
 	fmt.Println("=== Example 1: Get multimodal configuration ===")

example/object/object_example.go

@@ -27,12 +27,14 @@ func main() {
 	objectName := "test_object_1"
 	content := []byte("Hello, this is test content")
 
-	err := client.PutObject(project, logstore, objectName, content, nil)
+	putResp, err := client.PutObject(project, logstore, objectName, content, nil)
 	if err != nil {
 		fmt.Printf("Put object failed: %v\n", err)
 		return
 	}
 	fmt.Println("Put object success!")
+	fmt.Printf("  Response ETag: %s\n", putResp.GetETag())
+	fmt.Printf("  All Response Headers: %v\n", putResp.Headers)
 
 	// Get the object back
 	resp, err := client.GetObject(project, logstore, objectName)
@@ -54,12 +56,14 @@ func main() {
 		"x-log-meta-version": "1.0",
 	}
 
-	err = client.PutObject(project, logstore, objectName2, content2, headers)
+	putResp2, err := client.PutObject(project, logstore, objectName2, content2, headers)
 	if err != nil {
 		fmt.Printf("Put object with headers failed: %v\n", err)
 		return
 	}
 	fmt.Println("Put object with headers success!")
+	fmt.Printf("  Response ETag: %s\n", putResp2.GetETag())
+	fmt.Printf("  All Response Headers: %v\n", putResp2.Headers)
 
 	// Get the object back
 	resp2, err := client.GetObject(project, logstore, objectName2)
@@ -70,8 +74,8 @@ func main() {
 	fmt.Printf("Get object success! Body: %s\n", string(resp2.Body))
 	fmt.Printf("ETag: %s\n", resp2.GetETag())
 	fmt.Printf("Content-Type: %s\n", resp2.GetContentType())
-	fmt.Printf("x-log-meta-author: %s\n", resp2.Headers["x-log-meta-author"])
-	fmt.Printf("x-log-meta-version: %s\n", resp2.Headers["x-log-meta-version"])
+	fmt.Printf("x-log-meta-author: %s\n", resp2.Headers["X-Log-Meta-Author"])
+	fmt.Printf("x-log-meta-version: %s\n", resp2.Headers["X-Log-Meta-Version"])
 
 	// Example 3: Put an object with Content-MD5
 	fmt.Println("\n=== Example 3: Put an object with Content-MD5 ===")
@@ -87,12 +91,14 @@ func main() {
 		"Content-Type": "application/octet-stream",
 	}
 
-	err = client.PutObject(project, logstore, objectName3, content3, headers3)
+	putResp3, err := client.PutObject(project, logstore, objectName3, content3, headers3)
 	if err != nil {
 		fmt.Printf("Put object with MD5 failed: %v\n", err)
 		return
 	}
 	fmt.Println("Put object with MD5 success!")
+	fmt.Printf("  Response ETag: %s\n", putResp3.GetETag())
+	fmt.Printf("  All Response Headers: %v\n", putResp3.Headers)
 
 	// Get the object back
 	resp3, err := client.GetObject(project, logstore, objectName3)

log_project.go

@@ -129,7 +129,7 @@ func (p *LogProject) WithRetryTimeout(timeout time.Duration) *LogProject {
 // @note you should call http.Response.Body.Close() to close body stream
 func (p *LogProject) RawRequest(method, uri string, headers map[string]string, body []byte) (*http.Response, error) {
 	ctx := context.Background()
-	return realRequest(ctx, p, method, uri, headers, body)
+	return realRequest(ctx, p, method, uri, headers, body, defaultRequestOption())
 }
 
 // ListLogStore returns all logstore names of project p.

log_store_object.go

@@ -8,9 +8,9 @@ import (
 )
 
 // PutObject put an object to the specified logstore
-func (s *LogStore) PutObject(objectName string, content []byte, headers map[string]string) error {
+func (s *LogStore) PutObject(objectName string, content []byte, headers map[string]string) (*PutObjectResponse, error) {
 	if objectName == "" {
-		return fmt.Errorf("object name cannot be empty")
+		return nil, fmt.Errorf("object name cannot be empty")
 	}
 
 	encodedObjectName := objectNameEncode(objectName)
@@ -26,14 +26,29 @@ func (s *LogStore) PutObject(objectName string, content []byte, headers map[stri
 		h["Content-Type"] = "application/octet-stream"
 	}
 
+	option := &requestOption{
+		computeContentHash: false,
+	}
+
 	// Send request
-	r, err := request(s.project, "PUT", uri, h, content)
+	r, err := requestWithOption(s.project, "PUT", uri, h, content, option)
 	if err != nil {
-		return NewClientError(err)
+		return nil, NewClientError(err)
 	}
 	defer r.Body.Close()
 
-	return nil
+	// Extract response headers
+	respHeaders := make(map[string]string)
+	for k, v := range r.Header {
+		if len(v) > 0 {
+			canonicalKey := http.CanonicalHeaderKey(k)
+			respHeaders[canonicalKey] = v[0]
+		}
+	}
+
+	return &PutObjectResponse{
+		Headers: respHeaders,
+	}, nil
 }
 
 // GetObject get an object from the specified logstore

request.go

@@ -15,6 +15,16 @@ import (
 	"golang.org/x/net/context"
 )
 
+type requestOption struct {
+	computeContentHash bool
+}
+
+func defaultRequestOption() *requestOption {
+	return &requestOption{
+		computeContentHash: true,
+	}
+}
+
 // timeout configs
 var (
 	defaultRequestTimeout  = 60 * time.Second
@@ -92,12 +102,21 @@ func retryWriteErrorCheck(ctx context.Context, err error) (bool, error) {
 // mock param only for test, default is []
 func request(project *LogProject, method, uri string, headers map[string]string,
 	body []byte, mock ...interface{}) (*http.Response, error) {
+	return requestWithOption(project, method, uri, headers, body, nil, mock...)
+}
+
+func requestWithOption(project *LogProject, method, uri string, headers map[string]string,
+	body []byte, option *requestOption, mock ...interface{}) (*http.Response, error) {
 
 	var r *http.Response
 	var slsErr error
 	var err error
 	var mockErr *mockErrorRetry
 
+	if option == nil {
+		option = defaultRequestOption()
+	}
+
 	project.init()
 	ctx, cancel := context.WithTimeout(context.Background(), project.retryTimeout)
 	defer cancel()
@@ -108,7 +127,7 @@ func request(project *LogProject, method, uri string, headers map[string]string,
 		err = RetryWithCondition(ctx, backoff.NewExponentialBackOff(), func() (bool, error) {
 			if len(mock) == 0 {
 				//fmt.Println("real request", project, method, uri, headers, body)
-				r, slsErr = realRequest(ctx, project, method, uri, headers, body)
+				r, slsErr = realRequest(ctx, project, method, uri, headers, body, option)
 				//fmt.Println("real request done")
 			} else {
 				r, mockErr = nil, mock[0].(*mockErrorRetry)
@@ -125,7 +144,7 @@ func request(project *LogProject, method, uri string, headers map[string]string,
 	} else {
 		err = RetryWithCondition(ctx, backoff.NewExponentialBackOff(), func() (bool, error) {
 			if len(mock) == 0 {
-				r, slsErr = realRequest(ctx, project, method, uri, headers, body)
+				r, slsErr = realRequest(ctx, project, method, uri, headers, body, option)
 			} else {
 				r, mockErr = nil, mock[0].(*mockErrorRetry)
 				mockErr.RetryCnt--
@@ -149,7 +168,7 @@ func request(project *LogProject, method, uri string, headers map[string]string,
 // request sends a request to alibaba cloud Log Service.
 // @note if error is nil, you must call http.Response.Body.Close() to finalize reader
 func realRequest(ctx context.Context, project *LogProject, method, uri string, headers map[string]string,
-	body []byte) (*http.Response, error) {
+	body []byte, option *requestOption) (*http.Response, error) {
 
 	// The caller should provide 'x-log-bodyrawsize' header
 	if _, ok := headers[HTTPHeaderBodyRawSize]; !ok {
@@ -194,17 +213,21 @@ func realRequest(ctx context.Context, project *LogProject, method, uri string, h
 	for k, v := range project.innerHeaders {
 		headers[k] = v
 	}
-	var signer Signer
-	if project.AuthVersion == AuthV4 {
+	var err error
+	switch project.AuthVersion {
+	case AuthV4:
 		headers[HTTPHeaderLogDate] = dateTimeISO8601()
-		signer = NewSignerV4(accessKeyID, accessKeySecret, project.Region)
-	} else if project.AuthVersion == AuthV0 {
-		signer = NewSignerV0()
-	} else {
+		signer := NewSignerV4(accessKeyID, accessKeySecret, project.Region)
+		err = signer.SignWithOption(method, uri, headers, body, option.computeContentHash)
+	case AuthV0:
+		signer := NewSignerV0()
+		err = signer.Sign(method, uri, headers, body)
+	default:
 		headers[HTTPHeaderDate] = nowRFC1123()
-		signer = NewSignerV1(accessKeyID, accessKeySecret)
+		signer := NewSignerV1(accessKeyID, accessKeySecret)
+		err = signer.Sign(method, uri, headers, body)
 	}
-	if err := signer.Sign(method, uri, headers, body); err != nil {
+	if err != nil {
 		return nil, err
 	}
 

signature_v4.go

@@ -42,6 +42,13 @@ func NewSignerV4(accessKeyID, accessKeySecret, region string) *SignerV4 {
 	}
 }
 
+func (s *SignerV4) SignWithOption(method, uri string, headers map[string]string, body []byte, computeContentHash bool) error {
+	if !computeContentHash {
+		headers[HTTPHeaderLogContentSha256] = emptyStringSha256
+	}
+	return s.Sign(method, uri, headers, body)
+}
+
 func (s *SignerV4) isSignedHeader(key string) bool {
 	if strings.HasPrefix(strings.ToLower(key), "x-log-meta-") {
 		return false

token_auto_update_client.go

@@ -2171,9 +2171,9 @@ func (c *TokenAutoUpdateClient) ListProjectV3(req *ListProjectRequest) (projects
 	return
 }
 
-func (c *TokenAutoUpdateClient) PutObject(project, logstore, objectName string, content []byte, headers map[string]string) (err error) {
+func (c *TokenAutoUpdateClient) PutObject(project, logstore, objectName string, content []byte, headers map[string]string) (resp *PutObjectResponse, err error) {
 	for i := 0; i < c.maxTryTimes; i++ {
-		err = c.logClient.PutObject(project, logstore, objectName, content, headers)
+		resp, err = c.logClient.PutObject(project, logstore, objectName, content, headers)
 		if !c.processError(err) {
 			return
 		}