canic-control-plane 0.19.5

Canic — a canister orchestration and management toolkit for the Internet Computer
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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
use super::{
    TemplateManifestOps, TemplateManifestOpsError, WasmStoreGcExecutionStats, WasmStoreLimits,
    input_to_record,
};
use crate::{
    dto::template::{
        TemplateChunkInput, TemplateChunkResponse, TemplateChunkSetInfoResponse,
        TemplateChunkSetInput, TemplateChunkSetPrepareInput, TemplateManifestInput,
        TemplateManifestResponse, TemplateStagingStatusResponse, WasmStoreBootstrapDebugResponse,
        WasmStoreGcStatusResponse, WasmStoreStatusResponse, WasmStoreTemplateStatusResponse,
    },
    ids::{
        CanisterRole, TemplateChunkKey, TemplateChunkingMode, TemplateId, TemplateManifestState,
        TemplateReleaseKey, TemplateVersion, WasmStoreGcStatus,
    },
    storage::stable::template::{
        TemplateChunkRecord, TemplateChunkSetRecord, TemplateChunkSetStateStore,
        TemplateChunkStore, TemplateManifestRecord, TemplateManifestStateStore,
    },
};
use canic_core::__control_plane_core as cp_core;
use cp_core::{
    InternalError,
    cdk::{api::canister_self, structures::storable::Storable, utils::wasm::get_wasm_hash},
    format::byte_size,
    ops::ic::mgmt::MgmtOps,
};
use std::collections::{BTreeMap, BTreeSet};

///
/// TemplateChunkedOps
///

pub struct TemplateChunkedOps;

impl TemplateChunkedOps {
    // Return staged-release status for every approved manifest in deterministic role order.
    #[must_use]
    pub fn approved_staging_status_responses() -> Vec<TemplateStagingStatusResponse> {
        let chunk_counts = TemplateChunkStore::count_by_release();
        let mut staged = TemplateManifestOps::approved_manifests_response()
            .into_iter()
            .map(|manifest| Self::staging_status_response(&manifest, &chunk_counts))
            .collect::<Vec<_>>();

        staged.sort_by(|left, right| left.role.cmp(&right.role));
        staged
    }

    // Return a root-owned bootstrap debug snapshot for the staged bootstrap role and release set.
    pub fn bootstrap_debug_response(
        bootstrap_role: &CanisterRole,
    ) -> Result<WasmStoreBootstrapDebugResponse, InternalError> {
        let staged = Self::approved_staging_status_responses();
        let bootstrap = staged
            .iter()
            .find(|entry| entry.role == *bootstrap_role)
            .cloned();
        let ready_for_bootstrap = Self::has_publishable_chunked_approved_for_role(bootstrap_role)?;

        Ok(WasmStoreBootstrapDebugResponse {
            ready_for_bootstrap,
            bootstrap,
            staged,
        })
    }

