Merge branch 'features/cache' of github.com:thuan2172001/rust-api-server into HEAD

thuan2172001 · thuan2172001 · commit 53090439cf1f · 2024-05-19T16:06:17.000+07:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Dockerfile b/Dockerfile
@@ -20,11 +20,13 @@ COPY . .
 RUN cargo build --release --all
 RUN mv target/${CARGO_BUILD_TARGET}/release /out
 
-FROM scratch AS prod
+FROM alpine AS dev
 WORKDIR /user
 COPY src/public/config/00-default.toml 00-default.toml
 COPY --from=builder /out/cli /usr/local/bin/rust-server
-ENTRYPOINT ["/usr/local/bin/rust-server", "--config-path=*.toml"]
+COPY --from=bunyan /root/.cargo/bin/bunyan /usr/local/bin/
+ENTRYPOINT ["/bin/sh"]
+CMD ["-c", "/usr/local/bin/rust-server --config-path=*.toml | bunyan"]
 
 FROM alpine AS dev
 WORKDIR /user
@@ -33,3 +35,15 @@ COPY --from=builder /out/cli /usr/local/bin/rust-server
 COPY --from=bunyan /root/.cargo/bin/bunyan /usr/local/bin/
 ENTRYPOINT ["/bin/sh"]
 CMD ["-c", "/usr/local/bin/rust-server --config-path=*.toml | bunyan"]
+
+FROM scratch AS prod
+WORKDIR /user
+COPY src/public/config/00-default.toml 00-default.toml
+COPY --from=builder /out/cli /usr/local/bin/rust-server
+ENTRYPOINT ["/usr/local/bin/rust-server", "--config-path=*.toml"]
+
+FROM scratch AS prod
+WORKDIR /user
+COPY src/public/config/00-default.toml 00-default.toml
+COPY --from=builder /out/cli /usr/local/bin/rust-server
+ENTRYPOINT ["/usr/local/bin/rust-server", "--config-path=*.toml"]
diff --git a/Makefile b/Makefile
@@ -30,10 +30,12 @@ build:
 	BUILD_RELEASE=$(shell git describe --tags --abbrev=0)
 	BUILDKIT_PROGRESS=plain
 	DOCKER_BUILDKIT=1
-	docker build --ssh default -t $(PKG_NAME):$(BUILD_VERSION) --target=prod .
+	docker build -t $(PKG_NAME):$(BUILD_VERSION) --target=public-prod .
+	docker build -t $(PKG_NAME):$(BUILD_VERSION) --target=gpt-prod .
 
 build-dev:
