ref(server): Introduce partial scoping type (#5291)

A tiny bit more type safety.

Also in a future PR I plan to implement `FromRequestParts` for
`PartialScoping`.

Author: Dav1dde

relay-server/src/extractors/request_meta.rs

@@ -415,13 +415,40 @@ impl RequestMeta {
 
     /// Returns scoping information from the request.
     ///
-    /// The scoping returned from this function is not complete since it lacks info from the Project
-    /// state. To fetch full scoping information, invoke the `GetScoping` message on `Project`.
-    pub fn get_partial_scoping(&self) -> Scoping {
-        Scoping {
-            organization_id: OrganizationId::new(0),
-            project_id: self.project_id().unwrap_or_else(|| ProjectId::new(0)),
+    /// The scoping returned from this function is not complete since it lacks info from the Project.
+    pub fn get_partial_scoping(&self) -> PartialScoping {
+        PartialScoping {
+            organization_id: None,
+            project_id: self.project_id(),
             project_key: self.public_key(),
+        }
+    }
+}
+
+/// A partial [`Scoping`].
+///
+/// The scoping may not be complete and missing information compared to a full scoping.
+#[derive(Debug, Copy, Clone)]
+pub struct PartialScoping {
+    /// The organization id.
+    pub organization_id: Option<OrganizationId>,
+    /// The project id.
+    pub project_id: Option<ProjectId>,
+    /// The project key or public key.
+    pub project_key: ProjectKey,
+}
+
+impl PartialScoping {
+    /// Creates a [`Scoping`] from this partial scoping, unknown information is filled with defaults.
+    ///
+    /// The scoping returned from this function is not complete since it lacks info from the Project state.
+    pub fn into_scoping(self) -> Scoping {
+        Scoping {
+            organization_id: self
+                .organization_id
+                .unwrap_or_else(|| OrganizationId::new(0)),
+            project_id: self.project_id.unwrap_or_else(|| ProjectId::new(0)),
+            project_key: self.project_key,
             key_id: None,
         }
     }

relay-server/src/managed/envelope.rs

@@ -168,7 +168,7 @@ impl ManagedEnvelope {
     pub fn new(envelope: Box<Envelope>, outcome_aggregator: Addr<TrackOutcome>) -> Self {
         let meta = &envelope.meta();
         let summary = EnvelopeSummary::compute(envelope.as_ref());
-        let scoping = meta.get_partial_scoping();
+        let scoping = meta.get_partial_scoping().into_scoping();
 
         Self {
             envelope,

relay-server/src/services/projects/project/info.rs

@@ -228,21 +228,22 @@ impl ProjectInfo {
     /// The processor must fetch the full scoping before attempting to rate limit with partial
     /// scoping.
     pub fn scope_request(&self, meta: &RequestMeta) -> Scoping {
-        let mut scoping = meta.get_partial_scoping();
+        let partial = meta.get_partial_scoping();
 
         // The key configuration may be missing if the event has been queued for extended times and
         // project was refetched in between. In such a case, access to key quotas is not availabe,
         // but we can gracefully execute all other rate limiting.
-        scoping.key_id = self
+        let key_id = self
             .get_public_key_config()
             .and_then(|config| config.numeric_id);
 
         // The original project identifier is part of the DSN. If the DSN was moved to another
         // project, the actual project identifier is different and can be obtained from project
         // states. This is only possible when the project state has been loaded.
-        if let Some(project_id) = self.project_id {
-            scoping.project_id = project_id;
-        }
+        let project_id = self
+            .project_id
+            .or(partial.project_id)
+            .unwrap_or(ProjectId::new(0));
 
         // This is a hack covering three cases:
         //  1. Relay has not fetched the project state. In this case we have no way of knowing
@@ -255,9 +256,17 @@ impl ProjectInfo {
         //  3. An organization id is available and can be matched against rate limits. In this
         //     project, all organizations will match automatically, unless the organization id
         //     has changed since the last fetch.
-        scoping.organization_id = self.organization_id.unwrap_or(OrganizationId::new(0));
-
-        scoping
+        let organization_id = self
+            .organization_id
+            .or(partial.organization_id)
+            .unwrap_or(OrganizationId::new(0));
+
+        Scoping {
+            organization_id,
+            project_id,
+            project_key: partial.project_key,
+            key_id,
+        }
     }
 
     /// Returns quotas declared in this project state.

relay-server/src/utils/multipart.rs

@@ -412,7 +412,7 @@ impl UnconstrainedMultipart {
             |outcome, quantity| {
                 outcome_aggregator.send(TrackOutcome {
                     timestamp: request_meta.received_at(),
-                    scoping: request_meta.get_partial_scoping(),
+                    scoping: request_meta.get_partial_scoping().into_scoping(),
                     outcome,
                     event_id: None,
                     remote_addr: request_meta.remote_addr(),