Skip to content

Capture immutable credential scopes for resource operations #124

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

Closed
Stephen Belanger (Qard) wants to merge 1 commit into from
Closed

Capture immutable credential scopes for resource operations #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
74 changes: 23 additions & 51 deletions src/dataset.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ use uuid::Uuid;

use crate::api::datasets::{DatasetFields, DatasetWrite};
use crate::error::Result;
use crate::internal::session::CredentialScope;
use crate::span::SpanSubmitter;

// ============================================================================
Expand Down Expand Up @@ -251,7 +252,7 @@ pub(crate) trait DatasetRegistrar: Send + Sync {
/// Register a dataset with the API.
async fn register_dataset(
&self,
token: &str,
scope: &CredentialScope,
request: DatasetRegisterRequest,
) -> Result<DatasetRegisterResponse>;
}
Expand All @@ -262,8 +263,7 @@ pub(crate) trait DatasetFetcher: Send + Sync {
/// Fetch dataset records via BTQL query.
async fn fetch_dataset_records(
&self,
token: &str,
org_name: &str,
scope: &CredentialScope,
query: BTQLQuery,
) -> Result<BTQLResponse>;
}
Expand All @@ -274,21 +274,15 @@ pub(crate) trait DatasetSummarizer: Send + Sync {
/// Fetch dataset summary.
async fn fetch_dataset_summary(
&self,
token: &str,
org_name: &str,
scope: &CredentialScope,
dataset_id: &str,
) -> Result<DatasetSummaryResponse>;
}

/// Direct dataset mutation port; writes are acknowledged by the endpoint.
#[async_trait]
pub(crate) trait DatasetWriter: Send + Sync {
async fn write_dataset_record(
&self,
token: &str,
org_name: &str,
row: DatasetWrite,
) -> Result<()>;
async fn write_dataset_record(&self, scope: &CredentialScope, row: DatasetWrite) -> Result<()>;
}

