durable-actors 0.16.0

Standalone regional durable-actors control plane, host, and durability runtime
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
use std::time::Instant;

use super::*;
use crate::host_leases::HostLeaseRequest;

#[derive(Default)]
struct ActivationRecovery {
    snapshot: Option<LoadedSnapshot>,
    checkpoint: Option<super::super::recovery::PrefetchedCheckpoint>,
    checkpoint_ms: Option<f64>,
    session_ms: Option<f64>,
    snapshot_ms: Option<f64>,
}

#[derive(Default)]
pub(crate) struct CachedBase {
    /// The base's SQLite database: its checkpoint is left for SQLite recovery to fetch.
    pub database: bool,
    /// The base snapshot, used only when it matches the digest the ownership record names.
    pub snapshot: Option<Bytes>,
}

impl RuntimeStorage {
    pub async fn register_activation(
        &self,
        actor: &ActorKey,
        request: &HostLeaseRequest,
        region: &str,
        new_actor: bool,
        owner_hint: Option<&OwnershipHint>,
    ) -> Result<LoadedActor> {
        self.register_activation_with(
            actor,
            request,
            region,
            new_actor,
            owner_hint,
            &CachedBase::default(),
        )
        .await
    }

    pub(crate) async fn register_activation_with(
        &self,
        actor: &ActorKey,
        request: &HostLeaseRequest,
        region: &str,
        new_actor: bool,
        owner_hint: Option<&OwnershipHint>,
        cached: &CachedBase,
    ) -> Result<LoadedActor> {
        actor.validate()?;
        crate::placement::validate_region(region)?;
        request.validate_duration()?;
        let started = Instant::now();
        let now = self.clock.now_ms()?;
        // Unsealed recovery can fence a live session if the hinted lease was renewed.
        let owner_hint = owner_hint.filter(|hint| {
            hint.record.sealed
                && hint.generation > 0
                && hint.record.actor == *actor
                && hint.record.region == region
                && hint.record.lease.expires_at_ms <= now
                && (hint.record.lease.id != request.id
                    || hint.record.lease.session_id != request.session_id)
        });
        for hint in [owner_hint, None] {
            let read_started = Instant::now();
            let current = if let Some(hint) = hint {
                Some((hint.generation, hint.record.clone()))
            } else if new_actor && owner_hint.is_none() {
                None
            } else {
                self.load(&actor.storage_key()).await?
            };
            let ownership_read_ms = read_started.elapsed().as_secs_f64() * 1_000.0;
            let previous = current.as_ref().map(|(_, record)| record);
            self.validate_activation(actor, request, region, previous)?;
            let mut record = self.activation_record(actor, request, region, previous)?;
            let (recovery, replaced, ownership_cas_ms) =
                if previous.is_none_or(|record| record.sealed) {
                    // A sealed base is immutable; only the CAS winner may adopt the downloaded state.
                    let (recovery, replaced) = tokio::join!(
                        self.recover_activation(previous, cached),
                        self.claim_activation(
                            &mut record,
                            current.as_ref().map(|(generation, _)| *generation)
                        ),
                    );
                    let (replaced, elapsed) = replaced?;
                    (recovery, replaced, elapsed)
                } else {
                    let recovery = self.recover_activation(previous, cached).await?;
                    record.base = recovery
                        .snapshot
                        .as_ref()
                        .map(|snapshot| snapshot.reference.clone());
                    let (replaced, elapsed) = self
                        .claim_activation(
                            &mut record,
                            current.as_ref().map(|(generation, _)| *generation),
                        )
                        .await?;
                    (Ok(recovery), replaced, elapsed)
                };
            if !replaced {
                ensure!(hint.is_some(), "actor activation changed concurrently");
                continue;
            }
            let recovery = match recovery {
                Ok(recovery) => recovery,
                Err(error) => {
                    let checkpoint = SessionCheckpoint {
                        snapshot: record.base.clone(),
                    };
                    if let Err(release) = self
                        .release_with_checkpoint(
                            actor,
                            &request.id,
                            &request.session_id,
                            Some(checkpoint),
                        )
                        .await
                    {
                        tracing::warn!(%release, "failed activation lease release deferred to recovery");
                    }
                    return Err(error);
                }
            };
            let stream_started = Instant::now();
            self.snapshots.start(&record.stream()?).await?;
            let stream_open_ms = stream_started.elapsed().as_secs_f64() * 1_000.0;
            tracing::info!(
                event = "actor_activation_storage",
                project_id = %actor.project_id,
                actor_name = %actor.actor_name,
                actor_id = %actor.actor_id,
                host_id = %request.id,
                session_id = %request.session_id,
                new_actor,
                ownership_read_ms,
                ownership_cas_ms,
                stream_open_ms,
                session_recovery_ms = recovery.session_ms,
                snapshot_load_ms = recovery.snapshot_ms,
                checkpoint_prefetch_ms = recovery.checkpoint_ms,
                ownership_write_ms = ownership_cas_ms + stream_open_ms,
                duration_ms = started.elapsed().as_secs_f64() * 1_000.0,
            );
            let mut loaded = self.remember(record, recovery.snapshot);
            loaded.checkpoint = recovery.checkpoint;
            return Ok(loaded);
        }
        anyhow::bail!("actor activation changed concurrently")
    }

