feat: add platform_slug to upload metadata

Author: fargito

src/run/ci_provider/buildkite/provider.rs

@@ -3,6 +3,7 @@ use std::env;
 use simplelog::SharedLogger;
 
 use crate::prelude::*;
+use crate::run::ci_provider::interfaces::Platform;
 use crate::run::helpers::{parse_git_remote, GitRemote};
 use crate::run::{
     ci_provider::{
@@ -127,8 +128,8 @@ impl CIProvider for BuildkiteProvider {
         "Buildkite"
     }
 
-    fn get_provider_slug(&self) -> &'static str {
-        "buildkite"
+    fn get_platform(&self) -> Platform {
+        Platform::Buildkite
     }
 
     fn get_ci_provider_metadata(&self) -> Result<CIProviderMetadata> {

src/run/ci_provider/github_actions/provider.rs

@@ -5,6 +5,7 @@ use simplelog::SharedLogger;
 use std::{env, fs};
 
 use crate::prelude::*;
+use crate::run::ci_provider::interfaces::Platform;
 use crate::run::{
     ci_provider::{
         interfaces::{CIProviderMetadata, GhData, RepositoryProvider, RunEvent, Sender},
@@ -128,8 +129,8 @@ impl CIProvider for GitHubActionsProvider {
         "GitHub Actions"
     }
 
-    fn get_provider_slug(&self) -> &'static str {
-        "github-actions"
+    fn get_platform(&self) -> Platform {
+        Platform::GithubActions
     }
 
     fn get_ci_provider_metadata(&self) -> Result<CIProviderMetadata> {

src/run/ci_provider/gitlab_ci/provider.rs

@@ -3,7 +3,7 @@ use std::env;
 
 use crate::prelude::*;
 use crate::run::ci_provider::interfaces::{
-    CIProviderMetadata, GlData, RepositoryProvider, RunEvent, Sender,
+    CIProviderMetadata, GlData, Platform, RepositoryProvider, RunEvent, Sender,
 };
 use crate::run::ci_provider::provider::CIProviderDetector;
 use crate::run::ci_provider::CIProvider;
@@ -148,8 +148,8 @@ impl CIProvider for GitLabCIProvider {
         "GitLab CI"
     }
 
-    fn get_provider_slug(&self) -> &'static str {
-        "gitlab-ci"
+    fn get_platform(&self) -> Platform {
+        Platform::GitlabCi
     }
 
     fn get_ci_provider_metadata(&self) -> Result<CIProviderMetadata> {

src/run/ci_provider/interfaces.rs

@@ -7,6 +7,15 @@ pub enum RepositoryProvider {
     GitHub,
 }
 
+#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
+#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
+pub enum Platform {
+    GithubActions,
+    GitlabCi,
+    Buildkite,
+    Local,
+}
+
 #[derive(Deserialize, Serialize, Debug)]
 #[serde(rename_all = "camelCase")]
 pub struct CIProviderMetadata {

src/run/ci_provider/local/provider.rs

@@ -3,6 +3,7 @@ use simplelog::SharedLogger;
 
 use crate::local_logger::get_local_logger;
 use crate::prelude::*;
+use crate::run::ci_provider::interfaces::Platform;
 use crate::run::helpers::{parse_git_remote, GitRemote};
 use crate::run::{
     ci_provider::{
@@ -117,8 +118,8 @@ impl CIProvider for LocalProvider {
         "Local"
     }
 
-    fn get_provider_slug(&self) -> &'static str {
-        "local"
+    fn get_platform(&self) -> Platform {
+        Platform::Local
     }
 
     fn get_ci_provider_metadata(&self) -> Result<CIProviderMetadata> {

src/run/ci_provider/provider.rs

@@ -7,7 +7,7 @@ use crate::run::config::Config;
 use crate::run::runner::ExecutorName;
 use crate::run::uploader::{Runner, UploadMetadata};
 
-use super::interfaces::{CIProviderMetadata, RepositoryProvider};
+use super::interfaces::{CIProviderMetadata, Platform, RepositoryProvider};
 
 pub trait CIProviderDetector {
     /// Detects if the current environment is running inside the CI provider.
@@ -30,6 +30,8 @@ fn get_commit_hash(repository_root_path: &str) -> Result<String> {
 }
 
 /// `CIProvider` is a trait that defines the necessary methods for a continuous integration provider.
+///
+/// In other parts of the application, this may also be referred as `Platform`.
 pub trait CIProvider {
     /// Returns the logger for the CI provider.
     fn get_logger(&self) -> Box<dyn SharedLogger>;
@@ -47,15 +49,8 @@ pub trait CIProvider {
     /// ```
     fn get_provider_name(&self) -> &'static str;
 
-    /// Returns the slug of the CI provider.
-    ///
-    /// # Example
-    ///
-    /// ```
-    /// let provider = MyCIProvider::new();
-    /// assert_eq!(provider.get_provider_slug(), "my-ci-provider");
-    /// ```
-    fn get_provider_slug(&self) -> &'static str;
+    /// Returns the platform of the CI Provider
+    fn get_platform(&self) -> Platform;
 
     /// Returns the metadata related to the CI provider.
     fn get_ci_provider_metadata(&self) -> Result<CIProviderMetadata>;
@@ -101,7 +96,7 @@ pub trait CIProvider {
                 executor: executor_name,
                 system_info: system_info.clone(),
             },
-            platform: self.get_provider_slug().into(),
+            platform: self.get_platform(),
         })
     }
 }

src/run/mod.rs

@@ -4,6 +4,7 @@ use crate::prelude::*;
 use crate::run::{config::Config, logger::Logger};
 use crate::VERSION;
 use check_system::SystemInfo;
+use ci_provider::interfaces::Platform;
 use clap::Args;
 use instruments::mongo_tracer::MongoTracer;
 use runner::get_run_data;
@@ -100,12 +101,12 @@ pub async fn run(args: RunArgs, api_client: &CodSpeedAPIClient) -> Result<()> {
     let codspeed_config = CodSpeedConfig::load()?;
     let logger = Logger::new(&provider)?;
 
-    if provider.get_provider_slug() != "local" {
+    if provider.get_platform() != Platform::Local {
         show_banner();
     }
     debug!("config: {:#?}", config);
 
-    if provider.get_provider_slug() == "local" {
+    if provider.get_platform() == Platform::Local {
         if codspeed_config.auth.token.is_none() {
             bail!("You have to authenticate the CLI first. Run `codspeed auth login`.");
         }
@@ -157,7 +158,7 @@ pub async fn run(args: RunArgs, api_client: &CodSpeedAPIClient) -> Result<()> {
             uploader::upload(&config, &system_info, &provider, &run_data, executor.name()).await?;
         end_group!();
 
-        if provider.get_provider_slug() == "local" {
+        if provider.get_platform() == Platform::Local {
             start_group!("Fetching the results");
             poll_results::poll_results(api_client, &provider, upload_result.run_id).await?;
             end_group!();

src/run/uploader/interfaces.rs

@@ -2,7 +2,7 @@ use serde::{Deserialize, Serialize};
 
 use crate::run::{
     check_system::SystemInfo,
-    ci_provider::interfaces::{CIProviderMetadata, RepositoryProvider},
+    ci_provider::interfaces::{CIProviderMetadata, Platform, RepositoryProvider},
     instruments::InstrumentName,
     runner::ExecutorName,
 };
@@ -15,7 +15,8 @@ pub struct UploadMetadata {
     pub tokenless: bool,
     pub profile_md5: String,
     pub runner: Runner,
-    pub platform: String,
+    #[serde(rename = "platformSlug")]
+    pub platform: Platform,
     pub commit_hash: String,
     #[serde(flatten)]
     pub ci_provider_metadata: CIProviderMetadata,

…_metadata__tests__get_metadata_hash.snap …etadata__tests__get_metadata_hash-2.snapsrc/run/uploader/snapshots/codspeed__run__uploader__upload_metadata__tests__get_metadata_hash.snap renamed to src/run/uploader/snapshots/codspeed__run__uploader__upload_metadata__tests__get_metadata_hash-2.snap src/run/uploader/snapshots/codspeed__run__uploader__upload_metadata__tests__get_metadata_hash.snap renamed to src/run/uploader/snapshots/codspeed__run__uploader__upload_metadata__tests__get_metadata_hash-2.snap

@@ -25,7 +25,7 @@ expression: upload_metadata
     "cpuCores": 2,
     "totalMemoryGb": 8
   },
-  "platform": "github-actions",
+  "platformSlug": "GITHUB_ACTIONS",
   "commitHash": "5bd77cb0da72bef094893ed45fb793ff16ecfbe3",
   "ref": "refs/pull/29/merge",
   "headRef": "chore/native-action-runner",

src/run/uploader/upload.rs

@@ -1,3 +1,4 @@
+use crate::run::ci_provider::interfaces::Platform;
 use crate::run::runner::ExecutorName;
 use crate::run::{
     check_system::SystemInfo, ci_provider::CIProvider, config::Config, runner::RunData,
@@ -51,7 +52,7 @@ async fn retrieve_upload_data(
                     .map(|body| body.error)
                     .unwrap_or(text);
                 if status == StatusCode::UNAUTHORIZED {
-                    let additional_message = if upload_metadata.platform == "local" {
+                    let additional_message = if upload_metadata.platform == Platform::Local {
                         "Run `codspeed auth login` to authenticate the CLI"
                     } else {
                         "Check that CODSPEED_TOKEN is set and has the correct value"