// ============================================================================
Expand Down Expand Up @@ -330,8 +324,7 @@ pub struct DatasetBuilder<
S: SpanSubmitter + DatasetRegistrar + DatasetFetcher + DatasetSummarizer + DatasetWriter,
> {
submitter: Arc<S>,
token: String,
org_name: String,
scope: CredentialScope,
project_name: Option<String>,
dataset_name: Option<String>,
description: Option<String>,
Expand All @@ -344,8 +337,7 @@ impl<S: SpanSubmitter + DatasetRegistrar + DatasetFetcher + DatasetSummarizer +
fn clone(&self) -> Self {
Self {
submitter: Arc::clone(&self.submitter),
token: self.token.clone(),
org_name: self.org_name.clone(),
scope: self.scope.clone(),
project_name: self.project_name.clone(),
dataset_name: self.dataset_name.clone(),
description: self.description.clone(),
Expand All @@ -365,15 +357,10 @@ impl<
> DatasetBuilder<S>
{
/// Create a new DatasetBuilder (internal use).
pub(crate) fn new(
submitter: Arc<S>,
token: impl Into<String>,
org_name: impl Into<String>,
) -> Self {
pub(crate) fn new(submitter: Arc<S>, scope: CredentialScope) -> Self {
Self {
submitter,
token: token.into(),
org_name: org_name.into(),
scope,
project_name: None,
dataset_name: None,
description: None,
Expand Down Expand Up @@ -424,8 +411,7 @@ impl<

Ok(Dataset {
submitter: self.submitter,
token: self.token,
org_name: self.org_name,
scope: self.scope,
project_name,
dataset_name,
description: self.description,
Expand All @@ -447,8 +433,7 @@ pub struct Dataset<
S: SpanSubmitter + DatasetRegistrar + DatasetFetcher + DatasetSummarizer + DatasetWriter,
> {
submitter: Arc<S>,
token: String,
org_name: String,
scope: CredentialScope,
project_name: String,
dataset_name: String,
description: Option<String>,
Expand All @@ -462,8 +447,7 @@ impl<S: SpanSubmitter + DatasetRegistrar + DatasetFetcher + DatasetSummarizer +
fn clone(&self) -> Self {
Self {
submitter: self.submitter.clone(),
token: self.token.clone(),
org_name: self.org_name.clone(),
scope: self.scope.clone(),
project_name: self.project_name.clone(),
dataset_name: self.dataset_name.clone(),
description: self.description.clone(),
Expand Down Expand Up @@ -501,14 +485,14 @@ impl<
.get_or_try_init(|| async {
let request = DatasetRegisterRequest {
project_name: self.project_name.clone(),
org_name: self.org_name.clone(),
org_name: self.scope.org_name().unwrap_or_default().to_owned(),
dataset_name: self.dataset_name.clone(),
description: self.description.clone(),
metadata: self.metadata.clone(),
};
let response = self
.submitter
.register_dataset(&self.token, request)
.register_dataset(&self.scope, request)
.await?;
Ok(DatasetMetadata {
dataset_id: response.dataset.id,
Expand Down Expand Up @@ -539,8 +523,7 @@ impl<
let id = Uuid::new_v4().to_string();
self.submitter
.write_dataset_record(
&self.token,
&self.org_name,
&self.scope,
DatasetWrite::Insert {
dataset_id,
id: id.clone(),
Expand All @@ -556,8 +539,7 @@ impl<
let dataset_id = self.ensure_registered().await?.dataset_id.clone();
self.submitter
.write_dataset_record(
&self.token,
&self.org_name,
&self.scope,
DatasetWrite::Update {
dataset_id,
id: id.to_owned(),
Expand All @@ -572,8 +554,7 @@ impl<
let dataset_id = self.ensure_registered().await?.dataset_id.clone();
self.submitter
.write_dataset_record(
&self.token,
&self.org_name,
&self.scope,
DatasetWrite::Delete {
dataset_id,
id: id.to_owned(),
Expand All @@ -589,8 +570,7 @@ impl<
let metadata = self.ensure_registered().await?;
Ok(DatasetIterator::new(
Arc::clone(&self.submitter),
self.token.clone(),
self.org_name.clone(),
self.scope.clone(),
metadata.dataset_id.clone(),
batch_size.unwrap_or(1000).max(1),
))
Expand All @@ -603,7 +583,7 @@ impl<
// Fetch summary from API
let response = self
.submitter
.fetch_dataset_summary(&self.token, &self.org_name, &metadata.dataset_id)
.fetch_dataset_summary(&self.scope, &metadata.dataset_id)
.await?;

Ok(DatasetSummary {
Expand Down Expand Up @@ -643,8 +623,7 @@ impl<
#[allow(private_bounds)]
pub struct DatasetIterator<S: DatasetFetcher> {
fetcher: Arc<S>,
token: String,
org_name: String,
scope: CredentialScope,
dataset_id: String,
batch_size: usize,
cursor: Option<String>,
Expand All @@ -654,17 +633,10 @@ pub struct DatasetIterator<S: DatasetFetcher> {

#[allow(private_bounds)]
impl<S: DatasetFetcher + 'static> DatasetIterator<S> {
fn new(
fetcher: Arc<S>,
token: String,
org_name: String,
dataset_id: String,
batch_size: usize,
) -> Self {
fn new(fetcher: Arc<S>, scope: CredentialScope, dataset_id: String, batch_size: usize) -> Self {
Self {
fetcher,
token,
org_name,
scope,
dataset_id,
batch_size,
cursor: None,
Expand Down Expand Up @@ -693,7 +665,7 @@ impl<S: DatasetFetcher + 'static> DatasetIterator<S> {
// A failed request leaves the cursor and EOF state untouched.
let response = self
.fetcher
.fetch_dataset_records(&self.token, &self.org_name, query)
.fetch_dataset_records(&self.scope, query)
.await?;
if response.cursor.is_some() && response.cursor == previous_cursor {
return Err(crate::BraintrustError::Background(
Expand Down
7 changes: 4 additions & 3 deletions src/experiments/api/traits.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@ use crate::experiments::api::registration::{
ExperimentRegisterRequest, ExperimentRegisterResponse,
};
use crate::experiments::metadata::BaseExperimentInfo;
use crate::internal::session::CredentialScope;

/// Trait for registering experiments with the Braintrust API.
#[async_trait::async_trait]
pub(crate) trait ExperimentRegistrar: Send + Sync {
async fn register_experiment(
&self,
token: &str,
scope: &CredentialScope,
request: ExperimentRegisterRequest,
) -> Result<ExperimentRegisterResponse>;
}
Expand All @@ -22,7 +23,7 @@ pub(crate) trait ExperimentRegistrar: Send + Sync {
pub(crate) trait BaseExperimentFetcher: Send + Sync {
async fn fetch_base_experiment(
&self,
token: &str,
scope: &CredentialScope,
experiment_id: &str,
) -> Result<Option<BaseExperimentInfo>>;
}
Expand All @@ -32,7 +33,7 @@ pub(crate) trait BaseExperimentFetcher: Send + Sync {
pub(crate) trait ExperimentComparisonFetcher: Send + Sync {
async fn fetch_experiment_comparison(
&self,
token: &str,
scope: &CredentialScope,
experiment_id: &str,
base_experiment_id: Option<&str>,
) -> Result<ExperimentComparisonResponse>;
Expand Down
25 changes: 7 additions & 18 deletions src/experiments/builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use serde_json::{Map, Value};

use crate::experiments::experiment::{Experiment, ExperimentState};
use crate::experiments::metadata::RepoInfo;
use crate::internal::session::CredentialScope;
use crate::span::SpanSubmitter;

/// Error type for ExperimentBuilder validation.
Expand Down Expand Up @@ -36,9 +37,7 @@ impl std::error::Error for ExperimentBuilderError {}
#[allow(private_bounds)]
pub struct ExperimentBuilder<S: SpanSubmitter> {
submitter: Arc<S>,
token: String,
org_id: String,
org_name: Option<String>,
scope: CredentialScope,
project_name: Option<String>,
experiment_name: Option<String>,
description: Option<String>,
Expand All @@ -53,9 +52,7 @@ impl<S: SpanSubmitter> Clone for ExperimentBuilder<S> {
fn clone(&self) -> Self {
Self {
submitter: Arc::clone(&self.submitter),
token: self.token.clone(),
org_id: self.org_id.clone(),
org_name: self.org_name.clone(),
scope: self.scope.clone(),
project_name: self.project_name.clone(),
experiment_name: self.experiment_name.clone(),
description: self.description.clone(),
Expand All @@ -71,16 +68,10 @@ impl<S: SpanSubmitter> Clone for ExperimentBuilder<S> {
#[allow(private_bounds)]
impl<S: SpanSubmitter + 'static> ExperimentBuilder<S> {
/// Create a new ExperimentBuilder (internal use).
pub(crate) fn new(
submitter: Arc<S>,
token: impl Into<String>,
org_id: impl Into<String>,
) -> Self {
pub(crate) fn new(submitter: Arc<S>, scope: CredentialScope) -> Self {
Self {
submitter,
token: token.into(),
org_id: org_id.into(),
org_name: None,
scope,
project_name: None,
experiment_name: None,
description: None,
Expand All @@ -94,7 +85,7 @@ impl<S: SpanSubmitter + 'static> ExperimentBuilder<S> {

/// Set the organization name.
pub fn org_name(mut self, org_name: impl Into<String>) -> Self {
self.org_name = Some(org_name.into());
self.scope = self.scope.with_org_name(org_name.into());
self
}

Expand Down Expand Up @@ -168,9 +159,7 @@ impl<S: SpanSubmitter + 'static> ExperimentBuilder<S> {

Ok(Experiment {
submitter: self.submitter,
token: self.token,
org_id: self.org_id,
org_name: self.org_name,
scope: self.scope,
project_name,
experiment_name: self.experiment_name,
description: self.description,
Expand Down
Loading
Loading