appcore-gateway 2.0.0-alpha.2

Multi-tenant Gateway capability for the AppCore Runtime.
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
445
446
447
448
449
450
// =============================================================================
//        #######
//     ###       ###     F: federated_route_tests.rs
//    ##   ## ##   ##    P: AppCore-Runtime
//         ## ##
//                       C: 2026/08/26 00:00:00 by dnettoRaw
//    ##   ## ##   ##    U: 2026/08/26 00:00:00 by dnettoRaw
//      ###########      S: 1.0.6-rc
// =============================================================================
// appcore-norm: test

use crate::connection::CONNECTION_BUFFER_CAPACITY;
use crate::ha::coordinator::tests::TestProvider;
use crate::*;
use appcore_contracts::InstallationId;
use appcore_distributed_contracts::PeerRpcEnvelope;
use appcore_peer_rpc::{
    envelope_signing_hash, BoundedReplayStore, PeerRpcHttpRequest, PeerRpcHttpResponse,
    ReplayStoreConfig, PEER_QUERY_PATH,
};
use appcore_security::{CommandTokenFactory, HashTokenProvider};
use appcore_types::{CapabilityName, ClusterId, CoreId, InstanceId, TenantId};
use axum::extract::ws::Message;
use std::sync::Arc;
#[cfg(feature = "ha-redis")]
use std::time::Instant;
use std::time::{Duration, SystemTime, UNIX_EPOCH};
use tokio::sync::mpsc;
#[cfg(feature = "ha-redis")]
use zeroize::Zeroizing;

#[tokio::test]
async fn two_gateway_states_route_one_fenced_request_to_remote_socket_owner() {
    let provider: Arc<dyn GatewayRegistryProvider> = Arc::new(TestProvider::default());
    run_two_gateway_states(
        Arc::clone(&provider),
        provider,
        None,
        Duration::from_secs(30),
    )
    .await;
}

#[tokio::test]
#[cfg(feature = "ha-redis")]
#[ignore = "requires APPCORE_GATEWAY_REDIS_URL and APPCORE_GATEWAY_REDIS_CREDENTIAL"]
async fn real_redis_routes_one_fenced_request_between_two_gateway_states() {
    let Some((endpoint, credential)) = redis_environment() else {
        return;
    };
    let namespace = format!("appcore-federation-e2e-{}-{}", std::process::id(), now_ms());
    let config = RedisGatewayRegistryConfig::new(&endpoint, namespace, 2_000, 8).unwrap();
    let origin: Arc<dyn GatewayRegistryProvider> = Arc::new(
        RedisGatewayRegistryProvider::connect(
            config.clone(),
            RedisGatewayCredential::new(Zeroizing::new(credential.clone())).unwrap(),
        )
        .await
        .unwrap(),
    );
    let target: Arc<dyn GatewayRegistryProvider> = Arc::new(
        RedisGatewayRegistryProvider::connect(
            config,
            RedisGatewayCredential::new(Zeroizing::new(credential)).unwrap(),
        )
        .await
        .unwrap(),
    );
    run_two_gateway_states(origin, target, None, Duration::from_secs(30)).await;
}

#[tokio::test]
#[cfg(feature = "ha-redis")]
#[ignore = "requires Redis plus APPCORE_GATEWAY_TARGET_BIND and APPCORE_GATEWAY_FEDERATION_PROXY_URL"]
async fn real_redis_and_external_proxy_route_between_two_gateway_states() {
    let Some((endpoint, credential, target_bind, proxy_url)) = proxy_environment() else {
        return;
    };
    let namespace = format!("appcore-proxy-e2e-{}-{}", std::process::id(), now_ms());
    let config = RedisGatewayRegistryConfig::new(&endpoint, namespace, 2_000, 8).unwrap();
    let origin = redis_provider(config.clone(), credential.clone()).await;
    let target = redis_provider(config, credential).await;
    run_two_gateway_states(
        origin,
        target,
        Some((target_bind, proxy_url)),
        Duration::from_secs(30),
    )
    .await;
}