    // Return current occupied-byte and template-retention state for this local store.
    #[must_use]
    pub fn store_status_response(
        limits: WasmStoreLimits,
        headroom_bytes: Option<u64>,
        gc: WasmStoreGcStatus,
    ) -> WasmStoreStatusResponse {
        let manifests = TemplateManifestStateStore::export().entries;
        let chunk_sets = TemplateChunkSetStateStore::export();
        let chunks = TemplateChunkStore::export();
        let occupied_store_bytes = occupied_store_bytes(&manifests, &chunk_sets, &chunks);
        let template_versions = projected_template_versions(&manifests, &chunk_sets, &chunks);
        let remaining_store_bytes = limits.max_store_bytes.saturating_sub(occupied_store_bytes);
        let release_count = u32::try_from(
            template_versions
                .values()
                .map(std::collections::BTreeSet::len)
                .sum::<usize>(),
        )
        .unwrap_or(u32::MAX);
        let template_count = u32::try_from(template_versions.len()).unwrap_or(u32::MAX);
        let within_headroom =
            headroom_bytes.is_some_and(|threshold| remaining_store_bytes <= threshold);
        let mut templates = template_versions
            .into_iter()
            .map(|(template_id, versions)| WasmStoreTemplateStatusResponse {
                template_id,
                versions: u16::try_from(versions.len()).unwrap_or(u16::MAX),
            })
            .collect::<Vec<_>>();
        templates.sort_by(|left, right| left.template_id.cmp(&right.template_id));

        WasmStoreStatusResponse {
            gc: WasmStoreGcStatusResponse {
                mode: gc.mode,
                changed_at: gc.changed_at,
                prepared_at: gc.prepared_at,
                started_at: gc.started_at,
                completed_at: gc.completed_at,
                runs_completed: gc.runs_completed,
            },
            occupied_store_bytes,
            occupied_store_size: byte_size(occupied_store_bytes),
            max_store_bytes: limits.max_store_bytes,
            max_store_size: byte_size(limits.max_store_bytes),
            remaining_store_bytes,
            remaining_store_size: byte_size(remaining_store_bytes),
            headroom_bytes,
            headroom_size: headroom_bytes.map(byte_size),
            within_headroom,
            template_count,
            max_templates: limits.max_templates,
            release_count,
            max_template_versions_per_template: limits.max_template_versions_per_template,
            templates,
        }
    }

    // Return whether one approved chunked manifest is fully staged and ready for publication.
    pub fn has_publishable_chunked_approved_for_role(
        role: &CanisterRole,
    ) -> Result<bool, InternalError> {
        if !TemplateManifestOps::has_approved_for_role(role)? {
            return Ok(false);
        }

        let manifest = TemplateManifestOps::approved_for_role_response(role)?;

        if manifest.chunking_mode != TemplateChunkingMode::Chunked {
            return Ok(false);
        }

        Ok(Self::validate_staged_release(&manifest).is_ok())
    }

    // Return deterministic staged-chunk progress for one approved manifest.
    #[must_use]
    pub fn staging_status_response(
        manifest: &TemplateManifestResponse,
        chunk_counts: &BTreeMap<TemplateReleaseKey, u32>,
    ) -> TemplateStagingStatusResponse {
        let release =
            TemplateReleaseKey::new(manifest.template_id.clone(), manifest.version.clone());
        let chunk_set = TemplateChunkSetStateStore::get(&release);
        let expected_chunk_count = chunk_set.as_ref().map_or(0, |record| record.chunk_count);
        let stored_chunk_count = chunk_counts.get(&release).copied().unwrap_or(0);
        let publishable = manifest.chunking_mode == TemplateChunkingMode::Chunked
            && chunk_set.is_some()
            && stored_chunk_count == expected_chunk_count;

        TemplateStagingStatusResponse {
            role: manifest.role.clone(),
            template_id: manifest.template_id.clone(),
            version: manifest.version.clone(),
            store_binding: manifest.store_binding.clone(),
            chunking_mode: manifest.chunking_mode,
            payload_size_bytes: manifest.payload_size_bytes,
            payload_size: byte_size(manifest.payload_size_bytes),
            chunk_set_present: chunk_set.is_some(),
            expected_chunk_count,
            stored_chunk_count,
            publishable,
        }
    }

    // Replace the approved manifest for a local wasm store with capacity enforcement.
    #[allow(dead_code)]
    pub fn replace_approved_in_store_from_input(
        input: TemplateManifestInput,
        limits: WasmStoreLimits,
    ) -> Result<(), InternalError> {
        let projected_manifests = projected_manifests_after_replace(&input);
        let projected_chunk_sets = TemplateChunkSetStateStore::export();
        let projected_chunks = TemplateChunkStore::export();
        ensure_store_limits(
            limits,
            &projected_manifests,
            &projected_chunk_sets,
            &projected_chunks,
        )?;

        TemplateManifestOps::replace_approved_from_input(input);
        Ok(())
    }