    pub async fn renew_activation(
        &self,
        actor: &ActorKey,
        request: &HostLeaseRequest,
    ) -> Result<HostLease> {
        let (generation, mut record) = self
            .load(&actor.storage_key())
            .await?
            .context("actor ownership missing")?;
        ensure!(
            record.actor == *actor
                && record.lease.id == request.id
                && record.lease.session_id == request.session_id,
            "actor ownership changed"
        );
        let current = &record.lease;
        ensure!(
            current.expires_at_ms > self.clock.now_ms()?,
            "expired activation cannot renew"
        );
        ensure!(
            current.route == request.route,
            "activation route cannot change"
        );
        let lease = self.new_lease(request)?;
        record.lease = lease.clone();
        self.save_activation(&mut record, Some(generation)).await?;
        if let Some(owned) = self
            .owned
            .lock()
            .unwrap()
            .get_mut(actor.storage_key().as_str())
        {
            ensure!(owned.epoch == record.epoch, "local ownership epoch changed");
            owned.lease = lease.clone();
        }
        Ok(lease)
    }

    pub async fn release_activation(
        &self,
        actor: &ActorKey,
        host: &HostId,
        session: &str,
    ) -> Result<()> {
        self.release_with_checkpoint(actor, host, session, None)
            .await
    }

    pub(crate) async fn release_with_checkpoint(
        &self,
        actor: &ActorKey,
        host: &HostId,
        session: &str,
        checkpoint: Option<SessionCheckpoint>,
    ) -> Result<()> {
        for _ in 0..3 {
            let Some((generation, mut record)) = self.load(&actor.storage_key()).await? else {
                return Ok(());
            };
            if record.lease.id != *host
                || record.lease.session_id != session
                || record.lease.expires_at_ms == 0
            {
                return Ok(());
            }
            record.lease.expires_at_ms = 0;
            if let Some(checkpoint) = &checkpoint {
                record.base = checkpoint.snapshot.clone();
                record.sealed = true;
            }
            if self
                .replace_activation(&mut record, Some(generation))
                .await?
            {
                return Ok(());
            }
        }
        anyhow::bail!("actor activation kept changing during release")
    }

    fn validate_activation(
        &self,
        actor: &ActorKey,
        request: &HostLeaseRequest,
        region: &str,
        current: Option<&Ownership>,
    ) -> Result<()> {
        let Some(record) = current else {
            return Ok(());
        };
        ensure!(
            record.persistence.same_backend(&self.persistence),
            "actor persistence configuration changed; an explicit state migration is required"
        );
        ensure!(
            record.actor == *actor && record.region == region,
            "ownership scope cannot change"
        );
        ensure!(
            record.lease.id != request.id || record.lease.session_id != request.session_id,
            "activation session cannot be reused"
        );
        ensure!(
            record.lease.expires_at_ms <= self.clock.now_ms()?,
            "previous owner lease is still active"
        );
        Ok(())
    }

    fn activation_record(
        &self,
        actor: &ActorKey,
        request: &HostLeaseRequest,
        region: &str,
        current: Option<&Ownership>,
    ) -> Result<Ownership> {
        Ok(Ownership {
            persistence: self.persistence.clone(),
            sealed: false,
            actor: actor.clone(),
            epoch: current
                .map_or(Some(1), |record| record.epoch.checked_add(1))
                .context("owner epoch overflow")?,
            region: region.into(),
            base: current.and_then(|record| record.base.clone()),
            lease: self.new_lease(request)?,
            mutation: String::new(),
        })
    }

    async fn claim_activation(
        &self,
        record: &mut Ownership,
        generation: Option<i64>,
    ) -> Result<(bool, f64)> {
        let started = Instant::now();
        let replaced = self.replace_activation(record, generation).await?;
        Ok((replaced, started.elapsed().as_secs_f64() * 1_000.0))
    }