#[tokio::test]
#[cfg(feature = "ha-redis")]
#[ignore = "requires APPCORE_GATEWAY_REDIS_URL and APPCORE_GATEWAY_REDIS_CREDENTIAL"]
async fn real_redis_recovers_higher_epochs_after_ungraceful_owner_loss() {
    let Some((endpoint, credential)) = redis_environment() else {
        return;
    };
    let namespace = format!("appcore-failover-e2e-{}-{}", std::process::id(), now_ms());
    let config = RedisGatewayRegistryConfig::new(&endpoint, namespace, 2_000, 8).unwrap();
    let origin = redis_provider(config.clone(), credential.clone()).await;
    let target = redis_provider(config, credential).await;
    let lease_ttl = Duration::from_secs(1);
    let first_epoch =
        run_two_gateway_states(Arc::clone(&origin), Arc::clone(&target), None, lease_ttl).await;
    let recovery_started = Instant::now();
    tokio::time::sleep(Duration::from_millis(1_200)).await;
    let recovered_epoch = run_two_gateway_states(origin, target, None, lease_ttl).await;
    assert!(recovered_epoch > first_epoch);
    assert!(recovery_started.elapsed() < Duration::from_secs(5));
}

#[tokio::test]
#[cfg(feature = "ha-redis")]
#[ignore = "requires Redis plus APPCORE_GATEWAY_TARGET_BIND and APPCORE_GATEWAY_FEDERATION_PROXY_URL"]
async fn real_redis_and_external_proxy_recover_after_ungraceful_owner_loss() {
    let Some((endpoint, credential, target_bind, proxy_url)) = proxy_environment() else {
        return;
    };
    let namespace = format!("appcore-proxy-failover-{}-{}", std::process::id(), now_ms());
    let config = RedisGatewayRegistryConfig::new(&endpoint, namespace, 2_000, 8).unwrap();
    let origin = redis_provider(config.clone(), credential.clone()).await;
    let target = redis_provider(config, credential).await;
    let lease_ttl = Duration::from_secs(1);
    let proxy = Some((target_bind, proxy_url));
    let first_epoch = run_two_gateway_states(
        Arc::clone(&origin),
        Arc::clone(&target),
        proxy.clone(),
        lease_ttl,
    )
    .await;
    let recovery_started = Instant::now();
    tokio::time::sleep(Duration::from_millis(1_200)).await;
    let recovered_epoch = run_two_gateway_states(origin, target, proxy, lease_ttl).await;
    assert!(recovered_epoch > first_epoch);
    assert!(recovery_started.elapsed() < Duration::from_secs(5));
}

async fn run_two_gateway_states(
    origin_provider: Arc<dyn GatewayRegistryProvider>,
    target_provider: Arc<dyn GatewayRegistryProvider>,
    proxy: Option<(String, String)>,
    lease_ttl: Duration,
) -> u64 {
    let bind = proxy
        .as_ref()
        .map_or("127.0.0.1:0", |value| value.0.as_str());
    let listener = tokio::net::TcpListener::bind(bind).await.unwrap();
    let target_address = listener.local_addr().unwrap();
    let target_url = proxy
        .map(|value| value.1)
        .unwrap_or_else(|| format!("http://{target_address}"));
    let target_coordinator = Arc::new(coordinator(
        target_provider,
        "gateway-target",
        target_url,
        lease_ttl,
    ));
    let origin_coordinator = Arc::new(coordinator(
        origin_provider,
        "gateway-origin",
        "http://127.0.0.1:9".to_string(),
        lease_ttl,
    ));
    let token_provider = random_token_provider();
    let target_state = state(Arc::clone(&target_coordinator), token_provider.clone());
    let origin_state = state(Arc::clone(&origin_coordinator), token_provider);
    let now = now_ms();
    target_coordinator
        .recover(target_state.as_ref(), now)
        .await
        .unwrap();
    origin_coordinator
        .recover(origin_state.as_ref(), now)
        .await
        .unwrap();
    let RemoteWorkerFixture {
        tenant,
        cluster,
        core,
        capability,
        worker,
        receiver,
    } = install_remote_worker(&target_coordinator, &target_state, now).await;
    let server_state = Arc::clone(&target_state);
    let server = tokio::spawn(async move {
        axum::serve(listener, make_gateway_router(server_state))
            .await
            .unwrap();
    });
    let worker_task =
        spawn_worker_response(Arc::clone(&target_state), tenant.clone(), worker, receiver);
    let request = federated_request(&origin_state, &tenant, cluster, core, capability, now);
    let response = EnvelopeRouter::route_mesh_request(
        Arc::clone(&origin_state),
        request,
        Duration::from_secs(5),
    )
    .await
    .into_peer_response()
    .unwrap();

    assert_eq!(response.body, b"remote-ok");
    assert_eq!(origin_coordinator.snapshot().request_claims, 1);
    assert_eq!(origin_coordinator.snapshot().request_completions, 1);
    assert_eq!(origin_coordinator.snapshot().remote_forwards, 1);
    let target_epoch = target_coordinator.lease_for(&tenant).unwrap().epoch();
    worker_task.await.unwrap();
    server.abort();
    let _ = server.await;
    target_epoch
}

