athena_rs 3.3.0

Database gateway API
Documentation
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
mod parser;

use actix_web::{
    HttpRequest, HttpResponse, delete, get, patch, post,
    web::{Data, Json, Path},
};
use serde_json::{Value, json};

use crate::AppState;
use crate::api::cache::invalidation::invalidate_scoped_gateway_cache;
use crate::api::gateway::auth::{
    authorize_gateway_request, delete_right_for_resource, read_right_for_resource,
    write_right_for_resource,
};
use crate::api::gateway::postgrest::parser::{
    FilterOperator, PostgrestFilter, parse_postgrest_query,
};
use crate::api::gateway::update::table_id_map::get_resource_id_key;
use crate::api::headers::x_athena_client::x_athena_client;
use crate::drivers::postgresql::sqlx_driver::{
    PostgresInsertError, delete_rows, fetch_rows_with_columns_with_or_groups, insert_row,
    insert_rows_bulk, update_rows, upsert_row,
};
use crate::parser::query_builder::{Condition, ConditionOperator};
use crate::utils::request_logging::{LoggedRequest, log_request};

/// Handle GET /rest/v1/{table}
#[get("/rest/v1/{table}")]
pub async fn postgrest_get_route(
    req: HttpRequest,
    path: Path<String>,
    app_state: Data<AppState>,
) -> HttpResponse {
    let table_name = path.into_inner();
    let client_name = match require_client_header(&req) {
        Ok(name) => name,
        Err(resp) => return resp,
    };
    let auth = authorize_gateway_request(
        &req,
        app_state.get_ref(),
        Some(&client_name),
        vec![read_right_for_resource(Some(&table_name))],
    )
    .await;
    let _logged_request: LoggedRequest = log_request(
        req.clone(),
        Some(app_state.get_ref()),
        Some(auth.request_id.clone()),
        Some(&auth.log_context),
    );
    if let Some(resp) = auth.response {
        return resp;
    }

    let query = match parse_postgrest_query(
        &table_name,
        &req,
        app_state.gateway_force_camel_case_to_snake_case,
    ) {
        Ok(parsed) => parsed,
        Err(err) => {
            return HttpResponse::BadRequest().json(json!({ "error": err }));
        }
    };

    let limit = query.limit.unwrap_or(100).max(1);
    let offset = query.offset.unwrap_or(0).max(0);

    let pool = match app_state.pg_registry.get_pool(&client_name) {
        Some(pool) => pool,
        None => {
            return HttpResponse::BadRequest().json(json!({
                "error": format!("Postgres client '{}' is not configured", client_name)
            }));
        }
    };

    let columns_refs: Vec<&str> = query.columns.iter().map(String::as_str).collect();
    let and_conditions = convert_filters(
        &query.filters,
        app_state.gateway_auto_cast_uuid_filter_values_to_text,
    );
    let or_condition_groups = convert_or_filter_groups(
        &query.or_filters,
        app_state.gateway_auto_cast_uuid_filter_values_to_text,
    );
    let order_by = query
        .order
        .as_ref()
        .map(|spec| (spec.column.as_str(), spec.ascending));

    match fetch_rows_with_columns_with_or_groups(
        &pool,
        &table_name,
        &columns_refs,
        &and_conditions,
        &or_condition_groups,
        limit,
        offset,
        order_by,
        app_state.gateway_allow_schema_names_prefixed_as_table_name,
    )
    .await
    {
        Ok(rows) => respond_with_content_range(&rows, offset),
        Err(err) => HttpResponse::InternalServerError().json(json!({ "error": err.to_string() })),
    }
}

