chore: combining protos into one file and commiting output to src/protos

build.rs

@@ -3,20 +3,15 @@ use std::path::Path;
 
 fn init_proto() -> Result<(), Box<dyn std::error::Error>> {
     // Define the path to the output directory within the `src` folder
-    let out_dir = Path::new("proto");
+    let out_dir = Path::new("src/protos");
     std::fs::create_dir_all(out_dir)?;
 
     let descriptor_set_path = format!(
         "{}/ratings_descriptor.bin",
         std::env::var("OUT_DIR").unwrap()
     );
 
-    let files = &[
-        "proto/ratings_features_app.proto",
-        "proto/ratings_features_chart.proto",
-        "proto/ratings_features_user.proto",
-        "proto/ratings_features_common.proto",
-    ];
+    let files = &["protos/ratings.proto"];
 
     tonic_build::configure()
         .protoc_arg("--experimental_allow_proto3_optional") // needed to run on GHA because it's jammy
@@ -28,7 +23,7 @@ fn init_proto() -> Result<(), Box<dyn std::error::Error>> {
             "Category",
             r#"#[strum(serialize_all = "kebab_case", ascii_case_insensitive)]"#,
         )
-        .compile(files, &["proto"])?;
+        .compile(files, &["protos"])?;
 
     Ok(())
 }

protos/ratings.proto

@@ -0,0 +1,133 @@
+syntax = "proto3";
+
+package ratings;
+
+// Import dependencies
+import "google/protobuf/empty.proto";
+import "google/protobuf/timestamp.proto";
+
+// App service
+service App {
+  rpc GetRating (GetRatingRequest) returns (GetRatingResponse) {}
+}
+
+message GetRatingRequest {
+  string snap_id = 1;
+}
+
+message GetRatingResponse {
+  Rating rating = 1;
+}
+
+// Chart service
+service Chart {
+  rpc GetChart (GetChartRequest) returns (GetChartResponse) {}
+}
+
+message GetChartRequest {
+  Timeframe timeframe = 1;
+  optional Category category = 2;
+}
+
+message GetChartResponse {
+  Timeframe timeframe = 1;
+  repeated ChartData ordered_chart_data = 2;
+  optional Category category = 3;
+}
+
+message ChartData {
+  float raw_rating = 1;
+  Rating rating = 2;
+}
+
+enum Timeframe {
+  TIMEFRAME_UNSPECIFIED = 0;
+  TIMEFRAME_WEEK = 1;
+  TIMEFRAME_MONTH = 2;
+}
+
+enum Category {
+  ART_AND_DESIGN = 0;
+  BOOK_AND_REFERENCE = 1;
+  DEVELOPMENT = 2;
+  DEVICES_AND_IOT = 3;
+  EDUCATION = 4;
+  ENTERTAINMENT = 5;
+  FEATURED = 6;
+  FINANCE = 7;
+  GAMES = 8;
+  HEALTH_AND_FITNESS = 9;
+  MUSIC_AND_AUDIO = 10;
+  NEWS_AND_WEATHER = 11;
+  PERSONALISATION = 12;
+  PHOTO_AND_VIDEO = 13;
+  PRODUCTIVITY = 14;
+  SCIENCE = 15;
+  SECURITY = 16;
+  SERVER_AND_CLOUD = 17;
+  SOCIAL = 18;
+  UTILITIES = 19;
+}
+
+// User service
+service User {
+  rpc Authenticate (AuthenticateRequest) returns (AuthenticateResponse) {}
+
+  rpc Delete (google.protobuf.Empty) returns (google.protobuf.Empty) {}
+  rpc Vote (VoteRequest) returns (google.protobuf.Empty) {}
+  rpc ListMyVotes (ListMyVotesRequest) returns (ListMyVotesResponse) {}
+  rpc GetSnapVotes(GetSnapVotesRequest) returns (GetSnapVotesResponse) {}
+}
+
+message AuthenticateRequest {
+  string id = 1;
+}
+
+message AuthenticateResponse {
+  string token = 1;
+}
+
+message ListMyVotesRequest {
+  string snap_id_filter = 1;
+}
+
+message ListMyVotesResponse {
+  repeated Vote votes = 1;
+}
+
+message GetSnapVotesRequest {
+  string snap_id = 1;
+}
+
+message GetSnapVotesResponse {
+  repeated Vote votes = 1;
+}
+
+message Vote {
+  string snap_id = 1;
+  int32 snap_revision = 2;
+  bool vote_up = 3;
+  google.protobuf.Timestamp timestamp = 4;
+}
+
+message VoteRequest {
+  string snap_id = 1;
+  int32 snap_revision = 2;
+  bool vote_up = 3;
+}
+
+// Common messages
+message Rating {
+  string snap_id = 1;
+  uint64 total_votes = 2;
+  RatingsBand ratings_band = 3;
+}
+
+enum RatingsBand {
+  VERY_GOOD = 0;
+  GOOD = 1;
+  NEUTRAL = 2;
+  POOR = 3;
+  VERY_POOR = 4;
+  INSUFFICIENT_VOTES = 5;
+}

src/features/chart/entities.rs

@@ -1,7 +1,7 @@
 //! Contains struct definitions for the charting feature for ratings.
 use crate::features::{
     common::entities::{calculate_band, Rating, VoteSummary},
-    pb::chart as pb,
+    pb::protos as pb,
 };
 use sqlx::FromRow;
 

src/features/chart/infrastructure.rs

@@ -6,7 +6,7 @@ use crate::{
     features::{
         chart::errors::ChartError,
         common::entities::VoteSummary,
-        pb::chart::{Category, Timeframe},
+        pb::protos::{Category, Timeframe},
     },
 };
 use sqlx::QueryBuilder;
@@ -47,9 +47,9 @@ pub(crate) async fn get_votes_summary(
     if let Some(category) = category {
         builder
             .push(
-                r#" 
+                r#"
                 WHERE votes.snap_id IN (
-                    SELECT snap_categories.snap_id FROM snap_categories 
+                    SELECT snap_categories.snap_id FROM snap_categories
                     WHERE snap_categories.category = "#,
             )
             .push_bind(category)

src/features/chart/service/grpc.rs

@@ -3,7 +3,7 @@ use crate::{
     app::AppContext,
     features::{
         chart::{errors::ChartError, service::ChartService, use_cases},
-        pb::chart::{chart_server::Chart, Category, GetChartRequest, GetChartResponse, Timeframe},
+        pb::protos::{chart_server::Chart, Category, GetChartRequest, GetChartResponse, Timeframe},
     },
 };
 use tonic::{Request, Response, Status};

src/features/chart/service/mod.rs

@@ -2,7 +2,7 @@
 //!
 //! [`Chart`]: crate::features::chart::entities::Chart
 
-use crate::features::pb::chart::chart_server::ChartServer;
+use crate::features::pb::protos::chart_server::ChartServer;
 
 mod grpc;
 

src/features/chart/use_cases.rs

@@ -4,7 +4,7 @@ use crate::{
     app::AppContext,
     features::{
         chart::{entities::Chart, errors::ChartError, infrastructure::get_votes_summary},
-        pb::chart::{Category, Timeframe},
+        pb::protos::{Category, Timeframe},
     },
 };
 use tracing::error;