    // Publish one complete chunk set into the local wasm store.
    #[allow(dead_code)]
    pub fn publish_chunk_set_from_input(
        input: TemplateChunkSetInput,
        created_at: u64,
    ) -> Result<TemplateChunkSetInfoResponse, InternalError> {
        let release = TemplateReleaseKey::new(input.template_id, input.version);
        if input.chunks.is_empty() {
            return Err(TemplateManifestOpsError::TemplateChunkSetEmpty(release).into());
        }

        let payload_size_bytes = input
            .chunks
            .iter()
            .map(|chunk| chunk.len() as u64)
            .sum::<u64>();
        if payload_size_bytes != input.payload_size_bytes {
            return Err(TemplateManifestOpsError::PayloadSizeMismatch(release).into());
        }

        let mut payload = Vec::new();
        let mut chunk_hashes = Vec::with_capacity(input.chunks.len());

        for chunk in &input.chunks {
            payload.extend_from_slice(chunk);
            chunk_hashes.push(get_wasm_hash(chunk));
        }

        if get_wasm_hash(&payload) != input.payload_hash {
            return Err(TemplateManifestOpsError::PayloadHashMismatch(release).into());
        }

        let info = Self::prepare_chunk_set_from_input(
            TemplateChunkSetPrepareInput {
                template_id: release.template_id.clone(),
                version: release.version.clone(),
                payload_hash: input.payload_hash,
                payload_size_bytes: input.payload_size_bytes,
                chunk_hashes,
            },
            created_at,
        )?;

        for (chunk_index, bytes) in input.chunks.into_iter().enumerate() {
            let chunk_index = u32::try_from(chunk_index)
                .map_err(|_| TemplateManifestOpsError::ChunkIndexOverflow(release.clone()))?;
            Self::publish_chunk_from_input(TemplateChunkInput {
                template_id: release.template_id.clone(),
                version: release.version.clone(),
                chunk_index,
                bytes,
            })?;
        }

        Ok(info)
    }

    // Publish one complete chunk set into a local store with capacity enforcement.
    #[allow(dead_code)]
    pub fn publish_chunk_set_in_store_from_input(
        input: TemplateChunkSetInput,
        created_at: u64,
        limits: WasmStoreLimits,
    ) -> Result<TemplateChunkSetInfoResponse, InternalError> {
        let release = TemplateReleaseKey::new(input.template_id.clone(), input.version.clone());
        if input.chunks.is_empty() {
            return Err(TemplateManifestOpsError::TemplateChunkSetEmpty(release).into());
        }

        let payload_size_bytes = input
            .chunks
            .iter()
            .map(|chunk| chunk.len() as u64)
            .sum::<u64>();
        if payload_size_bytes != input.payload_size_bytes {
            return Err(TemplateManifestOpsError::PayloadSizeMismatch(release).into());
        }

        let mut payload = Vec::new();
        let mut chunk_hashes = Vec::with_capacity(input.chunks.len());

        for chunk in &input.chunks {
            payload.extend_from_slice(chunk);
            chunk_hashes.push(get_wasm_hash(chunk));
        }

        if get_wasm_hash(&payload) != input.payload_hash {
            return Err(TemplateManifestOpsError::PayloadHashMismatch(release).into());
        }

        let chunk_count = u32::try_from(chunk_hashes.len())
            .map_err(|_| TemplateManifestOpsError::ChunkIndexOverflow(release.clone()))?;
        let projected_chunk_set = TemplateChunkSetRecord {
            payload_hash: input.payload_hash.clone(),
            payload_size_bytes: input.payload_size_bytes,
            chunk_count,
            chunk_hashes,
            created_at,
        };
        let projected_chunks = input
            .chunks
            .iter()
            .enumerate()
            .map(|(chunk_index, bytes)| {
                let chunk_index = u32::try_from(chunk_index)
                    .map_err(|_| TemplateManifestOpsError::ChunkIndexOverflow(release.clone()))?;
                Ok((
                    TemplateChunkKey::new(release.clone(), chunk_index),
                    TemplateChunkRecord {
                        bytes: bytes.clone(),
                    },
                ))
            })
            .collect::<Result<Vec<_>, InternalError>>()?;

        let projected_manifests = TemplateManifestStateStore::export().entries;
        let projected_chunk_sets = replace_chunk_set_entry(release, projected_chunk_set);
        let projected_chunks = replace_chunk_entries(projected_chunks);
        ensure_store_limits(
            limits,
            &projected_manifests,
            &projected_chunk_sets,
            &projected_chunks,
        )?;

        Self::publish_chunk_set_from_input(input, created_at)
    }

