Merge pull request #30 from Virtual-Finland-Development/feat/general-data-product

Feat/general data product

Author: lsipii

.github/workflows/build-and-test.yml

@@ -19,12 +19,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Build 🔧
-        run: |
-          make build
-      - name: Test 🧪
+      - name: Test & Build 🧪🔧
         run: |
           make test
+          make build
       - name: Archive the build artifacts 🐪
         if: ${{ inputs.wants_artifacts }}
         uses: actions/upload-artifact@v3

Cargo.toml

@@ -18,11 +18,12 @@ itertools = "^0.10.5"
 libmath = "^0.2.1"
 stopwatch = "^0.0.7"
 utoipa = "3"
+tokio = { version = "^1.21.2", features = ["full"] }
 
 [dependencies]
 hot-lib-reloader = { version = "^0.6", optional = true }
-tokio = { version = "^1.21.2", features = ["full"] }
 dotenv = "^0.15.0"
+tokio = { workspace = true }
 log = { workspace = true }
 simple_logger = { workspace = true }
 lambda_http = { workspace = true }

src/lib/api_app/Cargo.toml

@@ -19,6 +19,7 @@ itertools = { workspace = true }
 libmath = { workspace = true }
 stopwatch = { workspace = true }
 utoipa = { workspace = true }
+tokio = { workspace = true }
 lazy_static = "1.4.0"
 
 app = { path = "./src/lib/app" }

src/lib/api_app/src/api/routes/mod.rs

@@ -25,6 +25,7 @@ pub mod testbed;
         application::health_check,
         application::wake_up_external_services,
         testbed::engage_reverse_proxy_request,
+        testbed::get_general_data_product,
         testbed::productizers::figure::get_population,
         testbed::productizers::job::find_job_postings,
         testbed::productizers::user::fetch_user_profile,

src/lib/api_app/src/api/routes/testbed/mod.rs

@@ -1,19 +1,55 @@
-use std::collections::HashMap;
-use utoipa::ToSchema;
-
 use http::HeaderMap;
-use serde::{Deserialize, Serialize};
 use serde_json::Value as JSONValue;
 
-use crate::api::routes::application::get_external_service_bad_response;
-
 use app::{
     responses::{APIResponse, APIRoutingError, APIRoutingResponse},
     router::ParsedRequest,
 };
+
+use utils::api::{parse_path_param, parse_query_param};
+
+use crate::api::routes::application::get_external_service_bad_response;
+use serde::{Deserialize, Serialize};
+use std::collections::HashMap;
 use utils::api::get_cors_response_headers;
+use utoipa::ToSchema;
 
 pub mod productizers;
+pub mod testbed_utils;
+
+use testbed_utils::{access_control_check, service::post_data_product};
+
+#[utoipa::path(
+    post,
+    path = "/testbed/data-product/{data_product}",
+    request_body(content = Object, description = "Data product request", example = json!({
+        "lat": 60.192059,
+        "lon": 24.945831
+    })),
+    responses((status = 200, body = Object, description = "Data product response")),
+    params(
+        ("data_product" = str, Path, description = "Data product name", example = "draft/Weather/Current/Metric"),
+        ("source" = str, Query, description = "Data source name", example = "openweather")
+    ),
+)]
+pub async fn get_general_data_product(request: ParsedRequest) -> APIResponse {
+    log::debug!("Path: {:#?}", request.path);
+    log::debug!("Query: {:#?}", request.query);
+    log::debug!("Path params: {:#?}", request.path_params);
+
+    let path_params = request.path_params.clone();
+    let query = request.query.clone();
+
+    let data_product = parse_path_param(path_params, "data_product")?;
+    let data_source = parse_query_param(query, "source")?;
+
+    log::debug!("Data product: {:#?}", data_product);
+    log::debug!("Data source: {:#?}", data_source);
+
+    let result =
+        post_data_product(data_product.as_str(), data_source.as_str(), request).await?;
+    Ok(result)
+}
 
 #[derive(Deserialize, Serialize, Debug, ToSchema)]
 pub struct ProxyRequestInput {
@@ -69,24 +105,3 @@ pub async fn engage_reverse_proxy_request(request: ParsedRequest) -> APIResponse
         get_cors_response_headers(),
     ))
 }
