Merge branch 'main' into feat/metadata-content-type

jan-auer · jan-auer · commit 485f02ba5da3 · 2025-10-31T10:40:12.000-04:00
* main: meta(client): Release setup (#157) feat(server): Improve error handling during shutdown (#161) feat: Allow defining a per-usecase/client default expiration policy (#158)
diff --git a/.github/workflows/build-clients.yml b/.github/workflows/build-clients.yml
@@ -0,0 +1,27 @@
+name: Build Python client
+
+on:
+  push:
+    branches:
+      - release/**
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build and upload artifacts
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@85856786d1ce8acfbcc2f13a5f3fbd6b938f9f41 # v7.1.2
+
+      - name: Build artifacts
+        run: uv build --package objectstore-client
+
+      - uses: actions/upload-artifact@v5
+        with:
+          path: dist/*
+          if-no-files-found: 'error'
diff --git a/.github/workflows/release-clients.yml b/.github/workflows/release-clients.yml
@@ -0,0 +1,44 @@
+name: Release client libraries
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Version to release
+        required: true
+      force:
+        description: Force a release even when there are release-blockers (optional)
+        required: false
+      merge_target:
+        description: Target branch to merge into. Uses the default branch as a fallback (optional)
+        required: false
+
+permissions:
+  contents: read
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/create-github-app-token@67018539274d69449ef7c02e8e71183d1719ab42 # v2.1.4
+        id: token
+        with:
+          app-id: ${{ vars.SENTRY_RELEASE_BOT_CLIENT_ID }}
+          private-key: ${{ secrets.SENTRY_RELEASE_BOT_PRIVATE_KEY }}
+
+      - uses: actions/checkout@v5
+        with:
+          token: ${{ steps.token.outputs.token }}
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@85856786d1ce8acfbcc2f13a5f3fbd6b938f9f41 # v7.1.2
+
+      - name: Prepare release
+        uses: getsentry/action-prepare-release@v1
+        env:
+          GITHUB_TOKEN: ${{ steps.token.outputs.token }}
+        with:
+          version: ${{ github.event.inputs.version }}
+          force: ${{ github.event.inputs.force }}
+          merge_target: ${{ github.event.inputs.merge_target }}
+          path: clients
diff --git a/clients/.craft.yml b/clients/.craft.yml
@@ -0,0 +1,13 @@
+changelogPolicy: auto
+preReleaseCommand: ../scripts/bump-version-clients.sh
+
+targets:
+  - name: github
+  - name: crates
+  - name: pypi
+  - name: sentry-pypi
+    internalPypiRepo: getsentry/pypi
+
+requireNames:
+  - /.*objectstore_client.*whl$/
+  - /.*objectstore_client.*tar\.gz$/
diff --git a/clients/CHANGELOG.md b/clients/CHANGELOG.md
@@ -0,0 +1,3 @@
+# Unreleased
+
+This is the first release of the Objectstore client SDKs.
diff --git a/clients/python/LICENSE.md b/clients/python/LICENSE.md
@@ -0,0 +1 @@
+../../LICENSE.md
diff --git a/clients/python/pyproject.toml b/clients/python/pyproject.toml
@@ -1,8 +1,14 @@
 [project]
 name = "objectstore-client"
 version = "0.1.0"
-description = "Python client for the Sentry Objectstore service"
+description = "Client SDK for Objectstore, the Sentry object storage platform"
 readme = "README.md"
+authors = [
+    {name = "Sentry", email = "oss@sentry.io"},
+]
+homepage = "https://getsentry.github.io/objectstore/"
+repository = "https://github.com/getsentry/objectstore"
+license = { file = "LICENSE.md" }
 requires-python = ">=3.13.1"
 dependencies = [
     "sentry-sdk>=2.42.1",
diff --git a/clients/python/src/objectstore_client/client.py b/clients/python/src/objectstore_client/client.py
@@ -43,10 +43,16 @@ def __init__(
         usecase: str,
         metrics_backend: MetricsBackend | None = None,
         propagate_traces: bool = False,
+        default_expiration_policy: ExpirationPolicy | None = None,
     ):
         self._base_url = objectstore_base_url
         self._usecase = usecase
         self._default_compression: Compression = "zstd"
+        self._default_expiration_policy = (
+            format_expiration(default_expiration_policy)
+            if default_expiration_policy
+            else None
+        )
         self._propagate_traces = propagate_traces
         self._metrics_backend = metrics_backend or NoOpMetricsBackend()
 
@@ -55,6 +61,7 @@ def _make_client(self, scope: str) -> Client:
         return Client(
             pool,
             self._default_compression,
+            self._default_expiration_policy,
             self._usecase,
             scope,
             self._propagate_traces,
@@ -79,13 +86,15 @@ def __init__(
         self,
         pool: HTTPConnectionPool,
         default_compression: Compression,
+        default_expiration_policy: str | None,
         usecase: str,
         scope: str,
         propagate_traces: bool,
         metrics_backend: MetricsBackend,
     ):
         self._pool = pool
         self._default_compression = default_compression
+        self._default_expiration_policy = default_expiration_policy
         self._usecase = usecase
         self._scope = scope
         self._propagate_traces = propagate_traces
@@ -140,6 +149,8 @@ def put(
 
         if expiration_policy:
             headers[HEADER_EXPIRATION] = format_expiration(expiration_policy)
+        elif self._default_expiration_policy:
+            headers[HEADER_EXPIRATION] = self._default_expiration_policy
 
         if metadata:
             for k, v in metadata.items():
diff --git a/clients/rust/Cargo.toml b/clients/rust/Cargo.toml
@@ -4,7 +4,7 @@ authors = ["Sentry <oss@sentry.io>"]
 description = "Client SDK for Objectstore, the Sentry object storage platform"
 homepage = "https://getsentry.github.io/objectstore/"
 repository = "https://github.com/getsentry/objectstore"
-license-file = "../LICENSE.md"
+license-file = "../../LICENSE.md"
 version = "0.1.0"
 edition = "2024"
 rust-version = "1.89"
diff --git a/clients/rust/src/client.rs b/clients/rust/src/client.rs
@@ -3,6 +3,7 @@ use std::sync::Arc;
 
 use bytes::Bytes;
 use futures_util::stream::BoxStream;
+use objectstore_types::ExpirationPolicy;
 use reqwest::header::HeaderName;
 
 pub use objectstore_types::{Compression, PARAM_SCOPE, PARAM_USECASE};
@@ -19,10 +20,11 @@ const USER_AGENT: &str = concat!("objectstore-client/", env!("CARGO_PKG_VERSION"
 pub struct ClientBuilder {
     service_url: Arc<str>,
     client: reqwest::Client,
+    propagate_traces: bool,
 
     usecase: Arc<str>,
     default_compression: Compression,
-    propagate_traces: bool,
+    default_expiration_policy: ExpirationPolicy,
 }
 
 impl ClientBuilder {
@@ -47,10 +49,11 @@ impl ClientBuilder {
         Ok(Self {
             service_url: service_url.trim_end_matches('/').into(),
             client,
+            propagate_traces: false,
 
             usecase: usecase.into(),
             default_compression: Compression::Zstd,
-            propagate_traces: false,
+            default_expiration_policy: ExpirationPolicy::Manual,
         })
     }
 
@@ -60,6 +63,12 @@ impl ClientBuilder {
         self
     }
 
+    /// This sets a default expiration policy used for uploads.
+    pub fn default_expiration_policy(mut self, expiration_policy: ExpirationPolicy) -> Self {
+        self.default_expiration_policy = expiration_policy;
+        self
+    }
+
     /// This changes whether the `sentry-trace` header will be sent to Objectstore
     /// to take advantage of Sentry's distributed tracing.
     pub fn with_distributed_tracing(mut self, propagate_traces: bool) -> Self {
@@ -71,11 +80,12 @@ impl ClientBuilder {
         Client {
             service_url: self.service_url.clone(),
             http: self.client.clone(),
+            propagate_traces: self.propagate_traces,
 
             usecase: self.usecase.clone(),
             scope,
             default_compression: self.default_compression,
-            propagate_traces: self.propagate_traces,
+            default_expiration_policy: self.default_expiration_policy,
         }
     }
 
@@ -98,6 +108,7 @@ impl ClientBuilder {
 pub struct Client {
     pub(crate) http: reqwest::Client,
     pub(crate) service_url: Arc<str>,
+    propagate_traces: bool,
 
     pub(crate) usecase: Arc<str>,
 
@@ -113,8 +124,7 @@ pub struct Client {
     /// characters.
     pub(crate) scope: String,
     pub(crate) default_compression: Compression,
-
-    propagate_traces: bool,
+    pub(crate) default_expiration_policy: ExpirationPolicy,
 }
 
 /// The type of [`Stream`](futures_util::Stream) to be used for a PUT request.
diff --git a/clients/rust/src/put.rs b/clients/rust/src/put.rs
@@ -18,6 +18,7 @@ use crate::{Client, ClientStream};
 impl Client {
     fn put_body(&self, body: PutBody) -> PutBuilder<'_> {
         let metadata = Metadata {
+            expiration_policy: self.default_expiration_policy,
             compression: Some(self.default_compression),
             ..Default::default()
         };
diff --git a/objectstore-server/src/http.rs b/objectstore-server/src/http.rs
@@ -113,9 +113,14 @@ impl App {
         let service =
             ServiceExt::<Request>::into_make_service_with_connect_info::<SocketAddr>(router);
 
-        let server = async move {
-            if graceful_shutdown {
-                let guard = elegant_departure::get_shutdown_guard().shutdown_on_drop();
+        let guard = if graceful_shutdown {
+            Some(elegant_departure::get_shutdown_guard())
+        } else {
+            None
+        };
+
+        let server = async {
+            if let Some(ref guard) = guard {
                 axum::serve(listener, service)
                     .with_graceful_shutdown(guard.wait_owned())
                     .await
diff --git a/objectstore-server/src/lib.rs b/objectstore-server/src/lib.rs
@@ -1,6 +1,6 @@
 //! The storage server component.
 //!
-//! This builds on top of the [`objectstore-service`], and exposes the underlying storage layer as
+//! This builds on top of the [`objectstore_service`], and exposes the underlying storage layer as
 //! an `HTTP` layer which can serve files directly to *external clients* and our SDK.
 
 pub mod config;
diff --git a/objectstore-server/src/main.rs b/objectstore-server/src/main.rs
@@ -1,6 +1,6 @@
 //! The storage server component.
 //!
-//! This builds on top of the [`objectstore-service`], and exposes the underlying storage layer as
+//! This builds on top of the [`objectstore_service`], and exposes the underlying storage layer as
 //! an `HTTP` layer which can serve files directly to *external clients* and our SDK.
 #![warn(missing_docs)]
 #![warn(missing_debug_implementations)]
@@ -42,27 +42,33 @@ fn main() -> Result<()> {
         .expect("Failed to install rustls crypto provider");
 
     let metrics_guard = maybe_initialize_metrics(&config)?;
-    let metrics_handle = async move {
-        match metrics_guard {
-            Some(metrics_guard) => metrics_guard.flush(None).await,
-            None => Ok(()),
-        }
-    };
 
     runtime.block_on(async move {
         let state = State::new(config).await?;
         let server_handle = tokio::spawn(http::server(state));
 
+        tokio::spawn(async move {
+            elegant_departure::get_shutdown_guard().wait().await;
+            tracing::info!("shutting down ...");
+        });
+
         elegant_departure::tokio::depart()
             .on_termination()
             .on_sigint()
             .on_signal(SignalKind::hangup())
             .on_signal(SignalKind::quit())
             .await;
 
-        let (server_result, metrics_result) = tokio::join!(server_handle, metrics_handle);
-        server_result??;
-        metrics_result?;
+        if let Err(error) = server_handle.await.map_err(From::from).flatten() {
+            tracing::error!(
+                error = error.as_ref() as &dyn std::error::Error,
+                "web server failed"
+            );
+        }
+
+        if let Some(metrics_guard) = metrics_guard {
+            metrics_guard.flush(None).await.ok();
+        }
 
         tracing::info!("shutdown complete");
 
diff --git a/scripts/bump-version-clients.sh b/scripts/bump-version-clients.sh
@@ -0,0 +1,25 @@
+#!/bin/bash
+set -euxo pipefail
+
+ROOT_DIR="$(realpath $(dirname "$0")/..)"
+
+OLD_VERSION="${1}"
+NEW_VERSION="${2}"
+
+echo "Current version: $OLD_VERSION"
+echo "Bumping to version: $NEW_VERSION"
+
+# =================== Rust ===================
+
+cd $ROOT_DIR
+cd clients/rust
+
+perl -pi -e "s/^version = \".*?\"/version = \"$NEW_VERSION\"/" Cargo.toml
+cargo metadata --format-version 1 >/dev/null # update `Cargo.lock`
+
+# ==================== PY ====================
+
+cd $ROOT_DIR
+cd clients/python
+
+uv version "$NEW_VERSION"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Unreleased`
	`2`	`+`
	`3`	`+This is the first release of the Objectstore client SDKs.`