Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add http-handler binding type #1253

Merged
merged 4 commits into from
Jan 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ git-version = "0.3.9"
golem-wit = { version = "=1.1.2" }
hex = "0.4.3"
http = "1.2.0" # keep in sync with wasmtime
http-body = "1.0.1" # keep in sync with wasmtime
http-body-util = "0.1.0" # keep in sync with wasmtime
humansize = "2.1.3"
humantime-serde = "1.1.1"
hyper = { version = "1.5.1", features = ["full"] } # keep in sync with wasmtime
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ enum GatewayBindingType {
FILE_SERVER = 1;
CORS_PREFLIGHT = 2;
AUTH_CALL_BACK = 3;
HTTP_HANDLER = 4;
}

// Used in api definition repo and needs to be backward compatible
Expand Down
132 changes: 132 additions & 0 deletions golem-cli/tests/api_deployment_http_handler.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
// Copyright 2024-2025 Golem Cloud
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::cli::{Cli, CliLive};
use crate::Tracing;
use golem_cli::model::component::ComponentView;
use golem_client::model::{ApiDeployment, HttpApiDefinitionRequest, HttpApiDefinitionResponseData};
use golem_common::model::ComponentId;
use golem_common::uri::oss::urn::WorkerUrn;
use golem_test_framework::config::{EnvBasedTestDependencies, TestDependencies};
use std::io::Write;
use std::sync::Arc;
use test_r::{inherit_test_dep, test, test_dep};

inherit_test_dep!(EnvBasedTestDependencies);
inherit_test_dep!(Tracing);

#[test_dep]
fn cli(deps: &EnvBasedTestDependencies) -> CliLive {
CliLive::make("api_deployment", Arc::new(deps.clone())).unwrap()
}

#[test]
async fn api_deployment_http_handler(
deps: &EnvBasedTestDependencies,
cli: &CliLive,
) -> anyhow::Result<()> {
let host = format!(
"localhost:{}",
deps.worker_service().private_custom_request_port()
);
let component_name = "wasi-http-incoming-request-handler-echo".to_string();
let golem_yaml = deps
.component_directory()
.join("wasi-http-incoming-request-handler-echo/golem.yaml");
let cfg = &cli.config;
let component: ComponentView = cli.run_trimmed(&[
"component",
"add",
&cfg.arg('a', "app"),
golem_yaml.to_str().unwrap(),
&cfg.arg('c', "component-name"),
&component_name,
])?;
let component_urn = component.component_urn;
let component_id = component_urn.id.clone();

let worker_name = format!("{component_name}-worker");

let _: WorkerUrn = cli.run(&[
"worker",
"add",
&cfg.arg('w', "worker-name"),
&worker_name,
&cfg.arg('C', "component"),
&component_urn.to_string(),
])?;

let temp_dir = tempfile::tempdir()?;
let api_definition = make_http_handler_api_definition(&component_id, &worker_name)?;
let api_path = temp_dir.path().join("api-definition.json");
{
let mut api_file = std::fs::File::create_new(&api_path)?;
let mut writer = std::io::BufWriter::new(&mut api_file);
serde_json::to_writer(&mut writer, &api_definition)?;
writer.flush()?;
}

let definition: HttpApiDefinitionResponseData =
cli.run(&["api-definition", "add", api_path.to_str().unwrap()])?;

let _: ApiDeployment = cli.run(&[
"api-deployment",
"deploy",
&cfg.arg('d', "definition"),
&format!("{}/{}", definition.id, definition.version),
&cfg.arg('H', "host"),
&host,
])?;

let res = {
let client = reqwest::Client::new();

client
.post(format!("http://{host}/test?foo=baz"))
.header("test-header", "test-header-value")
.body("\"test-body\"")
.send()
.await
}?;
assert_eq!(res.status().as_u16(), 200);
assert_eq!(
res.headers().get("echo-test-header").unwrap(),
"\"test-header-value\""
);
assert_eq!(res.text().await?, "\"test-body\"");

Ok(())
}

fn make_http_handler_api_definition(
component_id: &ComponentId,
worker_name: &str,
) -> anyhow::Result<HttpApiDefinitionRequest> {
Ok(serde_yaml::from_str(&format!(
r#"
id: "{component_id}"
version: "0.1.0"
draft: true
routes:
- method: Post
path: "/test"
binding:
bindingType: http-handler
componentId:
componentId: '{component_id}'
version: 0
workerName: 'let name: string = "{worker_name}"; name'
mschuwalow marked this conversation as resolved.
Show resolved Hide resolved
"#,
))?)
}
1 change: 1 addition & 0 deletions golem-cli/tests/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ pub mod cli;
mod api_definition;
mod api_deployment;
mod api_deployment_fileserver;
mod api_deployment_http_handler;
mod component;
mod get;
mod profile;
Expand Down
1 change: 1 addition & 0 deletions golem-common/src/model/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2186,6 +2186,7 @@ pub enum GatewayBindingType {
#[default]
Default,
FileServer,
HttpHandler,
CorsPreflight,
}

Expand Down
6 changes: 6 additions & 0 deletions golem-common/src/model/protobuf.rs
Original file line number Diff line number Diff line change
Expand Up @@ -736,6 +736,9 @@ impl From<golem_api_grpc::proto::golem::apidefinition::GatewayBindingType> for G
golem_api_grpc::proto::golem::apidefinition::GatewayBindingType::FileServer => {
GatewayBindingType::FileServer
}
golem_api_grpc::proto::golem::apidefinition::GatewayBindingType::HttpHandler => {
GatewayBindingType::HttpHandler
}
golem_api_grpc::proto::golem::apidefinition::GatewayBindingType::CorsPreflight => {
GatewayBindingType::CorsPreflight
}
Expand All @@ -755,6 +758,9 @@ impl From<GatewayBindingType> for golem_api_grpc::proto::golem::apidefinition::G
GatewayBindingType::FileServer => {
golem_api_grpc::proto::golem::apidefinition::GatewayBindingType::FileServer
}
GatewayBindingType::HttpHandler => {
golem_api_grpc::proto::golem::apidefinition::GatewayBindingType::HttpHandler
}
GatewayBindingType::CorsPreflight => {
golem_api_grpc::proto::golem::apidefinition::GatewayBindingType::CorsPreflight
}
Expand Down
Loading
Loading