-	BUILDKIT_PROGRESS=plain DOCKER_BUILDKIT=1 docker build --ssh default -t $(PKG_NAME):$(BUILD_VERSION) --target=dev .
+	BUILDKIT_PROGRESS=plain DOCKER_BUILDKIT=1 docker build -t $(PKG_NAME):$(BUILD_VERSION) --target=public-dev .
+	BUILDKIT_PROGRESS=plain DOCKER_BUILDKIT=1 docker build -t $(PKG_NAME):$(BUILD_VERSION) --target=gpt-dev .
 
 profiling-public:
 	CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph --root -- -c ./src/public/config/* -c ./deploy/local/custom.toml
diff --git a/README.md b/README.md
@@ -95,17 +95,17 @@ options:
 
 Hierarchical child config via env, separated by using `__`. Specify list values by using `,` separator
 
-| ENV                                                                      | DEFAULT VALUE | NOTE      |
-| ------------------------------------------------------------------------ | ------------- | --------- |
-| [RUST_LOG](https://docs.rs/env_logger/latest/env_logger/) > LOG\_\_LEVEL | "INFO"        | Log level |
-| SERVER\_\_URL                                                            |               |           |
-| SERVER\_\_PORT                                                           |               |           |
-| SERVICE_NAME                                                             |               |           |
-| EXPORTER_ENDPOINT                                                        |               |           |
-| DB\_\_PG\_\_URL                                                          | "LOCALHOST"   |           |
-| DB\_\_PG\_\_MAX_SIZE                                                     | "5432"        |           |
-| REDIS\_\_HOST                                                            | "LOCALHOST"   |           |
-| REDIS\_\_PORT                                                            | "6379"        |           |
+| ENV                                                                    | DEFAULT VALUE | NOTE      |
+|------------------------------------------------------------------------|---------------|-----------|
+| [RUST_LOG](https://docs.rs/env_logger/latest/env_logger/) > LOG__LEVEL | "INFO"        | Log level |
+| SERVER\_\_URL                                                          |               |           |
+| SERVER\_\_PORT                                                         |               |           |
+| SERVICE_NAME                                                           |               |           |
+| EXPORTER_ENDPOINT                                                      |               |           |
+| DB\_\_PG\_\_URL                                                        | "localhost"   |           |
+| DB\_\_PG\_\_MAX_SIZE                                                   | 5432          |           |
+| REDIS\_\_HOST                                                          | "localhost"   |           |
+| REDIS\_\_PORT                                                          | 6379          |           |
 
 Make sure to set these environment variables according to your needs before running the server.
 
diff --git a/deploy/docker/01_public_custom.toml b/deploy/docker/01_public_custom.toml
diff --git a/deploy/docker/docker-compose.yaml b/deploy/docker/docker-compose.yaml
@@ -48,7 +48,7 @@ services:
     ports:
       - "8888:8888"
     volumes:
-      - ./01_public_custom.toml:/user/01-custom.toml:ro
+      - ./01_public_custom.toml:/user/01_custom.toml:ro
   gpt_answer_server:
     image: gpt_answer_server
     build:
@@ -57,7 +57,7 @@ services:
     ports:
       - "9999:9999"
     volumes:
-      - ./01_gpt_answer_server_custom.toml.toml:/user/01-custom.toml:ro
+      - ./01_gpt_answer_server_custom.toml.toml:/user/01_custom.toml:ro
 volumes:
   postgres:
   redis:
diff --git a/src/adapter/Cargo.toml b/src/adapter/Cargo.toml
@@ -25,27 +25,27 @@ version = "2.1.0"
 version = "0.1.80"
 
 [dependencies.deadpool-diesel]
-version = "0.6.0"
+version = "0.6.1"
 features = ["postgres", "serde"]
 
 [dependencies.diesel]
-version = "2.1.4"
+version = "2.1.6"
 features = ["postgres", "postgres_backend", "uuid"]
 
 [dependencies.serde]
 version = "1.0"
 features = ["derive"]
 
 [dependencies.testcontainers-modules]
-version = "0.3.7"
+version = "0.4.3"
 features = ["postgres", "redis"]
 
 [dependencies.tokio]
 version = "1.36.0"
 features = ["full"]
 
 [dependencies.anyhow]
-version = "1.0.82"
+version = "1.0.83"
 
 [dependencies.tonic]
 version = "0.11.0"
diff --git a/src/adapter/src/repositories/redis/cache.rs b/src/adapter/src/repositories/redis/cache.rs
@@ -15,12 +15,12 @@ impl RedisCache {
     ///
     /// # Arguments
     ///
-    /// * redis_host: Hostname or IP address of the Redis server.
-    /// * redis_port: Port number of the Redis server.
+    /// * `redis_host`: Hostname or IP address of the Redis server.
+    /// * `redis_port`: Port number of the Redis server.
     ///
     /// # Returns
     ///
-    /// Returns a Result containing the initialized RedisCache instance.
+    /// Returns a `Result` containing the initialized `RedisCache` instance.
     pub async fn new(redis_host: &str, redis_port: u16) -> Result<Self, CoreError> {
         client::paired_connect(redis_host, redis_port)
             .await
@@ -35,7 +35,7 @@ impl CachePort for RedisCache {
     ///
     /// # Arguments
     ///
-    /// * key: The key of the value to retrieve.
+    /// * `key`: The key of the value to retrieve.
     ///
     /// # Returns
     ///
diff --git a/src/adapter/src/repositories/repository_test.rs b/src/adapter/src/repositories/repository_test.rs
@@ -8,7 +8,8 @@ mod question_repository_tests {
         Manager,
     };
     use diesel_migrations::MigrationHarness;
-    use testcontainers_modules::{postgres::Postgres, testcontainers::clients::Cli};
+    use testcontainers_modules::postgres::Postgres;
+    use testcontainers_modules::testcontainers::runners::AsyncRunner;
 
     use rust_core::{
         entities::{
@@ -89,12 +90,11 @@ mod question_repository_tests {
     #[tokio::test]
     async fn question_postgres_repository_test() {
         // Set up a postgres database question port for testing
-        let docker = Cli::default();
-        let postgres_instance = docker.run(Postgres::default());
+        let postgres_instance = Postgres::default().start().await;
 
         let database_url = format!(
             "postgres://postgres:postgres@127.0.0.1:{}/postgres",
-            postgres_instance.get_host_port_ipv4(5432)
+            postgres_instance.get_host_port_ipv4(5432).await
         );
         let database_config = DatabaseConfig {
             url: database_url.clone(),
@@ -130,11 +130,15 @@ mod question_repository_tests {
 mod cache_repository_tests {
     use std::time::Duration;
 
-    use crate::repositories::{in_memory::cache::InMemoryCache, redis::cache::RedisCache};
-    use rust_core::ports::cache::CachePort;
-    use testcontainers_modules::{redis::Redis, testcontainers::clients::Cli};
+    use testcontainers_modules::redis::Redis;
+    use testcontainers_modules::testcontainers::runners::AsyncRunner;
     use tokio::time::sleep;
 
+    use rust_core::common::errors::CoreError;
+    use rust_core::ports::cache::CachePort;
+
+    use crate::repositories::{in_memory::cache::InMemoryCache, redis::cache::RedisCache};
+
     async fn test_cache_operations<C: CachePort>(mut cache: C) {
         let test_key = "key1";
         let test_value = "value1";
@@ -155,22 +159,25 @@ mod cache_repository_tests {
 
         // Verify that test_key" is deleted and cannot retrievable
         let get_result = cache.get(&test_key).await;
-        assert!(get_result.is_err());
+        assert!(matches!(get_result, Err(CoreError::NotFound)));
 
         // Test deleting a non-existing key
         let del_result = cache.del("non_existing_key").await;
-        assert!(del_result.is_err());
+        assert!(matches!(del_result, Err(CoreError::NotFound)));
 
         // Test set operation for test_key with limit expiration time
         let set_result = cache
             .set(&test_key, &test_value, Some(Duration::from_secs(1)))
             .await;
         assert!(set_result.is_ok());
 
+        let set_result = cache.get(&test_key).await;
+        assert!(set_result.is_ok());
+
         // Test get an expired key
         sleep(Duration::from_secs(1)).await;
         let get_result = cache.get(&test_key).await;
-        assert!(get_result.is_err());
+        assert!(matches!(get_result, Err(CoreError::NotFound)));
     }
 
     #[tokio::test]
@@ -181,10 +188,9 @@ mod cache_repository_tests {
 
     #[tokio::test]
     async fn test_redis_cache_operations() {
-        let docker = Cli::default();
-        let redis_cache = docker.run(Redis::default());
+        let redis_instance = Redis::default().start().await;
         let host = "127.0.0.1";
-        let port = redis_cache.get_host_port_ipv4(6379);
+        let port = redis_instance.get_host_port_ipv4(6379).await;
         let cache = RedisCache::new(host, port).await.unwrap();
         test_cache_operations(cache).await;
     }
diff --git a/src/common/Cargo.toml b/src/common/Cargo.toml
@@ -34,7 +34,7 @@ version = "0.15.0"
 features = ["tonic"]
 
 [dependencies.opentelemetry-semantic-conventions]
-version = "0.14.0"
+version = "0.15.0"
 
 [dependencies.opentelemetry_sdk]
 version = "0.22.1"
@@ -48,6 +48,9 @@ features = ["derive"]
 version = "0.3.18"
 features = ["env-filter"]
 
+[dependencies.tokio]
+version = "1.37.0"
+
 [dependencies.tonic]
 version = "0.11.0"
 
diff --git a/src/common/src/kill_signals.rs b/src/common/src/kill_signals.rs
@@ -0,0 +1,30 @@
+use tokio::signal;
+use tracing::info;
+
+pub async fn wait_for_kill_signals() {
+    let ctrl_c = async {
+        signal::ctrl_c()
+            .await
+            .expect("Failed to install Ctrl+C handler");
+    };
+
+    #[cfg(unix)]
+    let terminate = async {
+        signal::unix::signal(signal::unix::SignalKind::terminate())
+            .expect("Failed to install signal handler")
+            .recv()
+            .await;
+    };
+
+    #[cfg(not(unix))]
+    let terminate = std::future::pending::<()>();
+
+    tokio::select! {
+        _ = ctrl_c => {
+                info!("Received ctrl_c!");
+        },
+        _ = terminate => {
+                info!("Received terminate!");
+        },
+    }
+}
diff --git a/src/common/src/lib.rs b/src/common/src/lib.rs
@@ -1,3 +1,4 @@
 pub mod grpc;
+pub mod kill_signals;
 pub mod loggers;
 pub mod options;
diff --git a/src/core/Cargo.toml b/src/core/Cargo.toml
@@ -20,7 +20,7 @@ version = "1.0"
 features = ["derive"]
 
 [dependencies.thiserror]
-version = "1.0.57"
+version = "1.0.60"
 
 [dependencies.anyhow]
-version = "1.0.82"
+version = "1.0.83"
diff --git a/src/gpt_answer_server/src/main.rs b/src/gpt_answer_server/src/main.rs
@@ -2,16 +2,20 @@ use std::sync::Arc;
 
 use clap::{Parser, Subcommand};
 use opentelemetry::global;
+use tokio::sync::oneshot;
+use tokio::sync::oneshot::Receiver;
 use tonic::transport::Server;
+use tracing::info;
 
 use adapter::repositories::redis::cache::RedisCache;
 use common::grpc::gpt_answer::gpt_answer::gpt_answer_service_server::GptAnswerServiceServer;
+use common::kill_signals;
 use common::loggers::telemetry::init_telemetry;
 use common::options::parse_options;
 use gpt_answer_server::controllers::gpt_answer::GptAnswerServiceImpl;
 use gpt_answer_server::options::Options;
 
-pub async fn serve(options: Options) {
+pub async fn serve(options: Options, rx: Receiver<()>) {
     let address = options.server_endpoint.parse().unwrap();
     println!("Starting GPT Answer server at {}", options.server_endpoint);
 
@@ -23,7 +27,10 @@ pub async fn serve(options: Options) {
 
     Server::builder()
         .add_service(GptAnswerServiceServer::new(gpt_answer_service))
-        .serve(address)
+        .serve_with_shutdown(address, async {
+            rx.await.ok();
+            info!("GRPC server shut down");
+        })
         .await
         .unwrap();
 }
@@ -55,11 +62,17 @@ async fn main() {
         options.log.level.as_str(),
     );
 
-    let server = tokio::spawn(serve(options));
+    let (tx, rx) = oneshot::channel();
+    let server = tokio::spawn(serve(options, rx));
 
-    tokio::try_join!(server).expect("Failed to run servers");
+    kill_signals::wait_for_kill_signals().await;
+
+    // Send the shutdown signal
+    let _ = tx.send(());
+    tokio::try_join!(server).expect("Failed to run server");
 
     global::shutdown_tracer_provider();
+    info!("Shutdown successfully!");
 }
 
 /// GPT Answer GRPC server.
diff --git a/src/public/Cargo.toml b/src/public/Cargo.toml
@@ -82,11 +82,11 @@ version = "4.4.7"
 features = ["derive"]
 
 [dependencies.deadpool-diesel]
-version = "0.6.0"
+version = "0.6.1"
 features = ["postgres", "serde"]
 
 [dependencies.diesel]
-version = "2.1.0"
+version = "2.1.6"
 features = ["postgres", "postgres_backend", "uuid"]
 
 [dependencies.openssl]
@@ -100,18 +100,18 @@ version = "1.0"
 features = ["derive"]
 
 [dependencies.testcontainers-modules]
-version = "0.3.7"
+version = "0.4.3"
 features = ["postgres", "redis"]
 
 [dependencies.tokio]
 version = "1.36.0"
 features = ["full"]
 
 [dependencies.thiserror]
-version = "1.0.57"
+version = "1.0.60"
 
 [dependencies.anyhow]
-version = "1.0.82"
+version = "1.0.83"
 
 [lib]
 path = "src/lib.rs"
diff --git a/src/public/src/main.rs b/src/public/src/main.rs
diff --git a/src/public/tests/questions_router_test.rs b/src/public/tests/questions_router_test.rs
