wip_resource_id

Author: epompeii

lib/bencher_client/src/lib.rs

@@ -41,7 +41,7 @@ from_client!(
     Index,
     Jwt,
     NonEmpty,
-    ResourceId,
+    // ResourceId,
     ResourceName,
     SampleSize,
     Slug,

lib/bencher_json/src/lib.rs

@@ -4,8 +4,8 @@ pub use bencher_context::RunContext;
 pub use bencher_valid::{
     BenchmarkName, Boundary, BranchName, CdfBoundary, DateTime, DateTimeMillis, Email, GitHash,
     Index, IqrBoundary, Jwt, Model, ModelTest, NameId, NonEmpty, PercentageBoundary, ResourceId,
-    ResourceIdKind, ResourceName, SampleSize, Sanitize, Search, Secret, Slug, Units, Url, UserName,
-    ValidError, Window,
+    ResourceName, SampleSize, Sanitize, Search, Secret, Slug, Units, Url, UserName, ValidError,
+    Window,
 };
 #[cfg(feature = "plus")]
 pub use bencher_valid::{
@@ -35,30 +35,40 @@ pub use organization::{plan::JsonPlan, usage::JsonUsage};
 
 pub use big_int::BigInt;
 pub use organization::{
-    JsonNewOrganization, JsonOrganization, JsonOrganizations, OrganizationUuid,
+    JsonNewOrganization, JsonOrganization, JsonOrganizations, OrganizationResourceId,
+    OrganizationSlug, OrganizationUuid,
     claim::JsonNewClaim,
     member::{JsonMember, JsonMembers},
 };
 pub use pagination::{JsonDirection, JsonPagination};
 pub use project::{
-    JsonNewProject, JsonProject, JsonProjects, ProjectUuid,
+    JsonNewProject, JsonProject, JsonProjects, ProjectResourceId, ProjectSlug, ProjectUuid,
     alert::{AlertUuid, JsonAlert, JsonAlerts},
-    benchmark::{BenchmarkNameId, BenchmarkSlug, BenchmarkUuid, JsonBenchmark, JsonBenchmarks},
+    benchmark::{
+        BenchmarkNameId, BenchmarkResourceId, BenchmarkSlug, BenchmarkUuid, JsonBenchmark,
+        JsonBenchmarks,
+    },
     boundary::{BoundaryUuid, JsonBoundaries, JsonBoundary},
     branch::{
-        BranchNameId, BranchSlug, BranchUuid, JsonBranch, JsonBranches, JsonNewBranch,
-        JsonNewStartPoint,
+        BranchNameId, BranchResourceId, BranchSlug, BranchUuid, JsonBranch, JsonBranches,
+        JsonNewBranch, JsonNewStartPoint,
     },
     head::{HeadUuid, JsonHead, JsonStartPoint, VersionUuid},
-    measure::{JsonMeasure, JsonMeasures, JsonNewMeasure, MeasureNameId, MeasureSlug, MeasureUuid},
+    measure::{
+        JsonMeasure, JsonMeasures, JsonNewMeasure, MeasureNameId, MeasureResourceId, MeasureSlug,
+        MeasureUuid,
+    },
     metric::{
         JsonMetric, JsonMetricsMap, JsonNewMetric, JsonOneMetric, JsonResultsMap, MetricUuid,
     },
     model::{JsonModel, ModelUuid},
     perf::{JsonPerf, JsonPerfQuery, ReportBenchmarkUuid},
     plot::{JsonNewPlot, JsonPlot, JsonPlots, PlotUuid},
     report::{JsonNewReport, JsonReport, JsonReports, ReportUuid},
-    testbed::{JsonNewTestbed, JsonTestbed, JsonTestbeds, TestbedNameId, TestbedSlug, TestbedUuid},
+    testbed::{
+        JsonNewTestbed, JsonTestbed, JsonTestbeds, TestbedNameId, TestbedResourceId, TestbedSlug,
+        TestbedUuid,
+    },
     threshold::{JsonNewThreshold, JsonThreshold, JsonThresholds, ThresholdUuid},
 };
 pub use run::JsonNewRun;
@@ -78,7 +88,7 @@ pub use system::{
     version::JsonApiVersion,
 };
 pub use user::{
-    JsonPubUser, JsonUpdateUser, JsonUser, JsonUsers, UserUuid,
+    JsonPubUser, JsonUpdateUser, JsonUser, JsonUsers, UserResourceId, UserSlug, UserUuid,
     token::{JsonNewToken, JsonToken, JsonTokens, TokenUuid},
 };
 

lib/bencher_json/src/organization/mod.rs

@@ -1,6 +1,6 @@
 use std::fmt;
 
-use bencher_valid::{DateTime, ResourceName, Slug};
+use bencher_valid::{DateTime, ResourceId, ResourceName, Slug};
 use derive_more::Display;
 #[cfg(feature = "schema")]
 use schemars::JsonSchema;
@@ -9,14 +9,19 @@ use serde::{
     de::{self, Visitor},
 };
 
-use crate::UserUuid;
+use crate::{ProjectSlug, UserUuid};
 
 pub mod claim;
 pub mod member;
 pub mod plan;
 pub mod usage;
 
 crate::typed_uuid::typed_uuid!(OrganizationUuid);
+crate::typed_slug::typed_slug!(OrganizationSlug, ResourceName);
+
+/// An organization UUID or slug.
+#[typeshare::typeshare]
+pub type OrganizationResourceId = ResourceId<OrganizationUuid, OrganizationSlug>;
 
 // Create a personal organization for a user.
 impl From<UserUuid> for OrganizationUuid {
@@ -25,6 +30,12 @@ impl From<UserUuid> for OrganizationUuid {
     }
 }
 
+impl From<ProjectSlug> for OrganizationSlug {
+    fn from(slug: ProjectSlug) -> Self {
+        Self(Slug::from(slug))
+    }
+}
+
 #[derive(Debug, Clone, Deserialize, Serialize)]
 #[cfg_attr(feature = "schema", derive(JsonSchema))]
 pub struct JsonNewOrganization {
@@ -35,7 +46,7 @@ pub struct JsonNewOrganization {
     /// If not provided, the slug will be generated from the name.
     /// If the provided or generated slug is already in use, a unique slug will be generated.
     /// Maximum length is 64 characters.
-    pub slug: Option<Slug>,
+    pub slug: Option<OrganizationSlug>,
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
@@ -50,7 +61,7 @@ crate::from_vec!(JsonOrganizations[JsonOrganization]);
 pub struct JsonOrganization {
     pub uuid: OrganizationUuid,
     pub name: ResourceName,
-    pub slug: Slug,
+    pub slug: OrganizationSlug,
     #[cfg(feature = "plus")]
     pub license: Option<bencher_valid::Jwt>,
     pub created: DateTime,
@@ -85,7 +96,7 @@ pub struct JsonOrganizationPatch {
     pub name: Option<ResourceName>,
     /// The preferred new slug for the organization.
     /// Maximum length is 64 characters.
-    pub slug: Option<Slug>,
+    pub slug: Option<OrganizationSlug>,
     /// ➕ Bencher Plus: The new license for the organization.
     /// Set to `null` to remove the current license.
     #[cfg(feature = "plus")]
@@ -96,7 +107,7 @@ pub struct JsonOrganizationPatch {
 #[cfg_attr(feature = "schema", derive(JsonSchema))]
 pub struct JsonOrganizationPatchNull {
     pub name: Option<ResourceName>,
-    pub slug: Option<Slug>,
+    pub slug: Option<OrganizationSlug>,
     #[cfg(feature = "plus")]
     pub license: (),
 }

lib/bencher_json/src/project/benchmark.rs

@@ -1,6 +1,6 @@
 use std::fmt;
 
-use bencher_valid::{BenchmarkName, DateTime, NameId};
+use bencher_valid::{BenchmarkName, DateTime, NameId, ResourceId};
 #[cfg(feature = "schema")]
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
@@ -10,6 +10,10 @@ use crate::ProjectUuid;
 crate::typed_uuid::typed_uuid!(BenchmarkUuid);
 crate::typed_slug::typed_slug!(BenchmarkSlug, BenchmarkName);
 
+/// An benchmark UUID or slug.
+#[typeshare::typeshare]
+pub type BenchmarkResourceId = ResourceId<BenchmarkUuid, BenchmarkSlug>;
+
 /// A benchmark UUID, slug, or name.
 #[typeshare::typeshare]
 pub type BenchmarkNameId = NameId<BenchmarkUuid, BenchmarkSlug, BenchmarkName>;

lib/bencher_json/src/project/branch.rs

@@ -1,7 +1,7 @@
 use std::fmt;
 use std::sync::LazyLock;
 
-use bencher_valid::{BranchName, DateTime, GitHash, NameId};
+use bencher_valid::{BranchName, DateTime, GitHash, NameId, ResourceId};
 #[cfg(feature = "schema")]
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
@@ -35,6 +35,10 @@ static BRANCH_MAIN_SLUG: LazyLock<Option<BranchSlug>> = LazyLock::new(|| {
 crate::typed_uuid::typed_uuid!(BranchUuid);
 crate::typed_slug::typed_slug!(BranchSlug, BranchName);
 
+/// An branch UUID or slug.
+#[typeshare::typeshare]
+pub type BranchResourceId = ResourceId<BranchUuid, BranchSlug>;
+
 /// A branch UUID, slug, or name.
 #[typeshare::typeshare]
 pub type BranchNameId = NameId<BranchUuid, BranchSlug, BranchName>;

lib/bencher_json/src/project/measure/mod.rs

@@ -1,6 +1,6 @@
 use std::{fmt, sync::LazyLock};
 
-use bencher_valid::{DateTime, NameId, ResourceName};
+use bencher_valid::{DateTime, NameId, ResourceId, ResourceName};
 #[cfg(feature = "schema")]
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
@@ -19,6 +19,10 @@ pub static DEFAULT_UNIT: LazyLock<ResourceName> = LazyLock::new(|| {
 crate::typed_uuid::typed_uuid!(MeasureUuid);
 crate::typed_slug::typed_slug!(MeasureSlug, ResourceName);
 
+/// An measure UUID or slug.
+#[typeshare::typeshare]
+pub type MeasureResourceId = ResourceId<MeasureUuid, MeasureSlug>;
+
 /// A measure UUID, slug, or name.
 #[typeshare::typeshare]
 pub type MeasureNameId = NameId<MeasureUuid, MeasureSlug, ResourceName>;

lib/bencher_json/src/project/mod.rs

@@ -3,7 +3,7 @@ use std::{
     str::FromStr,
 };
 
-use bencher_valid::{DateTime, ResourceName, Slug, Url};
+use bencher_valid::{DateTime, ResourceId, ResourceName, Url};
 #[cfg(feature = "schema")]
 use schemars::JsonSchema;
 use serde::{
@@ -28,6 +28,11 @@ pub mod testbed;
 pub mod threshold;
 
 crate::typed_uuid::typed_uuid!(ProjectUuid);
+crate::typed_slug::typed_slug!(ProjectSlug, ResourceName);
+
+/// An project UUID or slug.
+#[typeshare::typeshare]
+pub type ProjectResourceId = ResourceId<ProjectUuid, ProjectSlug>;
 
 // Create a project from an organization.
 impl From<OrganizationUuid> for ProjectUuid {
@@ -47,7 +52,7 @@ pub struct JsonNewProject {
     /// If not provided, the slug will be generated from the name.
     /// If the provided or generated slug is already in use, a unique slug will be generated.
     /// Maximum length is 64 characters.
-    pub slug: Option<Slug>,
+    pub slug: Option<ProjectSlug>,
     /// The URL for the project.
     /// If the project is public, the URL will be accessible listed on its Perf Page.
     pub url: Option<Url>,
@@ -69,7 +74,7 @@ pub struct JsonProject {
     pub uuid: ProjectUuid,
     pub organization: OrganizationUuid,
     pub name: ResourceName,
-    pub slug: Slug,
+    pub slug: ProjectSlug,
     pub url: Option<Url>,
     pub visibility: Visibility,
     pub created: DateTime,
@@ -110,7 +115,7 @@ pub struct JsonProjectPatch {
     pub name: Option<ResourceName>,
     /// The preferred new slug for the project.
     /// Maximum length is 64 characters.
-    pub slug: Option<Slug>,
+    pub slug: Option<ProjectSlug>,
     /// The new URL of the project.
     /// Set to `null` to remove the current URL.
     pub url: Option<Url>,
@@ -123,7 +128,7 @@ pub struct JsonProjectPatch {
 #[cfg_attr(feature = "schema", derive(JsonSchema))]
 pub struct JsonProjectPatchNull {
     pub name: Option<ResourceName>,
-    pub slug: Option<Slug>,
+    pub slug: Option<ProjectSlug>,
     pub url: (),
     pub visibility: Option<Visibility>,
 }

lib/bencher_json/src/project/testbed.rs

@@ -1,7 +1,7 @@
 use std::fmt;
 use std::sync::LazyLock;
 
-use bencher_valid::{DateTime, NameId, ResourceName};
+use bencher_valid::{DateTime, NameId, ResourceId, ResourceName};
 #[cfg(feature = "schema")]
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
@@ -33,6 +33,10 @@ static TESTBED_LOCALHOST_SLUG: LazyLock<Option<TestbedSlug>> = LazyLock::new(||
 crate::typed_uuid::typed_uuid!(TestbedUuid);
 crate::typed_slug::typed_slug!(TestbedSlug, ResourceName);
 
+/// An testbed UUID or slug.
+#[typeshare::typeshare]
+pub type TestbedResourceId = ResourceId<TestbedUuid, TestbedSlug>;
+
 /// A testbed UUID, slug, or name.
 #[typeshare::typeshare]
 pub type TestbedNameId = NameId<TestbedUuid, TestbedSlug, ResourceName>;

lib/bencher_json/src/run.rs

@@ -1,11 +1,11 @@
 use bencher_context::RunContext;
-use bencher_valid::{DateTime, GitHash, ResourceId};
+use bencher_valid::{DateTime, GitHash};
 #[cfg(feature = "schema")]
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    BranchNameId, TestbedNameId,
+    BranchNameId, ProjectResourceId, TestbedNameId,
     project::{
         branch::JsonUpdateStartPoint,
         report::{JsonReportSettings, JsonReportThresholds},
@@ -23,7 +23,7 @@ use crate::{
 pub struct JsonNewRun {
     /// Project UUID or slug.
     /// If the project is not provided or does not exist, it will be created.
-    pub project: Option<ResourceId>,
+    pub project: Option<ProjectResourceId>,
     /// Branch UUID, slug, or name.
     /// If the branch is not provided or does not exist, it will be created.
     pub branch: Option<BranchNameId>,

lib/bencher_json/src/system/payment.rs

@@ -2,13 +2,12 @@
 
 use bencher_valid::{
     CardCvc, CardNumber, Email, Entitlements, ExpirationMonth, ExpirationYear, NonEmpty, PlanLevel,
-    ResourceId,
 };
 #[cfg(feature = "schema")]
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
-use crate::{OrganizationUuid, UserUuid};
+use crate::{OrganizationResourceId, OrganizationUuid, UserUuid};
 
 #[typeshare::typeshare]
 #[derive(Debug, Clone, Serialize, Deserialize)]
@@ -49,7 +48,7 @@ pub struct JsonPayment {
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[cfg_attr(feature = "schema", derive(JsonSchema))]
 pub struct JsonNewCheckout {
-    pub organization: ResourceId,
+    pub organization: OrganizationResourceId,
     pub level: PlanLevel,
     pub entitlements: Option<Entitlements>,
     pub self_hosted: Option<OrganizationUuid>,