struct RemoteWorkerFixture {
    tenant: TenantId,
    cluster: ClusterId,
    core: CoreId,
    capability: CapabilityName,
    worker: WorkerConnection,
    receiver: mpsc::Receiver<Message>,
}

async fn install_remote_worker(
    coordinator: &GatewayHaCoordinator,
    state: &GatewayState,
    now: u64,
) -> RemoteWorkerFixture {
    let tenant = TenantId::new("tenant-a").unwrap();
    let cluster = ClusterId::new("cluster-a").unwrap();
    let core = CoreId::new("core-remote").unwrap();
    let capability = CapabilityName::new("runtime.query").unwrap();
    let installation = InstallationId::new("install-remote").unwrap();
    let (sender, receiver) = mpsc::channel(CONNECTION_BUFFER_CAPACITY);
    let worker = WorkerConnection::new_in_cluster(
        WorkerConnectionKey {
            tenant_id: tenant.clone(),
            installation_id: installation.clone(),
            core_id: core.clone(),
        },
        cluster.clone(),
        sender,
        now,
    );
    coordinator
        .register_worker(
            &tenant,
            &cluster,
            GatewayWorkerRegistration::new(
                installation,
                core.clone(),
                worker.generation(),
                vec![capability.clone()],
            )
            .unwrap(),
            now,
        )
        .await
        .unwrap();
    state
        .tenant_partition_or_insert(&tenant)
        .unwrap()
        .write()
        .add_worker(worker.clone(), vec![capability.clone()])
        .unwrap();
    RemoteWorkerFixture {
        tenant,
        cluster,
        core,
        capability,
        worker,
        receiver,
    }
}

fn spawn_worker_response(
    state: Arc<GatewayState>,
    tenant: TenantId,
    worker: WorkerConnection,
    mut receiver: mpsc::Receiver<Message>,
) -> tokio::task::JoinHandle<()> {
    tokio::spawn(async move {
        let Some(Message::Text(payload)) = receiver.recv().await else {
            panic!("federated worker did not receive a text request");
        };
        let request: MeshPeerRequest = serde_json::from_str(&payload).unwrap();
        EnvelopeRouter::handle_worker_mesh_response_from(
            state,
            &tenant,
            &worker,
            MeshPeerResponse::ok(
                request.request_id,
                PeerRpcHttpResponse {
                    status_code: 200,
                    body: b"remote-ok".to_vec(),
                },
            ),
        )
        .unwrap();
    })
}

fn federated_request(
    state: &GatewayState,
    tenant: &TenantId,
    cluster: ClusterId,
    core: CoreId,
    capability: CapabilityName,
    now: u64,
) -> MeshPeerRequest {
    let envelope = PeerRpcEnvelope::new(
        "federated-request",
        "federated-trace",
        CoreId::new("core-origin").unwrap(),
        core.clone(),
        tenant.clone(),
        cluster,
        now,
        now + 30_000,
        "federated-inner-nonce",
        capability,
        b"opaque".to_vec(),
        None,
        None,
    );
    let inner_hash = envelope_signing_hash(&envelope);
    let inner_credential = CommandTokenFactory::new(&state.token_provider, gateway_token_claims())
        .create_v1_with_jti_and_hash(
            "peer",
            None,
            None,
            None,
            now,
            30_000,
            Some(format!("inner-{}", envelope.request_id)),
            Some(inner_hash),
        )
        .unwrap();
    MeshPeerRequest::new(
        "federated-request",
        tenant.clone(),
        core,
        PeerRpcHttpRequest {
            method: "POST".to_string(),
            path: PEER_QUERY_PATH.to_string(),
            body: serde_json::to_vec(&envelope).unwrap(),
            bearer_token: Some(inner_credential),
            timeout_ms: 5_000,
            max_response_bytes: 4_096,
        },
    )
}

