1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0
*/
//! Python wrappers for Lambda related types.
use std::collections::HashMap;
use lambda_http::Context;
use pyo3::pyclass;
/// AWS Mobile SDK client fields.
#[pyclass(name = "ClientApplication")]
#[derive(Clone)]
pub struct PyClientApplication {
/// The mobile app installation id
///
/// :type str:
#[pyo3(get)]
installation_id: String,
/// The app title for the mobile app as registered with AWS' mobile services.
///
/// :type str:
#[pyo3(get)]
app_title: String,
/// The version name of the application as registered with AWS' mobile services.
///
/// :type str:
#[pyo3(get)]
app_version_name: String,
/// The app version code.
///
/// :type str:
#[pyo3(get)]
app_version_code: String,
/// The package name for the mobile application invoking the function
///
/// :type str:
#[pyo3(get)]
app_package_name: String,
}
/// Client context sent by the AWS Mobile SDK.
#[pyclass(name = "ClientContext")]
#[derive(Clone)]
pub struct PyClientContext {
/// Information about the mobile application invoking the function.
///
/// :type ClientApplication:
#[pyo3(get)]
client: PyClientApplication,
/// Custom properties attached to the mobile event context.
///
/// :type typing.Dict[str, str]:
#[pyo3(get)]
custom: HashMap<String, String>,
/// Environment settings from the mobile client.
///
/// :type typing.Dict[str, str]:
#[pyo3(get)]
environment: HashMap<String, String>,
}
/// Cognito identity information sent with the event
#[pyclass(name = "CognitoIdentity")]
#[derive(Clone)]
pub struct PyCognitoIdentity {
/// The unique identity id for the Cognito credentials invoking the function.
///
/// :type str:
#[pyo3(get)]
identity_id: String,
/// The identity pool id the caller is "registered" with.
///
/// :type str:
#[pyo3(get)]
identity_pool_id: String,
}
/// Configuration derived from environment variables.
#[pyclass(name = "Config")]
#[derive(Clone)]
pub struct PyConfig {
/// The name of the function.
///
/// :type str:
#[pyo3(get)]
function_name: String,
/// The amount of memory available to the function in MB.
///
/// :type int:
#[pyo3(get)]
memory: i32,
/// The version of the function being executed.
///
/// :type str:
#[pyo3(get)]
version: String,
/// The name of the Amazon CloudWatch Logs stream for the function.
///
/// :type str:
#[pyo3(get)]
log_stream: String,
/// The name of the Amazon CloudWatch Logs group for the function.
///
/// :type str:
#[pyo3(get)]
log_group: String,
}
/// The Lambda function execution context. The values in this struct
/// are populated using the [Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/current-supported-versions.html)
/// and the headers returned by the poll request to the Runtime APIs.
#[derive(Clone)]
#[pyclass(name = "LambdaContext")]
pub struct PyLambdaContext {
/// The AWS request ID generated by the Lambda service.
///
/// :type str:
#[pyo3(get)]
request_id: String,
/// The execution deadline for the current invocation in milliseconds.
///
/// :type int:
#[pyo3(get)]
deadline: u64,
/// The ARN of the Lambda function being invoked.
///
/// :type str:
#[pyo3(get)]
invoked_function_arn: String,
/// The X-Ray trace ID for the current invocation.
///
/// :type typing.Optional\[str\]:
#[pyo3(get)]
xray_trace_id: Option<String>,
/// The client context object sent by the AWS mobile SDK. This field is
/// empty unless the function is invoked using an AWS mobile SDK.
///
/// :type typing.Optional\[ClientContext\]:
#[pyo3(get)]
client_context: Option<PyClientContext>,
/// The Cognito identity that invoked the function. This field is empty
/// unless the invocation request to the Lambda APIs was made using AWS
/// credentials issues by Amazon Cognito Identity Pools.
///
/// :type typing.Optional\[CognitoIdentity\]:
#[pyo3(get)]
identity: Option<PyCognitoIdentity>,
/// Lambda function configuration from the local environment variables.
/// Includes information such as the function name, memory allocation,
/// version, and log streams.
///
/// :type Config:
#[pyo3(get)]
env_config: PyConfig,
}
impl PyLambdaContext {
/// Create Python-compatible version of [Context].
pub fn new(ctx: Context) -> Self {
Self {
request_id: ctx.request_id,
deadline: ctx.deadline,
invoked_function_arn: ctx.invoked_function_arn,
xray_trace_id: ctx.xray_trace_id,
client_context: ctx.client_context.map(|client_ctx| PyClientContext {
client: PyClientApplication {
installation_id: client_ctx.client.installation_id,
app_title: client_ctx.client.app_title,
app_version_name: client_ctx.client.app_version_name,
app_version_code: client_ctx.client.app_version_code,
app_package_name: client_ctx.client.app_package_name,
},
custom: client_ctx.custom,
environment: client_ctx.environment,
}),
identity: ctx.identity.map(|identity| PyCognitoIdentity {
identity_id: identity.identity_id,
identity_pool_id: identity.identity_pool_id,
}),
env_config: PyConfig {
function_name: ctx.env_config.function_name,
memory: ctx.env_config.memory,
version: ctx.env_config.version,
log_stream: ctx.env_config.log_stream,
log_group: ctx.env_config.log_group,
},
}
}
}
#[cfg(test)]
mod tests {
use http::{header::HeaderName, HeaderMap, HeaderValue};
use lambda_http::lambda_runtime::{Config, Context};
use pyo3::{prelude::*, py_run};
use super::*;
#[test]
fn py_lambda_context() -> PyResult<()> {
pyo3::prepare_freethreaded_python();
let headers = HeaderMap::from_iter([
(
HeaderName::from_static("lambda-runtime-aws-request-id"),
HeaderValue::from_static("my-id"),
),
(
HeaderName::from_static("lambda-runtime-deadline-ms"),
HeaderValue::from_static("123"),
),
(
HeaderName::from_static("lambda-runtime-invoked-function-arn"),
HeaderValue::from_static("arn::myarn"),
),
(
HeaderName::from_static("lambda-runtime-trace-id"),
HeaderValue::from_static("my-trace-id"),
),
(
HeaderName::from_static("lambda-runtime-client-context"),
HeaderValue::from_str(
&r#"
{
"client": {
"installationId": "my-installation-id",
"appTitle": "my-app-title",
"appVersionName": "my-app-version-name",
"appVersionCode": "my-app-version-code",
"appPackageName": "my-app-package-name"
},
"custom": {
"custom-key": "custom-val"
},
"environment": {
"environment-key": "environment-val"
}
}
"#
.split_whitespace()
.collect::<String>(),
)
.unwrap(),
),
(
HeaderName::from_static("lambda-runtime-cognito-identity"),
HeaderValue::from_str(
&r#"
{
"identity_id": "my-identity-id",
"identity_pool_id": "my-identity-pool-id"
}
"#
.split_whitespace()
.collect::<String>(),
)
.unwrap(),
),
]);
let lambda_context = Context::try_from(headers).unwrap();
let lambda_context = lambda_context.with_config(&Config {
function_name: "my-fn".to_string(),
memory: 128,
version: "my-version".to_string(),
log_stream: "my-log-stream".to_string(),
log_group: "my-log-group".to_string(),
});
Python::with_gil(|py| {
let ctx = PyCell::new(py, PyLambdaContext::new(lambda_context))?;
py_run!(
py,
ctx,
r#"
assert ctx.request_id == "my-id"
assert ctx.deadline == 123
assert ctx.invoked_function_arn == "arn::myarn"
assert ctx.xray_trace_id == "my-trace-id"
assert ctx.client_context.client.installation_id == "my-installation-id"
assert ctx.client_context.client.app_title == "my-app-title"
assert ctx.client_context.client.app_version_name == "my-app-version-name"
assert ctx.client_context.client.app_version_code == "my-app-version-code"
assert ctx.client_context.client.app_package_name == "my-app-package-name"
assert ctx.client_context.custom == {"custom-key":"custom-val"}
assert ctx.client_context.environment == {"environment-key":"environment-val"}
assert ctx.identity.identity_id == "my-identity-id"
assert ctx.identity.identity_pool_id == "my-identity-pool-id"
assert ctx.env_config.function_name == "my-fn"
assert ctx.env_config.memory == 128
assert ctx.env_config.version == "my-version"
assert ctx.env_config.log_stream == "my-log-stream"
assert ctx.env_config.log_group == "my-log-group"
"#
);
Ok(())
})
}
}