    // Prepare one chunk-set metadata record before chunk-by-chunk publication begins.
    pub fn prepare_chunk_set_from_input(
        input: TemplateChunkSetPrepareInput,
        created_at: u64,
    ) -> Result<TemplateChunkSetInfoResponse, InternalError> {
        let release = TemplateReleaseKey::new(input.template_id, input.version);
        if input.chunk_hashes.is_empty() {
            return Err(TemplateManifestOpsError::TemplateChunkSetEmpty(release).into());
        }

        let chunk_count = u32::try_from(input.chunk_hashes.len())
            .map_err(|_| TemplateManifestOpsError::ChunkIndexOverflow(release.clone()))?;
        let info_record = TemplateChunkSetRecord {
            payload_hash: input.payload_hash,
            payload_size_bytes: input.payload_size_bytes,
            chunk_count,
            chunk_hashes: input.chunk_hashes,
            created_at,
        };

        TemplateChunkSetStateStore::upsert(release, info_record.clone());

        Ok(chunk_set_record_to_response(info_record))
    }

    // Prepare one chunk-set metadata record in a local store with capacity enforcement.
    pub fn prepare_chunk_set_in_store_from_input(
        input: TemplateChunkSetPrepareInput,
        created_at: u64,
        limits: WasmStoreLimits,
    ) -> Result<TemplateChunkSetInfoResponse, InternalError> {
        let release = TemplateReleaseKey::new(input.template_id.clone(), input.version.clone());
        if input.chunk_hashes.is_empty() {
            return Err(TemplateManifestOpsError::TemplateChunkSetEmpty(release).into());
        }

        let chunk_count = u32::try_from(input.chunk_hashes.len())
            .map_err(|_| TemplateManifestOpsError::ChunkIndexOverflow(release.clone()))?;
        let info_record = TemplateChunkSetRecord {
            payload_hash: input.payload_hash,
            payload_size_bytes: input.payload_size_bytes,
            chunk_count,
            chunk_hashes: input.chunk_hashes,
            created_at,
        };

        let projected_manifests = TemplateManifestStateStore::export().entries;
        let projected_chunk_sets = replace_chunk_set_entry(release.clone(), info_record.clone());
        let projected_chunks = TemplateChunkStore::export();
        ensure_store_limits(
            limits,
            &projected_manifests,
            &projected_chunk_sets,
            &projected_chunks,
        )?;

        TemplateChunkSetStateStore::upsert(release, info_record.clone());

        Ok(chunk_set_record_to_response(info_record))
    }

    // Publish one chunk into an already prepared local template release.
    pub fn publish_chunk_from_input(input: TemplateChunkInput) -> Result<(), InternalError> {
        let release = TemplateReleaseKey::new(input.template_id, input.version);
        let info = TemplateChunkSetStateStore::get(&release)
            .ok_or_else(|| TemplateManifestOpsError::TemplateChunkSetMissing(release.clone()))?;

        if input.chunk_index >= info.chunk_count {
            return Err(TemplateManifestOpsError::TemplateChunkIndexOutOfRange(
                release,
                input.chunk_index,
            )
            .into());
        }

        let expected_hash = info.chunk_hashes[input.chunk_index as usize].clone();
        let actual_hash = get_wasm_hash(&input.bytes);
        let chunk_key = TemplateChunkKey::new(release, input.chunk_index);

        if actual_hash != expected_hash {
            return Err(TemplateManifestOpsError::TemplateChunkHashMismatch(chunk_key).into());
        }

        TemplateChunkStore::upsert(chunk_key, TemplateChunkRecord { bytes: input.bytes });

        Ok(())
    }

