Implement list uploads heal admin API (#3885)

2025-11-09 13:39:46 -05:00 · 2017-03-16 12:45:06 +05:30
parent 6509589adb
commit 051f9bb5c6
12 changed files with 845 additions and 33 deletions
--- a/pkg/madmin/API.md
+++ b/pkg/madmin/API.md
@@ -43,6 +43,7 @@ func main() {
 | | |[`HealBucket`](#HealBucket) |||
 | | |[`HealObject`](#HealObject)|||
 | | |[`HealFormat`](#HealFormat)|||
+| | |[`ListUploadsHeal`](#ListUploadsHeal)|||

 ## 1. Constructor
 <a name="Minio"></a>
@@ -353,3 +354,46 @@ __Example__
    }
    log.Println("SetConfig: ", string(buf.Bytes()))
 ```
+
+<a name="ListUploadsHeal"> </a>
+### ListUploadsHeal(bucket, prefix string, recursive bool, doneCh <-chan struct{}) (<-chan UploadInfo, error)
+List ongoing multipart uploads that need healing.
+
+| Param  | Type  | Description  |
+|---|---|---|
+|`ui.Key` | _string_ | Name of the object being uploaded |
+|`ui.UploadID` | _string_ | UploadID of the ongoing multipart upload |
+|`ui.HealUploadInfo.Status` | _healStatus_| One of `Healthy`, `CanHeal`, `Corrupted`, `QuorumUnavailable`|
+|`ui.Err`| _error_ | non-nil if fetching fetching healing information failed |
+
+__Example__
+
+``` go
+
+    // Set true if recursive listing is needed.
+    isRecursive := true
+    // List objects that need healing for a given bucket and
+    // prefix.
+    healUploadsCh, err := madmClnt.ListUploadsHeal(bucket, prefix, isRecursive, doneCh)
+    if err != nil {
+        log.Fatalln("Failed to get list of uploads to be healed: ", err)
+    }
+
+    for upload := range healUploadsCh {
+        if upload.Err != nil {
+            log.Println("upload listing error: ", upload.Err)
+        }
+
+        if upload.HealUploadInfo != nil {
+            switch healInfo := *upload.HealUploadInfo; healInfo.Status {
+            case madmin.CanHeal:
+                fmt.Println(upload.Key, " can be healed.")
+            case madmin.QuorumUnavailable:
+                fmt.Println(upload.Key, " can't be healed until quorum is available.")
+            case madmin.Corrupted:
+                fmt.Println(upload.Key, " can't be healed, not enough information.")
+            }
+        }
+    }
+
+```
--- a/pkg/madmin/examples/heal-uploads-list.go
+++ b/pkg/madmin/examples/heal-uploads-list.go
@@ -0,0 +1,74 @@
+// +build ignore
+
+package main
+
+/*
+ * Minio Cloud Storage, (C) 2017 Minio, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import (
+	"fmt"
+	"log"
+
+	"github.com/minio/minio/pkg/madmin"
+)
+
+func main() {
+
+	// Note: YOUR-ACCESSKEYID, YOUR-SECRETACCESSKEY are
+	// dummy values, please replace them with original values.
+
+	// API requests are secure (HTTPS) if secure=true and insecure (HTTPS) otherwise.
+	// New returns an Minio Admin client object.
+	madmClnt, err := madmin.New("your-minio.example.com:9000", "YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY", true)
+	if err != nil {
+		log.Fatalln(err)
+	}
+
+	bucket := "mybucket"
+	prefix := "myprefix"
+
+	// Create a done channel to control 'ListUploadsHeal' go routine.
+	doneCh := make(chan struct{})
+	// Indicate to our routine to exit cleanly upon return.
+	defer close(doneCh)
+
+	// Set true if recursive listing is needed.
+	isRecursive := true
+	// List objects that need healing for a given bucket and
+	// prefix.
+	healUploadsCh, err := madmClnt.ListUploadsHeal(bucket, prefix, isRecursive, doneCh)
+	if err != nil {
+		log.Fatalln("Failed to get list of uploads to be healed: ", err)
+	}
+
+	for upload := range healUploadsCh {
+		if upload.Err != nil {
+			log.Println("upload listing error: ", upload.Err)
+		}
+
+		if upload.HealUploadInfo != nil {
+			switch healInfo := *upload.HealUploadInfo; healInfo.Status {
+			case madmin.CanHeal:
+				fmt.Println(upload.Key, " can be healed.")
+			case madmin.QuorumUnavailable:
+				fmt.Println(upload.Key, " can't be healed until quorum is available.")
+			case madmin.Corrupted:
+				fmt.Println(upload.Key, " can't be healed, not enough information.")
+			}
+		}
+	}
+}
--- a/pkg/madmin/heal-commands.go
+++ b/pkg/madmin/heal-commands.go
@@ -3,6 +3,8 @@
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
+
+
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
@@ -25,6 +27,10 @@ import (
 	"time"
 )

+const (
+	maxUploadsList = 1000
+)
+
 // listBucketHealResult container for listObjects response.
 type listBucketHealResult struct {
 	// A response can contain CommonPrefixes only if you have
@@ -156,16 +162,75 @@ type ObjectInfo struct {
 	HealObjectInfo *HealObjectInfo `json:"healObjectInfo,omitempty"`
 }

+// UploadInfo - represents an ongoing upload that needs to be healed.
+type UploadInfo struct {
+	Key string `json:"name"` // Name of the object being uploaded.
+
+	UploadID string `json:"uploadId"` // UploadID
+	// Owner name.
+	Owner struct {
+		DisplayName string `json:"name"`
+		ID          string `json:"id"`
+	} `json:"owner"`
+
+	// The class of storage used to store the object.
+	StorageClass string `json:"storageClass"`
+
+	Initiated time.Time `json:"initiated"` // Time at which upload was initiated.
+
+	// Error
+	Err            error           `json:"-"`
+	HealUploadInfo *HealObjectInfo `json:"healObjectInfo,omitempty"`
+}
+
+// Initiator - has same properties as Owner.
+type Initiator Owner
+
+// upload - represents an ongoing multipart upload.
+type upload struct {
+	Key            string
+	UploadID       string `xml:"UploadId"`
+	Initiator      Initiator
+	Owner          Owner
+	StorageClass   string
+	Initiated      time.Time
+	HealUploadInfo *HealObjectInfo `xml:"HealObjectInfo,omitempty"`
+}
+
+// listUploadsHealResponse - represents ListUploadsHeal response.
+type listUploadsHealResponse struct {
+	XMLName xml.Name `xml:"http://s3.amazonaws.com/doc/2006-03-01/ ListMultipartUploadsResult" json:"-"`
+
+	Bucket             string
+	KeyMarker          string
+	UploadIDMarker     string `xml:"UploadIdMarker"`
+	NextKeyMarker      string
+	NextUploadIDMarker string `xml:"NextUploadIdMarker"`
+	Delimiter          string
+	Prefix             string
+	EncodingType       string `xml:"EncodingType,omitempty"`
+	MaxUploads         int
+	IsTruncated        bool
+
+	// List of pending uploads.
+	Uploads []upload `xml:"Upload"`
+
+	// Delimed common prefixes.
+	CommonPrefixes []commonPrefix
+}
+
 type healQueryKey string

 const (
-	healBucket    healQueryKey = "bucket"
-	healObject    healQueryKey = "object"
-	healPrefix    healQueryKey = "prefix"
-	healMarker    healQueryKey = "marker"
-	healDelimiter healQueryKey = "delimiter"
-	healMaxKey    healQueryKey = "max-key"
-	healDryRun    healQueryKey = "dry-run"
+	healBucket         healQueryKey = "bucket"
+	healObject         healQueryKey = "object"
+	healPrefix         healQueryKey = "prefix"
+	healMarker         healQueryKey = "marker"
+	healDelimiter      healQueryKey = "delimiter"
+	healMaxKey         healQueryKey = "max-key"
+	healDryRun         healQueryKey = "dry-run"
+	healUploadIDMarker healQueryKey = "upload-id-marker"
+	healMaxUpload      healQueryKey = "max-uploads"
 )

 // mkHealQueryVal - helper function to construct heal REST API query params.
@@ -432,3 +497,139 @@ func (adm *AdminClient) HealFormat(dryrun bool) error {

 	return nil
 }
+
+// mkUploadsHealQuery - helper function to construct query params for
+// ListUploadsHeal API.
+func mkUploadsHealQuery(bucket, prefix, marker, uploadIDMarker, delimiter, maxUploadsStr string) url.Values {
+
+	queryVal := make(url.Values)
+	queryVal.Set("heal", "")
+	queryVal.Set(string(healBucket), bucket)
+	queryVal.Set(string(healPrefix), prefix)
+	queryVal.Set(string(healMarker), marker)
+	queryVal.Set(string(healUploadIDMarker), uploadIDMarker)
+	queryVal.Set(string(healDelimiter), delimiter)
+	queryVal.Set(string(healMaxUpload), maxUploadsStr)
+	return queryVal
+}
+
+func (adm *AdminClient) listUploadsHeal(bucket, prefix, marker, uploadIDMarker, delimiter string, maxUploads int) (listUploadsHealResponse, error) {
+	// Construct query params.
+	maxUploadsStr := fmt.Sprintf("%d", maxUploads)
+	queryVal := mkUploadsHealQuery(bucket, prefix, marker, uploadIDMarker, delimiter, maxUploadsStr)
+
+	hdrs := make(http.Header)
+	hdrs.Set(minioAdminOpHeader, "list-uploads")
+
+	reqData := requestData{
+		queryValues:   queryVal,
+		customHeaders: hdrs,
+	}
+
+	// Empty 'list' of objects to be healed.
+	toBeHealedUploads := listUploadsHealResponse{}
+
+	// Execute GET on /?heal to list objects needing heal.
+	resp, err := adm.executeMethod("GET", reqData)
+
+	defer closeResponse(resp)
+	if err != nil {
+		return listUploadsHealResponse{}, err
+	}
+
+	if resp.StatusCode != http.StatusOK {
+		return toBeHealedUploads, httpRespToErrorResponse(resp)
+
+	}
+
+	err = xml.NewDecoder(resp.Body).Decode(&toBeHealedUploads)
+	if err != nil {
+		return listUploadsHealResponse{}, err
+	}
+
+	return toBeHealedUploads, nil
+}
+
+// ListUploadsHeal - issues list heal uploads API request
+func (adm *AdminClient) ListUploadsHeal(bucket, prefix string, recursive bool,
+	doneCh <-chan struct{}) (<-chan UploadInfo, error) {
+
+	// Default listing is delimited at "/"
+	delimiter := "/"
+	if recursive {
+		// If recursive we do not delimit.
+		delimiter = ""
+	}
+
+	uploadIDMarker := ""
+
+	// Allocate new list objects channel.
+	uploadStatCh := make(chan UploadInfo, maxUploadsList)
+
+	// Initiate list objects goroutine here.
+	go func(uploadStatCh chan<- UploadInfo) {
+		defer close(uploadStatCh)
+		// Save marker for next request.
+		var marker string
+		for {
+			// Get list of objects a maximum of 1000 per request.
+			result, err := adm.listUploadsHeal(bucket, prefix, marker,
+				uploadIDMarker, delimiter, maxUploadsList)
+			if err != nil {
+				uploadStatCh <- UploadInfo{
+					Err: err,
+				}
+				return
+			}
+
+			// If contents are available loop through and
+			// send over channel.
+			for _, upload := range result.Uploads {
+				select {
+				// Send upload info.
+				case uploadStatCh <- UploadInfo{
+					Key:            upload.Key,
+					Initiated:      upload.Initiated,
+					HealUploadInfo: upload.HealUploadInfo,
+				}:
+				// If receives done from the caller, return here.
+				case <-doneCh:
+					return
+				}
+			}
+
+			// Send all common prefixes if any.  NOTE:
+			// prefixes are only present if the request is
+			// delimited.
+			for _, prefix := range result.CommonPrefixes {
+				upload := UploadInfo{}
+				upload.Key = prefix.Prefix
+				select {
+				// Send object prefixes.
+				case uploadStatCh <- upload:
+				// If receives done from the caller, return here.
+				case <-doneCh:
+					return
+				}
+			}
+
+			// If next uploadID marker is present, set it
+			// for the next request.
+			if result.NextUploadIDMarker != "" {
+				uploadIDMarker = result.NextUploadIDMarker
+			}
+
+			// If next marker present, save it for next request.
+			if result.KeyMarker != "" {
+				marker = result.KeyMarker
+			}
+
+			// Listing ends result is not truncated,
+			// return right here.
+			if !result.IsTruncated {
+				return
+			}
+		}
+	}(uploadStatCh)
+	return uploadStatCh, nil
+}