#[cfg(feature = "ha-redis")]
async fn redis_provider(
    config: RedisGatewayRegistryConfig,
    credential: String,
) -> Arc<dyn GatewayRegistryProvider> {
    Arc::new(
        RedisGatewayRegistryProvider::connect(
            config,
            RedisGatewayCredential::new(Zeroizing::new(credential)).unwrap(),
        )
        .await
        .unwrap(),
    )
}

fn coordinator(
    provider: Arc<dyn GatewayRegistryProvider>,
    instance: &str,
    federation_url: String,
    lease_ttl: Duration,
) -> GatewayHaCoordinator {
    GatewayHaCoordinator::new(
        provider,
        Arc::new(GatewayHaLifecycle::new()),
        GatewayHaCoordinatorConfig {
            instance_id: InstanceId::new(instance).unwrap(),
            federation_url: GatewayFederationUrl::new(federation_url).unwrap(),
            tenants: vec![GatewayHaTenantBinding {
                tenant_id: TenantId::new("tenant-a").unwrap(),
                cluster_id: ClusterId::new("cluster-a").unwrap(),
            }],
            lease_ttl,
            renewal_interval: lease_ttl / 4,
        },
    )
    .unwrap()
}

fn random_token_provider() -> HashTokenProvider {
    let mut secret = [0u8; 32];
    getrandom::getrandom(&mut secret).unwrap();
    HashTokenProvider::from_secret(secret.to_vec()).unwrap()
}

#[cfg(feature = "ha-redis")]
fn redis_environment() -> Option<(String, String)> {
    match (
        std::env::var("APPCORE_GATEWAY_REDIS_URL"),
        std::env::var("APPCORE_GATEWAY_REDIS_CREDENTIAL"),
    ) {
        (Ok(endpoint), Ok(credential)) => Some((endpoint, credential)),
        (Err(std::env::VarError::NotPresent), Err(std::env::VarError::NotPresent)) => None,
        _ => panic!("Redis Gateway test environment is incomplete or invalid"),
    }
}

#[cfg(feature = "ha-redis")]
fn proxy_environment() -> Option<(String, String, String, String)> {
    let redis_url = std::env::var("APPCORE_GATEWAY_REDIS_URL");
    let redis_credential = std::env::var("APPCORE_GATEWAY_REDIS_CREDENTIAL");
    let target_bind = std::env::var("APPCORE_GATEWAY_TARGET_BIND");
    let proxy_url = std::env::var("APPCORE_GATEWAY_FEDERATION_PROXY_URL");
    match (redis_url, redis_credential, target_bind, proxy_url) {
        (Ok(endpoint), Ok(credential), Ok(bind), Ok(proxy)) => {
            Some((endpoint, credential, bind, proxy))
        }
        (
            Err(std::env::VarError::NotPresent),
            Err(std::env::VarError::NotPresent),
            Err(std::env::VarError::NotPresent),
            Err(std::env::VarError::NotPresent),
        ) => None,
        _ => panic!("Gateway proxy test environment is incomplete or invalid"),
    }
}

fn state(
    coordinator: Arc<GatewayHaCoordinator>,
    token_provider: HashTokenProvider,
) -> Arc<GatewayState> {
    Arc::new(
        GatewayState::with_ha_coordinator(
            GatewayConfig::new(([127, 0, 0, 1], 0).into(), "gateway.test"),
            token_provider,
            Arc::new(BoundedReplayStore::new(ReplayStoreConfig::default())),
            coordinator,
        )
        .unwrap(),
    )
}

fn now_ms() -> u64 {
    SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .unwrap()
        .as_millis() as u64
}