    // Publish one chunk into a local store with capacity enforcement.
    pub fn publish_chunk_in_store_from_input(
        input: TemplateChunkInput,
        limits: WasmStoreLimits,
    ) -> Result<(), InternalError> {
        let release = TemplateReleaseKey::new(input.template_id.clone(), input.version.clone());
        let info = TemplateChunkSetStateStore::get(&release)
            .ok_or_else(|| TemplateManifestOpsError::TemplateChunkSetMissing(release.clone()))?;

        if input.chunk_index >= info.chunk_count {
            return Err(TemplateManifestOpsError::TemplateChunkIndexOutOfRange(
                release,
                input.chunk_index,
            )
            .into());
        }

        let expected_hash = info.chunk_hashes[input.chunk_index as usize].clone();
        let actual_hash = get_wasm_hash(&input.bytes);
        let chunk_key = TemplateChunkKey::new(release, input.chunk_index);

        if actual_hash != expected_hash {
            return Err(TemplateManifestOpsError::TemplateChunkHashMismatch(chunk_key).into());
        }

        let projected_manifests = TemplateManifestStateStore::export().entries;
        let projected_chunk_sets = TemplateChunkSetStateStore::export();
        let projected_chunks = replace_chunk_entries(vec![(
            chunk_key.clone(),
            TemplateChunkRecord {
                bytes: input.bytes.clone(),
            },
        )]);
        ensure_store_limits(
            limits,
            &projected_manifests,
            &projected_chunk_sets,
            &projected_chunks,
        )?;

        TemplateChunkStore::upsert(chunk_key, TemplateChunkRecord { bytes: input.bytes });

        Ok(())
    }

    // Return deterministic chunk-set metadata for one template release.
    pub fn chunk_set_info_response(
        template_id: &TemplateId,
        version: &TemplateVersion,
    ) -> Result<TemplateChunkSetInfoResponse, InternalError> {
        let release = TemplateReleaseKey::new(template_id.clone(), version.clone());
        let record = TemplateChunkSetStateStore::get(&release)
            .ok_or_else(|| TemplateManifestOpsError::TemplateChunkSetMissing(release.clone()))?;

        Ok(chunk_set_record_to_response(record))
    }

    // Return one deterministic chunk for one template release.
    pub fn chunk_response(
        template_id: &TemplateId,
        version: &TemplateVersion,
        chunk_index: u32,
    ) -> Result<TemplateChunkResponse, InternalError> {
        let release = TemplateReleaseKey::new(template_id.clone(), version.clone());
        let chunk_key = TemplateChunkKey::new(release, chunk_index);
        let record = TemplateChunkStore::get(&chunk_key)
            .ok_or_else(|| TemplateManifestOpsError::TemplateChunkMissing(chunk_key.clone()))?;

        Ok(TemplateChunkResponse {
            bytes: record.bytes,
        })
    }

    // Verify that one approved chunked manifest has a complete staged payload with matching hashes.
    pub fn validate_staged_release(
        manifest: &TemplateManifestResponse,
    ) -> Result<(), InternalError> {
        let info = Self::chunk_set_info_response(&manifest.template_id, &manifest.version)?;
        let release =
            TemplateReleaseKey::new(manifest.template_id.clone(), manifest.version.clone());

        if info.chunk_hashes.is_empty() {
            return Err(TemplateManifestOpsError::TemplateChunkSetEmpty(release).into());
        }

        let mut payload = Vec::new();

        for (chunk_index, expected_hash) in info.chunk_hashes.iter().enumerate() {
            let chunk_index = u32::try_from(chunk_index)
                .map_err(|_| TemplateManifestOpsError::ChunkIndexOverflow(release.clone()))?;
            let response =
                Self::chunk_response(&manifest.template_id, &manifest.version, chunk_index)?;
            let actual_hash = get_wasm_hash(&response.bytes);
            let chunk_key = TemplateChunkKey::new(release.clone(), chunk_index);

            if &actual_hash != expected_hash {
                return Err(TemplateManifestOpsError::TemplateChunkHashMismatch(chunk_key).into());
            }

            payload.extend_from_slice(&response.bytes);
        }

        if payload.len() as u64 != manifest.payload_size_bytes {
            return Err(TemplateManifestOpsError::PayloadSizeMismatch(release).into());
        }

        if get_wasm_hash(&payload) != manifest.payload_hash {
            return Err(TemplateManifestOpsError::PayloadHashMismatch(release).into());
        }

        Ok(())
    }