/// Handle POST /rest/v1/{table}
#[post("/rest/v1/{table}")]
pub async fn postgrest_post_route(
    req: HttpRequest,
    path: Path<String>,
    body: Json<Value>,
    app_state: Data<AppState>,
) -> HttpResponse {
    let table_name = path.into_inner();
    let client_name = match require_client_header(&req) {
        Ok(name) => name,
        Err(resp) => return resp,
    };
    let auth = authorize_gateway_request(
        &req,
        app_state.get_ref(),
        Some(&client_name),
        vec![write_right_for_resource(Some(&table_name))],
    )
    .await;
    let _logged_request: LoggedRequest = log_request(
        req.clone(),
        Some(app_state.get_ref()),
        Some(auth.request_id.clone()),
        Some(&auth.log_context),
    );
    if let Some(resp) = auth.response {
        return resp;
    }

    let pool = match app_state.pg_registry.get_pool(&client_name) {
        Some(pool) => pool,
        None => {
            return HttpResponse::BadRequest().json(json!({
                "error": format!("Postgres client '{}' is not configured", client_name)
            }));
        }
    };

    let prefer_header = prefer_header_value(&req).unwrap_or_default();
    let upsert = prefer_header.contains("resolution=merge-duplicates");
    let minimal = prefer_header.contains("return=minimal");

    let payload = body.into_inner();
    let inserted_rows_result: Result<Vec<Value>, HttpResponse> = if payload.is_array() {
        let rows = payload.as_array().cloned().unwrap_or_default();
        match insert_rows_bulk(&pool, &table_name, &rows).await {
            Ok(rows) => Ok(rows),
            Err(err) => Err(map_postgres_insert_error(err)),
        }
    } else if upsert {
        let conflict_column = get_resource_id_key(&table_name).await;
        match upsert_row(&pool, &table_name, &payload, &conflict_column).await {
            Ok(row) => Ok(vec![row]),
            Err(err) => Err(map_postgres_insert_error(err)),
        }
    } else {
        match insert_row(&pool, &table_name, &payload).await {
            Ok(row) => Ok(vec![row]),
            Err(err) => Err(map_postgres_insert_error(err)),
        }
    };

    let inserted_rows = match inserted_rows_result {
        Ok(rows) => rows,
        Err(resp) => return resp,
    };

    let _ = invalidate_scoped_gateway_cache(app_state.clone(), &client_name, &table_name).await;

    if minimal {
        HttpResponse::NoContent().finish()
    } else {
        HttpResponse::Ok().json(json!({ "data": inserted_rows }))
    }
}

/// Handle PATCH /rest/v1/{table}
#[patch("/rest/v1/{table}")]
pub async fn postgrest_patch_route(
    req: HttpRequest,
    path: Path<String>,
    body: Json<Value>,
    app_state: Data<AppState>,
) -> HttpResponse {
    let table_name = path.into_inner();
    let client_name = match require_client_header(&req) {
        Ok(name) => name,
        Err(resp) => return resp,
    };
    let auth = authorize_gateway_request(
        &req,
        app_state.get_ref(),
        Some(&client_name),
        vec![write_right_for_resource(Some(&table_name))],
    )
    .await;
    let _logged_request: LoggedRequest = log_request(
        req.clone(),
        Some(app_state.get_ref()),
        Some(auth.request_id.clone()),
        Some(&auth.log_context),
    );
    if let Some(resp) = auth.response {
        return resp;
    }

    let query = match parse_postgrest_query(
        &table_name,
        &req,
        app_state.gateway_force_camel_case_to_snake_case,
    ) {
        Ok(parsed) => parsed,
        Err(err) => return HttpResponse::BadRequest().json(json!({ "error": err })),
    };

    let conditions = convert_filters(
        &query.filters,
        app_state.gateway_auto_cast_uuid_filter_values_to_text,
    );
    if conditions.is_empty() {
        return HttpResponse::BadRequest().json(json!({
            "error": "filters are required for update"
        }));
    }

    let pool = match app_state.pg_registry.get_pool(&client_name) {
        Some(pool) => pool,
        None => {
            return HttpResponse::BadRequest().json(json!({
                "error": format!("Postgres client '{}' is not configured", client_name)
            }));
        }
    };

    let prefer_header = prefer_header_value(&req).unwrap_or_default();
    let minimal = prefer_header.contains("return=minimal");

    let payload = body.into_inner();
    if !payload.is_object() {
        return HttpResponse::BadRequest().json(json!({
            "error": "patch body must be an object"
        }));
    }

    let update_result = update_rows(&pool, &table_name, &conditions, &payload).await;

    let updated_rows = match update_result {
        Ok(rows) => rows,
        Err(err) => {
            return HttpResponse::InternalServerError().json(json!({
                "error": err.to_string()
            }));
        }
    };

    let _ = invalidate_scoped_gateway_cache(app_state.clone(), &client_name, &table_name).await;

    if minimal {
        HttpResponse::NoContent().finish()
    } else {
        HttpResponse::Ok().json(json!({ "data": updated_rows }))
    }
}

