feat: add object versioning support
Implements object versioning capabilities (v0.15.0) including: - Bucket APIs: PutBucketVersioning, GetBucketVersioning - Object Listing: ListVersions (lists versions and delete markers) - Object Operations: Updated FileDownload, FileDelete, and FileDetails to support VersionId - Integration tests covering the full versioning workflow (enable, upload versions, list, download specific version, delete specific version) Documentation updated in README.md and ROADMAP.md. "I have implemented Object Versioning (v0.15.0) as per the roadmap."
This commit is contained in:
@@ -258,3 +258,196 @@ func (s3 *S3) ListAll(input ListInput) (iter.Seq[Object], func() error) {
|
||||
|
||||
return seq, finish
|
||||
}
|
||||
|
||||
// ListVersionsInput is passed to ListVersions as a parameter.
|
||||
type ListVersionsInput struct {
|
||||
// Required: The name of the bucket to list versions from
|
||||
Bucket string
|
||||
|
||||
// Optional: A delimiter to group objects by (commonly "/")
|
||||
Delimiter string
|
||||
|
||||
// Optional: Only list objects starting with this prefix
|
||||
Prefix string
|
||||
|
||||
// Optional: Maximum number of objects to return
|
||||
MaxKeys int64
|
||||
|
||||
// Optional: Key to start listing after (used for pagination)
|
||||
KeyMarker string
|
||||
|
||||
// Optional: Version ID to start listing after (used for pagination)
|
||||
VersionIdMarker string
|
||||
}
|
||||
|
||||
// ObjectVersion represents a version of an object.
|
||||
type ObjectVersion struct {
|
||||
ETag string `xml:"ETag"`
|
||||
IsLatest bool `xml:"IsLatest"`
|
||||
Key string `xml:"Key"`
|
||||
LastModified string `xml:"LastModified"`
|
||||
Size int64 `xml:"Size"`
|
||||
StorageClass string `xml:"StorageClass"`
|
||||
VersionId string `xml:"VersionId"`
|
||||
Owner struct {
|
||||
ID string `xml:"ID"`
|
||||
DisplayName string `xml:"DisplayName"`
|
||||
} `xml:"Owner"`
|
||||
}
|
||||
|
||||
// DeleteMarker represents a delete marker for an object.
|
||||
type DeleteMarker struct {
|
||||
IsLatest bool `xml:"IsLatest"`
|
||||
Key string `xml:"Key"`
|
||||
LastModified string `xml:"LastModified"`
|
||||
VersionId string `xml:"VersionId"`
|
||||
Owner struct {
|
||||
ID string `xml:"ID"`
|
||||
DisplayName string `xml:"DisplayName"`
|
||||
} `xml:"Owner"`
|
||||
}
|
||||
|
||||
// ListVersionsResponse is returned by ListVersions.
|
||||
type ListVersionsResponse struct {
|
||||
Name string `xml:"Name"`
|
||||
Prefix string `xml:"Prefix"`
|
||||
KeyMarker string `xml:"KeyMarker"`
|
||||
VersionIdMarker string `xml:"VersionIdMarker"`
|
||||
MaxKeys int64 `xml:"MaxKeys"`
|
||||
Delimiter string `xml:"Delimiter"`
|
||||
IsTruncated bool `xml:"IsTruncated"`
|
||||
NextKeyMarker string `xml:"NextKeyMarker"`
|
||||
NextVersionIdMarker string `xml:"NextVersionIdMarker"`
|
||||
Versions []ObjectVersion `xml:"Version"`
|
||||
DeleteMarkers []DeleteMarker `xml:"DeleteMarker"`
|
||||
CommonPrefixes []string
|
||||
}
|
||||
|
||||
// ListVersions lists object versions in a bucket.
|
||||
func (s3 *S3) ListVersions(input ListVersionsInput) (ListVersionsResponse, error) {
|
||||
// Input validation
|
||||
if input.Bucket == "" {
|
||||
return ListVersionsResponse{}, fmt.Errorf("bucket name cannot be empty")
|
||||
}
|
||||
if input.MaxKeys < 0 {
|
||||
return ListVersionsResponse{}, fmt.Errorf("MaxKeys cannot be negative")
|
||||
}
|
||||
if input.MaxKeys > 1000 {
|
||||
return ListVersionsResponse{}, fmt.Errorf("MaxKeys cannot exceed 1000")
|
||||
}
|
||||
|
||||
// Build query parameters
|
||||
query := url.Values{}
|
||||
query.Set("versions", "") // Enables version listing
|
||||
|
||||
// Add optional parameters if they exist
|
||||
if input.Delimiter != "" {
|
||||
query.Set("delimiter", input.Delimiter)
|
||||
}
|
||||
if input.Prefix != "" {
|
||||
query.Set("prefix", input.Prefix)
|
||||
}
|
||||
if input.MaxKeys > 0 {
|
||||
query.Set("max-keys", fmt.Sprintf("%d", input.MaxKeys))
|
||||
}
|
||||
if input.KeyMarker != "" {
|
||||
query.Set("key-marker", input.KeyMarker)
|
||||
}
|
||||
if input.VersionIdMarker != "" {
|
||||
query.Set("version-id-marker", input.VersionIdMarker)
|
||||
}
|
||||
|
||||
// Build base URL
|
||||
baseURL := s3.getURL(input.Bucket)
|
||||
|
||||
// Parse URL and add query parameters
|
||||
parsedURL, err := url.Parse(baseURL)
|
||||
if err != nil {
|
||||
return ListVersionsResponse{}, err
|
||||
}
|
||||
parsedURL.RawQuery = query.Encode()
|
||||
|
||||
// Create HTTP request
|
||||
req, err := http.NewRequest(http.MethodGet, parsedURL.String(), nil)
|
||||
if err != nil {
|
||||
return ListVersionsResponse{}, err
|
||||
}
|
||||
|
||||
// Apply AWS V4 signing
|
||||
if err := s3.renewIAMToken(); err != nil {
|
||||
return ListVersionsResponse{}, err
|
||||
}
|
||||
if err := s3.signRequest(req); err != nil {
|
||||
return ListVersionsResponse{}, err
|
||||
}
|
||||
|
||||
// Execute request
|
||||
client := s3.getClient()
|
||||
res, err := client.Do(req)
|
||||
if err != nil {
|
||||
return ListVersionsResponse{}, err
|
||||
}
|
||||
|
||||
// Close response body when done
|
||||
defer res.Body.Close()
|
||||
|
||||
// Read response body once
|
||||
body, err := io.ReadAll(res.Body)
|
||||
if err != nil {
|
||||
return ListVersionsResponse{}, err
|
||||
}
|
||||
|
||||
// Handle response status codes
|
||||
if res.StatusCode != http.StatusOK {
|
||||
var s3Err S3Error
|
||||
if xmlErr := xml.Unmarshal(body, &s3Err); xmlErr == nil {
|
||||
return ListVersionsResponse{}, fmt.Errorf("S3 Error: %s - %s", s3Err.Code, s3Err.Message)
|
||||
}
|
||||
return ListVersionsResponse{}, fmt.Errorf("status code: %s: %s", res.Status, string(body))
|
||||
}
|
||||
|
||||
// Parse XML response using internal struct for CommonPrefixes handling
|
||||
var xmlResult struct {
|
||||
XMLName xml.Name `xml:"ListVersionsResult"`
|
||||
Name string `xml:"Name"`
|
||||
Prefix string `xml:"Prefix"`
|
||||
KeyMarker string `xml:"KeyMarker"`
|
||||
VersionIdMarker string `xml:"VersionIdMarker"`
|
||||
MaxKeys int64 `xml:"MaxKeys"`
|
||||
Delimiter string `xml:"Delimiter"`
|
||||
IsTruncated bool `xml:"IsTruncated"`
|
||||
NextKeyMarker string `xml:"NextKeyMarker"`
|
||||
NextVersionIdMarker string `xml:"NextVersionIdMarker"`
|
||||
Versions []ObjectVersion `xml:"Version"`
|
||||
DeleteMarkers []DeleteMarker `xml:"DeleteMarker"`
|
||||
CommonPrefixes []struct {
|
||||
Prefix string `xml:"Prefix"`
|
||||
} `xml:"CommonPrefixes"`
|
||||
}
|
||||
|
||||
if err := xml.Unmarshal(body, &xmlResult); err != nil {
|
||||
return ListVersionsResponse{}, err
|
||||
}
|
||||
|
||||
// Convert to simple response format
|
||||
response := ListVersionsResponse{
|
||||
Name: xmlResult.Name,
|
||||
Prefix: xmlResult.Prefix,
|
||||
KeyMarker: xmlResult.KeyMarker,
|
||||
VersionIdMarker: xmlResult.VersionIdMarker,
|
||||
MaxKeys: xmlResult.MaxKeys,
|
||||
Delimiter: xmlResult.Delimiter,
|
||||
IsTruncated: xmlResult.IsTruncated,
|
||||
NextKeyMarker: xmlResult.NextKeyMarker,
|
||||
NextVersionIdMarker: xmlResult.NextVersionIdMarker,
|
||||
Versions: xmlResult.Versions,
|
||||
DeleteMarkers: xmlResult.DeleteMarkers,
|
||||
}
|
||||
|
||||
// Convert common prefixes
|
||||
for _, prefix := range xmlResult.CommonPrefixes {
|
||||
response.CommonPrefixes = append(response.CommonPrefixes, prefix.Prefix)
|
||||
}
|
||||
|
||||
return response, nil
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user