    // Clear all local template metadata and chunk bytes for store-local GC execution.
    pub async fn execute_local_store_gc() -> Result<WasmStoreGcExecutionStats, InternalError> {
        let manifests = TemplateManifestStateStore::export().entries;
        let chunk_sets = TemplateChunkSetStateStore::export();
        let chunks = TemplateChunkStore::export();
        let stored_chunk_hashes = MgmtOps::stored_chunks(canister_self()).await?;
        let template_count =
            u32::try_from(projected_template_versions(&manifests, &chunk_sets, &chunks).len())
                .unwrap_or(u32::MAX);
        let release_count = u32::try_from(
            projected_template_versions(&manifests, &chunk_sets, &chunks)
                .values()
                .map(BTreeSet::len)
                .sum::<usize>(),
        )
        .unwrap_or(u32::MAX);
        let chunk_count = u32::try_from(chunks.len()).unwrap_or(u32::MAX);
        let chunk_store_hash_count = u32::try_from(stored_chunk_hashes.len()).unwrap_or(u32::MAX);
        let reclaimed_store_bytes = occupied_store_bytes(&manifests, &chunk_sets, &chunks);

        MgmtOps::clear_chunk_store(canister_self()).await?;
        TemplateManifestStateStore::clear();
        TemplateChunkSetStateStore::clear();
        TemplateChunkStore::clear();

        Ok(WasmStoreGcExecutionStats {
            reclaimed_store_bytes,
            cleared_template_count: template_count,
            cleared_release_count: release_count,
            cleared_chunk_count: chunk_count,
            cleared_chunk_store_hash_count: chunk_store_hash_count,
        })
    }
}

// Map one stored chunk-set record into the public metadata response.
fn chunk_set_record_to_response(record: TemplateChunkSetRecord) -> TemplateChunkSetInfoResponse {
    TemplateChunkSetInfoResponse {
        chunk_hashes: record.chunk_hashes,
    }
}

fn occupied_store_bytes(
    manifests: &[(TemplateReleaseKey, TemplateManifestRecord)],
    chunk_sets: &[(TemplateReleaseKey, TemplateChunkSetRecord)],
    chunks: &[(TemplateChunkKey, TemplateChunkRecord)],
) -> u64 {
    let manifest_bytes = manifests
        .iter()
        .map(|(template_id, record)| {
            (template_id.to_bytes().len() + record.to_bytes().len()) as u64
        })
        .sum::<u64>();
    let chunk_set_bytes = chunk_sets
        .iter()
        .map(|(release, record)| (release.to_bytes().len() + record.to_bytes().len()) as u64)
        .sum::<u64>();
    let chunk_bytes = chunks
        .iter()
        .map(|(chunk_key, record)| (chunk_key.to_bytes().len() + record.to_bytes().len()) as u64)
        .sum::<u64>();

    manifest_bytes + chunk_set_bytes + chunk_bytes
}