-
-/**
- * Access control check
- *
- * @param proxy_destination_url
- * @returns {boolean} - true if access is denied
- */
-fn access_control_check(proxy_destination_url: &str) -> bool {
-    // Access control list check
-    let acl = ["https://consent.testbed.fi/", "https://gateway.testbed.fi/"];
-
-    let mut acl_is_satisfied = false;
-    for url in acl {
-        if proxy_destination_url.starts_with(url) {
-            acl_is_satisfied = true;
-            break;
-        }
-    }
-
-    !acl_is_satisfied
-}

src/lib/api_app/src/api/routes/testbed/productizers/figure/mod.rs

@@ -1,6 +1,6 @@
 use std::env;
 
-use super::parse_testbed_request_headers;
+use crate::api::routes::testbed::testbed_utils::parse_testbed_request_headers;
 
 use app::{requests::post_json_request, responses::APIResponse, router::ParsedRequest};
 

src/lib/api_app/src/api/routes/testbed/productizers/job/mod.rs

@@ -2,7 +2,7 @@ use http::{Method, StatusCode};
 use math::round;
 use std::{cmp::Ordering, collections::hash_map::DefaultHasher, env, hash::Hasher};
 
-use super::parse_testbed_request_headers;
+use crate::api::routes::testbed::testbed_utils::parse_testbed_request_headers;
 
 use app::{
     requests::engage_many_json_requests,

src/lib/api_app/src/api/routes/testbed/productizers/mod.rs

@@ -1,107 +1,5 @@
-use http::{HeaderMap, HeaderValue};
-use std::env;
-
-use app::{responses::APIRoutingError, router::ParsedRequest};
-use utils::environment::get_stage;
-
 pub mod figure;
 pub mod job;
 pub mod nsg;
 pub mod person;
 pub mod user;
-
-/**
- * Parses the authorization headers from the input request
- */
-fn parse_testbed_request_headers(request: ParsedRequest) -> Result<HeaderMap, APIRoutingError> {
-    // Prep auth header forwarding
-    let mut request_headers = HeaderMap::new();
-    request_headers.insert("Content-Type", HeaderValue::from_static("application/json"));
-    request_headers.insert(
-        "authorization",
-        request
-            .headers
-            .get("authorization")
-            .ok_or_else(|| {
-                APIRoutingError::UnprocessableEntity("No authorization header".to_string())
-            })?
-            .clone(),
-    );
-
-    if request.headers.contains_key("x-consent-token") {
-        request_headers.insert(
-            "x-consent-token",
-            request
-                .headers
-                .get("x-consent-token")
-                .ok_or_else(|| {
-                    APIRoutingError::UnprocessableEntity(
-                        "No x-consent-token header".to_string(),
-                    )
-                })?
-                .clone(),
-        );
-    }
-    Ok(request_headers)
-}
-
-/**
- * Builds the URI for the testbed data product
- */
-fn build_data_product_stage_uri(data_product: &str, data_source: &str) -> String {
-    let testbed_environment =
-        env::var("TESTBED_ENVIRONMENT").expect("TESTBED_ENVIRONMENT must be set");
-    build_data_product_uri(
-        data_product,
-        format!("{data_source}:{testbed_environment}").as_str(),
-    )
-}
-
-fn build_data_product_uri(data_product: &str, data_source: &str) -> String {
-    let mut testbed_base_url =
-        env::var("TESTBED_BASE_URL").expect("TESTBED_BASE_URL must be set");
-
-    if get_stage() == "local" {
-        // @TODO: needs a local testbed data product gw simulation
-        match data_product {
-            "test/lassipatanen/User/Profile" => {
-                testbed_base_url = env::var("USER_PROFILE_PRODUCTIZER_ENDPOINT")
-                    .expect("USER_PROFILE_PRODUCTIZER_ENDPOINT must be set");
-            }
-            "test/lsipii/User/StatusInfo" => {
-                testbed_base_url = env::var("USER_STATUS_INFO_PRODUCTIZER_ENDPOINT")
-                    .expect("USER_STATUS_INFO_PRODUCTIZER_ENDPOINT must be set");
-            }
-            "test/lsipii/User/StatusInfo/Write" => {
-                testbed_base_url = env::var("USER_STATUS_INFO_PRODUCTIZER_ENDPOINT")
-                    .expect("USER_STATUS_INFO_PRODUCTIZER_ENDPOINT must be set");
-            }
-            "draft/NSG/Agent/LegalEntity/NonListedCompany/Establishment/Write" => {
-                testbed_base_url = env::var("PRH_MOCK_PRODUCTIZER_ENDPOINT")
-                    .expect("PRH_MOCK_PRODUCTIZER_ENDPOINT must be set");
-            }
-            "draft/NSG/Agent/LegalEntity/NonListedCompany/BeneficialOwners" => {
-                testbed_base_url = env::var("PRH_MOCK_PRODUCTIZER_ENDPOINT")
-                    .expect("PRH_MOCK_PRODUCTIZER_ENDPOINT must be set");
-            }
-            "draft/NSG/Agent/LegalEntity/NonListedCompany/SignatoryRights" => {
-                testbed_base_url = env::var("PRH_MOCK_PRODUCTIZER_ENDPOINT")
-                    .expect("PRH_MOCK_PRODUCTIZER_ENDPOINT must be set");
-            }
-            "draft/NSG/Agent/BasicInformation" => {
-                if data_source.starts_with("virtualfinland") {
-                    testbed_base_url = env::var("PRH_MOCK_PRODUCTIZER_ENDPOINT")
-                        .expect("PRH_MOCK_PRODUCTIZER_ENDPOINT must be set");
-                }
-            }
-            _ => {}
-        }
-    }
-
-    // Remove trailing slash from base url
-    if testbed_base_url.ends_with('/') {
-        testbed_base_url.pop();
-    }
-
-    format!("{testbed_base_url}/{data_product}?source={data_source}")
-}

src/lib/api_app/src/api/routes/testbed/productizers/nsg/basic_information.rs

@@ -4,13 +4,13 @@ use app::{
     router::ParsedRequest,
 };
 use serde::{Deserialize, Serialize};
-use serde_json::Value as JSONValue;
 use utils::api::get_default_headers;
 use utoipa::ToSchema;
 
-use crate::api::routes::testbed::productizers::{
-    build_data_product_stage_uri, build_data_product_uri,
+use crate::api::routes::testbed::testbed_utils::{
+    build_data_product_staged_uri, build_data_product_uri,
 };
+use serde_json::Value as JSONValue;
 
 #[derive(Deserialize, Serialize, Debug, PartialEq, Eq, Clone, ToSchema)]
 pub struct NSGAgentBasicInformationRequest {
@@ -62,7 +62,7 @@ pub async fn get_nsg_basic_information(request: ParsedRequest) -> APIResponse {
                 "Missing source parameter".to_string(),
             ));
         }
-        "virtualfinland" => build_data_product_stage_uri(data_product, data_source),
+        "virtualfinland" => build_data_product_staged_uri(data_product, data_source),
         _ => build_data_product_uri(data_product, data_source),
     };
 

src/lib/api_app/src/api/routes/testbed/productizers/nsg/mod.rs

@@ -1,25 +1,2 @@
-use serde_json::{json, Value as JSONValue};
-
-use app::{requests::post_json_request, responses::APIResponse, router::ParsedRequest};
-
-use super::{build_data_product_stage_uri, parse_testbed_request_headers};
-
 pub mod basic_information;
 pub mod non_listed_company;
-
-pub async fn post_data_product(
-    data_product: &str,
-    data_source: &str,
-    request: ParsedRequest,
-) -> APIResponse {
-    let request_input: JSONValue =
-        serde_json::from_str(request.body.as_str()).unwrap_or_else(|_| json!({}));
-    let request_headers = parse_testbed_request_headers(request)?;
-    let response = post_json_request::<JSONValue, JSONValue>(
-        build_data_product_stage_uri(data_product, data_source),
-        &request_input,
-        request_headers,
-    )
-    .await?;
-    Ok(response)
-}