/// Handle DELETE /rest/v1/{table}
#[delete("/rest/v1/{table}")]
pub async fn postgrest_delete_route(
    req: HttpRequest,
    path: Path<String>,
    app_state: Data<AppState>,
) -> HttpResponse {
    let table_name = path.into_inner();
    let client_name = match require_client_header(&req) {
        Ok(name) => name,
        Err(resp) => return resp,
    };
    let auth = authorize_gateway_request(
        &req,
        app_state.get_ref(),
        Some(&client_name),
        vec![delete_right_for_resource(Some(&table_name))],
    )
    .await;
    let _logged_request: LoggedRequest = log_request(
        req.clone(),
        Some(app_state.get_ref()),
        Some(auth.request_id.clone()),
        Some(&auth.log_context),
    );
    if let Some(resp) = auth.response {
        return resp;
    }

    let query = match parse_postgrest_query(
        &table_name,
        &req,
        app_state.gateway_force_camel_case_to_snake_case,
    ) {
        Ok(parsed) => parsed,
        Err(err) => return HttpResponse::BadRequest().json(json!({ "error": err })),
    };

    let conditions = convert_filters(
        &query.filters,
        app_state.gateway_auto_cast_uuid_filter_values_to_text,
    );
    if conditions.is_empty() {
        return HttpResponse::BadRequest().json(json!({
            "error": "filters are required for delete"
        }));
    }

    let pool = match app_state.pg_registry.get_pool(&client_name) {
        Some(pool) => pool,
        None => {
            return HttpResponse::BadRequest().json(json!({
                "error": format!("Postgres client '{}' is not configured", client_name)
            }));
        }
    };

    let prefer_header = prefer_header_value(&req).unwrap_or_default();
    let minimal = prefer_header.contains("return=minimal");

    let delete_result = delete_rows(&pool, &table_name, &conditions).await;

    let deleted_rows = match delete_result {
        Ok(rows) => rows,
        Err(err) => {
            return HttpResponse::InternalServerError().json(json!({
                "error": err.to_string()
            }));
        }
    };

    let _ = invalidate_scoped_gateway_cache(app_state.clone(), &client_name, &table_name).await;

    if minimal {
        HttpResponse::NoContent().finish()
    } else {
        HttpResponse::Ok().json(json!({ "data": deleted_rows }))
    }
}

fn convert_filters(
    filters: &[PostgrestFilter],
    auto_cast_uuid_filter_values_to_text: bool,
) -> Vec<Condition> {
    filters
        .iter()
        .filter_map(|filter| {
            convert_filter_to_condition(filter, auto_cast_uuid_filter_values_to_text)
        })
        .collect()
}

fn convert_or_filter_groups(
    or_groups: &[Vec<PostgrestFilter>],
    auto_cast_uuid_filter_values_to_text: bool,
) -> Vec<Vec<Condition>> {
    or_groups
        .iter()
        .map(|group| convert_filters(group, auto_cast_uuid_filter_values_to_text))
        .filter(|group| !group.is_empty())
        .collect()
}

fn map_filter_operator(op: FilterOperator) -> ConditionOperator {
    match op {
        FilterOperator::Eq => ConditionOperator::Eq,
        FilterOperator::Neq => ConditionOperator::Neq,
        FilterOperator::Gt => ConditionOperator::Gt,
        FilterOperator::Lt => ConditionOperator::Lt,
        FilterOperator::Gte => ConditionOperator::Gte,
        FilterOperator::Lte => ConditionOperator::Lte,
        FilterOperator::Like => ConditionOperator::Like,
        FilterOperator::ILike => ConditionOperator::ILike,
        FilterOperator::Is => ConditionOperator::Is,
        FilterOperator::In => ConditionOperator::In,
        FilterOperator::Contains => ConditionOperator::Contains,
        FilterOperator::Contained => ConditionOperator::Contained,
    }
}

fn convert_filter_to_condition(
    filter: &PostgrestFilter,
    auto_cast_uuid_filter_values_to_text: bool,
) -> Option<Condition> {
    Some(
        Condition::new(
            filter.column.clone(),
            map_filter_operator(filter.operator),
            filter.values.clone(),
            filter.negated,
        )
        .with_uuid_value_text_cast(auto_cast_uuid_filter_values_to_text),
    )
}

fn prefer_header_value(req: &HttpRequest) -> Option<String> {
    req.headers()
        .get("Prefer")
        .and_then(|value| value.to_str().ok())
        .map(|value| value.to_lowercase())
}

fn require_client_header(req: &HttpRequest) -> Result<String, HttpResponse> {
    let client_name = x_athena_client(req);
    if client_name.is_empty() {
        Err(HttpResponse::BadRequest().json(json!({
            "error": "X-Athena-Client header is required"
        })))
    } else {
        Ok(client_name)
    }
}

fn map_postgres_insert_error(err: PostgresInsertError) -> HttpResponse {
    HttpResponse::InternalServerError().json(json!({
        "error": format!("failed to insert rows: {:?}", err)
    }))
}

fn respond_with_content_range(rows: &[Value], offset: i64) -> HttpResponse {
    let end = if rows.is_empty() {
        offset.saturating_sub(1)
    } else {
        offset + (rows.len() as i64) - 1
    };
    HttpResponse::Ok()
        .insert_header(("Content-Range", format!("items {}-{}/{}", offset, end, "*")))
        .json(json!({ "data": rows }))
}