fn ensure_store_limits(
    limits: WasmStoreLimits,
    manifests: &[(TemplateReleaseKey, TemplateManifestRecord)],
    chunk_sets: &[(TemplateReleaseKey, TemplateChunkSetRecord)],
    chunks: &[(TemplateChunkKey, TemplateChunkRecord)],
) -> Result<(), InternalError> {
    let projected_bytes = occupied_store_bytes(manifests, chunk_sets, chunks);
    if projected_bytes > limits.max_store_bytes {
        return Err(TemplateManifestOpsError::WasmStoreCapacityExceeded {
            projected_bytes,
            max_store_bytes: limits.max_store_bytes,
        }
        .into());
    }

    let projected_versions = projected_template_versions(manifests, chunk_sets, chunks);

    if let Some(max_templates) = limits.max_templates {
        let projected_templates = u32::try_from(projected_versions.len()).unwrap_or(u32::MAX);
        if projected_templates > max_templates {
            return Err(TemplateManifestOpsError::WasmStoreTemplateLimitExceeded {
                projected_templates,
                max_templates,
            }
            .into());
        }
    }

    if let Some(max_versions) = limits.max_template_versions_per_template {
        for (template_id, versions) in projected_versions {
            let projected_versions = u16::try_from(versions.len()).unwrap_or(u16::MAX);
            if projected_versions > max_versions {
                return Err(TemplateManifestOpsError::WasmStoreVersionLimitExceeded {
                    template_id,
                    projected_versions,
                    max_template_versions_per_template: max_versions,
                }
                .into());
            }
        }
    }

    Ok(())
}

fn projected_template_versions(
    manifests: &[(TemplateReleaseKey, TemplateManifestRecord)],
    chunk_sets: &[(TemplateReleaseKey, TemplateChunkSetRecord)],
    chunks: &[(TemplateChunkKey, TemplateChunkRecord)],
) -> BTreeMap<TemplateId, BTreeSet<TemplateVersion>> {
    let mut template_versions = BTreeMap::<TemplateId, BTreeSet<TemplateVersion>>::new();

    for (release, _) in manifests {
        template_versions
            .entry(release.template_id.clone())
            .or_default()
            .insert(release.version.clone());
    }

    for (release, _) in chunk_sets {
        template_versions
            .entry(release.template_id.clone())
            .or_default()
            .insert(release.version.clone());
    }

    for (chunk_key, _) in chunks {
        template_versions
            .entry(chunk_key.release.template_id.clone())
            .or_default()
            .insert(chunk_key.release.version.clone());
    }

    template_versions
}

#[allow(dead_code)]
fn projected_manifests_after_replace(
    input: &TemplateManifestInput,
) -> Vec<(TemplateReleaseKey, TemplateManifestRecord)> {
    let role = input.role.clone();
    let release = TemplateReleaseKey::new(input.template_id.clone(), input.version.clone());
    let mut manifests = TemplateManifestStateStore::export().entries;

    for (existing_release, existing) in &mut manifests {
        if existing.role != role {
            continue;
        }
        if *existing_release == release {
            continue;
        }
        if existing.manifest_state != TemplateManifestState::Approved {
            continue;
        }

        existing.manifest_state = TemplateManifestState::Deprecated;
    }

    let record = input_to_record(input.clone());
    if let Some(existing) = manifests
        .iter_mut()
        .find(|(existing_release, _)| *existing_release == release)
    {
        existing.1 = record;
    } else {
        manifests.push((release, record));
    }

    manifests
}

fn replace_chunk_set_entry(
    release: TemplateReleaseKey,
    record: TemplateChunkSetRecord,
) -> Vec<(TemplateReleaseKey, TemplateChunkSetRecord)> {
    let mut entries = TemplateChunkSetStateStore::export();

    if let Some(existing) = entries
        .iter_mut()
        .find(|(existing_release, _)| *existing_release == release)
    {
        existing.1 = record;
    } else {
        entries.push((release, record));
    }

    entries
}

fn replace_chunk_entries(
    replacements: Vec<(TemplateChunkKey, TemplateChunkRecord)>,
) -> Vec<(TemplateChunkKey, TemplateChunkRecord)> {
    let mut entries = TemplateChunkStore::export();

    for (chunk_key, record) in replacements {
        if let Some(existing) = entries
            .iter_mut()
            .find(|(existing_key, _)| *existing_key == chunk_key)
        {
            existing.1 = record;
        } else {
            entries.push((chunk_key, record));
        }
    }

    entries
}