Delete example code, and move prod code into functional separation (#16)

* Clean up example code

Signed-off-by: José Ulises Niño Rivera <junr03@users.noreply.github.com>

* clean

Signed-off-by: José Ulises Niño Rivera <junr03@users.noreply.github.com>

* rename

---------

Signed-off-by: José Ulises Niño Rivera <junr03@users.noreply.github.com>
Co-authored-by: Adil Hafeez <adil@katanemo.com>
This commit is contained in:
José Ulises Niño Rivera 2024-07-21 23:22:47 -07:00 committed by GitHub
parent 5b4143d580
commit 7ae2d918e8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,6 +1,7 @@
use common_types::CreateEmbeddingRequest;
use common_types::EmbeddingRequest;
use configuration::PromptTarget;
use log::info;
use log::warn;
use serde_json::to_string;
use stats::IncrementingMetric;
use stats::Metric;
@ -20,289 +21,132 @@ mod stats;
proxy_wasm::main! {{
proxy_wasm::set_log_level(LogLevel::Trace);
proxy_wasm::set_root_context(|_| -> Box<dyn RootContext> {
Box::new(FilterContext {
callouts: HashMap::new(),
config: None,
metrics: WasmMetrics {
counter: stats::Counter::new(String::from("wasm_counter")),
gauge: stats::Gauge::new(String::from("wasm_gauge")),
histogram: stats::Histogram::new(String::from("wasm_histogram")),
},
})
Box::new(FilterContext::new())
});
}}
struct StreamContext {
context_id: u32,
config: configuration::Configuration,
metrics: WasmMetrics,
host_header: Option<String>,
}
impl StreamContext {
fn save_host_header(&mut self) {
// Save the host header to be used by filter logic later on.
self.host_header = self.get_http_request_header(":host");
}
fn delete_content_length_header(&mut self) {
// Remove the Content-Length header because further body manipulations in the gateway logic will invalidate it.
// Server's generally throw away requests whose body length do not match the Content-Length header.
// However, a missing Content-Length header is not grounds for bad requests given that intermediary hops could
// manipulate the body in benign ways e.g., compression.
self.set_http_request_header("content-length", None);
}
fn modify_path_header(&mut self) {
match self.get_http_request_header(":path") {
// The gateway can start gathering information necessary for routing. For now change the path to an
// OpenAI API path.
Some(path) if path == "/llmrouting" => {
self.set_http_request_header(":path", Some("/v1/chat/completions"));
}
// Otherwise let the filter continue.
_ => (),
}
}
}
// HttpContext is the trait that allows the Rust code to interact with HTTP objects.
impl HttpContext for StreamContext {
// Envoy's HTTP model is event driven. The WASM ABI has given implementors events to hook onto
// the lifecycle of the http request and response.
fn on_http_request_headers(&mut self, _num_headers: usize, _end_of_stream: bool) -> Action {
// Read config
info!("config: {:?}", self.config.prompt_config.system_prompt);
// Metrics
self.metrics.counter.increment(10);
info!("counter -> {}", self.metrics.counter.value());
self.metrics.gauge.record(20);
info!("gauge -> {}", self.metrics.gauge.value());
self.metrics.histogram.record(30);
// info!("histogram -> {}", self.metrics.histogram.value());
self.save_host_header();
self.delete_content_length_header();
self.modify_path_header();
// Example of reading the HTTP headers on the incoming request
for (name, value) in &self.get_http_request_headers() {
info!("#{} -> {}: {}", self.context_id, name, value);
}
// Save the host header to be used by filter logic later on.
self.host_header = self.get_http_request_header(":host");
// Remove the Content-Length header because further body manipulations in the gateway logic will invalidate it.
// Server's generally throw away requests whose body length do not match the Content-Length header.
// However, a missing Content-Length header is not grounds for bad requests given that intermediary hops could
// manipulate the body in benign ways e.g., compression.
self.set_http_request_header("content-length", None);
// Example logic of branching based on a request header.
match self.get_http_request_header(":path") {
// If the path header is present and the path is /inline
Some(path) if path == "/inline" => {
// Dispatch an HTTP call inline. This is the model that we will use for the LLM routing host.
self.dispatch_http_call(
"httpbin",
vec![
(":method", "GET"),
(":path", "/bytes/1"),
(":authority", "httpbin.org"),
],
None,
vec![],
Duration::from_secs(5),
)
.unwrap();
// Pause the filter until the out of band HTTP response arrives.
Action::Pause
}
// The gateway can start gathering information necessary for routing. For now change the path to an
// OpenAI API path.
Some(path) if path == "/llmrouting" => {
self.set_http_request_header(":path", Some("/v1/chat/completions"));
Action::Continue
}
// Otherwise let the filter continue.
_ => Action::Continue,
}
Action::Continue
}
fn on_http_request_body(&mut self, body_size: usize, end_of_stream: bool) -> Action {
// Let the filter continue if the request is not meant for OpenAi
match &self.host_header {
Some(host) if host != "api.openai.com" => return Action::Continue,
_ => {}
}
// Let the client send the gateway all the data before sending to the LLM_provider
// Let the client send the gateway all the data before sending to the LLM_provider.
// TODO: consider a streaming API.
if !end_of_stream {
return Action::Pause;
}
if let Some(body_bytes) = self.get_http_request_body(0, body_size) {
let mut deserialized: llm_backend::ChatCompletions =
match serde_json::from_slice(&body_bytes) {
if body_size == 0 {
return Action::Continue;
}
// Deserialize body into spec.
// Currently OpenAI API.
let mut deserialized_body: llm_backend::ChatCompletions =
match self.get_http_request_body(0, body_size) {
Some(body_bytes) => match serde_json::from_slice(&body_bytes) {
Ok(deserialized) => deserialized,
Err(msg) => panic!("Failed to deserialize: {}", msg),
};
},
None => panic!(
"Failed to obtain body bytes even though body_size is {}",
body_size
),
};
warn!("deserialized body = {:?}", deserialized);
// Modify JSON payload
deserialized_body.model = String::from("gpt-3.5-turbo");
let json_string = serde_json::to_string(&deserialized_body).unwrap();
// This is the big moment here: the user did not set the model in their request.
// The gateway is setting the model for them.
deserialized.model = String::from("gpt-3.5-turbo");
let json_string = serde_json::to_string(&deserialized).unwrap();
self.set_http_request_body(0, body_size, &json_string.into_bytes());
warn!("serialized json = {}", json_string);
self.set_http_request_body(0, body_size, &json_string.into_bytes())
}
Action::Continue
}
fn on_http_response_headers(&mut self, _: usize, _: bool) -> Action {
self.set_http_response_header("Powered-By", Some("Katanemo"));
Action::Continue
}
}
impl Context for StreamContext {
// Note that the event driven model continues here from the return of the on_http_request_headers above.
fn on_http_call_response(&mut self, _: u32, _: usize, body_size: usize, _: usize) {
info!("on_http_call_response: body_size = {}", body_size);
if let Some(body) = self.get_http_call_response_body(0, body_size) {
if !body.is_empty() && body[0] % 2 == 0 {
info!("Access granted.");
// This call allows the filter to continue operating on the HTTP request sent by the user.
// In Katanemo's use case the call would continue after the LLM host has responded with routing
// decisions.
self.resume_http_request();
return;
}
}
info!("Access forbidden.");
// This is an example of short-circuiting the http request and sending back a response to the client.
// i.e there was never an external HTTP request made. This could be used for example if the user prompt requires
// more information before it can be sent out to a third party API.
self.send_http_response(
403,
vec![("Powered-By", "Katanemo")],
Some(b"Access forbidden.\n"),
);
}
}
impl Context for StreamContext {}
#[derive(Copy, Clone)]
struct WasmMetrics {
counter: stats::Counter,
gauge: stats::Gauge,
histogram: stats::Histogram,
// TODO: remove example metrics once real ones are created. These ones exist in order to silence the dead code warning.
example_counter: stats::Counter,
example_gauge: stats::Gauge,
example_histogram: stats::Histogram,
}
impl WasmMetrics {
fn new() -> WasmMetrics {
let new_metrics = WasmMetrics {
example_counter: stats::Counter::new(String::from("example_counter")),
example_gauge: stats::Gauge::new(String::from("example_gauge")),
example_histogram: stats::Histogram::new(String::from("example_histogram")),
};
new_metrics.example_counter.increment(10);
new_metrics.example_counter.value();
new_metrics.example_gauge.record(20);
new_metrics.example_histogram.record(30);
new_metrics
}
}
struct FilterContext {
metrics: WasmMetrics,
_metrics: WasmMetrics,
// callouts stores token_id to request mapping that we use during #on_http_call_response to match the response to the request.
callouts: HashMap<u32, common_types::CalloutData>,
config: Option<configuration::Configuration>,
}
impl Context for FilterContext {
fn on_http_call_response(
&mut self,
token_id: u32,
_num_headers: usize,
body_size: usize,
_num_trailers: usize,
) {
info!("on_http_call_response: token_id = {}", token_id);
let callout_data = self.callouts.remove(&token_id).expect("invalid token_id");
match callout_data.message {
common_types::MessageType::EmbeddingRequest(common_types::EmbeddingRequest {
create_embedding_request,
prompt_target,
}) => {
info!("response received for CreateEmbeddingRequest");
if let Some(body) = self.get_http_call_response_body(0, body_size) {
if !body.is_empty() {
let embedding_response: common_types::CreateEmbeddingResponse =
serde_json::from_slice(&body).unwrap();
info!(
"embedding_response model: {}, vector len: {}",
embedding_response.model,
embedding_response.data[0].embedding.len()
);
let mut payload: HashMap<String, String> = HashMap::new();
payload.insert(
"prompt-target".to_string(),
to_string(&prompt_target).unwrap(),
);
payload.insert(
"few-shot-example".to_string(),
create_embedding_request.input.clone(),
);
let id = md5::compute(create_embedding_request.input);
let create_vector_store_points = common_types::CreateVectorStorePoints {
points: vec![common_types::VectorPoint {
id: format!("{:x}", id),
payload,
vector: embedding_response.data[0].embedding.clone(),
}],
};
let json_data = to_string(&create_vector_store_points).unwrap(); // Handle potential errors
info!(
"create_vector_store_points: points length: {}",
embedding_response.data[0].embedding.len()
);
let token_id = match self.dispatch_http_call(
"qdrant",
vec![
(":method", "PUT"),
(":path", "/collections/prompt_vector_store/points"),
(":authority", "qdrant"),
("content-type", "application/json"),
],
Some(json_data.as_bytes()),
vec![],
Duration::from_secs(5),
) {
Ok(token_id) => token_id,
Err(e) => {
panic!("Error dispatching HTTP call: {:?}", e);
}
};
info!("on_tick: dispatched HTTP call with token_id = {}", token_id);
let callout_message = common_types::CalloutData {
message: common_types::MessageType::CreateVectorStorePoints(
create_vector_store_points,
),
};
if self.callouts.insert(token_id, callout_message).is_some() {
panic!("duplicate token_id")
}
}
}
}
common_types::MessageType::CreateVectorStorePoints(_) => {
info!("response received for CreateVectorStorePoints");
if let Some(body) = self.get_http_call_response_body(0, body_size) {
if !body.is_empty() {
info!("response body: {:?}", String::from_utf8(body).unwrap());
}
}
}
impl FilterContext {
fn new() -> FilterContext {
FilterContext {
callouts: HashMap::new(),
config: None,
_metrics: WasmMetrics::new(),
}
}
}
// RootContext allows the Rust code to reach into the Envoy Config
impl RootContext for FilterContext {
fn on_configure(&mut self, _: usize) -> bool {
if let Some(config_bytes) = self.get_plugin_configuration() {
self.config = serde_yaml::from_slice(&config_bytes).unwrap();
info!("on_configure: plugin configuration loaded");
}
true
}
fn create_http_context(&self, context_id: u32) -> Option<Box<dyn HttpContext>> {
Some(Box::new(StreamContext {
context_id,
config: self.config.clone()?,
metrics: self.metrics,
host_header: None,
}))
}
fn get_type(&self) -> Option<ContextType> {
Some(ContextType::HttpContext)
}
fn on_vm_start(&mut self, _: usize) -> bool {
info!("on_vm_start: setting up tick timeout");
self.set_tick_period(Duration::from_secs(1));
true
}
fn on_tick(&mut self) {
info!("on_tick: starting to process prompt targets");
fn process_prompt_targets(&mut self) {
for prompt_target in &self.config.as_ref().unwrap().prompt_config.prompt_targets {
for few_shot_example in &prompt_target.few_shot_examples {
info!("few_shot_example: {:?}", few_shot_example);
@ -344,6 +188,143 @@ impl RootContext for FilterContext {
}
}
}
}
fn embedding_request_handler(
&mut self,
body_size: usize,
create_embedding_request: CreateEmbeddingRequest,
prompt_target: PromptTarget,
) {
info!("response received for CreateEmbeddingRequest");
if let Some(body) = self.get_http_call_response_body(0, body_size) {
if !body.is_empty() {
let embedding_response: common_types::CreateEmbeddingResponse =
serde_json::from_slice(&body).unwrap();
info!(
"embedding_response model: {}, vector len: {}",
embedding_response.model,
embedding_response.data[0].embedding.len()
);
let mut payload: HashMap<String, String> = HashMap::new();
payload.insert(
"prompt-target".to_string(),
to_string(&prompt_target).unwrap(),
);
payload.insert(
"few-shot-example".to_string(),
create_embedding_request.input.clone(),
);
let id = md5::compute(create_embedding_request.input);
let create_vector_store_points = common_types::CreateVectorStorePoints {
points: vec![common_types::VectorPoint {
id: format!("{:x}", id),
payload,
vector: embedding_response.data[0].embedding.clone(),
}],
};
let json_data = to_string(&create_vector_store_points).unwrap(); // Handle potential errors
info!(
"create_vector_store_points: points length: {}",
embedding_response.data[0].embedding.len()
);
let token_id = match self.dispatch_http_call(
"qdrant",
vec![
(":method", "PUT"),
(":path", "/collections/prompt_vector_store/points"),
(":authority", "qdrant"),
("content-type", "application/json"),
],
Some(json_data.as_bytes()),
vec![],
Duration::from_secs(5),
) {
Ok(token_id) => token_id,
Err(e) => {
panic!("Error dispatching HTTP call: {:?}", e);
}
};
info!("on_tick: dispatched HTTP call with token_id = {}", token_id);
let callout_message = common_types::CalloutData {
message: common_types::MessageType::CreateVectorStorePoints(
create_vector_store_points,
),
};
if self.callouts.insert(token_id, callout_message).is_some() {
panic!("duplicate token_id")
}
}
}
}
fn create_vector_store_points_worker(&self, body_size: usize) {
info!("response received for CreateVectorStorePoints");
if let Some(body) = self.get_http_call_response_body(0, body_size) {
if !body.is_empty() {
info!("response body: {:?}", String::from_utf8(body).unwrap());
}
}
}
}
impl Context for FilterContext {
fn on_http_call_response(
&mut self,
token_id: u32,
_num_headers: usize,
body_size: usize,
_num_trailers: usize,
) {
info!("on_http_call_response: token_id = {}", token_id);
let callout_data = self.callouts.remove(&token_id).expect("invalid token_id");
match callout_data.message {
common_types::MessageType::EmbeddingRequest(common_types::EmbeddingRequest {
create_embedding_request,
prompt_target,
}) => {
self.embedding_request_handler(body_size, create_embedding_request, prompt_target)
}
common_types::MessageType::CreateVectorStorePoints(_) => {
self.create_vector_store_points_worker(body_size)
}
}
}
}
// RootContext allows the Rust code to reach into the Envoy Config
impl RootContext for FilterContext {
fn on_configure(&mut self, _: usize) -> bool {
if let Some(config_bytes) = self.get_plugin_configuration() {
self.config = serde_yaml::from_slice(&config_bytes).unwrap();
info!("on_configure: plugin configuration loaded");
}
true
}
fn create_http_context(&self, _context_id: u32) -> Option<Box<dyn HttpContext>> {
Some(Box::new(StreamContext { host_header: None }))
}
fn get_type(&self) -> Option<ContextType> {
Some(ContextType::HttpContext)
}
fn on_vm_start(&mut self, _: usize) -> bool {
info!("on_vm_start: setting up tick timeout");
self.set_tick_period(Duration::from_secs(1));
true
}
fn on_tick(&mut self) {
info!("on_tick: starting to process prompt targets");
self.process_prompt_targets();
self.set_tick_period(Duration::from_secs(0));
}
}