    async fn recover_activation(
        &self,
        current: Option<&Ownership>,
        cached: &CachedBase,
    ) -> Result<ActivationRecovery> {
        let Some(record) = current else {
            return Ok(ActivationRecovery::default());
        };
        if record.sealed && cached.database {
            return self
                .load_activation_snapshot(record, cached.snapshot.as_ref())
                .await;
        }
        if record.sealed {
            return self
                .recover_sealed_activation(record, cached.snapshot.as_ref())
                .await;
        }
        let started = Instant::now();
        let recovered = self
            .snapshots
            .recover(&record.stream()?.prefix)
            .await?
            .map(|(key, bytes)| decode_snapshot(key, bytes))
            .transpose()?;
        let snapshot = self.load_latest(record, recovered).await?;
        Ok(ActivationRecovery {
            snapshot,
            session_ms: Some(started.elapsed().as_secs_f64() * 1_000.0),
            ..ActivationRecovery::default()
        })
    }

    async fn recover_sealed_activation(
        &self,
        record: &Ownership,
        cached: Option<&Bytes>,
    ) -> Result<ActivationRecovery> {
        let snapshot = self.load_activation_snapshot(record, cached);
        let checkpoint = self.prefetch_activation_checkpoint(record);
        tokio::pin!(snapshot, checkpoint);
        let (mut recovery, (checkpoint, checkpoint_ms)) = tokio::select! {
            result = &mut snapshot => {
                let recovery = result?;
                let needs_checkpoint = match &recovery.snapshot {
                    Some(snapshot) => crate::state_log::StateSnapshot::decode(&snapshot.bytes)?.sqlite.parent.is_some(),
                    None => false,
                };
                if !needs_checkpoint {
                    return Ok(recovery);
                }
                (recovery, checkpoint.await)
            }
            checkpoint = &mut checkpoint => (snapshot.await?, checkpoint),
        };
        recovery.checkpoint = checkpoint;
        recovery.checkpoint_ms = Some(checkpoint_ms);
        Ok(recovery)
    }

    async fn load_activation_snapshot(
        &self,
        record: &Ownership,
        cached: Option<&Bytes>,
    ) -> Result<ActivationRecovery> {
        let started = Instant::now();
        let cached = record
            .base
            .as_ref()
            .zip(cached)
            .filter(|(base, bytes)| base.verify(bytes).is_ok())
            .map(|(base, bytes)| LoadedSnapshot {
                reference: base.clone(),
                bytes: bytes.clone(),
            });
        let snapshot = self.load_latest(record, cached).await?;
        Ok(ActivationRecovery {
            snapshot,
            snapshot_ms: Some(started.elapsed().as_secs_f64() * 1_000.0),
            ..ActivationRecovery::default()
        })
    }

    async fn prefetch_activation_checkpoint(
        &self,
        record: &Ownership,
    ) -> (Option<super::super::recovery::PrefetchedCheckpoint>, f64) {
        let started = Instant::now();
        let checkpoint = match &record.base {
            Some(base) => match self.snapshots.prefetch_checkpoint(base).await {
                Ok(checkpoint) => checkpoint,
                Err(error) => {
                    tracing::warn!(%error, "checkpoint prefetch deferred to SQLite recovery");
                    None
                }
            },
            None => None,
        };
        (checkpoint, started.elapsed().as_secs_f64() * 1_000.0)
    }

    fn new_lease(&self, request: &HostLeaseRequest) -> Result<HostLease> {
        request.validate_duration()?;
        ensure!(
            !request.id.as_str().is_empty() && !request.session_id.is_empty(),
            "activation identity missing"
        );
        Ok(HostLease {
            id: request.id.clone(),
            session_id: request.session_id.clone(),
            route: request.route.clone(),
            expires_at_ms: self
                .clock
                .now_ms()?
                .checked_add(request.duration_ms)
                .context("lease expiration overflow")?,
        })
    }

    async fn save_activation(&self, record: &mut Ownership, generation: Option<i64>) -> Result<()> {
        ensure!(
            self.replace_activation(record, generation).await?,
            "actor activation changed concurrently"
        );
        Ok(())
    }
}

impl RuntimeStorageReader {
    pub(super) async fn replace_activation(
        &self,
        record: &mut Ownership,
        generation: Option<i64>,
    ) -> Result<bool> {
        record.mutation = uuid::Uuid::new_v4().to_string();
        replace(
            self.authority.as_ref(),
            &ownership_key(&record.actor.storage_key())?,
            generation,
            crate::payload::encode(record)?,
        )
        .await
    }
}