Skip to content

Add better metadata handling #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
herber merged 2 commits into from
Dec 24, 2025
Merged

Add better metadata handling #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bdfb84
Add better metadata handling
herber Dec 24, 2025
398e6f9
Update clients
herber Dec 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 142 additions & 2 deletions clients/go/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ type Client struct {
}

type Bucket struct {
ID string `json:"id"`
Name string `json:"name"`
CreatedAt string `json:"created_at"`
}
Expand Down Expand Up @@ -77,6 +78,29 @@ func NewClientWithHTTP(baseURL string, httpClient *http.Client) *Client {
}
}

func (c *Client) Ping() error {
req, err := http.NewRequest("GET", c.baseURL+"/ping", nil)
if err != nil {
return err
}

resp, err := c.httpClient.Do(req)
if err != nil {
return err
}
defer resp.Body.Close()

if resp.StatusCode != http.StatusOK {
bodyBytes, _ := io.ReadAll(resp.Body)
return &Error{
StatusCode: resp.StatusCode,
Message: string(bodyBytes),
}
}

return nil
}

func (c *Client) CreateBucket(name string) (*Bucket, error) {
reqBody := createBucketRequest{Name: name}
body, err := json.Marshal(reqBody)
Expand Down Expand Up @@ -112,6 +136,69 @@ func (c *Client) CreateBucket(name string) (*Bucket, error) {
return &bucket, nil
}

func (c *Client) UpsertBucket(name string) (*Bucket, error) {
reqBody := createBucketRequest{Name: name}
body, err := json.Marshal(reqBody)
if err != nil {
return nil, err
}

req, err := http.NewRequest("PUT", c.baseURL+"/buckets", bytes.NewReader(body))
if err != nil {
return nil, err
}
req.Header.Set("Content-Type", "application/json")

resp, err := c.httpClient.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()

if resp.StatusCode != http.StatusOK {
bodyBytes, _ := io.ReadAll(resp.Body)
return nil, &Error{
StatusCode: resp.StatusCode,
Message: string(bodyBytes),
}
}

var bucket Bucket
if err := json.NewDecoder(resp.Body).Decode(&bucket); err != nil {
return nil, err
}

return &bucket, nil
}

func (c *Client) GetBucket(id string) (*Bucket, error) {
req, err := http.NewRequest("GET", c.baseURL+"/buckets/"+id, nil)
if err != nil {
return nil, err
}

resp, err := c.httpClient.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()

if resp.StatusCode != http.StatusOK {
bodyBytes, _ := io.ReadAll(resp.Body)
return nil, &Error{
StatusCode: resp.StatusCode,
Message: string(bodyBytes),
}
}

var bucket Bucket
if err := json.NewDecoder(resp.Body).Decode(&bucket); err != nil {
return nil, err
}

return &bucket, nil
}

func (c *Client) ListBuckets() ([]Bucket, error) {
req, err := http.NewRequest("GET", c.baseURL+"/buckets", nil)
if err != nil {
Expand Down Expand Up @@ -233,14 +320,26 @@ func (c *Client) GetObject(bucket, key string) (*ObjectData, error) {
ct = &contentType
}

// Extract custom metadata from x-object-meta-* headers
metadata := make(map[string]string)
for headerName, headerValues := range resp.Header {
if len(headerValues) > 0 {
const prefix = "X-Object-Meta-"
if len(headerName) > len(prefix) && headerName[:len(prefix)] == prefix {
metaKey := headerName[len(prefix):]
metadata[metaKey] = headerValues[0]
}
}
}

return &ObjectData{
Metadata: ObjectMetadata{
Key: key,
Size: size,
ContentType: ct,
ETag: resp.Header.Get("ETag"),
LastModified: resp.Header.Get("Last-Modified"),
Metadata: make(map[string]string),
Metadata: metadata,
},
Data: data,
}, nil
Expand Down Expand Up @@ -273,16 +372,57 @@ func (c *Client) HeadObject(bucket, key string) (*ObjectMetadata, error) {
ct = &contentType
}

// Extract custom metadata from x-object-meta-* headers
metadata := make(map[string]string)
for headerName, headerValues := range resp.Header {
if len(headerValues) > 0 {
const prefix = "X-Object-Meta-"
if len(headerName) > len(prefix) && headerName[:len(prefix)] == prefix {
metaKey := headerName[len(prefix):]
metadata[metaKey] = headerValues[0]
}
}
}

return &ObjectMetadata{
Key: key,
Size: size,
ContentType: ct,
ETag: resp.Header.Get("ETag"),
LastModified: resp.Header.Get("Last-Modified"),
Metadata: make(map[string]string),
Metadata: metadata,
}, nil
}

func (c *Client) GetObjectInfo(bucket, key string) (*ObjectMetadata, error) {
urlPath := fmt.Sprintf("%s/buckets/%s/object-info/%s", c.baseURL, bucket, key)
req, err := http.NewRequest("GET", urlPath, nil)
if err != nil {
return nil, err
}

resp, err := c.httpClient.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()

if resp.StatusCode != http.StatusOK {
bodyBytes, _ := io.ReadAll(resp.Body)
return nil, &Error{
StatusCode: resp.StatusCode,
Message: string(bodyBytes),
}
}

var objMetadata ObjectMetadata
if err := json.NewDecoder(resp.Body).Decode(&objMetadata); err != nil {
return nil, err
}

return &objMetadata, nil
}

func (c *Client) DeleteObject(bucket, key string) error {
urlPath := fmt.Sprintf("%s/buckets/%s/objects/%s", c.baseURL, bucket, key)
req, err := http.NewRequest("DELETE", urlPath, nil)
Expand Down
89 changes: 85 additions & 4 deletions clients/rust/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ pub type Result<T> = std::result::Result<T, Error>;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Bucket {
pub id: String,
pub name: String,
pub created_at: String,
}
Expand Down Expand Up @@ -87,6 +88,18 @@ impl ObjectStoreClient {
}
}

pub async fn ping(&self) -> Result<()> {
let url = format!("{}/ping", self.base_url);
let response = self.client.get(&url).send().await?;

match response.status() {
StatusCode::OK => Ok(()),
_ => Err(Error::ServerError(
response.text().await.unwrap_or_default(),
)),
}
}

pub async fn create_bucket(&self, name: &str) -> Result<Bucket> {
let url = format!("{}/buckets", self.base_url);
let req = CreateBucketRequest {
Expand All @@ -107,6 +120,38 @@ impl ObjectStoreClient {
}
}

pub async fn upsert_bucket(&self, name: &str) -> Result<Bucket> {
let url = format!("{}/buckets", self.base_url);
let req = CreateBucketRequest {
name: name.to_string(),
};

let response = self.client.put(&url).json(&req).send().await?;

match response.status() {
StatusCode::OK => Ok(response.json().await?),
StatusCode::BAD_REQUEST => {
Err(Error::BadRequest(response.text().await.unwrap_or_default()))
}
_ => Err(Error::ServerError(
response.text().await.unwrap_or_default(),
)),
}
}

pub async fn get_bucket(&self, id: &str) -> Result<Bucket> {
let url = format!("{}/buckets/{}", self.base_url, id);
let response = self.client.get(&url).send().await?;

match response.status() {
StatusCode::OK => Ok(response.json().await?),
StatusCode::NOT_FOUND => Err(Error::NotFound(id.to_string())),
_ => Err(Error::ServerError(
response.text().await.unwrap_or_default(),
)),
}
}

pub async fn list_buckets(&self) -> Result<Vec<Bucket>> {
let url = format!("{}/buckets", self.base_url);
let response = self.client.get(&url).send().await?;
Expand Down Expand Up @@ -206,6 +251,16 @@ impl ObjectStoreClient {
.and_then(|s| s.parse().ok())
.unwrap_or(0);

// Extract custom metadata from x-object-meta-* headers
let mut metadata = HashMap::new();
for (header_name, header_value) in response.headers().iter() {
if let Some(meta_key) = header_name.as_str().strip_prefix("x-object-meta-") {
if let Ok(meta_value) = header_value.to_str() {
metadata.insert(meta_key.to_string(), meta_value.to_string());
}
}
}

let data = response.bytes().await?;

Ok(ObjectData {
Expand All @@ -215,7 +270,7 @@ impl ObjectStoreClient {
content_type,
etag,
last_modified,
metadata: HashMap::new(),
metadata,
},
data,
})
Expand Down Expand Up @@ -260,13 +315,23 @@ impl ObjectStoreClient {
.and_then(|s| s.parse().ok())
.unwrap_or(0);

// Extract custom metadata from x-object-meta-* headers
let mut metadata = HashMap::new();
for (header_name, header_value) in response.headers().iter() {
if let Some(meta_key) = header_name.as_str().strip_prefix("x-object-meta-") {
if let Ok(meta_value) = header_value.to_str() {
metadata.insert(meta_key.to_string(), meta_value.to_string());
}
}
}

Ok(ObjectMetadata {
key: key.to_string(),
size,
content_type,
etag,
last_modified,
metadata: HashMap::new(),
metadata,
})
}
StatusCode::NOT_FOUND => Err(Error::NotFound(format!("{}/{}", bucket, key))),
Expand All @@ -276,6 +341,19 @@ impl ObjectStoreClient {
}
}

pub async fn get_object_info(&self, bucket: &str, key: &str) -> Result<ObjectMetadata> {
let url = format!("{}/buckets/{}/object-info/{}", self.base_url, bucket, key);
let response = self.client.get(&url).send().await?;

match response.status() {
StatusCode::OK => Ok(response.json().await?),
StatusCode::NOT_FOUND => Err(Error::NotFound(format!("{}/{}", bucket, key))),
_ => Err(Error::ServerError(
response.text().await.unwrap_or_default(),
)),
}
}

pub async fn delete_object(&self, bucket: &str, key: &str) -> Result<()> {
let url = format!("{}/buckets/{}/objects/{}", self.base_url, bucket, key);
let response = self.client.delete(&url).send().await?;
Expand Down Expand Up @@ -369,13 +447,14 @@ mod tests {
.mock("POST", "/buckets")
.with_status(200)
.with_header("content-type", "application/json")
.with_body(r#"{"name":"test-bucket","created_at":"2024-01-01T00:00:00Z"}"#)
.with_body(r#"{"id":"bucket-123","name":"test-bucket","created_at":"2024-01-01T00:00:00Z"}"#)
.create_async()
.await;

let client = ObjectStoreClient::new(&server.url());
let bucket = client.create_bucket("test-bucket").await.unwrap();

assert_eq!(bucket.id, "bucket-123");
assert_eq!(bucket.name, "test-bucket");
assert_eq!(bucket.created_at, "2024-01-01T00:00:00Z");
}
Expand Down Expand Up @@ -404,15 +483,17 @@ mod tests {
.mock("GET", "/buckets")
.with_status(200)
.with_header("content-type", "application/json")
.with_body(r#"{"buckets":[{"name":"bucket1","created_at":"2024-01-01T00:00:00Z"},{"name":"bucket2","created_at":"2024-01-02T00:00:00Z"}]}"#)
.with_body(r#"{"buckets":[{"id":"bucket-1","name":"bucket1","created_at":"2024-01-01T00:00:00Z"},{"id":"bucket-2","name":"bucket2","created_at":"2024-01-02T00:00:00Z"}]}"#)
.create_async()
.await;

let client = ObjectStoreClient::new(&server.url());
let buckets = client.list_buckets().await.unwrap();

assert_eq!(buckets.len(), 2);
assert_eq!(buckets[0].id, "bucket-1");
assert_eq!(buckets[0].name, "bucket1");
assert_eq!(buckets[1].id, "bucket-2");
assert_eq!(buckets[1].name, "bucket2");
}

Expand Down
2 changes: 1 addition & 1 deletion clients/typescript/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "object-storage-client",
"version": "0.2.2",
"version": "0.2.3",
"description": "TypeScript client for Object Storage Service",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
Loading
Loading