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 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.
use std::collections::BTreeMap;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use anyhow::Context;
use chrono::{DateTime, Utc};
use derivative::Derivative;
use mz_ore::cast::CastFrom;
use mz_repr::{Datum, Diff, Row, RowArena, Timestamp};
use mz_secrets::cache::CachingSecretsReader;
use mz_secrets::SecretsReader;
use mz_sql::plan::{WebhookBodyFormat, WebhookHeaders, WebhookValidation, WebhookValidationSecret};
use mz_storage_client::controller::MonotonicAppender;
use mz_storage_client::statistics::WebhookStatistics;
use mz_storage_types::controller::StorageError;
use tokio::sync::Semaphore;
use crate::optimize::dataflows::{prep_scalar_expr, ExprPrepStyle};
/// Errors returns when attempting to append to a webhook.
#[derive(thiserror::Error, Debug)]
pub enum AppendWebhookError {
// A secret that we need for validation has gone missing.
#[error("could not read a required secret")]
MissingSecret,
#[error("the provided request body is not UTF-8: {msg}")]
InvalidUtf8Body { msg: String },
#[error("the provided request body is not valid JSON: {msg}")]
InvalidJsonBody { msg: String },
#[error("webhook source '{database}.{schema}.{name}' does not exist")]
UnknownWebhook {
database: String,
schema: String,
name: String,
},
#[error("failed to validate the request")]
ValidationFailed,
// Note: we should _NEVER_ add more detail to this error, including the actual error we got
// when running validation. This is because the error messages might contain info about the
// arguments provided to the validation expression, we could contains user SECRETs. So by
// including any more detail we might accidentally expose SECRETs.
#[error("validation error")]
ValidationError,
#[error("internal channel closed")]
ChannelClosed,
#[error("internal error: {0:?}")]
InternalError(#[from] anyhow::Error),
#[error("internal storage failure! {0:?}")]
StorageError(#[from] StorageError<mz_repr::Timestamp>),
}
/// Contains all of the components necessary for running webhook validation.
///
/// To actually validate a webhook request call [`AppendWebhookValidator::eval`].
#[derive(Clone)]
pub struct AppendWebhookValidator {
validation: WebhookValidation,
secrets_reader: CachingSecretsReader,
}
impl AppendWebhookValidator {
pub fn new(validation: WebhookValidation, secrets_reader: CachingSecretsReader) -> Self {
AppendWebhookValidator {
validation,
secrets_reader,
}
}
pub async fn eval(
self,
body: bytes::Bytes,
headers: Arc<BTreeMap<String, String>>,
received_at: DateTime<Utc>,
) -> Result<bool, AppendWebhookError> {
let AppendWebhookValidator {
validation,
secrets_reader,
} = self;
let WebhookValidation {
mut expression,
relation_desc: _,
secrets,
bodies: body_columns,
headers: header_columns,
} = validation;
// Use the secrets reader to get any secrets.
let mut secret_contents = BTreeMap::new();
for WebhookValidationSecret {
id,
column_idx,
use_bytes,
} in secrets
{
let secret = secrets_reader
.read(id)
.await
.map_err(|_| AppendWebhookError::MissingSecret)?;
secret_contents.insert(column_idx, (secret, use_bytes));
}
// Transform any calls to `now()` into a constant representing of the current time.
//
// Note: we do this outside the closure, because otherwise there are some odd catch unwind
// boundary errors, and this shouldn't be too computationally expensive.
prep_scalar_expr(
&mut expression,
ExprPrepStyle::WebhookValidation { now: received_at },
)
.map_err(|err| {
tracing::error!(?err, "failed to evaluate current time");
AppendWebhookError::ValidationError
})?;
// Create a closure to run our validation, this allows lifetimes and unwind boundaries to
// work.
let validate = move || {
// Gather our Datums for evaluation
//
// TODO(parkmycar): Re-use the RowArena when we implement rate limiting.
let temp_storage = RowArena::default();
let mut datums = Vec::with_capacity(
body_columns.len() + header_columns.len() + secret_contents.len(),
);
// Append all of our body columns.
for (column_idx, use_bytes) in body_columns {
assert_eq!(column_idx, datums.len(), "body index and datums mismatch!");
let datum = if use_bytes {
Datum::Bytes(&body[..])
} else {
let s = std::str::from_utf8(&body[..])
.map_err(|m| AppendWebhookError::InvalidUtf8Body { msg: m.to_string() })?;
Datum::String(s)
};
datums.push(datum);
}
// Append all of our header columns, re-using Row packings.
//
let headers_byte = std::cell::OnceCell::new();
let headers_text = std::cell::OnceCell::new();
for (column_idx, use_bytes) in header_columns {
assert_eq!(column_idx, datums.len(), "index and datums mismatch!");
let row = if use_bytes {
headers_byte.get_or_init(|| {
let mut row = Row::with_capacity(1);
let mut packer = row.packer();
packer.push_dict(
headers
.iter()
.map(|(name, val)| (name.as_str(), Datum::Bytes(val.as_bytes()))),
);
row
})
} else {
headers_text.get_or_init(|| {
let mut row = Row::with_capacity(1);
let mut packer = row.packer();
packer.push_dict(
headers
.iter()
.map(|(name, val)| (name.as_str(), Datum::String(val))),
);
row
})
};
datums.push(row.unpack_first());
}
// Append all of our secrets to our datums, in the correct column order.
for column_idx in datums.len()..datums.len() + secret_contents.len() {
// Get the secret that corresponds with what is the next "column";
let (secret, use_bytes) = secret_contents
.get(&column_idx)
.expect("more secrets to provide, but none for the next column");
if *use_bytes {
datums.push(Datum::Bytes(secret));
} else {
let secret_str = std::str::from_utf8(&secret[..]).expect("valid UTF-8");
datums.push(Datum::String(secret_str));
}
}
// Run our validation
let valid = expression
.eval(&datums[..], &temp_storage)
.map_err(|_| AppendWebhookError::ValidationError)?;
match valid {
Datum::True => Ok::<_, AppendWebhookError>(true),
Datum::False | Datum::Null => Ok(false),
_ => unreachable!("Creating a webhook source asserts we return a boolean"),
}
};
// Then run the validation itself.
let valid = mz_ore::task::spawn_blocking(
|| "webhook-validator-expr",
move || {
// Since the validation expression is technically a user defined function, we want to
// be extra careful and guard against issues taking down the entire process.
mz_ore::panic::catch_unwind(validate).map_err(|_| {
tracing::error!("panic while validating webhook request!");
AppendWebhookError::ValidationError
})
},
)
.await
.context("joining on validation")
.map_err(|e| {
tracing::error!("Failed to run validation for webhook, {e}");
AppendWebhookError::ValidationError
})??;
valid
}
}
#[derive(Derivative, Clone)]
#[derivative(Debug)]
pub struct AppendWebhookResponse {
/// Channel to monotonically append rows to a webhook source.
pub tx: WebhookAppender,
/// Column type for the `body` column.
pub body_format: WebhookBodyFormat,
/// Types of the columns for the headers of a request.
pub header_tys: WebhookHeaders,
/// Expression used to validate a webhook request.
#[derivative(Debug = "ignore")]
pub validator: Option<AppendWebhookValidator>,
}
/// A wrapper around [`MonotonicAppender`] that can get closed by the `Coordinator` if the webhook
/// gets modified.
#[derive(Clone, Debug)]
pub struct WebhookAppender {
tx: MonotonicAppender<Timestamp>,
guard: WebhookAppenderGuard,
// Shared statistics related to this webhook.
stats: Arc<WebhookStatistics>,
}
impl WebhookAppender {
/// Checks if the [`WebhookAppender`] has closed.
pub fn is_closed(&self) -> bool {
self.guard.is_closed()
}
/// Appends updates to the linked webhook source.
pub async fn append(&self, updates: Vec<(Row, Diff)>) -> Result<(), AppendWebhookError> {
if self.is_closed() {
return Err(AppendWebhookError::ChannelClosed);
}
let count = u64::cast_from(updates.len());
self.stats
.updates_staged
.fetch_add(count, Ordering::Relaxed);
self.tx.append(updates).await?;
self.stats
.updates_committed
.fetch_add(count, Ordering::Relaxed);
Ok(())
}
/// Increment the `messages_received` user-facing statistics. This
/// should be incremented even if the request is invalid.
pub fn increment_messages_received(&self, msgs: u64) {
self.stats
.messages_received
.fetch_add(msgs, Ordering::Relaxed);
}
/// Increment the `bytes_received` user-facing statistics. This
/// should be incremented even if the request is invalid.
pub fn increment_bytes_received(&self, bytes: u64) {
self.stats
.bytes_received
.fetch_add(bytes, Ordering::Relaxed);
}
pub(crate) fn new(
tx: MonotonicAppender<Timestamp>,
guard: WebhookAppenderGuard,
stats: Arc<WebhookStatistics>,
) -> Self {
WebhookAppender { tx, guard, stats }
}
}
/// When a webhook, or it's containing schema and database, get modified we need to invalidate any
/// outstanding [`WebhookAppender`]s. This is because `Adapter`s will cache [`WebhookAppender`]s to
/// increase performance, and the (database, schema, name) tuple they cached an appender for is now
/// incorrect.
#[derive(Clone, Debug)]
pub struct WebhookAppenderGuard {
is_closed: Arc<AtomicBool>,
}
impl WebhookAppenderGuard {
pub fn is_closed(&self) -> bool {
self.is_closed.load(Ordering::SeqCst)
}
}
/// A handle to invalidate [`WebhookAppender`]s. See the comment on [`WebhookAppenderGuard`] for
/// more detail.
///
/// Note: to invalidate the associated [`WebhookAppender`]s, you must drop the corresponding
/// [`WebhookAppenderInvalidator`].
#[derive(Debug)]
pub struct WebhookAppenderInvalidator {
is_closed: Arc<AtomicBool>,
}
// We want to enforce unique ownership over the ability to invalidate a `WebhookAppender`.
static_assertions::assert_not_impl_all!(WebhookAppenderInvalidator: Clone);
impl WebhookAppenderInvalidator {
pub(crate) fn new() -> WebhookAppenderInvalidator {
let is_closed = Arc::new(AtomicBool::new(false));
WebhookAppenderInvalidator { is_closed }
}
pub fn guard(&self) -> WebhookAppenderGuard {
WebhookAppenderGuard {
is_closed: Arc::clone(&self.is_closed),
}
}
}
impl Drop for WebhookAppenderInvalidator {
fn drop(&mut self) {
self.is_closed.store(true, Ordering::SeqCst);
}
}
pub type WebhookAppenderName = (String, String, String);
/// A cache of [`WebhookAppender`]s and other metadata required for appending to a wbhook source.
///
/// Entries in the cache get invalidated when a [`WebhookAppender`] closes, at which point the
/// entry should be dropped from the cache and a request made to the `Coordinator` for a new one.
#[derive(Debug, Clone)]
pub struct WebhookAppenderCache {
pub entries: Arc<tokio::sync::Mutex<BTreeMap<WebhookAppenderName, AppendWebhookResponse>>>,
}
impl WebhookAppenderCache {
pub fn new() -> Self {
WebhookAppenderCache {
entries: Arc::new(tokio::sync::Mutex::new(BTreeMap::new())),
}
}
}
/// Manages how many concurrent webhook requests we allow at once.
#[derive(Debug, Clone)]
pub struct WebhookConcurrencyLimiter {
semaphore: Arc<Semaphore>,
prev_limit: usize,
}
impl WebhookConcurrencyLimiter {
pub fn new(limit: usize) -> Self {
let semaphore = Arc::new(Semaphore::new(limit));
WebhookConcurrencyLimiter {
semaphore,
prev_limit: limit,
}
}
/// Returns the underlying [`Semaphore`] used for limiting.
pub fn semaphore(&self) -> Arc<Semaphore> {
Arc::clone(&self.semaphore)
}
/// Updates the limit of how many concurrent requests can be run at once.
pub fn set_limit(&mut self, new_limit: usize) {
if new_limit > self.prev_limit {
// Add permits.
let diff = new_limit.saturating_sub(self.prev_limit);
tracing::debug!("Adding {diff} permits");
self.semaphore.add_permits(diff);
} else if new_limit < self.prev_limit {
// Remove permits.
let diff = self.prev_limit.saturating_sub(new_limit);
let diff = u32::try_from(diff).unwrap_or(u32::MAX);
tracing::debug!("Removing {diff} permits");
let semaphore = self.semaphore();
// Kind of janky, but the recommended way to reduce the amount of permits is to spawn
// a task the acquires and then forgets old permits.
mz_ore::task::spawn(|| "webhook-concurrency-limiter-drop-permits", async move {
if let Ok(permit) = Semaphore::acquire_many_owned(semaphore, diff).await {
permit.forget()
}
});
}
// Store our new limit.
self.prev_limit = new_limit;
tracing::debug!("New limit, {} permits", self.prev_limit);
}
}
impl Default for WebhookConcurrencyLimiter {
fn default() -> Self {
WebhookConcurrencyLimiter::new(mz_sql::WEBHOOK_CONCURRENCY_LIMIT)
}
}
#[cfg(test)]
mod test {
use super::WebhookConcurrencyLimiter;
#[mz_ore::test(tokio::test)]
#[cfg_attr(miri, ignore)] // unsupported operation: returning ready events from epoll_wait is not yet implemented
async fn smoke_test_concurrency_limiter() {
let mut limiter = WebhookConcurrencyLimiter::new(10);
let semaphore_a = limiter.semaphore();
let _permit_a = semaphore_a.try_acquire_many(10).expect("acquire");
let semaphore_b = limiter.semaphore();
assert!(semaphore_b.try_acquire().is_err());
// Increase our limit.
limiter.set_limit(15);
// This should now succeed!
let _permit_b = semaphore_b.try_acquire().expect("acquire");
// Decrease our limit.
limiter.set_limit(5);
tokio::time::sleep(tokio::time::Duration::from_secs(1)).await;
// This should fail again.
assert!(semaphore_b.try_acquire().is_err());
}
}