mirror of
https://github.com/rustfs/rustfs.git
synced 2026-10-29 07:17:52 +00:00
Compare commits
58 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| cfe75fddd9 | |||
| fe7854500c | |||
| 75ab3052a9 | |||
| 368cdfd214 | |||
| 90a1eb814e | |||
| b97a952cda | |||
| 0a8e78238b | |||
| fe04c79894 | |||
| 5c4a285a7b | |||
| 9a8faf7c86 | |||
| 0a2f58c7a9 | |||
| 4d97501327 | |||
| 3b2af12c64 | |||
| c73ddde848 | |||
| ef72a37fd7 | |||
| e46cf750dd | |||
| fe955fa3ee | |||
| 64578c067e | |||
| 78715f0921 | |||
| 3284aafd73 | |||
| 9286442f87 | |||
| b8aad1c168 | |||
| 5fcb229760 | |||
| 94baef7462 | |||
| 60d90f085a | |||
| dfa5d50565 | |||
| a902886737 | |||
| 8e53b87421 | |||
| f7631e91b1 | |||
| f9bc4e921f | |||
| 781584307a | |||
| 59d641a5fe | |||
| c618b57870 | |||
| bbe1d54098 | |||
| 9e8ea4dcdb | |||
| 63cf8e2f2f | |||
| b7fe40f4b3 | |||
| 5b872b8e56 | |||
| ca5be1ef95 | |||
| 9373e8fa3e | |||
| cb32965522 | |||
| fb6cf49a67 | |||
| 8c97049e68 | |||
| 17d4fe27cc | |||
| fb0c7972b2 | |||
| eba7967755 | |||
| 451c1c31ad | |||
| 8780dd670e | |||
| f29bf2c902 | |||
| fd03436090 | |||
| 1f1e7b1c97 | |||
| 45a952609e | |||
| 323190a95a | |||
| 38cdda9292 | |||
| 85c84fa73d | |||
| 51402087c5 | |||
| a994984fe2 | |||
| 48eb0e402c |
@@ -45,13 +45,11 @@ Update this file only when an advisory adds or changes a reusable lesson, affect
|
||||
- `GHSA-6r96-hmgc-726c`: request headers collided with lowercase server-derived condition keys such as `userid`, `groups`, `versionid`, and JWT/LDAP claims. Lesson: never let caller-controlled headers append to or replace server-derived policy context; reserve trusted condition keys and keep intentional request-header keys separate.
|
||||
- `GHSA-v9cp-qfw9-9pfp`: quantified negated string conditions applied negation after aggregation, transposing `ForAllValues` and `ForAnyValue` semantics. Lesson: push negation into the per-value predicate for quantified operators and test partially overlapping multi-value sets.
|
||||
- `GHSA-5w8r-p896-6vq2`: OPA policy mode skipped `ExistingObjectTag/*` loading, so tagged objects looked untagged to external policies. Lesson: external authorization plugins need the same object-tag and request context as built-in policy evaluation before they decide.
|
||||
- `GHSA-9wgh-5r68-49p7`: substituted policy-variable values could recreate `${...}` and loop inside a single resolution pass, never reaching the outer iteration limit. Lesson: bound substitutions within each pass and test cycles formed across otherwise literal resolver values; confirm whether attacker-controlled claims can reach those values before assigning remote impact.
|
||||
|
||||
### S3 object actions, copy, multipart, and upload policy validation
|
||||
|
||||
- `GHSA-g8w9-qw9q-fghr` and `GHSA-xm99-m3gq-83g8`: a valid presigned `PutObject` accepted extra `x-amz-*` headers omitted from `SignedHeaders`; `x-amz-copy-source` could turn that upload capability into a cross-bucket read performed as the signer. Lesson: a presigned URL is a bounded capability; inspect all received security-sensitive headers and reject unsigned ones before selecting the S3 operation or reaching storage.
|
||||
- `GHSA-3ppv-fx5m-m749`: explicit `versionId` reads and copy sources authorized `s3:GetObject` instead of `s3:GetObjectVersion`. Lesson: version-specific object access must select version-specific actions for direct reads, `CopyObject`, and `UploadPartCopy`, with tests proving the backend is not reached on denial.
|
||||
- `GHSA-cg33-pxfp-qcj3` and `GHSA-65wq-gjw8-xr9w`: `HeadObject` and object-tagging paths authorized current-object actions while operating on an explicit historical `versionId`. Lesson: select the corresponding version action for metadata and tag reads and writes too; audit every operation that accepts a version ID.
|
||||
- `GHSA-gjph-xcgw-4p7w`: `PutObject` and browser POST accepted a caller-supplied `versionId` and replaced an unlocked historical version with only `s3:PutObject`. Lesson: only replication-authorized writes may choose an existing version ID; ordinary uploads must not rewrite version history.
|
||||
- `GHSA-x298-9x87-fvjq`: anonymous `ListObjectVersions` fell back to `ListBucket` and returned before public-access-block gates. Lesson: compatibility fallbacks must converge on the same post-authorization checks as direct grants, especially `RestrictPublicBuckets` and anonymous data-plane denies.
|
||||
- `GHSA-mx42-j6wv-px98`: `UploadPartCopy` missed source authorization and allowed cross-bucket object exfiltration. Lesson: multipart copy must enforce the same source and destination contract as `CopyObject`.
|
||||
@@ -112,7 +110,6 @@ Update this file only when an advisory adds or changes a reusable lesson, affect
|
||||
|
||||
- `GHSA-j548-9grx-fh4f`: Object Lock enforcement treated unreadable, fabricated, or unparsable bucket metadata as absent configuration and allowed retained objects to be deleted or expired. Lesson: retention must fail closed unless Object Lock absence is authoritative, and every delete, lifecycle, scanner, force-delete, and default-retention path needs the same state distinction.
|
||||
- `GHSA-28w4-rp2p-636w` and `GHSA-c7hx-vr97-45rg`: an authorized `DeleteBucket` with `x-rustfs-force-delete: true` removed active COMPLIANCE-retained versions even though ordinary version deletion was denied. Lesson: bucket force-delete must enforce retention across every version, including against root/owner callers.
|
||||
- `GHSA-q23w-fp7p-472v`: `PutObjectRetention` policy conditions read `x-amz-object-lock-*` headers while the handler applied mode and date from the XML body. Lesson: authorize the parsed retention that will be stored, or reject mismatched header/body values; compare retention dates as instants so offsets cannot change the applied bound.
|
||||
|
||||
### Serde deserialization and input validation
|
||||
|
||||
@@ -146,13 +143,13 @@ rg -n "deny_unknown_fields|serde.default|as u32|as usize|as i32" rustfs crates
|
||||
- IAM fixes: include import/update/list service-account cases with attacker-controlled parent, claims, access key, secret key, and policy.
|
||||
- Copy/upload fixes: include cross-bucket, cross-user, source-denied, destination-denied, copy-source-condition, and multipart completion cases.
|
||||
- Presigned upload fixes: include a valid presign with extra unsigned tagging, redirect, storage-class, and cross-bucket copy-source headers; require rejection before source or destination storage access, and verify explicitly signed equivalents still work.
|
||||
- Version-action fixes: include historical UUID, explicit current version, `null`, range, partNumber, presigned, STS/session, service-account, anonymous bucket-policy, copy source, multipart-copy source, `HeadObject`, and tag read/write cases.
|
||||
- Version-action fixes: include historical UUID, explicit current version, `null`, range, partNumber, presigned, STS/session, service-account, anonymous bucket-policy, copy source, and multipart-copy source cases.
|
||||
- Version-write fixes: a `PutObject`-only principal must not replace an existing version through `PutObject` or browser POST `?versionId=`; verify replication-authorized writes and versioned, suspended, and unversioned buckets separately.
|
||||
- Policy-condition fixes: include reserved-key header collisions, missing keys, partially overlapping multi-value sets, cyclic variable substitutions, plugin mode, and built-in policy mode.
|
||||
- Policy-condition fixes: include reserved-key header collisions, missing keys, partially overlapping multi-value sets, plugin mode, and built-in policy mode.
|
||||
- Path fixes: include encoded traversal, absolute path, nested traversal, archive entries with `..`, valid object keys that resemble traversal text but should be rejected, and canonical bucket/prefix boundary checks; test per-key `DeleteObjects` errors and prefix-scoped denials on versioned buckets.
|
||||
- Logging fixes: assert redacted output for structs and response bodies that may contain credentials.
|
||||
- IAM export fixes: assert exported archives omit plaintext user and service-account secrets unless the format deliberately encrypts or seals them.
|
||||
- RPC auth fixes: include captured metadata replay across two concrete methods, stale timestamps, wrong path, wrong method surrogate, wrong secret, and valid same-method calls.
|
||||
- Browser/CORS fixes: assert no credentials on reflected/default origins, correct behavior for explicit allowlists, and no same-origin script execution for previewed object content.
|
||||
- SSE fixes: inspect stored bytes and verify API metadata, read-back behavior, and on-disk ciphertext together; for ETags, upload equal plaintext under different keys and assert list-only callers cannot derive or correlate the plaintext digest, including multipart objects.
|
||||
- Object Lock fixes: include unreadable metadata, fabricated metadata defaults, unparsable config, confirmed absent config, COMPLIANCE/GOVERNANCE retention, lifecycle expiry, scanner sweeps, and force-delete paths; an authorized force-delete must preserve active COMPLIANCE versions. For `PutObjectRetention`, test conflicting header/body values and offset dates against policy bounds and read-back retention.
|
||||
- Object Lock fixes: include unreadable metadata, fabricated metadata defaults, unparsable config, confirmed absent config, COMPLIANCE/GOVERNANCE retention, lifecycle expiry, scanner sweeps, and force-delete paths; an authorized force-delete must preserve active COMPLIANCE versions.
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
sha256-darwin=ff63177a6280d52ac29f4a14a0c1f7fdcf7cecd442c1f3d3bce0bbdffc0552a5
|
||||
sha256-linux=2cc8bb449f52bdf5d9e88f75dc5c3a94df121a55aa436d5ec95311d42ec5fa0b
|
||||
sha256-darwin=98dff0961c6eb21d6128bfd2d4a6100a624ddf1fb7db05dba360a5d3d0a310c2
|
||||
sha256-linux=890f5925b87e1bf3710c356253f3b2276d901e156df9ccc04ec9315374de6d22
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
sha256-darwin=8ef80b7353d1e0c4f863a2aca7e996d23858b8c32b9edf8fd272076fa63a83d8
|
||||
sha256-linux=99fe1cd128ade2df69b9e3ecf94b91021185a9769293420b1ba5d24760f2ea99
|
||||
sha256-darwin=efe68675f4676a0d2901242c5815b1f7af5cdec8231f7cccd408f6dacf5c75db
|
||||
sha256-linux=003ed6480935a0a95680cc061be143722fbd37bd477b8ff98607b1a064f3aef1
|
||||
|
||||
@@ -1 +1 @@
|
||||
sha256=bf77250d94604db7ba094c5d63bf8a284beb872983871bcfd0dc02e46ff53326
|
||||
sha256=ba8f392b617cf9f2338142233a417e43927b28096635e628233ce8a60cf49d10
|
||||
|
||||
@@ -70,11 +70,6 @@ s3s-footprint-check: ## Check the s3s dependency footprint ratchet stays frozen
|
||||
@echo "📦 Checking s3s footprint ratchet..."
|
||||
./scripts/check_s3s_footprint.sh
|
||||
|
||||
.PHONY: test-count-ratchet-check
|
||||
test-count-ratchet-check: ## Check no workspace crate lost tests or gained #[ignore] against the committed baseline
|
||||
@echo "🧪 Checking per-crate test-count ratchet..."
|
||||
./scripts/check_test_count_ratchet.sh
|
||||
|
||||
.PHONY: fips-wording-check
|
||||
fips-wording-check: ## Check docs and crates/kms do not over-claim crypto capabilities
|
||||
@echo "📣 Checking cryptographic capability wording guard..."
|
||||
|
||||
@@ -20,11 +20,11 @@ planning-docs-check: ## Check that no planning-type documents are committed
|
||||
./scripts/check_no_planning_docs.sh
|
||||
|
||||
.PHONY: pre-commit
|
||||
pre-commit: fmt-check unsafe-code-check architecture-migration-check logging-guardrails-check error-other-ratchet-check tokio-io-uring-check extension-schema-check body-cache-whitelist-check s3s-footprint-check test-count-ratchet-check fips-wording-check embedded-secrets-check test-wiring-check doc-paths-check planning-docs-check quick-check ## Run fast pre-commit checks without clippy/full tests
|
||||
pre-commit: fmt-check unsafe-code-check architecture-migration-check logging-guardrails-check error-other-ratchet-check tokio-io-uring-check extension-schema-check body-cache-whitelist-check s3s-footprint-check fips-wording-check embedded-secrets-check test-wiring-check doc-paths-check planning-docs-check quick-check ## Run fast pre-commit checks without clippy/full tests
|
||||
@echo "✅ All pre-commit checks passed!"
|
||||
|
||||
.PHONY: pre-pr
|
||||
pre-pr: fmt-check unsafe-code-check architecture-migration-check logging-guardrails-check error-other-ratchet-check tokio-io-uring-check extension-schema-check body-cache-whitelist-check s3s-footprint-check test-count-ratchet-check fips-wording-check embedded-secrets-check test-wiring-check doc-paths-check planning-docs-check log-analyzer-rules-check offline-enrollment-e2e-check clippy-check test ## Run full pre-PR checks with clippy and tests
|
||||
pre-pr: fmt-check unsafe-code-check architecture-migration-check logging-guardrails-check error-other-ratchet-check tokio-io-uring-check extension-schema-check body-cache-whitelist-check s3s-footprint-check fips-wording-check embedded-secrets-check test-wiring-check doc-paths-check planning-docs-check log-analyzer-rules-check offline-enrollment-e2e-check clippy-check test ## Run full pre-PR checks with clippy and tests
|
||||
@echo "✅ All pre-PR checks passed!"
|
||||
|
||||
.PHONY: dev-check
|
||||
|
||||
@@ -50,13 +50,8 @@ script-tests: ## Run shell script tests
|
||||
./scripts/test_fuzz_runner.sh
|
||||
./scripts/test_python_bin.sh
|
||||
./scripts/check_embedded_secrets.sh --self-test
|
||||
./scripts/check_s3s_footprint.sh --self-test
|
||||
$(RUSTFS_PYTHON_BIN) ./scripts/check_test_wiring.py --self-test
|
||||
$(RUSTFS_PYTHON_BIN) ./scripts/codemods/s3_error_to_s3_types.py --self-test
|
||||
$(RUSTFS_PYTHON_BIN) ./scripts/test_e2e_binary.py
|
||||
$(RUSTFS_PYTHON_BIN) ./scripts/test_release_build_workflow.py
|
||||
$(RUSTFS_PYTHON_BIN) ./scripts/test_release_glibc.py
|
||||
$(RUSTFS_PYTHON_BIN) ./scripts/test_upgrade_workflow.py
|
||||
$(RUSTFS_PYTHON_BIN) ./scripts/test_migration_gate_evidence.py
|
||||
$(RUSTFS_PYTHON_BIN) ./scripts/ci_gate.py --self-test
|
||||
$(RUSTFS_PYTHON_BIN) ./scripts/check_security_coverage.py --self-test
|
||||
|
||||
@@ -88,11 +88,6 @@ threads-required = "num-test-threads"
|
||||
filter = 'package(rustfs-ecstore) & test(/^(bucket::lifecycle::bucket_lifecycle_ops::tests::manual_transition_worker_result_recovery_marks_unknown_for_corrupt_marker|services::rebalance::entry::tests::real_rebalance_run_fence_loss_blocks_multipart_publication|store::init::tests::(batch_transitioned_delete_uses_free_version_per_item|decommission_entry_(allows_free_version_consumed_before_source_lock|rejects_subquorum_free_version_conflict_and_retains_source|skips_cleanup_only_marker_when_free_version_is_present)|dispatched_tier_delete_recovery_(checks_later_pool_then_commits_after_source_removal|finds_directory_source_on_encoded_set|retains_journal_on_source_metadata_error)|force_tier_remove_blocks_on_physical_free_version_hidden_by_other_pool|legacy_unknown_transition_delete_falls_back_for_single_batch_and_blocks_prefix|multi_pool_(recursive_prefix_rejects_legacy_or_hidden_merge_loser_before_delete|same_remote_tuple_(batch|single)_delete_waits_for_all_sources|same_tuple_recursive_prefix_uses_one_journal_owner|transitioned_delete_persists_one_free_version_per_remote_tuple)|recursive_prefix_partial_(pool|set)_failure_keeps_prepared_cleanup_owners|restored_transitioned_delete_uses_free_version_as_cleanup_owner|stable_transitioned_recursive_prefix_delete_uses_journal_owners|suspended_null_transition_delete_uses_free_version_as_sole_owner|tier_mutation_peer_handler_applies_prepare_commit_and_abort_idempotently|transition_response_loss_persists_unknown_outcome_for_provider_recovery|transition_transaction_recovery_(drops_record_after_confirmed_local_commit|keeps_cleanup_pending_local_commit)|transitioned_delete_(free_version_replays_after_store_restart|local_quorum_failure_rolls_back_without_cleanup_owner|uses_free_version_as_cleanup_owner)|versioned_delete_marker_keeps_transitioned_source_and_remote_object|versioned_explicit_transition_delete_preserves_other_version_then_allows_bucket_delete))$/)'
|
||||
setup = 'ecstore-large-stack'
|
||||
|
||||
# These cross-crate real-storage fixtures need the same bounded stack as ECStore tests.
|
||||
[[profile.default.scripts]]
|
||||
filter = '(package(rustfs) & test(/^(admin::handlers::site_replication::tests::durable_iam_state_apply_iam_item_rejects_a_stale_recreate_after_a_replicated_delete|admin::service::federated_identity::tests::(binding_keeps_explicit_iam_mapping_strict|markerless_legacy_oidc_session_crosses_auth_and_iam_deletion_boundaries)|storage::scanner_dirty_journal::tests::(clear_callback_keeps_unknown_coverage_until_all_pending_work_is_confirmed|owned_journals_keep_peer_records_after_interleaved_writes_and_clear))$/)) | (package(rustfs-heal) & ((binary(heal_b5_versioned_regression_test) & test(/^serial_tests::(test_heal_unversioned_bucket_e2e|test_historical_null_recursive_heal_restores_physical_versions|test_recursive_deep_heal_reports_stale_delete_marker_repair)$/)) | (binary(usage_observation_read_repair_test) & test(=usage_observation_read_repair_survives_snapshot_cleanup)))) | (package(rustfs-test-utils) & test(=data_usage_snapshot_tests::data_usage_snapshot_recovery_wires_primary_backup_and_negative_cache))'
|
||||
setup = 'ecstore-base-stack'
|
||||
|
||||
[[profile.default.scripts]]
|
||||
filter = 'package(rustfs-ecstore) | package(rustfs-s3select-api) | package(rustfs-scanner) | (package(rustfs) & test(/^(app::multipart_usecase::tests::concurrent_completions_share_durable_bucket_quota_reservations|app::object::delete::tests::compressed_delete_requests_update_observed_usage_without_releasing_quota_floor|app::object::internal_put::tests::internal_multipart_roundtrip_completes_and_abort_leaves_nothing|app::object::restore::tests::execute_restore_object_maps_failures_to_typed_s3_errors|storage::access::tests::(delete_object_access_captures_authorized_bucket_incarnation|copy_operations_reject_recreated_source_bucket_after_authorization|request_slot_keeps_bucket_policy_bound_to_its_store))$/))'
|
||||
setup = 'ecstore-base-stack'
|
||||
@@ -344,11 +339,6 @@ threads-required = "num-test-threads"
|
||||
filter = 'package(rustfs-ecstore) & test(/^(bucket::lifecycle::bucket_lifecycle_ops::tests::manual_transition_worker_result_recovery_marks_unknown_for_corrupt_marker|services::rebalance::entry::tests::real_rebalance_run_fence_loss_blocks_multipart_publication|store::init::tests::(batch_transitioned_delete_uses_free_version_per_item|decommission_entry_(allows_free_version_consumed_before_source_lock|rejects_subquorum_free_version_conflict_and_retains_source|skips_cleanup_only_marker_when_free_version_is_present)|dispatched_tier_delete_recovery_(checks_later_pool_then_commits_after_source_removal|finds_directory_source_on_encoded_set|retains_journal_on_source_metadata_error)|force_tier_remove_blocks_on_physical_free_version_hidden_by_other_pool|legacy_unknown_transition_delete_falls_back_for_single_batch_and_blocks_prefix|multi_pool_(recursive_prefix_rejects_legacy_or_hidden_merge_loser_before_delete|same_remote_tuple_(batch|single)_delete_waits_for_all_sources|same_tuple_recursive_prefix_uses_one_journal_owner|transitioned_delete_persists_one_free_version_per_remote_tuple)|recursive_prefix_partial_(pool|set)_failure_keeps_prepared_cleanup_owners|restored_transitioned_delete_uses_free_version_as_cleanup_owner|stable_transitioned_recursive_prefix_delete_uses_journal_owners|suspended_null_transition_delete_uses_free_version_as_sole_owner|tier_mutation_peer_handler_applies_prepare_commit_and_abort_idempotently|transition_response_loss_persists_unknown_outcome_for_provider_recovery|transition_transaction_recovery_(drops_record_after_confirmed_local_commit|keeps_cleanup_pending_local_commit)|transitioned_delete_(free_version_replays_after_store_restart|local_quorum_failure_rolls_back_without_cleanup_owner|uses_free_version_as_cleanup_owner)|versioned_delete_marker_keeps_transitioned_source_and_remote_object|versioned_explicit_transition_delete_preserves_other_version_then_allows_bucket_delete))$/)'
|
||||
setup = 'ecstore-large-stack'
|
||||
|
||||
# These cross-crate real-storage fixtures need the same bounded stack as ECStore tests.
|
||||
[[profile.ci.scripts]]
|
||||
filter = '(package(rustfs) & test(/^(admin::handlers::site_replication::tests::durable_iam_state_apply_iam_item_rejects_a_stale_recreate_after_a_replicated_delete|admin::service::federated_identity::tests::(binding_keeps_explicit_iam_mapping_strict|markerless_legacy_oidc_session_crosses_auth_and_iam_deletion_boundaries)|storage::scanner_dirty_journal::tests::(clear_callback_keeps_unknown_coverage_until_all_pending_work_is_confirmed|owned_journals_keep_peer_records_after_interleaved_writes_and_clear))$/)) | (package(rustfs-heal) & ((binary(heal_b5_versioned_regression_test) & test(/^serial_tests::(test_heal_unversioned_bucket_e2e|test_historical_null_recursive_heal_restores_physical_versions|test_recursive_deep_heal_reports_stale_delete_marker_repair)$/)) | (binary(usage_observation_read_repair_test) & test(=usage_observation_read_repair_survives_snapshot_cleanup)))) | (package(rustfs-test-utils) & test(=data_usage_snapshot_tests::data_usage_snapshot_recovery_wires_primary_backup_and_negative_cache))'
|
||||
setup = 'ecstore-base-stack'
|
||||
|
||||
[[profile.ci.scripts]]
|
||||
filter = 'package(rustfs-ecstore) | package(rustfs-s3select-api) | package(rustfs-scanner) | (package(rustfs) & test(/^(app::multipart_usecase::tests::concurrent_completions_share_durable_bucket_quota_reservations|app::object::delete::tests::compressed_delete_requests_update_observed_usage_without_releasing_quota_floor|app::object::internal_put::tests::internal_multipart_roundtrip_completes_and_abort_leaves_nothing|app::object::restore::tests::execute_restore_object_maps_failures_to_typed_s3_errors|storage::access::tests::(delete_object_access_captures_authorized_bucket_incarnation|copy_operations_reject_recreated_source_bucket_after_authorization|request_slot_keeps_bucket_policy_bound_to_its_store))$/))'
|
||||
setup = 'ecstore-base-stack'
|
||||
@@ -599,14 +589,6 @@ test-group = 'ecstore-serial-flaky'
|
||||
# the PR-lane e2e coverage for scanner usage snapshots consumed by quota and
|
||||
# admin surfaces. It uses the same single-node, random-port, isolated-temp-dir
|
||||
# fixture as the existing smoke modules.
|
||||
#
|
||||
# Dual-stack differential (rustfs/backlog#2740): `dual_stack_differential::`
|
||||
# starts two single-node servers from the same binary, one per
|
||||
# RUSTFS_S3_STACK value, on random ports with isolated temp dirs, and runs one
|
||||
# SDK script covering every operation of `impl S3 for FS` against both. Its
|
||||
# comparator unit tests need no server. It meets the admission criteria
|
||||
# unchanged; the module clause admits a new differential test without another
|
||||
# filter edit.
|
||||
[profile.e2e-smoke]
|
||||
default-filter = """
|
||||
package(e2e_test) & (
|
||||
@@ -614,7 +596,6 @@ default-filter = """
|
||||
| test(/^replication_extension_test::(test_replication_check_succeeds_with_remote_target|test_replication_check_rejects_target_without_object_lock|test_set_remote_target_rejects_unversioned_source_bucket|test_replication_check_rejects_unversioned_source_bucket|test_replication_check_rejects_missing_replication_config|test_replication_check_rejects_invalid_bucket|test_set_remote_target_rejects_same_bucket_on_same_deployment|test_set_remote_target_rejects_unversioned_target_bucket|test_set_remote_target_update_requires_arn|test_set_remote_target_update_rejects_missing_target|test_set_remote_target_rejects_invalid_target_url|test_set_remote_target_rejects_self_signed_https_target_without_skip_tls_verify|test_set_remote_target_rejects_private_ca_https_target_without_ca_cert_pem|test_list_remote_targets_rejects_empty_bucket|test_list_remote_targets_rejects_invalid_bucket|test_remove_remote_target_rejects_missing_target|test_remove_remote_target_rejects_missing_arn|test_remove_remote_target_rejects_invalid_bucket|test_remove_remote_target_rejects_target_used_by_replication|test_delete_bucket_replication_removes_remote_target)$/)
|
||||
| test(/^reliant::lifecycle::/)
|
||||
| test(/^reliant::tiering::/)
|
||||
| test(/^dual_stack_differential::/)
|
||||
| test(/^upgrade_compatibility_test::upgrade_write_readiness_tests::/)
|
||||
| test(/^on_demand_migration::(get_basic_test::(get_miss_pulls_inline_and_serves_locally_afterwards|head_miss_answers_from_the_source_without_persisting)|interaction_test::test_odm_admin_config_is_redacted_and_status_counts_match_the_source)$/)
|
||||
)
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
# Files that may still reference s3s (`s3s::` or `s3s_sigv4`) when Phase 1 of
|
||||
# the gateway migration ends (rustfs/backlog#2734 task T0.6, rustfs/backlog#2741).
|
||||
# Consumed only by `scripts/check_s3s_footprint.sh --mode allowlist`.
|
||||
#
|
||||
# One entry per line: a repository-relative file path or a git `:(glob)`
|
||||
# pathspec. `**` matches across directories, `*` stays within one path
|
||||
# component, and a directory entry matches everything under it. Blank lines
|
||||
# and lines starting with `#` are ignored; an entry may not contain whitespace,
|
||||
# so a note belongs on its own comment line.
|
||||
#
|
||||
# Every Rust file listed by `git grep -l '\bs3s\(::\|_sigv4\)' -- '*.rs'` that
|
||||
# no entry matches fails the allowlist mode. Task T1.9 switches CI to that
|
||||
# mode; until then `--dry-run` prints the files still outside this list, which
|
||||
# is the Phase 1 tracking list.
|
||||
#
|
||||
# Never add crates/** other than crates/e2e_test: the engine crates leave s3s
|
||||
# entirely, and the script rejects such an entry. Only the s3s-facing edge of
|
||||
# the rustfs binary and the e2e oracle keep it.
|
||||
|
||||
# rustfs binary: the s3s-facing edge that survives Phase 1
|
||||
rustfs/src/storage/ecfs.rs
|
||||
rustfs/src/storage/s3_compat/**
|
||||
rustfs/src/storage/access.rs
|
||||
rustfs/src/auth.rs
|
||||
rustfs/src/error.rs
|
||||
rustfs/src/storage_api.rs
|
||||
rustfs/src/app/storage_api.rs
|
||||
rustfs/src/admin/router.rs
|
||||
rustfs/src/app/metadata_route.rs
|
||||
rustfs/src/server/http.rs
|
||||
rustfs/src/server/layer.rs
|
||||
rustfs/src/server/hybrid.rs
|
||||
rustfs/src/protocols/client.rs
|
||||
|
||||
# e2e oracle: the test target that verifies S3 behaviour against s3s
|
||||
crates/e2e_test/src/fake_s3_target/**
|
||||
crates/e2e_test/src/**
|
||||
@@ -1,17 +0,0 @@
|
||||
# Exact baseline for the direct s3s footprint, consumed only by
|
||||
# scripts/check_s3s_footprint.sh (rustfs/backlog#1677; rustfs/backlog#2734 T0.4).
|
||||
#
|
||||
# Each value is the exact measurement of the tree, not a ceiling. CI fails when a
|
||||
# measured counter differs from its line here in either direction:
|
||||
# - a larger measurement means new code widened the s3s surface: route it
|
||||
# through the gateway abstractions instead; never raise a value here;
|
||||
# - a smaller measurement means the PR shrank the surface: lower the matching
|
||||
# value to the measured number in the same PR.
|
||||
#
|
||||
# files Rust files referencing s3s paths, repo-wide minus crates/e2e_test
|
||||
# s3_error_lines lines holding s3_error!, same scope, minus those the script
|
||||
# header's rule clears (rustfs_s3_types's macro); fails closed
|
||||
# ecstore_files Rust files referencing s3s paths under crates/ecstore/src
|
||||
files=194
|
||||
s3_error_lines=1565
|
||||
ecstore_files=36
|
||||
@@ -1,63 +0,0 @@
|
||||
# Per-crate test-count baseline consumed by scripts/check_test_count_ratchet.sh
|
||||
# (rustfs/backlog#2734 section 1 rule 3; T0.3 in rustfs/backlog#2738).
|
||||
#
|
||||
# One row per workspace member: <package>, tests, ignored, tab-separated.
|
||||
# tests counts #[test], #[tokio::test], #[tokio::test(...)] and #[test_case(...)]
|
||||
# attribute lines under the package directory; ignored counts #[ignore] and
|
||||
# #[ignore = "..."]. Both columns are exact: CI fails when a crate's tests fall
|
||||
# below or rise above its row, or when its ignored count changes. Raise a row in
|
||||
# the PR that adds tests; lowering one is a reviewed statement that tests were
|
||||
# intentionally removed. Regenerate with:
|
||||
# scripts/check_test_count_ratchet.sh --update
|
||||
e2e_test 902 18
|
||||
rustfs 5653 62
|
||||
rustfs-audit 70 0
|
||||
rustfs-checksums 26 0
|
||||
rustfs-common 25 0
|
||||
rustfs-concurrency 27 0
|
||||
rustfs-config 43 0
|
||||
rustfs-connect-symbol-catalog 6 0
|
||||
rustfs-credentials 24 0
|
||||
rustfs-crypto 67 0
|
||||
rustfs-data-usage 54 0
|
||||
rustfs-ecstore 6495 1
|
||||
rustfs-extension-schema 23 0
|
||||
rustfs-filemeta 306 0
|
||||
rustfs-heal 843 3
|
||||
rustfs-heal-contracts 6 0
|
||||
rustfs-iam 390 0
|
||||
rustfs-io-core 49 0
|
||||
rustfs-io-metrics 127 0
|
||||
rustfs-keystone 29 0
|
||||
rustfs-kms 715 25
|
||||
rustfs-license 2 0
|
||||
rustfs-lifecycle 152 0
|
||||
rustfs-lock 135 0
|
||||
rustfs-log-analyzer 89 0
|
||||
rustfs-madmin 209 0
|
||||
rustfs-notify 136 0
|
||||
rustfs-object-capacity 92 0
|
||||
rustfs-object-data-cache 140 0
|
||||
rustfs-obs 367 0
|
||||
rustfs-policy 681 0
|
||||
rustfs-protocols 736 1
|
||||
rustfs-protos 63 0
|
||||
rustfs-replication 200 0
|
||||
rustfs-rio 200 0
|
||||
rustfs-rio-v2 34 6
|
||||
rustfs-s3-client 65 0
|
||||
rustfs-s3-ops 8 0
|
||||
rustfs-s3-types 97 0
|
||||
rustfs-s3select-api 206 0
|
||||
rustfs-s3select-query 188 2
|
||||
rustfs-scanner 997 20
|
||||
rustfs-scanner-metrics 81 0
|
||||
rustfs-security-governance 20 0
|
||||
rustfs-signer 31 0
|
||||
rustfs-storage-api 31 0
|
||||
rustfs-targets 603 26
|
||||
rustfs-test-utils 1 0
|
||||
rustfs-tls-runtime 43 0
|
||||
rustfs-trusted-proxies 68 0
|
||||
rustfs-utils 217 0
|
||||
rustfs-zip 30 0
|
||||
@@ -1748,7 +1748,7 @@
|
||||
"uid": "${datasource}"
|
||||
},
|
||||
"editorMode": "code",
|
||||
"expr": "max by (rustfs_cluster_id, job, bucket) (rustfs_cluster_usage_buckets_objects_count{rustfs_cluster_id=\"$storage_cluster\", job=~\"$job\", bucket=~\"$bucket\"})",
|
||||
"expr": "max by (job, bucket) (rustfs_cluster_usage_buckets_objects_count{job=~\"$job\", bucket=~\"$bucket\"})",
|
||||
"legendFormat": "{{bucket}}",
|
||||
"range": true,
|
||||
"refId": "A"
|
||||
@@ -1848,7 +1848,7 @@
|
||||
"uid": "${datasource}"
|
||||
},
|
||||
"editorMode": "code",
|
||||
"expr": "max by (rustfs_cluster_id, job, bucket) (rustfs_cluster_usage_buckets_total_bytes{rustfs_cluster_id=\"$storage_cluster\", job=~\"$job\", bucket=~\"$bucket\"})",
|
||||
"expr": "max by (job, bucket) (rustfs_cluster_usage_buckets_total_bytes{job=~\"$job\", bucket=~\"$bucket\"})",
|
||||
"legendFormat": "{{bucket}}",
|
||||
"range": true,
|
||||
"refId": "A"
|
||||
|
||||
@@ -61,7 +61,6 @@ scrape_configs:
|
||||
otlp:
|
||||
promote_resource_attributes:
|
||||
- service.instance.id
|
||||
- process.pid
|
||||
- service.name
|
||||
- service.namespace
|
||||
- cloud.availability_zone
|
||||
|
||||
@@ -1,48 +0,0 @@
|
||||
evaluation_interval: 1m
|
||||
tests:
|
||||
- name: bucket usage keeps clusters separate and deduplicates reporting nodes
|
||||
interval: 1m
|
||||
input_series:
|
||||
- series: rustfs_cluster_usage_buckets_total_bytes{rustfs_cluster_id="a",job="rustfs",bucket="shared",service_instance_id="a1"}
|
||||
values: '4096 1024'
|
||||
- series: rustfs_cluster_usage_buckets_total_bytes{rustfs_cluster_id="a",job="rustfs",bucket="shared",service_instance_id="a2"}
|
||||
values: '4096 1024'
|
||||
- series: rustfs_cluster_usage_buckets_total_bytes{rustfs_cluster_id="b",job="rustfs",bucket="shared",service_instance_id="b1"}
|
||||
values: '65536 65536'
|
||||
- series: rustfs_cluster_usage_buckets_total_bytes{rustfs_cluster_id="a",job="rustfs",bucket="empty",service_instance_id="a1"}
|
||||
values: '0 0'
|
||||
- series: rustfs_cluster_usage_buckets_objects_count{rustfs_cluster_id="a",job="rustfs",bucket="shared",service_instance_id="a1"}
|
||||
values: '3 1'
|
||||
- series: rustfs_cluster_usage_buckets_objects_count{rustfs_cluster_id="a",job="rustfs",bucket="shared",service_instance_id="a2"}
|
||||
values: '3 1'
|
||||
- series: rustfs_cluster_usage_buckets_objects_count{rustfs_cluster_id="b",job="rustfs",bucket="shared",service_instance_id="b1"}
|
||||
values: '70 70'
|
||||
- series: rustfs_cluster_usage_buckets_objects_count{rustfs_cluster_id="a",job="rustfs",bucket="empty",service_instance_id="a1"}
|
||||
values: '0 0'
|
||||
promql_expr_test:
|
||||
- expr: max by (rustfs_cluster_id, job, bucket) (rustfs_cluster_usage_buckets_total_bytes{rustfs_cluster_id="a",job=~"rustfs",bucket=~".*"})
|
||||
eval_time: 1m
|
||||
exp_samples:
|
||||
- labels: '{rustfs_cluster_id="a",job="rustfs",bucket="shared"}'
|
||||
value: 1024
|
||||
- labels: '{rustfs_cluster_id="a",job="rustfs",bucket="empty"}'
|
||||
value: 0
|
||||
- expr: max by (rustfs_cluster_id, job, bucket) (rustfs_cluster_usage_buckets_objects_count{rustfs_cluster_id="a",job=~"rustfs",bucket=~".*"})
|
||||
eval_time: 1m
|
||||
exp_samples:
|
||||
- labels: '{rustfs_cluster_id="a",job="rustfs",bucket="shared"}'
|
||||
value: 1
|
||||
- labels: '{rustfs_cluster_id="a",job="rustfs",bucket="empty"}'
|
||||
value: 0
|
||||
- expr: max by (rustfs_cluster_id, job, bucket) (rustfs_cluster_usage_buckets_total_bytes)
|
||||
eval_time: 1m
|
||||
exp_samples:
|
||||
- labels: '{rustfs_cluster_id="a",job="rustfs",bucket="shared"}'
|
||||
value: 1024
|
||||
- labels: '{rustfs_cluster_id="a",job="rustfs",bucket="empty"}'
|
||||
value: 0
|
||||
- labels: '{rustfs_cluster_id="b",job="rustfs",bucket="shared"}'
|
||||
value: 65536
|
||||
- expr: rustfs_cluster_usage_buckets_total_bytes{rustfs_cluster_id="a",bucket="unknown"}
|
||||
eval_time: 1m
|
||||
exp_samples: []
|
||||
@@ -86,10 +86,6 @@ runs:
|
||||
shell: bash
|
||||
run: ./scripts/check_s3s_footprint.sh
|
||||
|
||||
- name: Check per-crate test-count ratchet
|
||||
shell: bash
|
||||
run: ./scripts/check_test_count_ratchet.sh
|
||||
|
||||
- name: Check cryptographic capability wording
|
||||
shell: bash
|
||||
run: ./scripts/check_fips_wording.sh
|
||||
|
||||
@@ -36,16 +36,6 @@ inputs:
|
||||
description: "Install cross-compilation tools"
|
||||
required: false
|
||||
default: "false"
|
||||
zig-version:
|
||||
description: >-
|
||||
Zig version for cargo-zigbuild builds. Pinned so the `<target>.<glibc>`
|
||||
baseline semantics cannot drift with an untested zig release.
|
||||
required: false
|
||||
default: "0.17.0"
|
||||
cargo-zigbuild-version:
|
||||
description: "cargo-zigbuild version installed for cross builds."
|
||||
required: false
|
||||
default: "0.23.4"
|
||||
target:
|
||||
description: "Target architecture to add"
|
||||
required: false
|
||||
@@ -109,14 +99,10 @@ runs:
|
||||
- name: Install Zig
|
||||
if: inputs.install-cross-tools == 'true'
|
||||
uses: mlugg/setup-zig@d1434d08867e3ee9daa34448df10607b98908d29 # v2
|
||||
with:
|
||||
version: ${{ inputs.zig-version }}
|
||||
|
||||
- name: Install cargo-zigbuild
|
||||
if: inputs.install-cross-tools == 'true'
|
||||
uses: taiki-e/install-action@a21ae4029b089b9ddc45704028756f51ab8abe48 # cargo-zigbuild
|
||||
with:
|
||||
tool: cargo-zigbuild@${{ inputs.cargo-zigbuild-version }}
|
||||
|
||||
- name: Install cargo-nextest
|
||||
if: inputs.install-test-tools == 'true'
|
||||
@@ -140,5 +126,5 @@ runs:
|
||||
# normalises, so cargo fingerprints stay valid.
|
||||
cache-all-crates: false
|
||||
cache-on-failure: true
|
||||
shared-key: ${{ inputs.cache-shared-key }}${{ inputs.install-cross-tools == 'true' && format('-zig-{0}-zigbuild-{1}', inputs.zig-version, inputs.cargo-zigbuild-version) || '' }}
|
||||
shared-key: ${{ inputs.cache-shared-key }}
|
||||
save-if: ${{ inputs.cache-save-if }}
|
||||
|
||||
@@ -20,7 +20,6 @@ on:
|
||||
paths:
|
||||
- '**/Cargo.toml'
|
||||
- '**/Cargo.lock'
|
||||
- 'third-party/pyroscope/**'
|
||||
- 'deny.toml'
|
||||
- '.github/actions/**'
|
||||
- '.github/workflows/**'
|
||||
@@ -40,7 +39,6 @@ on:
|
||||
paths:
|
||||
- '**/Cargo.toml'
|
||||
- '**/Cargo.lock'
|
||||
- 'third-party/pyroscope/**'
|
||||
- 'deny.toml'
|
||||
- '.github/actions/**'
|
||||
- '.github/workflows/**'
|
||||
@@ -131,13 +129,6 @@ jobs:
|
||||
- name: Run cargo-deny
|
||||
run: cargo deny check --hide-inclusion-graph advisories sources bans licenses
|
||||
|
||||
- name: Test patched profiling dependency
|
||||
env:
|
||||
CARGO_TARGET_DIR: ${{ github.workspace }}/target/pyroscope-dependency
|
||||
run: >-
|
||||
cargo test --manifest-path third-party/pyroscope/Cargo.toml
|
||||
--features backend-pprof-rs --lib --test rustfs_zstd
|
||||
|
||||
workflow-pin-report:
|
||||
name: Workflow Pin Report
|
||||
if: github.repository == 'rustfs/rustfs' && (github.event_name != 'pull_request' || github.event.action != 'closed')
|
||||
|
||||
+39
-56
@@ -213,12 +213,12 @@ jobs:
|
||||
fi
|
||||
|
||||
all='{"include":[
|
||||
{"target_id":"linux-x86_64-musl","os":"sm-standard-4","target":"x86_64-unknown-linux-musl","cross":false,"platform":"linux","rustflags":"","features":"","glibc":""},
|
||||
{"target_id":"linux-aarch64-musl","os":"sm-standard-4-arm","target":"aarch64-unknown-linux-musl","cross":false,"platform":"linux","rustflags":"","features":"","glibc":""},
|
||||
{"target_id":"linux-x86_64-gnu","os":"sm-standard-4","target":"x86_64-unknown-linux-gnu","cross":true,"platform":"linux","rustflags":"","features":"pyroscope","glibc":"2.31"},
|
||||
{"target_id":"linux-aarch64-gnu","os":"sm-standard-4-arm","target":"aarch64-unknown-linux-gnu","cross":true,"platform":"linux","rustflags":"","features":"pyroscope","glibc":"2.31"},
|
||||
{"target_id":"macos-aarch64","os":"macos-latest","target":"aarch64-apple-darwin","cross":false,"platform":"macos","rustflags":"","features":"pyroscope","glibc":""},
|
||||
{"target_id":"windows-x86_64","os":"windows-latest","target":"x86_64-pc-windows-msvc","cross":false,"platform":"windows","rustflags":"","features":"","glibc":""}
|
||||
{"target_id":"linux-x86_64-musl","os":"sm-standard-4","target":"x86_64-unknown-linux-musl","cross":false,"platform":"linux","rustflags":"","features":""},
|
||||
{"target_id":"linux-aarch64-musl","os":"sm-standard-4-arm","target":"aarch64-unknown-linux-musl","cross":false,"platform":"linux","rustflags":"","features":""},
|
||||
{"target_id":"linux-x86_64-gnu","os":"sm-standard-4","target":"x86_64-unknown-linux-gnu","cross":false,"platform":"linux","rustflags":"","features":"pyroscope"},
|
||||
{"target_id":"linux-aarch64-gnu","os":"sm-standard-4-arm","target":"aarch64-unknown-linux-gnu","cross":false,"platform":"linux","rustflags":"","features":"pyroscope"},
|
||||
{"target_id":"macos-aarch64","os":"macos-latest","target":"aarch64-apple-darwin","cross":false,"platform":"macos","rustflags":"","features":"pyroscope"},
|
||||
{"target_id":"windows-x86_64","os":"windows-latest","target":"x86_64-pc-windows-msvc","cross":false,"platform":"windows","rustflags":"","features":""}
|
||||
]}'
|
||||
|
||||
if [[ "${selected}" == "all" ]]; then
|
||||
@@ -246,8 +246,7 @@ jobs:
|
||||
echo "Selected platforms: ${selected}"
|
||||
|
||||
build-rustfs:
|
||||
# Acceptance workflows select artifacts by this stable platform name.
|
||||
name: Build RustFS (${{ matrix.target_id }})
|
||||
name: Build RustFS
|
||||
needs: [ build-check, prepare-platform-matrix ]
|
||||
if: needs.build-check.outputs.should_build == 'true' && needs.prepare-platform-matrix.result == 'success'
|
||||
runs-on: ${{ matrix.os }}
|
||||
@@ -274,7 +273,7 @@ jobs:
|
||||
with:
|
||||
rust-version: stable
|
||||
target: ${{ matrix.target }}
|
||||
cache-shared-key: build-${{ matrix.target }}${{ matrix.glibc && format('-glibc-{0}', matrix.glibc) || '' }}
|
||||
cache-shared-key: build-${{ matrix.target }}
|
||||
# main only. A cache saved on refs/tags/X is scoped to that tag: no
|
||||
# other tag, no main run and no PR can restore it, so every release
|
||||
# cycle wrote up to 12 entries of 1-2GB (preview tag plus final tag,
|
||||
@@ -411,53 +410,35 @@ jobs:
|
||||
shell: bash
|
||||
env:
|
||||
BUILD_TARGET: ${{ matrix.target }}
|
||||
BUILD_OS: ${{ matrix.platform }}-${{ startsWith(matrix.target, 'aarch64-') && 'aarch64' || 'x86_64' }}
|
||||
run: |
|
||||
# Force rebuild by touching build.rs
|
||||
touch rustfs/build.rs
|
||||
|
||||
BINARY_NAMES=(rustfs)
|
||||
if [[ "${{ matrix.platform }}" == "linux" ]]; then
|
||||
BINARY_NAMES+=(rustfs-cli)
|
||||
fi
|
||||
FEATURE_ARGS=()
|
||||
if [[ -n "${{ matrix.features }}" ]]; then
|
||||
FEATURE_ARGS=(--features "${{ matrix.features }}")
|
||||
fi
|
||||
|
||||
# gnu targets pin an explicit glibc baseline (`<target>.<glibc>` for
|
||||
# cargo-zigbuild) so release binaries link no symbols newer than it
|
||||
# and run on older distros such as RHEL/Rocky 9 (glibc 2.34); #8062.
|
||||
TARGET_ARG="$BUILD_TARGET"
|
||||
if [[ -n "${{ matrix.glibc }}" ]]; then
|
||||
TARGET_ARG="${TARGET_ARG}.${{ matrix.glibc }}"
|
||||
fi
|
||||
|
||||
PROFILE_ARGS=()
|
||||
if [[ "$BUILD_TARGET" == *-linux-gnu && "${{ matrix.features }}" == "pyroscope" ]]; then
|
||||
# The in-process profiler resolves names from the final executable.
|
||||
# Retain function symbols without enabling DWARF source information.
|
||||
PROFILE_ARGS=(--config 'profile.release.strip="none"')
|
||||
fi
|
||||
if [[ "${{ matrix.cross }}" == "true" ]]; then
|
||||
cargo zigbuild --release --locked --target "$TARGET_ARG" "${FEATURE_ARGS[@]}" "${PROFILE_ARGS[@]}" -p rustfs --bin rustfs
|
||||
else
|
||||
cargo build --release --locked --target "$TARGET_ARG" "${FEATURE_ARGS[@]}" "${PROFILE_ARGS[@]}" -p rustfs --bin rustfs
|
||||
fi
|
||||
|
||||
# All release targets use same-architecture runners, including GNU
|
||||
# builds that use Zig only to select the glibc ABI floor.
|
||||
bin="target/${{ matrix.target }}/release/rustfs"
|
||||
if [[ -f "${bin}.exe" ]]; then
|
||||
bin="${bin}.exe"
|
||||
fi
|
||||
version_output=$("$bin" --version)
|
||||
if ! grep -Fxq "build target : ${BUILD_TARGET}" <<< "$version_output" || \
|
||||
! grep -Fxq "build os : ${BUILD_OS}" <<< "$version_output" || \
|
||||
! grep -Fxq "rust channel : stable-${BUILD_TARGET}" <<< "$version_output"; then
|
||||
echo "release binary reports an unexpected compile target" >&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ -n "${{ matrix.glibc }}" ]]; then
|
||||
python3 scripts/release/check_glibc.py "${{ matrix.glibc }}" \
|
||||
"target/${{ matrix.target }}/release/rustfs"
|
||||
fi
|
||||
# Build one binary at a time so release LTO links cannot exhaust a
|
||||
# self-hosted runner by running concurrently.
|
||||
for binary in "${BINARY_NAMES[@]}"; do
|
||||
PROFILE_ARGS=()
|
||||
if [[ "$binary" == "rustfs" && "$BUILD_TARGET" == *-linux-gnu && "${{ matrix.features }}" == "pyroscope" ]]; then
|
||||
# The in-process profiler resolves names from the final executable.
|
||||
# Retain function symbols without enabling DWARF source information.
|
||||
PROFILE_ARGS=(--config 'profile.release.strip="none"')
|
||||
fi
|
||||
if [[ "${{ matrix.cross }}" == "true" ]]; then
|
||||
# All cross targets in the matrix are Linux; zigbuild handles them.
|
||||
cargo zigbuild --release --target ${{ matrix.target }} "${FEATURE_ARGS[@]}" "${PROFILE_ARGS[@]}" -p rustfs --bin "$binary"
|
||||
else
|
||||
cargo build --release --target ${{ matrix.target }} "${FEATURE_ARGS[@]}" "${PROFILE_ARGS[@]}" -p rustfs --bin "$binary"
|
||||
fi
|
||||
done
|
||||
|
||||
- name: Verify macOS binary has no dynamic liblzma dependency
|
||||
if: matrix.platform == 'macos'
|
||||
@@ -573,6 +554,9 @@ jobs:
|
||||
fi
|
||||
|
||||
BINARY_FILES=("$BINARY_NAME")
|
||||
if [[ "${{ matrix.platform }}" == "linux" ]]; then
|
||||
BINARY_FILES+=("rustfs-cli")
|
||||
fi
|
||||
|
||||
if [[ "$TARGET" == *-linux-gnu && "${{ matrix.features }}" == "pyroscope" ]]; then
|
||||
BINARY_FILES+=(rustfs.cpu-symbol-catalog.json rustfs.cpu-symbol-catalog.sha256)
|
||||
@@ -687,7 +671,7 @@ jobs:
|
||||
echo "🔧 Build type: ${BUILD_TYPE}"
|
||||
echo "📊 Version: ${VERSION}"
|
||||
|
||||
- name: Verify packaged Linux binary
|
||||
- name: Verify packaged Linux binaries
|
||||
if: matrix.platform == 'linux'
|
||||
shell: bash
|
||||
run: |
|
||||
@@ -695,7 +679,7 @@ jobs:
|
||||
|
||||
package_file="${{ steps.package.outputs.package_file }}"
|
||||
archive_members="$(unzip -Z1 "$package_file" | sort)"
|
||||
expected_members='rustfs'
|
||||
expected_members=$'rustfs\nrustfs-cli'
|
||||
target="${{ matrix.target }}"
|
||||
features="${{ matrix.features }}"
|
||||
if [[ "$target" == *-linux-gnu && "$features" == "pyroscope" ]]; then
|
||||
@@ -707,14 +691,13 @@ jobs:
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# musl targets build natively; the gnu legs are same-arch
|
||||
# cargo-zigbuild builds pinned to the release glibc baseline. Either
|
||||
# way the binaries run on their runner, so executing them here
|
||||
# Every Linux target builds natively, so executing the binaries here
|
||||
# proves each artifact matches its runner architecture.
|
||||
binary_dir="$(mktemp -d)"
|
||||
trap 'rm -rf "$binary_dir"' EXIT
|
||||
unzip -q "$package_file" rustfs -d "$binary_dir"
|
||||
"$binary_dir/rustfs" --version
|
||||
cli_dir="$(mktemp -d)"
|
||||
trap 'rm -rf "$cli_dir"' EXIT
|
||||
unzip -q "$package_file" rustfs rustfs-cli -d "$cli_dir"
|
||||
"$cli_dir/rustfs" --version
|
||||
"$cli_dir/rustfs-cli" --help >/dev/null
|
||||
|
||||
- name: Verify packaged console
|
||||
if: matrix.target == 'x86_64-unknown-linux-gnu' || matrix.target == 'aarch64-unknown-linux-gnu'
|
||||
|
||||
@@ -99,7 +99,7 @@ env:
|
||||
RUST_BACKTRACE: 1
|
||||
|
||||
jobs:
|
||||
# Readers: test-and-lint (workspace and ILM), build-rustfs-debug-binary,
|
||||
# Readers: test-and-lint, test-ilm-integration-serial, build-rustfs-debug-binary,
|
||||
# e2e-tests, e2e-full.
|
||||
warm-ci-dev:
|
||||
name: Warm ci-dev
|
||||
|
||||
+89
-146
@@ -16,9 +16,7 @@ name: Continuous Integration
|
||||
|
||||
on:
|
||||
push:
|
||||
# gateway/integration receives the daily merge of main as a direct push
|
||||
# (rustfs/backlog#2734), so its pushes must prove the result like main's.
|
||||
branches: [ main, gateway/integration ]
|
||||
branches: [ main ]
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
- "docs/**"
|
||||
@@ -170,10 +168,13 @@ jobs:
|
||||
echo "started_at=$(date --utc --iso-8601=seconds)"
|
||||
} > artifacts/test-and-lint/run-metadata.txt
|
||||
|
||||
# Keep full Clippy validation on main, merge groups, and scheduled/manual
|
||||
# runs. PRs retain the complete default test suite and compile-free checks.
|
||||
# Clippy runs before the test pass: lint failures are the most common
|
||||
# CI-only breakage and should surface in minutes, not after 20+ minutes
|
||||
# of tests.
|
||||
# Sampled too: clippy is the natural control arm for any CARGO_BUILD_JOBS
|
||||
# experiment, since --all-targets is check-only for workspace members and
|
||||
# never links the ~100 test binaries the limit exists to throttle.
|
||||
- name: Run clippy lints
|
||||
if: github.event_name != 'pull_request'
|
||||
run: |
|
||||
./scripts/ci/resource_sampler.sh start clippy
|
||||
trap './scripts/ci/resource_sampler.sh stop' EXIT
|
||||
@@ -282,49 +283,6 @@ jobs:
|
||||
- name: Verify rebalance/decommission migration proofs
|
||||
run: ./scripts/check_migration_gate_count.sh evidence artifacts/test-and-lint/core-test-listing.json target/nextest/ci/junit.xml
|
||||
|
||||
# The workspace already compiled these ignored tests. Keep the same Cargo
|
||||
# package selection to reuse their binaries, then run them serially in
|
||||
# separate processes because they share fixed ports and global state.
|
||||
# test_transition_and_restore_flows was re-enabled by rustfs/backlog#1303:
|
||||
# its "missing xl.meta on disk2" was a test-util bug (open_disk hardcoded
|
||||
# disk_index 0), not an EC metadata-distribution issue.
|
||||
# restore_object_usecase_reports_ongoing_conflict_and_completion was
|
||||
# re-enabled by backlog#1304 (restore accepts serialize on a short CAS
|
||||
# guard; the copy-back no longer holds the #4877 whole-copy-back lock,
|
||||
# so the mid-restore ongoing read and fast 409 rejection it asserts are
|
||||
# the implemented contract).
|
||||
- name: Run ignored ILM integration tests serially
|
||||
if: needs.classify-changes.outputs.mode == 'full'
|
||||
env:
|
||||
# Match the preceding workspace build and reuse its feature graph.
|
||||
CARGO_BUILD_JOBS: ${{ (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && '3' || '2' }}
|
||||
run: |
|
||||
mkdir -p artifacts/ilm-integration
|
||||
set +e
|
||||
NEXTEST_HIDE_PROGRESS_BAR=1 timeout --verbose --signal=TERM --kill-after=30s 80m \
|
||||
cargo nextest run --profile default -j1 --run-ignored ignored-only \
|
||||
--all --exclude e2e_test \
|
||||
-E 'binary(lifecycle_integration_test) or (package(rustfs) and test(lifecycle_transition_api_test))' \
|
||||
--status-level all --final-status-level all \
|
||||
2>&1 | tee artifacts/ilm-integration/nextest.log
|
||||
status=${PIPESTATUS[0]}
|
||||
{
|
||||
echo "exit_status=${status}"
|
||||
echo "finished_at=$(date --utc --iso-8601=seconds)"
|
||||
echo
|
||||
echo "Remaining test-related processes:"
|
||||
pgrep -af 'cargo|nextest|target/.*/deps/' || true
|
||||
} > artifacts/ilm-integration/diagnostics.txt
|
||||
exit "${status}"
|
||||
|
||||
- name: Upload ILM test diagnostics
|
||||
if: always() && needs.classify-changes.outputs.mode == 'full'
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
with:
|
||||
name: ilm-integration-${{ github.run_number }}-${{ github.run_attempt }}
|
||||
path: artifacts/ilm-integration
|
||||
retention-days: 3
|
||||
|
||||
# This gate builds into a fresh target directory to isolate the E2E root.
|
||||
# Give its cold build a separate budget from workspace tests and migration proofs.
|
||||
offline-enrollment-e2e:
|
||||
@@ -356,11 +314,83 @@ jobs:
|
||||
- name: Check offline enrollment E2E root boundary
|
||||
run: ./scripts/check_offline_enrollment_e2e.sh
|
||||
|
||||
# Dedicated serial lane for the ILM / lifecycle integration tests. These tests
|
||||
# drive the object layer through process-global singletons (the GLOBAL_ENV
|
||||
# ECStore, the global tier-config manager, background-expiry workers) and bind
|
||||
# fixed ports (9002 for the scanner suite, 9003 for the app suite), so they are
|
||||
# marked #[ignore] to keep them out of the default parallel `cargo nextest run
|
||||
# --all` pass. Run them here explicitly with `--run-ignored ignored-only` and
|
||||
# `-j1` so no two of them share global state or race for a port at once.
|
||||
# serial_test's #[serial] does NOT serialize across nextest's process-per-test
|
||||
# boundary (see .config/nextest.toml); `-j1` is what actually serializes them.
|
||||
# See rustfs/backlog#1148 (ilm-1) and #1155.
|
||||
test-ilm-integration-serial:
|
||||
name: ILM Integration (serial)
|
||||
if: needs.classify-changes.outputs.mode == 'full' && (github.event_name != 'pull_request' || github.event.action != 'closed')
|
||||
needs: [ quick-checks, classify-changes ]
|
||||
runs-on: sm-standard-4
|
||||
timeout-minutes: 90
|
||||
env:
|
||||
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true"
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@f548e57e544e1ff5a4c46bf1e1b8685f8e4a348a # v7
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Setup Rust environment
|
||||
uses: ./.github/actions/setup
|
||||
with:
|
||||
rust-version: stable
|
||||
cache-shared-key: ci-dev
|
||||
cache-save-if: 'false'
|
||||
install-build-packaging-tools: 'false'
|
||||
|
||||
# test_transition_and_restore_flows was re-enabled by rustfs/backlog#1303:
|
||||
# its "missing xl.meta on disk2" was a test-util bug (open_disk hardcoded
|
||||
# disk_index 0), not an EC metadata-distribution issue.
|
||||
# restore_object_usecase_reports_ongoing_conflict_and_completion was
|
||||
# re-enabled by backlog#1304 (restore accepts serialize on a short CAS
|
||||
# guard; the copy-back no longer holds the #4877 whole-copy-back lock,
|
||||
# so the mid-restore ongoing read and fast 409 rejection it asserts are
|
||||
# the implemented contract).
|
||||
- name: Run ignored ILM integration tests serially
|
||||
env:
|
||||
# Match the measured Test and Lint link budget. The default exposed
|
||||
# all 14 pod CPUs and a cold cache spent the full 80m compiling
|
||||
# without starting one ILM test (main run 32982910990).
|
||||
CARGO_BUILD_JOBS: ${{ (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && '3' || '2' }}
|
||||
run: |
|
||||
mkdir -p artifacts/ilm-integration
|
||||
set +e
|
||||
NEXTEST_HIDE_PROGRESS_BAR=1 timeout --verbose --signal=TERM --kill-after=30s 80m \
|
||||
cargo nextest run -j1 --run-ignored ignored-only \
|
||||
-p rustfs-scanner -p rustfs \
|
||||
-E 'binary(lifecycle_integration_test) or (package(rustfs) and test(lifecycle_transition_api_test))' \
|
||||
--status-level all --final-status-level all \
|
||||
2>&1 | tee artifacts/ilm-integration/nextest.log
|
||||
status=${PIPESTATUS[0]}
|
||||
{
|
||||
echo "exit_status=${status}"
|
||||
echo "finished_at=$(date --utc --iso-8601=seconds)"
|
||||
echo
|
||||
echo "Remaining test-related processes:"
|
||||
pgrep -af 'cargo|nextest|target/.*/deps/' || true
|
||||
} > artifacts/ilm-integration/diagnostics.txt
|
||||
exit "${status}"
|
||||
|
||||
- name: Upload ILM test diagnostics
|
||||
if: always()
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
with:
|
||||
name: ilm-integration-${{ github.run_number }}-${{ github.run_attempt }}
|
||||
path: |
|
||||
artifacts/ilm-integration
|
||||
target/nextest/ci/junit.xml
|
||||
|
||||
test-and-lint-rio-v2:
|
||||
name: Test and Lint (rio-v2)
|
||||
# Alternate feature configurations run on main, merge groups, and scheduled
|
||||
# or manual validation; the default workspace remains the PR gate.
|
||||
if: needs.classify-changes.outputs.mode == 'full' && github.event_name != 'pull_request'
|
||||
if: needs.classify-changes.outputs.mode == 'full' && (github.event_name != 'pull_request' || github.event.action != 'closed')
|
||||
needs: [ quick-checks, classify-changes ]
|
||||
runs-on: sm-standard-4
|
||||
timeout-minutes: 90
|
||||
@@ -476,7 +506,7 @@ jobs:
|
||||
|
||||
test-and-lint-protocols:
|
||||
name: "Test and Lint (${{ matrix.features.name }})"
|
||||
if: needs.classify-changes.outputs.mode == 'full' && github.event_name != 'pull_request'
|
||||
if: needs.classify-changes.outputs.mode == 'full' && (github.event_name != 'pull_request' || github.event.action != 'closed')
|
||||
needs: [ quick-checks, classify-changes ]
|
||||
runs-on: sm-standard-4
|
||||
timeout-minutes: 90
|
||||
@@ -750,8 +780,6 @@ jobs:
|
||||
needs: [ build-rustfs-debug-binary ]
|
||||
runs-on: sm-standard-2
|
||||
timeout-minutes: 30
|
||||
env:
|
||||
RUSTFS_S3_STACK: legacy
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@f548e57e544e1ff5a4c46bf1e1b8685f8e4a348a # v7
|
||||
@@ -870,105 +898,18 @@ jobs:
|
||||
path: ${{ runner.temp }}/rustfs-e2e-*/rustfs.log
|
||||
retention-days: 3
|
||||
|
||||
# The same e2e-smoke suite against the same debug binary with the gateway
|
||||
# S3 stack selected (rustfs/backlog#2734). Report-only: it is outside the
|
||||
# Test and Lint aggregate and becomes required at T2.10. The archive and run
|
||||
# steps must stay identical to e2e-tests; scripts/ci_gate.py enforces that.
|
||||
e2e-tests-gateway:
|
||||
name: e2e-smoke (gateway, report-only until T2.10)
|
||||
needs: [ build-rustfs-debug-binary ]
|
||||
runs-on: sm-standard-2
|
||||
timeout-minutes: 30
|
||||
continue-on-error: true
|
||||
env:
|
||||
RUSTFS_S3_STACK: gateway
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@f548e57e544e1ff5a4c46bf1e1b8685f8e4a348a # v7
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Setup Rust environment
|
||||
uses: ./.github/actions/setup
|
||||
with:
|
||||
rust-version: stable
|
||||
cache-shared-key: ci-dev
|
||||
cache-save-if: 'false'
|
||||
install-build-packaging-tools: 'false'
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: "3.12"
|
||||
|
||||
- name: Install awscurl
|
||||
run: |
|
||||
python3 -m pip install --user --upgrade pip "awscurl==0.44"
|
||||
echo "AWSCURL_PATH=$HOME/.local/bin/awscurl" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Verify awscurl
|
||||
run: test -x "$AWSCURL_PATH"
|
||||
|
||||
- name: Download debug binary
|
||||
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
|
||||
with:
|
||||
name: rustfs-debug-binary
|
||||
path: target/debug
|
||||
|
||||
- name: Make binary executable
|
||||
run: chmod +x ./target/debug/rustfs
|
||||
|
||||
- name: Archive e2e smoke test binaries
|
||||
env:
|
||||
NEXTEST_ARCHIVE: ${{ runner.temp }}/rustfs-e2e-smoke.tar.zst
|
||||
NEXTEST_LISTING: ${{ runner.temp }}/rustfs-e2e-smoke-list.json
|
||||
run: |
|
||||
cargo nextest archive --profile e2e-smoke -p e2e_test --archive-file "${NEXTEST_ARCHIVE}"
|
||||
cargo nextest list --profile e2e-smoke --archive-file "${NEXTEST_ARCHIVE}" --message-format json > "${NEXTEST_LISTING}"
|
||||
python3 ./scripts/check_test_wiring.py --check-profile e2e-smoke "${NEXTEST_LISTING}"
|
||||
./scripts/check_security_smoke_count.sh check "${NEXTEST_LISTING}"
|
||||
|
||||
- name: Run e2e smoke suite
|
||||
env:
|
||||
NEXTEST_ARCHIVE: ${{ runner.temp }}/rustfs-e2e-smoke.tar.zst
|
||||
RUSTFS_E2E_LOG_DIR: ${{ runner.temp }}/rustfs-e2e-smoke-logs
|
||||
SAMPLER_INTERVAL_SECS: "15"
|
||||
run: |
|
||||
./scripts/ci/resource_sampler.sh start e2e-smoke
|
||||
trap './scripts/ci/resource_sampler.sh stop' EXIT
|
||||
python3 scripts/e2e_binary.py run --features e2e-test-hooks -- cargo nextest run --profile e2e-smoke --archive-file "${NEXTEST_ARCHIVE}" \
|
||||
--status-level all --final-status-level all --failure-output final
|
||||
|
||||
- name: Upload e2e smoke diagnostics
|
||||
if: always()
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
with:
|
||||
name: e2e-smoke-gateway-diagnostics-${{ github.run_number }}
|
||||
path: |
|
||||
${{ runner.temp }}/rustfs-e2e-smoke-logs/
|
||||
${{ runner.temp }}/rustfs-e2e-smoke-list.json
|
||||
if-no-files-found: warn
|
||||
|
||||
- name: Upload e2e smoke JUnit report
|
||||
if: always()
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
with:
|
||||
name: e2e-smoke-gateway-junit-${{ github.run_number }}
|
||||
path: target/nextest/e2e-smoke/junit.xml
|
||||
if-no-files-found: warn
|
||||
|
||||
e2e-full:
|
||||
name: End-to-End Tests (full merge gate)
|
||||
# Merge gate only (backlog#1149 ci-5): the never-automated user-visible
|
||||
# suites — KMS, object_lock, multipart_auth, quota, checksum, encryption,
|
||||
# security-boundary, ... — via the e2e-full nextest profile. Too heavy for
|
||||
# every PR, so it is gated to main and gateway/integration pushes, the merge
|
||||
# queue, and manual dispatch. protocols / the 7 cluster suites / replication
|
||||
# / #[ignore] are owned by other lanes (see .config/nextest.toml profile.e2e-full).
|
||||
# every PR, so it is gated to main pushes, the merge queue, and manual
|
||||
# dispatch. protocols / the 7 cluster suites / replication / #[ignore] are
|
||||
# owned by other lanes (see .config/nextest.toml profile.e2e-full).
|
||||
if: >-
|
||||
github.event_name == 'workflow_dispatch' ||
|
||||
github.event_name == 'merge_group' ||
|
||||
(github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/gateway/integration'))
|
||||
(github.event_name == 'push' && github.ref == 'refs/heads/main')
|
||||
needs: [ build-rustfs-debug-binary ]
|
||||
runs-on: sm-standard-2
|
||||
timeout-minutes: 55
|
||||
@@ -1323,6 +1264,7 @@ jobs:
|
||||
- quick-checks
|
||||
- test-and-lint
|
||||
- offline-enrollment-e2e
|
||||
- test-ilm-integration-serial
|
||||
- test-and-lint-rio-v2
|
||||
- connect-short-credential-boundary
|
||||
- test-and-lint-protocols
|
||||
@@ -1356,6 +1298,7 @@ jobs:
|
||||
- quick-checks
|
||||
- test-and-lint
|
||||
- offline-enrollment-e2e
|
||||
- test-ilm-integration-serial
|
||||
- test-and-lint-rio-v2
|
||||
- test-and-lint-protocols
|
||||
- build-rustfs-debug-binary
|
||||
|
||||
@@ -57,11 +57,6 @@ jobs:
|
||||
ref: ${{ inputs.connect_sha }}
|
||||
token: ${{ secrets.PF_TESTING_GH_TOKEN }}
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: "3.14"
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
with:
|
||||
@@ -99,7 +94,7 @@ jobs:
|
||||
' <<<"$run" >/dev/null
|
||||
jobs=$(gh api --paginate --slurp "repos/${GITHUB_REPOSITORY}/actions/runs/${BUILD_RUN_ID}/jobs?per_page=100")
|
||||
jq -e '
|
||||
[.[].jobs[] | select(.name | test("^Build RustFS \\(linux-x86_64-gnu\\)$"))] as $matches
|
||||
[.[].jobs[] | select(.name | test("^Build RustFS \\(linux-x86_64-gnu, [a-z0-9-]+, x86_64-unknown-linux-gnu, false, linux, pyroscope\\)$"))] as $matches
|
||||
| ($matches | length) == 1 and $matches[0].conclusion == "success"
|
||||
' <<<"$jobs" >/dev/null
|
||||
artifact=$(gh api "repos/${GITHUB_REPOSITORY}/actions/artifacts/${ARTIFACT_ID}")
|
||||
@@ -142,7 +137,7 @@ jobs:
|
||||
assert outer.testzip() is None
|
||||
with zipfile.ZipFile(io.BytesIO(outer.read(package))) as inner:
|
||||
entries = inner.infolist()
|
||||
assert {item.filename for item in entries} == {'rustfs', 'rustfs.cpu-symbol-catalog.json', 'rustfs.cpu-symbol-catalog.sha256'} and len(entries) == 3
|
||||
assert {item.filename for item in entries} == {'rustfs', 'rustfs-cli'} and len(entries) == 2
|
||||
assert all(regular(item) and 0 < item.file_size <= 1073741824 for item in entries)
|
||||
assert inner.testzip() is None
|
||||
pathlib.Path('binary').mkdir()
|
||||
|
||||
@@ -57,11 +57,6 @@ jobs:
|
||||
ref: ${{ inputs.connect_sha }}
|
||||
token: ${{ secrets.PF_TESTING_GH_TOKEN }}
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: "3.14"
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
with:
|
||||
@@ -132,7 +127,7 @@ jobs:
|
||||
' <<<"$run" >/dev/null
|
||||
jobs=$(gh api --paginate --slurp "repos/rustfs/rustfs/actions/runs/${BUILD_RUN_ID}/jobs?per_page=100")
|
||||
jq -e '
|
||||
[.[].jobs[] | select(.name | test("^Build RustFS \\(linux-x86_64-gnu\\)$"))] as $matches
|
||||
[.[].jobs[] | select(.name | test("^Build RustFS \\(linux-x86_64-gnu, [a-z0-9-]+, x86_64-unknown-linux-gnu, false, linux, pyroscope\\)$"))] as $matches
|
||||
| ($matches | length) == 1 and $matches[0].conclusion == "success"
|
||||
' <<<"$jobs" >/dev/null
|
||||
artifact=$(gh api "repos/rustfs/rustfs/actions/artifacts/${ARTIFACT_ID}")
|
||||
@@ -177,7 +172,7 @@ jobs:
|
||||
assert outer.testzip() is None
|
||||
with zipfile.ZipFile(io.BytesIO(outer.read(package))) as inner:
|
||||
entries = inner.infolist()
|
||||
assert {entry.filename for entry in entries} == {'rustfs', 'rustfs.cpu-symbol-catalog.json', 'rustfs.cpu-symbol-catalog.sha256'} and len(entries) == 3
|
||||
assert {entry.filename for entry in entries} == {'rustfs', 'rustfs-cli', 'rustfs.cpu-symbol-catalog.json', 'rustfs.cpu-symbol-catalog.sha256'} and len(entries) == 4
|
||||
assert all(regular(entry) and 0 < entry.file_size <= 1073741824 for entry in entries)
|
||||
assert inner.testzip() is None
|
||||
pathlib.Path('binary').mkdir()
|
||||
|
||||
@@ -73,11 +73,6 @@ jobs:
|
||||
ref: ${{ inputs.connect_sha }}
|
||||
token: ${{ secrets.PF_TESTING_GH_TOKEN }}
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: "3.14"
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
with:
|
||||
@@ -112,7 +107,7 @@ jobs:
|
||||
[[ $(jq -r '.head_repository.full_name' <<<"$run") == "$GITHUB_REPOSITORY" ]]
|
||||
[[ $(jq -r '.name' <<<"$run") == "Build and Release" ]]
|
||||
|
||||
expected_job='Build RustFS (linux-x86_64-gnu)'
|
||||
expected_job='Build RustFS (linux-x86_64-gnu, sm-standard-4, x86_64-unknown-linux-gnu, false, linux, pyroscope)'
|
||||
jobs=$(gh api --paginate --slurp "repos/${GITHUB_REPOSITORY}/actions/runs/${BUILD_RUN_ID}/jobs?per_page=100")
|
||||
jq -e --arg name "$expected_job" '
|
||||
[.[].jobs[] | select(.name == $name)] as $matches
|
||||
|
||||
@@ -73,11 +73,6 @@ jobs:
|
||||
ref: ${{ inputs.connect_sha }}
|
||||
token: ${{ secrets.PF_TESTING_GH_TOKEN }}
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: "3.14"
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
with:
|
||||
@@ -112,7 +107,7 @@ jobs:
|
||||
[[ $(jq -r '.head_repository.full_name' <<<"$run") == "$GITHUB_REPOSITORY" ]]
|
||||
[[ $(jq -r '.name' <<<"$run") == "Build and Release" ]]
|
||||
|
||||
expected_job='Build RustFS (linux-x86_64-gnu)'
|
||||
expected_job='Build RustFS (linux-x86_64-gnu, sm-standard-4, x86_64-unknown-linux-gnu, false, linux, pyroscope)'
|
||||
jobs=$(gh api --paginate --slurp "repos/${GITHUB_REPOSITORY}/actions/runs/${BUILD_RUN_ID}/jobs?per_page=100")
|
||||
jq -e --arg name "$expected_job" '
|
||||
[.[].jobs[] | select(.name == $name)] as $matches
|
||||
|
||||
@@ -77,11 +77,6 @@ jobs:
|
||||
ref: ${{ inputs.connect_sha }}
|
||||
token: ${{ secrets.PF_TESTING_GH_TOKEN }}
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: "3.14"
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
with:
|
||||
@@ -123,7 +118,7 @@ jobs:
|
||||
[[ $(jq -r '.head_repository.full_name' <<<"$run") == "$GITHUB_REPOSITORY" ]]
|
||||
[[ $(jq -r '.name' <<<"$run") == "Build and Release" ]]
|
||||
|
||||
expected_job='Build RustFS (linux-x86_64-gnu)'
|
||||
expected_job='Build RustFS (linux-x86_64-gnu, sm-standard-4, x86_64-unknown-linux-gnu, false, linux, pyroscope)'
|
||||
jobs=$(github_api "repos/${GITHUB_REPOSITORY}/actions/runs/${BUILD_RUN_ID}/jobs?per_page=100")
|
||||
jq -e --arg name "$expected_job" '
|
||||
[.jobs[] | select(.name == $name)] as $matches
|
||||
|
||||
@@ -57,11 +57,6 @@ jobs:
|
||||
ref: ${{ inputs.connect_sha }}
|
||||
token: ${{ secrets.PF_TESTING_GH_TOKEN }}
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: "3.14"
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
with:
|
||||
@@ -132,7 +127,7 @@ jobs:
|
||||
' <<<"$run" >/dev/null
|
||||
jobs=$(gh api --paginate --slurp "repos/rustfs/rustfs/actions/runs/${BUILD_RUN_ID}/jobs?per_page=100")
|
||||
jq -e '
|
||||
[.[].jobs[] | select(.name | test("^Build RustFS \\(linux-x86_64-gnu\\)$"))] as $matches
|
||||
[.[].jobs[] | select(.name | test("^Build RustFS \\(linux-x86_64-gnu, [a-z0-9-]+, x86_64-unknown-linux-gnu, false, linux, pyroscope\\)$"))] as $matches
|
||||
| ($matches | length) == 1 and $matches[0].conclusion == "success"
|
||||
' <<<"$jobs" >/dev/null
|
||||
artifact=$(gh api "repos/rustfs/rustfs/actions/artifacts/${ARTIFACT_ID}")
|
||||
@@ -177,7 +172,7 @@ jobs:
|
||||
assert outer.testzip() is None
|
||||
with zipfile.ZipFile(io.BytesIO(outer.read(package))) as inner:
|
||||
entries = inner.infolist()
|
||||
expected = {'rustfs', 'rustfs.cpu-symbol-catalog.json', 'rustfs.cpu-symbol-catalog.sha256'}
|
||||
expected = {'rustfs', 'rustfs-cli', 'rustfs.cpu-symbol-catalog.json', 'rustfs.cpu-symbol-catalog.sha256'}
|
||||
assert {entry.filename for entry in entries} == expected and len(entries) == len(expected)
|
||||
assert all(regular(entry) and 0 < entry.file_size <= 1073741824 for entry in entries)
|
||||
assert inner.testzip() is None
|
||||
|
||||
@@ -81,11 +81,6 @@ jobs:
|
||||
ref: ${{ inputs.connect_sha }}
|
||||
token: ${{ secrets.PF_TESTING_GH_TOKEN }}
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: "3.14"
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
with:
|
||||
@@ -153,7 +148,7 @@ jobs:
|
||||
[[ $(jq -r '.head_repository.full_name' <<<"$run") == "$GITHUB_REPOSITORY" ]]
|
||||
[[ $(jq -r '.name' <<<"$run") == "Build and Release" ]]
|
||||
|
||||
expected_job='Build RustFS (linux-x86_64-gnu)'
|
||||
expected_job='Build RustFS (linux-x86_64-gnu, sm-standard-4, x86_64-unknown-linux-gnu, false, linux, pyroscope)'
|
||||
jobs=$(gh api --paginate --slurp "repos/${GITHUB_REPOSITORY}/actions/runs/${BUILD_RUN_ID}/jobs?per_page=100")
|
||||
jq -e --arg name "$expected_job" '
|
||||
[.[].jobs[] | select(.name == $name)] as $matches
|
||||
|
||||
@@ -73,11 +73,6 @@ jobs:
|
||||
ref: ${{ inputs.connect_sha }}
|
||||
token: ${{ secrets.PF_TESTING_GH_TOKEN }}
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: "3.14"
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
with:
|
||||
@@ -112,7 +107,7 @@ jobs:
|
||||
[[ $(jq -r '.head_repository.full_name' <<<"$run") == "$GITHUB_REPOSITORY" ]]
|
||||
[[ $(jq -r '.name' <<<"$run") == "Build and Release" ]]
|
||||
|
||||
expected_job='Build RustFS (linux-x86_64-gnu)'
|
||||
expected_job='Build RustFS (linux-x86_64-gnu, sm-standard-4, x86_64-unknown-linux-gnu, false, linux, pyroscope)'
|
||||
jobs=$(gh api --paginate --slurp "repos/${GITHUB_REPOSITORY}/actions/runs/${BUILD_RUN_ID}/jobs?per_page=100")
|
||||
jq -e --arg name "$expected_job" '
|
||||
[.[].jobs[] | select(.name == $name)] as $matches
|
||||
|
||||
@@ -68,11 +68,6 @@ jobs:
|
||||
ref: ${{ inputs.connect_sha }}
|
||||
token: ${{ secrets.PF_TESTING_GH_TOKEN }}
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: "3.14"
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
with:
|
||||
@@ -143,7 +138,7 @@ jobs:
|
||||
' <<<"$run" >/dev/null
|
||||
jobs=$(gh api --paginate --slurp "repos/rustfs/rustfs/actions/runs/${BUILD_RUN_ID}/jobs?per_page=100")
|
||||
jq -e '
|
||||
[.[].jobs[] | select(.name | test("^Build RustFS \\(linux-x86_64-gnu\\)$"))] as $matches
|
||||
[.[].jobs[] | select(.name | test("^Build RustFS \\(linux-x86_64-gnu, [a-z0-9-]+, x86_64-unknown-linux-gnu, false, linux, pyroscope\\)$"))] as $matches
|
||||
| ($matches | length) == 1 and $matches[0].conclusion == "success"
|
||||
' <<<"$jobs" >/dev/null
|
||||
artifact=$(gh api "repos/rustfs/rustfs/actions/artifacts/${ARTIFACT_ID}")
|
||||
@@ -188,7 +183,7 @@ jobs:
|
||||
assert outer.testzip() is None
|
||||
with zipfile.ZipFile(io.BytesIO(outer.read(package))) as inner:
|
||||
entries = inner.infolist()
|
||||
expected = {'rustfs', 'rustfs.cpu-symbol-catalog.json', 'rustfs.cpu-symbol-catalog.sha256'}
|
||||
expected = {'rustfs', 'rustfs-cli', 'rustfs.cpu-symbol-catalog.json', 'rustfs.cpu-symbol-catalog.sha256'}
|
||||
assert {entry.filename for entry in entries} == expected and len(entries) == len(expected)
|
||||
assert all(regular(entry) and 0 < entry.file_size <= 1073741824 for entry in entries)
|
||||
assert inner.testzip() is None
|
||||
|
||||
@@ -73,11 +73,6 @@ jobs:
|
||||
ref: ${{ inputs.connect_sha }}
|
||||
token: ${{ secrets.PF_TESTING_GH_TOKEN }}
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: "3.14"
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
with:
|
||||
@@ -112,7 +107,7 @@ jobs:
|
||||
[[ $(jq -r '.head_repository.full_name' <<<"$run") == "$GITHUB_REPOSITORY" ]]
|
||||
[[ $(jq -r '.name' <<<"$run") == "Build and Release" ]]
|
||||
|
||||
expected_job='Build RustFS (linux-x86_64-gnu)'
|
||||
expected_job='Build RustFS (linux-x86_64-gnu, sm-standard-4, x86_64-unknown-linux-gnu, false, linux, pyroscope)'
|
||||
jobs=$(gh api --paginate --slurp "repos/${GITHUB_REPOSITORY}/actions/runs/${BUILD_RUN_ID}/jobs?per_page=100")
|
||||
jq -e --arg name "$expected_job" '
|
||||
[.[].jobs[] | select(.name == $name)] as $matches
|
||||
|
||||
@@ -73,11 +73,6 @@ jobs:
|
||||
ref: ${{ inputs.connect_sha }}
|
||||
token: ${{ secrets.PF_TESTING_GH_TOKEN }}
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: "3.14"
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
with:
|
||||
@@ -112,7 +107,7 @@ jobs:
|
||||
[[ $(jq -r '.head_repository.full_name' <<<"$run") == "$GITHUB_REPOSITORY" ]]
|
||||
[[ $(jq -r '.name' <<<"$run") == "Build and Release" ]]
|
||||
|
||||
expected_job='Build RustFS (linux-x86_64-gnu)'
|
||||
expected_job='Build RustFS (linux-x86_64-gnu, sm-standard-4, x86_64-unknown-linux-gnu, false, linux, pyroscope)'
|
||||
jobs=$(gh api --paginate --slurp "repos/${GITHUB_REPOSITORY}/actions/runs/${BUILD_RUN_ID}/jobs?per_page=100")
|
||||
jq -e --arg name "$expected_job" '
|
||||
[.[].jobs[] | select(.name == $name)] as $matches
|
||||
|
||||
@@ -96,8 +96,38 @@ jobs:
|
||||
overwrite: true
|
||||
|
||||
upgrade:
|
||||
name: Upgrade compatibility
|
||||
name: ${{ matrix.name }}
|
||||
needs: build
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
# The two `_from_rc2_` tests keep their names: they assert
|
||||
# release-independent object contracts and pass unchanged against the
|
||||
# newer pinned source, so renaming them would only churn history and
|
||||
# the CI required-check names. UPGRADE_SOURCE_VERSION above is the
|
||||
# single source of truth for which release they actually run against.
|
||||
- name: Direct upgrade from the previous release
|
||||
test: direct_upgrade_from_rc2_preserves_object_contracts
|
||||
artifact: direct-upgrade
|
||||
- name: Mixed-version rolling upgrade from the previous release
|
||||
test: rolling_upgrade_from_rc2_preserves_mixed_version_contracts
|
||||
artifact: mixed-version-upgrade
|
||||
- name: Bucket configuration survives the upgrade
|
||||
test: direct_upgrade_from_previous_release_preserves_bucket_configuration
|
||||
artifact: bucket-config-upgrade
|
||||
- name: Rollback reads current bucket metadata
|
||||
test: rollback_to_previous_release_reads_current_bucket_metadata
|
||||
artifact: bucket-config-rollback
|
||||
- name: ODM configuration recovery after rc.5 rollback
|
||||
test: rc5_rollback_requires_restoring_odm_configuration
|
||||
artifact: odm-config-rollback
|
||||
- name: Multipart layouts survive the rc.5 upgrade
|
||||
test: direct_upgrade_from_rc5_preserves_multipart_layouts
|
||||
artifact: multipart-layout-upgrade
|
||||
- name: rc.5 multipart replication baseline
|
||||
test: rc5_baseline_replicates_multipart_layouts
|
||||
artifact: multipart-layout-baseline
|
||||
runs-on: sm-standard-2
|
||||
timeout-minutes: 60
|
||||
env:
|
||||
@@ -112,7 +142,8 @@ jobs:
|
||||
uses: ./.github/actions/setup
|
||||
with:
|
||||
cache-shared-key: e2e-upgrade-tests
|
||||
cache-save-if: ${{ github.ref == 'refs/heads/main' }}
|
||||
# One main-branch consumer warms the shared test-harness dependencies.
|
||||
cache-save-if: ${{ github.ref == 'refs/heads/main' && matrix.artifact == 'direct-upgrade' }}
|
||||
install-build-packaging-tools: "false"
|
||||
install-test-tools: "false"
|
||||
|
||||
@@ -139,49 +170,22 @@ jobs:
|
||||
echo "RUSTFS_UPGRADE_SOURCE_BINARY=$SOURCE_DIR/rustfs" >> "$GITHUB_ENV"
|
||||
echo "RUSTFS_E2E_LOG_DIR=$RUNNER_TEMP/rustfs-upgrade-logs" >> "$GITHUB_ENV"
|
||||
|
||||
# Reuse one compiled harness, while keeping each case in its own process.
|
||||
# Continue after a failure to retain the former matrix's complete verdict.
|
||||
- name: Run upgrade compatibility tests
|
||||
shell: bash
|
||||
- name: Run upgrade compatibility test
|
||||
env:
|
||||
RUSTFS_SCANNER_HEAL_G09_EVIDENCE_DIR: ${{ runner.temp }}/rustfs-upgrade-g09-evidence/${{ matrix.artifact }}
|
||||
NO_PROXY: 127.0.0.1,localhost,::1
|
||||
run: |
|
||||
export no_proxy="$NO_PROXY"
|
||||
cases=(
|
||||
direct-upgrade:direct_upgrade_from_rc2_preserves_object_contracts
|
||||
mixed-version-upgrade:rolling_upgrade_from_rc2_preserves_mixed_version_contracts
|
||||
bucket-config-upgrade:direct_upgrade_from_previous_release_preserves_bucket_configuration
|
||||
bucket-config-rollback:rollback_to_previous_release_reads_current_bucket_metadata
|
||||
odm-config-rollback:rc5_rollback_requires_restoring_odm_configuration
|
||||
multipart-layout-upgrade:direct_upgrade_from_rc5_preserves_multipart_layouts
|
||||
multipart-layout-baseline:rc5_baseline_replicates_multipart_layouts
|
||||
)
|
||||
status=0
|
||||
for entry in "${cases[@]}"; do
|
||||
artifact="${entry%%:*}"
|
||||
test="${entry#*:}"
|
||||
export RUSTFS_SCANNER_HEAL_G09_EVIDENCE_DIR="$RUNNER_TEMP/rustfs-upgrade-g09-evidence/$artifact"
|
||||
export RUSTFS_E2E_LOG_DIR="$RUNNER_TEMP/rustfs-upgrade-logs/$artifact"
|
||||
mkdir -p "$RUSTFS_E2E_LOG_DIR"
|
||||
echo "::group::$test"
|
||||
if python3 scripts/e2e_binary.py run -- cargo test --locked -p e2e_test \
|
||||
"upgrade_compatibility_test::$test" -- --ignored --exact --nocapture \
|
||||
2>&1 | tee "$RUSTFS_E2E_LOG_DIR/test.log"; then
|
||||
echo "PASS: $test"
|
||||
else
|
||||
echo "::error::Upgrade compatibility failed: $test"
|
||||
status=1
|
||||
fi
|
||||
echo "::endgroup::"
|
||||
done
|
||||
exit "$status"
|
||||
python3 scripts/e2e_binary.py run -- cargo test --locked -p e2e_test \
|
||||
"upgrade_compatibility_test::${{ matrix.test }}" \
|
||||
-- --ignored --exact --nocapture
|
||||
|
||||
- name: Upload scanner/heal G09 evidence
|
||||
if: always()
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
with:
|
||||
name: upgrade-g09-evidence-${{ github.run_number }}
|
||||
path: ${{ runner.temp }}/rustfs-upgrade-g09-evidence
|
||||
name: ${{ matrix.artifact }}-g09-evidence-${{ github.run_number }}
|
||||
path: ${{ runner.temp }}/rustfs-upgrade-g09-evidence/${{ matrix.artifact }}
|
||||
if-no-files-found: ignore
|
||||
retention-days: 14
|
||||
|
||||
@@ -189,7 +193,7 @@ jobs:
|
||||
if: always()
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
with:
|
||||
name: upgrade-server-logs-${{ github.run_number }}
|
||||
name: ${{ matrix.artifact }}-server-logs-${{ github.run_number }}
|
||||
path: ${{ runner.temp }}/rustfs-upgrade-logs
|
||||
if-no-files-found: warn
|
||||
retention-days: 14
|
||||
|
||||
@@ -80,24 +80,13 @@ jobs:
|
||||
- name: Setup Rust environment
|
||||
uses: ./.github/actions/setup
|
||||
with:
|
||||
cache-shared-key: build-x86_64-unknown-linux-gnu-glibc-2.31
|
||||
cache-shared-key: build-x86_64-unknown-linux-gnu
|
||||
cache-save-if: 'false'
|
||||
install-cross-tools: 'true'
|
||||
target: x86_64-unknown-linux-gnu
|
||||
install-build-packaging-tools: 'false'
|
||||
install-test-tools: 'false'
|
||||
|
||||
- name: Build RustFS
|
||||
# Pin the glibc baseline (`<target>.<glibc>` for cargo-zigbuild) so
|
||||
# nightlies run on older distros such as RHEL/Rocky 9 (glibc 2.34); #8062.
|
||||
run: cargo zigbuild --release --locked --target x86_64-unknown-linux-gnu.2.31 -p rustfs --bins
|
||||
|
||||
- name: Verify glibc symbol baseline
|
||||
run: |
|
||||
python3 scripts/release/check_glibc.py 2.31 \
|
||||
target/x86_64-unknown-linux-gnu/release/rustfs \
|
||||
target/x86_64-unknown-linux-gnu/release/rustfs-cli
|
||||
target/x86_64-unknown-linux-gnu/release/rustfs --version | grep -Fx 'build target : x86_64-unknown-linux-gnu'
|
||||
run: cargo build --release --locked --target x86_64-unknown-linux-gnu -p rustfs --bins
|
||||
|
||||
- name: Build DEB package
|
||||
id: deb
|
||||
|
||||
@@ -20,9 +20,8 @@ on:
|
||||
- ".github/workflows/oidc-keycloak.yml"
|
||||
- "crates/config/src/constants/oidc.rs"
|
||||
- "crates/iam/src/federation/**"
|
||||
- "crates/iam/src/oidc/**"
|
||||
- "crates/iam/src/oidc.rs"
|
||||
- "rustfs/src/admin/handlers/oidc.rs"
|
||||
- "rustfs/src/admin/service/oidc_config.rs"
|
||||
- "rustfs/src/admin/handlers/sts.rs"
|
||||
- "scripts/test/oidc_keycloak_live.sh"
|
||||
- "scripts/test/fixtures/keycloak-rustfs-ci-realm.json"
|
||||
@@ -32,9 +31,8 @@ on:
|
||||
- ".github/workflows/oidc-keycloak.yml"
|
||||
- "crates/config/src/constants/oidc.rs"
|
||||
- "crates/iam/src/federation/**"
|
||||
- "crates/iam/src/oidc/**"
|
||||
- "crates/iam/src/oidc.rs"
|
||||
- "rustfs/src/admin/handlers/oidc.rs"
|
||||
- "rustfs/src/admin/service/oidc_config.rs"
|
||||
- "rustfs/src/admin/handlers/sts.rs"
|
||||
- "scripts/test/oidc_keycloak_live.sh"
|
||||
- "scripts/test/fixtures/keycloak-rustfs-ci-realm.json"
|
||||
|
||||
@@ -90,4 +90,3 @@ worktrees/*
|
||||
# insta scratch files; the accepted .snap files ARE the assertions and are committed
|
||||
*.snap.new
|
||||
*.pending-snap
|
||||
.mimosa
|
||||
Vendored
+28
-22
@@ -7,9 +7,7 @@
|
||||
"name": "Debug(only) executable 'rustfs'",
|
||||
"env": {
|
||||
"RUST_LOG": "rustfs=info,ecstore=info,s3s=info,iam=info",
|
||||
"RUSTFS_SKIP_BACKGROUND_TASK": "on",
|
||||
// Local test volumes share one physical disk.
|
||||
"RUSTFS_UNSAFE_BYPASS_DISK_CHECK": "true"
|
||||
"RUSTFS_SKIP_BACKGROUND_TASK": "on"
|
||||
//"RUSTFS_OBS_LOG_DIRECTORY": "./deploy/logs",
|
||||
// "RUSTFS_POLICY_PLUGIN_URL":"http://localhost:8181/v1/data/rustfs/authz/allow",
|
||||
// "RUSTFS_POLICY_PLUGIN_AUTH_TOKEN":"your-opa-token"
|
||||
@@ -46,7 +44,6 @@
|
||||
"env": {
|
||||
"RUST_LOG": "rustfs=debug,ecstore=info,s3s=debug,iam=debug",
|
||||
"RUSTFS_SKIP_BACKGROUND_TASK": "on",
|
||||
"RUSTFS_UNSAFE_BYPASS_DISK_CHECK": "true",
|
||||
//"RUSTFS_OBS_LOG_DIRECTORY": "./deploy/logs",
|
||||
// "RUSTFS_POLICY_PLUGIN_URL":"http://localhost:8181/v1/data/rustfs/authz/allow",
|
||||
// "RUSTFS_POLICY_PLUGIN_AUTH_TOKEN":"your-opa-token"
|
||||
@@ -120,8 +117,7 @@
|
||||
"env": {
|
||||
"RUSTFS_ACCESS_KEY": "rustfsadmin",
|
||||
"RUSTFS_SECRET_KEY": "rustfsadmin",
|
||||
"RUSTFS_VOLUMES": "./target/volume/test{1...4}",
|
||||
"RUSTFS_UNSAFE_BYPASS_DISK_CHECK": "true",
|
||||
//"RUSTFS_VOLUMES": "./target/volume/test{1...4}",
|
||||
"RUSTFS_ADDRESS": ":9000",
|
||||
"RUSTFS_CONSOLE_ENABLE": "true",
|
||||
// "RUSTFS_OBS_TRACE_ENDPOINT": "http://127.0.0.1:4318/v1/traces", // jeager otlp http endpoint
|
||||
@@ -139,31 +135,42 @@
|
||||
{
|
||||
"type": "lldb",
|
||||
"request": "launch",
|
||||
"name": "Debug test_transition_and_restore_flows",
|
||||
"name": "Debug test_lifecycle_transition_basic",
|
||||
"cargo": {
|
||||
"args": [
|
||||
"test",
|
||||
"--no-run",
|
||||
"-p",
|
||||
"rustfs-scanner",
|
||||
"--test",
|
||||
"lifecycle_integration_test",
|
||||
"serial_tests::test_lifecycle_transition_basic",
|
||||
"-j",
|
||||
"1"
|
||||
],
|
||||
"filter": {
|
||||
"name": "lifecycle_integration_test",
|
||||
"kind": "test"
|
||||
}
|
||||
]
|
||||
},
|
||||
"args": [
|
||||
"serial_tests::test_transition_and_restore_flows",
|
||||
"--exact",
|
||||
"--ignored",
|
||||
"--test-threads=1"
|
||||
],
|
||||
"args": [],
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
{
|
||||
"name": "Debug executable target/debug/test",
|
||||
"type": "lldb",
|
||||
"request": "launch",
|
||||
"program": "${workspaceFolder}/target/debug/deps/lifecycle_integration_test-5915cbfcab491b3b",
|
||||
"args": [
|
||||
"--skip",
|
||||
"test_lifecycle_expiry_basic",
|
||||
"--skip",
|
||||
"test_lifecycle_expiry_deletemarker",
|
||||
//"--skip",
|
||||
//"test_lifecycle_transition_basic",
|
||||
],
|
||||
"cwd": "${workspaceFolder}",
|
||||
//"stopAtEntry": false,
|
||||
//"preLaunchTask": "cargo build",
|
||||
"sourceLanguages": [
|
||||
"rust"
|
||||
],
|
||||
},
|
||||
{
|
||||
"name": "Debug executable target/debug/rustfs with sse kms",
|
||||
"type": "lldb",
|
||||
@@ -278,7 +285,7 @@
|
||||
"RUSTFS_COMPRESSION_ENABLED": "true",
|
||||
"RUSTFS_KMS_ENABLE": "true",
|
||||
"RUSTFS_KMS_BACKEND": "local",
|
||||
"RUSTFS_KMS_KEY_DIR": "${workspaceFolder}/target/rio-v2/kms-key-dir",
|
||||
"RUSTFS_KMS_KEY_DIR": "./target/rio-v2/kms-key-dir",
|
||||
"RUSTFS_KMS_LOCAL_MASTER_KEY": "my-secret-key", // Some Password
|
||||
"RUSTFS_KMS_DEFAULT_KEY_ID": "rustfs-master-key",
|
||||
},
|
||||
@@ -300,7 +307,6 @@
|
||||
"RUSTFS_ACCESS_KEY": "rustfsadmin",
|
||||
"RUSTFS_SECRET_KEY": "rustfsadmin",
|
||||
"RUSTFS_VOLUMES": "./target/e2e-test/test{1...4}",
|
||||
"RUSTFS_UNSAFE_BYPASS_DISK_CHECK": "true",
|
||||
"RUSTFS_REGION": "us-east-1",
|
||||
"RUSTFS_ADDRESS": ":9000",
|
||||
"RUSTFS_CONSOLE_ENABLE": "true",
|
||||
@@ -309,7 +315,7 @@
|
||||
|
||||
"RUSTFS_KMS_ENABLE": "true",
|
||||
"RUSTFS_KMS_BACKEND": "local",
|
||||
"RUSTFS_KMS_KEY_DIR": "${workspaceFolder}/target/e2e-key-dir",
|
||||
"RUSTFS_KMS_KEY_DIR": "./target/e2e-key-dir",
|
||||
"RUSTFS_KMS_LOCAL_MASTER_KEY": "my-secret-key", // Some Password
|
||||
"RUSTFS_KMS_DEFAULT_KEY_ID": "rustfs-master-key",
|
||||
},
|
||||
|
||||
+1
-1
@@ -155,7 +155,7 @@ default build (lifecycle:
|
||||
- ⚠️ PARTIALLY VIOLATED: serving-side `s3s` references remain in ecstore
|
||||
(bucket metadata/replication/lifecycle DTOs and error mapping). The
|
||||
count is ratcheted shrink-only by `scripts/check_s3s_footprint.sh`
|
||||
(the `ecstore_files` line of `.config/s3s-footprint-baseline.txt`; the `object_lock` module was converted to
|
||||
(`S3S_ECSTORE_FILES_BASELINE`; the `object_lock` module was converted to
|
||||
storage-level types as the first ratchet step). Target state: the
|
||||
baseline reaches zero and ecstore's `Cargo.toml` drops `s3s`.
|
||||
|
||||
|
||||
Generated
+409
-280
File diff suppressed because it is too large
Load Diff
+26
-34
@@ -18,6 +18,7 @@ members = [
|
||||
"crates/audit", # Audit target management system with multi-target fan-out
|
||||
"crates/checksums", # client checksums
|
||||
"crates/common", # Shared utilities and data structures
|
||||
"crates/capture-authority", # Durable capture authority storage
|
||||
"crates/data-usage", # Shared data usage models and algorithms
|
||||
"crates/config", # Configuration management
|
||||
"crates/connect-symbol-catalog", # Release-only CPU profile symbol catalog generator
|
||||
@@ -48,7 +49,7 @@ members = [
|
||||
"crates/replication", # Replication contracts and wire formats
|
||||
"crates/concurrency", # Concurrency management for RustFS - timeout, locking, backpressure, and I/O scheduling
|
||||
"crates/s3-client", # S3 client for engine-side consumption of remote S3 endpoints (tiering, transition targets)
|
||||
"crates/s3-types", # S3 event and error type definitions
|
||||
"crates/s3-types", # S3 event type definitions
|
||||
"crates/s3-ops", # S3 operation definitions and mapping
|
||||
"crates/s3select-api", # S3 Select API interface
|
||||
"crates/s3select-query", # S3 Select query engine
|
||||
@@ -67,7 +68,6 @@ members = [
|
||||
"crates/io-core", # Buffered Bytes, mmap-then-copy, and aligned pread I/O helpers
|
||||
"crates/zip", # ZIP file handling and compression
|
||||
]
|
||||
exclude = ["third-party/pyroscope"]
|
||||
resolver = "3"
|
||||
|
||||
[workspace.package]
|
||||
@@ -104,6 +104,7 @@ rustfs-config = { path = "./crates/config", version = "1.0.1" }
|
||||
rustfs-concurrency = { path = "./crates/concurrency", version = "1.0.1" }
|
||||
rustfs-credentials = { path = "crates/credentials", version = "1.0.1" }
|
||||
rustfs-crypto = { path = "crates/crypto", version = "1.0.1" }
|
||||
rustfs-capture-authority = { path = "crates/capture-authority", version = "1.0.1" }
|
||||
rustfs-ecstore = { path = "crates/ecstore", version = "1.0.1" }
|
||||
rustfs-filemeta = { path = "crates/filemeta", version = "1.0.1" }
|
||||
rustfs-iam = { path = "crates/iam", version = "1.0.1" }
|
||||
@@ -157,9 +158,8 @@ futures-lite = "2.6.1"
|
||||
futures-util = "0.3.34"
|
||||
pollster = "1.0.1"
|
||||
pulsar = { default-features = false, version = "6.9.0" }
|
||||
lapin = { default-features = false, version = "4.12.1" }
|
||||
lapin = { default-features = false, version = "4.12.0" }
|
||||
hyper = { version = "1.12.0" }
|
||||
h2 = { version = "0.4.20" }
|
||||
hyper-rustls = { default-features = false, version = "0.27.10" }
|
||||
hyper-util = { version = "0.1.21" }
|
||||
http = "1.5.0"
|
||||
@@ -174,7 +174,7 @@ tokio = { version = "1.53.2" }
|
||||
tokio-rustls = { default-features = false, version = "0.26.6" }
|
||||
tokio-stream = { version = "0.1.19" }
|
||||
tokio-test = "0.4.6"
|
||||
tokio-util = { version = "0.7.20" }
|
||||
tokio-util = { version = "0.7.19" }
|
||||
tonic = { version = "0.14.6" }
|
||||
tonic-prost = { version = "0.14.6" }
|
||||
tonic-prost-build = { version = "0.14.6" }
|
||||
@@ -182,7 +182,7 @@ tower = { version = "0.5.3" }
|
||||
tower-http = { version = "0.7.1" }
|
||||
h3 = "0.0.8"
|
||||
h3-quinn = "0.0.10"
|
||||
quinn = { version = "0.11.12", default-features = false, features = [
|
||||
quinn = { version = "0.11.11", default-features = false, features = [
|
||||
"futures-io",
|
||||
"runtime-tokio",
|
||||
"rustls-aws-lc-rs",
|
||||
@@ -202,7 +202,7 @@ rmp-serde = { version = "1.3.1" }
|
||||
serde = { version = "1.0.229" }
|
||||
serde_ignored = { version = "0.1" }
|
||||
serde_with = { version = "3", default-features = false, features = ["macros", "std"] }
|
||||
serde_json = { version = "1.0.154" }
|
||||
serde_json = { version = "1.0.151" }
|
||||
serde_urlencoded = "0.7.1"
|
||||
|
||||
# Cryptography and Security
|
||||
@@ -226,7 +226,7 @@ rustls-native-certs = "0.8"
|
||||
rustls-pki-types = "1.15.1"
|
||||
x509-parser = "0.18.1"
|
||||
sha1 = "0.11.0"
|
||||
sha2 = "0.11.1"
|
||||
sha2 = "0.11.0"
|
||||
subtle = "2.6"
|
||||
zeroize = { version = "1.9.1" }
|
||||
proptest = "1"
|
||||
@@ -270,7 +270,7 @@ crossbeam-queue = "0.3.14"
|
||||
crossbeam-channel = "0.5.17"
|
||||
crossbeam-deque = "0.8.8"
|
||||
crossbeam-utils = "0.8.23"
|
||||
datafusion = { default-features = false, version = "55.2.0" }
|
||||
datafusion = { default-features = false, version = "55.1.0" }
|
||||
derive_builder = "0.20.2"
|
||||
ed25519-dalek = "3.0.0"
|
||||
enumset = "1.1.14"
|
||||
@@ -316,28 +316,25 @@ ratelimit = "2.0.0"
|
||||
rayon = "1.12.0"
|
||||
rustfs-erasure-codec = { version = "9.0.0" }
|
||||
reed-solomon-simd = "3.1.0"
|
||||
openraft = { version = "=0.9.25", default-features = false, features = ["serde"] }
|
||||
redb = "=4.3.0"
|
||||
regex = { version = "1.13.1" }
|
||||
rumqttc = { package = "rumqttc-next", version = "0.34.0" }
|
||||
redis = { version = "1.7.1" }
|
||||
rustify = { version = "0.7", default-features = false }
|
||||
rustix = { version = "1.1.5" }
|
||||
rust-embed = { version = "8.13.0" }
|
||||
rust-embed = { version = "8.12.0" }
|
||||
rustc-hash = { version = "2.1.3" }
|
||||
s3s = { git = "https://github.com/s3s-project/s3s", rev = "5761ddfe4c509fcac87e3b99fd5bd9e176b442c0", features = ["minio"] }
|
||||
s3s-sigv4 = { git = "https://github.com/s3s-project/s3s", rev = "5761ddfe4c509fcac87e3b99fd5bd9e176b442c0" }
|
||||
# The same s3s pin under the name the legacy edge of the gateway migration uses
|
||||
# (crates/s3-types, feature `compat-s3s`). Keep `rev` identical to `s3s` above.
|
||||
# DELETE BY T4.2 (rustfs/backlog#2784).
|
||||
legacy-s3s = { package = "s3s", git = "https://github.com/s3s-project/s3s", rev = "5761ddfe4c509fcac87e3b99fd5bd9e176b442c0", features = ["minio"] }
|
||||
serial_test = "4.0.1"
|
||||
shadow-rs = { default-features = false, version = "2.0.0" }
|
||||
siphasher = "1.0.4"
|
||||
smallvec = { version = "1.16.3" }
|
||||
smallvec = { version = "1.16.2" }
|
||||
compact_str = "0.10.0"
|
||||
snap = "1.1.2"
|
||||
starshard = { version = "2.4.0" }
|
||||
strum = { version = "0.28.0" }
|
||||
sync_wrapper = "1.0.2"
|
||||
sysinfo = "0.39.6"
|
||||
temp-env = "0.3.6"
|
||||
tempfile = "3.27.0"
|
||||
@@ -347,12 +344,12 @@ tracing = { version = "0.1.44" }
|
||||
tracing-appender = "0.2.5"
|
||||
tracing-core = "0.1.36"
|
||||
tracing-error = "0.2.1"
|
||||
tracing-opentelemetry = { version = "0.34.0" }
|
||||
tracing-opentelemetry = { version = "0.34" }
|
||||
tracing-subscriber = { version = "0.3.23" }
|
||||
transform-stream = "0.3.1"
|
||||
url = "2.5.8"
|
||||
urlencoding = "2.1.3"
|
||||
uuid = { version = "1.28.0" }
|
||||
uuid = { version = "1.27.0" }
|
||||
vaultrs = { version = "0.8.0" }
|
||||
tar = "0.4.46"
|
||||
walkdir = "2.5.0"
|
||||
@@ -360,26 +357,26 @@ winapi-util = "0.1.11"
|
||||
windows = { version = "0.62.2" }
|
||||
windows-sys = "0.61.2"
|
||||
xxhash-rust = { version = "0.8.19" }
|
||||
zip = "9.0.2"
|
||||
zstd = "0.14.2"
|
||||
zip = "8.6.0"
|
||||
zstd = "0.14.0"
|
||||
|
||||
# Observability and Metrics
|
||||
metrics = "0.24.6"
|
||||
metrics-util = "0.20"
|
||||
dial9 = { version = "0.5.3", default-features = false }
|
||||
opentelemetry = { version = "0.33.1" }
|
||||
opentelemetry-appender-tracing = { version = "0.33.1" }
|
||||
opentelemetry-otlp = { version = "0.33.1" }
|
||||
opentelemetry-proto = { version = "0.33.1", default-features = false, features = ["metrics", "gen-tonic-messages"] }
|
||||
opentelemetry_sdk = { version = "0.33.1" }
|
||||
opentelemetry-semantic-conventions = { version = "0.33.1" }
|
||||
opentelemetry-stdout = { version = "0.33.1" }
|
||||
opentelemetry = { version = "0.33.0" }
|
||||
opentelemetry-appender-tracing = { version = "0.33.0" }
|
||||
opentelemetry-otlp = { version = "0.33.0" }
|
||||
opentelemetry-proto = { version = "0.33.0", default-features = false, features = ["metrics", "gen-tonic-messages"] }
|
||||
opentelemetry_sdk = { version = "0.33.0" }
|
||||
opentelemetry-semantic-conventions = { version = "0.33.0" }
|
||||
opentelemetry-stdout = { version = "0.33.0" }
|
||||
pyroscope = { version = "2.1.1" }
|
||||
|
||||
# FTP and SFTP
|
||||
libunftp = { version = "0.23.1" }
|
||||
unftp-core = "0.1.0"
|
||||
suppaftp = { version = "12.2.0" }
|
||||
suppaftp = { version = "12.1.1" }
|
||||
rcgen = { version = "0.14.10", default-features = false, features = ["aws_lc_rs", "crypto", "pem"] }
|
||||
russh = { version = "0.64.1" }
|
||||
russh-sftp = "3.0.1"
|
||||
@@ -390,7 +387,7 @@ dav-server = "0.11.0"
|
||||
# Performance Analysis and Memory Profiling
|
||||
rustfs-mimalloc = { version = "0.5.6" }
|
||||
# Preserve Unicode focus filters until rustfs/backlog#2302 is resolved.
|
||||
hotpath = { version = "0.28.6", default-features = false }
|
||||
hotpath = { version = "0.28.5", default-features = false }
|
||||
# Snapshot testing for output format regression detection
|
||||
insta = { version = "1.49" }
|
||||
|
||||
@@ -427,8 +424,3 @@ inherits = "release"
|
||||
inherits = "release"
|
||||
debug = true
|
||||
strip = "none"
|
||||
|
||||
# Remove this patch when Pyroscope releases support for object 0.40 or later.
|
||||
# object 0.39 requires ruzstd 0.8, affected by RUSTSEC-2026-0344.
|
||||
[patch.crates-io]
|
||||
pyroscope = { path = "third-party/pyroscope" }
|
||||
|
||||
@@ -51,8 +51,6 @@ unparseable = "unparseable"
|
||||
# Disaster-recovery objectives: recovery time and recovery point.
|
||||
RTO = "RTO"
|
||||
rto = "rto"
|
||||
# rustix OFlags variant (POSIX O_WRONLY equivalent).
|
||||
WRONLY = "WRONLY"
|
||||
|
||||
[files]
|
||||
extend-exclude = []
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
[package]
|
||||
name = "rustfs-capture-authority"
|
||||
version.workspace = true
|
||||
edition.workspace = true
|
||||
license.workspace = true
|
||||
rust-version.workspace = true
|
||||
repository.workspace = true
|
||||
description = "Durable local storage for capture authority"
|
||||
|
||||
[dependencies]
|
||||
openraft = { workspace = true, features = ["storage-v2"] }
|
||||
redb = { workspace = true }
|
||||
sha2 = { workspace = true }
|
||||
serde = { workspace = true, features = ["derive"] }
|
||||
thiserror = { workspace = true }
|
||||
tokio = { workspace = true, features = ["net", "io-util", "time", "sync", "rt"] }
|
||||
url = { workspace = true }
|
||||
tempfile = { workspace = true }
|
||||
serde_json = { workspace = true }
|
||||
|
||||
[target.'cfg(any(target_os = "linux", target_os = "macos"))'.dependencies]
|
||||
rustix = { workspace = true, features = ["process"] }
|
||||
|
||||
[dev-dependencies]
|
||||
tokio = { workspace = true, features = ["macros", "rt-multi-thread"] }
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,531 @@
|
||||
use super::*;
|
||||
use crate::application::{APPLY_RESULTS, EVENTS, OPERATIONS, VERSIONS};
|
||||
use crate::tests::CrashBackend;
|
||||
use redb::ReadableTableMetadata;
|
||||
use std::{
|
||||
io::{BufRead, BufReader, Write},
|
||||
process::{Command, Stdio},
|
||||
sync::mpsc,
|
||||
time::Duration,
|
||||
};
|
||||
fn identity() -> NodeIdentity {
|
||||
NodeIdentity {
|
||||
cluster_id: [7; 16],
|
||||
node_id: 0,
|
||||
}
|
||||
}
|
||||
fn binding() -> CaptureBinding {
|
||||
CaptureBinding {
|
||||
revision: 9,
|
||||
binding_id: [8; 16],
|
||||
target_id: [9; 16],
|
||||
}
|
||||
}
|
||||
fn command() -> DecideCreated {
|
||||
DecideCreated {
|
||||
operation_id: [1; 16],
|
||||
object: ObjectIdentity {
|
||||
bucket_incarnation: [2; 16],
|
||||
key: vec![0, 255, 3],
|
||||
},
|
||||
expected_head: None,
|
||||
prepared: PreparedIdentity {
|
||||
version_id: [3; 16],
|
||||
preparation_id: [4; 16],
|
||||
content_digest: [5; 32],
|
||||
content_length: 123,
|
||||
},
|
||||
binding_revision: 9,
|
||||
}
|
||||
}
|
||||
fn id(index: u64) -> LogId {
|
||||
LogId {
|
||||
term: 8,
|
||||
leader_node: 0,
|
||||
index,
|
||||
}
|
||||
}
|
||||
fn append(store: &mut Store, index: u64, c: &DecideCreated) {
|
||||
store
|
||||
.append(&[LogEntry {
|
||||
id: id(index),
|
||||
payload: c.encode().expect("encode command"),
|
||||
}])
|
||||
.expect("append command");
|
||||
}
|
||||
fn apply(store: &mut Store, index: u64, c: &DecideCreated) -> CreatedResult {
|
||||
append(store, index, c);
|
||||
store.save_committed(id(index)).expect("commit log");
|
||||
store.apply_next_created(id(index)).expect("apply command")
|
||||
}
|
||||
fn success(c: &DecideCreated, index: u64) -> CreatedResult {
|
||||
CreatedResult::Created {
|
||||
version_id: c.prepared.version_id,
|
||||
event_id: c.operation_id,
|
||||
decision_log_id: id(index),
|
||||
}
|
||||
}
|
||||
fn complete(store: &Store) {
|
||||
let c = command();
|
||||
assert_eq!(store.capture_binding().expect("binding"), Some(binding()));
|
||||
assert_eq!(
|
||||
store.created_head(&c.object).expect("head"),
|
||||
Some(c.prepared.version_id),
|
||||
"U11 acknowledged head lost"
|
||||
);
|
||||
assert_eq!(
|
||||
store.created_version(&c.object, c.prepared.version_id).expect("version"),
|
||||
Some(CreatedVersion {
|
||||
prepared: c.prepared.clone(),
|
||||
decision_log_id: id(0),
|
||||
binding_revision: 9
|
||||
})
|
||||
);
|
||||
assert_eq!(
|
||||
store.created_event(c.operation_id).expect("event"),
|
||||
Some(CreatedEvent {
|
||||
object: c.object.clone(),
|
||||
prepared: c.prepared.clone(),
|
||||
decision_log_id: id(0),
|
||||
binding: binding()
|
||||
}),
|
||||
"U11 complete event missing"
|
||||
);
|
||||
assert_eq!(
|
||||
store.created_operation(c.operation_id).expect("operation"),
|
||||
Some(CreatedOperation {
|
||||
canonical_command: c.encode().expect("encode"),
|
||||
result: success(&c, 0)
|
||||
})
|
||||
);
|
||||
assert_eq!(
|
||||
store.created_apply_result(0).expect("result"),
|
||||
Some(CreatedApplyResult {
|
||||
log_id: id(0),
|
||||
result: success(&c, 0)
|
||||
})
|
||||
);
|
||||
assert_eq!(store.last_applied().expect("last applied"), Some(id(0)));
|
||||
}
|
||||
fn fixture() -> (tempfile::TempDir, Store) {
|
||||
let dir = tempfile::tempdir().expect("tempdir");
|
||||
let mut store = Store::initialize(dir.path().join("db"), identity()).expect("initialize");
|
||||
store.pin_capture_binding(binding()).expect("pin");
|
||||
(dir, store)
|
||||
}
|
||||
fn reopen(path: &std::path::Path) -> Store {
|
||||
let result = Store::open(path, identity());
|
||||
assert!(result.is_ok(), "U11 complete reopen: {:?}", result.as_ref().err());
|
||||
result.expect("asserted successful reopen")
|
||||
}
|
||||
#[test]
|
||||
fn created_codec_is_canonical_and_strict() {
|
||||
let c = command();
|
||||
let b = c.encode().expect("encode");
|
||||
let mut golden = b"CRTD\x01".to_vec();
|
||||
golden.extend([1; 16]);
|
||||
golden.extend([2; 16]);
|
||||
golden.extend(3u32.to_be_bytes());
|
||||
golden.extend([0, 255, 3]);
|
||||
golden.push(0);
|
||||
golden.extend([3; 16]);
|
||||
golden.extend([4; 16]);
|
||||
golden.extend([5; 32]);
|
||||
golden.extend(123u64.to_be_bytes());
|
||||
golden.extend(9u64.to_be_bytes());
|
||||
assert_eq!(b, golden);
|
||||
assert_eq!(DecideCreated::decode(&b).expect("decode"), c);
|
||||
let mut variants = Vec::new();
|
||||
let mut v = c.clone();
|
||||
v.operation_id = [6; 16];
|
||||
variants.push(v);
|
||||
let mut v = c.clone();
|
||||
v.object.bucket_incarnation = [6; 16];
|
||||
variants.push(v);
|
||||
let mut v = c.clone();
|
||||
v.object.key.push(4);
|
||||
variants.push(v);
|
||||
let mut v = c.clone();
|
||||
v.expected_head = Some([6; 16]);
|
||||
variants.push(v);
|
||||
let mut v = c.clone();
|
||||
v.prepared.version_id = [6; 16];
|
||||
variants.push(v);
|
||||
let mut v = c.clone();
|
||||
v.prepared.preparation_id = [6; 16];
|
||||
variants.push(v);
|
||||
let mut v = c.clone();
|
||||
v.prepared.content_digest = [6; 32];
|
||||
variants.push(v);
|
||||
let mut v = c.clone();
|
||||
v.prepared.content_length += 1;
|
||||
variants.push(v);
|
||||
let mut v = c.clone();
|
||||
v.binding_revision += 1;
|
||||
variants.push(v);
|
||||
for v in variants {
|
||||
assert_ne!(v.encode().expect("variant"), b)
|
||||
}
|
||||
for n in 0..b.len() {
|
||||
assert!(DecideCreated::decode(&b[..n]).is_err())
|
||||
}
|
||||
let mut bad = b.clone();
|
||||
bad[4] = 2;
|
||||
assert!(DecideCreated::decode(&bad).is_err());
|
||||
let mut bad = b.clone();
|
||||
bad[44] = 2;
|
||||
assert!(DecideCreated::decode(&bad).is_err());
|
||||
let mut bad = b.clone();
|
||||
bad.push(0);
|
||||
assert!(DecideCreated::decode(&bad).is_err());
|
||||
let mut bad = b;
|
||||
bad[37..41].copy_from_slice(&4097u32.to_be_bytes());
|
||||
assert!(DecideCreated::decode(&bad).is_err());
|
||||
let mut bad = c.clone();
|
||||
bad.operation_id = [0; 16];
|
||||
assert!(bad.encode().is_err());
|
||||
bad = c;
|
||||
bad.object.key = vec![0; MAX_OBJECT_KEY_LENGTH + 1];
|
||||
assert!(bad.encode().is_err());
|
||||
}
|
||||
#[test]
|
||||
fn created_committed_order_and_identity_are_enforced() {
|
||||
let (_dir, mut s) = fixture();
|
||||
let c = command();
|
||||
append(&mut s, 0, &c);
|
||||
append(&mut s, 1, &c);
|
||||
assert!(s.apply_next_created(id(0)).is_err());
|
||||
assert_eq!(s.last_applied().expect("no apply"), None);
|
||||
s.save_committed(id(1)).expect("committed");
|
||||
assert!(matches!(s.apply_next_created(id(1)), Err(StoreError::InvalidApplySequence)));
|
||||
let mut wrong = id(0);
|
||||
wrong.term += 1;
|
||||
assert!(s.apply_next_created(wrong).is_err());
|
||||
wrong = id(0);
|
||||
wrong.leader_node += 1;
|
||||
assert!(s.apply_next_created(wrong).is_err());
|
||||
assert_eq!(s.apply_next_created(id(0)).expect("first"), success(&c, 0));
|
||||
complete(&s);
|
||||
assert_eq!(s.apply_next_created(id(0)).expect("retry"), success(&c, 0));
|
||||
complete(&s);
|
||||
assert!(s.apply_next_created(wrong).is_err());
|
||||
assert_eq!(s.apply_next_created(id(1)).expect("duplicate log"), success(&c, 0));
|
||||
assert_eq!(s.last_applied().expect("last"), Some(id(1)));
|
||||
assert_eq!(
|
||||
s.created_apply_result(1).expect("result"),
|
||||
Some(CreatedApplyResult {
|
||||
log_id: id(1),
|
||||
result: success(&c, 0)
|
||||
})
|
||||
);
|
||||
let tx = s.database.begin_read().expect("read");
|
||||
assert_eq!(tx.open_table(EVENTS).expect("events").len().expect("len"), 1);
|
||||
}
|
||||
#[test]
|
||||
fn created_head_version_event_and_dedup_reopen_together() {
|
||||
let (dir, mut s) = fixture();
|
||||
let c = command();
|
||||
assert_eq!(apply(&mut s, 0, &c), success(&c, 0));
|
||||
drop(s);
|
||||
let mut s = reopen(&dir.path().join("db"));
|
||||
complete(&s);
|
||||
assert_eq!(apply(&mut s, 1, &c), success(&c, 0));
|
||||
let mut changed = c.clone();
|
||||
changed.prepared.content_digest = [6; 32];
|
||||
assert_eq!(
|
||||
apply(&mut s, 2, &changed),
|
||||
CreatedResult::OperationConflict,
|
||||
"U11 full canonical operation conflict"
|
||||
);
|
||||
assert_eq!(
|
||||
s.created_operation(c.operation_id)
|
||||
.expect("original")
|
||||
.expect("operation")
|
||||
.result,
|
||||
success(&c, 0)
|
||||
);
|
||||
let mut stale = c.clone();
|
||||
stale.operation_id = [6; 16];
|
||||
stale.prepared.version_id = [6; 16];
|
||||
assert_eq!(
|
||||
apply(&mut s, 3, &stale),
|
||||
CreatedResult::HeadMismatch {
|
||||
actual_head: Some(c.prepared.version_id)
|
||||
}
|
||||
);
|
||||
let mut reuse = c.clone();
|
||||
reuse.operation_id = [7; 16];
|
||||
reuse.expected_head = Some(c.prepared.version_id);
|
||||
assert_eq!(apply(&mut s, 4, &reuse), CreatedResult::VersionConflict);
|
||||
let mut replacement = stale.clone();
|
||||
replacement.operation_id = [10; 16];
|
||||
replacement.expected_head = Some(c.prepared.version_id);
|
||||
assert_eq!(apply(&mut s, 5, &replacement), success(&replacement, 5));
|
||||
assert_eq!(s.created_head(&c.object).expect("head"), Some(replacement.prepared.version_id));
|
||||
assert_eq!(
|
||||
s.created_version(&c.object, c.prepared.version_id)
|
||||
.expect("old version")
|
||||
.expect("version")
|
||||
.decision_log_id,
|
||||
id(0)
|
||||
);
|
||||
assert!(s.created_event(c.operation_id).expect("old event").is_some());
|
||||
assert!(s.created_event(replacement.operation_id).expect("new event").is_some());
|
||||
assert!(s.created_event(stale.operation_id).expect("rejection event").is_none());
|
||||
assert_eq!(
|
||||
apply(&mut s, 6, &stale),
|
||||
CreatedResult::HeadMismatch {
|
||||
actual_head: Some(c.prepared.version_id)
|
||||
}
|
||||
);
|
||||
drop(s);
|
||||
let s = reopen(&dir.path().join("db"));
|
||||
assert_eq!(s.last_applied().expect("last"), Some(id(6)));
|
||||
let tx = s.database.begin_read().expect("read");
|
||||
assert_eq!(tx.open_table(EVENTS).expect("events").len().expect("len"), 2);
|
||||
}
|
||||
#[test]
|
||||
fn created_binding_is_pinned_and_not_caller_selected() {
|
||||
let (dir, mut s) = fixture();
|
||||
let mut bad = command();
|
||||
bad.binding_revision = 10;
|
||||
assert_eq!(apply(&mut s, 0, &bad), CreatedResult::BindingMismatch);
|
||||
assert!(s.created_head(&bad.object).expect("head").is_none());
|
||||
assert!(s.created_event(bad.operation_id).expect("event").is_none());
|
||||
assert_eq!(
|
||||
s.created_operation(bad.operation_id)
|
||||
.expect("operation")
|
||||
.expect("saved")
|
||||
.result,
|
||||
CreatedResult::BindingMismatch
|
||||
);
|
||||
s.pin_capture_binding(binding()).expect("idempotent pin");
|
||||
let mut changed = binding();
|
||||
changed.target_id = [10; 16];
|
||||
assert!(matches!(s.pin_capture_binding(changed), Err(StoreError::BindingConflict)));
|
||||
drop(s);
|
||||
let s = reopen(&dir.path().join("db"));
|
||||
assert_eq!(s.capture_binding().expect("binding"), Some(binding()));
|
||||
}
|
||||
#[test]
|
||||
fn created_schema_compatibility_and_corruption_are_checked() {
|
||||
let dir = tempfile::tempdir().expect("dir");
|
||||
let path = dir.path().join("db");
|
||||
let s = Store::initialize(&path, identity()).expect("schema1");
|
||||
assert_eq!(s.capture_binding().expect("unmigrated"), None);
|
||||
drop(s);
|
||||
let mut s = reopen(&path);
|
||||
assert_eq!(s.last_applied().expect("no apply"), None);
|
||||
append(&mut s, 0, &command());
|
||||
s.save_committed(id(0)).expect("schema2");
|
||||
drop(s);
|
||||
let mut s = reopen(&path);
|
||||
assert_eq!(s.capture_binding().expect("schema2 unchanged"), None);
|
||||
s.pin_capture_binding(binding()).expect("explicit upgrade");
|
||||
drop(s);
|
||||
let mut s = reopen(&path);
|
||||
assert_eq!(s.capture_binding().expect("schema3"), Some(binding()));
|
||||
s.apply_next_created(id(0)).expect("apply");
|
||||
drop(s);
|
||||
let db = Database::open(&path).expect("raw db");
|
||||
let tx = db.begin_write().expect("write corruption");
|
||||
tx.open_table(EVENTS)
|
||||
.expect("events")
|
||||
.remove(command().operation_id.as_slice())
|
||||
.expect("remove reference");
|
||||
tx.commit().expect("commit corruption");
|
||||
drop(db);
|
||||
let result = Store::open(&path, identity());
|
||||
assert!(
|
||||
matches!(result, Err(StoreError::CorruptRecord)),
|
||||
"U11 missing event rejected before expect"
|
||||
);
|
||||
let (dir, mut s) = fixture();
|
||||
assert_eq!(s.read_committed().expect("empty committed"), None);
|
||||
append(&mut s, 0, &command());
|
||||
s.save_committed(id(0)).expect("committed schema3");
|
||||
assert_eq!(s.capture_binding().expect("no downgrade"), Some(binding()));
|
||||
drop(s);
|
||||
let path = dir.path().join("db");
|
||||
let db = Database::open(&path).expect("raw db");
|
||||
let tx = db.begin_write().expect("write");
|
||||
let mut marker = vec![1];
|
||||
marker.extend(encode_id(id(0)));
|
||||
tx.open_table(META)
|
||||
.expect("meta")
|
||||
.insert("last_applied", marker.as_slice())
|
||||
.expect("corrupt applied");
|
||||
tx.commit().expect("commit");
|
||||
drop(db);
|
||||
assert!(
|
||||
matches!(Store::open(&path, identity()), Err(StoreError::CorruptRecord)),
|
||||
"U11 last applied missing result rejected"
|
||||
);
|
||||
let (dir, s) = fixture();
|
||||
drop(s);
|
||||
let path = dir.path().join("db");
|
||||
let db = Database::open(&path).expect("raw pinned db");
|
||||
let tx = db.begin_write().expect("missing binding write");
|
||||
tx.open_table(META)
|
||||
.expect("meta")
|
||||
.remove("capture_binding")
|
||||
.expect("remove binding");
|
||||
tx.commit().expect("binding corruption commit");
|
||||
drop(db);
|
||||
assert!(
|
||||
matches!(Store::open(&path, identity()), Err(StoreError::CorruptRecord)),
|
||||
"U11 missing pinned binding rejected"
|
||||
);
|
||||
|
||||
let (dir, mut s) = fixture();
|
||||
let c = command();
|
||||
assert_eq!(apply(&mut s, 0, &c), success(&c, 0));
|
||||
assert_eq!(apply(&mut s, 1, &c), success(&c, 0));
|
||||
drop(s);
|
||||
let path = dir.path().join("db");
|
||||
let db = Database::open(&path).expect("raw duplicate db");
|
||||
let tx = db.begin_write().expect("retarget decision write");
|
||||
let mut key = created::object_bytes(&c.object).expect("object key");
|
||||
key.extend(c.prepared.version_id);
|
||||
let mut version = Vec::new();
|
||||
created::put_prepared(&mut version, &c.prepared);
|
||||
version.extend(encode_id(id(1)));
|
||||
version.extend(binding().revision.to_be_bytes());
|
||||
tx.open_table(VERSIONS)
|
||||
.expect("versions")
|
||||
.insert(key.as_slice(), version.as_slice())
|
||||
.expect("retarget version");
|
||||
let mut event = created::object_bytes(&c.object).expect("event object");
|
||||
created::put_prepared(&mut event, &c.prepared);
|
||||
event.extend(encode_id(id(1)));
|
||||
event.extend(created::binding_bytes(&binding()).expect("binding bytes"));
|
||||
tx.open_table(EVENTS)
|
||||
.expect("events")
|
||||
.insert(c.operation_id.as_slice(), event.as_slice())
|
||||
.expect("retarget event");
|
||||
let canonical = c.encode().expect("canonical");
|
||||
let mut operation = u64::try_from(canonical.len()).expect("length").to_be_bytes().to_vec();
|
||||
operation.extend(canonical);
|
||||
operation.extend(created::result_bytes(&success(&c, 1)));
|
||||
tx.open_table(OPERATIONS)
|
||||
.expect("operations")
|
||||
.insert(c.operation_id.as_slice(), operation.as_slice())
|
||||
.expect("retarget original response");
|
||||
for index in 0..=1 {
|
||||
let mut result = encode_id(id(index));
|
||||
result.extend(created::result_bytes(&success(&c, 1)));
|
||||
tx.open_table(APPLY_RESULTS)
|
||||
.expect("results")
|
||||
.insert(index, result.as_slice())
|
||||
.expect("retarget duplicate response");
|
||||
}
|
||||
tx.commit().expect("coherent retarget commit");
|
||||
drop(db);
|
||||
assert!(
|
||||
matches!(Store::open(&path, identity()), Err(StoreError::CorruptRecord)),
|
||||
"U11 original decision cannot retarget duplicate log"
|
||||
);
|
||||
}
|
||||
#[test]
|
||||
fn created_process_child() {
|
||||
if let Some(path) = std::env::var_os("U11_CHILD_DB") {
|
||||
let mut s = Store::initialize(path, identity()).expect("child init");
|
||||
s.pin_capture_binding(binding()).expect("child pin");
|
||||
assert_eq!(apply(&mut s, 0, &command()), success(&command(), 0));
|
||||
complete(&s);
|
||||
println!("U11_ACK");
|
||||
std::io::stdout().flush().expect("flush ACK");
|
||||
loop {
|
||||
std::thread::park()
|
||||
}
|
||||
}
|
||||
let (_dir, mut s) = fixture();
|
||||
assert_eq!(apply(&mut s, 0, &command()), success(&command(), 0));
|
||||
complete(&s);
|
||||
}
|
||||
#[test]
|
||||
fn created_acknowledged_apply_survives_child_kill() {
|
||||
let dir = tempfile::tempdir().expect("dir");
|
||||
let path = dir.path().join("db");
|
||||
let mut child = Command::new(std::env::current_exe().expect("test executable"))
|
||||
.args(["--exact", "application_tests::created_process_child", "--nocapture"])
|
||||
.env("U11_CHILD_DB", &path)
|
||||
.stdout(Stdio::piped())
|
||||
.stderr(Stdio::inherit())
|
||||
.spawn()
|
||||
.expect("spawn");
|
||||
let stdout = child.stdout.take().expect("stdout");
|
||||
let (tx, rx) = mpsc::channel();
|
||||
let reader = std::thread::spawn(move || {
|
||||
for line in BufReader::new(stdout).lines() {
|
||||
let line = line.expect("child line");
|
||||
if line.ends_with("U11_ACK") {
|
||||
let _ = tx.send(());
|
||||
break;
|
||||
}
|
||||
}
|
||||
});
|
||||
let acknowledged = rx.recv_timeout(Duration::from_secs(20));
|
||||
child.kill().expect("kill child");
|
||||
child.wait().expect("wait child");
|
||||
reader.join().expect("reader cleanup");
|
||||
assert!(acknowledged.is_ok(), "U11 bounded child ACK missing");
|
||||
complete(&reopen(&path));
|
||||
}
|
||||
#[test]
|
||||
fn created_power_cut_before_and_after_apply_flush() {
|
||||
let (dir, mut s) = fixture();
|
||||
append(&mut s, 0, &command());
|
||||
s.save_committed(id(0)).expect("committed");
|
||||
drop(s);
|
||||
let path = dir.path().join("db");
|
||||
let backend = CrashBackend::new(&path);
|
||||
let mut s = Store::from_database(backend.database(), identity()).expect("backend");
|
||||
assert_eq!(s.apply_next_created(id(0)).expect("apply ACK"), success(&command(), 0));
|
||||
backend.cut();
|
||||
drop(s);
|
||||
complete(&reopen(&path));
|
||||
for sync in 1..=2 {
|
||||
for after in [false, true] {
|
||||
let (dir, mut s) = fixture();
|
||||
append(&mut s, 0, &command());
|
||||
s.save_committed(id(0)).expect("committed");
|
||||
drop(s);
|
||||
let path = dir.path().join("db");
|
||||
let backend = CrashBackend::new(&path);
|
||||
let mut s = Store::from_database(backend.database(), identity()).expect("backend");
|
||||
let (entered, resume) = backend.pause_sync(sync, after);
|
||||
let writer = std::thread::spawn(move || {
|
||||
let result = s.apply_next_created(id(0));
|
||||
(s, result)
|
||||
});
|
||||
entered.wait();
|
||||
backend.cut();
|
||||
resume.wait();
|
||||
let (s, result) = writer.join().expect("writer");
|
||||
drop(s);
|
||||
let reopened = Store::open(&path, identity());
|
||||
assert!(
|
||||
reopened.is_ok(),
|
||||
"U11 apply cut must reopen whole old/new state sync={sync} after={after}: {:?}",
|
||||
reopened.as_ref().err()
|
||||
);
|
||||
let s = reopened.expect("asserted reopen");
|
||||
if s.last_applied().expect("last").is_some() {
|
||||
complete(&s)
|
||||
} else {
|
||||
assert!(result.is_err());
|
||||
assert_eq!(s.created_head(&command().object).expect("old head"), None);
|
||||
assert_eq!(
|
||||
s.created_version(&command().object, command().prepared.version_id)
|
||||
.expect("old version"),
|
||||
None
|
||||
);
|
||||
assert_eq!(s.created_event(command().operation_id).expect("old event"), None);
|
||||
assert_eq!(s.created_operation(command().operation_id).expect("old op"), None);
|
||||
assert_eq!(s.created_apply_result(0).expect("old result"), None)
|
||||
}
|
||||
eprintln!("U11 cut boundary sync={sync} after={after}");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,579 @@
|
||||
//! Immutable checkpoint state and disk-backed validation of the retained suffix.
|
||||
use crate::{
|
||||
CaptureMembership, CreatedApplyResult, CreatedEvent, CreatedResult, CreatedVersion, LogId, StoreError, application,
|
||||
created::{DecideCreated, Decoder, object_bytes, result_bytes},
|
||||
native_checkpoint::{CheckpointLimits, recovery_scratch},
|
||||
snapshot,
|
||||
};
|
||||
use redb::{ReadTransaction, ReadableDatabase, ReadableTable, ReadableTableMetadata, TableDefinition};
|
||||
|
||||
pub(crate) const META_KEY: &str = "checkpoint_baseline";
|
||||
pub(crate) const PURGED_KEY: &str = "checkpoint_purged";
|
||||
pub(crate) const HEADS: TableDefinition<&[u8], &[u8]> = TableDefinition::new("checkpoint_heads_v1");
|
||||
pub(crate) const VERSIONS: TableDefinition<&[u8], &[u8]> = TableDefinition::new("checkpoint_versions_v1");
|
||||
pub(crate) const EVENTS: TableDefinition<&[u8], &[u8]> = TableDefinition::new("checkpoint_events_v1");
|
||||
pub(crate) const OPERATIONS: TableDefinition<&[u8], &[u8]> = TableDefinition::new("checkpoint_operations_v1");
|
||||
const FIRST_DECISIONS: TableDefinition<u64, &[u8]> = TableDefinition::new("checkpoint_validation_decisions");
|
||||
const VERSION_OPERATIONS: TableDefinition<&[u8], &[u8]> = TableDefinition::new("checkpoint_validation_versions");
|
||||
const METADATA_BYTES: usize = 1024 * 1024;
|
||||
|
||||
#[derive(Clone, Debug)]
|
||||
pub(crate) struct BaselineMetadata {
|
||||
pub(crate) generation: u64,
|
||||
pub(crate) header: snapshot::Header,
|
||||
pub(crate) limits: CheckpointLimits,
|
||||
}
|
||||
|
||||
struct EmptySink;
|
||||
impl snapshot::StagingSink for EmptySink {
|
||||
fn row(&mut self, _: snapshot::Section, _: &[u8], _: &[u8]) -> std::io::Result<()> {
|
||||
Err(std::io::Error::other("checkpoint metadata contains rows"))
|
||||
}
|
||||
}
|
||||
fn metadata_limits() -> snapshot::Limits {
|
||||
snapshot::Limits {
|
||||
total_bytes: 1024 * 1024,
|
||||
membership_bytes: 512 * 1024,
|
||||
key_bytes: 0,
|
||||
value_bytes: 0,
|
||||
records: 0,
|
||||
}
|
||||
}
|
||||
pub(crate) fn encode_metadata(metadata: &BaselineMetadata) -> Result<Vec<u8>, StoreError> {
|
||||
metadata.limits.validate()?;
|
||||
if metadata.generation == 0 {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let mut bytes = b"CBAS\x01".to_vec();
|
||||
for value in [
|
||||
metadata.generation,
|
||||
metadata.limits.snapshot.total_bytes,
|
||||
metadata.limits.snapshot.membership_bytes,
|
||||
metadata.limits.snapshot.key_bytes,
|
||||
metadata.limits.snapshot.value_bytes,
|
||||
metadata.limits.snapshot.records,
|
||||
metadata.limits.staging_bytes,
|
||||
] {
|
||||
bytes.extend(value.to_be_bytes());
|
||||
}
|
||||
let frame = snapshot::Encoder::new(Vec::new(), &metadata.header, [0; 4], metadata_limits())
|
||||
.and_then(snapshot::Encoder::finish)
|
||||
.map_err(|_| StoreError::CorruptRecord)?;
|
||||
bytes.extend(frame);
|
||||
if bytes.len() > METADATA_BYTES {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
Ok(bytes)
|
||||
}
|
||||
pub(crate) fn read_metadata(
|
||||
meta: &impl ReadableTable<&'static str, &'static [u8]>,
|
||||
) -> Result<Option<BaselineMetadata>, StoreError> {
|
||||
let schema = crate::number(required(meta.get("schema")?)?.value())?;
|
||||
let stored = meta.get(META_KEY)?;
|
||||
if schema != 7 {
|
||||
if stored.is_some() || meta.get(PURGED_KEY)?.is_some() {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
return Ok(None);
|
||||
}
|
||||
let value = required(stored)?;
|
||||
let bytes = value.value();
|
||||
if bytes.len() > METADATA_BYTES || bytes.get(..5) != Some(b"CBAS\x01") {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let mut numbers = [0u64; 7];
|
||||
for (index, number) in numbers.iter_mut().enumerate() {
|
||||
let start = 5 + index * 8;
|
||||
*number = crate::number(bytes.get(start..start + 8).ok_or(StoreError::CorruptRecord)?)?;
|
||||
}
|
||||
let limits = CheckpointLimits {
|
||||
snapshot: snapshot::Limits {
|
||||
total_bytes: numbers[1],
|
||||
membership_bytes: numbers[2],
|
||||
key_bytes: numbers[3],
|
||||
value_bytes: numbers[4],
|
||||
records: numbers[5],
|
||||
},
|
||||
staging_bytes: numbers[6],
|
||||
};
|
||||
limits.validate()?;
|
||||
let header = snapshot::decode(bytes.get(61..).ok_or(StoreError::CorruptRecord)?, &mut EmptySink, metadata_limits())
|
||||
.map_err(|_| StoreError::CorruptRecord)?;
|
||||
let metadata = BaselineMetadata {
|
||||
generation: numbers[0],
|
||||
header,
|
||||
limits,
|
||||
};
|
||||
if encode_metadata(&metadata)?.as_slice() != bytes {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
Ok(Some(metadata))
|
||||
}
|
||||
pub(crate) fn read_baseline_cut(meta: &impl ReadableTable<&'static str, &'static [u8]>) -> Result<Option<LogId>, StoreError> {
|
||||
Ok(read_metadata(meta)?.and_then(|metadata| metadata.header.applied))
|
||||
}
|
||||
pub(crate) fn encode_purged(id: LogId) -> Vec<u8> {
|
||||
let mut bytes = b"CPUR\x01".to_vec();
|
||||
bytes.extend(crate::encode_id(id));
|
||||
bytes
|
||||
}
|
||||
pub(crate) fn read_purged(meta: &impl ReadableTable<&'static str, &'static [u8]>) -> Result<Option<LogId>, StoreError> {
|
||||
let cut = read_baseline_cut(meta)?;
|
||||
let Some(value) = meta.get(PURGED_KEY)? else {
|
||||
return Ok(None);
|
||||
};
|
||||
let bytes = value.value();
|
||||
if bytes.len() != 29 || bytes.get(..5) != Some(b"CPUR\x01") {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let id = crate::decode_id(&bytes[5..])?;
|
||||
at_or_before(id, required(cut)?)?;
|
||||
Ok(Some(id))
|
||||
}
|
||||
fn at_or_before(id: LogId, cut: LogId) -> Result<(), StoreError> {
|
||||
if id.index > cut.index || (id.index == cut.index && id != cut) {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
fn required<T>(value: Option<T>) -> Result<T, StoreError> {
|
||||
value.ok_or(StoreError::CorruptRecord)
|
||||
}
|
||||
struct Budget {
|
||||
limits: snapshot::Limits,
|
||||
bytes: u64,
|
||||
records: u64,
|
||||
}
|
||||
impl Budget {
|
||||
fn new(limits: snapshot::Limits) -> Self {
|
||||
Self {
|
||||
limits,
|
||||
bytes: 0,
|
||||
records: 0,
|
||||
}
|
||||
}
|
||||
fn row(&mut self, key: &[u8], value: &[u8]) -> Result<(), StoreError> {
|
||||
let key = u64::try_from(key.len()).map_err(|_| StoreError::CorruptRecord)?;
|
||||
let value = u64::try_from(value.len()).map_err(|_| StoreError::CorruptRecord)?;
|
||||
if key > 1024 * 1024 || value > 1024 * 1024 {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
self.bytes = self
|
||||
.bytes
|
||||
.checked_add(key)
|
||||
.and_then(|n| n.checked_add(value))
|
||||
.ok_or(StoreError::ResourceLimit)?;
|
||||
self.records = self.records.checked_add(1).ok_or(StoreError::ResourceLimit)?;
|
||||
if key > self.limits.key_bytes
|
||||
|| value > self.limits.value_bytes
|
||||
|| self.bytes > self.limits.total_bytes
|
||||
|| self.records > self.limits.records
|
||||
{
|
||||
return Err(StoreError::ResourceLimit);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn resource_error(error: StoreError) -> StoreError {
|
||||
use std::error::Error;
|
||||
let mut cause: Option<&(dyn Error + 'static)> = Some(&error);
|
||||
while let Some(current) = cause {
|
||||
if current
|
||||
.downcast_ref::<std::io::Error>()
|
||||
.is_some_and(|io| io.kind() == std::io::ErrorKind::StorageFull)
|
||||
{
|
||||
return StoreError::ResourceLimit;
|
||||
}
|
||||
cause = current.source();
|
||||
}
|
||||
error
|
||||
}
|
||||
|
||||
/// Validate relationships, preserving negative history rather than re-evaluating it.
|
||||
/// The caller separately establishes local capture or authenticated installation authority.
|
||||
pub(crate) fn validate_baseline_with_budget(
|
||||
tx: &ReadTransaction,
|
||||
metadata: &BaselineMetadata,
|
||||
index_max: u64,
|
||||
) -> Result<(), StoreError> {
|
||||
validate_baseline_inner(tx, metadata, index_max).map_err(resource_error)
|
||||
}
|
||||
|
||||
fn validate_baseline_inner(tx: &ReadTransaction, metadata: &BaselineMetadata, index_max: u64) -> Result<(), StoreError> {
|
||||
encode_metadata(metadata)?;
|
||||
let Some(cut) = metadata.header.applied else {
|
||||
if metadata.header.membership != CaptureMembership::new(None, vec![], std::collections::BTreeMap::new())? {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
for definition in [HEADS, VERSIONS, EVENTS, OPERATIONS] {
|
||||
if tx.open_table(definition)?.len()? != 0 {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
}
|
||||
return Ok(());
|
||||
};
|
||||
let heads = tx.open_table(HEADS)?;
|
||||
let versions = tx.open_table(VERSIONS)?;
|
||||
let events = tx.open_table(EVENTS)?;
|
||||
let operations = tx.open_table(OPERATIONS)?;
|
||||
let (_directory, index) = recovery_scratch(index_max)?;
|
||||
let mut index_write = index.begin_write()?;
|
||||
index_write.open_table(FIRST_DECISIONS)?;
|
||||
index_write.open_table(VERSION_OPERATIONS)?;
|
||||
let mut budget = Budget::new(metadata.limits.snapshot);
|
||||
let mut pending = 0;
|
||||
for row in operations.iter()? {
|
||||
let (key, value) = row?;
|
||||
budget.row(key.value(), value.value())?;
|
||||
let provenance = application::decode_provenance(value.value())?;
|
||||
let command = DecideCreated::decode(&provenance.operation.canonical_command)?;
|
||||
let canonical = command.encode()?;
|
||||
if key.value() != command.operation_id || canonical != provenance.operation.canonical_command {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
at_or_before(provenance.first_decision_log_id, cut)?;
|
||||
let mut original = u64::try_from(canonical.len())
|
||||
.map_err(|_| StoreError::CorruptRecord)?
|
||||
.to_be_bytes()
|
||||
.to_vec();
|
||||
original.extend(&canonical);
|
||||
original.extend(result_bytes(&provenance.operation.result));
|
||||
if application::encode_provenance(provenance.first_decision_log_id, &original)?.as_slice() != value.value() {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
if index_write
|
||||
.open_table(FIRST_DECISIONS)?
|
||||
.insert(provenance.first_decision_log_id.index, key.value())?
|
||||
.is_some()
|
||||
{
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
if provenance.operation.result == CreatedResult::OperationConflict {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
if let CreatedResult::Created {
|
||||
version_id,
|
||||
event_id,
|
||||
decision_log_id,
|
||||
} = provenance.operation.result
|
||||
{
|
||||
if version_id != command.prepared.version_id
|
||||
|| event_id != command.operation_id
|
||||
|| decision_log_id != provenance.first_decision_log_id
|
||||
|| command.binding_revision != metadata.header.binding.revision
|
||||
{
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let event = application::decode_event(required(events.get(key.value())?)?.value())?;
|
||||
if event
|
||||
!= (CreatedEvent {
|
||||
object: command.object.clone(),
|
||||
prepared: command.prepared.clone(),
|
||||
decision_log_id,
|
||||
binding: metadata.header.binding.clone(),
|
||||
})
|
||||
{
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let version_key = application::version_key(&command.object, version_id)?;
|
||||
let version = application::decode_version(required(versions.get(version_key.as_slice())?)?.value())?;
|
||||
if version
|
||||
!= (CreatedVersion {
|
||||
prepared: command.prepared.clone(),
|
||||
decision_log_id,
|
||||
binding_revision: metadata.header.binding.revision,
|
||||
})
|
||||
{
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
if index_write
|
||||
.open_table(VERSION_OPERATIONS)?
|
||||
.insert(version_key.as_slice(), key.value())?
|
||||
.is_some()
|
||||
{
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
} else if events.get(key.value())?.is_some() {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
pending += 1;
|
||||
if pending == 128 {
|
||||
index_write.commit().map_err(StoreError::StagingCommit)?;
|
||||
index_write = index.begin_write()?;
|
||||
pending = 0;
|
||||
}
|
||||
}
|
||||
index_write.commit().map_err(StoreError::StagingCommit)?;
|
||||
let index_read = index.begin_read()?;
|
||||
let version_operations = index_read.open_table(VERSION_OPERATIONS)?;
|
||||
if version_operations.len()? != versions.len()? {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
for row in versions.iter()? {
|
||||
let (key, value) = row?;
|
||||
budget.row(key.value(), value.value())?;
|
||||
required(version_operations.get(key.value())?)?;
|
||||
let mut decoder = Decoder::new(key.value());
|
||||
let object = decoder.object()?;
|
||||
let id = decoder.uuid()?;
|
||||
decoder.finish()?;
|
||||
let version = application::decode_version(value.value())?;
|
||||
let head_bytes = required(heads.get(object_bytes(&object)?.as_slice())?)?;
|
||||
let mut decoder = Decoder::new(head_bytes.value());
|
||||
let head = decoder.uuid()?;
|
||||
decoder.finish()?;
|
||||
let current =
|
||||
application::decode_version(required(versions.get(application::version_key(&object, head)?.as_slice())?)?.value())?;
|
||||
if id != version.prepared.version_id
|
||||
|| current.decision_log_id.index < version.decision_log_id.index
|
||||
|| (current.decision_log_id.index == version.decision_log_id.index
|
||||
&& current.decision_log_id != version.decision_log_id)
|
||||
{
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
}
|
||||
for row in events.iter()? {
|
||||
let (key, value) = row?;
|
||||
budget.row(key.value(), value.value())?;
|
||||
let event = application::decode_event(value.value())?;
|
||||
let operation = application::decode_provenance(required(operations.get(key.value())?)?.value())?;
|
||||
if operation.operation.result
|
||||
!= (CreatedResult::Created {
|
||||
version_id: event.prepared.version_id,
|
||||
event_id: key.value().try_into().map_err(|_| StoreError::CorruptRecord)?,
|
||||
decision_log_id: event.decision_log_id,
|
||||
})
|
||||
{
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
}
|
||||
for row in heads.iter()? {
|
||||
let (key, value) = row?;
|
||||
budget.row(key.value(), value.value())?;
|
||||
let mut decoder = Decoder::new(key.value());
|
||||
let object = decoder.object()?;
|
||||
decoder.finish()?;
|
||||
let mut decoder = Decoder::new(value.value());
|
||||
let id = decoder.uuid()?;
|
||||
decoder.finish()?;
|
||||
required(versions.get(application::version_key(&object, id)?.as_slice())?)?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub(crate) fn validate_recovery(tx: &ReadTransaction) -> Result<(), StoreError> {
|
||||
validate_recovery_with_limits(tx, None)
|
||||
}
|
||||
|
||||
pub(crate) fn validate_recovery_with_limits(
|
||||
tx: &ReadTransaction,
|
||||
override_limits: Option<CheckpointLimits>,
|
||||
) -> Result<(), StoreError> {
|
||||
validate_recovery_inner(tx, override_limits).map_err(resource_error)
|
||||
}
|
||||
|
||||
fn validate_recovery_inner(tx: &ReadTransaction, override_limits: Option<CheckpointLimits>) -> Result<(), StoreError> {
|
||||
let meta = tx.open_table(crate::META)?;
|
||||
let metadata = required(read_metadata(&meta)?)?;
|
||||
crate::raft_state_machine::selected_meta(&meta, &metadata)?;
|
||||
let cut = metadata.header.applied;
|
||||
let recovery_limits = override_limits.unwrap_or(metadata.limits);
|
||||
recovery_limits.validate()?;
|
||||
let identity = crate::decode_identity(required(meta.get("identity")?)?.value())?;
|
||||
let binding = application::read_binding(&meta)?;
|
||||
if identity.cluster_id != metadata.header.cluster_id || binding != metadata.header.binding {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let purged = read_purged(&meta)?;
|
||||
validate_baseline_with_budget(tx, &metadata, recovery_limits.staging_bytes)?;
|
||||
let last = application::read_applied(&meta)?;
|
||||
optional_at_or_before(cut, last)?;
|
||||
let logs = tx.open_table(crate::LOGS)?;
|
||||
let committed = crate::committed::validate_committed(&meta, &logs)?;
|
||||
optional_at_or_before(last, committed)?;
|
||||
let declared_tail = meta.get("tail")?.map(|v| crate::decode_id(v.value())).transpose()?;
|
||||
optional_at_or_before(committed, declared_tail)?;
|
||||
let (_directory, scratch) = recovery_scratch(recovery_limits.staging_bytes)?;
|
||||
for (source, target) in [
|
||||
(HEADS, application::HEADS),
|
||||
(VERSIONS, application::VERSIONS),
|
||||
(EVENTS, application::EVENTS),
|
||||
(OPERATIONS, application::OPERATIONS),
|
||||
] {
|
||||
let table = tx.open_table(source)?;
|
||||
let mut write = scratch.begin_write()?;
|
||||
write.open_table(target)?;
|
||||
let mut pending = 0;
|
||||
for row in table.iter()? {
|
||||
let (key, value) = row?;
|
||||
write.open_table(target)?.insert(key.value(), value.value())?;
|
||||
pending += 1;
|
||||
if pending == 128 {
|
||||
write.commit().map_err(StoreError::StagingCommit)?;
|
||||
write = scratch.begin_write()?;
|
||||
pending = 0;
|
||||
}
|
||||
}
|
||||
write.commit().map_err(StoreError::StagingCommit)?;
|
||||
}
|
||||
let mut membership: CaptureMembership = metadata.header.membership.clone();
|
||||
if let Some(cut) = cut
|
||||
&& let Some(retained_cut) = logs.get(cut.index)?
|
||||
&& crate::decode_log(retained_cut.value())?.id != cut
|
||||
{
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let results = tx.open_table(application::APPLY_RESULTS)?;
|
||||
// Covered entries may remain until purge. Check their exact typed responses
|
||||
// without rebuilding the historical state or allocating a prefix-sized map.
|
||||
let operations = tx.open_table(OPERATIONS)?;
|
||||
let mut actual_tail = purged;
|
||||
let mut prefix_next = purged.map_or(Some(0), |id| id.index.checked_add(1));
|
||||
if let Some(cut) = cut {
|
||||
for row in logs.range(..=cut.index)? {
|
||||
let (key, bytes) = row?;
|
||||
if purged.is_some_and(|purged| key.value() <= purged.index) {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
if bytes.value().len() > 1024 * 1024 {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let entry = crate::decode_log(bytes.value())?;
|
||||
if entry.id.index != key.value() || prefix_next != Some(key.value()) {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
actual_tail = Some(entry.id);
|
||||
prefix_next = key.value().checked_add(1);
|
||||
let native = application::decode_native_entry(entry)?;
|
||||
let bytes = required(results.get(key.value())?)?;
|
||||
if bytes.value().len() > 1024 * 1024 {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let response = application::decode_response(bytes.value())?;
|
||||
application::validate_response_kind(&native, &response)?;
|
||||
if let openraft::EntryPayload::Normal(command) = native.payload {
|
||||
let operation = application::decode_provenance(
|
||||
required(operations.get(command.created().operation_id.as_slice())?)?.value(),
|
||||
)?;
|
||||
let canonical = command.created().encode()?;
|
||||
let expected = if operation.operation.canonical_command == canonical {
|
||||
operation.operation.result
|
||||
} else {
|
||||
CreatedResult::OperationConflict
|
||||
};
|
||||
if response.created_result() != Some(&expected) {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
if operation.first_decision_log_id.index == key.value()
|
||||
&& operation.first_decision_log_id != LogId::from(native.log_id)
|
||||
{
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
}
|
||||
}
|
||||
for row in results.range(..=cut.index)? {
|
||||
let (key, _) = row?;
|
||||
if purged.is_some_and(|purged| key.value() <= purged.index) || logs.get(key.value())?.is_none() {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
}
|
||||
if purged.is_none_or(|purged| purged.index < cut.index) && logs.get(cut.index)?.is_none() {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
}
|
||||
if actual_tail != cut {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
|
||||
let mut observed = cut;
|
||||
let mut next = cut.map_or(Some(0), |cut| cut.index.checked_add(1));
|
||||
let mut budget = Budget::new(recovery_limits.snapshot);
|
||||
if let Some(start) = next {
|
||||
for row in logs.range(start..)? {
|
||||
let (key, bytes) = row?;
|
||||
budget.row(&key.value().to_be_bytes(), bytes.value())?;
|
||||
let entry = crate::decode_log(bytes.value())?;
|
||||
if next != Some(key.value()) || entry.id.index != key.value() {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
next = key.value().checked_add(1);
|
||||
actual_tail = Some(entry.id);
|
||||
let native = application::decode_native_entry(entry.clone())?;
|
||||
if last.is_none_or(|last| key.value() > last.index) {
|
||||
continue;
|
||||
}
|
||||
let response_bytes = required(results.get(key.value())?)?;
|
||||
if response_bytes.value().len() > 1024 * 1024 {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
if u64::try_from(response_bytes.value().len()).map_err(|_| StoreError::CorruptRecord)?
|
||||
> recovery_limits.snapshot.value_bytes
|
||||
{
|
||||
return Err(StoreError::ResourceLimit);
|
||||
}
|
||||
let response = application::decode_response(response_bytes.value())?;
|
||||
application::validate_response_kind(&native, &response)?;
|
||||
let write = scratch.begin_write()?;
|
||||
let expected = match native.payload {
|
||||
openraft::EntryPayload::Blank => crate::CaptureResponse::blank(entry.id)?,
|
||||
openraft::EntryPayload::Membership(value) => {
|
||||
membership = CaptureMembership::try_from(&openraft::StoredMembership::new(Some(entry.id.into()), value))?;
|
||||
crate::CaptureResponse::membership(entry.id)?
|
||||
}
|
||||
openraft::EntryPayload::Normal(command) => {
|
||||
let canonical = command.created().encode()?;
|
||||
let result = application::apply_created(&write, entry.id, command.created(), &canonical, &binding, 6)?;
|
||||
crate::CaptureResponse::created(CreatedApplyResult {
|
||||
log_id: entry.id,
|
||||
result,
|
||||
})?
|
||||
}
|
||||
};
|
||||
if response != expected {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
write.commit().map_err(StoreError::StagingCommit)?;
|
||||
observed = Some(entry.id);
|
||||
}
|
||||
for row in results.range(start..)? {
|
||||
let (key, _) = row?;
|
||||
if last.is_none_or(|last| key.value() > last.index) || logs.get(key.value())?.is_none() {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
}
|
||||
}
|
||||
if actual_tail != declared_tail || observed != last || application::native_application_state(tx)?.1 != membership {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let recovered = scratch.begin_read()?;
|
||||
let mut live_budget = Budget::new(recovery_limits.snapshot);
|
||||
for definition in [
|
||||
application::HEADS,
|
||||
application::VERSIONS,
|
||||
application::EVENTS,
|
||||
application::OPERATIONS,
|
||||
] {
|
||||
let expected = recovered.open_table(definition)?;
|
||||
let actual = tx.open_table(definition)?;
|
||||
if expected.len()? != actual.len()? {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
for row in actual.iter()? {
|
||||
let (key, value) = row?;
|
||||
live_budget.row(key.value(), value.value())?;
|
||||
if required(expected.get(key.value())?)?.value() != value.value() {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn optional_at_or_before(id: Option<LogId>, cut: Option<LogId>) -> Result<(), StoreError> {
|
||||
match (id, cut) {
|
||||
(None, _) => Ok(()),
|
||||
(Some(id), Some(cut)) => at_or_before(id, cut),
|
||||
_ => Err(StoreError::CorruptRecord),
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
use crate::{LOGS, LogId, META, Store, StoreError, decode_id, decode_log, encode_id, number};
|
||||
use redb::{ReadableDatabase, ReadableTable};
|
||||
|
||||
pub(crate) fn validate_committed(
|
||||
meta: &impl ReadableTable<&'static str, &'static [u8]>,
|
||||
logs: &impl ReadableTable<u64, &'static [u8]>,
|
||||
) -> Result<Option<LogId>, StoreError> {
|
||||
let schema = number(meta.get("schema")?.ok_or(StoreError::CorruptRecord)?.value())?;
|
||||
let marker = meta.get("committed")?;
|
||||
match (schema, marker) {
|
||||
(1 | 3 | 4 | 5 | 6 | 7, None) => {
|
||||
if matches!(schema, 3..=7) && meta.get("last_applied")?.is_none_or(|v| v.value() != [0]) {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
Ok(None)
|
||||
}
|
||||
(2 | 3 | 4 | 5 | 6 | 7, Some(marker)) => {
|
||||
let id = decode_id(marker.value())?;
|
||||
match logs.get(id.index)? {
|
||||
Some(record) if decode_log(record.value())?.id == id => {}
|
||||
None if schema == 7 && crate::checkpoint_baseline::read_baseline_cut(meta)? == Some(id) => {}
|
||||
_ => return Err(StoreError::CorruptRecord),
|
||||
}
|
||||
Ok(Some(id))
|
||||
}
|
||||
(1 | 2, _) => Err(StoreError::CorruptRecord),
|
||||
_ => Err(StoreError::UnsupportedSchema),
|
||||
}
|
||||
}
|
||||
|
||||
impl Store {
|
||||
/// Read the exact committed boundary, validating it against the stored log.
|
||||
pub fn read_committed(&self) -> Result<Option<LogId>, StoreError> {
|
||||
let tx = self.database.begin_read()?;
|
||||
validate_committed(&tx.open_table(META)?, &tx.open_table(LOGS)?)
|
||||
}
|
||||
|
||||
/// Persist a monotonic committed boundary supplied by the authority owner.
|
||||
pub fn save_committed(&mut self, id: LogId) -> Result<(), StoreError> {
|
||||
let tx = self.write_transaction()?;
|
||||
{
|
||||
let mut meta = tx.open_table(META)?;
|
||||
let logs = tx.open_table(LOGS)?;
|
||||
let previous = validate_committed(&meta, &logs)?;
|
||||
if previous == Some(id) {
|
||||
return Ok(());
|
||||
}
|
||||
let record = logs.get(id.index)?.ok_or(StoreError::InvalidCommittedLog)?;
|
||||
if decode_log(record.value())?.id != id {
|
||||
return Err(StoreError::InvalidCommittedLog);
|
||||
}
|
||||
if let Some(previous) = previous {
|
||||
if id.index < previous.index {
|
||||
return Err(StoreError::CommittedRegression);
|
||||
}
|
||||
}
|
||||
meta.insert("committed", encode_id(id).as_slice())?;
|
||||
if previous.is_none() && !matches!(number(meta.get("schema")?.ok_or(StoreError::CorruptRecord)?.value())?, 3..=7) {
|
||||
meta.insert("schema", 2u64.to_be_bytes().as_slice())?;
|
||||
}
|
||||
}
|
||||
self.commit(tx)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,278 @@
|
||||
//! Reuse the existing actual Raft owner fixture, never a caller-constructed result proof.
|
||||
use super::*;
|
||||
|
||||
async fn decide(cluster: &Cluster, value: u8) -> (DecideCreated, LogId) {
|
||||
let input = command(value);
|
||||
let expected = input.created().clone();
|
||||
let response = cluster
|
||||
.node(0)
|
||||
.owner()
|
||||
.client_write(input)
|
||||
.await
|
||||
.expect("actual Raft Created decision");
|
||||
let Some(CreatedResult::Created { decision_log_id, .. }) = response.data.created_result() else {
|
||||
panic!("successful Created result required")
|
||||
};
|
||||
(expected, *decision_log_id)
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn committed_created_authorization_exact() {
|
||||
let cluster = Cluster::start(&[0], 100).await;
|
||||
let (expected, first) = decide(&cluster, 1).await;
|
||||
let authorization = cluster
|
||||
.node(0)
|
||||
.owner()
|
||||
.authorize_created(expected.clone(), first)
|
||||
.await
|
||||
.expect("durable exact authorization");
|
||||
assert_eq!(authorization.identity(), identity(0));
|
||||
assert_eq!(authorization.operation_id(), expected.operation_id);
|
||||
assert_eq!(authorization.object(), &expected.object);
|
||||
assert_eq!(authorization.prepared(), &expected.prepared);
|
||||
assert_eq!(authorization.binding(), &binding());
|
||||
assert_eq!(authorization.decision_log_id(), first);
|
||||
assert_eq!(cluster.node(0).page().await.events[0].captured.decision_log_id, first);
|
||||
cluster.stop().await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn committed_created_authorization_retry_first_decision() {
|
||||
let cluster = Cluster::start(&[0], 100).await;
|
||||
let (expected, first) = decide(&cluster, 2).await;
|
||||
let before = cluster
|
||||
.node(0)
|
||||
.owner()
|
||||
.authorize_created(expected.clone(), first)
|
||||
.await
|
||||
.expect("first authorization");
|
||||
let response = cluster
|
||||
.node(0)
|
||||
.owner()
|
||||
.client_write(CaptureCommand::try_created(expected.clone()).expect("retry command"))
|
||||
.await
|
||||
.expect("real retry");
|
||||
assert_ne!(LogId::from(response.log_id), first);
|
||||
assert!(
|
||||
matches!(response.data.created_result(), Some(CreatedResult::Created{decision_log_id,..}) if *decision_log_id==first)
|
||||
);
|
||||
let after = cluster
|
||||
.node(0)
|
||||
.owner()
|
||||
.authorize_created(expected.clone(), first)
|
||||
.await
|
||||
.expect("first decision retained");
|
||||
assert_eq!(before, after);
|
||||
assert!(
|
||||
cluster
|
||||
.node(0)
|
||||
.owner()
|
||||
.authorize_created(expected, response.log_id.into())
|
||||
.await
|
||||
.is_err()
|
||||
);
|
||||
assert_eq!(cluster.node(0).page().await.events.len(), 1);
|
||||
cluster.stop().await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn committed_created_authorization_rejects_mismatch() {
|
||||
let cluster = Cluster::start(&[0], 100).await;
|
||||
let (expected, first) = decide(&cluster, 3).await;
|
||||
let before = cluster.node(0).page().await;
|
||||
let durable_before = cluster
|
||||
.node(0)
|
||||
.writer
|
||||
.write(|store| {
|
||||
Ok((
|
||||
store.read_vote()?,
|
||||
store.read_committed()?,
|
||||
store.read_entries(0, u64::MAX)?,
|
||||
store.native_application_state()?,
|
||||
store.created_events_page(None, 256)?,
|
||||
))
|
||||
})
|
||||
.await
|
||||
.expect("durable state before rejected authorization");
|
||||
let mut variants = Vec::new();
|
||||
let mut altered = expected.clone();
|
||||
altered.operation_id = [4; 16];
|
||||
variants.push(altered);
|
||||
let mut altered = expected.clone();
|
||||
altered.object.key.push(9);
|
||||
variants.push(altered);
|
||||
let mut altered = expected.clone();
|
||||
altered.object.bucket_incarnation = [9; 16];
|
||||
variants.push(altered);
|
||||
let mut altered = expected.clone();
|
||||
altered.expected_head = Some([9; 16]);
|
||||
variants.push(altered);
|
||||
let mut altered = expected.clone();
|
||||
altered.prepared.preparation_id = [9; 16];
|
||||
variants.push(altered);
|
||||
let mut altered = expected.clone();
|
||||
altered.prepared.version_id = [9; 16];
|
||||
variants.push(altered);
|
||||
let mut altered = expected.clone();
|
||||
altered.prepared.content_digest = [9; 32];
|
||||
variants.push(altered);
|
||||
let mut altered = expected.clone();
|
||||
altered.prepared.content_length += 1;
|
||||
variants.push(altered);
|
||||
let mut altered = expected.clone();
|
||||
altered.binding_revision += 1;
|
||||
variants.push(altered);
|
||||
for altered in variants {
|
||||
assert!(
|
||||
cluster.node(0).owner().authorize_created(altered, first).await.is_err(),
|
||||
"AUTHORIZATION_REQUIRES_EXACT_PREPARED_IDENTITY_AND_COMMAND"
|
||||
);
|
||||
}
|
||||
for wrong in [
|
||||
LogId {
|
||||
term: first.term + 1,
|
||||
..first
|
||||
},
|
||||
LogId {
|
||||
leader_node: first.leader_node + 1,
|
||||
..first
|
||||
},
|
||||
LogId {
|
||||
index: first.index + 1,
|
||||
..first
|
||||
},
|
||||
] {
|
||||
assert!(
|
||||
cluster
|
||||
.node(0)
|
||||
.owner()
|
||||
.authorize_created(expected.clone(), wrong)
|
||||
.await
|
||||
.is_err()
|
||||
);
|
||||
}
|
||||
let durable_after = cluster
|
||||
.node(0)
|
||||
.writer
|
||||
.write(|store| {
|
||||
Ok((
|
||||
store.read_vote()?,
|
||||
store.read_committed()?,
|
||||
store.read_entries(0, u64::MAX)?,
|
||||
store.native_application_state()?,
|
||||
store.created_events_page(None, 256)?,
|
||||
))
|
||||
})
|
||||
.await
|
||||
.expect("durable state after rejected authorization");
|
||||
assert_eq!(durable_before, durable_after, "REJECTED_AUTHORIZATION_DOES_NOT_WRITE");
|
||||
let mut failed = expected.clone();
|
||||
failed.operation_id = [5; 16];
|
||||
failed.prepared.version_id = [5; 16];
|
||||
let response = cluster
|
||||
.node(0)
|
||||
.owner()
|
||||
.client_write(CaptureCommand::try_created(failed.clone()).expect("failed command"))
|
||||
.await
|
||||
.expect("real head mismatch decision");
|
||||
assert!(matches!(response.data.created_result(), Some(CreatedResult::HeadMismatch { .. })));
|
||||
assert!(
|
||||
cluster
|
||||
.node(0)
|
||||
.owner()
|
||||
.authorize_created(failed, response.log_id.into())
|
||||
.await
|
||||
.is_err()
|
||||
);
|
||||
assert_eq!(cluster.node(0).page().await, before);
|
||||
cluster.stop().await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn committed_created_authorization_restart() {
|
||||
let routes = Arc::new(Routes::default());
|
||||
let mut node = Node::start(0, routes.clone(), config(100)).await;
|
||||
node.owner().bootstrap(members(&[0])).await.expect("bootstrap actual owner");
|
||||
node.owner()
|
||||
.raft()
|
||||
.wait(Some(Duration::from_secs(15)))
|
||||
.state(ServerState::Leader, "leader")
|
||||
.await
|
||||
.expect("leader ready");
|
||||
let expected = command(6).created().clone();
|
||||
let response = node.owner().client_write(command(6)).await.expect("real first write");
|
||||
let Some(CreatedResult::Created {
|
||||
decision_log_id: first, ..
|
||||
}) = response.data.created_result()
|
||||
else {
|
||||
panic!("Created")
|
||||
};
|
||||
let first = *first;
|
||||
let before = node
|
||||
.owner()
|
||||
.authorize_created(expected.clone(), first)
|
||||
.await
|
||||
.expect("before restart");
|
||||
node.stop(&routes).await;
|
||||
let Node {
|
||||
directory,
|
||||
writer,
|
||||
owner: _,
|
||||
id,
|
||||
} = node;
|
||||
drop(writer);
|
||||
let writer = NativeLogWriter::new(Store::open(directory.path().join("db"), identity(id)).expect("retained redb"));
|
||||
// A retained commit-before-apply crash fixture is not a client-provided proof.
|
||||
// Only real owner initialization may replay it before authorization can succeed.
|
||||
use openraft::storage::{RaftLogStorage, RaftLogStorageExt};
|
||||
let pending = command(7).created().clone();
|
||||
let mut logs = NativeRaftLogStore::new(writer.clone());
|
||||
let last = logs.get_log_state().await.expect("retained tail").last_log_id.expect("tail");
|
||||
let pending_id = LogId {
|
||||
term: last.leader_id.term,
|
||||
leader_node: last.leader_id.node_id,
|
||||
index: last.index + 1,
|
||||
};
|
||||
logs.blocking_append(vec![CaptureRaftEntry {
|
||||
log_id: pending_id.into(),
|
||||
payload: openraft::EntryPayload::Normal(CaptureCommand::try_created(pending.clone()).expect("pending command")),
|
||||
}])
|
||||
.await
|
||||
.expect("retained crash suffix");
|
||||
logs.save_committed(Some(pending_id.into()))
|
||||
.await
|
||||
.expect("retained commit marker");
|
||||
assert!(
|
||||
writer.authorize_created(pending.clone(), pending_id).await.is_err(),
|
||||
"UNAPPLIED_COMMIT_IS_NOT_AUTHORIZATION"
|
||||
);
|
||||
drop(logs);
|
||||
let owner = NativeRaftOwner::start(
|
||||
writer.clone(),
|
||||
id,
|
||||
config(100),
|
||||
CheckpointLimits::default(),
|
||||
DirectFactory {
|
||||
source: id,
|
||||
routes: routes.clone(),
|
||||
},
|
||||
)
|
||||
.await
|
||||
.expect("real recovery");
|
||||
routes.register(id, owner.raft().clone());
|
||||
let after = owner
|
||||
.authorize_created(expected, first)
|
||||
.await
|
||||
.expect("durable authorization after restart");
|
||||
assert_eq!(before, after);
|
||||
let replayed = owner
|
||||
.authorize_created(pending.clone(), pending_id)
|
||||
.await
|
||||
.expect("actual owner committed recovery authorizes");
|
||||
assert_eq!(replayed.prepared(), &pending.prepared);
|
||||
assert_eq!(replayed.decision_log_id(), pending_id);
|
||||
owner.shutdown().await.expect("drain recovered owner");
|
||||
routes.remove(id);
|
||||
drop(owner);
|
||||
drop(writer);
|
||||
}
|
||||
@@ -0,0 +1,297 @@
|
||||
use crate::{LogId, StoreError, decode_id, encode_id};
|
||||
|
||||
pub const MAX_OBJECT_KEY_LENGTH: usize = 4096;
|
||||
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct ObjectIdentity {
|
||||
pub bucket_incarnation: [u8; 16],
|
||||
pub key: Vec<u8>,
|
||||
}
|
||||
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct PreparedIdentity {
|
||||
pub version_id: [u8; 16],
|
||||
pub preparation_id: [u8; 16],
|
||||
pub content_digest: [u8; 32],
|
||||
pub content_length: u64,
|
||||
}
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct DecideCreated {
|
||||
pub operation_id: [u8; 16],
|
||||
pub object: ObjectIdentity,
|
||||
pub expected_head: Option<[u8; 16]>,
|
||||
pub prepared: PreparedIdentity,
|
||||
pub binding_revision: u64,
|
||||
}
|
||||
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct CaptureBinding {
|
||||
pub revision: u64,
|
||||
pub binding_id: [u8; 16],
|
||||
pub target_id: [u8; 16],
|
||||
}
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub enum CreatedResult {
|
||||
Created {
|
||||
version_id: [u8; 16],
|
||||
event_id: [u8; 16],
|
||||
decision_log_id: LogId,
|
||||
},
|
||||
HeadMismatch {
|
||||
actual_head: Option<[u8; 16]>,
|
||||
},
|
||||
OperationConflict,
|
||||
BindingMismatch,
|
||||
VersionConflict,
|
||||
}
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct CreatedVersion {
|
||||
pub prepared: PreparedIdentity,
|
||||
pub decision_log_id: LogId,
|
||||
pub binding_revision: u64,
|
||||
}
|
||||
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct CreatedEvent {
|
||||
pub object: ObjectIdentity,
|
||||
pub prepared: PreparedIdentity,
|
||||
pub decision_log_id: LogId,
|
||||
pub binding: CaptureBinding,
|
||||
}
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct CreatedOperation {
|
||||
pub canonical_command: Vec<u8>,
|
||||
pub result: CreatedResult,
|
||||
}
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct CreatedOperationProvenance {
|
||||
pub operation: CreatedOperation,
|
||||
pub first_decision_log_id: LogId,
|
||||
}
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct CreatedApplyResult {
|
||||
pub log_id: LogId,
|
||||
pub result: CreatedResult,
|
||||
}
|
||||
|
||||
/// Local publication authority re-read from the actual owner's durable Created decision.
|
||||
/// This is not a serializable remote proof and does not attest physical preparation durability.
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct CommittedCreatedAuthorization {
|
||||
identity: crate::NodeIdentity,
|
||||
command: DecideCreated,
|
||||
binding: CaptureBinding,
|
||||
decision_log_id: LogId,
|
||||
}
|
||||
impl CommittedCreatedAuthorization {
|
||||
pub(crate) fn verified(
|
||||
identity: crate::NodeIdentity,
|
||||
command: DecideCreated,
|
||||
binding: CaptureBinding,
|
||||
decision_log_id: LogId,
|
||||
) -> Self {
|
||||
Self {
|
||||
identity,
|
||||
command,
|
||||
binding,
|
||||
decision_log_id,
|
||||
}
|
||||
}
|
||||
pub fn identity(&self) -> crate::NodeIdentity {
|
||||
self.identity
|
||||
}
|
||||
pub fn operation_id(&self) -> [u8; 16] {
|
||||
self.command.operation_id
|
||||
}
|
||||
pub fn object(&self) -> &ObjectIdentity {
|
||||
&self.command.object
|
||||
}
|
||||
pub fn expected_head(&self) -> Option<[u8; 16]> {
|
||||
self.command.expected_head
|
||||
}
|
||||
pub fn prepared(&self) -> &PreparedIdentity {
|
||||
&self.command.prepared
|
||||
}
|
||||
pub fn binding(&self) -> &CaptureBinding {
|
||||
&self.binding
|
||||
}
|
||||
pub fn decision_log_id(&self) -> LogId {
|
||||
self.decision_log_id
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) struct Decoder<'a> {
|
||||
bytes: &'a [u8],
|
||||
}
|
||||
impl<'a> Decoder<'a> {
|
||||
pub(crate) fn new(bytes: &'a [u8]) -> Self {
|
||||
Self { bytes }
|
||||
}
|
||||
pub(crate) fn take<const N: usize>(&mut self) -> Result<[u8; N], StoreError> {
|
||||
let a = self
|
||||
.bytes
|
||||
.get(..N)
|
||||
.ok_or(StoreError::CorruptRecord)?
|
||||
.try_into()
|
||||
.map_err(|_| StoreError::CorruptRecord)?;
|
||||
self.bytes = &self.bytes[N..];
|
||||
Ok(a)
|
||||
}
|
||||
pub(crate) fn u64(&mut self) -> Result<u64, StoreError> {
|
||||
Ok(u64::from_be_bytes(self.take()?))
|
||||
}
|
||||
pub(crate) fn uuid(&mut self) -> Result<[u8; 16], StoreError> {
|
||||
let id = self.take()?;
|
||||
if id == [0; 16] {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
Ok(id)
|
||||
}
|
||||
pub(crate) fn option(&mut self) -> Result<Option<[u8; 16]>, StoreError> {
|
||||
match self.take::<1>()?[0] {
|
||||
0 => Ok(None),
|
||||
1 => Ok(Some(self.uuid()?)),
|
||||
_ => Err(StoreError::CorruptRecord),
|
||||
}
|
||||
}
|
||||
pub(crate) fn object(&mut self) -> Result<ObjectIdentity, StoreError> {
|
||||
let bucket_incarnation = self.uuid()?;
|
||||
let len = usize::try_from(u32::from_be_bytes(self.take()?)).map_err(|_| StoreError::CorruptRecord)?;
|
||||
if len > MAX_OBJECT_KEY_LENGTH {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let key = self.bytes.get(..len).ok_or(StoreError::CorruptRecord)?.to_vec();
|
||||
self.bytes = &self.bytes[len..];
|
||||
Ok(ObjectIdentity { bucket_incarnation, key })
|
||||
}
|
||||
pub(crate) fn prepared(&mut self) -> Result<PreparedIdentity, StoreError> {
|
||||
Ok(PreparedIdentity {
|
||||
version_id: self.uuid()?,
|
||||
preparation_id: self.uuid()?,
|
||||
content_digest: self.take()?,
|
||||
content_length: self.u64()?,
|
||||
})
|
||||
}
|
||||
pub(crate) fn id(&mut self) -> Result<LogId, StoreError> {
|
||||
decode_id(&self.take::<24>()?)
|
||||
}
|
||||
pub(crate) fn binding(&mut self) -> Result<CaptureBinding, StoreError> {
|
||||
Ok(CaptureBinding {
|
||||
revision: self.u64()?,
|
||||
binding_id: self.uuid()?,
|
||||
target_id: self.uuid()?,
|
||||
})
|
||||
}
|
||||
pub(crate) fn finish(self) -> Result<(), StoreError> {
|
||||
if self.bytes.is_empty() {
|
||||
Ok(())
|
||||
} else {
|
||||
Err(StoreError::CorruptRecord)
|
||||
}
|
||||
}
|
||||
pub(crate) fn result(&mut self) -> Result<CreatedResult, StoreError> {
|
||||
match self.take::<1>()?[0] {
|
||||
0 => Ok(CreatedResult::Created {
|
||||
version_id: self.uuid()?,
|
||||
event_id: self.uuid()?,
|
||||
decision_log_id: self.id()?,
|
||||
}),
|
||||
1 => Ok(CreatedResult::HeadMismatch {
|
||||
actual_head: self.option()?,
|
||||
}),
|
||||
2 => Ok(CreatedResult::OperationConflict),
|
||||
3 => Ok(CreatedResult::BindingMismatch),
|
||||
4 => Ok(CreatedResult::VersionConflict),
|
||||
_ => Err(StoreError::CorruptRecord),
|
||||
}
|
||||
}
|
||||
}
|
||||
pub(crate) fn put_option(b: &mut Vec<u8>, id: Option<[u8; 16]>) {
|
||||
b.push(u8::from(id.is_some()));
|
||||
if let Some(id) = id {
|
||||
b.extend(id)
|
||||
}
|
||||
}
|
||||
pub(crate) fn object_bytes(o: &ObjectIdentity) -> Result<Vec<u8>, StoreError> {
|
||||
if o.bucket_incarnation == [0; 16] || o.key.len() > MAX_OBJECT_KEY_LENGTH {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let capacity = 20usize.checked_add(o.key.len()).ok_or(StoreError::CorruptRecord)?;
|
||||
let mut b = Vec::with_capacity(capacity);
|
||||
b.extend(o.bucket_incarnation);
|
||||
b.extend(
|
||||
u32::try_from(o.key.len())
|
||||
.map_err(|_| StoreError::CorruptRecord)?
|
||||
.to_be_bytes(),
|
||||
);
|
||||
b.extend(&o.key);
|
||||
Ok(b)
|
||||
}
|
||||
pub(crate) fn put_prepared(b: &mut Vec<u8>, p: &PreparedIdentity) {
|
||||
b.extend(p.version_id);
|
||||
b.extend(p.preparation_id);
|
||||
b.extend(p.content_digest);
|
||||
b.extend(p.content_length.to_be_bytes())
|
||||
}
|
||||
pub(crate) fn binding_bytes(v: &CaptureBinding) -> Result<Vec<u8>, StoreError> {
|
||||
let mut b = v.revision.to_be_bytes().to_vec();
|
||||
b.extend(v.binding_id);
|
||||
b.extend(v.target_id);
|
||||
let mut d = Decoder::new(&b);
|
||||
d.binding()?;
|
||||
d.finish()?;
|
||||
Ok(b)
|
||||
}
|
||||
pub(crate) fn result_bytes(r: &CreatedResult) -> Vec<u8> {
|
||||
let mut b = Vec::new();
|
||||
match r {
|
||||
CreatedResult::Created {
|
||||
version_id,
|
||||
event_id,
|
||||
decision_log_id,
|
||||
} => {
|
||||
b.push(0);
|
||||
b.extend(version_id);
|
||||
b.extend(event_id);
|
||||
b.extend(encode_id(*decision_log_id))
|
||||
}
|
||||
CreatedResult::HeadMismatch { actual_head } => {
|
||||
b.push(1);
|
||||
put_option(&mut b, *actual_head)
|
||||
}
|
||||
CreatedResult::OperationConflict => b.push(2),
|
||||
CreatedResult::BindingMismatch => b.push(3),
|
||||
CreatedResult::VersionConflict => b.push(4),
|
||||
}
|
||||
b
|
||||
}
|
||||
impl DecideCreated {
|
||||
pub fn encode(&self) -> Result<Vec<u8>, StoreError> {
|
||||
let object = object_bytes(&self.object)?;
|
||||
let capacity = object.len().checked_add(134).ok_or(StoreError::CorruptRecord)?;
|
||||
let mut b = Vec::with_capacity(capacity);
|
||||
b.extend(b"CRTD\x01");
|
||||
b.extend(self.operation_id);
|
||||
b.extend(object);
|
||||
put_option(&mut b, self.expected_head);
|
||||
put_prepared(&mut b, &self.prepared);
|
||||
b.extend(self.binding_revision.to_be_bytes());
|
||||
Self::decode(&b)?;
|
||||
Ok(b)
|
||||
}
|
||||
pub fn decode(bytes: &[u8]) -> Result<Self, StoreError> {
|
||||
let mut d = Decoder::new(bytes);
|
||||
if d.take::<5>()? != *b"CRTD\x01" {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let c = Self {
|
||||
operation_id: d.uuid()?,
|
||||
object: d.object()?,
|
||||
expected_head: d.option()?,
|
||||
prepared: d.prepared()?,
|
||||
binding_revision: d.u64()?,
|
||||
};
|
||||
d.finish()?;
|
||||
Ok(c)
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,588 @@
|
||||
//! Local checkpoints are captured from this writer's owned transaction only.
|
||||
use crate::{
|
||||
LogId, NativeLogWriter, NativeSnapshotError, NativeSnapshotView, StoreError,
|
||||
checkpoint_baseline::{self, BaselineMetadata},
|
||||
snapshot,
|
||||
};
|
||||
use redb::{ReadableDatabase, ReadableTable, StorageBackend};
|
||||
use std::{
|
||||
fs::File,
|
||||
io::{self, Seek, Write},
|
||||
ops::Bound,
|
||||
sync::{
|
||||
Arc,
|
||||
atomic::{AtomicBool, Ordering},
|
||||
},
|
||||
};
|
||||
|
||||
#[derive(Clone, Copy, Debug)]
|
||||
pub struct CheckpointLimits {
|
||||
pub snapshot: snapshot::Limits,
|
||||
pub staging_bytes: u64,
|
||||
}
|
||||
|
||||
impl CheckpointLimits {
|
||||
pub(crate) fn validate(&self) -> Result<(), StoreError> {
|
||||
let rows = self.snapshot;
|
||||
if rows.total_bytes == 0
|
||||
|| rows.membership_bytes == 0
|
||||
|| rows.membership_bytes > 512 * 1024
|
||||
|| rows.key_bytes == 0
|
||||
|| rows.key_bytes > 1024 * 1024
|
||||
|| rows.value_bytes == 0
|
||||
|| rows.value_bytes > 1024 * 1024
|
||||
|| rows.records == 0
|
||||
|| self.staging_bytes < 4 * 1024 * 1024
|
||||
{
|
||||
return Err(StoreError::ResourceLimit);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for CheckpointLimits {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
snapshot: snapshot::Limits {
|
||||
total_bytes: 256 * 1024 * 1024,
|
||||
membership_bytes: 512 * 1024,
|
||||
key_bytes: 8192,
|
||||
value_bytes: 8192,
|
||||
records: 1_000_000,
|
||||
},
|
||||
staging_bytes: 1024 * 1024 * 1024,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub struct CheckpointReceipt {
|
||||
generation: u64,
|
||||
cut: LogId,
|
||||
}
|
||||
|
||||
impl CheckpointReceipt {
|
||||
pub fn generation(&self) -> u64 {
|
||||
self.generation
|
||||
}
|
||||
pub fn cut(&self) -> LogId {
|
||||
self.cut
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
pub enum CheckpointError {
|
||||
#[error(transparent)]
|
||||
Store(#[from] StoreError),
|
||||
#[error(transparent)]
|
||||
Capture(#[from] NativeSnapshotError),
|
||||
#[error(transparent)]
|
||||
Snapshot(#[from] snapshot::SnapshotError),
|
||||
#[error("checkpoint filesystem failure")]
|
||||
Io(#[from] io::Error),
|
||||
#[error("checkpoint worker failed")]
|
||||
Worker(#[source] tokio::task::JoinError),
|
||||
#[error("checkpoint store lock poisoned")]
|
||||
Poisoned,
|
||||
#[error("checkpoint conflict: {0}")]
|
||||
Conflict(&'static str),
|
||||
#[error("checkpoint cancelled before publication")]
|
||||
Cancelled,
|
||||
}
|
||||
|
||||
/// Enforces the file-length budget before redb can allocate or write a page.
|
||||
#[derive(Debug)]
|
||||
pub(crate) struct BoundedBackend {
|
||||
inner: redb::backends::FileBackend,
|
||||
maximum: u64,
|
||||
}
|
||||
|
||||
impl BoundedBackend {
|
||||
fn new(file: File, maximum: u64) -> Result<Self, redb::DatabaseError> {
|
||||
Ok(Self {
|
||||
inner: redb::backends::FileBackend::new(file)?,
|
||||
maximum,
|
||||
})
|
||||
}
|
||||
|
||||
fn check(&self, end: u64) -> io::Result<()> {
|
||||
if end > self.maximum {
|
||||
return Err(io::Error::new(io::ErrorKind::StorageFull, "checkpoint staging budget"));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
impl StorageBackend for BoundedBackend {
|
||||
fn len(&self) -> io::Result<u64> {
|
||||
self.inner.len()
|
||||
}
|
||||
fn read(&self, offset: u64, out: &mut [u8]) -> io::Result<()> {
|
||||
self.inner.read(offset, out)
|
||||
}
|
||||
fn set_len(&self, len: u64) -> io::Result<()> {
|
||||
self.check(len)?;
|
||||
self.inner.set_len(len)
|
||||
}
|
||||
fn sync_data(&self) -> io::Result<()> {
|
||||
self.inner.sync_data()
|
||||
}
|
||||
fn write(&self, offset: u64, data: &[u8]) -> io::Result<()> {
|
||||
let length = u64::try_from(data.len()).map_err(io::Error::other)?;
|
||||
self.check(
|
||||
offset
|
||||
.checked_add(length)
|
||||
.ok_or_else(|| io::Error::other("checkpoint write overflow"))?,
|
||||
)?;
|
||||
self.inner.write(offset, data)
|
||||
}
|
||||
fn close(&self) -> io::Result<()> {
|
||||
self.inner.close()
|
||||
}
|
||||
fn try_lock_range(&self, start: Bound<u64>, end: Bound<u64>) -> Result<bool, redb::BackendError> {
|
||||
self.inner.try_lock_range(start, end)
|
||||
}
|
||||
fn try_lock_shared_range(&self, start: Bound<u64>, end: Bound<u64>) -> Result<bool, redb::BackendError> {
|
||||
self.inner.try_lock_shared_range(start, end)
|
||||
}
|
||||
fn lock_range(&self, start: Bound<u64>, end: Bound<u64>) -> Result<(), redb::BackendError> {
|
||||
self.inner.lock_range(start, end)
|
||||
}
|
||||
fn lock_shared_range(&self, start: Bound<u64>, end: Bound<u64>) -> Result<(), redb::BackendError> {
|
||||
self.inner.lock_shared_range(start, end)
|
||||
}
|
||||
fn unlock_range(&self, start: Bound<u64>, end: Bound<u64>) -> Result<(), redb::BackendError> {
|
||||
self.inner.unlock_range(start, end)
|
||||
}
|
||||
fn query_lock_range(&self, start: Bound<u64>, end: Bound<u64>) -> Result<bool, redb::BackendError> {
|
||||
self.inner.query_lock_range(start, end)
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn recovery_scratch(maximum: u64) -> Result<(tempfile::TempDir, redb::Database), StoreError> {
|
||||
let directory = tempfile::tempdir()?;
|
||||
let database = stage_database(directory.path().join("stage.redb"), maximum)?;
|
||||
Ok((directory, database))
|
||||
}
|
||||
|
||||
pub(crate) fn stage_database(path: std::path::PathBuf, maximum: u64) -> Result<redb::Database, StoreError> {
|
||||
let file = File::options().read(true).write(true).create_new(true).open(path)?;
|
||||
let backend = BoundedBackend::new(file, maximum)?;
|
||||
Ok(redb::Database::builder()
|
||||
.set_cache_size(8 * 1024 * 1024)
|
||||
.create_with_backend(backend)?)
|
||||
}
|
||||
|
||||
struct PayloadFile {
|
||||
file: File,
|
||||
maximum: u64,
|
||||
written: u64,
|
||||
}
|
||||
|
||||
impl Write for PayloadFile {
|
||||
fn write(&mut self, bytes: &[u8]) -> io::Result<usize> {
|
||||
let length = u64::try_from(bytes.len()).map_err(io::Error::other)?;
|
||||
let end = self
|
||||
.written
|
||||
.checked_add(length)
|
||||
.ok_or_else(|| io::Error::other("checkpoint payload overflow"))?;
|
||||
if end > self.maximum {
|
||||
return Err(io::Error::new(io::ErrorKind::StorageFull, "checkpoint payload budget"));
|
||||
}
|
||||
let count = self.file.write(bytes)?;
|
||||
self.written = self
|
||||
.written
|
||||
.checked_add(u64::try_from(count).map_err(io::Error::other)?)
|
||||
.ok_or_else(|| io::Error::other("checkpoint payload overflow"))?;
|
||||
Ok(count)
|
||||
}
|
||||
fn flush(&mut self) -> io::Result<()> {
|
||||
self.file.flush()
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) struct StageSink<'a>(pub(crate) &'a redb::WriteTransaction);
|
||||
|
||||
impl snapshot::StagingSink for StageSink<'_> {
|
||||
fn row(&mut self, section: snapshot::Section, key: &[u8], value: &[u8]) -> io::Result<()> {
|
||||
let definition = match section {
|
||||
snapshot::Section::Heads => checkpoint_baseline::HEADS,
|
||||
snapshot::Section::Versions => checkpoint_baseline::VERSIONS,
|
||||
snapshot::Section::Events => checkpoint_baseline::EVENTS,
|
||||
snapshot::Section::Operations => checkpoint_baseline::OPERATIONS,
|
||||
};
|
||||
let mut table = self.0.open_table(definition).map_err(io::Error::other)?;
|
||||
if table.insert(key, value).map_err(io::Error::other)?.is_some() {
|
||||
return Err(io::Error::new(io::ErrorKind::InvalidData, "duplicate checkpoint key"));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
// This type has no external constructors, deserialization, or path-based import.
|
||||
// Its source remains the owned local read transaction, not the decoded artifact.
|
||||
struct LocalStage {
|
||||
source: NativeSnapshotView,
|
||||
database: redb::Database,
|
||||
_directory: tempfile::TempDir,
|
||||
metadata: BaselineMetadata,
|
||||
}
|
||||
|
||||
fn capture_stage(source: NativeSnapshotView, limits: CheckpointLimits) -> Result<LocalStage, CheckpointError> {
|
||||
limits.validate()?;
|
||||
source
|
||||
.header()
|
||||
.applied
|
||||
.ok_or(CheckpointError::Conflict("empty applied cut"))?;
|
||||
let directory = tempfile::tempdir()?;
|
||||
let payload = File::options()
|
||||
.read(true)
|
||||
.write(true)
|
||||
.create_new(true)
|
||||
.open(directory.path().join("capture.csnp"))?;
|
||||
let artifact = source.stream_local_capability(
|
||||
PayloadFile {
|
||||
file: payload,
|
||||
maximum: limits.staging_bytes.min(limits.snapshot.total_bytes),
|
||||
written: 0,
|
||||
},
|
||||
limits.snapshot,
|
||||
)?;
|
||||
let remaining = limits
|
||||
.staging_bytes
|
||||
.checked_sub(artifact.payload.written)
|
||||
.ok_or(CheckpointError::Conflict("staging budget"))?;
|
||||
let mut payload = artifact.payload.file;
|
||||
payload.sync_all()?;
|
||||
payload.rewind()?;
|
||||
let database = stage_database(directory.path().join("stage.redb"), remaining)?;
|
||||
let transaction = database.begin_write().map_err(StoreError::from)?;
|
||||
for definition in [
|
||||
checkpoint_baseline::HEADS,
|
||||
checkpoint_baseline::VERSIONS,
|
||||
checkpoint_baseline::EVENTS,
|
||||
checkpoint_baseline::OPERATIONS,
|
||||
] {
|
||||
transaction.open_table(definition).map_err(StoreError::from)?;
|
||||
}
|
||||
let header = snapshot::decode_capability_artifact(
|
||||
snapshot::CapabilityArtifact {
|
||||
manifest: artifact.manifest,
|
||||
payload,
|
||||
},
|
||||
&mut StageSink(&transaction),
|
||||
limits.snapshot,
|
||||
)?;
|
||||
std::fs::remove_file(directory.path().join("capture.csnp"))?;
|
||||
if header != *source.header() {
|
||||
return Err(CheckpointError::Conflict("capture header"));
|
||||
}
|
||||
let metadata = BaselineMetadata {
|
||||
generation: 1,
|
||||
header,
|
||||
limits,
|
||||
};
|
||||
let encoded = checkpoint_baseline::encode_metadata(&metadata)?;
|
||||
{
|
||||
let mut meta = transaction.open_table(crate::META).map_err(StoreError::from)?;
|
||||
meta.insert("schema", 7u64.to_be_bytes().as_slice())
|
||||
.map_err(StoreError::from)?;
|
||||
meta.insert("checkpoint_baseline", encoded.as_slice())
|
||||
.map_err(StoreError::from)?;
|
||||
}
|
||||
transaction.commit().map_err(StoreError::StagingCommit)?;
|
||||
let stage = LocalStage {
|
||||
source,
|
||||
database,
|
||||
_directory: directory,
|
||||
metadata,
|
||||
};
|
||||
Ok(stage)
|
||||
}
|
||||
|
||||
fn verify_local_stage(stage: &LocalStage) -> Result<(), CheckpointError> {
|
||||
let transaction = stage.database.begin_read().map_err(StoreError::from)?;
|
||||
for (source_definition, stage_definition) in [
|
||||
(crate::application::HEADS, checkpoint_baseline::HEADS),
|
||||
(crate::application::VERSIONS, checkpoint_baseline::VERSIONS),
|
||||
(crate::application::EVENTS, checkpoint_baseline::EVENTS),
|
||||
(crate::application::OPERATIONS, checkpoint_baseline::OPERATIONS),
|
||||
] {
|
||||
let source = stage
|
||||
.source
|
||||
.transaction()
|
||||
.open_table(source_definition)
|
||||
.map_err(StoreError::from)?;
|
||||
let staged = transaction.open_table(stage_definition).map_err(StoreError::from)?;
|
||||
let mut source_rows = source.iter().map_err(StoreError::from)?;
|
||||
let mut staged_rows = staged.iter().map_err(StoreError::from)?;
|
||||
loop {
|
||||
match (source_rows.next(), staged_rows.next()) {
|
||||
(None, None) => break,
|
||||
(Some(source), Some(staged)) => {
|
||||
let (source_key, source_value) = source.map_err(StoreError::from)?;
|
||||
let (stage_key, stage_value) = staged.map_err(StoreError::from)?;
|
||||
if source_key.value() != stage_key.value() || source_value.value() != stage_value.value() {
|
||||
return Err(CheckpointError::Conflict("staging differs from owned local capture"));
|
||||
}
|
||||
}
|
||||
_ => return Err(CheckpointError::Conflict("staging row count")),
|
||||
}
|
||||
}
|
||||
}
|
||||
let staged_meta = transaction.open_table(crate::META).map_err(StoreError::from)?;
|
||||
let staged_metadata =
|
||||
checkpoint_baseline::read_metadata(&staged_meta)?.ok_or(CheckpointError::Conflict("missing staging metadata"))?;
|
||||
if checkpoint_baseline::encode_metadata(&staged_metadata)? != checkpoint_baseline::encode_metadata(&stage.metadata)? {
|
||||
return Err(CheckpointError::Conflict("staging metadata differs from local capture"));
|
||||
}
|
||||
let stage_bytes = std::fs::metadata(stage._directory.path().join("stage.redb"))?.len();
|
||||
let index_budget = stage
|
||||
.metadata
|
||||
.limits
|
||||
.staging_bytes
|
||||
.checked_sub(stage_bytes)
|
||||
.ok_or(CheckpointError::Conflict("staging disk budget"))?;
|
||||
checkpoint_baseline::validate_baseline_with_budget(&transaction, &stage.metadata, index_budget)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn resource_error(error: CheckpointError) -> CheckpointError {
|
||||
use std::error::Error;
|
||||
if matches!(&error, CheckpointError::Store(StoreError::CommitIndeterminate(_))) {
|
||||
return error;
|
||||
}
|
||||
let mut source: Option<&(dyn Error + 'static)> = Some(&error);
|
||||
while let Some(current) = source {
|
||||
if current
|
||||
.downcast_ref::<io::Error>()
|
||||
.is_some_and(|error| error.kind() == io::ErrorKind::StorageFull)
|
||||
{
|
||||
return CheckpointError::Store(StoreError::ResourceLimit);
|
||||
}
|
||||
source = current.source();
|
||||
}
|
||||
error
|
||||
}
|
||||
|
||||
struct CancelOnDrop(Arc<AtomicBool>);
|
||||
impl Drop for CancelOnDrop {
|
||||
fn drop(&mut self) {
|
||||
self.0.store(true, Ordering::Release);
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
type CaptureHook = Box<dyn FnOnce() + Send>;
|
||||
#[cfg(test)]
|
||||
type StageHook = Box<dyn FnOnce(&redb::Database) + Send>;
|
||||
#[cfg(test)]
|
||||
static CAPTURE_HOOKS: std::sync::Mutex<std::collections::BTreeMap<usize, CaptureHook>> =
|
||||
std::sync::Mutex::new(std::collections::BTreeMap::new());
|
||||
#[cfg(test)]
|
||||
static STAGE_HOOKS: std::sync::Mutex<std::collections::BTreeMap<usize, StageHook>> =
|
||||
std::sync::Mutex::new(std::collections::BTreeMap::new());
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) struct CheckpointHook {
|
||||
owner: usize,
|
||||
stage: bool,
|
||||
}
|
||||
#[cfg(test)]
|
||||
impl Drop for CheckpointHook {
|
||||
fn drop(&mut self) {
|
||||
if self.stage {
|
||||
STAGE_HOOKS.lock().expect("stage hooks").remove(&self.owner);
|
||||
} else {
|
||||
CAPTURE_HOOKS.lock().expect("capture hooks").remove(&self.owner);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) fn after_local_capture(writer: &NativeLogWriter, hook: impl FnOnce() + Send + 'static) -> CheckpointHook {
|
||||
let owner = Arc::as_ptr(&writer.store).addr();
|
||||
assert!(
|
||||
CAPTURE_HOOKS
|
||||
.lock()
|
||||
.expect("capture hooks")
|
||||
.insert(owner, Box::new(hook))
|
||||
.is_none()
|
||||
);
|
||||
CheckpointHook { owner, stage: false }
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) fn after_local_stage(writer: &NativeLogWriter, hook: impl FnOnce(&redb::Database) + Send + 'static) -> CheckpointHook {
|
||||
let owner = Arc::as_ptr(&writer.store).addr();
|
||||
assert!(
|
||||
STAGE_HOOKS
|
||||
.lock()
|
||||
.expect("stage hooks")
|
||||
.insert(owner, Box::new(hook))
|
||||
.is_none()
|
||||
);
|
||||
CheckpointHook { owner, stage: true }
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
fn run_capture_hook(owner: &Arc<std::sync::Mutex<crate::Store>>) {
|
||||
let hook = CAPTURE_HOOKS
|
||||
.lock()
|
||||
.expect("capture hooks")
|
||||
.remove(&Arc::as_ptr(owner).addr());
|
||||
if let Some(hook) = hook {
|
||||
hook();
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
fn run_stage_hook(owner: &Arc<std::sync::Mutex<crate::Store>>, database: &redb::Database) {
|
||||
let hook = STAGE_HOOKS.lock().expect("stage hooks").remove(&Arc::as_ptr(owner).addr());
|
||||
if let Some(hook) = hook {
|
||||
hook(database);
|
||||
}
|
||||
}
|
||||
|
||||
impl NativeLogWriter {
|
||||
pub async fn checkpoint_local(&self, limits: CheckpointLimits) -> Result<CheckpointReceipt, CheckpointError> {
|
||||
self.checkpoint_local_inner(limits).await.map_err(resource_error)
|
||||
}
|
||||
|
||||
async fn checkpoint_local_inner(&self, limits: CheckpointLimits) -> Result<CheckpointReceipt, CheckpointError> {
|
||||
limits.validate()?;
|
||||
let admission = self.checkpoint_admission.clone().lock_owned().await;
|
||||
let owner = self.store.clone();
|
||||
let stage = tokio::task::spawn_blocking(move || {
|
||||
let source = NativeSnapshotView::acquire(owner.clone())?;
|
||||
#[cfg(test)]
|
||||
run_capture_hook(&owner);
|
||||
let stage = capture_stage(source, limits)?;
|
||||
#[cfg(test)]
|
||||
run_stage_hook(&owner, &stage.database);
|
||||
verify_local_stage(&stage)?;
|
||||
Ok::<_, CheckpointError>((stage, admission))
|
||||
})
|
||||
.await
|
||||
.map_err(CheckpointError::Worker)??;
|
||||
let ordering = self.ordering.clone().lock_owned().await;
|
||||
let owner = self.store.clone();
|
||||
let cancellation = CancelOnDrop(Arc::new(AtomicBool::new(false)));
|
||||
let cancelled = cancellation.0.clone();
|
||||
tokio::task::spawn_blocking(move || {
|
||||
// The blocking owner retains both guards until publication finishes,
|
||||
// even if the async caller is dropped while redb is committing.
|
||||
let _ordering = ordering;
|
||||
let (stage, _admission) = stage;
|
||||
if cancelled.load(Ordering::Acquire) {
|
||||
return Err(CheckpointError::Cancelled);
|
||||
}
|
||||
if !Arc::ptr_eq(&owner, stage.source.owner()) {
|
||||
return Err(CheckpointError::Conflict("local capture owner"));
|
||||
}
|
||||
let mut store = owner.lock().map_err(|_| CheckpointError::Poisoned)?;
|
||||
let transaction = store.write_transaction()?;
|
||||
let mut meta = transaction.open_table(crate::META).map_err(StoreError::from)?;
|
||||
let schema = crate::number(
|
||||
meta.get("schema")
|
||||
.map_err(StoreError::from)?
|
||||
.ok_or(StoreError::CorruptRecord)?
|
||||
.value(),
|
||||
)?;
|
||||
if !matches!(schema, 6 | 7) {
|
||||
return Err(StoreError::UnsupportedSchema.into());
|
||||
}
|
||||
let previous = checkpoint_baseline::read_metadata(&meta)?;
|
||||
if crate::application::read_binding(&meta)? != stage.metadata.header.binding {
|
||||
return Err(CheckpointError::Conflict("live capture binding changed"));
|
||||
}
|
||||
let identity = crate::decode_identity(
|
||||
meta.get("identity")
|
||||
.map_err(StoreError::from)?
|
||||
.ok_or(StoreError::CorruptRecord)?
|
||||
.value(),
|
||||
)?;
|
||||
if identity.cluster_id != stage.metadata.header.cluster_id {
|
||||
return Err(CheckpointError::Conflict("live capture cluster changed"));
|
||||
}
|
||||
let cut = stage
|
||||
.metadata
|
||||
.header
|
||||
.applied
|
||||
.ok_or(CheckpointError::Conflict("empty applied cut"))?;
|
||||
let applied = crate::application::read_applied(&meta)?.ok_or(StoreError::CorruptRecord)?;
|
||||
let logs = transaction.open_table(crate::LOGS).map_err(StoreError::from)?;
|
||||
let committed = crate::committed::validate_committed(&meta, &logs)?.ok_or(StoreError::CorruptRecord)?;
|
||||
if cut.index > applied.index
|
||||
|| (cut.index == applied.index && cut != applied)
|
||||
|| applied.index > committed.index
|
||||
|| (applied.index == committed.index && applied != committed)
|
||||
{
|
||||
return Err(CheckpointError::Conflict("live applied and committed bounds"));
|
||||
}
|
||||
drop(logs);
|
||||
if let Some(old) = previous.as_ref().and_then(|previous| previous.header.applied)
|
||||
&& (old.index > cut.index || (old.index == cut.index && old != cut))
|
||||
{
|
||||
return Err(CheckpointError::Conflict("published checkpoint cut"));
|
||||
}
|
||||
let mut metadata = stage.metadata;
|
||||
metadata.generation = previous.map_or(Ok(1), |old| {
|
||||
old.generation
|
||||
.checked_add(1)
|
||||
.ok_or(CheckpointError::Conflict("checkpoint generation exhausted"))
|
||||
})?;
|
||||
let stage_transaction = stage.database.begin_read().map_err(StoreError::from)?;
|
||||
for (source_definition, definition) in [
|
||||
(crate::application::HEADS, checkpoint_baseline::HEADS),
|
||||
(crate::application::VERSIONS, checkpoint_baseline::VERSIONS),
|
||||
(crate::application::EVENTS, checkpoint_baseline::EVENTS),
|
||||
(crate::application::OPERATIONS, checkpoint_baseline::OPERATIONS),
|
||||
] {
|
||||
let captured = stage
|
||||
.source
|
||||
.transaction()
|
||||
.open_table(source_definition)
|
||||
.map_err(StoreError::from)?;
|
||||
let staged = stage_transaction.open_table(definition).map_err(StoreError::from)?;
|
||||
let mut source_rows = captured.iter().map_err(StoreError::from)?;
|
||||
let mut stage_rows = staged.iter().map_err(StoreError::from)?;
|
||||
let mut target = transaction.open_table(definition).map_err(StoreError::from)?;
|
||||
target.retain(|_, _| false).map_err(StoreError::from)?;
|
||||
// Recheck disk bytes while copying; the earlier relationship
|
||||
// validation remains outside the writer ordering interval.
|
||||
loop {
|
||||
match (source_rows.next(), stage_rows.next()) {
|
||||
(None, None) => break,
|
||||
(Some(source), Some(staged)) => {
|
||||
let (source_key, source_value) = source.map_err(StoreError::from)?;
|
||||
let (key, value) = staged.map_err(StoreError::from)?;
|
||||
if source_key.value() != key.value() || source_value.value() != value.value() {
|
||||
return Err(CheckpointError::Conflict("publication differs from local capture"));
|
||||
}
|
||||
target.insert(key.value(), value.value()).map_err(StoreError::from)?;
|
||||
}
|
||||
_ => return Err(CheckpointError::Conflict("publication row count")),
|
||||
}
|
||||
}
|
||||
}
|
||||
let encoded = checkpoint_baseline::encode_metadata(&metadata)?;
|
||||
meta.insert("checkpoint_baseline", encoded.as_slice())
|
||||
.map_err(StoreError::from)?;
|
||||
meta.insert("schema", 7u64.to_be_bytes().as_slice())
|
||||
.map_err(StoreError::from)?;
|
||||
crate::raft_state_machine::publish_local_meta(&mut meta, &metadata)?;
|
||||
drop(meta);
|
||||
if cancelled.load(Ordering::Acquire) {
|
||||
return Err(CheckpointError::Cancelled);
|
||||
}
|
||||
store.commit(transaction)?;
|
||||
Ok(CheckpointReceipt {
|
||||
generation: metadata.generation,
|
||||
cut,
|
||||
})
|
||||
})
|
||||
.await
|
||||
.map_err(CheckpointError::Worker)?
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,607 @@
|
||||
use super::*;
|
||||
use std::collections::{BTreeMap, BTreeSet};
|
||||
|
||||
fn identity() -> NodeIdentity {
|
||||
NodeIdentity {
|
||||
cluster_id: [7; 16],
|
||||
node_id: 0,
|
||||
}
|
||||
}
|
||||
|
||||
fn binding() -> CaptureBinding {
|
||||
CaptureBinding {
|
||||
revision: 9,
|
||||
binding_id: [8; 16],
|
||||
target_id: [9; 16],
|
||||
}
|
||||
}
|
||||
|
||||
fn id(index: u64) -> LogId {
|
||||
LogId {
|
||||
term: 8,
|
||||
leader_node: 0,
|
||||
index,
|
||||
}
|
||||
}
|
||||
|
||||
fn command(operation: u8) -> DecideCreated {
|
||||
DecideCreated {
|
||||
operation_id: [operation; 16],
|
||||
object: ObjectIdentity {
|
||||
bucket_incarnation: [2; 16],
|
||||
key: b"checkpoint-object".to_vec(),
|
||||
},
|
||||
expected_head: None,
|
||||
prepared: PreparedIdentity {
|
||||
version_id: [3; 16],
|
||||
preparation_id: [4; 16],
|
||||
content_digest: [5; 32],
|
||||
content_length: 4097,
|
||||
},
|
||||
binding_revision: 9,
|
||||
}
|
||||
}
|
||||
|
||||
fn apply(store: &mut Store, index: u64, command: DecideCreated) -> CaptureResponse {
|
||||
let entry = CaptureRaftEntry {
|
||||
log_id: id(index).into(),
|
||||
payload: openraft::EntryPayload::Normal(CaptureCommand::try_created(command).expect("canonical command")),
|
||||
};
|
||||
store.append_native(&[entry]).expect("actual durable append");
|
||||
store.save_committed(id(index)).expect("actual durable commit");
|
||||
store.apply_next_native(id(index)).expect("actual native apply")
|
||||
}
|
||||
|
||||
fn fixture() -> (tempfile::TempDir, Store, DecideCreated, CreatedOperationProvenance) {
|
||||
let dir = tempfile::tempdir().expect("actual native database directory");
|
||||
let mut store = Store::initialize(dir.path().join("db"), identity()).expect("initialize actual redb");
|
||||
store.pin_capture_binding(binding()).expect("bind actual store");
|
||||
store.enable_native_empty().expect("native schema4");
|
||||
store.promote_created_provenance().expect("native schema6 provenance");
|
||||
let membership = CaptureMembership::new(
|
||||
Some(id(0)),
|
||||
vec![BTreeSet::from([0])],
|
||||
BTreeMap::from([(0, CaptureNode::new("http://127.0.0.1:7000".into()).expect("native member"))]),
|
||||
)
|
||||
.expect("full native membership");
|
||||
let stored = openraft::StoredMembership::try_from(&membership).expect("OpenRaft membership");
|
||||
store
|
||||
.append_native(&[CaptureRaftEntry {
|
||||
log_id: id(0).into(),
|
||||
payload: openraft::EntryPayload::Membership(stored.membership().clone()),
|
||||
}])
|
||||
.expect("append actual membership");
|
||||
store.save_committed(id(0)).expect("commit membership");
|
||||
store.apply_next_native(id(0)).expect("apply membership");
|
||||
let negative = command(11);
|
||||
let mut original = negative.clone();
|
||||
original.expected_head = Some([12; 16]);
|
||||
apply(&mut store, 1, original.clone());
|
||||
let first = store
|
||||
.created_operation_provenance(original.operation_id)
|
||||
.expect("read first negative")
|
||||
.expect("canonical negative operation");
|
||||
assert_eq!(first.first_decision_log_id, id(1), "CHECKPOINT_FIRST_NEGATIVE_BOUND");
|
||||
assert!(
|
||||
matches!(first.operation.result, CreatedResult::HeadMismatch { .. }),
|
||||
"CHECKPOINT_FIRST_NEGATIVE_BOUND"
|
||||
);
|
||||
apply(&mut store, 2, command(1));
|
||||
(dir, store, original, first)
|
||||
}
|
||||
|
||||
fn runtime() -> tokio::runtime::Runtime {
|
||||
tokio::runtime::Builder::new_current_thread()
|
||||
.enable_all()
|
||||
.build()
|
||||
.expect("checkpoint runtime")
|
||||
}
|
||||
|
||||
fn schema(store: &Store) -> u64 {
|
||||
let tx = store.database.begin_read().expect("read actual schema");
|
||||
let table = tx.open_table(META).expect("schema table");
|
||||
number(table.get("schema").expect("schema read").expect("schema exists").value()).expect("schema number")
|
||||
}
|
||||
|
||||
fn assert_negative(store: &Store, original: &DecideCreated, first: &CreatedOperationProvenance) {
|
||||
assert_eq!(
|
||||
store
|
||||
.created_operation_provenance(original.operation_id)
|
||||
.expect("canonical read"),
|
||||
Some(first.clone()),
|
||||
"CHECKPOINT_FIRST_NEGATIVE_BOUND: preserve original bytes/result/full first ID"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn native_checkpoint_negative_retry_and_purge_reopen() {
|
||||
let (dir, store, original, first) = fixture();
|
||||
assert_eq!(schema(&store), 6);
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let receipt = runtime()
|
||||
.block_on(writer.checkpoint_local(CheckpointLimits::default()))
|
||||
.expect("publish local checkpoint");
|
||||
assert_eq!(receipt.cut(), id(2), "CHECKPOINT_BASELINE_BOUND");
|
||||
assert_eq!(receipt.generation(), 1);
|
||||
{
|
||||
let mut store = writer.store.lock().expect("actual writer store");
|
||||
assert_eq!(schema(&store), 7);
|
||||
assert_negative(&store, &original, &first);
|
||||
apply(&mut store, 3, original.clone());
|
||||
assert_negative(&store, &original, &first);
|
||||
let mut conflict = original.clone();
|
||||
conflict.binding_revision += 1;
|
||||
apply(&mut store, 4, conflict);
|
||||
assert_eq!(
|
||||
store
|
||||
.created_apply_result(4)
|
||||
.expect("conflicting response")
|
||||
.expect("response")
|
||||
.result,
|
||||
CreatedResult::OperationConflict,
|
||||
"CHECKPOINT_RETRY_BOUND"
|
||||
);
|
||||
assert_negative(&store, &original, &first);
|
||||
}
|
||||
runtime()
|
||||
.block_on(writer.purge_checkpoint(&receipt))
|
||||
.expect("purge exact durable baseline");
|
||||
drop(writer);
|
||||
let reopened = Store::open(dir.path().join("db"), identity()).expect("reopen purged baseline plus suffix");
|
||||
assert_negative(&reopened, &original, &first);
|
||||
assert_eq!(reopened.last_applied().expect("suffix applied"), Some(id(4)), "CHECKPOINT_SUFFIX_BOUND");
|
||||
assert!(reopened.read_entry(2).expect("purged cut").is_none());
|
||||
assert!(reopened.read_entry(3).expect("retained suffix").is_some());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn native_checkpoint_capture_keeps_concurrent_suffix() {
|
||||
let (dir, store, original, first) = fixture();
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let (entered_tx, entered_rx) = std::sync::mpsc::channel();
|
||||
let (release_tx, release_rx) = std::sync::mpsc::channel();
|
||||
let _hook = native_checkpoint::after_local_capture(&writer, move || {
|
||||
entered_tx.send(()).expect("capture reached");
|
||||
release_rx
|
||||
.recv_timeout(std::time::Duration::from_secs(30))
|
||||
.expect("release owned capture");
|
||||
});
|
||||
let worker = writer.clone();
|
||||
let thread = std::thread::spawn(move || runtime().block_on(worker.checkpoint_local(CheckpointLimits::default())));
|
||||
entered_rx
|
||||
.recv_timeout(std::time::Duration::from_secs(30))
|
||||
.expect("actual capture boundary");
|
||||
{
|
||||
let mut store = writer.store.lock().expect("capture releases live write owner");
|
||||
apply(&mut store, 3, original.clone());
|
||||
}
|
||||
release_tx.send(()).expect("release capture");
|
||||
let receipt = thread.join().expect("checkpoint worker").expect("concurrent checkpoint");
|
||||
assert_eq!(receipt.cut(), id(2), "CHECKPOINT_SAME_CUT_BOUND");
|
||||
runtime()
|
||||
.block_on(writer.purge_checkpoint(&receipt))
|
||||
.expect("purge captured prefix");
|
||||
drop(writer);
|
||||
let reopened = Store::open(dir.path().join("db"), identity()).expect("reopen concurrent suffix");
|
||||
assert_eq!(reopened.last_applied().expect("actual suffix"), Some(id(3)), "CHECKPOINT_SUFFIX_BOUND");
|
||||
assert_negative(&reopened, &original, &first);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn native_checkpoint_staging_corruption_preserves_live_generation() {
|
||||
let (dir, store, original, first) = fixture();
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let before = runtime()
|
||||
.block_on(writer.checkpoint_local(CheckpointLimits::default()))
|
||||
.expect("initial baseline");
|
||||
let _hook = native_checkpoint::after_local_stage(&writer, |database| {
|
||||
let tx = database.begin_write().expect("actual isolated stage mutation");
|
||||
tx.open_table(checkpoint_baseline::OPERATIONS)
|
||||
.expect("stage operations")
|
||||
.retain(|_, _| false)
|
||||
.expect("damage cross-record relationships");
|
||||
tx.commit().expect("persist actual damaged stage");
|
||||
});
|
||||
assert!(
|
||||
runtime()
|
||||
.block_on(writer.checkpoint_local(CheckpointLimits::default()))
|
||||
.is_err(),
|
||||
"CHECKPOINT_FAILURE_ATOMIC"
|
||||
);
|
||||
let store = writer.store.lock().expect("unchanged live store");
|
||||
let tx = store.database.begin_read().expect("published generation");
|
||||
let meta = tx.open_table(META).expect("published meta");
|
||||
assert_eq!(
|
||||
checkpoint_baseline::read_metadata(&meta)
|
||||
.expect("valid old metadata")
|
||||
.expect("old baseline")
|
||||
.generation,
|
||||
before.generation(),
|
||||
"CHECKPOINT_FAILURE_ATOMIC"
|
||||
);
|
||||
assert_negative(&store, &original, &first);
|
||||
drop(meta);
|
||||
drop(tx);
|
||||
drop(store);
|
||||
drop(writer);
|
||||
let reopened = Store::open(dir.path().join("db"), identity()).expect("reopen after failed staging validation");
|
||||
assert_negative(&reopened, &original, &first);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn native_checkpoint_budget_failure_preserves_schema_and_history() {
|
||||
for staging in [false, true] {
|
||||
let (dir, mut store, original, first) = fixture();
|
||||
if staging {
|
||||
for index in 0u64..256 {
|
||||
let mut large = command(31);
|
||||
large.operation_id[..8].copy_from_slice(&index.to_be_bytes());
|
||||
large.prepared.version_id[..8].copy_from_slice(&index.to_be_bytes());
|
||||
large.object.key = vec![b'x'; MAX_OBJECT_KEY_LENGTH];
|
||||
large.object.key[..8].copy_from_slice(&index.to_be_bytes());
|
||||
apply(&mut store, index + 3, large);
|
||||
}
|
||||
}
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let mut limits = CheckpointLimits::default();
|
||||
if staging {
|
||||
limits.staging_bytes = 4 * 1024 * 1024;
|
||||
} else {
|
||||
limits.snapshot.total_bytes = 64;
|
||||
}
|
||||
let result = runtime().block_on(writer.checkpoint_local(limits));
|
||||
if staging {
|
||||
assert!(
|
||||
matches!(&result, Err(CheckpointError::Store(StoreError::ResourceLimit))),
|
||||
"CHECKPOINT_RESOURCE_BOUND: actual 4MiB physical staging limit: {result:?}"
|
||||
);
|
||||
} else {
|
||||
assert!(
|
||||
result.is_err(),
|
||||
"CHECKPOINT_RESOURCE_BOUND: actual bounded output must refuse: {result:?}"
|
||||
);
|
||||
}
|
||||
{
|
||||
let store = writer.store.lock().expect("live after exhausted budget");
|
||||
assert_eq!(schema(&store), 6, "CHECKPOINT_FAILURE_ATOMIC");
|
||||
assert_negative(&store, &original, &first);
|
||||
assert!(store.read_entry(0).expect("prefix intact").is_some());
|
||||
}
|
||||
drop(writer);
|
||||
assert_negative(
|
||||
&Store::open(dir.path().join("db"), identity()).expect("reopen budget failure"),
|
||||
&original,
|
||||
&first,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn native_checkpoint_cancelled_capture_cannot_publish_or_purge() {
|
||||
let (dir, store, original, first) = fixture();
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let (entered_tx, entered_rx) = std::sync::mpsc::channel();
|
||||
let (release_tx, release_rx) = std::sync::mpsc::channel();
|
||||
let _hook = native_checkpoint::after_local_capture(&writer, move || {
|
||||
entered_tx.send(()).expect("capture cancellation boundary");
|
||||
release_rx
|
||||
.recv_timeout(std::time::Duration::from_secs(30))
|
||||
.expect("release pending actual capture");
|
||||
});
|
||||
let rt = runtime();
|
||||
let worker = writer.clone();
|
||||
rt.block_on(async {
|
||||
let task = tokio::spawn(async move { worker.checkpoint_local(CheckpointLimits::default()).await });
|
||||
tokio::task::spawn_blocking(move || entered_rx.recv_timeout(std::time::Duration::from_secs(30)))
|
||||
.await
|
||||
.expect("capture observer")
|
||||
.expect("actual capture owned transaction");
|
||||
task.abort();
|
||||
assert!(task.await.expect_err("cancelled waiter").is_cancelled(), "CHECKPOINT_CANCEL_BOUND");
|
||||
release_tx.send(()).expect("release actual worker after waiter cancellation");
|
||||
// A fresh checkpoint waits for the same production admission; completion
|
||||
// establishes that the cancelled capture worker released its real resources.
|
||||
let receipt = writer
|
||||
.checkpoint_local(CheckpointLimits::default())
|
||||
.await
|
||||
.expect("capture after cancellation");
|
||||
assert_eq!(receipt.generation(), 1, "CHECKPOINT_CANCEL_BOUND: abandoned capture never published");
|
||||
});
|
||||
drop(rt);
|
||||
drop(writer);
|
||||
let reopened = Store::open(dir.path().join("db"), identity()).expect("reopen after cancellation and successful next capture");
|
||||
assert_negative(&reopened, &original, &first);
|
||||
assert!(
|
||||
reopened.read_entry(0).expect("cancellation cannot purge").is_some(),
|
||||
"CHECKPOINT_CANCEL_BOUND"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn native_checkpoint_stale_receipt_cannot_remove_history() {
|
||||
let (_dir, store, original, first) = fixture();
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let rt = runtime();
|
||||
let old = rt
|
||||
.block_on(writer.checkpoint_local(CheckpointLimits::default()))
|
||||
.expect("first generation");
|
||||
let new = rt
|
||||
.block_on(writer.checkpoint_local(CheckpointLimits::default()))
|
||||
.expect("next generation");
|
||||
assert!(new.generation() > old.generation());
|
||||
assert!(
|
||||
matches!(
|
||||
rt.block_on(writer.purge_checkpoint(&old)),
|
||||
Err(NativeWriteError::Store(StoreError::StaleCheckpoint))
|
||||
),
|
||||
"CHECKPOINT_PURGE_BOUND"
|
||||
);
|
||||
let store = writer.store.lock().expect("history after stale purge");
|
||||
assert_negative(&store, &original, &first);
|
||||
assert!(store.read_entry(1).expect("first decision retained").is_some());
|
||||
assert!(store.created_apply_result(1).expect("typed result retained").is_some());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn native_checkpoint_reopen_rejects_conflicting_cut_and_suffix_gap() {
|
||||
for corruption in 0..4 {
|
||||
let gap = corruption == 1;
|
||||
let (dir, store, original, _) = fixture();
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let rt = runtime();
|
||||
let receipt = rt
|
||||
.block_on(writer.checkpoint_local(CheckpointLimits::default()))
|
||||
.expect("valid checkpoint");
|
||||
if gap {
|
||||
{
|
||||
let mut store = writer.store.lock().expect("suffix owner");
|
||||
apply(&mut store, 3, original.clone());
|
||||
apply(&mut store, 4, original.clone());
|
||||
}
|
||||
rt.block_on(writer.purge_checkpoint(&receipt))
|
||||
.expect("purge before gap corruption");
|
||||
{
|
||||
let store = writer.store.lock().expect("actual purged metadata owner");
|
||||
let tx = store.database.begin_write().expect("actual CPUR mutation");
|
||||
let mut meta = tx.open_table(META).expect("actual CPUR table");
|
||||
let mut conflict = receipt.cut();
|
||||
conflict.term += 1;
|
||||
conflict.leader_node += 1;
|
||||
let encoded = checkpoint_baseline::encode_purged(conflict);
|
||||
meta.insert(checkpoint_baseline::PURGED_KEY, encoded.as_slice())
|
||||
.expect("persist conflicting full purge ID");
|
||||
drop(meta);
|
||||
tx.commit().expect("durable conflicting CPUR");
|
||||
let tx = store.database.begin_read().expect("actual conflicting CPUR read");
|
||||
let meta = tx.open_table(META).expect("actual persisted CPUR");
|
||||
assert!(
|
||||
matches!(checkpoint_baseline::read_purged(&meta), Err(StoreError::CorruptRecord)),
|
||||
"CHECKPOINT_FULL_CUT_BOUND: same index with different term/leader is corruption"
|
||||
);
|
||||
drop(meta);
|
||||
drop(tx);
|
||||
let tx = store
|
||||
.database
|
||||
.begin_write()
|
||||
.expect("restore valid purge boundary for gap scenario");
|
||||
let encoded = checkpoint_baseline::encode_purged(receipt.cut());
|
||||
tx.open_table(META)
|
||||
.expect("actual purge meta")
|
||||
.insert(checkpoint_baseline::PURGED_KEY, encoded.as_slice())
|
||||
.expect("restore exact cut");
|
||||
tx.commit().expect("persist exact purge boundary");
|
||||
}
|
||||
}
|
||||
if corruption >= 2 {
|
||||
let mut store = writer.store.lock().expect("actual suffix before tail corruption");
|
||||
apply(&mut store, 3, original.clone());
|
||||
}
|
||||
{
|
||||
let store = writer.store.lock().expect("actual corruption owner");
|
||||
let tx = store.database.begin_write().expect("actual redb mutation");
|
||||
let mut logs = tx.open_table(LOGS).expect("actual log table");
|
||||
if gap {
|
||||
logs.remove(3).expect("remove required suffix entry");
|
||||
} else if corruption >= 2 {
|
||||
let mut tail = id(3);
|
||||
if corruption == 2 {
|
||||
tail.index += 1;
|
||||
} else {
|
||||
tail.term += 1;
|
||||
tail.leader_node += 1;
|
||||
}
|
||||
let encoded = encode_id(tail);
|
||||
tx.open_table(META)
|
||||
.expect("actual metadata")
|
||||
.insert("tail", encoded.as_slice())
|
||||
.expect("corrupt durable tail");
|
||||
} else {
|
||||
let mut entry = store.read_entry(2).expect("retained cut").expect("cut entry");
|
||||
entry.id.term += 1;
|
||||
entry.id.leader_node += 1;
|
||||
let encoded = encode_log(&entry).expect("valid conflicting full ID encoding");
|
||||
logs.insert(2, encoded.as_slice()).expect("replace exact cut identity");
|
||||
}
|
||||
drop(logs);
|
||||
tx.commit().expect("persist actual inconsistent recovery input");
|
||||
}
|
||||
assert!(
|
||||
rt.block_on(writer.purge_checkpoint(&receipt)).is_err(),
|
||||
"CHECKPOINT_PURGE_BOUND: invalid recovery cannot authorize cleanup"
|
||||
);
|
||||
if !gap {
|
||||
let store = writer.store.lock().expect("refused purge retains original evidence");
|
||||
assert!(store.read_entry(1).expect("original log retained").is_some(), "CHECKPOINT_PURGE_BOUND");
|
||||
assert!(
|
||||
store.created_apply_result(1).expect("original response retained").is_some(),
|
||||
"CHECKPOINT_PURGE_BOUND"
|
||||
);
|
||||
}
|
||||
drop(writer);
|
||||
drop(rt);
|
||||
assert!(Store::open(dir.path().join("db"), identity()).is_err(), "CHECKPOINT_RECOVERY_BOUND");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn native_checkpoint_publication_fault_selects_complete_generation() {
|
||||
for (sync, after) in [(1, false), (1, true), (2, false), (2, true)] {
|
||||
let (dir, store, original, first) = fixture();
|
||||
let vote = VoteRecord {
|
||||
term: 9,
|
||||
voted_node: 0,
|
||||
committed: true,
|
||||
};
|
||||
let mut store = store;
|
||||
store.save_vote(vote).expect("local hard state before checkpoint");
|
||||
drop(store);
|
||||
let path = dir.path().join("db");
|
||||
let backend = tests::CrashBackend::new(&path);
|
||||
let store = Store::from_database(backend.database(), identity()).expect("existing simulated durability backend");
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let (entered, release) = backend.pause_sync(sync, after);
|
||||
let worker = writer.clone();
|
||||
let task = std::thread::spawn(move || runtime().block_on(worker.checkpoint_local(CheckpointLimits::default())));
|
||||
entered.wait();
|
||||
backend.cut();
|
||||
release.wait();
|
||||
let _unknown = task.join().expect("interrupted publication worker");
|
||||
drop(writer);
|
||||
let reopened = Store::open(&path, identity()).expect("recover complete generation after simulated sync cut");
|
||||
assert!(matches!(schema(&reopened), 6 | 7), "CHECKPOINT_CRASH_ATOMIC");
|
||||
assert_negative(&reopened, &original, &first);
|
||||
assert_eq!(
|
||||
reopened.read_vote().expect("preserved local vote"),
|
||||
Some(vote),
|
||||
"CHECKPOINT_LOCAL_STATE_BOUND"
|
||||
);
|
||||
assert_eq!(reopened.last_applied().expect("complete applied position"), Some(id(2)));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn native_checkpoint_recovery_budget_can_be_raised_without_changing_baseline() {
|
||||
use redb::ReadableTableMetadata;
|
||||
let (dir, store, original, first) = fixture();
|
||||
let mut limits = CheckpointLimits::default();
|
||||
let tx = store.database.begin_read().expect("measure real baseline rows");
|
||||
limits.snapshot.records = [
|
||||
application::HEADS,
|
||||
application::VERSIONS,
|
||||
application::EVENTS,
|
||||
application::OPERATIONS,
|
||||
]
|
||||
.into_iter()
|
||||
.map(|definition| {
|
||||
tx.open_table(definition)
|
||||
.expect("actual baseline table")
|
||||
.len()
|
||||
.expect("actual row count")
|
||||
})
|
||||
.sum();
|
||||
drop(tx);
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let receipt = runtime()
|
||||
.block_on(writer.checkpoint_local(limits))
|
||||
.expect("capture exact bounded baseline");
|
||||
{
|
||||
let mut store = writer.store.lock().expect("actual suffix writer");
|
||||
let mut suffix = command(21);
|
||||
suffix.object.key = b"suffix-new-key".to_vec();
|
||||
suffix.prepared.version_id = [22; 16];
|
||||
apply(&mut store, 3, suffix);
|
||||
}
|
||||
drop(writer);
|
||||
let path = dir.path().join("db");
|
||||
assert!(
|
||||
matches!(Store::open(&path, identity()), Err(StoreError::ResourceLimit)),
|
||||
"CHECKPOINT_RESOURCE_BOUND"
|
||||
);
|
||||
let mut raised = limits;
|
||||
raised.snapshot.records += 32;
|
||||
let reopened =
|
||||
Store::open_with_checkpoint_limits(&path, identity(), raised).expect("explicitly raise bounded recovery budget");
|
||||
assert_negative(&reopened, &original, &first);
|
||||
assert_eq!(reopened.last_applied().expect("retained suffix position"), Some(id(3)));
|
||||
let tx = reopened.database.begin_read().expect("unchanged baseline metadata");
|
||||
let meta = tx.open_table(META).expect("actual metadata");
|
||||
let baseline = checkpoint_baseline::read_metadata(&meta)
|
||||
.expect("baseline decode")
|
||||
.expect("baseline selected");
|
||||
assert_eq!(baseline.generation, receipt.generation());
|
||||
assert_eq!(
|
||||
baseline.limits.snapshot.records, limits.snapshot.records,
|
||||
"CHECKPOINT_RESOURCE_BOUND: override never rewrites evidence"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn native_checkpoint_interrupted_purge_reopens_and_retries_idempotently() {
|
||||
for (sync, after) in [(1, false), (1, true), (2, false), (2, true)] {
|
||||
let (dir, store, original, first) = fixture();
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let receipt = runtime()
|
||||
.block_on(writer.checkpoint_local(CheckpointLimits::default()))
|
||||
.expect("durable baseline before purge");
|
||||
drop(writer);
|
||||
let path = dir.path().join("db");
|
||||
let backend = tests::CrashBackend::new(&path);
|
||||
let store = Store::from_database(backend.database(), identity()).expect("simulated purge durability backend");
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let (entered, release) = backend.pause_sync(sync, after);
|
||||
let worker = writer.clone();
|
||||
let task = std::thread::spawn(move || runtime().block_on(worker.purge_checkpoint(&receipt)));
|
||||
entered.wait();
|
||||
backend.cut();
|
||||
release.wait();
|
||||
let _unknown = task.join().expect("interrupted purge worker");
|
||||
drop(writer);
|
||||
let reopened = Store::open(&path, identity()).expect("baseline survives simulated interrupted purge");
|
||||
assert_negative(&reopened, &original, &first);
|
||||
let retained = (0..=2)
|
||||
.map(|index| reopened.read_entry(index).expect("atomic purge log state").is_some())
|
||||
.collect::<Vec<_>>();
|
||||
assert!(
|
||||
retained.iter().all(|present| *present) || retained.iter().all(|present| !*present),
|
||||
"CHECKPOINT_PURGE_ATOMIC: complete old prefix or complete new purge"
|
||||
);
|
||||
let writer = NativeLogWriter::new(reopened);
|
||||
let rt = runtime();
|
||||
rt.block_on(writer.purge_checkpoint(&receipt)).expect("resume exact purge");
|
||||
rt.block_on(writer.purge_checkpoint(&receipt))
|
||||
.expect("repeat exact purge idempotently");
|
||||
drop(writer);
|
||||
let reopened = Store::open(&path, identity()).expect("reopen resumed purge");
|
||||
assert_negative(&reopened, &original, &first);
|
||||
assert!(reopened.read_entry(2).expect("purged cut absent").is_none(), "CHECKPOINT_PURGE_ATOMIC");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn native_checkpoint_ack_and_purge_ack_survive_simulated_power_cut() {
|
||||
let (dir, store, original, first) = fixture();
|
||||
drop(store);
|
||||
let path = dir.path().join("db");
|
||||
let backend = tests::CrashBackend::new(&path);
|
||||
let writer =
|
||||
NativeLogWriter::new(Store::from_database(backend.database(), identity()).expect("actual checkpoint fault backend"));
|
||||
let receipt = runtime()
|
||||
.block_on(writer.checkpoint_local(CheckpointLimits::default()))
|
||||
.expect("successful checkpoint ACK");
|
||||
backend.cut();
|
||||
drop(writer);
|
||||
let reopened = Store::open(&path, identity()).expect("ACK checkpoint survives simulated power cut");
|
||||
assert_eq!(schema(&reopened), 7, "CHECKPOINT_ACK_DURABLE");
|
||||
assert_negative(&reopened, &original, &first);
|
||||
let backend = tests::CrashBackend::new(&path);
|
||||
drop(reopened);
|
||||
let writer = NativeLogWriter::new(Store::from_database(backend.database(), identity()).expect("actual purge fault backend"));
|
||||
runtime()
|
||||
.block_on(writer.purge_checkpoint(&receipt))
|
||||
.expect("successful purge ACK");
|
||||
backend.cut();
|
||||
drop(writer);
|
||||
let reopened = Store::open(&path, identity()).expect("ACK purge survives simulated power cut");
|
||||
assert_negative(&reopened, &original, &first);
|
||||
assert!(reopened.read_entry(2).expect("ACK purge cut absent").is_none(), "CHECKPOINT_ACK_DURABLE");
|
||||
}
|
||||
@@ -0,0 +1,182 @@
|
||||
//! Owned consistent native application snapshot view.
|
||||
use crate::{Store, StoreError, application, snapshot};
|
||||
use redb::{ReadTransaction, ReadableDatabase, ReadableTable, ReadableTableMetadata};
|
||||
use std::{
|
||||
io::Write,
|
||||
sync::{Arc, Mutex},
|
||||
};
|
||||
|
||||
#[cfg(test)]
|
||||
std::thread_local! {
|
||||
static AFTER_CAPTURE: std::cell::RefCell<Option<Box<dyn FnOnce()>>> = const { std::cell::RefCell::new(None) };
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) struct CaptureHook;
|
||||
#[cfg(test)]
|
||||
impl Drop for CaptureHook {
|
||||
fn drop(&mut self) {
|
||||
AFTER_CAPTURE.with(|hook| {
|
||||
hook.borrow_mut().take();
|
||||
});
|
||||
}
|
||||
}
|
||||
#[cfg(test)]
|
||||
pub(crate) fn after_capture(hook: impl FnOnce() + 'static) -> CaptureHook {
|
||||
AFTER_CAPTURE.with(|slot| {
|
||||
assert!(slot.borrow().is_none(), "one capture hook per test thread");
|
||||
*slot.borrow_mut() = Some(Box::new(hook));
|
||||
});
|
||||
CaptureHook
|
||||
}
|
||||
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
pub enum NativeSnapshotError {
|
||||
#[error(transparent)]
|
||||
Store(#[from] StoreError),
|
||||
#[error(transparent)]
|
||||
Snapshot(#[from] snapshot::SnapshotError),
|
||||
#[error("native snapshot Store lock poisoned")]
|
||||
Poisoned,
|
||||
#[error("native snapshot worker failed")]
|
||||
Worker(#[source] tokio::task::JoinError),
|
||||
}
|
||||
|
||||
pub struct NativeSnapshotView {
|
||||
// Drop the transaction before the owner so the Database stays open throughout the view.
|
||||
transaction: ReadTransaction,
|
||||
header: snapshot::Header,
|
||||
counts: [u64; 4],
|
||||
schema: u64,
|
||||
_owner: Arc<Mutex<Store>>,
|
||||
}
|
||||
impl NativeSnapshotView {
|
||||
pub(crate) fn acquire(owner: Arc<Mutex<Store>>) -> Result<Self, NativeSnapshotError> {
|
||||
let transaction = {
|
||||
let store = owner.lock().map_err(|_| NativeSnapshotError::Poisoned)?;
|
||||
if !store.writable {
|
||||
return Err(StoreError::WriteDisabled.into());
|
||||
}
|
||||
store.database.begin_read().map_err(StoreError::from)?
|
||||
};
|
||||
#[cfg(test)]
|
||||
if let Some(hook) = AFTER_CAPTURE.with(|slot| slot.borrow_mut().take()) {
|
||||
hook();
|
||||
}
|
||||
let (applied, membership) = application::native_application_state(&transaction)?;
|
||||
let (header, schema) = {
|
||||
let meta = transaction.open_table(crate::META).map_err(StoreError::from)?;
|
||||
let logs = transaction.open_table(crate::LOGS).map_err(StoreError::from)?;
|
||||
let committed = crate::committed::validate_committed(&meta, &logs)?;
|
||||
if let Some(applied) = applied {
|
||||
let committed = committed.ok_or(StoreError::CorruptRecord)?;
|
||||
if applied.index > committed.index || (applied.index == committed.index && applied != committed) {
|
||||
return Err(StoreError::CorruptRecord.into());
|
||||
}
|
||||
}
|
||||
let identity = meta
|
||||
.get("identity")
|
||||
.map_err(StoreError::from)?
|
||||
.ok_or(StoreError::CorruptRecord)?;
|
||||
let schema = crate::number(
|
||||
meta.get("schema")
|
||||
.map_err(StoreError::from)?
|
||||
.ok_or(StoreError::CorruptRecord)?
|
||||
.value(),
|
||||
)?;
|
||||
(
|
||||
snapshot::Header {
|
||||
cluster_id: crate::decode_identity(identity.value())?.cluster_id,
|
||||
applied,
|
||||
membership,
|
||||
binding: application::read_binding(&meta)?,
|
||||
},
|
||||
schema,
|
||||
)
|
||||
};
|
||||
let mut counts = [0; 4];
|
||||
for (index, definition) in [
|
||||
application::HEADS,
|
||||
application::VERSIONS,
|
||||
application::EVENTS,
|
||||
application::OPERATIONS,
|
||||
]
|
||||
.into_iter()
|
||||
.enumerate()
|
||||
{
|
||||
counts[index] = transaction
|
||||
.open_table(definition)
|
||||
.map_err(StoreError::from)?
|
||||
.len()
|
||||
.map_err(StoreError::from)?;
|
||||
}
|
||||
Ok(Self {
|
||||
transaction,
|
||||
header,
|
||||
counts,
|
||||
schema,
|
||||
_owner: owner,
|
||||
})
|
||||
}
|
||||
|
||||
pub fn stream_capability_artifact<W: Write>(
|
||||
self,
|
||||
writer: W,
|
||||
limits: snapshot::Limits,
|
||||
) -> Result<snapshot::CapabilityArtifact<W>, NativeSnapshotError> {
|
||||
if !matches!(self.schema, 6 | 7) {
|
||||
return Err(StoreError::UnsupportedSchema.into());
|
||||
}
|
||||
let output = snapshot::CapabilityOutput::new(writer, limits.total_bytes);
|
||||
Ok(self.stream(output, limits)?.finish())
|
||||
}
|
||||
|
||||
pub(crate) fn transaction(&self) -> &ReadTransaction {
|
||||
&self.transaction
|
||||
}
|
||||
|
||||
pub(crate) fn header(&self) -> &snapshot::Header {
|
||||
&self.header
|
||||
}
|
||||
|
||||
pub(crate) fn owner(&self) -> &Arc<Mutex<Store>> {
|
||||
&self._owner
|
||||
}
|
||||
|
||||
pub(crate) fn stream_local_capability<W: Write>(
|
||||
&self,
|
||||
writer: W,
|
||||
limits: snapshot::Limits,
|
||||
) -> Result<snapshot::CapabilityArtifact<W>, NativeSnapshotError> {
|
||||
if !matches!(self.schema, 6 | 7) {
|
||||
return Err(StoreError::UnsupportedSchema.into());
|
||||
}
|
||||
let output = snapshot::CapabilityOutput::new(writer, limits.total_bytes);
|
||||
Ok(self.stream_borrowed(output, limits)?.finish())
|
||||
}
|
||||
|
||||
pub fn stream<W: Write>(self, writer: W, limits: snapshot::Limits) -> Result<W, NativeSnapshotError> {
|
||||
self.stream_borrowed(writer, limits)
|
||||
}
|
||||
|
||||
fn stream_borrowed<W: Write>(&self, writer: W, limits: snapshot::Limits) -> Result<W, NativeSnapshotError> {
|
||||
let mut encoder = snapshot::Encoder::new(writer, &self.header, self.counts, limits)?;
|
||||
for (definition, section) in [
|
||||
(application::HEADS, snapshot::Section::Heads),
|
||||
(application::VERSIONS, snapshot::Section::Versions),
|
||||
(application::EVENTS, snapshot::Section::Events),
|
||||
(application::OPERATIONS, snapshot::Section::Operations),
|
||||
] {
|
||||
let table = self.transaction.open_table(definition).map_err(StoreError::from)?;
|
||||
for row in table.iter().map_err(StoreError::from)? {
|
||||
let (key, value) = row.map_err(StoreError::from)?;
|
||||
encoder.row(snapshot::Row {
|
||||
section,
|
||||
key: key.value(),
|
||||
value: value.value(),
|
||||
})?;
|
||||
}
|
||||
}
|
||||
Ok(encoder.finish()?)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,197 @@
|
||||
//! Bounded snapshot transport bytes; receive ownership follows the buffer into install.
|
||||
use std::{
|
||||
io::{self, Read, Seek, SeekFrom, Write},
|
||||
pin::Pin,
|
||||
task::{Context, Poll},
|
||||
};
|
||||
use tokio::io::{AsyncRead, AsyncSeek, AsyncWrite, ReadBuf};
|
||||
|
||||
pub struct NativeSnapshotData {
|
||||
bytes: Vec<u8>,
|
||||
position: u64,
|
||||
limit: u64,
|
||||
pub(crate) receive_guard: Option<crate::raft_state_machine::ReceiveGuard>,
|
||||
}
|
||||
|
||||
fn boundary() -> io::Error {
|
||||
io::Error::new(io::ErrorKind::InvalidInput, "native snapshot byte limit")
|
||||
}
|
||||
|
||||
impl NativeSnapshotData {
|
||||
pub fn new(max_bytes: u64) -> io::Result<Self> {
|
||||
if max_bytes == 0 || usize::try_from(max_bytes).is_err() {
|
||||
return Err(boundary());
|
||||
}
|
||||
Ok(Self {
|
||||
bytes: Vec::new(),
|
||||
position: 0,
|
||||
limit: max_bytes,
|
||||
receive_guard: None,
|
||||
})
|
||||
}
|
||||
|
||||
pub(crate) fn as_slice(&self) -> &[u8] {
|
||||
&self.bytes
|
||||
}
|
||||
|
||||
pub(crate) fn attach_receive_guard(&mut self, guard: crate::raft_state_machine::ReceiveGuard) {
|
||||
self.receive_guard = Some(guard);
|
||||
}
|
||||
}
|
||||
|
||||
impl Read for NativeSnapshotData {
|
||||
fn read(&mut self, output: &mut [u8]) -> io::Result<usize> {
|
||||
let position = usize::try_from(self.position).map_err(|_| boundary())?;
|
||||
let available = self.bytes.get(position..).unwrap_or_default();
|
||||
let count = output.len().min(available.len());
|
||||
output[..count].copy_from_slice(&available[..count]);
|
||||
self.position = self
|
||||
.position
|
||||
.checked_add(u64::try_from(count).map_err(|_| boundary())?)
|
||||
.ok_or_else(boundary)?;
|
||||
Ok(count)
|
||||
}
|
||||
}
|
||||
|
||||
impl Write for NativeSnapshotData {
|
||||
fn write(&mut self, input: &[u8]) -> io::Result<usize> {
|
||||
if input.is_empty() {
|
||||
return Ok(0);
|
||||
}
|
||||
let count = u64::try_from(input.len()).map_err(|_| boundary())?;
|
||||
let end = self
|
||||
.position
|
||||
.checked_add(count)
|
||||
.filter(|end| *end <= self.limit)
|
||||
.ok_or_else(boundary)?;
|
||||
let position = usize::try_from(self.position).map_err(|_| boundary())?;
|
||||
let length = usize::try_from(end).map_err(|_| boundary())?;
|
||||
if length > self.bytes.len() {
|
||||
self.bytes
|
||||
.try_reserve_exact(length - self.bytes.len())
|
||||
.map_err(|_| io::Error::new(io::ErrorKind::OutOfMemory, "native snapshot allocation"))?;
|
||||
self.bytes.resize(length, 0);
|
||||
}
|
||||
self.bytes[position..length].copy_from_slice(input);
|
||||
self.position = end;
|
||||
Ok(input.len())
|
||||
}
|
||||
|
||||
fn flush(&mut self) -> io::Result<()> {
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
impl Seek for NativeSnapshotData {
|
||||
fn seek(&mut self, from: SeekFrom) -> io::Result<u64> {
|
||||
let position = match from {
|
||||
SeekFrom::Start(position) => Some(position),
|
||||
SeekFrom::Current(offset) => self.position.checked_add_signed(offset),
|
||||
SeekFrom::End(offset) => u64::try_from(self.bytes.len())
|
||||
.map_err(|_| boundary())?
|
||||
.checked_add_signed(offset),
|
||||
}
|
||||
.filter(|position| *position <= self.limit)
|
||||
.ok_or_else(boundary)?;
|
||||
self.position = position;
|
||||
Ok(position)
|
||||
}
|
||||
}
|
||||
|
||||
impl AsyncRead for NativeSnapshotData {
|
||||
fn poll_read(self: Pin<&mut Self>, _cx: &mut Context<'_>, output: &mut ReadBuf<'_>) -> Poll<io::Result<()>> {
|
||||
let this = self.get_mut();
|
||||
let position = match usize::try_from(this.position) {
|
||||
Ok(position) => position,
|
||||
Err(_) => return Poll::Ready(Err(boundary())),
|
||||
};
|
||||
let available = this.bytes.get(position..).unwrap_or_default();
|
||||
let count = output.remaining().min(available.len());
|
||||
let end = this
|
||||
.position
|
||||
.checked_add(u64::try_from(count).map_err(|_| boundary())?)
|
||||
.ok_or_else(boundary)?;
|
||||
output.put_slice(&available[..count]);
|
||||
this.position = end;
|
||||
Poll::Ready(Ok(()))
|
||||
}
|
||||
}
|
||||
|
||||
impl AsyncWrite for NativeSnapshotData {
|
||||
fn poll_write(self: Pin<&mut Self>, _cx: &mut Context<'_>, input: &[u8]) -> Poll<io::Result<usize>> {
|
||||
Poll::Ready(Write::write(self.get_mut(), input))
|
||||
}
|
||||
|
||||
fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<io::Result<()>> {
|
||||
Poll::Ready(Ok(()))
|
||||
}
|
||||
|
||||
fn poll_shutdown(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<io::Result<()>> {
|
||||
Poll::Ready(Ok(()))
|
||||
}
|
||||
}
|
||||
|
||||
impl AsyncSeek for NativeSnapshotData {
|
||||
fn start_seek(self: Pin<&mut Self>, from: SeekFrom) -> io::Result<()> {
|
||||
Seek::seek(self.get_mut(), from).map(|_| ())
|
||||
}
|
||||
|
||||
fn poll_complete(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<io::Result<u64>> {
|
||||
Poll::Ready(Ok(self.position))
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn native_snapshot_data_rejects_growth_before_mutation() {
|
||||
let mut data = NativeSnapshotData::new(4).expect("bounded snapshot");
|
||||
Write::write_all(&mut data, b"ab").expect("initial bytes");
|
||||
assert!(Write::write_all(&mut data, b"cde").is_err());
|
||||
assert_eq!(data.as_slice(), b"ab", "rejected write leaves bytes intact");
|
||||
assert_eq!(Seek::stream_position(&mut data).expect("position"), 2);
|
||||
Seek::seek(&mut data, SeekFrom::Start(4)).expect("seek exactly to limit");
|
||||
Write::write(&mut data, b"").expect("empty write");
|
||||
assert_eq!(data.as_slice(), b"ab", "empty write never allocates a gap");
|
||||
assert!(Write::write(&mut data, b"x").is_err());
|
||||
assert!(Seek::seek(&mut data, SeekFrom::Current(1)).is_err());
|
||||
assert!(Seek::seek(&mut data, SeekFrom::Current(i64::MIN)).is_err());
|
||||
assert_eq!(Seek::stream_position(&mut data).expect("unchanged position"), 4);
|
||||
Seek::seek(&mut data, SeekFrom::Start(3)).expect("bounded sparse position");
|
||||
Write::write_all(&mut data, b"z").expect("write ending exactly at limit");
|
||||
assert_eq!(data.as_slice(), b"ab\0z");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn native_snapshot_data_checks_length_overflow() {
|
||||
assert!(NativeSnapshotData::new(0).is_err());
|
||||
if usize::BITS == 64 {
|
||||
let mut data = NativeSnapshotData::new(u64::MAX).expect("representable byte limit");
|
||||
Seek::seek(&mut data, SeekFrom::Start(u64::MAX)).expect("seek does not allocate");
|
||||
assert!(Write::write(&mut data, b"x").is_err());
|
||||
assert!(Seek::seek(&mut data, SeekFrom::Current(1)).is_err());
|
||||
assert!(data.as_slice().is_empty(), "overflow never allocates");
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn native_snapshot_data_async_io_uses_the_same_bounds() {
|
||||
use tokio::io::{AsyncReadExt, AsyncSeekExt, AsyncWriteExt};
|
||||
let mut data = NativeSnapshotData::new(4).expect("bounded async snapshot");
|
||||
AsyncWriteExt::write_all(&mut data, b"abcd").await.expect("write exact limit");
|
||||
assert!(AsyncWriteExt::write_all(&mut data, b"e").await.is_err());
|
||||
assert!(AsyncSeekExt::seek(&mut data, SeekFrom::Start(5)).await.is_err());
|
||||
AsyncSeekExt::seek(&mut data, SeekFrom::End(-2))
|
||||
.await
|
||||
.expect("rewind within snapshot");
|
||||
let mut output = Vec::new();
|
||||
AsyncReadExt::read_to_end(&mut data, &mut output)
|
||||
.await
|
||||
.expect("read snapshot suffix");
|
||||
assert_eq!(output, b"cd");
|
||||
AsyncWriteExt::shutdown(&mut data).await.expect("transport shutdown");
|
||||
assert_eq!(data.as_slice(), b"abcd");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,217 @@
|
||||
//! Validate isolated received bytes before one durable shared-owner publication.
|
||||
use crate::{
|
||||
CaptureMembership, CheckpointLimits, NativeLogWriter, NativeSnapshotData, StoreError, application, checkpoint_baseline,
|
||||
native_checkpoint, snapshot,
|
||||
};
|
||||
use redb::{ReadableDatabase, ReadableTable};
|
||||
use std::sync::{
|
||||
Arc,
|
||||
atomic::{AtomicBool, Ordering},
|
||||
};
|
||||
|
||||
struct Cancel(Arc<AtomicBool>);
|
||||
impl Drop for Cancel {
|
||||
fn drop(&mut self) {
|
||||
self.0.store(true, Ordering::Release);
|
||||
}
|
||||
}
|
||||
struct Stage {
|
||||
database: redb::Database,
|
||||
_directory: tempfile::TempDir,
|
||||
baseline: checkpoint_baseline::BaselineMetadata,
|
||||
}
|
||||
fn stage(data: &NativeSnapshotData, limits: CheckpointLimits) -> Result<Stage, StoreError> {
|
||||
let bytes = data.as_slice();
|
||||
if u64::try_from(bytes.len()).map_err(|_| StoreError::ResourceLimit)?
|
||||
> limits.snapshot.total_bytes.checked_add(56).ok_or(StoreError::ResourceLimit)?
|
||||
{
|
||||
return Err(StoreError::ResourceLimit);
|
||||
}
|
||||
let manifest = snapshot::CapabilityManifest::decode(bytes.get(..56).ok_or(StoreError::CorruptRecord)?)
|
||||
.map_err(|_| StoreError::CorruptRecord)?;
|
||||
let directory = tempfile::tempdir()?;
|
||||
let database = native_checkpoint::stage_database(directory.path().join("received.redb"), limits.staging_bytes)?;
|
||||
let tx = database.begin_write()?;
|
||||
for definition in [
|
||||
checkpoint_baseline::HEADS,
|
||||
checkpoint_baseline::VERSIONS,
|
||||
checkpoint_baseline::EVENTS,
|
||||
checkpoint_baseline::OPERATIONS,
|
||||
] {
|
||||
tx.open_table(definition)?;
|
||||
}
|
||||
let header = snapshot::decode_capability_artifact(
|
||||
snapshot::CapabilityArtifact {
|
||||
manifest,
|
||||
payload: &bytes[56..],
|
||||
},
|
||||
&mut native_checkpoint::StageSink(&tx),
|
||||
limits.snapshot,
|
||||
)
|
||||
.map_err(|_| StoreError::CorruptRecord)?;
|
||||
let baseline = checkpoint_baseline::BaselineMetadata {
|
||||
generation: 1,
|
||||
header,
|
||||
limits,
|
||||
};
|
||||
let encoded = checkpoint_baseline::encode_metadata(&baseline)?;
|
||||
{
|
||||
let mut meta = tx.open_table(crate::META)?;
|
||||
meta.insert("schema", 7u64.to_be_bytes().as_slice())?;
|
||||
meta.insert(checkpoint_baseline::META_KEY, encoded.as_slice())?;
|
||||
}
|
||||
tx.commit().map_err(StoreError::StagingCommit)?;
|
||||
checkpoint_baseline::validate_baseline_with_budget(&database.begin_read()?, &baseline, limits.staging_bytes)?;
|
||||
Ok(Stage {
|
||||
database,
|
||||
_directory: directory,
|
||||
baseline,
|
||||
})
|
||||
}
|
||||
pub(crate) async fn install(
|
||||
writer: NativeLogWriter,
|
||||
limits: CheckpointLimits,
|
||||
meta: openraft::SnapshotMeta<u64, crate::CaptureNode>,
|
||||
data: Box<NativeSnapshotData>,
|
||||
) -> Result<(), StoreError> {
|
||||
if data
|
||||
.receive_guard
|
||||
.as_ref()
|
||||
.is_none_or(|guard| !guard.belongs_to(&writer.snapshot_receives))
|
||||
{
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let (mut stage, data) = tokio::task::spawn_blocking(move || Ok::<_, StoreError>((stage(&data, limits)?, data)))
|
||||
.await
|
||||
.map_err(|_| StoreError::CorruptRecord)??;
|
||||
if meta.last_log_id.map(crate::LogId::from) != stage.baseline.header.applied {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
if CaptureMembership::try_from(&meta.last_membership)? != stage.baseline.header.membership {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let ordering = writer.ordering.clone().lock_owned().await;
|
||||
let cancel = Cancel(Arc::new(AtomicBool::new(false)));
|
||||
let cancelled = cancel.0.clone();
|
||||
tokio::task::spawn_blocking(move || {
|
||||
let _ordering = ordering;
|
||||
let _data = data;
|
||||
if cancelled.load(Ordering::Acquire) {
|
||||
return Err(StoreError::WriteDisabled);
|
||||
}
|
||||
let mut store = writer.store.lock().map_err(|_| StoreError::CorruptRecord)?;
|
||||
let read = store.database.begin_read()?;
|
||||
let old_meta = read.open_table(crate::META)?;
|
||||
let identity = crate::decode_identity(old_meta.get("identity")?.ok_or(StoreError::CorruptRecord)?.value())?;
|
||||
if identity.cluster_id != stage.baseline.header.cluster_id
|
||||
|| application::read_binding(&old_meta)? != stage.baseline.header.binding
|
||||
{
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let old_applied = application::read_applied(&old_meta)?;
|
||||
let old_logs = read.open_table(crate::LOGS)?;
|
||||
let committed = crate::committed::validate_committed(&old_meta, &old_logs)?;
|
||||
let cut = stage.baseline.header.applied;
|
||||
if old_applied.is_some_and(|id| cut.is_none_or(|cut| id.index > cut.index || (id.index == cut.index && id != cut))) {
|
||||
return Err(StoreError::CommittedRegression);
|
||||
}
|
||||
let compatible = match cut {
|
||||
None => true,
|
||||
Some(cut) => {
|
||||
let at_cut = old_logs
|
||||
.get(cut.index)?
|
||||
.map(|v| crate::decode_log(v.value()).map(|v| v.id))
|
||||
.transpose()?
|
||||
.or(checkpoint_baseline::read_baseline_cut(&old_meta)?.filter(|id| id.index == cut.index));
|
||||
if committed
|
||||
.is_some_and(|id| id.index >= cut.index && (at_cut != Some(cut) || (id.index == cut.index && id != cut)))
|
||||
{
|
||||
return Err(StoreError::CommittedRegression);
|
||||
}
|
||||
at_cut == Some(cut)
|
||||
}
|
||||
};
|
||||
let previous = checkpoint_baseline::read_metadata(&old_meta)?;
|
||||
stage.baseline.generation =
|
||||
previous.map_or(Ok(1), |old| old.generation.checked_add(1).ok_or(StoreError::ResourceLimit))?;
|
||||
drop(old_logs);
|
||||
drop(old_meta);
|
||||
drop(read);
|
||||
let source = stage.database.begin_read()?;
|
||||
let tx = store.write_transaction()?;
|
||||
for (baseline, live) in [
|
||||
(checkpoint_baseline::HEADS, application::HEADS),
|
||||
(checkpoint_baseline::VERSIONS, application::VERSIONS),
|
||||
(checkpoint_baseline::EVENTS, application::EVENTS),
|
||||
(checkpoint_baseline::OPERATIONS, application::OPERATIONS),
|
||||
] {
|
||||
let table = source.open_table(baseline)?;
|
||||
for target in [baseline, live] {
|
||||
let mut target = tx.open_table(target)?;
|
||||
target.retain(|_, _| false)?;
|
||||
for row in table.iter()? {
|
||||
let (key, value) = row?;
|
||||
target.insert(key.value(), value.value())?;
|
||||
}
|
||||
}
|
||||
}
|
||||
{
|
||||
let mut index = tx.open_table(crate::source_page::EVENT_SEQUENCE)?;
|
||||
index.retain(|_, _| false)?;
|
||||
}
|
||||
for row in source.open_table(checkpoint_baseline::EVENTS)?.iter()? {
|
||||
let (key, value) = row?;
|
||||
let event = application::decode_event(value.value())?;
|
||||
crate::source_page::insert_event_index(
|
||||
&tx,
|
||||
event.decision_log_id,
|
||||
key.value().try_into().map_err(|_| StoreError::CorruptRecord)?,
|
||||
)?;
|
||||
}
|
||||
let tail = {
|
||||
let mut logs = tx.open_table(crate::LOGS)?;
|
||||
logs.retain(|index, _| compatible && cut.is_none_or(|cut| index > cut.index))?;
|
||||
logs.last()?
|
||||
.map(|(_, v)| crate::decode_log(v.value()).map(|v| v.id))
|
||||
.transpose()?
|
||||
.or(cut)
|
||||
};
|
||||
tx.open_table(application::APPLY_RESULTS)?.retain(|_, _| false)?;
|
||||
{
|
||||
let mut target = tx.open_table(crate::META)?;
|
||||
target.insert("schema", 7u64.to_be_bytes().as_slice())?;
|
||||
target.insert(
|
||||
checkpoint_baseline::META_KEY,
|
||||
checkpoint_baseline::encode_metadata(&stage.baseline)?.as_slice(),
|
||||
)?;
|
||||
let mut applied = vec![0];
|
||||
if let Some(cut) = cut {
|
||||
target.insert(checkpoint_baseline::PURGED_KEY, checkpoint_baseline::encode_purged(cut).as_slice())?;
|
||||
applied = vec![1];
|
||||
applied.extend(crate::encode_id(cut));
|
||||
} else {
|
||||
target.remove(checkpoint_baseline::PURGED_KEY)?;
|
||||
}
|
||||
target.insert("last_applied", applied.as_slice())?;
|
||||
target.insert("native_membership", stage.baseline.header.membership.encode()?.as_slice())?;
|
||||
if let Some(tail) = tail {
|
||||
target.insert("tail", crate::encode_id(tail).as_slice())?;
|
||||
} else {
|
||||
target.remove("tail")?;
|
||||
}
|
||||
let committed = committed.filter(|id| cut.is_none_or(|cut| id.index > cut.index)).or(cut);
|
||||
if let Some(committed) = committed {
|
||||
target.insert("committed", crate::encode_id(committed).as_slice())?;
|
||||
} else {
|
||||
target.remove("committed")?;
|
||||
}
|
||||
crate::raft_state_machine::publish_meta(&mut target, &stage.baseline, meta)?;
|
||||
}
|
||||
if cancelled.load(Ordering::Acquire) {
|
||||
return Err(StoreError::WriteDisabled);
|
||||
}
|
||||
store.commit(tx)
|
||||
})
|
||||
.await
|
||||
.map_err(|_| StoreError::CorruptRecord)?
|
||||
}
|
||||
@@ -0,0 +1,536 @@
|
||||
//! Atomic installation failures over real native stores and disk fault backend.
|
||||
use super::raft_state_machine_tests::{Fixture, entries, entry, id, install, receive, snapshot_bytes};
|
||||
use super::*;
|
||||
use openraft::{
|
||||
RaftLogReader, RaftSnapshotBuilder,
|
||||
storage::{RaftLogStorage, RaftLogStorageExt, RaftStateMachine},
|
||||
};
|
||||
|
||||
async fn media_target() -> (Fixture, tests::CrashBackend) {
|
||||
let mut f = Fixture::new(1);
|
||||
f.apply(entries(1)).await;
|
||||
f.logs
|
||||
.save_vote(&openraft::Vote::new_committed(9, 1))
|
||||
.await
|
||||
.expect("preserved target vote");
|
||||
let Fixture {
|
||||
directory,
|
||||
writer,
|
||||
logs,
|
||||
sm,
|
||||
identity,
|
||||
} = f;
|
||||
drop(sm);
|
||||
drop(logs);
|
||||
drop(writer);
|
||||
let backend = tests::CrashBackend::new(&directory.path().join("db"));
|
||||
let writer = NativeLogWriter::new(Store::from_database(backend.database(), identity).expect("actual redb fault target"));
|
||||
let logs = NativeRaftLogStore::new(writer.clone());
|
||||
let sm = NativeRaftStateMachine::new(writer.clone(), CheckpointLimits::default()).expect("fault target state machine");
|
||||
(
|
||||
Fixture {
|
||||
directory,
|
||||
writer,
|
||||
logs,
|
||||
sm,
|
||||
identity,
|
||||
},
|
||||
backend,
|
||||
)
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn native_snapshot_install_corruption_preserves_state() {
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(2)).await;
|
||||
let mut snapshot = source.build().await;
|
||||
let bytes = snapshot_bytes(&mut snapshot).await;
|
||||
let mut target = Fixture::new(1);
|
||||
target.apply(entries(1)).await;
|
||||
let before = target.page().await;
|
||||
let state = target.sm.applied_state().await.expect("old applied state");
|
||||
let mut corrupted = bytes.clone();
|
||||
*corrupted.last_mut().expect("nonempty snapshot") ^= 1;
|
||||
for payload in [corrupted, bytes[..bytes.len() - 1].to_vec()] {
|
||||
let stable = std::fs::read(target.directory.path().join("db")).expect("old stable bytes");
|
||||
let data = receive(&mut target.sm, &payload).await;
|
||||
assert!(
|
||||
target.sm.install_snapshot(&snapshot.meta, data).await.is_err(),
|
||||
"SNAPSHOT_INSTALL_CORRUPT_FRAME_REJECTED"
|
||||
);
|
||||
assert_eq!(target.sm.applied_state().await.expect("unchanged applied state"), state);
|
||||
assert_eq!(target.page().await, before, "SNAPSHOT_INSTALL_CORRUPTION_NO_PARTIAL_TABLES");
|
||||
assert_eq!(std::fs::read(target.directory.path().join("db")).expect("unchanged stable bytes"), stable);
|
||||
assert!(
|
||||
target
|
||||
.sm
|
||||
.get_current_snapshot()
|
||||
.await
|
||||
.expect("unpublished corrupt snapshot")
|
||||
.is_none()
|
||||
);
|
||||
}
|
||||
install(&mut target.sm, &mut snapshot).await;
|
||||
assert_eq!(target.page().await, source.page().await, "SNAPSHOT_INSTALL_RETRY_AFTER_CORRUPT_RECEIVE");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn native_snapshot_install_stale_cut_rejected() {
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(1)).await;
|
||||
let mut snapshot = source.build().await;
|
||||
let bytes = snapshot_bytes(&mut snapshot).await;
|
||||
let mut target = Fixture::new(1);
|
||||
target.apply(entries(3)).await;
|
||||
let current = target.build().await.meta;
|
||||
let events = target.page().await;
|
||||
let data = receive(&mut target.sm, &bytes).await;
|
||||
assert!(
|
||||
target.sm.install_snapshot(&snapshot.meta, data).await.is_err(),
|
||||
"SNAPSHOT_INSTALL_NEVER_ROLLS_BACK_APPLIED_STATE"
|
||||
);
|
||||
assert_eq!(target.sm.applied_state().await.expect("non-regressed applied").0, Some(id(3).into()));
|
||||
assert_eq!(
|
||||
target
|
||||
.sm
|
||||
.get_current_snapshot()
|
||||
.await
|
||||
.expect("old current snapshot")
|
||||
.expect("present")
|
||||
.meta,
|
||||
current
|
||||
);
|
||||
assert_eq!(target.page().await, events);
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(2)).await;
|
||||
let mut snapshot = source.build().await;
|
||||
let bytes = snapshot_bytes(&mut snapshot).await;
|
||||
let mut target = Fixture::new(1);
|
||||
let mut batch = entries(3);
|
||||
for entry in &mut batch[2..] {
|
||||
entry.log_id = LogId {
|
||||
term: 9,
|
||||
..id(entry.log_id.index)
|
||||
}
|
||||
.into();
|
||||
}
|
||||
target
|
||||
.logs
|
||||
.blocking_append(batch)
|
||||
.await
|
||||
.expect("conflicting committed suffix logs");
|
||||
target.sm.apply(entries(1)).await.expect("existing applied prefix");
|
||||
target
|
||||
.logs
|
||||
.save_committed(Some(LogId { term: 9, ..id(3) }.into()))
|
||||
.await
|
||||
.expect("protect conflicting committed suffix");
|
||||
let before = target
|
||||
.logs
|
||||
.get_log_reader()
|
||||
.await
|
||||
.try_get_log_entries(..)
|
||||
.await
|
||||
.expect("protected logs");
|
||||
let data = receive(&mut target.sm, &bytes).await;
|
||||
assert!(
|
||||
target.sm.install_snapshot(&snapshot.meta, data).await.is_err(),
|
||||
"SNAPSHOT_INSTALL_NEVER_DISCARDS_COMMITTED_CONFLICT"
|
||||
);
|
||||
assert_eq!(
|
||||
target
|
||||
.logs
|
||||
.get_log_reader()
|
||||
.await
|
||||
.try_get_log_entries(..)
|
||||
.await
|
||||
.expect("unchanged protected logs"),
|
||||
before
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||
async fn native_snapshot_install_cancelled_owner() {
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(2)).await;
|
||||
let mut snapshot = source.build().await;
|
||||
let bytes = snapshot_bytes(&mut snapshot).await;
|
||||
let (mut target, backend) = media_target().await;
|
||||
let data = receive(&mut target.sm, &bytes).await;
|
||||
let (entered, resume) = backend.pause_sync(1, false);
|
||||
let mut installing = target.sm.clone();
|
||||
let meta = snapshot.meta.clone();
|
||||
let task = tokio::spawn(async move { installing.install_snapshot(&meta, data).await });
|
||||
entered.wait();
|
||||
assert!(!task.is_finished(), "SNAPSHOT_INSTALL_NOT_ACKED_BEFORE_SYNC");
|
||||
task.abort();
|
||||
assert!(task.await.expect_err("cancelled install waiter").is_cancelled());
|
||||
assert!(
|
||||
target.writer.ordering.try_lock().is_err(),
|
||||
"SNAPSHOT_INSTALL_CANCELLED_WAITER_RETAINS_OWNER"
|
||||
);
|
||||
resume.wait();
|
||||
// Acquiring the production owner waits for the abandoned blocking commit.
|
||||
drop(target.writer.ordering.lock().await);
|
||||
assert_eq!(
|
||||
target.sm.applied_state().await.expect("completed background install").0,
|
||||
Some(id(2).into()),
|
||||
"SNAPSHOT_INSTALL_COMMIT_NOT_INTERRUPTED_BY_WAITER_CANCEL"
|
||||
);
|
||||
let vote = target.logs.read_vote().await.expect("preserved vote");
|
||||
assert_eq!(vote, Some(openraft::Vote::new_committed(9, 1)));
|
||||
backend.cut();
|
||||
let Fixture {
|
||||
directory,
|
||||
writer,
|
||||
logs,
|
||||
sm,
|
||||
identity,
|
||||
} = target;
|
||||
drop(sm);
|
||||
drop(logs);
|
||||
drop(writer);
|
||||
let writer = NativeLogWriter::new(Store::open(directory.path().join("db"), identity).expect("reopen cancelled installation"));
|
||||
let mut sm =
|
||||
NativeRaftStateMachine::new(writer.clone(), CheckpointLimits::default()).expect("reopen installed state machine");
|
||||
assert_eq!(
|
||||
sm.get_current_snapshot()
|
||||
.await
|
||||
.expect("completed durable snapshot")
|
||||
.expect("present")
|
||||
.meta,
|
||||
snapshot.meta
|
||||
);
|
||||
assert_eq!(
|
||||
writer.created_events_page(None, 256).await.expect("installed events"),
|
||||
source.page().await
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||
async fn native_snapshot_install_power_cut_atomic() {
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(2)).await;
|
||||
let mut snapshot = source.build().await;
|
||||
let bytes = snapshot_bytes(&mut snapshot).await;
|
||||
let new_events = source.page().await;
|
||||
for after_sync in [false, true] {
|
||||
let (mut target, backend) = media_target().await;
|
||||
let old_events = target.page().await;
|
||||
let data = receive(&mut target.sm, &bytes).await;
|
||||
let (entered, resume) = backend.pause_sync(1, after_sync);
|
||||
let meta = snapshot.meta.clone();
|
||||
let mut installing = target.sm.clone();
|
||||
let task = tokio::spawn(async move { installing.install_snapshot(&meta, data).await });
|
||||
entered.wait();
|
||||
backend.cut();
|
||||
resume.wait();
|
||||
assert!(
|
||||
task.await.expect("faulted install task").is_err(),
|
||||
"SNAPSHOT_INSTALL_POWER_CUT_NO_FALSE_ACK"
|
||||
);
|
||||
assert!(
|
||||
target.sm.get_current_snapshot().await.is_err(),
|
||||
"SNAPSHOT_INSTALL_FENCED_HANDLE_CANNOT_EXPORT"
|
||||
);
|
||||
let Fixture {
|
||||
directory,
|
||||
writer,
|
||||
logs,
|
||||
sm,
|
||||
identity,
|
||||
} = target;
|
||||
drop(sm);
|
||||
drop(logs);
|
||||
drop(writer);
|
||||
let writer =
|
||||
NativeLogWriter::new(Store::open(directory.path().join("db"), identity).expect("atomic installation recovery"));
|
||||
let mut logs = NativeRaftLogStore::new(writer.clone());
|
||||
let mut sm = NativeRaftStateMachine::new(writer.clone(), CheckpointLimits::default()).expect("recovered SM");
|
||||
let events = writer
|
||||
.created_events_page(None, 256)
|
||||
.await
|
||||
.expect("complete recovered tables");
|
||||
let cut = sm.applied_state().await.expect("recovered applied marker").0;
|
||||
if events == old_events {
|
||||
assert_eq!(cut, Some(id(1).into()), "SNAPSHOT_INSTALL_OLD_TABLES_OLD_MARKER");
|
||||
assert!(sm.get_current_snapshot().await.expect("old snapshot selection").is_none());
|
||||
} else {
|
||||
assert_eq!(events, new_events, "SNAPSHOT_INSTALL_ALL_TABLES_OLD_OR_NEW");
|
||||
assert_eq!(cut, Some(id(2).into()), "SNAPSHOT_INSTALL_NEW_TABLES_NEW_MARKER");
|
||||
let mut current = sm
|
||||
.get_current_snapshot()
|
||||
.await
|
||||
.expect("new snapshot selection")
|
||||
.expect("new snapshot published");
|
||||
assert_eq!(current.meta, snapshot.meta);
|
||||
assert_eq!(snapshot_bytes(&mut current).await, bytes);
|
||||
}
|
||||
assert_eq!(writer.durable_identity().await.expect("recovered local identity"), identity);
|
||||
assert_eq!(
|
||||
logs.read_vote().await.expect("recovered local vote"),
|
||||
Some(openraft::Vote::new_committed(9, 1))
|
||||
);
|
||||
let state = logs.get_log_state().await.expect("coherent recovered log state");
|
||||
assert!(
|
||||
state
|
||||
.last_log_id
|
||||
.is_some_and(|last| cut.is_some_and(|applied| last.index >= applied.index)),
|
||||
"SNAPSHOT_INSTALL_LOG_STATE_COVERS_APPLIED_CUT"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn native_snapshot_install_ack_survives_power_cut() {
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(2)).await;
|
||||
let mut snapshot = source.build().await;
|
||||
let bytes = snapshot_bytes(&mut snapshot).await;
|
||||
let (mut target, backend) = media_target().await;
|
||||
install(&mut target.sm, &mut snapshot).await;
|
||||
backend.cut();
|
||||
let Fixture {
|
||||
directory,
|
||||
writer,
|
||||
logs,
|
||||
sm,
|
||||
identity,
|
||||
} = target;
|
||||
drop(sm);
|
||||
drop(logs);
|
||||
drop(writer);
|
||||
let writer = NativeLogWriter::new(
|
||||
Store::open(directory.path().join("db"), identity).expect("acknowledged installation survives power cut"),
|
||||
);
|
||||
let mut logs = NativeRaftLogStore::new(writer.clone());
|
||||
let mut sm = NativeRaftStateMachine::new(writer.clone(), CheckpointLimits::default()).expect("reopened durable SM");
|
||||
let mut current = sm
|
||||
.get_current_snapshot()
|
||||
.await
|
||||
.expect("durable current snapshot")
|
||||
.expect("present");
|
||||
assert_eq!(current.meta, snapshot.meta, "SNAPSHOT_INSTALL_ACK_COMPLETE_META_DURABLE");
|
||||
assert_eq!(snapshot_bytes(&mut current).await, bytes);
|
||||
assert_eq!(
|
||||
writer.created_events_page(None, 256).await.expect("durable installed events"),
|
||||
source.page().await
|
||||
);
|
||||
logs.blocking_append(vec![entry(3)]).await.expect("append after ACK recovery");
|
||||
sm.apply(vec![entry(3)]).await.expect("apply after ACK recovery");
|
||||
assert_eq!(sm.applied_state().await.expect("continued state").0, Some(id(3).into()));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn native_snapshot_install_purge_without_pending_rejected() {
|
||||
let mut target = Fixture::new(1);
|
||||
target.apply(entries(1)).await;
|
||||
let before = target.page().await;
|
||||
let bytes = std::fs::read(target.directory.path().join("db")).expect("old unauthorized purge bytes");
|
||||
let result = tokio::time::timeout(std::time::Duration::from_secs(2), target.logs.purge(id(3).into()))
|
||||
.await
|
||||
.expect("no pending receiver means purge cannot wait for hypothetical installation");
|
||||
assert!(result.is_err(), "SNAPSHOT_PURGE_WITHOUT_PENDING_FAILS_IMMEDIATELY");
|
||||
assert_eq!(target.page().await, before);
|
||||
assert_eq!(
|
||||
std::fs::read(target.directory.path().join("db")).expect("rejected purge preserves bytes"),
|
||||
bytes
|
||||
);
|
||||
}
|
||||
|
||||
async fn wait_for_pending_purge(writer: &NativeLogWriter) {
|
||||
tokio::time::timeout(std::time::Duration::from_secs(5), async {
|
||||
while writer.snapshot_receives.waiters.load(std::sync::atomic::Ordering::Acquire) == 0 {
|
||||
tokio::task::yield_now().await;
|
||||
}
|
||||
})
|
||||
.await
|
||||
.expect("actual trait purge reached pending-receive wait");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn native_snapshot_install_pending_purge_waits_for_install() {
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(3)).await;
|
||||
let mut snapshot = source.build().await;
|
||||
let bytes = snapshot_bytes(&mut snapshot).await;
|
||||
let mut target = Fixture::new(1);
|
||||
target.apply(entries(1)).await;
|
||||
let data = receive(&mut target.sm, &bytes).await;
|
||||
let mut purging = target.logs.clone();
|
||||
let purge = tokio::spawn(async move { purging.purge(id(3).into()).await });
|
||||
wait_for_pending_purge(&target.writer).await;
|
||||
assert!(!purge.is_finished(), "SNAPSHOT_PURGE_WAITS_FOR_INCOMING_CUT_BEYOND_LOCAL_TAIL");
|
||||
target
|
||||
.sm
|
||||
.install_snapshot(&snapshot.meta, data)
|
||||
.await
|
||||
.expect("actual install while OpenRaft-style purge waits");
|
||||
tokio::time::timeout(std::time::Duration::from_secs(5), purge)
|
||||
.await
|
||||
.expect("pending purge wakes after install")
|
||||
.expect("purge task")
|
||||
.expect("installed checkpoint now authorizes exact purge");
|
||||
assert_eq!(
|
||||
target
|
||||
.logs
|
||||
.get_log_state()
|
||||
.await
|
||||
.expect("installed log state")
|
||||
.last_purged_log_id,
|
||||
Some(id(3).into()),
|
||||
"SNAPSHOT_PENDING_PURGE_USES_DURABLE_INSTALLED_CUT"
|
||||
);
|
||||
assert_eq!(target.page().await, source.page().await);
|
||||
assert_eq!(
|
||||
target
|
||||
.writer
|
||||
.snapshot_receives
|
||||
.waiters
|
||||
.load(std::sync::atomic::Ordering::Acquire),
|
||||
0,
|
||||
"SNAPSHOT_PURGE_WAIT_OWNER_RELEASED"
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn native_snapshot_install_cancelled_receive_wakes_purge() {
|
||||
let mut target = Fixture::new(1);
|
||||
target.apply(entries(1)).await;
|
||||
let page = target.page().await;
|
||||
let before = std::fs::read(target.directory.path().join("db")).expect("stable target before cancelled receive");
|
||||
let data = target.sm.begin_receiving_snapshot().await.expect("actual pending receiver");
|
||||
let mut purging = target.logs.clone();
|
||||
let purge = tokio::spawn(async move { purging.purge(id(3).into()).await });
|
||||
wait_for_pending_purge(&target.writer).await;
|
||||
assert!(!purge.is_finished(), "SNAPSHOT_CANCELLED_RECEIVE_TEST_HAS_REAL_WAITING_PURGE");
|
||||
drop(data);
|
||||
assert!(
|
||||
tokio::time::timeout(std::time::Duration::from_secs(5), purge)
|
||||
.await
|
||||
.expect("cancelled receive wakes pending purge")
|
||||
.expect("purge task")
|
||||
.is_err(),
|
||||
"SNAPSHOT_CANCELLED_RECEIVE_CANNOT_AUTHORIZE_PURGE"
|
||||
);
|
||||
assert_eq!(target.page().await, page);
|
||||
assert_eq!(
|
||||
std::fs::read(target.directory.path().join("db")).expect("retained cancelled-receive state"),
|
||||
before
|
||||
);
|
||||
assert_eq!(
|
||||
target
|
||||
.writer
|
||||
.snapshot_receives
|
||||
.waiters
|
||||
.load(std::sync::atomic::Ordering::Acquire),
|
||||
0
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn native_snapshot_install_failed_receive_wakes_purge() {
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(3)).await;
|
||||
let mut snapshot = source.build().await;
|
||||
let bytes = snapshot_bytes(&mut snapshot).await;
|
||||
let mut target = Fixture::new(1);
|
||||
target.apply(entries(1)).await;
|
||||
let page = target.page().await;
|
||||
let before = std::fs::read(target.directory.path().join("db")).expect("stable target before failed install");
|
||||
let data = receive(&mut target.sm, &bytes).await;
|
||||
let mut purging = target.logs.clone();
|
||||
let purge = tokio::spawn(async move { purging.purge(id(3).into()).await });
|
||||
wait_for_pending_purge(&target.writer).await;
|
||||
assert!(!purge.is_finished(), "SNAPSHOT_FAILED_INSTALL_TEST_HAS_REAL_WAITING_PURGE");
|
||||
let mut wrong = snapshot.meta.clone();
|
||||
wrong.last_log_id = Some(LogId { term: 9, ..id(3) }.into());
|
||||
assert!(
|
||||
target.sm.install_snapshot(&wrong, data).await.is_err(),
|
||||
"SNAPSHOT_INVALID_META_INSTALL_REJECTED"
|
||||
);
|
||||
assert!(
|
||||
tokio::time::timeout(std::time::Duration::from_secs(5), purge)
|
||||
.await
|
||||
.expect("failed install wakes pending purge")
|
||||
.expect("purge task")
|
||||
.is_err(),
|
||||
"SNAPSHOT_FAILED_INSTALL_CANNOT_AUTHORIZE_PURGE"
|
||||
);
|
||||
assert_eq!(target.page().await, page);
|
||||
assert_eq!(
|
||||
std::fs::read(target.directory.path().join("db")).expect("retained failed-install state"),
|
||||
before
|
||||
);
|
||||
assert_eq!(
|
||||
target
|
||||
.writer
|
||||
.snapshot_receives
|
||||
.waiters
|
||||
.load(std::sync::atomic::Ordering::Acquire),
|
||||
0
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn native_snapshot_install_completed_between_purge_query_and_wait() {
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(2)).await;
|
||||
let mut snapshot = source.build().await;
|
||||
let data_bytes = snapshot_bytes(&mut snapshot).await;
|
||||
let mut target = Fixture::new(1);
|
||||
let data = receive(&mut target.sm, &data_bytes).await;
|
||||
let entered = std::sync::Arc::new(tokio::sync::Notify::new());
|
||||
let resume = std::sync::Arc::new(tokio::sync::Notify::new());
|
||||
*target.writer.snapshot_receives.purge_recheck.lock().expect("test pause") = Some((entered.clone(), resume.clone()));
|
||||
let mut logs = target.logs.clone();
|
||||
let purge = tokio::spawn(async move { logs.purge(id(2).into()).await });
|
||||
tokio::time::timeout(std::time::Duration::from_secs(5), entered.notified())
|
||||
.await
|
||||
.expect("purge failed coverage under owner before continuation");
|
||||
target
|
||||
.sm
|
||||
.install_snapshot(&snapshot.meta, data)
|
||||
.await
|
||||
.expect("install completes before purge continuation");
|
||||
resume.notify_one();
|
||||
tokio::time::timeout(std::time::Duration::from_secs(5), purge)
|
||||
.await
|
||||
.expect("completed install wake retained")
|
||||
.expect("purge task")
|
||||
.expect("old StaleCheckpoint rechecked after install");
|
||||
assert_eq!(
|
||||
target.page().await,
|
||||
source.page().await,
|
||||
"SNAPSHOT_COMPLETED_INSTALL_RECHECKS_STALE_PURGE"
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn native_snapshot_install_empty_baseline_pending_purge() {
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(2)).await;
|
||||
let mut snapshot = source.build().await;
|
||||
let bytes = snapshot_bytes(&mut snapshot).await;
|
||||
let mut target = Fixture::new(1);
|
||||
target.sm.build_snapshot().await.expect("real local empty baseline");
|
||||
let data = receive(&mut target.sm, &bytes).await;
|
||||
let mut logs = target.logs.clone();
|
||||
let purge = tokio::spawn(async move { logs.purge(id(2).into()).await });
|
||||
wait_for_pending_purge(&target.writer).await;
|
||||
target
|
||||
.sm
|
||||
.install_snapshot(&snapshot.meta, data)
|
||||
.await
|
||||
.expect("install supersedes empty baseline");
|
||||
tokio::time::timeout(std::time::Duration::from_secs(5), purge)
|
||||
.await
|
||||
.expect("empty coverage wake")
|
||||
.expect("purge task")
|
||||
.expect("new covered purge");
|
||||
assert_eq!(
|
||||
target.page().await,
|
||||
source.page().await,
|
||||
"SNAPSHOT_EMPTY_BASELINE_IS_UNCOVERED_NOT_CORRUPT"
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,371 @@
|
||||
//! Validated capture peer metadata and its independent CNOD v1 codec.
|
||||
use serde::{Deserialize, Deserializer, Serialize, Serializer, ser::SerializeStruct};
|
||||
|
||||
#[derive(Clone, Debug, Default, PartialEq, Eq)]
|
||||
pub struct CaptureNode {
|
||||
rpc_uri: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
pub enum CaptureNodeError {
|
||||
#[error("invalid RPC URI")]
|
||||
InvalidRpcUri,
|
||||
#[error("invalid RPC URI")]
|
||||
InvalidRpcUriParse(#[source] url::ParseError),
|
||||
#[error("RPC URI too long")]
|
||||
RpcUriTooLong,
|
||||
#[error("invalid node magic")]
|
||||
InvalidNodeMagic,
|
||||
#[error("unsupported node version")]
|
||||
UnsupportedNodeVersion,
|
||||
#[error("invalid node length")]
|
||||
InvalidNodeLength,
|
||||
#[error("truncated node record")]
|
||||
TruncatedNodeRecord,
|
||||
#[error("invalid node UTF-8")]
|
||||
InvalidNodeUtf8(#[source] std::str::Utf8Error),
|
||||
#[error("trailing node bytes")]
|
||||
TrailingNodeBytes,
|
||||
}
|
||||
impl CaptureNodeError {
|
||||
pub fn code(&self) -> &'static str {
|
||||
match self {
|
||||
Self::InvalidRpcUri | Self::InvalidRpcUriParse(_) => "invalid_rpc_uri",
|
||||
Self::RpcUriTooLong => "rpc_uri_too_long",
|
||||
Self::InvalidNodeMagic => "invalid_node_magic",
|
||||
Self::UnsupportedNodeVersion => "unsupported_node_version",
|
||||
Self::InvalidNodeLength => "invalid_node_length",
|
||||
Self::TruncatedNodeRecord => "truncated_node_record",
|
||||
Self::InvalidNodeUtf8(_) => "invalid_node_utf8",
|
||||
Self::TrailingNodeBytes => "trailing_node_bytes",
|
||||
}
|
||||
}
|
||||
}
|
||||
impl CaptureNode {
|
||||
pub fn new(rpc_uri: String) -> Result<Self, CaptureNodeError> {
|
||||
let node = Self { rpc_uri };
|
||||
node.validate()?;
|
||||
Ok(node)
|
||||
}
|
||||
|
||||
pub fn rpc_uri(&self) -> &str {
|
||||
&self.rpc_uri
|
||||
}
|
||||
|
||||
pub fn validate(&self) -> Result<(), CaptureNodeError> {
|
||||
let uri = &self.rpc_uri;
|
||||
if uri.len() > 4096 {
|
||||
return Err(CaptureNodeError::RpcUriTooLong);
|
||||
}
|
||||
if uri.is_empty() || uri.chars().any(|c| c.is_whitespace() || c.is_control() || c == '\\') {
|
||||
return Err(CaptureNodeError::InvalidRpcUri);
|
||||
}
|
||||
let rest = uri
|
||||
.strip_prefix("http://")
|
||||
.or_else(|| uri.strip_prefix("https://"))
|
||||
.ok_or(CaptureNodeError::InvalidRpcUri)?;
|
||||
if uri.contains('?') || uri.contains('#') {
|
||||
return Err(CaptureNodeError::InvalidRpcUri);
|
||||
}
|
||||
let (authority, path) = rest.split_once('/').map_or((rest, ""), |(a, p)| (a, p));
|
||||
// An empty suffix after the first slash is the only allowed path.
|
||||
if !path.is_empty() || authority.contains('@') {
|
||||
return Err(CaptureNodeError::InvalidRpcUri);
|
||||
}
|
||||
let (host, port) = if authority.starts_with('[') {
|
||||
let end = authority.find(']').ok_or(CaptureNodeError::InvalidRpcUri)?;
|
||||
let port = authority
|
||||
.get(end + 1..)
|
||||
.and_then(|suffix| suffix.strip_prefix(':'))
|
||||
.ok_or(CaptureNodeError::InvalidRpcUri)?;
|
||||
(&authority[..=end], port)
|
||||
} else {
|
||||
authority.split_once(':').ok_or(CaptureNodeError::InvalidRpcUri)?
|
||||
};
|
||||
if host.is_empty() || port.is_empty() || !port.bytes().all(|b| b.is_ascii_digit()) {
|
||||
return Err(CaptureNodeError::InvalidRpcUri);
|
||||
}
|
||||
let port = port.parse::<u16>().map_err(|_| CaptureNodeError::InvalidRpcUri)?;
|
||||
if port == 0 {
|
||||
return Err(CaptureNodeError::InvalidRpcUri);
|
||||
}
|
||||
let parsed_url = url::Url::parse(uri).map_err(CaptureNodeError::InvalidRpcUriParse)?;
|
||||
if parsed_url.host().is_none() {
|
||||
return Err(CaptureNodeError::InvalidRpcUri);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn encode(&self) -> Result<Vec<u8>, CaptureNodeError> {
|
||||
self.validate()?;
|
||||
let length = u32::try_from(self.rpc_uri.len()).map_err(|_| CaptureNodeError::InvalidNodeLength)?;
|
||||
let mut bytes = b"CNOD\x01".to_vec();
|
||||
bytes.extend_from_slice(&length.to_be_bytes());
|
||||
bytes.extend_from_slice(self.rpc_uri.as_bytes());
|
||||
Ok(bytes)
|
||||
}
|
||||
|
||||
pub fn decode(bytes: &[u8]) -> Result<Self, CaptureNodeError> {
|
||||
if bytes.len() < 9 {
|
||||
return Err(CaptureNodeError::TruncatedNodeRecord);
|
||||
}
|
||||
if &bytes[..4] != b"CNOD" {
|
||||
return Err(CaptureNodeError::InvalidNodeMagic);
|
||||
}
|
||||
if bytes[4] != 1 {
|
||||
return Err(CaptureNodeError::UnsupportedNodeVersion);
|
||||
}
|
||||
let length = u32::from_be_bytes(bytes[5..9].try_into().map_err(|_| CaptureNodeError::InvalidNodeLength)?);
|
||||
if !(1..=4096).contains(&length) {
|
||||
return Err(CaptureNodeError::InvalidNodeLength);
|
||||
}
|
||||
let length = usize::try_from(length).map_err(|_| CaptureNodeError::InvalidNodeLength)?;
|
||||
let end = 9_usize.checked_add(length).ok_or(CaptureNodeError::InvalidNodeLength)?;
|
||||
if bytes.len() < end {
|
||||
return Err(CaptureNodeError::TruncatedNodeRecord);
|
||||
}
|
||||
if bytes.len() != end {
|
||||
return Err(CaptureNodeError::TrailingNodeBytes);
|
||||
}
|
||||
let uri = std::str::from_utf8(&bytes[9..end]).map_err(CaptureNodeError::InvalidNodeUtf8)?;
|
||||
Self::new(uri.to_owned())
|
||||
}
|
||||
}
|
||||
impl Serialize for CaptureNode {
|
||||
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
|
||||
self.validate().map_err(serde::ser::Error::custom)?;
|
||||
let mut state = serializer.serialize_struct("CaptureNode", 1)?;
|
||||
state.serialize_field("rpc_uri", &self.rpc_uri)?;
|
||||
state.end()
|
||||
}
|
||||
}
|
||||
impl<'de> Deserialize<'de> for CaptureNode {
|
||||
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
|
||||
#[derive(Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
struct Fields {
|
||||
rpc_uri: String,
|
||||
}
|
||||
let fields = Fields::deserialize(deserializer).map_err(|_| serde::de::Error::custom("invalid capture node fields"))?;
|
||||
Self::new(fields.rpc_uri).map_err(serde::de::Error::custom)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::error::Error;
|
||||
|
||||
fn record(payload: &[u8]) -> Vec<u8> {
|
||||
let mut bytes = b"CNOD\x01".to_vec();
|
||||
bytes.extend_from_slice(&u32::try_from(payload.len()).expect("test payload length").to_be_bytes());
|
||||
bytes.extend_from_slice(payload);
|
||||
bytes
|
||||
}
|
||||
fn reject_uri(uri: &str) {
|
||||
let result = CaptureNode::new(uri.to_owned());
|
||||
assert!(result.is_err(), "URI should reject: {uri:?}");
|
||||
assert_eq!(result.expect_err("rejected URI").code(), "invalid_rpc_uri");
|
||||
}
|
||||
fn reject_record(bytes: &[u8], code: &str) {
|
||||
let result = CaptureNode::decode(bytes);
|
||||
assert!(result.is_err(), "record should reject with {code}");
|
||||
assert_eq!(result.expect_err("rejected record").code(), code);
|
||||
}
|
||||
#[test]
|
||||
fn actual_openraft_node_bound() {
|
||||
fn require_node<T: openraft::Node>() {}
|
||||
require_node::<CaptureNode>();
|
||||
assert_eq!(CaptureNode::default().rpc_uri(), "");
|
||||
}
|
||||
#[test]
|
||||
fn default_and_empty_rejected_at_every_boundary() {
|
||||
let node = CaptureNode::default();
|
||||
assert_eq!(node.rpc_uri(), "");
|
||||
reject_uri("");
|
||||
assert_eq!(node.validate().expect_err("empty validation").code(), "invalid_rpc_uri");
|
||||
assert!(serde_json::to_string(&node).is_err());
|
||||
assert!(serde_json::from_str::<CaptureNode>(r#"{"rpc_uri":""}"#).is_err());
|
||||
assert_eq!(node.encode().expect_err("empty encoding").code(), "invalid_rpc_uri");
|
||||
reject_record(&record(b""), "invalid_node_length");
|
||||
}
|
||||
#[test]
|
||||
fn accepted_uris_preserve_exact_bytes() {
|
||||
for uri in [
|
||||
"http://node:80",
|
||||
"https://node:443",
|
||||
"http://node:1",
|
||||
"https://node:65535/",
|
||||
"http://127.0.0.1:9000",
|
||||
"https://[::1]:443/",
|
||||
"http://[2001:db8::1]:1",
|
||||
"http://NoDe:00080/",
|
||||
] {
|
||||
let result = CaptureNode::new(uri.to_owned());
|
||||
assert!(result.is_ok(), "valid URI construction: {uri}");
|
||||
let node = result.expect("valid URI");
|
||||
assert_eq!(node.rpc_uri(), uri, "preserve explicit default port and raw URI");
|
||||
assert_eq!(node.encode().expect("encode URI"), record(uri.as_bytes()));
|
||||
assert_eq!(CaptureNode::decode(&record(uri.as_bytes())).expect("decode URI"), node);
|
||||
}
|
||||
}
|
||||
#[test]
|
||||
fn golden_cnod_bytes() {
|
||||
let node = CaptureNode {
|
||||
rpc_uri: "http://node:80".to_owned(),
|
||||
};
|
||||
let golden = b"CNOD\x01\x00\x00\x00\x0ehttp://node:80";
|
||||
assert_eq!(node.encode().ok().as_deref(), Some(golden.as_slice()), "golden CNOD bytes");
|
||||
}
|
||||
#[test]
|
||||
fn valid_cnod_decode() {
|
||||
let golden = b"CNOD\x01\x00\x00\x00\x0ehttp://node:80";
|
||||
let decoded = CaptureNode::decode(golden);
|
||||
assert!(decoded.is_ok(), "golden decode succeeds");
|
||||
assert_eq!(decoded.expect("golden decoded node").rpc_uri(), "http://node:80");
|
||||
}
|
||||
#[test]
|
||||
fn serde_shape_roundtrip_and_strict_fields() {
|
||||
let node = CaptureNode::new("https://node:443/".to_owned()).expect("serde node");
|
||||
let json = r#"{"rpc_uri":"https://node:443/"}"#;
|
||||
assert_eq!(serde_json::to_string(&node).expect("serialize node"), json);
|
||||
assert_eq!(serde_json::from_str::<CaptureNode>(json).expect("deserialize node"), node);
|
||||
for json in [
|
||||
r#"{}"#,
|
||||
r#"{"rpc_uri":1}"#,
|
||||
r#"{"rpc_uri":null}"#,
|
||||
r#"{"rpc_uri":"http://node:1","extra":0}"#,
|
||||
r#"{"rpc_uri":"http://node:1","rpc_uri":"http://node:2"}"#,
|
||||
] {
|
||||
assert!(serde_json::from_str::<CaptureNode>(json).is_err(), "strict fields: {json}");
|
||||
}
|
||||
}
|
||||
#[test]
|
||||
fn credentials_and_raw_uri_shapes_reject() {
|
||||
for uri in [
|
||||
"http://user@node:1",
|
||||
"http://user:password@node:1",
|
||||
"http://@node:1",
|
||||
"HTTP://node:1",
|
||||
"Https://node:1",
|
||||
"http://node",
|
||||
"http://node:",
|
||||
"http://node:0",
|
||||
"http://node:-1",
|
||||
"http://node:+1",
|
||||
"http://node:65536",
|
||||
"http://node:999999999999999999999",
|
||||
"http://[::1:1",
|
||||
"http://[::1]extra:1",
|
||||
"http://[invalid]:1",
|
||||
"http://::1:1",
|
||||
"http://:1",
|
||||
"/disk/path",
|
||||
"file:///disk/path",
|
||||
"http://node:1/./",
|
||||
"http://node:1/../",
|
||||
"http://node:1/%2e/",
|
||||
"http://node:1/%2E%2e/",
|
||||
"http://node:1/path",
|
||||
"http://node:1\\",
|
||||
" http://node:1",
|
||||
"http://node:1\n",
|
||||
"http://no\tde:1",
|
||||
"http://node:1\u{00a0}",
|
||||
"http://node:1\u{0085}",
|
||||
"http://node:1\0",
|
||||
] {
|
||||
reject_uri(uri);
|
||||
}
|
||||
}
|
||||
#[test]
|
||||
fn query_and_fragment_markers_reject() {
|
||||
for uri in [
|
||||
"http://node:1?",
|
||||
"http://node:1?x=y",
|
||||
"http://node:1/?",
|
||||
"http://node:1#",
|
||||
"http://node:1#fragment",
|
||||
"http://node:1/#",
|
||||
] {
|
||||
reject_uri(uri);
|
||||
}
|
||||
}
|
||||
#[test]
|
||||
fn utf8_byte_length_boundaries() {
|
||||
for length in [4095, 4096] {
|
||||
let prefix = "http://node:";
|
||||
let uri = format!("{prefix}{}1", "0".repeat(length - prefix.len() - 1));
|
||||
assert_eq!(uri.len(), length);
|
||||
assert!(url::Url::parse(&uri).is_ok(), "boundary fixture accepted by actual URL parser");
|
||||
let node = CaptureNode::new(uri.clone()).expect("boundary node");
|
||||
assert_eq!(node.rpc_uri(), uri);
|
||||
assert_eq!(
|
||||
CaptureNode::decode(&node.encode().expect("boundary encoding")).expect("boundary decoding"),
|
||||
node
|
||||
);
|
||||
}
|
||||
let uri = format!("http://node:{}1", "0".repeat(4097 - "http://node:".len() - 1));
|
||||
assert_eq!(CaptureNode::new(uri).expect_err("oversize URI").code(), "rpc_uri_too_long");
|
||||
let unicode = format!("http://{}:1", "é".repeat(2044));
|
||||
assert!(unicode.chars().count() < 4096);
|
||||
assert!(unicode.len() > 4096);
|
||||
assert_eq!(CaptureNode::new(unicode).expect_err("UTF-8 byte limit").code(), "rpc_uri_too_long");
|
||||
}
|
||||
#[test]
|
||||
fn cnod_headers_and_lengths_reject_exact_codes() {
|
||||
let valid = record(b"http://node:80");
|
||||
for end in 0..9 {
|
||||
reject_record(&valid[..end], "truncated_node_record");
|
||||
}
|
||||
let mut bad = valid.clone();
|
||||
bad[0] = b'X';
|
||||
reject_record(&bad, "invalid_node_magic");
|
||||
bad = valid.clone();
|
||||
bad[4] = 2;
|
||||
reject_record(&bad, "unsupported_node_version");
|
||||
for length in [0_u32, 4097, u32::MAX] {
|
||||
bad = b"CNOD\x01".to_vec();
|
||||
bad.extend_from_slice(&length.to_be_bytes());
|
||||
reject_record(&bad, "invalid_node_length");
|
||||
}
|
||||
for end in 9..valid.len() {
|
||||
reject_record(&valid[..end], "truncated_node_record");
|
||||
}
|
||||
reject_record(&record(&[0xff]), "invalid_node_utf8");
|
||||
reject_record(&record(&[0xc3, 0x28]), "invalid_node_utf8");
|
||||
reject_record(&record(b"invalid URI"), "invalid_rpc_uri");
|
||||
}
|
||||
#[test]
|
||||
fn trailing_bytes_reject() {
|
||||
for tail in [&b"x"[..], &b"xyz"[..]] {
|
||||
let mut bytes = record(b"http://node:80");
|
||||
bytes.extend_from_slice(tail);
|
||||
reject_record(&bytes, "trailing_node_bytes");
|
||||
}
|
||||
}
|
||||
#[test]
|
||||
fn errors_and_sources_redact_input() {
|
||||
let sentinel = "http://SECRET_USER:SECRET_PASSWORD@node:1";
|
||||
let error = CaptureNode::new(sentinel.to_owned()).expect_err("credentials reject");
|
||||
let mut current: &dyn Error = &error;
|
||||
loop {
|
||||
let rendered = format!("{current} {current:?}");
|
||||
assert!(!rendered.contains("SECRET"));
|
||||
match current.source() {
|
||||
Some(source) => current = source,
|
||||
None => break,
|
||||
}
|
||||
}
|
||||
let json = format!(r#"{{"rpc_uri":"{sentinel}"}}"#);
|
||||
let error = serde_json::from_str::<CaptureNode>(&json).expect_err("serde credentials reject");
|
||||
assert!(!format!("{error} {error:?}").contains("SECRET"));
|
||||
let json = format!(r#"{{"{sentinel}":0}}"#);
|
||||
let error = serde_json::from_str::<CaptureNode>(&json).expect_err("unknown fields reject");
|
||||
assert!(!format!("{error} {error:?}").contains("SECRET"));
|
||||
let error = CaptureNode::new("http://[bad]:1".to_owned()).expect_err("parser rejection");
|
||||
assert!(error.source().is_some(), "retain URL parser source");
|
||||
let error = CaptureNode::decode(&record(&[0xff])).expect_err("UTF-8 rejection");
|
||||
assert!(error.source().is_some(), "retain UTF-8 source");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,175 @@
|
||||
//! OpenRaft log storage backed by the existing native writer and local durable baseline.
|
||||
use crate::{CaptureRaftEntry, CaptureTypeConfig, NativeLogReader, NativeLogWriter, NativeWriteError, StoreError};
|
||||
use openraft::{
|
||||
LogId, OptionalSend, RaftLogReader, StorageError, StorageIOError, Vote,
|
||||
storage::{LogFlushed, RaftLogStorage},
|
||||
};
|
||||
use redb::{ReadableDatabase, ReadableTable};
|
||||
|
||||
/// Clones share one native Store, write ordering and checkpoint authority.
|
||||
#[derive(Clone)]
|
||||
pub struct NativeRaftLogStore {
|
||||
writer: NativeLogWriter,
|
||||
// Last: owner drain is signaled only after this clone releases its writer.
|
||||
pub(crate) owner_lease: Option<std::sync::Arc<crate::raft_owner::OwnerLease>>,
|
||||
}
|
||||
impl NativeRaftLogStore {
|
||||
pub fn new(writer: NativeLogWriter) -> Self {
|
||||
Self {
|
||||
writer,
|
||||
owner_lease: None,
|
||||
}
|
||||
}
|
||||
}
|
||||
fn error(error: NativeWriteError, operation: fn(openraft::AnyError) -> StorageIOError<u64>) -> StorageError<u64> {
|
||||
StorageError::IO {
|
||||
source: operation(openraft::AnyError::new(&error)),
|
||||
}
|
||||
}
|
||||
impl RaftLogReader<CaptureTypeConfig> for NativeRaftLogStore {
|
||||
async fn try_get_log_entries<RB: std::ops::RangeBounds<u64> + Clone + std::fmt::Debug + OptionalSend>(
|
||||
&mut self,
|
||||
range: RB,
|
||||
) -> Result<Vec<CaptureRaftEntry>, StorageError<u64>> {
|
||||
let mut reader = self.writer.reader();
|
||||
reader.owner_lease = self.owner_lease.clone();
|
||||
reader.try_get_log_entries(range).await
|
||||
}
|
||||
}
|
||||
impl RaftLogStorage<CaptureTypeConfig> for NativeRaftLogStore {
|
||||
type LogReader = NativeLogReader;
|
||||
async fn get_log_state(&mut self) -> Result<openraft::LogState<CaptureTypeConfig>, StorageError<u64>> {
|
||||
self.writer
|
||||
.write(|store| {
|
||||
if !store.writable {
|
||||
return Err(StoreError::WriteDisabled);
|
||||
}
|
||||
let read = store.database.begin_read()?;
|
||||
let meta = read.open_table(crate::META)?;
|
||||
let purged = crate::checkpoint_baseline::read_purged(&meta)?;
|
||||
let logs = read.open_table(crate::LOGS)?;
|
||||
let last = logs
|
||||
.last()?
|
||||
.map(|(index, value)| {
|
||||
let id = crate::decode_log(value.value())?.id;
|
||||
if id.index != index.value() {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
Ok(id)
|
||||
})
|
||||
.transpose()?
|
||||
.or(purged);
|
||||
let tail = meta.get("tail")?.map(|value| crate::decode_id(value.value())).transpose()?;
|
||||
if tail != last {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
Ok(openraft::LogState {
|
||||
last_purged_log_id: purged.map(Into::into),
|
||||
last_log_id: last.map(Into::into),
|
||||
})
|
||||
})
|
||||
.await
|
||||
.map_err(|e| error(e, StorageIOError::read_logs))
|
||||
}
|
||||
async fn get_log_reader(&mut self) -> Self::LogReader {
|
||||
let mut reader = self.writer.reader();
|
||||
reader.owner_lease = self.owner_lease.clone();
|
||||
reader
|
||||
}
|
||||
async fn save_vote(&mut self, vote: &Vote<u64>) -> Result<(), StorageError<u64>> {
|
||||
self.writer
|
||||
.save_vote(*vote)
|
||||
.await
|
||||
.map_err(|e| error(e, StorageIOError::write_vote))
|
||||
}
|
||||
async fn read_vote(&mut self) -> Result<Option<Vote<u64>>, StorageError<u64>> {
|
||||
self.writer.read_vote().await.map_err(|e| error(e, StorageIOError::read_vote))
|
||||
}
|
||||
async fn save_committed(&mut self, committed: Option<LogId<u64>>) -> Result<(), StorageError<u64>> {
|
||||
self.writer
|
||||
.write(move |store| match committed {
|
||||
Some(id) => store.save_committed(id.into()),
|
||||
None if store.read_committed()?.is_none() => Ok(()),
|
||||
None => Err(StoreError::CommittedRegression),
|
||||
})
|
||||
.await
|
||||
.map_err(|e| error(e, StorageIOError::write_logs))
|
||||
}
|
||||
async fn read_committed(&mut self) -> Result<Option<LogId<u64>>, StorageError<u64>> {
|
||||
self.writer
|
||||
.write(|store| store.read_committed().map(|id| id.map(Into::into)))
|
||||
.await
|
||||
.map_err(|e| error(e, StorageIOError::read_logs))
|
||||
}
|
||||
async fn append<I>(&mut self, entries: I, callback: LogFlushed<CaptureTypeConfig>) -> Result<(), StorageError<u64>>
|
||||
where
|
||||
I: IntoIterator<Item = CaptureRaftEntry> + OptionalSend,
|
||||
I::IntoIter: OptionalSend,
|
||||
{
|
||||
let entries = entries.into_iter().collect::<Vec<_>>();
|
||||
// The original blocking worker owns ordering and callback through durable commit,
|
||||
// even if OpenRaft cancels its awaiting append future.
|
||||
self.writer
|
||||
.write(move |store| {
|
||||
let result = store.append_native(&entries);
|
||||
callback.log_io_completed(
|
||||
result
|
||||
.as_ref()
|
||||
.map(|_| ())
|
||||
.map_err(|error| std::io::Error::other(error.code())),
|
||||
);
|
||||
result
|
||||
})
|
||||
.await
|
||||
.map_err(|e| error(e, StorageIOError::write_logs))
|
||||
}
|
||||
async fn truncate(&mut self, log_id: LogId<u64>) -> Result<(), StorageError<u64>> {
|
||||
self.writer
|
||||
.truncate_suffix(log_id.index)
|
||||
.await
|
||||
.map_err(|e| error(e, StorageIOError::write_logs))
|
||||
}
|
||||
async fn purge(&mut self, log_id: LogId<u64>) -> Result<(), StorageError<u64>> {
|
||||
let deadline = tokio::time::Instant::now() + std::time::Duration::from_secs(30);
|
||||
loop {
|
||||
if tokio::time::Instant::now() >= deadline {
|
||||
return Err(error(NativeWriteError::Store(StoreError::StaleCheckpoint), StorageIOError::write_logs));
|
||||
}
|
||||
let notified = self.writer.snapshot_receives.changed.notified();
|
||||
tokio::pin!(notified);
|
||||
notified.as_mut().enable();
|
||||
let receives = self.writer.snapshot_receives.clone();
|
||||
// Observe coverage and receive ownership while install is excluded by ordering.
|
||||
let (result, pending) = self
|
||||
.writer
|
||||
.write(move |store| Ok((store.purge_native_prefix(log_id.into(), None), receives.pending())))
|
||||
.await
|
||||
.map_err(|e| error(e, StorageIOError::write_logs))?;
|
||||
if matches!(&result, Err(StoreError::StaleCheckpoint)) {
|
||||
#[cfg(test)]
|
||||
{
|
||||
let hook = self
|
||||
.writer
|
||||
.snapshot_receives
|
||||
.purge_recheck
|
||||
.lock()
|
||||
.expect("test hook lock")
|
||||
.take();
|
||||
if let Some((entered, resume)) = hook {
|
||||
entered.notify_one();
|
||||
resume.notified().await;
|
||||
}
|
||||
}
|
||||
if pending {
|
||||
#[cfg(test)]
|
||||
let _waiter = crate::raft_state_machine::Waiter::new(self.writer.snapshot_receives.clone());
|
||||
if tokio::time::timeout_at(deadline, notified).await.is_err() {
|
||||
return Err(error(NativeWriteError::Store(StoreError::StaleCheckpoint), StorageIOError::write_logs));
|
||||
}
|
||||
continue;
|
||||
}
|
||||
}
|
||||
return result.map_err(|e| error(e.into(), StorageIOError::write_logs));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,439 @@
|
||||
//! Exercises actual OpenRaft storage traits, not a substitute consensus engine.
|
||||
use super::*;
|
||||
use openraft::{
|
||||
RaftLogReader,
|
||||
storage::{RaftLogStorage, RaftLogStorageExt},
|
||||
};
|
||||
use std::collections::{BTreeMap, BTreeSet};
|
||||
|
||||
fn identity() -> NodeIdentity {
|
||||
NodeIdentity {
|
||||
cluster_id: [7; 16],
|
||||
node_id: 0,
|
||||
}
|
||||
}
|
||||
fn binding() -> CaptureBinding {
|
||||
CaptureBinding {
|
||||
revision: 9,
|
||||
binding_id: [8; 16],
|
||||
target_id: [9; 16],
|
||||
}
|
||||
}
|
||||
fn id(index: u64) -> LogId {
|
||||
LogId {
|
||||
term: 8,
|
||||
leader_node: 0,
|
||||
index,
|
||||
}
|
||||
}
|
||||
fn entry(index: u64) -> CaptureRaftEntry {
|
||||
let payload = if index == 0 {
|
||||
let membership = CaptureMembership::new(
|
||||
Some(id(0)),
|
||||
vec![BTreeSet::from([0])],
|
||||
BTreeMap::from([(0, CaptureNode::new("http://127.0.0.1:7000".into()).expect("test member"))]),
|
||||
)
|
||||
.expect("native membership");
|
||||
let membership = openraft::StoredMembership::try_from(&membership).expect("stored native membership");
|
||||
openraft::EntryPayload::Membership(membership.membership().clone())
|
||||
} else {
|
||||
let byte = u8::try_from(index).expect("small test event index");
|
||||
let command = DecideCreated {
|
||||
operation_id: [byte; 16],
|
||||
object: ObjectIdentity {
|
||||
bucket_incarnation: [2; 16],
|
||||
key: vec![byte],
|
||||
},
|
||||
expected_head: None,
|
||||
prepared: PreparedIdentity {
|
||||
version_id: [byte; 16],
|
||||
preparation_id: [4; 16],
|
||||
content_digest: [5; 32],
|
||||
content_length: 123,
|
||||
},
|
||||
binding_revision: binding().revision,
|
||||
};
|
||||
openraft::EntryPayload::Normal(CaptureCommand::try_created(command).expect("native test command"))
|
||||
};
|
||||
CaptureRaftEntry {
|
||||
log_id: id(index).into(),
|
||||
payload,
|
||||
}
|
||||
}
|
||||
fn entries(end: u64) -> Vec<CaptureRaftEntry> {
|
||||
(0..=end).map(entry).collect()
|
||||
}
|
||||
fn fixture() -> (tempfile::TempDir, NativeLogWriter, NativeRaftLogStore) {
|
||||
let directory = tempfile::tempdir().expect("actual native database directory");
|
||||
let mut store = Store::initialize(directory.path().join("db"), identity()).expect("actual redb initialization");
|
||||
store.pin_capture_binding(binding()).expect("capture binding");
|
||||
store.enable_native_empty().expect("native mode");
|
||||
store.promote_created_provenance().expect("native provenance");
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let adapter = NativeRaftLogStore::new(writer.clone());
|
||||
(directory, writer, adapter)
|
||||
}
|
||||
fn media_fixture() -> (tempfile::TempDir, tests::CrashBackend, NativeLogWriter, NativeRaftLogStore) {
|
||||
let (directory, writer, adapter) = fixture();
|
||||
drop(adapter);
|
||||
drop(writer);
|
||||
let backend = tests::CrashBackend::new(&directory.path().join("db"));
|
||||
let store = Store::from_database(backend.database(), identity()).expect("existing real disk fault backend");
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let adapter = NativeRaftLogStore::new(writer.clone());
|
||||
(directory, backend, writer, adapter)
|
||||
}
|
||||
async fn logs(adapter: &mut NativeRaftLogStore) -> Vec<CaptureRaftEntry> {
|
||||
adapter
|
||||
.get_log_reader()
|
||||
.await
|
||||
.try_get_log_entries(..)
|
||||
.await
|
||||
.expect("actual trait reader")
|
||||
}
|
||||
async fn checkpoint(writer: &NativeLogWriter, adapter: &mut NativeRaftLogStore) -> CheckpointReceipt {
|
||||
let batch = entries(2);
|
||||
adapter
|
||||
.blocking_append(batch.clone())
|
||||
.await
|
||||
.expect("trait append before checkpoint");
|
||||
// Prepares genuine applied/checkpoint evidence; this does not claim Raft consensus.
|
||||
writer
|
||||
.apply_committed(batch)
|
||||
.await
|
||||
.expect("trusted test owner applies preparation entries");
|
||||
writer
|
||||
.checkpoint_local(CheckpointLimits::default())
|
||||
.await
|
||||
.expect("real durable baseline")
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_log_storage_flush_restart() {
|
||||
let (directory, backend, writer, mut adapter) = media_fixture();
|
||||
let batch = entries(2);
|
||||
// blocking_append constructs the real library-private LogFlushed callback.
|
||||
adapter
|
||||
.blocking_append(batch.clone())
|
||||
.await
|
||||
.expect("real durable flush callback");
|
||||
let state = adapter.get_log_state().await.expect("trait log state");
|
||||
assert_eq!(state.last_log_id, Some(id(2).into()), "RAFT_LOG_TAIL_NOT_APPLIED_STATE");
|
||||
assert_eq!(state.last_purged_log_id, None);
|
||||
assert_eq!(writer.applied_state().await.expect("application state").0, None);
|
||||
assert_eq!(logs(&mut adapter).await, batch);
|
||||
backend.cut();
|
||||
drop(adapter);
|
||||
drop(writer);
|
||||
let reopened = Store::open(directory.path().join("db"), identity()).expect("reopen after successful callback and power cut");
|
||||
let mut adapter = NativeRaftLogStore::new(NativeLogWriter::new(reopened));
|
||||
assert_eq!(logs(&mut adapter).await, batch, "RAFT_LOG_FLUSH_CALLBACK_DURABLE");
|
||||
assert_eq!(
|
||||
adapter.get_log_state().await.expect("reopened trait state").last_log_id,
|
||||
Some(id(2).into())
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_log_storage_vote_restart() {
|
||||
let (directory, backend, writer, mut adapter) = media_fixture();
|
||||
let vote = openraft::Vote::new_committed(9, 0);
|
||||
adapter.save_vote(&vote).await.expect("trait durable vote");
|
||||
assert_eq!(adapter.read_vote().await.expect("trait vote read"), Some(vote));
|
||||
adapter.blocking_append(entries(2)).await.expect("trait append");
|
||||
adapter
|
||||
.save_committed(Some(id(1).into()))
|
||||
.await
|
||||
.expect("trait durable commit marker");
|
||||
assert!(adapter.save_committed(None).await.is_err(), "RAFT_LOG_COMMITTED_NONE_CANNOT_RESET");
|
||||
assert_eq!(adapter.read_committed().await.expect("exact marker"), Some(id(1).into()));
|
||||
assert!(
|
||||
adapter.save_committed(Some(id(0).into())).await.is_err(),
|
||||
"RAFT_LOG_COMMITTED_NO_REGRESSION"
|
||||
);
|
||||
let mut wrong = id(2);
|
||||
wrong.term += 1;
|
||||
assert!(
|
||||
adapter.save_committed(Some(wrong.into())).await.is_err(),
|
||||
"RAFT_LOG_COMMITTED_EXACT_IDENTITY"
|
||||
);
|
||||
backend.cut();
|
||||
drop(adapter);
|
||||
drop(writer);
|
||||
let mut reopened = NativeRaftLogStore::new(NativeLogWriter::new(
|
||||
Store::open(directory.path().join("db"), identity()).expect("durable vote reopen"),
|
||||
));
|
||||
assert_eq!(
|
||||
reopened.read_vote().await.expect("reopened vote"),
|
||||
Some(vote),
|
||||
"RAFT_LOG_VOTE_ACK_DURABLE"
|
||||
);
|
||||
assert_eq!(reopened.read_committed().await.expect("reopened committed marker"), Some(id(1).into()));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_log_storage_partial_purge_restart() {
|
||||
let (directory, writer, mut adapter) = fixture();
|
||||
let receipt = checkpoint(&writer, &mut adapter).await;
|
||||
adapter
|
||||
.blocking_append(vec![entry(3), entry(4)])
|
||||
.await
|
||||
.expect("uncovered suffix append");
|
||||
let events = writer
|
||||
.created_events_page(None, 256)
|
||||
.await
|
||||
.expect("pre-purge authoritative events");
|
||||
adapter
|
||||
.purge(id(1).into())
|
||||
.await
|
||||
.expect("checkpoint authorizes strict prefix");
|
||||
assert_eq!(
|
||||
logs(&mut adapter).await,
|
||||
vec![entry(2), entry(3), entry(4)],
|
||||
"RAFT_LOG_PARTIAL_PURGE_RETAINS_SUFFIX"
|
||||
);
|
||||
let state = adapter.get_log_state().await.expect("partially purged state");
|
||||
assert_eq!(state.last_purged_log_id, Some(id(1).into()));
|
||||
assert_eq!(state.last_log_id, Some(id(4).into()));
|
||||
adapter.purge(id(1).into()).await.expect("repeat exact purge is idempotent");
|
||||
assert!(adapter.purge(id(0).into()).await.is_err(), "RAFT_LOG_PURGE_NO_REGRESSION");
|
||||
{
|
||||
let store = writer.store.lock().expect("inspect task-owned store");
|
||||
let tx = store.database.begin_read().expect("real persisted prefix inspection");
|
||||
let results = tx.open_table(application::APPLY_RESULTS).expect("apply receipts");
|
||||
assert!(results.get(0).expect("membership receipt").is_none());
|
||||
assert!(results.get(1).expect("first receipt").is_none());
|
||||
assert!(
|
||||
results.get(2).expect("retained receipt").is_some(),
|
||||
"RAFT_LOG_PARTIAL_PURGE_RECEIPT_SUFFIX"
|
||||
);
|
||||
}
|
||||
drop(adapter);
|
||||
drop(writer);
|
||||
let writer = NativeLogWriter::new(Store::open(directory.path().join("db"), identity()).expect("restart partial purge"));
|
||||
let mut adapter = NativeRaftLogStore::new(writer.clone());
|
||||
assert_eq!(
|
||||
logs(&mut adapter).await,
|
||||
vec![entry(2), entry(3), entry(4)],
|
||||
"RAFT_LOG_PARTIAL_PURGE_REOPEN"
|
||||
);
|
||||
adapter
|
||||
.blocking_append(vec![entry(5)])
|
||||
.await
|
||||
.expect("continue append after partial purge");
|
||||
writer
|
||||
.apply_committed(vec![entry(3), entry(4), entry(5)])
|
||||
.await
|
||||
.expect("continue application from true applied state");
|
||||
assert_eq!(
|
||||
writer
|
||||
.created_events_page(None, 256)
|
||||
.await
|
||||
.expect("retained plus new events")
|
||||
.events
|
||||
.len(),
|
||||
5,
|
||||
"RAFT_LOG_PURGE_NEVER_DELETES_EVENTS"
|
||||
);
|
||||
writer
|
||||
.purge_checkpoint(&receipt)
|
||||
.await
|
||||
.expect("existing exact receipt API remains compatible after partial purge");
|
||||
assert_eq!(
|
||||
adapter
|
||||
.get_log_state()
|
||||
.await
|
||||
.expect("exact compatibility state")
|
||||
.last_purged_log_id,
|
||||
Some(id(2).into())
|
||||
);
|
||||
assert_eq!(logs(&mut adapter).await, vec![entry(3), entry(4), entry(5)]);
|
||||
assert_eq!(
|
||||
writer
|
||||
.created_events_page(None, 2)
|
||||
.await
|
||||
.expect("original events retained")
|
||||
.events,
|
||||
events.events
|
||||
);
|
||||
drop(adapter);
|
||||
drop(writer);
|
||||
let mut reopened = NativeRaftLogStore::new(NativeLogWriter::new(
|
||||
Store::open(directory.path().join("db"), identity()).expect("reopen continued apply and exact purge"),
|
||||
));
|
||||
assert_eq!(logs(&mut reopened).await, vec![entry(3), entry(4), entry(5)]);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_log_storage_purge_rejects_uncovered() {
|
||||
let (directory, writer, mut adapter) = fixture();
|
||||
adapter
|
||||
.blocking_append(entries(2))
|
||||
.await
|
||||
.expect("trait append without snapshot authority");
|
||||
writer
|
||||
.apply_committed(entries(2))
|
||||
.await
|
||||
.expect("applied preparation without checkpoint");
|
||||
let before = std::fs::read(directory.path().join("db")).expect("stable pre-rejection bytes");
|
||||
assert!(
|
||||
adapter.purge(id(1).into()).await.is_err(),
|
||||
"PURGE_REQUIRES_CHECKPOINT_COVERAGE: application progress is not a durable checkpoint"
|
||||
);
|
||||
assert_eq!(
|
||||
std::fs::read(directory.path().join("db")).expect("rejected purge bytes"),
|
||||
before,
|
||||
"RAFT_LOG_UNAUTHORIZED_PURGE_NO_MUTATION"
|
||||
);
|
||||
writer
|
||||
.checkpoint_local(CheckpointLimits::default())
|
||||
.await
|
||||
.expect("checkpoint at applied cut 2");
|
||||
adapter
|
||||
.blocking_append(vec![entry(3)])
|
||||
.await
|
||||
.expect("log beyond checkpoint cut");
|
||||
let before = std::fs::read(directory.path().join("db")).expect("post-checkpoint bytes");
|
||||
assert!(
|
||||
adapter.purge(id(3).into()).await.is_err(),
|
||||
"PURGE_REQUIRES_CHECKPOINT_COVERAGE: retained target exceeds durable cut"
|
||||
);
|
||||
assert_eq!(
|
||||
std::fs::read(directory.path().join("db")).expect("uncovered target rejection bytes"),
|
||||
before,
|
||||
"RAFT_LOG_UNCOVERED_PURGE_NO_MUTATION"
|
||||
);
|
||||
assert_eq!(logs(&mut adapter).await, entries(3));
|
||||
assert_eq!(adapter.get_log_state().await.expect("unchanged marker").last_purged_log_id, None);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_log_storage_purge_identity() {
|
||||
let (directory, writer, mut adapter) = fixture();
|
||||
checkpoint(&writer, &mut adapter).await;
|
||||
for target in [
|
||||
LogId { term: 9, ..id(1) },
|
||||
LogId { leader_node: 1, ..id(1) },
|
||||
LogId { term: 9, ..id(2) },
|
||||
] {
|
||||
let before = std::fs::read(directory.path().join("db")).expect("before wrong complete LogId");
|
||||
assert!(adapter.purge(target.into()).await.is_err(), "RAFT_LOG_PURGE_EXACT_LOG_ID");
|
||||
assert_eq!(std::fs::read(directory.path().join("db")).expect("after identity rejection"), before);
|
||||
}
|
||||
adapter.purge(id(1).into()).await.expect("valid identity");
|
||||
let mut wrong = id(1);
|
||||
wrong.term += 1;
|
||||
assert!(adapter.purge(wrong.into()).await.is_err(), "RAFT_LOG_PURGED_REPEAT_IDENTITY_BOUND");
|
||||
assert_eq!(
|
||||
adapter
|
||||
.get_log_state()
|
||||
.await
|
||||
.expect("unchanged identity marker")
|
||||
.last_purged_log_id,
|
||||
Some(id(1).into())
|
||||
);
|
||||
adapter.purge(id(2).into()).await.expect("final exact covered target");
|
||||
let state = adapter.get_log_state().await.expect("no remaining logs");
|
||||
assert_eq!(state.last_purged_log_id, Some(id(2).into()));
|
||||
assert_eq!(state.last_log_id, Some(id(2).into()), "RAFT_LOG_EMPTY_TAIL_USES_PURGED_LOG_ID");
|
||||
assert!(logs(&mut adapter).await.is_empty());
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||
async fn raft_log_storage_cancelled_append() {
|
||||
let (directory, backend, writer, adapter) = media_fixture();
|
||||
let (entered, resume) = backend.pause_sync(1, false);
|
||||
let mut first = adapter.clone();
|
||||
let task = tokio::spawn(async move { first.blocking_append(entries(2)).await });
|
||||
entered.wait(); // Actual redb commit has begun but its first sync is paused.
|
||||
assert!(!task.is_finished(), "RAFT_LOG_FLUSH_NOT_BEFORE_DURABILITY");
|
||||
task.abort();
|
||||
assert!(task.await.expect_err("cancelled blocking append waiter").is_cancelled());
|
||||
assert!(writer.ordering.try_lock().is_err(), "RAFT_LOG_CANCELLED_APPEND_RETAINS_ORDERING_OWNER");
|
||||
let mut following = adapter.clone();
|
||||
let next = tokio::spawn(async move { following.blocking_append(vec![entry(3)]).await });
|
||||
assert!(writer.ordering.try_lock().is_err(), "RAFT_LOG_NEXT_APPEND_CANNOT_BYPASS_PENDING_SYNC");
|
||||
resume.wait();
|
||||
next.await.expect("next trait append task").expect("ordered follow-up append");
|
||||
let mut adapter = adapter;
|
||||
assert_eq!(
|
||||
logs(&mut adapter).await,
|
||||
entries(3),
|
||||
"RAFT_LOG_CANCELLED_WAITER_BACKGROUND_COMMIT_COMPLETE"
|
||||
);
|
||||
backend.cut();
|
||||
drop(adapter);
|
||||
drop(writer);
|
||||
let mut reopened = NativeRaftLogStore::new(NativeLogWriter::new(
|
||||
Store::open(directory.path().join("db"), identity()).expect("reopen cancelled waiter background commit"),
|
||||
));
|
||||
assert_eq!(logs(&mut reopened).await, entries(3));
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||
async fn raft_log_storage_failed_append() {
|
||||
let (directory, backend, writer, adapter) = media_fixture();
|
||||
let (entered, resume) = backend.pause_sync(1, false);
|
||||
let mut appending = adapter.clone();
|
||||
let task = tokio::spawn(async move { appending.blocking_append(entries(2)).await });
|
||||
entered.wait();
|
||||
assert!(!task.is_finished(), "RAFT_LOG_FAILED_FLUSH_NOT_EARLY_SUCCESS");
|
||||
backend.cut();
|
||||
resume.wait();
|
||||
assert!(
|
||||
task.await.expect("failed actual trait append task").is_err(),
|
||||
"RAFT_LOG_FAILED_APPEND_NEVER_REPORTS_CALLBACK_SUCCESS"
|
||||
);
|
||||
let mut adapter = adapter;
|
||||
assert!(
|
||||
adapter.blocking_append(entries(2)).await.is_err(),
|
||||
"RAFT_LOG_INDETERMINATE_STORE_REJECTS_LATER_APPEND"
|
||||
);
|
||||
assert!(
|
||||
adapter.save_vote(&openraft::Vote::new_committed(9, 0)).await.is_err(),
|
||||
"RAFT_LOG_INDETERMINATE_STORE_REJECTS_LATER_VOTE"
|
||||
);
|
||||
drop(adapter);
|
||||
drop(writer);
|
||||
let mut reopened = NativeRaftLogStore::new(NativeLogWriter::new(
|
||||
Store::open(directory.path().join("db"), identity()).expect("reopen failed-before-first-sync append"),
|
||||
));
|
||||
assert!(logs(&mut reopened).await.is_empty(), "RAFT_LOG_FAILURE_NO_PARTIAL_BATCH");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_log_storage_truncate_uncommitted_suffix() {
|
||||
let (directory, writer, mut adapter) = fixture();
|
||||
adapter.blocking_append(entries(4)).await.expect("trait append full log");
|
||||
adapter
|
||||
.save_committed(Some(id(2).into()))
|
||||
.await
|
||||
.expect("protect committed prefix");
|
||||
assert!(
|
||||
adapter.truncate(id(2).into()).await.is_err(),
|
||||
"RAFT_LOG_TRUNCATE_PROTECTS_COMMITTED_PREFIX"
|
||||
);
|
||||
adapter
|
||||
.truncate(id(3).into())
|
||||
.await
|
||||
.expect("truncate includes uncommitted target");
|
||||
assert_eq!(logs(&mut adapter).await, entries(2), "RAFT_LOG_TRUNCATE_INCLUSIVE");
|
||||
let mut replacement = entry(3);
|
||||
replacement.log_id = LogId { term: 9, ..id(3) }.into();
|
||||
adapter
|
||||
.blocking_append(vec![replacement.clone()])
|
||||
.await
|
||||
.expect("trait append replacement suffix");
|
||||
assert_eq!(
|
||||
adapter.get_log_state().await.expect("replacement tail").last_log_id,
|
||||
Some(replacement.log_id)
|
||||
);
|
||||
drop(adapter);
|
||||
drop(writer);
|
||||
let mut reopened = NativeRaftLogStore::new(NativeLogWriter::new(
|
||||
Store::open(directory.path().join("db"), identity()).expect("reopen truncate and replacement"),
|
||||
));
|
||||
let mut expected = entries(2);
|
||||
expected.push(replacement);
|
||||
assert_eq!(logs(&mut reopened).await, expected);
|
||||
}
|
||||
@@ -0,0 +1,251 @@
|
||||
//! Explicit lifecycle for real OpenRaft over one durable native capture owner.
|
||||
use crate::{
|
||||
CaptureCommand, CaptureNode, CaptureNodeError, CaptureTypeConfig, CheckpointLimits, NativeLogWriter, NativeRaftLogStore,
|
||||
NativeRaftStateMachine, NativeSnapshotError, NativeWriteError, StoreError,
|
||||
};
|
||||
use openraft::{
|
||||
Config, ConfigError, Raft, RaftMetrics, RaftNetworkFactory,
|
||||
error::{ClientWriteError, Fatal, InitializeError, RaftError},
|
||||
raft::ClientWriteResponse,
|
||||
};
|
||||
use redb::ReadableDatabase;
|
||||
use std::{
|
||||
collections::BTreeMap,
|
||||
sync::{
|
||||
Arc,
|
||||
atomic::{AtomicBool, Ordering},
|
||||
},
|
||||
};
|
||||
use tokio::sync::watch;
|
||||
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
pub enum NativeRaftOwnerError {
|
||||
#[error(transparent)]
|
||||
Config(#[from] Box<ConfigError>),
|
||||
#[error(transparent)]
|
||||
Store(#[from] NativeWriteError),
|
||||
#[error(transparent)]
|
||||
Snapshot(#[from] NativeSnapshotError),
|
||||
#[error("runtime node ID {runtime} differs from durable node ID {durable}")]
|
||||
IdentityMismatch { runtime: u64, durable: u64 },
|
||||
#[error("bootstrap must contain the local node")]
|
||||
MissingLocalMember,
|
||||
#[error(transparent)]
|
||||
Node(#[from] CaptureNodeError),
|
||||
#[error("native Raft owner is stopping or stopped")]
|
||||
Stopped,
|
||||
#[error(transparent)]
|
||||
Fatal(Box<Fatal<u64>>),
|
||||
#[error(transparent)]
|
||||
Initialize(Box<RaftError<u64, InitializeError<u64, CaptureNode>>>),
|
||||
#[error(transparent)]
|
||||
Write(Box<RaftError<u64, ClientWriteError<u64, CaptureNode>>>),
|
||||
#[error("native Raft shutdown task failed")]
|
||||
Shutdown(#[source] tokio::task::JoinError),
|
||||
#[cfg(any(target_os = "linux", target_os = "macos"))]
|
||||
#[error(transparent)]
|
||||
Reader(#[from] crate::source_reader::ReaderError),
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
struct DrainState {
|
||||
complete: AtomicBool,
|
||||
changed: tokio::sync::Notify,
|
||||
#[cfg(test)]
|
||||
waiters: Arc<std::sync::atomic::AtomicUsize>,
|
||||
}
|
||||
impl DrainState {
|
||||
async fn wait(&self) {
|
||||
#[cfg(test)]
|
||||
let _waiter = DrainWaiter::new(self.waiters.clone());
|
||||
loop {
|
||||
let notified = self.changed.notified();
|
||||
tokio::pin!(notified);
|
||||
notified.as_mut().enable();
|
||||
if self.complete.load(Ordering::Acquire) {
|
||||
return;
|
||||
}
|
||||
notified.await;
|
||||
}
|
||||
}
|
||||
}
|
||||
#[cfg(test)]
|
||||
struct DrainWaiter(Arc<std::sync::atomic::AtomicUsize>);
|
||||
#[cfg(test)]
|
||||
impl DrainWaiter {
|
||||
fn new(waiters: Arc<std::sync::atomic::AtomicUsize>) -> Self {
|
||||
waiters.fetch_add(1, Ordering::AcqRel);
|
||||
Self(waiters)
|
||||
}
|
||||
}
|
||||
#[cfg(test)]
|
||||
impl Drop for DrainWaiter {
|
||||
fn drop(&mut self) {
|
||||
self.0.fetch_sub(1, Ordering::AcqRel);
|
||||
}
|
||||
}
|
||||
|
||||
// The real worker, snapshot builders and replication readers share this one lease.
|
||||
// Its final drop runs after their NativeLogWriter fields have been released.
|
||||
pub(crate) struct OwnerLease {
|
||||
drain: Arc<DrainState>,
|
||||
}
|
||||
impl Drop for OwnerLease {
|
||||
fn drop(&mut self) {
|
||||
self.drain.complete.store(true, Ordering::Release);
|
||||
self.drain.changed.notify_waiters();
|
||||
}
|
||||
}
|
||||
|
||||
/// A lifecycle owner, not a transport. All storage adapters share its original writer.
|
||||
pub struct NativeRaftOwner {
|
||||
raft: Raft<CaptureTypeConfig>,
|
||||
writer: NativeLogWriter,
|
||||
identity: crate::NodeIdentity,
|
||||
accepting: AtomicBool,
|
||||
drain: Arc<DrainState>,
|
||||
#[cfg(test)]
|
||||
pub(crate) snapshot_build_pause: Arc<crate::raft_state_machine::TestPause>,
|
||||
}
|
||||
impl NativeRaftOwner {
|
||||
pub async fn start<N>(
|
||||
writer: NativeLogWriter,
|
||||
node_id: u64,
|
||||
config: Arc<Config>,
|
||||
limits: CheckpointLimits,
|
||||
network: N,
|
||||
) -> Result<Self, NativeRaftOwnerError>
|
||||
where
|
||||
N: RaftNetworkFactory<CaptureTypeConfig>,
|
||||
{
|
||||
// All operator-input checks precede Raft::new and its background workers.
|
||||
let config = Arc::new(
|
||||
(*config)
|
||||
.clone()
|
||||
.validate()
|
||||
.map_err(|error| NativeRaftOwnerError::Config(Box::new(error)))?,
|
||||
);
|
||||
let mut state_machine = NativeRaftStateMachine::new(writer.clone(), limits)?;
|
||||
let identity = writer
|
||||
.write(|store| {
|
||||
if !store.writable {
|
||||
return Err(StoreError::WriteDisabled);
|
||||
}
|
||||
let transaction = store.database.begin_read()?;
|
||||
let meta = transaction.open_table(crate::META)?;
|
||||
crate::application::native_application_state(&transaction)?;
|
||||
crate::application::read_binding(&meta)?;
|
||||
crate::decode_identity(meta.get("identity")?.ok_or(StoreError::CorruptRecord)?.value())
|
||||
})
|
||||
.await?;
|
||||
if identity.node_id != node_id {
|
||||
return Err(NativeRaftOwnerError::IdentityMismatch {
|
||||
runtime: node_id,
|
||||
durable: identity.node_id,
|
||||
});
|
||||
}
|
||||
let drain = Arc::new(DrainState::default());
|
||||
let lease = Arc::new(OwnerLease { drain: drain.clone() });
|
||||
state_machine.owner_lease = Some(lease.clone());
|
||||
let mut logs = NativeRaftLogStore::new(writer.clone());
|
||||
logs.owner_lease = Some(lease);
|
||||
#[cfg(test)]
|
||||
let snapshot_build_pause = state_machine.build_before_ordering.clone();
|
||||
let raft = Raft::new(node_id, config, network, logs, state_machine)
|
||||
.await
|
||||
.map_err(|error| NativeRaftOwnerError::Fatal(Box::new(error)))?;
|
||||
Ok(Self {
|
||||
raft,
|
||||
writer,
|
||||
identity,
|
||||
accepting: AtomicBool::new(true),
|
||||
drain,
|
||||
#[cfg(test)]
|
||||
snapshot_build_pause,
|
||||
})
|
||||
}
|
||||
|
||||
/// Identity read from durable META and checked before starting this owner.
|
||||
pub fn identity(&self) -> crate::NodeIdentity {
|
||||
self.identity
|
||||
}
|
||||
|
||||
fn require_running(&self) -> Result<(), NativeRaftOwnerError> {
|
||||
if self.accepting.load(Ordering::Acquire) {
|
||||
Ok(())
|
||||
} else {
|
||||
Err(NativeRaftOwnerError::Stopped)
|
||||
}
|
||||
}
|
||||
|
||||
/// Only explicit first-cluster formation calls initialize; start never does.
|
||||
pub async fn bootstrap(&self, members: BTreeMap<u64, CaptureNode>) -> Result<(), NativeRaftOwnerError> {
|
||||
self.require_running()?;
|
||||
if !members.contains_key(&self.identity.node_id) {
|
||||
return Err(NativeRaftOwnerError::MissingLocalMember);
|
||||
}
|
||||
for node in members.values() {
|
||||
node.validate()?;
|
||||
}
|
||||
self.raft
|
||||
.initialize(members)
|
||||
.await
|
||||
.map_err(|error| NativeRaftOwnerError::Initialize(Box::new(error)))
|
||||
}
|
||||
|
||||
/// The returned LogId and application response come from actual consensus apply.
|
||||
pub async fn client_write(
|
||||
&self,
|
||||
command: CaptureCommand,
|
||||
) -> Result<ClientWriteResponse<CaptureTypeConfig>, NativeRaftOwnerError> {
|
||||
self.require_running()?;
|
||||
self.raft
|
||||
.client_write(command)
|
||||
.await
|
||||
.map_err(|error| NativeRaftOwnerError::Write(Box::new(error)))
|
||||
}
|
||||
|
||||
/// Re-read an exact successful first decision from this owner's durable view.
|
||||
/// Use the Created result's decision LogId, not an idempotent retry entry's outer LogId.
|
||||
pub async fn authorize_created(
|
||||
&self,
|
||||
expected: crate::DecideCreated,
|
||||
expected_decision: crate::LogId,
|
||||
) -> Result<crate::CommittedCreatedAuthorization, NativeRaftOwnerError> {
|
||||
self.require_running()?;
|
||||
Ok(self.writer.authorize_created(expected, expected_decision).await?)
|
||||
}
|
||||
|
||||
pub fn metrics(&self) -> watch::Receiver<RaftMetrics<u64, CaptureNode>> {
|
||||
self.raft.metrics()
|
||||
}
|
||||
|
||||
/// Transport registration only; raw clones remain trusted caller-owned handles.
|
||||
pub fn raft(&self) -> &Raft<CaptureTypeConfig> {
|
||||
&self.raft
|
||||
}
|
||||
|
||||
/// The caller owns serve/shutdown and must drain it before releasing the Store.
|
||||
#[cfg(any(target_os = "linux", target_os = "macos"))]
|
||||
pub fn bind_reader(
|
||||
&self,
|
||||
path: impl AsRef<std::path::Path>,
|
||||
) -> Result<(crate::source_reader::SourceReaderServer, crate::source_reader::Shutdown), NativeRaftOwnerError> {
|
||||
self.require_running()?;
|
||||
Ok(crate::source_reader::SourceReaderServer::bind(path, self.writer.clone())?)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) fn shutdown_waiters(&self) -> Arc<std::sync::atomic::AtomicUsize> {
|
||||
self.drain.waiters.clone()
|
||||
}
|
||||
|
||||
/// Stop admission before signaling Raft; await its real core/tick shutdown.
|
||||
pub async fn shutdown(&self) -> Result<(), NativeRaftOwnerError> {
|
||||
self.accepting.store(false, Ordering::Release);
|
||||
self.raft.shutdown().await.map_err(NativeRaftOwnerError::Shutdown)?;
|
||||
// OpenRaft joins core/tick but detaches the SM worker and snapshot builders.
|
||||
self.drain.wait().await;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,885 @@
|
||||
//! Real Raft engines and real redb; direct RPC routing exists only inside these tests.
|
||||
use super::*;
|
||||
use openraft::{
|
||||
Raft, RaftNetwork, RaftNetworkFactory, ServerState,
|
||||
error::{InstallSnapshotError, RPCError, RaftError, RemoteError, Unreachable},
|
||||
network::{Backoff, RPCOption},
|
||||
raft::{
|
||||
AppendEntriesRequest, AppendEntriesResponse, InstallSnapshotRequest, InstallSnapshotResponse, VoteRequest, VoteResponse,
|
||||
},
|
||||
};
|
||||
use std::{
|
||||
collections::{BTreeMap, BTreeSet},
|
||||
sync::{
|
||||
Arc, Mutex,
|
||||
atomic::{AtomicUsize, Ordering},
|
||||
},
|
||||
time::Duration,
|
||||
};
|
||||
|
||||
type Engine = Raft<CaptureTypeConfig>;
|
||||
type RpcError = RPCError<u64, CaptureNode, RaftError<u64>>;
|
||||
type SnapshotRpcError = RPCError<u64, CaptureNode, RaftError<u64, InstallSnapshotError>>;
|
||||
type PausedLinks = Mutex<BTreeMap<(u64, u64), (Arc<tokio::sync::Notify>, Arc<tokio::sync::Notify>)>>;
|
||||
#[derive(Default)]
|
||||
struct Routes {
|
||||
nodes: Mutex<BTreeMap<u64, Engine>>,
|
||||
blocked: Mutex<BTreeSet<(u64, u64)>>,
|
||||
snapshot_installs: AtomicUsize,
|
||||
pause_append: PausedLinks,
|
||||
}
|
||||
impl Routes {
|
||||
fn register(&self, id: u64, raft: Engine) {
|
||||
self.nodes.lock().expect("routes").insert(id, raft);
|
||||
}
|
||||
fn remove(&self, id: u64) {
|
||||
self.nodes.lock().expect("routes").remove(&id);
|
||||
}
|
||||
fn isolate(&self, id: u64, members: &[u64]) {
|
||||
let mut blocked = self.blocked.lock().expect("partition routes");
|
||||
for peer in members {
|
||||
if *peer != id {
|
||||
blocked.insert((id, *peer));
|
||||
blocked.insert((*peer, id));
|
||||
}
|
||||
}
|
||||
}
|
||||
fn heal(&self) {
|
||||
self.blocked.lock().expect("restore routes").clear();
|
||||
}
|
||||
fn endpoint(&self, source: u64, target: u64) -> Result<Engine, Unreachable> {
|
||||
if self.blocked.lock().expect("partition check").contains(&(source, target)) {
|
||||
return Err(Unreachable::new(&std::io::Error::other("test partition")));
|
||||
}
|
||||
self.nodes
|
||||
.lock()
|
||||
.expect("endpoint registry")
|
||||
.get(&target)
|
||||
.cloned()
|
||||
.ok_or_else(|| Unreachable::new(&std::io::Error::other("test endpoint unavailable")))
|
||||
}
|
||||
}
|
||||
#[derive(Clone)]
|
||||
struct DirectFactory {
|
||||
source: u64,
|
||||
routes: Arc<Routes>,
|
||||
}
|
||||
struct DirectClient {
|
||||
source: u64,
|
||||
target: u64,
|
||||
node: CaptureNode,
|
||||
routes: Arc<Routes>,
|
||||
}
|
||||
impl RaftNetworkFactory<CaptureTypeConfig> for DirectFactory {
|
||||
type Network = DirectClient;
|
||||
async fn new_client(&mut self, target: u64, node: &CaptureNode) -> DirectClient {
|
||||
DirectClient {
|
||||
source: self.source,
|
||||
target,
|
||||
node: node.clone(),
|
||||
routes: self.routes.clone(),
|
||||
}
|
||||
}
|
||||
}
|
||||
impl RaftNetwork<CaptureTypeConfig> for DirectClient {
|
||||
async fn append_entries(
|
||||
&mut self,
|
||||
request: AppendEntriesRequest<CaptureTypeConfig>,
|
||||
_option: RPCOption,
|
||||
) -> Result<AppendEntriesResponse<u64>, RpcError> {
|
||||
let pause = self
|
||||
.routes
|
||||
.pause_append
|
||||
.lock()
|
||||
.expect("actual RPC pause hook")
|
||||
.remove(&(self.source, self.target));
|
||||
if let Some((entered, resume)) = pause {
|
||||
entered.notify_one();
|
||||
resume.notified().await;
|
||||
}
|
||||
let raft = self.routes.endpoint(self.source, self.target)?;
|
||||
raft.append_entries(request)
|
||||
.await
|
||||
.map_err(|error| RemoteError::new_with_node(self.target, self.node.clone(), error).into())
|
||||
}
|
||||
async fn vote(&mut self, request: VoteRequest<u64>, _option: RPCOption) -> Result<VoteResponse<u64>, RpcError> {
|
||||
let raft = self.routes.endpoint(self.source, self.target)?;
|
||||
raft.vote(request)
|
||||
.await
|
||||
.map_err(|error| RemoteError::new_with_node(self.target, self.node.clone(), error).into())
|
||||
}
|
||||
async fn install_snapshot(
|
||||
&mut self,
|
||||
request: InstallSnapshotRequest<CaptureTypeConfig>,
|
||||
_option: RPCOption,
|
||||
) -> Result<InstallSnapshotResponse<u64>, SnapshotRpcError> {
|
||||
let raft = self.routes.endpoint(self.source, self.target)?;
|
||||
let done = request.done;
|
||||
let result = raft
|
||||
.install_snapshot(request)
|
||||
.await
|
||||
.map_err(|error| RemoteError::new_with_node(self.target, self.node.clone(), error).into());
|
||||
if done && result.is_ok() {
|
||||
self.routes.snapshot_installs.fetch_add(1, Ordering::AcqRel);
|
||||
}
|
||||
result
|
||||
}
|
||||
fn backoff(&self) -> Backoff {
|
||||
Backoff::new(std::iter::repeat(Duration::from_millis(25)))
|
||||
}
|
||||
}
|
||||
fn identity(node_id: u64) -> NodeIdentity {
|
||||
NodeIdentity {
|
||||
cluster_id: [7; 16],
|
||||
node_id,
|
||||
}
|
||||
}
|
||||
fn binding() -> CaptureBinding {
|
||||
CaptureBinding {
|
||||
revision: 9,
|
||||
binding_id: [8; 16],
|
||||
target_id: [9; 16],
|
||||
}
|
||||
}
|
||||
fn command(value: u8) -> CaptureCommand {
|
||||
CaptureCommand::try_created(DecideCreated {
|
||||
operation_id: [value; 16],
|
||||
object: ObjectIdentity {
|
||||
bucket_incarnation: [2; 16],
|
||||
key: vec![value],
|
||||
},
|
||||
expected_head: None,
|
||||
prepared: PreparedIdentity {
|
||||
version_id: [value; 16],
|
||||
preparation_id: [4; 16],
|
||||
content_digest: [5; 32],
|
||||
content_length: 123,
|
||||
},
|
||||
binding_revision: 9,
|
||||
})
|
||||
.expect("native client command")
|
||||
}
|
||||
fn config(snapshot_every: u64) -> Arc<openraft::Config> {
|
||||
Arc::new(
|
||||
openraft::Config {
|
||||
cluster_name: "native-owner-tests".into(),
|
||||
heartbeat_interval: 100,
|
||||
election_timeout_min: 500,
|
||||
election_timeout_max: 1000,
|
||||
snapshot_policy: openraft::SnapshotPolicy::LogsSinceLast(snapshot_every),
|
||||
max_in_snapshot_log_to_keep: 0,
|
||||
purge_batch_size: 1,
|
||||
..openraft::Config::default()
|
||||
}
|
||||
.validate()
|
||||
.expect("valid real Raft test configuration"),
|
||||
)
|
||||
}
|
||||
fn members(ids: &[u64]) -> BTreeMap<u64, CaptureNode> {
|
||||
ids.iter()
|
||||
.map(|id| {
|
||||
(
|
||||
*id,
|
||||
CaptureNode::new(format!("http://127.0.0.1:{}", 7000 + id)).expect("bounded test endpoint"),
|
||||
)
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
struct Node {
|
||||
directory: tempfile::TempDir,
|
||||
writer: NativeLogWriter,
|
||||
owner: Option<NativeRaftOwner>,
|
||||
id: u64,
|
||||
}
|
||||
impl Node {
|
||||
async fn start(id: u64, routes: Arc<Routes>, config: Arc<openraft::Config>) -> Self {
|
||||
let directory = tempfile::tempdir().expect("real Raft owner directory");
|
||||
let mut store = Store::initialize(directory.path().join("db"), identity(id)).expect("real owner redb");
|
||||
store.pin_capture_binding(binding()).expect("captured binding");
|
||||
store.enable_native_empty().expect("native storage mode");
|
||||
store.promote_created_provenance().expect("native provenance");
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let owner = NativeRaftOwner::start(
|
||||
writer.clone(),
|
||||
id,
|
||||
config,
|
||||
CheckpointLimits::default(),
|
||||
DirectFactory {
|
||||
source: id,
|
||||
routes: routes.clone(),
|
||||
},
|
||||
)
|
||||
.await
|
||||
.expect("actual owner start");
|
||||
routes.register(id, owner.raft().clone());
|
||||
Self {
|
||||
directory,
|
||||
writer,
|
||||
owner: Some(owner),
|
||||
id,
|
||||
}
|
||||
}
|
||||
fn owner(&self) -> &NativeRaftOwner {
|
||||
self.owner.as_ref().expect("live owner")
|
||||
}
|
||||
async fn page(&self) -> EventPage {
|
||||
self.writer
|
||||
.created_events_page(None, 256)
|
||||
.await
|
||||
.expect("actual committed events")
|
||||
}
|
||||
async fn stop(&mut self, routes: &Routes) {
|
||||
self.owner
|
||||
.take()
|
||||
.expect("running owner")
|
||||
.shutdown()
|
||||
.await
|
||||
.expect("real Raft shutdown");
|
||||
routes.remove(self.id);
|
||||
}
|
||||
}
|
||||
struct Cluster {
|
||||
nodes: Vec<Node>,
|
||||
routes: Arc<Routes>,
|
||||
}
|
||||
impl Cluster {
|
||||
async fn start(ids: &[u64], snapshot_every: u64) -> Self {
|
||||
let routes = Arc::new(Routes::default());
|
||||
let mut nodes = Vec::new();
|
||||
for id in ids {
|
||||
nodes.push(Node::start(*id, routes.clone(), config(snapshot_every)).await);
|
||||
}
|
||||
nodes[0]
|
||||
.owner()
|
||||
.bootstrap(members(ids))
|
||||
.await
|
||||
.expect("explicit initial cluster bootstrap");
|
||||
let cluster = Self { nodes, routes };
|
||||
cluster.leader(ids).await;
|
||||
cluster
|
||||
}
|
||||
fn node(&self, id: u64) -> &Node {
|
||||
self.nodes.iter().find(|node| node.id == id).expect("cluster node")
|
||||
}
|
||||
async fn leader(&self, eligible: &[u64]) -> u64 {
|
||||
tokio::time::timeout(Duration::from_secs(15), async {
|
||||
loop {
|
||||
for id in eligible {
|
||||
let node = self.node(*id);
|
||||
let Some(owner) = &node.owner else {
|
||||
continue;
|
||||
};
|
||||
let metrics = owner.metrics().borrow().clone();
|
||||
assert!(metrics.running_state.is_ok(), "real Raft owner fatal state: {:?}", metrics.running_state);
|
||||
if metrics.state == ServerState::Leader && metrics.current_leader == Some(*id) {
|
||||
return *id;
|
||||
}
|
||||
}
|
||||
tokio::task::yield_now().await;
|
||||
}
|
||||
})
|
||||
.await
|
||||
.expect("real leader election readiness")
|
||||
}
|
||||
async fn applied(&self, ids: &[u64], index: u64) {
|
||||
for id in ids {
|
||||
self.node(*id)
|
||||
.owner()
|
||||
.raft()
|
||||
.wait(Some(Duration::from_secs(15)))
|
||||
.applied_index_at_least(Some(index), "real replicated apply readiness")
|
||||
.await
|
||||
.expect("committed log applied on real node");
|
||||
}
|
||||
}
|
||||
async fn stop(mut self) {
|
||||
for node in &mut self.nodes {
|
||||
if node.owner.is_some() {
|
||||
node.stop(&self.routes).await;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_owner_single_node_bootstrap() {
|
||||
let cluster = Cluster::start(&[0], 100).await;
|
||||
let response = cluster
|
||||
.node(0)
|
||||
.owner()
|
||||
.client_write(command(1))
|
||||
.await
|
||||
.expect("real client_write");
|
||||
assert!(
|
||||
matches!(response.data.created_result(),Some(CreatedResult::Created { event_id,.. }) if *event_id==[1;16]),
|
||||
"OWNER_TRUE_RAFT_CREATED_RESPONSE"
|
||||
);
|
||||
let page = cluster.node(0).page().await;
|
||||
assert_eq!(page.events.len(), 1);
|
||||
assert_eq!(
|
||||
page.events[0].captured.decision_log_id,
|
||||
LogId::from(response.log_id),
|
||||
"OWNER_COMMITTED_EVENT_LOG_ID"
|
||||
);
|
||||
assert!(
|
||||
cluster.node(0).owner().bootstrap(members(&[0])).await.is_err(),
|
||||
"OWNER_BOOTSTRAP_NOT_REINITIALIZATION"
|
||||
);
|
||||
cluster.stop().await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_owner_single_node_restart() {
|
||||
let routes = Arc::new(Routes::default());
|
||||
let mut node = Node::start(0, routes.clone(), config(100)).await;
|
||||
node.owner().bootstrap(members(&[0])).await.expect("first bootstrap only");
|
||||
node.owner()
|
||||
.raft()
|
||||
.wait(Some(Duration::from_secs(15)))
|
||||
.state(ServerState::Leader, "single leader")
|
||||
.await
|
||||
.expect("leader ready");
|
||||
node.owner().client_write(command(1)).await.expect("first genuine write");
|
||||
let before = node.page().await;
|
||||
node.stop(&routes).await;
|
||||
let Node {
|
||||
directory,
|
||||
writer,
|
||||
owner: _,
|
||||
id,
|
||||
} = node;
|
||||
let vote = writer.read_vote().await.expect("durable vote before reopen");
|
||||
drop(writer);
|
||||
let store = Store::open(directory.path().join("db"), identity(id)).expect("restart same durable identity");
|
||||
assert_eq!(store.read_vote().expect("persisted vote"), vote.map(Into::into));
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let owner = NativeRaftOwner::start(
|
||||
writer.clone(),
|
||||
id,
|
||||
config(100),
|
||||
CheckpointLimits::default(),
|
||||
DirectFactory {
|
||||
source: id,
|
||||
routes: routes.clone(),
|
||||
},
|
||||
)
|
||||
.await
|
||||
.expect("restart existing Raft");
|
||||
routes.register(id, owner.raft().clone());
|
||||
assert!(
|
||||
owner.raft().is_initialized().await.expect("restored cluster membership"),
|
||||
"OWNER_RESTART_DOES_NOT_REQUIRE_BOOTSTRAP"
|
||||
);
|
||||
owner
|
||||
.raft()
|
||||
.wait(Some(Duration::from_secs(15)))
|
||||
.state(ServerState::Leader, "restored leader")
|
||||
.await
|
||||
.expect("restarted leader ready");
|
||||
owner
|
||||
.client_write(command(2))
|
||||
.await
|
||||
.expect("continue after restart without initialize");
|
||||
let after = writer.created_events_page(None, 256).await.expect("restart continued events");
|
||||
assert_eq!(after.events.len(), 2);
|
||||
assert_eq!(after.events[0], before.events[0], "OWNER_RESTART_PRESERVES_FIRST_DECISION");
|
||||
owner.shutdown().await.expect("restart owner shutdown");
|
||||
routes.remove(id);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_owner_idempotent_retry() {
|
||||
let cluster = Cluster::start(&[0], 100).await;
|
||||
let owner = cluster.node(0).owner();
|
||||
let first = owner.client_write(command(1)).await.expect("first write");
|
||||
let replay = owner.client_write(command(1)).await.expect("same operation retry");
|
||||
assert_eq!(
|
||||
replay.data.created_result(),
|
||||
first.data.created_result(),
|
||||
"OWNER_RETRY_PRESERVES_FIRST_DECISION_RESULT"
|
||||
);
|
||||
assert!(replay.log_id.index > first.log_id.index, "real retry can append another Raft log");
|
||||
assert_eq!(cluster.node(0).page().await.events.len(), 1, "OWNER_RETRY_NO_DUPLICATE_EVENT");
|
||||
cluster.stop().await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_owner_identity_binding() {
|
||||
let routes = Arc::new(Routes::default());
|
||||
let mut node = Node::start(0, routes.clone(), config(100)).await;
|
||||
node.owner().bootstrap(members(&[0])).await.expect("real durable membership");
|
||||
node.owner()
|
||||
.raft()
|
||||
.wait(Some(Duration::from_secs(15)))
|
||||
.state(ServerState::Leader, "single leader")
|
||||
.await
|
||||
.expect("leader");
|
||||
node.owner().client_write(command(1)).await.expect("nonempty durable store");
|
||||
node.stop(&routes).await;
|
||||
let before = std::fs::read(node.directory.path().join("db")).expect("stable identity-bound store");
|
||||
let result = NativeRaftOwner::start(
|
||||
node.writer.clone(),
|
||||
1,
|
||||
config(100),
|
||||
CheckpointLimits::default(),
|
||||
DirectFactory {
|
||||
source: 1,
|
||||
routes: routes.clone(),
|
||||
},
|
||||
)
|
||||
.await;
|
||||
assert!(
|
||||
matches!(result, Err(NativeRaftOwnerError::IdentityMismatch { runtime: 1, durable: 0 })),
|
||||
"OWNER_REQUIRES_DURABLE_NODE_ID: runtime node cannot reinterpret stored membership/identity"
|
||||
);
|
||||
assert_eq!(
|
||||
std::fs::read(node.directory.path().join("db")).expect("unchanged identity-bound store"),
|
||||
before
|
||||
);
|
||||
let invalid_config = Arc::new(openraft::Config {
|
||||
election_timeout_min: 1000,
|
||||
election_timeout_max: 500,
|
||||
..openraft::Config::default()
|
||||
});
|
||||
let invalid = NativeRaftOwner::start(
|
||||
node.writer.clone(),
|
||||
0,
|
||||
invalid_config,
|
||||
CheckpointLimits::default(),
|
||||
DirectFactory {
|
||||
source: 0,
|
||||
routes: routes.clone(),
|
||||
},
|
||||
)
|
||||
.await;
|
||||
assert!(
|
||||
matches!(invalid, Err(NativeRaftOwnerError::Config(_))),
|
||||
"OWNER_REJECTS_INVALID_CONFIG_BEFORE_START"
|
||||
);
|
||||
let mut limits = CheckpointLimits::default();
|
||||
limits.snapshot.total_bytes = 0;
|
||||
let invalid = NativeRaftOwner::start(node.writer.clone(), 0, config(100), limits, DirectFactory { source: 0, routes }).await;
|
||||
assert!(
|
||||
matches!(invalid, Err(NativeRaftOwnerError::Snapshot(_))),
|
||||
"OWNER_REJECTS_INVALID_LIMITS_BEFORE_START"
|
||||
);
|
||||
assert_eq!(
|
||||
std::fs::read(node.directory.path().join("db")).expect("invalid start leaves stable bytes"),
|
||||
before
|
||||
);
|
||||
}
|
||||
|
||||
#[cfg(any(target_os = "linux", target_os = "macos"))]
|
||||
#[tokio::test]
|
||||
async fn raft_owner_shared_reader() {
|
||||
use source_reader::SourceReaderClient;
|
||||
use std::os::unix::fs::PermissionsExt;
|
||||
let cluster = Cluster::start(&[0], 100).await;
|
||||
let node = cluster.node(0);
|
||||
std::fs::set_permissions(node.directory.path(), std::fs::Permissions::from_mode(0o700)).expect("private reader parent");
|
||||
let socket = node.directory.path().join("reader.sock");
|
||||
let (server, shutdown) = node
|
||||
.owner()
|
||||
.bind_reader(&socket)
|
||||
.expect("owner shares live writer with reader");
|
||||
let task = tokio::spawn(server.serve());
|
||||
let client = SourceReaderClient::new(&socket).expect("live reader");
|
||||
assert!(
|
||||
client
|
||||
.page(identity(0).cluster_id, None, 1)
|
||||
.await
|
||||
.expect("initial reader page")
|
||||
.page
|
||||
.events
|
||||
.is_empty()
|
||||
);
|
||||
let response = node
|
||||
.owner()
|
||||
.client_write(command(1))
|
||||
.await
|
||||
.expect("real write while reader runs");
|
||||
let page = client
|
||||
.page(identity(0).cluster_id, None, 1)
|
||||
.await
|
||||
.expect("live committed event");
|
||||
assert_eq!(page.identity, identity(0));
|
||||
assert_eq!(
|
||||
page.page.events[0].captured.decision_log_id,
|
||||
LogId::from(response.log_id),
|
||||
"OWNER_READER_USES_REAL_COMMITTED_WRITER"
|
||||
);
|
||||
shutdown.shutdown();
|
||||
task.await.expect("reader serve task").expect("reader drains");
|
||||
cluster.stop().await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_owner_shutdown() {
|
||||
let cluster = Cluster::start(&[0], 100).await;
|
||||
let owner = cluster.node(0).owner();
|
||||
owner.client_write(command(1)).await.expect("accepted before shutdown");
|
||||
owner.shutdown().await.expect("actual owner shutdown");
|
||||
assert!(owner.client_write(command(2)).await.is_err(), "OWNER_SHUTDOWN_REJECTS_NEW_WRITES");
|
||||
assert_eq!(cluster.node(0).page().await.events.len(), 1);
|
||||
cluster.stop().await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
|
||||
async fn raft_owner_three_node_majority() {
|
||||
let cluster = Cluster::start(&[0, 1, 2], 100).await;
|
||||
let leader = cluster.leader(&[0, 1, 2]).await;
|
||||
let first = cluster
|
||||
.node(leader)
|
||||
.owner()
|
||||
.client_write(command(1))
|
||||
.await
|
||||
.expect("real quorum write");
|
||||
cluster.applied(&[0, 1, 2], first.log_id.index).await;
|
||||
let follower = [0, 1, 2].into_iter().find(|id| *id != leader).expect("nonleader");
|
||||
let rejected = cluster.node(follower).owner().client_write(command(254)).await;
|
||||
match rejected {
|
||||
Err(NativeRaftOwnerError::Write(error)) => {
|
||||
assert!(
|
||||
matches!(error.api_error(), Some(openraft::error::ClientWriteError::ForwardToLeader(_))),
|
||||
"OWNER_PRESERVES_TYPED_FORWARD_TO_LEADER"
|
||||
);
|
||||
}
|
||||
other => panic!("OWNER_NONLEADER_WRITE_MUST_NOT_SUCCEED: {other:?}"),
|
||||
}
|
||||
cluster.routes.isolate(leader, &[0, 1, 2]);
|
||||
let uncertain =
|
||||
tokio::time::timeout(Duration::from_millis(1500), cluster.node(leader).owner().client_write(command(2))).await;
|
||||
assert!(!matches!(uncertain, Ok(Ok(_))), "OWNER_MAJORITY_REQUIRED_FOR_SUCCESS");
|
||||
let others: Vec<_> = [0, 1, 2].into_iter().filter(|id| *id != leader).collect();
|
||||
let next = cluster.leader(&others).await;
|
||||
let response = cluster
|
||||
.node(next)
|
||||
.owner()
|
||||
.client_write(command(2))
|
||||
.await
|
||||
.expect("majority-owned retry of exact same operation");
|
||||
cluster.routes.heal();
|
||||
cluster.applied(&[0, 1, 2], response.log_id.index).await;
|
||||
for node in &cluster.nodes {
|
||||
assert_eq!(node.page().await.events.len(), 2, "OWNER_QUORUM_RETRY_NO_DUPLICATE_EVENT");
|
||||
}
|
||||
cluster.stop().await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
|
||||
async fn raft_owner_leader_failover() {
|
||||
let mut cluster = Cluster::start(&[0, 1, 2], 100).await;
|
||||
let leader = cluster.leader(&[0, 1, 2]).await;
|
||||
let first = cluster
|
||||
.node(leader)
|
||||
.owner()
|
||||
.client_write(command(1))
|
||||
.await
|
||||
.expect("first confirmed write");
|
||||
cluster.applied(&[0, 1, 2], first.log_id.index).await;
|
||||
let before = cluster.node(leader).page().await.events[0].clone();
|
||||
cluster
|
||||
.nodes
|
||||
.iter_mut()
|
||||
.find(|node| node.id == leader)
|
||||
.expect("old leader")
|
||||
.stop(&cluster.routes)
|
||||
.await;
|
||||
let survivors: Vec<_> = [0, 1, 2].into_iter().filter(|id| *id != leader).collect();
|
||||
let next = cluster.leader(&survivors).await;
|
||||
let response = cluster
|
||||
.node(next)
|
||||
.owner()
|
||||
.client_write(command(2))
|
||||
.await
|
||||
.expect("new leader actual quorum write");
|
||||
cluster.applied(&survivors, response.log_id.index).await;
|
||||
for id in survivors {
|
||||
let page = cluster.node(id).page().await;
|
||||
assert_eq!(page.events.len(), 2);
|
||||
assert_eq!(page.events[0], before, "OWNER_FAILOVER_PRESERVES_CONFIRMED_DECISION");
|
||||
}
|
||||
cluster.stop().await;
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
|
||||
async fn raft_owner_snapshot_catchup() {
|
||||
let cluster = Cluster::start(&[0, 1, 2], 1000).await;
|
||||
let leader = cluster.leader(&[0, 1, 2]).await;
|
||||
let follower = [0, 1, 2].into_iter().find(|id| *id != leader).expect("lagging follower");
|
||||
let first = cluster
|
||||
.node(leader)
|
||||
.owner()
|
||||
.client_write(command(1))
|
||||
.await
|
||||
.expect("initial confirmed event");
|
||||
cluster.applied(&[0, 1, 2], first.log_id.index).await;
|
||||
// Keep the catch-up test focused on replication rather than an isolated follower's election.
|
||||
cluster.node(follower).owner().raft().runtime_config().elect(false);
|
||||
cluster.routes.isolate(follower, &[0, 1, 2]);
|
||||
let mut last = first;
|
||||
for value in 2..=12 {
|
||||
last = cluster
|
||||
.node(leader)
|
||||
.owner()
|
||||
.client_write(command(value))
|
||||
.await
|
||||
.expect("majority writes while follower offline");
|
||||
}
|
||||
cluster
|
||||
.node(leader)
|
||||
.owner()
|
||||
.raft()
|
||||
.trigger()
|
||||
.snapshot()
|
||||
.await
|
||||
.expect("true Raft snapshot trigger");
|
||||
cluster
|
||||
.node(leader)
|
||||
.owner()
|
||||
.raft()
|
||||
.wait(Some(Duration::from_secs(15)))
|
||||
.metrics(
|
||||
|metrics| metrics.purged.is_some_and(|cut| cut.index >= last.log_id.index),
|
||||
"snapshot durably purged lagging log prefix",
|
||||
)
|
||||
.await
|
||||
.expect("real snapshot and purge");
|
||||
let before = cluster.routes.snapshot_installs.load(Ordering::Acquire);
|
||||
cluster.routes.heal();
|
||||
cluster.applied(&[0, 1, 2], last.log_id.index).await;
|
||||
cluster
|
||||
.node(follower)
|
||||
.owner()
|
||||
.raft()
|
||||
.wait(Some(Duration::from_secs(15)))
|
||||
.metrics(
|
||||
|metrics| metrics.snapshot.is_some_and(|cut| cut.index >= last.log_id.index),
|
||||
"follower installed actual transferred snapshot",
|
||||
)
|
||||
.await
|
||||
.expect("real snapshot catch-up");
|
||||
tokio::time::timeout(Duration::from_secs(15), async {
|
||||
while cluster.routes.snapshot_installs.load(Ordering::Acquire) <= before {
|
||||
tokio::task::yield_now().await;
|
||||
}
|
||||
})
|
||||
.await
|
||||
.expect("snapshot readiness includes actual successful done-RPC return");
|
||||
assert!(
|
||||
cluster.routes.snapshot_installs.load(Ordering::Acquire) > before,
|
||||
"OWNER_CATCHUP_USED_ACTUAL_SNAPSHOT_RPC"
|
||||
);
|
||||
let expected = cluster.node(leader).page().await;
|
||||
for node in &cluster.nodes {
|
||||
assert_eq!(node.page().await, expected, "OWNER_SNAPSHOT_CATCHUP_FULL_SOURCE_EVENTS");
|
||||
}
|
||||
cluster.node(follower).owner().raft().runtime_config().elect(true);
|
||||
let current = cluster.leader(&[0, 1, 2]).await;
|
||||
let next = cluster
|
||||
.node(current)
|
||||
.owner()
|
||||
.client_write(command(13))
|
||||
.await
|
||||
.expect("continue after real snapshot install");
|
||||
cluster.applied(&[0, 1, 2], next.log_id.index).await;
|
||||
for node in &cluster.nodes {
|
||||
assert_eq!(node.page().await.events.len(), 13);
|
||||
}
|
||||
cluster.stop().await;
|
||||
}
|
||||
|
||||
async fn wait_for_shutdown_drain(waiters: &AtomicUsize) {
|
||||
tokio::time::timeout(Duration::from_secs(5), async {
|
||||
while waiters.load(Ordering::Acquire) == 0 {
|
||||
tokio::task::yield_now().await;
|
||||
}
|
||||
})
|
||||
.await
|
||||
.expect("OWNER_SHUTDOWN_DRAINS_INFLIGHT_WORK: owner reached real worker drain wait");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_owner_shutdown_inflight_snapshot() {
|
||||
let routes = Arc::new(Routes::default());
|
||||
let mut node = Node::start(0, routes.clone(), config(1000)).await;
|
||||
node.owner()
|
||||
.bootstrap(members(&[0]))
|
||||
.await
|
||||
.expect("real single-node bootstrap");
|
||||
node.owner()
|
||||
.raft()
|
||||
.wait(Some(Duration::from_secs(15)))
|
||||
.state(ServerState::Leader, "leader before snapshot")
|
||||
.await
|
||||
.expect("leader readiness");
|
||||
node.owner()
|
||||
.client_write(command(1))
|
||||
.await
|
||||
.expect("real committed snapshot input");
|
||||
let entered = Arc::new(tokio::sync::Notify::new());
|
||||
let resume = Arc::new(tokio::sync::Notify::new());
|
||||
*node.owner().snapshot_build_pause.lock().expect("real builder hook") = Some((entered.clone(), resume.clone()));
|
||||
node.owner()
|
||||
.raft()
|
||||
.trigger()
|
||||
.snapshot()
|
||||
.await
|
||||
.expect("real Raft snapshot request");
|
||||
tokio::time::timeout(Duration::from_secs(5), entered.notified())
|
||||
.await
|
||||
.expect("real detached snapshot builder paused");
|
||||
let owner = node.owner.take().expect("running owner");
|
||||
let waiters = owner.shutdown_waiters();
|
||||
let observer = owner.raft().clone();
|
||||
let shutdown = tokio::spawn(async move {
|
||||
let result = owner.shutdown().await;
|
||||
(owner, result)
|
||||
});
|
||||
wait_for_shutdown_drain(&waiters).await;
|
||||
assert!(
|
||||
observer.metrics().borrow().running_state.is_err(),
|
||||
"OWNER_CORE_STOPPED_WHILE_SNAPSHOT_DRAIN_PENDING"
|
||||
);
|
||||
assert!(!shutdown.is_finished(), "OWNER_SHUTDOWN_DRAINS_INFLIGHT_SNAPSHOT");
|
||||
resume.notify_one();
|
||||
let (owner, result) = tokio::time::timeout(Duration::from_secs(10), shutdown)
|
||||
.await
|
||||
.expect("released snapshot lets shutdown finish")
|
||||
.expect("shutdown task");
|
||||
result.expect("snapshot work drained");
|
||||
routes.remove(0);
|
||||
drop(observer);
|
||||
drop(owner);
|
||||
drop(waiters);
|
||||
let Node {
|
||||
directory,
|
||||
writer,
|
||||
owner: _,
|
||||
id,
|
||||
} = node;
|
||||
drop(writer);
|
||||
let store = Store::open(directory.path().join("db"), identity(id)).expect("OWNER_SHUTDOWN_SNAPSHOT_RELEASES_LIVE_DATABASE");
|
||||
assert_eq!(
|
||||
store
|
||||
.created_events_page(None, 256)
|
||||
.expect("retained committed source events")
|
||||
.events
|
||||
.len(),
|
||||
1
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
|
||||
async fn raft_owner_shutdown_inflight_replication() {
|
||||
// OpenRaft times append_entries by heartbeat_interval. Keep the real deadline
|
||||
// longer than readiness checks so only explicit RPC release ends this pause.
|
||||
let slow = Arc::new(
|
||||
openraft::Config {
|
||||
heartbeat_interval: 10_000,
|
||||
election_timeout_min: 20_000,
|
||||
election_timeout_max: 30_000,
|
||||
snapshot_policy: openraft::SnapshotPolicy::LogsSinceLast(1000),
|
||||
..openraft::Config::default()
|
||||
}
|
||||
.validate()
|
||||
.expect("long real RPC deadline"),
|
||||
);
|
||||
let routes = Arc::new(Routes::default());
|
||||
let mut nodes = Vec::new();
|
||||
for id in [0, 1, 2] {
|
||||
nodes.push(Node::start(id, routes.clone(), slow.clone()).await);
|
||||
}
|
||||
nodes[0]
|
||||
.owner()
|
||||
.bootstrap(members(&[0, 1, 2]))
|
||||
.await
|
||||
.expect("real three-node bootstrap");
|
||||
nodes[0]
|
||||
.owner()
|
||||
.raft()
|
||||
.trigger()
|
||||
.elect()
|
||||
.await
|
||||
.expect("explicit test election readiness");
|
||||
let mut cluster = Cluster { nodes, routes };
|
||||
let leader = cluster.leader(&[0, 1, 2]).await;
|
||||
let response = cluster
|
||||
.node(leader)
|
||||
.owner()
|
||||
.client_write(command(1))
|
||||
.await
|
||||
.expect("real replicated write before pause");
|
||||
cluster.applied(&[0, 1, 2], response.log_id.index).await;
|
||||
let follower = [0, 1, 2].into_iter().find(|id| *id != leader).expect("replication target");
|
||||
let entered = Arc::new(tokio::sync::Notify::new());
|
||||
let resume = Arc::new(tokio::sync::Notify::new());
|
||||
cluster
|
||||
.routes
|
||||
.pause_append
|
||||
.lock()
|
||||
.expect("actual request pause")
|
||||
.insert((leader, follower), (entered.clone(), resume.clone()));
|
||||
cluster
|
||||
.node(leader)
|
||||
.owner()
|
||||
.raft()
|
||||
.trigger()
|
||||
.heartbeat()
|
||||
.await
|
||||
.expect("real replication RPC");
|
||||
tokio::time::timeout(Duration::from_secs(5), entered.notified())
|
||||
.await
|
||||
.expect("actual AppendEntries in flight");
|
||||
let node = cluster.nodes.iter_mut().find(|node| node.id == leader).expect("leader node");
|
||||
let owner = node.owner.take().expect("leader owner");
|
||||
let waiters = owner.shutdown_waiters();
|
||||
let observer = owner.raft().clone();
|
||||
let shutdown = tokio::spawn(async move {
|
||||
let result = owner.shutdown().await;
|
||||
(owner, result)
|
||||
});
|
||||
wait_for_shutdown_drain(&waiters).await;
|
||||
assert!(
|
||||
observer.metrics().borrow().running_state.is_err(),
|
||||
"OWNER_CORE_STOPPED_WHILE_REPLICATION_DRAIN_PENDING"
|
||||
);
|
||||
assert!(!shutdown.is_finished(), "OWNER_SHUTDOWN_DRAINS_INFLIGHT_REPLICATION");
|
||||
resume.notify_one();
|
||||
let (owner, result) = tokio::time::timeout(Duration::from_secs(10), shutdown)
|
||||
.await
|
||||
.expect("released real RPC lets shutdown finish")
|
||||
.expect("replication shutdown task");
|
||||
result.expect("actual replication reader drained");
|
||||
cluster.routes.remove(leader);
|
||||
drop(observer);
|
||||
drop(owner);
|
||||
drop(waiters);
|
||||
let position = cluster
|
||||
.nodes
|
||||
.iter()
|
||||
.position(|node| node.id == leader)
|
||||
.expect("stopped leader");
|
||||
let Node {
|
||||
directory,
|
||||
writer,
|
||||
owner: _,
|
||||
id,
|
||||
} = cluster.nodes.remove(position);
|
||||
drop(writer);
|
||||
let store =
|
||||
Store::open(directory.path().join("db"), identity(id)).expect("OWNER_SHUTDOWN_REPLICATION_RELEASES_LIVE_DATABASE");
|
||||
assert_eq!(
|
||||
store
|
||||
.created_events_page(None, 256)
|
||||
.expect("real quorum event remains")
|
||||
.events
|
||||
.len(),
|
||||
1
|
||||
);
|
||||
drop(store);
|
||||
cluster.stop().await;
|
||||
}
|
||||
|
||||
#[path = "committed_created_authorization_tests.rs"]
|
||||
mod authorization;
|
||||
@@ -0,0 +1,327 @@
|
||||
//! Durable OpenRaft application state and selected baseline snapshots.
|
||||
use crate::{
|
||||
CaptureRaftEntry, CaptureResponse, CaptureTypeConfig, CheckpointLimits, NativeLogWriter, NativeSnapshotData,
|
||||
NativeSnapshotError, StoreError, checkpoint_baseline, snapshot,
|
||||
};
|
||||
use openraft::{
|
||||
OptionalSend, RaftSnapshotBuilder, Snapshot, SnapshotMeta, StorageError, StorageIOError, StoredMembership,
|
||||
storage::RaftStateMachine,
|
||||
};
|
||||
use redb::{ReadableDatabase, ReadableTable, ReadableTableMetadata};
|
||||
use std::{
|
||||
io::{Seek, Write},
|
||||
sync::{
|
||||
Arc,
|
||||
atomic::{AtomicUsize, Ordering},
|
||||
},
|
||||
};
|
||||
|
||||
pub(crate) const SNAPSHOT_META: &str = "native_snapshot_meta_v1";
|
||||
type Meta = SnapshotMeta<u64, crate::CaptureNode>;
|
||||
#[derive(serde::Serialize, serde::Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
struct SelectedMeta {
|
||||
generation: u64,
|
||||
meta: Meta,
|
||||
}
|
||||
|
||||
pub(crate) fn publish_meta(
|
||||
meta: &mut redb::Table<&str, &[u8]>,
|
||||
baseline: &checkpoint_baseline::BaselineMetadata,
|
||||
value: Meta,
|
||||
) -> Result<(), StoreError> {
|
||||
let bytes = serde_json::to_vec(&SelectedMeta {
|
||||
generation: baseline.generation,
|
||||
meta: value,
|
||||
})
|
||||
.map_err(|_| StoreError::CorruptRecord)?;
|
||||
if bytes.len() > 1024 * 1024 {
|
||||
return Err(StoreError::ResourceLimit);
|
||||
}
|
||||
meta.insert(SNAPSHOT_META, bytes.as_slice())?;
|
||||
meta.insert("native_snapshot_meta_required", &[1u8][..])?;
|
||||
Ok(())
|
||||
}
|
||||
pub(crate) fn local_meta(
|
||||
baseline: &checkpoint_baseline::BaselineMetadata,
|
||||
identity: crate::NodeIdentity,
|
||||
) -> Result<Meta, StoreError> {
|
||||
Ok(Meta {
|
||||
last_log_id: baseline.header.applied.map(Into::into),
|
||||
last_membership: StoredMembership::try_from(&baseline.header.membership)?,
|
||||
snapshot_id: format!("native-local-{:x?}-{}-{}", identity.cluster_id, identity.node_id, baseline.generation),
|
||||
})
|
||||
}
|
||||
pub(crate) fn publish_local_meta(
|
||||
meta: &mut redb::Table<&str, &[u8]>,
|
||||
baseline: &checkpoint_baseline::BaselineMetadata,
|
||||
) -> Result<(), StoreError> {
|
||||
let identity = crate::decode_identity(meta.get("identity")?.ok_or(StoreError::CorruptRecord)?.value())?;
|
||||
publish_meta(meta, baseline, local_meta(baseline, identity)?)
|
||||
}
|
||||
pub(crate) fn selected_meta(
|
||||
meta: &impl ReadableTable<&'static str, &'static [u8]>,
|
||||
baseline: &checkpoint_baseline::BaselineMetadata,
|
||||
) -> Result<Meta, StoreError> {
|
||||
let Some(bytes) = meta.get(SNAPSHOT_META)? else {
|
||||
if meta.get("native_snapshot_meta_required")?.is_some() {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
return local_meta(
|
||||
baseline,
|
||||
crate::decode_identity(meta.get("identity")?.ok_or(StoreError::CorruptRecord)?.value())?,
|
||||
);
|
||||
};
|
||||
if bytes.value().len() > 1024 * 1024 {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let selected: SelectedMeta = serde_json::from_slice(bytes.value()).map_err(|_| StoreError::CorruptRecord)?;
|
||||
if selected.generation != baseline.generation
|
||||
|| selected.meta.last_log_id.map(crate::LogId::from) != baseline.header.applied
|
||||
|| crate::CaptureMembership::try_from(&selected.meta.last_membership)? != baseline.header.membership
|
||||
{
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
Ok(selected.meta)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) type TestPause = std::sync::Mutex<Option<(Arc<tokio::sync::Notify>, Arc<tokio::sync::Notify>)>>;
|
||||
|
||||
#[derive(Default)]
|
||||
pub(crate) struct ReceiveState {
|
||||
count: AtomicUsize,
|
||||
#[cfg(test)]
|
||||
pub(crate) purge_recheck: TestPause,
|
||||
pub(crate) changed: tokio::sync::Notify,
|
||||
#[cfg(test)]
|
||||
pub(crate) waiters: AtomicUsize,
|
||||
}
|
||||
pub(crate) struct ReceiveGuard {
|
||||
state: Arc<ReceiveState>,
|
||||
}
|
||||
impl ReceiveGuard {
|
||||
pub(crate) fn belongs_to(&self, state: &Arc<ReceiveState>) -> bool {
|
||||
Arc::ptr_eq(&self.state, state)
|
||||
}
|
||||
fn new(state: Arc<ReceiveState>) -> Self {
|
||||
state.count.fetch_add(1, Ordering::AcqRel);
|
||||
Self { state }
|
||||
}
|
||||
}
|
||||
impl Drop for ReceiveGuard {
|
||||
fn drop(&mut self) {
|
||||
self.state.count.fetch_sub(1, Ordering::AcqRel);
|
||||
self.state.changed.notify_waiters();
|
||||
}
|
||||
}
|
||||
impl ReceiveState {
|
||||
pub(crate) fn pending(&self) -> bool {
|
||||
self.count.load(Ordering::Acquire) > 0
|
||||
}
|
||||
}
|
||||
|
||||
/// Both adapters must use clones of the same writer. Limits apply while receiving.
|
||||
#[derive(Clone)]
|
||||
pub struct NativeRaftStateMachine {
|
||||
pub(crate) writer: NativeLogWriter,
|
||||
pub(crate) limits: CheckpointLimits,
|
||||
#[cfg(test)]
|
||||
pub(crate) build_before_ordering: Arc<TestPause>,
|
||||
// Declared last: every clone releases its writer before the final owner lease.
|
||||
pub(crate) owner_lease: Option<Arc<crate::raft_owner::OwnerLease>>,
|
||||
}
|
||||
impl NativeRaftStateMachine {
|
||||
pub fn new(writer: NativeLogWriter, limits: CheckpointLimits) -> Result<Self, NativeSnapshotError> {
|
||||
limits.validate()?;
|
||||
limits.snapshot.total_bytes.checked_add(56).ok_or(StoreError::ResourceLimit)?;
|
||||
Ok(Self {
|
||||
writer,
|
||||
limits,
|
||||
#[cfg(test)]
|
||||
build_before_ordering: Arc::new(TestPause::default()),
|
||||
owner_lease: None,
|
||||
})
|
||||
}
|
||||
fn maximum(&self) -> u64 {
|
||||
self.limits.snapshot.total_bytes + 56
|
||||
}
|
||||
async fn current(&self) -> Result<Option<Snapshot<CaptureTypeConfig>>, NativeSnapshotError> {
|
||||
let owner = self.writer.store.clone();
|
||||
let limits = self.limits;
|
||||
tokio::task::spawn_blocking(move || {
|
||||
let store = owner.lock().map_err(|_| StoreError::CorruptRecord)?;
|
||||
if !store.writable {
|
||||
return Err(StoreError::WriteDisabled);
|
||||
}
|
||||
let tx = store.database.begin_read()?;
|
||||
drop(store);
|
||||
let table = tx.open_table(crate::META)?;
|
||||
let Some(baseline) = checkpoint_baseline::read_metadata(&table)? else {
|
||||
return Ok(None);
|
||||
};
|
||||
let meta = selected_meta(&table, &baseline)?;
|
||||
let definitions = [
|
||||
checkpoint_baseline::HEADS,
|
||||
checkpoint_baseline::VERSIONS,
|
||||
checkpoint_baseline::EVENTS,
|
||||
checkpoint_baseline::OPERATIONS,
|
||||
];
|
||||
let mut counts = [0; 4];
|
||||
for (i, definition) in definitions.iter().enumerate() {
|
||||
counts[i] = tx.open_table(*definition)?.len()?;
|
||||
}
|
||||
let out = snapshot::CapabilityOutput::new(Vec::new(), limits.snapshot.total_bytes);
|
||||
let mut encoder =
|
||||
snapshot::Encoder::new(out, &baseline.header, counts, limits.snapshot).map_err(|_| StoreError::CorruptRecord)?;
|
||||
for (definition, section) in definitions.into_iter().zip([
|
||||
snapshot::Section::Heads,
|
||||
snapshot::Section::Versions,
|
||||
snapshot::Section::Events,
|
||||
snapshot::Section::Operations,
|
||||
]) {
|
||||
for row in tx.open_table(definition)?.iter()? {
|
||||
let (key, value) = row?;
|
||||
encoder
|
||||
.row(snapshot::Row {
|
||||
section,
|
||||
key: key.value(),
|
||||
value: value.value(),
|
||||
})
|
||||
.map_err(|_| StoreError::CorruptRecord)?;
|
||||
}
|
||||
}
|
||||
let artifact = encoder.finish().map_err(|_| StoreError::CorruptRecord)?.finish();
|
||||
let mut data = NativeSnapshotData::new(limits.snapshot.total_bytes + 56).map_err(|_| StoreError::ResourceLimit)?;
|
||||
data.write_all(&artifact.manifest.bytes)
|
||||
.map_err(|_| StoreError::ResourceLimit)?;
|
||||
data.write_all(&artifact.payload).map_err(|_| StoreError::ResourceLimit)?;
|
||||
data.rewind().map_err(|_| StoreError::CorruptRecord)?;
|
||||
Ok::<_, StoreError>(Some(Snapshot {
|
||||
meta,
|
||||
snapshot: Box::new(data),
|
||||
}))
|
||||
})
|
||||
.await
|
||||
.map_err(NativeSnapshotError::Worker)?
|
||||
.map_err(NativeSnapshotError::Store)
|
||||
}
|
||||
}
|
||||
fn failure(error: impl std::error::Error + 'static) -> StorageError<u64> {
|
||||
StorageIOError::read_state_machine(openraft::AnyError::new(&error)).into()
|
||||
}
|
||||
impl RaftStateMachine<CaptureTypeConfig> for NativeRaftStateMachine {
|
||||
type SnapshotBuilder = Self;
|
||||
async fn applied_state(
|
||||
&mut self,
|
||||
) -> Result<(Option<openraft::LogId<u64>>, StoredMembership<u64, crate::CaptureNode>), StorageError<u64>> {
|
||||
let (id, membership) = self.writer.applied_state().await.map_err(failure)?;
|
||||
Ok((id.map(Into::into), StoredMembership::try_from(&membership).map_err(failure)?))
|
||||
}
|
||||
async fn apply<I>(&mut self, entries: I) -> Result<Vec<CaptureResponse>, StorageError<u64>>
|
||||
where
|
||||
I: IntoIterator<Item = CaptureRaftEntry> + OptionalSend,
|
||||
I::IntoIter: OptionalSend,
|
||||
{
|
||||
self.writer
|
||||
.apply_committed(entries.into_iter().collect())
|
||||
.await
|
||||
.map_err(failure)
|
||||
}
|
||||
async fn get_snapshot_builder(&mut self) -> Self {
|
||||
self.clone()
|
||||
}
|
||||
async fn begin_receiving_snapshot(&mut self) -> Result<Box<NativeSnapshotData>, StorageError<u64>> {
|
||||
let mut data = NativeSnapshotData::new(self.maximum()).map_err(failure)?;
|
||||
data.attach_receive_guard(ReceiveGuard::new(self.writer.snapshot_receives.clone()));
|
||||
Ok(Box::new(data))
|
||||
}
|
||||
async fn install_snapshot(&mut self, meta: &Meta, data: Box<NativeSnapshotData>) -> Result<(), StorageError<u64>> {
|
||||
crate::native_snapshot_install::install(self.writer.clone(), self.limits, meta.clone(), data)
|
||||
.await
|
||||
.map_err(failure)
|
||||
}
|
||||
async fn get_current_snapshot(&mut self) -> Result<Option<Snapshot<CaptureTypeConfig>>, StorageError<u64>> {
|
||||
self.current().await.map_err(failure)
|
||||
}
|
||||
}
|
||||
impl RaftSnapshotBuilder<CaptureTypeConfig> for NativeRaftStateMachine {
|
||||
async fn build_snapshot(&mut self) -> Result<Snapshot<CaptureTypeConfig>, StorageError<u64>> {
|
||||
#[cfg(test)]
|
||||
{
|
||||
let hook = self.build_before_ordering.lock().expect("build test hook").take();
|
||||
if let Some((entered, resume)) = hook {
|
||||
entered.notify_one();
|
||||
resume.notified().await;
|
||||
}
|
||||
}
|
||||
let limits = self.limits;
|
||||
let published_empty = self
|
||||
.writer
|
||||
.write(move |store| {
|
||||
let tx = store.write_transaction()?;
|
||||
let mut meta = tx.open_table(crate::META)?;
|
||||
// Decide the empty/nonempty path under the original writer ordering.
|
||||
if crate::application::read_applied(&meta)?.is_some() {
|
||||
return Ok(false);
|
||||
}
|
||||
let identity = crate::decode_identity(meta.get("identity")?.ok_or(StoreError::CorruptRecord)?.value())?;
|
||||
let membership =
|
||||
crate::CaptureMembership::decode(meta.get("native_membership")?.ok_or(StoreError::CorruptRecord)?.value())?;
|
||||
let previous = checkpoint_baseline::read_metadata(&meta)?;
|
||||
let generation = previous.map_or(Ok(1), |v| v.generation.checked_add(1).ok_or(StoreError::ResourceLimit))?;
|
||||
let baseline = checkpoint_baseline::BaselineMetadata {
|
||||
generation,
|
||||
header: snapshot::Header {
|
||||
cluster_id: identity.cluster_id,
|
||||
applied: None,
|
||||
membership,
|
||||
binding: crate::application::read_binding(&meta)?,
|
||||
},
|
||||
limits,
|
||||
};
|
||||
for (live, base) in [
|
||||
(crate::application::HEADS, checkpoint_baseline::HEADS),
|
||||
(crate::application::VERSIONS, checkpoint_baseline::VERSIONS),
|
||||
(crate::application::EVENTS, checkpoint_baseline::EVENTS),
|
||||
(crate::application::OPERATIONS, checkpoint_baseline::OPERATIONS),
|
||||
] {
|
||||
if tx.open_table(live)?.len()? != 0 {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
tx.open_table(base)?.retain(|_, _| false)?;
|
||||
}
|
||||
meta.insert("schema", 7u64.to_be_bytes().as_slice())?;
|
||||
meta.insert(checkpoint_baseline::META_KEY, checkpoint_baseline::encode_metadata(&baseline)?.as_slice())?;
|
||||
publish_local_meta(&mut meta, &baseline)?;
|
||||
drop(meta);
|
||||
store.commit(tx)?;
|
||||
Ok(true)
|
||||
})
|
||||
.await
|
||||
.map_err(failure)?;
|
||||
if !published_empty {
|
||||
self.writer.checkpoint_local(self.limits).await.map_err(failure)?;
|
||||
}
|
||||
self.current()
|
||||
.await
|
||||
.map_err(failure)?
|
||||
.ok_or_else(|| failure(StoreError::CorruptRecord))
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) struct Waiter(Arc<ReceiveState>);
|
||||
#[cfg(test)]
|
||||
impl Waiter {
|
||||
pub(crate) fn new(state: Arc<ReceiveState>) -> Self {
|
||||
state.waiters.fetch_add(1, Ordering::AcqRel);
|
||||
Self(state)
|
||||
}
|
||||
}
|
||||
#[cfg(test)]
|
||||
impl Drop for Waiter {
|
||||
fn drop(&mut self) {
|
||||
self.0.waiters.fetch_sub(1, Ordering::AcqRel);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,583 @@
|
||||
//! Actual OpenRaft storage traits over real redb; no simulated state machine.
|
||||
use super::*;
|
||||
use openraft::{
|
||||
RaftLogReader, RaftSnapshotBuilder,
|
||||
storage::{RaftLogStorage, RaftLogStorageExt, RaftStateMachine},
|
||||
};
|
||||
use std::{
|
||||
collections::{BTreeMap, BTreeSet},
|
||||
io::SeekFrom,
|
||||
};
|
||||
use tokio::io::{AsyncReadExt, AsyncSeekExt, AsyncWriteExt};
|
||||
|
||||
pub(super) type Snapshot = openraft::Snapshot<CaptureTypeConfig>;
|
||||
pub(super) fn identity(node_id: u64) -> NodeIdentity {
|
||||
NodeIdentity {
|
||||
cluster_id: [7; 16],
|
||||
node_id,
|
||||
}
|
||||
}
|
||||
pub(super) fn binding() -> CaptureBinding {
|
||||
CaptureBinding {
|
||||
revision: 9,
|
||||
binding_id: [8; 16],
|
||||
target_id: [9; 16],
|
||||
}
|
||||
}
|
||||
pub(super) fn id(index: u64) -> LogId {
|
||||
LogId {
|
||||
term: 8,
|
||||
leader_node: 0,
|
||||
index,
|
||||
}
|
||||
}
|
||||
pub(super) fn entry(index: u64) -> CaptureRaftEntry {
|
||||
let payload = if index == 0 {
|
||||
let membership = CaptureMembership::new(
|
||||
Some(id(0)),
|
||||
vec![BTreeSet::from([0])],
|
||||
BTreeMap::from([(0, CaptureNode::new("http://127.0.0.1:7000".into()).expect("member"))]),
|
||||
)
|
||||
.expect("native membership");
|
||||
let stored = openraft::StoredMembership::try_from(&membership).expect("stored membership");
|
||||
openraft::EntryPayload::Membership(stored.membership().clone())
|
||||
} else {
|
||||
let byte = u8::try_from(index).expect("bounded test event");
|
||||
openraft::EntryPayload::Normal(
|
||||
CaptureCommand::try_created(DecideCreated {
|
||||
operation_id: [byte; 16],
|
||||
object: ObjectIdentity {
|
||||
bucket_incarnation: [2; 16],
|
||||
key: vec![byte],
|
||||
},
|
||||
expected_head: None,
|
||||
prepared: PreparedIdentity {
|
||||
version_id: [byte; 16],
|
||||
preparation_id: [4; 16],
|
||||
content_digest: [5; 32],
|
||||
content_length: 123,
|
||||
},
|
||||
binding_revision: binding().revision,
|
||||
})
|
||||
.expect("native command"),
|
||||
)
|
||||
};
|
||||
CaptureRaftEntry {
|
||||
log_id: id(index).into(),
|
||||
payload,
|
||||
}
|
||||
}
|
||||
pub(super) fn entries(end: u64) -> Vec<CaptureRaftEntry> {
|
||||
(0..=end).map(entry).collect()
|
||||
}
|
||||
pub(super) struct Fixture {
|
||||
pub directory: tempfile::TempDir,
|
||||
pub writer: NativeLogWriter,
|
||||
pub logs: NativeRaftLogStore,
|
||||
pub sm: NativeRaftStateMachine,
|
||||
pub identity: NodeIdentity,
|
||||
}
|
||||
impl Fixture {
|
||||
pub fn new(node_id: u64) -> Self {
|
||||
Self::with_identity_binding(identity(node_id), binding())
|
||||
}
|
||||
pub fn with_identity_binding(identity: NodeIdentity, binding: CaptureBinding) -> Self {
|
||||
let directory = tempfile::tempdir().expect("real state machine directory");
|
||||
let mut store = Store::initialize(directory.path().join("db"), identity).expect("real redb initialization");
|
||||
store.pin_capture_binding(binding).expect("native binding");
|
||||
store.enable_native_empty().expect("native mode");
|
||||
store.promote_created_provenance().expect("provenance");
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let logs = NativeRaftLogStore::new(writer.clone());
|
||||
let sm = NativeRaftStateMachine::new(writer.clone(), CheckpointLimits::default()).expect("real state machine adapter");
|
||||
Self {
|
||||
directory,
|
||||
writer,
|
||||
logs,
|
||||
sm,
|
||||
identity,
|
||||
}
|
||||
}
|
||||
pub async fn apply(&mut self, batch: Vec<CaptureRaftEntry>) -> Vec<CaptureResponse> {
|
||||
self.logs
|
||||
.blocking_append(batch.clone())
|
||||
.await
|
||||
.expect("actual trait append and library flush callback");
|
||||
self.sm.apply(batch).await.expect("actual state machine trait apply")
|
||||
}
|
||||
pub async fn build(&mut self) -> Snapshot {
|
||||
self.sm
|
||||
.get_snapshot_builder()
|
||||
.await
|
||||
.build_snapshot()
|
||||
.await
|
||||
.expect("actual durable snapshot builder")
|
||||
}
|
||||
pub async fn page(&self) -> EventPage {
|
||||
self.writer
|
||||
.created_events_page(None, 256)
|
||||
.await
|
||||
.expect("authoritative native events")
|
||||
}
|
||||
}
|
||||
pub(super) async fn snapshot_bytes(snapshot: &mut Snapshot) -> Vec<u8> {
|
||||
snapshot.snapshot.seek(SeekFrom::Start(0)).await.expect("snapshot rewind");
|
||||
let mut bytes = Vec::new();
|
||||
snapshot
|
||||
.snapshot
|
||||
.read_to_end(&mut bytes)
|
||||
.await
|
||||
.expect("actual snapshot bytes");
|
||||
bytes
|
||||
}
|
||||
pub(super) async fn receive(
|
||||
sm: &mut NativeRaftStateMachine,
|
||||
bytes: &[u8],
|
||||
) -> Box<<CaptureTypeConfig as openraft::RaftTypeConfig>::SnapshotData> {
|
||||
let mut data = sm.begin_receiving_snapshot().await.expect("actual bounded receive handle");
|
||||
data.write_all(bytes).await.expect("receive real snapshot bytes");
|
||||
data.seek(SeekFrom::Start(0)).await.expect("received snapshot rewind");
|
||||
data
|
||||
}
|
||||
pub(super) async fn install(sm: &mut NativeRaftStateMachine, snapshot: &mut Snapshot) {
|
||||
let bytes = snapshot_bytes(snapshot).await;
|
||||
let data = receive(sm, &bytes).await;
|
||||
sm.install_snapshot(&snapshot.meta, data)
|
||||
.await
|
||||
.expect("actual state machine trait install");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_state_machine_apply_restart() {
|
||||
let mut f = Fixture::new(0);
|
||||
assert_eq!(f.sm.applied_state().await.expect("empty applied state").0, None);
|
||||
assert!(f.sm.get_current_snapshot().await.expect("no published snapshot").is_none());
|
||||
let batch = entries(2);
|
||||
let responses = f.apply(batch.clone()).await;
|
||||
assert_eq!(responses.len(), 3, "RAFT_SM_REAL_RESPONSE_COUNT");
|
||||
assert_eq!(responses[0].kind(), CaptureResponseKind::Membership);
|
||||
assert!(matches!(responses[1].created_result(), Some(CreatedResult::Created { .. })));
|
||||
let state = f.sm.applied_state().await.expect("durable applied state");
|
||||
assert_eq!(state.0, Some(id(2).into()));
|
||||
assert_eq!(state.1.log_id(), &Some(id(0).into()));
|
||||
let before = f.page().await;
|
||||
let Fixture {
|
||||
directory,
|
||||
writer,
|
||||
logs,
|
||||
sm,
|
||||
identity,
|
||||
} = f;
|
||||
drop(sm);
|
||||
drop(logs);
|
||||
drop(writer);
|
||||
let writer = NativeLogWriter::new(Store::open(directory.path().join("db"), identity).expect("restart real store"));
|
||||
let mut sm = NativeRaftStateMachine::new(writer.clone(), CheckpointLimits::default()).expect("reopened state machine");
|
||||
assert_eq!(
|
||||
sm.applied_state().await.expect("reopened applied state"),
|
||||
state,
|
||||
"RAFT_SM_APPLY_ACK_DURABLE"
|
||||
);
|
||||
assert_eq!(writer.created_events_page(None, 256).await.expect("reopened events"), before);
|
||||
assert_eq!(
|
||||
sm.apply(batch).await.expect("exact replay responses"),
|
||||
responses,
|
||||
"RAFT_SM_REPLAY_SAME_RESPONSES"
|
||||
);
|
||||
assert_eq!(
|
||||
writer
|
||||
.created_events_page(None, 256)
|
||||
.await
|
||||
.expect("no duplicate replay events"),
|
||||
before
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_state_machine_snapshot_build_get_restart() {
|
||||
let mut f = Fixture::new(0);
|
||||
f.apply(entries(2)).await;
|
||||
let mut built = f.build().await;
|
||||
let meta = built.meta.clone();
|
||||
let bytes = snapshot_bytes(&mut built).await;
|
||||
assert_eq!(meta.last_log_id, Some(id(2).into()), "RAFT_SM_SNAPSHOT_META_CUT");
|
||||
assert_eq!(meta.last_membership, f.sm.applied_state().await.expect("membership").1);
|
||||
f.apply(vec![entry(3)]).await;
|
||||
let mut current =
|
||||
f.sm.get_current_snapshot()
|
||||
.await
|
||||
.expect("persisted snapshot")
|
||||
.expect("snapshot exists");
|
||||
assert_eq!(current.meta, meta, "RAFT_SM_LIVE_APPLY_DOES_NOT_REPIN_SNAPSHOT");
|
||||
assert_eq!(snapshot_bytes(&mut current).await, bytes, "RAFT_SM_SNAPSHOT_FROZEN_BYTES");
|
||||
let Fixture {
|
||||
directory,
|
||||
writer,
|
||||
logs,
|
||||
sm,
|
||||
identity,
|
||||
} = f;
|
||||
drop(current);
|
||||
drop(built);
|
||||
drop(sm);
|
||||
drop(logs);
|
||||
drop(writer);
|
||||
let writer = NativeLogWriter::new(Store::open(directory.path().join("db"), identity).expect("restart snapshot owner"));
|
||||
let mut sm = NativeRaftStateMachine::new(writer, CheckpointLimits::default()).expect("reopen adapter");
|
||||
let mut current = sm
|
||||
.get_current_snapshot()
|
||||
.await
|
||||
.expect("restarted current snapshot")
|
||||
.expect("durable snapshot exists");
|
||||
assert_eq!(current.meta, meta, "RAFT_SM_COMPLETE_META_RECONSTRUCTED");
|
||||
assert_eq!(snapshot_bytes(&mut current).await, bytes, "RAFT_SM_RESTART_SNAPSHOT_BYTES");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_state_machine_receive_bounds() {
|
||||
let f = Fixture::new(0);
|
||||
let mut limits = CheckpointLimits::default();
|
||||
limits.snapshot.total_bytes = 1024;
|
||||
let mut sm = NativeRaftStateMachine::new(f.writer.clone(), limits).expect("bounded state machine");
|
||||
let mut data = sm.begin_receiving_snapshot().await.expect("bounded receive");
|
||||
data.write_all(&[1; 16]).await.expect("small write");
|
||||
assert!(data.seek(SeekFrom::Start(u64::MAX)).await.is_err(), "RAFT_SM_RECEIVE_SEEK_BOUND");
|
||||
data.seek(SeekFrom::Start(0)).await.expect("restore seek");
|
||||
let mut bytes = [0; 16];
|
||||
data.read_exact(&mut bytes).await.expect("small received bytes");
|
||||
assert_eq!(bytes, [1; 16], "RAFT_SM_BAD_SEEK_PRESERVES_BYTES");
|
||||
assert!(data.write_all(&[2; 2048]).await.is_err(), "RAFT_SM_RECEIVE_WRITE_BOUND_BEFORE_INSTALL");
|
||||
assert_eq!(sm.applied_state().await.expect("receive is not install").0, None);
|
||||
assert!(sm.get_current_snapshot().await.expect("no received publication").is_none());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_state_machine_install_rejects_meta_identity() {
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(2)).await;
|
||||
let mut snapshot = source.build().await;
|
||||
let bytes = snapshot_bytes(&mut snapshot).await;
|
||||
let mut target = Fixture::new(1);
|
||||
target.apply(entries(1)).await;
|
||||
let old_page = target.page().await;
|
||||
let stable = std::fs::read(target.directory.path().join("db")).expect("nonempty target bytes");
|
||||
let mut wrong = snapshot.meta.clone();
|
||||
wrong.last_log_id = Some(LogId { term: 9, ..id(2) }.into());
|
||||
let data = receive(&mut target.sm, &bytes).await;
|
||||
assert!(
|
||||
target.sm.install_snapshot(&wrong, data).await.is_err(),
|
||||
"SNAPSHOT_META_BOUND_TO_FRAME: full LogId term cannot differ from snapshot header"
|
||||
);
|
||||
assert_eq!(target.sm.applied_state().await.expect("rejection state").0, Some(id(1).into()));
|
||||
assert_eq!(target.page().await, old_page, "RAFT_SM_META_REJECTION_RETAINS_EVENTS");
|
||||
assert_eq!(
|
||||
std::fs::read(target.directory.path().join("db")).expect("unchanged nonempty target"),
|
||||
stable,
|
||||
"RAFT_SM_META_REJECTION_NO_MUTATION"
|
||||
);
|
||||
assert!(target.sm.get_current_snapshot().await.expect("rejection snapshot").is_none());
|
||||
let mut wrong = snapshot.meta.clone();
|
||||
wrong.last_membership = openraft::StoredMembership::default();
|
||||
let data = receive(&mut target.sm, &bytes).await;
|
||||
assert!(
|
||||
target.sm.install_snapshot(&wrong, data).await.is_err(),
|
||||
"RAFT_SM_MEMBERSHIP_BOUND_TO_FRAME"
|
||||
);
|
||||
let mut foreign = Fixture::with_identity_binding(
|
||||
NodeIdentity {
|
||||
cluster_id: [6; 16],
|
||||
..identity(1)
|
||||
},
|
||||
binding(),
|
||||
);
|
||||
let data = receive(&mut foreign.sm, &bytes).await;
|
||||
assert!(
|
||||
foreign.sm.install_snapshot(&snapshot.meta, data).await.is_err(),
|
||||
"RAFT_SM_CLUSTER_BOUND_TO_DURABLE_OWNER"
|
||||
);
|
||||
let mut foreign = Fixture::with_identity_binding(
|
||||
identity(1),
|
||||
CaptureBinding {
|
||||
target_id: [5; 16],
|
||||
..binding()
|
||||
},
|
||||
);
|
||||
let data = receive(&mut foreign.sm, &bytes).await;
|
||||
assert!(
|
||||
foreign.sm.install_snapshot(&snapshot.meta, data).await.is_err(),
|
||||
"RAFT_SM_CAPTURE_BINDING_BOUND"
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_state_machine_install_preserves_local_identity_vote() {
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(2)).await;
|
||||
let mut snapshot = source.build().await;
|
||||
snapshot.meta.snapshot_id = "foreign-snapshot-id-preserved-verbatim".into();
|
||||
let mut target = Fixture::new(1);
|
||||
let vote = openraft::Vote::new_committed(10, 1);
|
||||
target.logs.save_vote(&vote).await.expect("local election vote");
|
||||
install(&mut target.sm, &mut snapshot).await;
|
||||
assert_eq!(
|
||||
target.writer.durable_identity().await.expect("local identity"),
|
||||
identity(1),
|
||||
"RAFT_SM_INSTALL_PRESERVES_LOCAL_NODE"
|
||||
);
|
||||
assert_eq!(
|
||||
target.logs.read_vote().await.expect("local vote"),
|
||||
Some(vote),
|
||||
"RAFT_SM_INSTALL_PRESERVES_LOCAL_VOTE"
|
||||
);
|
||||
let mut current = target
|
||||
.sm
|
||||
.get_current_snapshot()
|
||||
.await
|
||||
.expect("installed snapshot")
|
||||
.expect("present");
|
||||
assert_eq!(current.meta, snapshot.meta, "RAFT_SM_INSTALL_PRESERVES_COMPLETE_INCOMING_META");
|
||||
assert_eq!(snapshot_bytes(&mut current).await, snapshot_bytes(&mut snapshot).await);
|
||||
let Fixture {
|
||||
directory,
|
||||
writer,
|
||||
logs,
|
||||
sm,
|
||||
identity,
|
||||
} = target;
|
||||
drop(current);
|
||||
drop(sm);
|
||||
drop(logs);
|
||||
drop(writer);
|
||||
let writer = NativeLogWriter::new(Store::open(directory.path().join("db"), identity).expect("restart installed target"));
|
||||
let mut logs = NativeRaftLogStore::new(writer.clone());
|
||||
let mut sm = NativeRaftStateMachine::new(writer.clone(), CheckpointLimits::default()).expect("reopened installed SM");
|
||||
assert_eq!(writer.durable_identity().await.expect("restarted local identity"), identity);
|
||||
assert_eq!(logs.read_vote().await.expect("restarted vote"), Some(vote));
|
||||
assert_eq!(
|
||||
sm.get_current_snapshot()
|
||||
.await
|
||||
.expect("restarted snapshot")
|
||||
.expect("present")
|
||||
.meta,
|
||||
snapshot.meta,
|
||||
"RAFT_SM_INCOMING_SNAPSHOT_ID_DURABLE"
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_state_machine_install_suffix() {
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(2)).await;
|
||||
let mut snapshot = source.build().await;
|
||||
let mut target = Fixture::new(1);
|
||||
target
|
||||
.logs
|
||||
.blocking_append(entries(4))
|
||||
.await
|
||||
.expect("retained local log suffix");
|
||||
target.sm.apply(entries(1)).await.expect("old local applied prefix");
|
||||
target
|
||||
.logs
|
||||
.save_committed(Some(id(4).into()))
|
||||
.await
|
||||
.expect("known committed compatible suffix");
|
||||
install(&mut target.sm, &mut snapshot).await;
|
||||
assert_eq!(
|
||||
target
|
||||
.logs
|
||||
.get_log_reader()
|
||||
.await
|
||||
.try_get_log_entries(3..)
|
||||
.await
|
||||
.expect("compatible suffix"),
|
||||
vec![entry(3), entry(4)],
|
||||
"RAFT_SM_INSTALL_PRESERVES_COMPATIBLE_COMMITTED_SUFFIX"
|
||||
);
|
||||
assert_eq!(
|
||||
target.logs.read_committed().await.expect("preserved committed marker"),
|
||||
Some(id(4).into())
|
||||
);
|
||||
target
|
||||
.sm
|
||||
.apply(vec![entry(3), entry(4)])
|
||||
.await
|
||||
.expect("apply retained committed suffix");
|
||||
assert_eq!(target.page().await.events.len(), 4);
|
||||
let mut conflict = Fixture::new(2);
|
||||
let mut batch = entries(4);
|
||||
for entry in &mut batch[2..] {
|
||||
entry.log_id = LogId {
|
||||
term: 9,
|
||||
..id(entry.log_id.index)
|
||||
}
|
||||
.into();
|
||||
}
|
||||
conflict
|
||||
.logs
|
||||
.blocking_append(batch)
|
||||
.await
|
||||
.expect("conflicting uncommitted suffix");
|
||||
conflict.sm.apply(entries(1)).await.expect("protected applied prefix");
|
||||
install(&mut conflict.sm, &mut snapshot).await;
|
||||
assert!(
|
||||
conflict
|
||||
.logs
|
||||
.get_log_reader()
|
||||
.await
|
||||
.try_get_log_entries(3..)
|
||||
.await
|
||||
.expect("discarded conflict")
|
||||
.is_empty(),
|
||||
"RAFT_SM_INSTALL_DROPS_ONLY_UNCOMMITTED_CONFLICT"
|
||||
);
|
||||
conflict.apply(vec![entry(3)]).await;
|
||||
assert_eq!(conflict.sm.applied_state().await.expect("new suffix applied").0, Some(id(3).into()));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_state_machine_install_restart_continue() {
|
||||
let mut source = Fixture::new(0);
|
||||
source.apply(entries(2)).await;
|
||||
let expected = source.page().await;
|
||||
let mut snapshot = source.build().await;
|
||||
let mut target = Fixture::new(1);
|
||||
install(&mut target.sm, &mut snapshot).await;
|
||||
assert_eq!(target.page().await, expected, "RAFT_SM_INSTALL_REBUILDS_SOURCE_EVENTS");
|
||||
let Fixture {
|
||||
directory,
|
||||
writer,
|
||||
logs,
|
||||
sm,
|
||||
identity,
|
||||
} = target;
|
||||
drop(sm);
|
||||
drop(logs);
|
||||
drop(writer);
|
||||
let writer = NativeLogWriter::new(Store::open(directory.path().join("db"), identity).expect("restart installed redb"));
|
||||
let mut logs = NativeRaftLogStore::new(writer.clone());
|
||||
let mut sm = NativeRaftStateMachine::new(writer.clone(), CheckpointLimits::default()).expect("restart installed adapter");
|
||||
assert_eq!(sm.applied_state().await.expect("snapshot applied state").0, Some(id(2).into()));
|
||||
logs.blocking_append(vec![entry(3)])
|
||||
.await
|
||||
.expect("append after install restart");
|
||||
sm.apply(vec![entry(3)]).await.expect("apply after install restart");
|
||||
let all = writer.created_events_page(None, 256).await.expect("retained plus new event");
|
||||
assert_eq!(all.events.len(), 3);
|
||||
assert_eq!(all.events[..2], expected.events);
|
||||
let next = writer
|
||||
.created_events_page(expected.next, 1)
|
||||
.await
|
||||
.expect("snapshot cursor resumes");
|
||||
assert_eq!(next.events[0].event_id, [3; 16], "RAFT_SM_INSTALL_CURSOR_CONTINUITY");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_state_machine_empty_snapshot_restart_continue() {
|
||||
let mut source = Fixture::new(0);
|
||||
let mut target = Fixture::new(42);
|
||||
let mut snapshot = source.sm.build_snapshot().await.expect("durable empty baseline");
|
||||
assert_eq!(snapshot.meta.last_log_id, None);
|
||||
let empty_meta = snapshot.meta.clone();
|
||||
let received = receive(&mut target.sm, &snapshot_bytes(&mut snapshot).await).await;
|
||||
target
|
||||
.sm
|
||||
.install_snapshot(&empty_meta, received)
|
||||
.await
|
||||
.expect("install empty frame");
|
||||
let mut target = target.reopen();
|
||||
let current = target
|
||||
.sm
|
||||
.get_current_snapshot()
|
||||
.await
|
||||
.expect("empty after reopen")
|
||||
.expect("durable selection");
|
||||
assert_eq!(current.meta, empty_meta);
|
||||
target
|
||||
.logs
|
||||
.blocking_append(entries(1))
|
||||
.await
|
||||
.expect("real append after empty install");
|
||||
target.sm.apply(entries(1)).await.expect("real apply after empty install");
|
||||
let mut target = target.reopen();
|
||||
assert_eq!(
|
||||
target.sm.applied_state().await.expect("replay empty baseline + suffix").0,
|
||||
Some(id(1).into())
|
||||
);
|
||||
assert_eq!(
|
||||
target
|
||||
.writer
|
||||
.created_events_page(None, 16)
|
||||
.await
|
||||
.expect("event after empty baseline")
|
||||
.events
|
||||
.len(),
|
||||
1
|
||||
);
|
||||
let refreshed = target
|
||||
.sm
|
||||
.build_snapshot()
|
||||
.await
|
||||
.expect("nonempty checkpoint supersedes empty");
|
||||
assert_eq!(refreshed.meta.last_log_id, Some(id(1).into()));
|
||||
}
|
||||
|
||||
impl Fixture {
|
||||
fn reopen(self) -> Self {
|
||||
let Self {
|
||||
directory,
|
||||
writer,
|
||||
logs,
|
||||
sm,
|
||||
identity,
|
||||
} = self;
|
||||
drop(sm);
|
||||
drop(logs);
|
||||
drop(writer);
|
||||
let writer =
|
||||
NativeLogWriter::new(Store::open(directory.path().join("db"), identity).expect("real empty baseline restart"));
|
||||
let logs = NativeRaftLogStore::new(writer.clone());
|
||||
let sm =
|
||||
NativeRaftStateMachine::new(writer.clone(), CheckpointLimits::default()).expect("reopened empty baseline adapter");
|
||||
Self {
|
||||
directory,
|
||||
writer,
|
||||
logs,
|
||||
sm,
|
||||
identity,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raft_state_machine_build_competes_with_initial_apply() {
|
||||
let mut target = Fixture::new(0);
|
||||
target
|
||||
.logs
|
||||
.blocking_append(entries(1))
|
||||
.await
|
||||
.expect("real pending initial batch");
|
||||
let entered = std::sync::Arc::new(tokio::sync::Notify::new());
|
||||
let resume = std::sync::Arc::new(tokio::sync::Notify::new());
|
||||
*target.sm.build_before_ordering.lock().expect("build pause") = Some((entered.clone(), resume.clone()));
|
||||
let mut builder = target.sm.get_snapshot_builder().await;
|
||||
let task = tokio::spawn(async move { builder.build_snapshot().await });
|
||||
tokio::time::timeout(std::time::Duration::from_secs(5), entered.notified())
|
||||
.await
|
||||
.expect("builder began before initial apply");
|
||||
target
|
||||
.sm
|
||||
.apply(entries(1))
|
||||
.await
|
||||
.expect("actual initial apply while builder pending");
|
||||
resume.notify_one();
|
||||
let snapshot = tokio::time::timeout(std::time::Duration::from_secs(5), task)
|
||||
.await
|
||||
.expect("build continues")
|
||||
.expect("builder task")
|
||||
.expect("initial apply does not make snapshot build a fatal storage error");
|
||||
assert_eq!(
|
||||
snapshot.meta.last_log_id,
|
||||
Some(id(1).into()),
|
||||
"SNAPSHOT_BUILD_INITIAL_APPLY_RACE_USES_NONEMPTY_CHECKPOINT"
|
||||
);
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,559 @@
|
||||
//! Disposable event ordering index. EVENTS remains the sole event authority.
|
||||
use crate::{
|
||||
CaptureBinding, CreatedEvent, CreatedResult, LogId, NativeLogWriter, NativeWriteError, Store, StoreError, application,
|
||||
decode_id, encode_id,
|
||||
};
|
||||
use redb::{ReadableDatabase, ReadableTable, ReadableTableMetadata, TableDefinition, WriteTransaction};
|
||||
|
||||
pub const MAX_EVENT_PAGE: usize = 256;
|
||||
pub(crate) const EVENT_SEQUENCE: TableDefinition<u64, &[u8]> = TableDefinition::new("event_sequence_cache_v1");
|
||||
|
||||
/// Persist only after every event preceding this cursor has a durable consumer ACK.
|
||||
/// Deserialization does not grant authority: each use checks the stored event.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct EventCursor {
|
||||
cluster: [u8; 16],
|
||||
term: u64,
|
||||
leader: u64,
|
||||
index: u64,
|
||||
event: [u8; 16],
|
||||
binding_id: [u8; 16],
|
||||
target_id: [u8; 16],
|
||||
revision: u64,
|
||||
}
|
||||
impl EventCursor {
|
||||
pub(crate) fn new(cluster: [u8; 16], event: [u8; 16], value: &CreatedEvent) -> Self {
|
||||
Self {
|
||||
cluster,
|
||||
term: value.decision_log_id.term,
|
||||
leader: value.decision_log_id.leader_node,
|
||||
index: value.decision_log_id.index,
|
||||
event,
|
||||
binding_id: value.binding.binding_id,
|
||||
target_id: value.binding.target_id,
|
||||
revision: value.binding.revision,
|
||||
}
|
||||
}
|
||||
fn matches(&self, cluster: [u8; 16], event: [u8; 16], value: &CreatedEvent) -> bool {
|
||||
self == &Self::new(cluster, event, value)
|
||||
}
|
||||
}
|
||||
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct SourceEvent {
|
||||
pub event_id: [u8; 16],
|
||||
pub captured: CreatedEvent,
|
||||
}
|
||||
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct EventPage {
|
||||
pub events: Vec<SourceEvent>,
|
||||
pub next: Option<EventCursor>,
|
||||
}
|
||||
fn encoded_index(id: LogId, event: [u8; 16]) -> Vec<u8> {
|
||||
let mut bytes = encode_id(id).to_vec();
|
||||
bytes.extend(event);
|
||||
bytes
|
||||
}
|
||||
fn decode_index(bytes: &[u8]) -> Result<(LogId, [u8; 16]), StoreError> {
|
||||
if bytes.len() != 40 {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let id = decode_id(&bytes[..24])?;
|
||||
let event: [u8; 16] = bytes[24..].try_into().map_err(|_| StoreError::CorruptRecord)?;
|
||||
if event == [0; 16] {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
Ok((id, event))
|
||||
}
|
||||
pub(crate) fn insert_event_index(tx: &WriteTransaction, id: LogId, event: [u8; 16]) -> Result<(), StoreError> {
|
||||
let bytes = encoded_index(id, event);
|
||||
let mut index = tx.open_table(EVENT_SEQUENCE)?;
|
||||
if index.get(id.index)?.is_some() {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
index.insert(id.index, bytes.as_slice())?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Check the event semantics required to derive ordering from checkpoint authority.
|
||||
/// This deliberately does not grant snapshot installation or source authority.
|
||||
fn validated_event(
|
||||
key: &[u8],
|
||||
bytes: &[u8],
|
||||
operations: &impl ReadableTable<&'static [u8], &'static [u8]>,
|
||||
versions: &impl ReadableTable<&'static [u8], &'static [u8]>,
|
||||
schema: u64,
|
||||
binding: &CaptureBinding,
|
||||
applied: Option<LogId>,
|
||||
) -> Result<([u8; 16], CreatedEvent), StoreError> {
|
||||
let event_id: [u8; 16] = key.try_into().map_err(|_| StoreError::CorruptRecord)?;
|
||||
let event = application::decode_event(bytes)?;
|
||||
let cut = applied.ok_or(StoreError::CorruptRecord)?;
|
||||
let operation = operations.get(key)?.ok_or(StoreError::CorruptRecord)?;
|
||||
let first_decision = if matches!(schema, 5 | 6 | 7) {
|
||||
Some(application::decode_provenance(operation.value())?.first_decision_log_id)
|
||||
} else {
|
||||
None
|
||||
};
|
||||
let operation = application::decode_stored_operation(operation.value(), schema)?;
|
||||
let command = crate::DecideCreated::decode(&operation.canonical_command)?;
|
||||
let version_key = application::version_key(&event.object, event.prepared.version_id)?;
|
||||
let version = versions.get(version_key.as_slice())?.ok_or(StoreError::CorruptRecord)?;
|
||||
let version = application::decode_version(version.value())?;
|
||||
if first_decision.is_some_and(|first| first != event.decision_log_id)
|
||||
|| event_id == [0; 16]
|
||||
|| event.decision_log_id.index > cut.index
|
||||
|| (event.decision_log_id.index == cut.index && event.decision_log_id != cut)
|
||||
|| event.binding != *binding
|
||||
|| command.operation_id != event_id
|
||||
|| command.object != event.object
|
||||
|| command.prepared != event.prepared
|
||||
|| command.binding_revision != event.binding.revision
|
||||
|| operation.result
|
||||
!= (CreatedResult::Created {
|
||||
version_id: event.prepared.version_id,
|
||||
event_id,
|
||||
decision_log_id: event.decision_log_id,
|
||||
})
|
||||
|| version
|
||||
!= (crate::CreatedVersion {
|
||||
prepared: event.prepared.clone(),
|
||||
decision_log_id: event.decision_log_id,
|
||||
binding_revision: event.binding.revision,
|
||||
})
|
||||
{
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
Ok((event_id, event))
|
||||
}
|
||||
|
||||
/// Rebuild from the same authority rows emitted by the existing four-section checkpoint.
|
||||
/// Callers must independently establish authority and validate all other state before promotion.
|
||||
pub(crate) fn rebuild_from_authority(
|
||||
tx: &WriteTransaction,
|
||||
schema: u64,
|
||||
binding: &CaptureBinding,
|
||||
applied: Option<LogId>,
|
||||
) -> Result<(), StoreError> {
|
||||
let events = tx.open_table(application::EVENTS)?;
|
||||
let operations = tx.open_table(application::OPERATIONS)?;
|
||||
let versions = tx.open_table(application::VERSIONS)?;
|
||||
{
|
||||
let mut index = tx.open_table(EVENT_SEQUENCE)?;
|
||||
index.retain(|_, _| false)?;
|
||||
}
|
||||
for row in events.iter()? {
|
||||
let (key, bytes) = row?;
|
||||
let (event, value) = validated_event(key.value(), bytes.value(), &operations, &versions, schema, binding, applied)?;
|
||||
insert_event_index(tx, value.decision_log_id, event)?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
impl Store {
|
||||
pub(crate) fn ensure_event_index(&mut self) -> Result<(), StoreError> {
|
||||
let read = self.database.begin_read()?;
|
||||
let meta = read.open_table(crate::META)?;
|
||||
let schema = crate::number(meta.get("schema")?.ok_or(StoreError::CorruptRecord)?.value())?;
|
||||
if !matches!(schema, 3..=7) {
|
||||
return Ok(());
|
||||
}
|
||||
let binding = application::read_binding(&meta)?;
|
||||
let applied = application::read_applied(&meta)?;
|
||||
let events = read.open_table(application::EVENTS)?;
|
||||
let complete = match read.open_table(EVENT_SEQUENCE) {
|
||||
Ok(index) => {
|
||||
let mut complete = index.len()? == events.len()?;
|
||||
if complete {
|
||||
for row in events.iter()? {
|
||||
let (key, bytes) = row?;
|
||||
let value = application::decode_event(bytes.value())?;
|
||||
let expected =
|
||||
encoded_index(value.decision_log_id, key.value().try_into().map_err(|_| StoreError::CorruptRecord)?);
|
||||
if index
|
||||
.get(value.decision_log_id.index)?
|
||||
.is_none_or(|stored| stored.value() != expected.as_slice())
|
||||
{
|
||||
complete = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
complete
|
||||
}
|
||||
Err(redb::TableError::TableDoesNotExist(_)) => false,
|
||||
Err(error) => return Err(error.into()),
|
||||
};
|
||||
drop(events);
|
||||
drop(meta);
|
||||
drop(read);
|
||||
if !complete {
|
||||
let tx = self.write_transaction()?;
|
||||
rebuild_from_authority(&tx, schema, &binding, applied)?;
|
||||
self.commit(tx)?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
/// Read a bounded page without changing any delivery ACK or cursor state.
|
||||
pub fn created_events_page(&self, cursor: Option<&EventCursor>, limit: usize) -> Result<EventPage, StoreError> {
|
||||
if !self.writable {
|
||||
return Err(StoreError::WriteDisabled);
|
||||
}
|
||||
if limit == 0 || limit > MAX_EVENT_PAGE {
|
||||
return Err(StoreError::InvalidEventPage);
|
||||
}
|
||||
let tx = self.database.begin_read()?;
|
||||
let meta = tx.open_table(crate::META)?;
|
||||
let schema = crate::number(meta.get("schema")?.ok_or(StoreError::CorruptRecord)?.value())?;
|
||||
if !matches!(schema, 3..=7) {
|
||||
return Err(StoreError::UnsupportedSchema);
|
||||
}
|
||||
let identity = crate::decode_identity(meta.get("identity")?.ok_or(StoreError::CorruptRecord)?.value())?;
|
||||
let events = tx.open_table(application::EVENTS)?;
|
||||
let index = tx.open_table(EVENT_SEQUENCE)?;
|
||||
if index.len()? != events.len()? {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
let read_event = |id: u64, bytes: &[u8]| -> Result<SourceEvent, StoreError> {
|
||||
let (log, event_id) = decode_index(bytes)?;
|
||||
let value = events.get(event_id.as_slice())?.ok_or(StoreError::CorruptRecord)?;
|
||||
let captured = application::decode_event(value.value())?;
|
||||
if log.index != id || captured.decision_log_id != log {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
Ok(SourceEvent { event_id, captured })
|
||||
};
|
||||
if let Some(cursor) = cursor {
|
||||
let stored = index.get(cursor.index)?.ok_or(StoreError::IdentityMismatch)?;
|
||||
let event = read_event(cursor.index, stored.value())?;
|
||||
if !cursor.matches(identity.cluster_id, event.event_id, &event.captured) {
|
||||
return Err(StoreError::IdentityMismatch);
|
||||
}
|
||||
}
|
||||
let start = cursor.map_or(0, |c| c.index);
|
||||
let range = if cursor.is_some() {
|
||||
(std::ops::Bound::Excluded(start), std::ops::Bound::Unbounded)
|
||||
} else {
|
||||
(std::ops::Bound::Included(start), std::ops::Bound::Unbounded)
|
||||
};
|
||||
let mut page = EventPage {
|
||||
events: Vec::with_capacity(limit),
|
||||
next: cursor.cloned(),
|
||||
};
|
||||
for row in index.range(range)?.take(limit) {
|
||||
let (id, bytes) = row?;
|
||||
let event = read_event(id.value(), bytes.value())?;
|
||||
page.next = Some(EventCursor::new(identity.cluster_id, event.event_id, &event.captured));
|
||||
page.events.push(event);
|
||||
}
|
||||
Ok(page)
|
||||
}
|
||||
}
|
||||
impl NativeLogWriter {
|
||||
pub async fn created_events_page(&self, cursor: Option<EventCursor>, limit: usize) -> Result<EventPage, NativeWriteError> {
|
||||
let owner = self.store.clone();
|
||||
tokio::task::spawn_blocking(move || {
|
||||
owner
|
||||
.lock()
|
||||
.map_err(|_| NativeWriteError::Poisoned)?
|
||||
.created_events_page(cursor.as_ref(), limit)
|
||||
.map_err(NativeWriteError::Store)
|
||||
})
|
||||
.await
|
||||
.map_err(NativeWriteError::Worker)?
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::{CaptureCommand, CaptureRaftEntry, DecideCreated, NodeIdentity, ObjectIdentity, PreparedIdentity, snapshot};
|
||||
use std::io;
|
||||
fn identity() -> NodeIdentity {
|
||||
NodeIdentity {
|
||||
cluster_id: [7; 16],
|
||||
node_id: 0,
|
||||
}
|
||||
}
|
||||
fn binding() -> CaptureBinding {
|
||||
CaptureBinding {
|
||||
revision: 9,
|
||||
binding_id: [8; 16],
|
||||
target_id: [9; 16],
|
||||
}
|
||||
}
|
||||
fn id(index: u64) -> LogId {
|
||||
LogId {
|
||||
term: 8,
|
||||
leader_node: 0,
|
||||
index,
|
||||
}
|
||||
}
|
||||
fn command(event: u8) -> DecideCreated {
|
||||
DecideCreated {
|
||||
operation_id: [event; 16],
|
||||
object: ObjectIdentity {
|
||||
bucket_incarnation: [2; 16],
|
||||
key: vec![event],
|
||||
},
|
||||
expected_head: None,
|
||||
prepared: PreparedIdentity {
|
||||
version_id: [event; 16],
|
||||
preparation_id: [4; 16],
|
||||
content_digest: [5; 32],
|
||||
content_length: 123,
|
||||
},
|
||||
binding_revision: 9,
|
||||
}
|
||||
}
|
||||
fn apply(store: &mut Store, index: u64, command: DecideCreated) -> CreatedResult {
|
||||
store
|
||||
.append_native(&[CaptureRaftEntry {
|
||||
log_id: id(index).into(),
|
||||
payload: openraft::EntryPayload::Normal(CaptureCommand::try_created(command).expect("command")),
|
||||
}])
|
||||
.expect("append native");
|
||||
store.save_committed(id(index)).expect("commit native");
|
||||
store
|
||||
.apply_next_native(id(index))
|
||||
.expect("apply native")
|
||||
.created_result()
|
||||
.expect("created response")
|
||||
.clone()
|
||||
}
|
||||
fn fixture() -> (tempfile::TempDir, Store) {
|
||||
let dir = tempfile::tempdir().expect("directory");
|
||||
let mut store = Store::initialize(dir.path().join("source.redb"), identity()).expect("initialize");
|
||||
store.pin_capture_binding(binding()).expect("pin");
|
||||
store.enable_native_empty().expect("native");
|
||||
apply(&mut store, 0, command(9));
|
||||
apply(&mut store, 1, command(7));
|
||||
(dir, store)
|
||||
}
|
||||
#[test]
|
||||
fn committed_events_page_in_decision_order() {
|
||||
let (_dir, store) = fixture();
|
||||
let first = store.created_events_page(None, 1).expect("first");
|
||||
assert_eq!(
|
||||
first.events.iter().map(|e| e.event_id).collect::<Vec<_>>(),
|
||||
vec![[9; 16]],
|
||||
"SOURCE_PAGE_ORDER_BOUND"
|
||||
);
|
||||
let next = store.created_events_page(first.next.as_ref(), 1).expect("second");
|
||||
assert_eq!(next.events[0].event_id, [7; 16]);
|
||||
assert_eq!(next.events[0].captured.binding, binding());
|
||||
assert!(
|
||||
store
|
||||
.created_events_page(next.next.as_ref(), 1)
|
||||
.expect("end")
|
||||
.events
|
||||
.is_empty()
|
||||
);
|
||||
}
|
||||
#[test]
|
||||
fn replay_and_rejections_do_not_duplicate_events() {
|
||||
let (_dir, mut store) = fixture();
|
||||
apply(&mut store, 2, command(9));
|
||||
let mut rejected = command(3);
|
||||
rejected.object = command(9).object;
|
||||
assert!(matches!(apply(&mut store, 3, rejected), CreatedResult::HeadMismatch { .. }));
|
||||
let page = store.created_events_page(None, 256).expect("page");
|
||||
assert_eq!(page.events.len(), 2, "SOURCE_PAGE_REPLAY_BOUND");
|
||||
}
|
||||
#[test]
|
||||
fn reopen_rebuilds_missing_or_stale_index() {
|
||||
let (dir, mut store) = fixture();
|
||||
apply(&mut store, 2, command(1));
|
||||
let expected = store.created_events_page(None, 256).expect("before");
|
||||
let tx = store.write_transaction().expect("remove cache");
|
||||
tx.delete_table(EVENT_SEQUENCE).expect("delete cache");
|
||||
store.commit(tx).expect("cache deletion");
|
||||
drop(store);
|
||||
let mut store = Store::open(dir.path().join("source.redb"), identity()).expect("rebuild missing");
|
||||
assert_eq!(store.created_events_page(None, 256).expect("rebuilt"), expected);
|
||||
let tx = store.write_transaction().expect("stale cache");
|
||||
{
|
||||
let mut index = tx.open_table(EVENT_SEQUENCE).expect("cache");
|
||||
index.remove(1).expect("omit middle item");
|
||||
index.insert(200, b"bad".as_slice()).expect("same-count stale item");
|
||||
}
|
||||
store.commit(tx).expect("cache damage");
|
||||
drop(store);
|
||||
let store = Store::open(dir.path().join("source.redb"), identity()).expect("rebuild stale");
|
||||
assert_eq!(store.created_events_page(None, 256).expect("rebuilt stale"), expected);
|
||||
}
|
||||
#[test]
|
||||
fn cursor_binds_cluster_term_leader_and_event() {
|
||||
let (_dir, store) = fixture();
|
||||
let cursor = store.created_events_page(None, 1).expect("page").next.expect("cursor");
|
||||
let mut bad = Vec::new();
|
||||
let mut c = cursor.clone();
|
||||
c.cluster = [6; 16];
|
||||
bad.push(c);
|
||||
let mut c = cursor.clone();
|
||||
c.term += 1;
|
||||
bad.push(c);
|
||||
let mut c = cursor.clone();
|
||||
c.leader += 1;
|
||||
bad.push(c);
|
||||
let mut c = cursor.clone();
|
||||
c.event = [7; 16];
|
||||
bad.push(c);
|
||||
let mut c = cursor.clone();
|
||||
c.revision += 1;
|
||||
bad.push(c);
|
||||
let mut c = cursor.clone();
|
||||
c.binding_id = [6; 16];
|
||||
bad.push(c);
|
||||
let mut c = cursor.clone();
|
||||
c.target_id = [6; 16];
|
||||
bad.push(c);
|
||||
for cursor in bad {
|
||||
assert_eq!(
|
||||
store.created_events_page(Some(&cursor), 1).err().map(|e| e.code()),
|
||||
Some("identity_mismatch"),
|
||||
"SOURCE_PAGE_CURSOR_BOUND"
|
||||
);
|
||||
}
|
||||
let encoded = serde_json::to_vec(&cursor).expect("cursor bytes");
|
||||
let decoded: EventCursor = serde_json::from_slice(&encoded).expect("cursor decode");
|
||||
assert_eq!(store.created_events_page(Some(&decoded), 1).expect("resume").events[0].event_id, [7; 16]);
|
||||
}
|
||||
#[test]
|
||||
fn page_is_bounded_and_new_lower_uuid_is_not_lost() {
|
||||
let (_dir, mut store) = fixture();
|
||||
let page = store.created_events_page(None, 1).expect("one");
|
||||
assert_eq!(page.events.len(), 1);
|
||||
apply(&mut store, 2, command(1));
|
||||
let next = store.created_events_page(page.next.as_ref(), 256).expect("later");
|
||||
assert_eq!(next.events.iter().map(|e| e.event_id).collect::<Vec<_>>(), vec![[7; 16], [1; 16]]);
|
||||
for limit in [0, MAX_EVENT_PAGE + 1, usize::MAX] {
|
||||
assert_eq!(store.created_events_page(None, limit).err().map(|e| e.code()), Some("invalid_event_page"));
|
||||
}
|
||||
store.writable = false;
|
||||
assert_eq!(store.created_events_page(None, 1).err().map(|e| e.code()), Some("write_disabled"));
|
||||
store.writable = true;
|
||||
let mut max = page.next.expect("cursor");
|
||||
max.index = u64::MAX;
|
||||
assert_eq!(
|
||||
store.created_events_page(Some(&max), 1).err().map(|e| e.code()),
|
||||
Some("identity_mismatch")
|
||||
);
|
||||
}
|
||||
struct Staging<'a>(&'a WriteTransaction);
|
||||
impl snapshot::StagingSink for Staging<'_> {
|
||||
fn row(&mut self, section: snapshot::Section, key: &[u8], value: &[u8]) -> io::Result<()> {
|
||||
let table = match section {
|
||||
snapshot::Section::Heads => application::HEADS,
|
||||
snapshot::Section::Versions => application::VERSIONS,
|
||||
snapshot::Section::Events => application::EVENTS,
|
||||
snapshot::Section::Operations => application::OPERATIONS,
|
||||
};
|
||||
self.0
|
||||
.open_table(table)
|
||||
.map_err(io::Error::other)?
|
||||
.insert(key, value)
|
||||
.map_err(io::Error::other)?;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
fn limits() -> snapshot::Limits {
|
||||
snapshot::Limits {
|
||||
total_bytes: 1_048_576,
|
||||
membership_bytes: 4096,
|
||||
key_bytes: 4096,
|
||||
value_bytes: 8192,
|
||||
records: 1024,
|
||||
}
|
||||
}
|
||||
async fn artifact(store: Store) -> (snapshot::CapabilityArtifact<Vec<u8>>, EventPage) {
|
||||
let writer = NativeLogWriter::new(store);
|
||||
let before = writer.created_events_page(None, 256).await.expect("async page");
|
||||
let artifact = writer
|
||||
.snapshot_view()
|
||||
.await
|
||||
.expect("snapshot view")
|
||||
.stream_capability_artifact(Vec::new(), limits())
|
||||
.expect("capability export");
|
||||
(artifact, before)
|
||||
}
|
||||
fn stage(artifact: snapshot::CapabilityArtifact<Vec<u8>>, damage: bool) -> Result<(tempfile::TempDir, Store), StoreError> {
|
||||
let dir = tempfile::tempdir().expect("stage directory");
|
||||
let database = redb::Database::create(dir.path().join("stage.redb")).expect("isolated database");
|
||||
let tx = database.begin_write()?;
|
||||
let header = snapshot::decode_capability_artifact(
|
||||
snapshot::CapabilityArtifact {
|
||||
manifest: artifact.manifest,
|
||||
payload: std::io::Cursor::new(artifact.payload),
|
||||
},
|
||||
&mut Staging(&tx),
|
||||
limits(),
|
||||
)
|
||||
.expect("real capability decoder");
|
||||
if damage {
|
||||
let mut events = tx.open_table(application::EVENTS)?;
|
||||
let value = events.get([9; 16].as_slice())?.expect("event").value().to_vec();
|
||||
events.insert([6; 16].as_slice(), value.as_slice())?;
|
||||
events.remove([9; 16].as_slice())?;
|
||||
}
|
||||
rebuild_from_authority(&tx, 6, &header.binding, header.applied)?;
|
||||
{
|
||||
let mut meta = tx.open_table(crate::META)?;
|
||||
meta.insert("schema", 6u64.to_be_bytes().as_slice())?;
|
||||
meta.insert(
|
||||
"identity",
|
||||
crate::encode_identity(NodeIdentity {
|
||||
cluster_id: header.cluster_id,
|
||||
..identity()
|
||||
})
|
||||
.as_slice(),
|
||||
)?;
|
||||
meta.insert("capture_binding", crate::created::binding_bytes(&header.binding)?.as_slice())?;
|
||||
let mut applied = vec![1];
|
||||
applied.extend(encode_id(header.applied.expect("cut")));
|
||||
meta.insert("last_applied", applied.as_slice())?;
|
||||
}
|
||||
tx.commit().expect("stage commit");
|
||||
// A test-only staging handle, not a production installer or authority grant.
|
||||
Ok((
|
||||
dir,
|
||||
Store {
|
||||
database,
|
||||
writable: true,
|
||||
},
|
||||
))
|
||||
}
|
||||
#[tokio::test]
|
||||
async fn snapshot_authority_rebuild_matches_source() {
|
||||
let (_dir, mut store) = fixture();
|
||||
apply(&mut store, 2, command(9));
|
||||
let mut rejected = command(3);
|
||||
rejected.object = command(9).object;
|
||||
apply(&mut store, 3, rejected);
|
||||
store.promote_created_provenance().expect("schema6");
|
||||
let (artifact, before) = artifact(store).await;
|
||||
let (_stage, restored) = stage(artifact, false).expect("staged authority index");
|
||||
assert_eq!(
|
||||
restored.created_events_page(None, 256).expect("restored page"),
|
||||
before,
|
||||
"SOURCE_PAGE_SNAPSHOT_BOUND"
|
||||
);
|
||||
let first = restored.created_events_page(None, 1).expect("first");
|
||||
assert_eq!(
|
||||
restored.created_events_page(first.next.as_ref(), 1).expect("resume").events[0],
|
||||
before.events[1]
|
||||
);
|
||||
}
|
||||
#[tokio::test]
|
||||
async fn snapshot_event_operation_mismatch_rejected() {
|
||||
let (_dir, mut store) = fixture();
|
||||
store.promote_created_provenance().expect("schema6");
|
||||
let (artifact, _) = artifact(store).await;
|
||||
assert_eq!(
|
||||
stage(artifact, true).err().map(|e| e.code()),
|
||||
Some("corrupt_record"),
|
||||
"SOURCE_PAGE_SNAPSHOT_BOUND"
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,451 @@
|
||||
//! Same-UID local reads from an owner's live native store. No ACK or cursor writes.
|
||||
use crate::{EventCursor, EventPage, NativeLogWriter, NativeWriteError, NodeIdentity, StoreError};
|
||||
use redb::ReadableDatabase;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use std::{
|
||||
fs, io,
|
||||
os::unix::fs::{FileTypeExt, MetadataExt, PermissionsExt},
|
||||
path::{Path, PathBuf},
|
||||
time::Duration,
|
||||
};
|
||||
use tokio::{
|
||||
io::{AsyncReadExt, AsyncWriteExt},
|
||||
net::{UnixListener, UnixStream},
|
||||
sync::{OwnedSemaphorePermit, watch},
|
||||
task::JoinSet,
|
||||
};
|
||||
|
||||
pub const WIRE_VERSION: u16 = 1;
|
||||
pub const MAX_REQUEST_BYTES: usize = 4096;
|
||||
pub const MAX_RESPONSE_BYTES: usize = 8 * 1024 * 1024;
|
||||
pub const MAX_CONNECTIONS: usize = 4;
|
||||
pub const IO_TIMEOUT: Duration = Duration::from_secs(5);
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct ReadPage {
|
||||
pub version: u16,
|
||||
pub expected_cluster: [u8; 16],
|
||||
pub cursor: Option<EventCursor>,
|
||||
pub limit: usize,
|
||||
}
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct ReadPageResponse {
|
||||
pub version: u16,
|
||||
pub identity: NodeIdentity,
|
||||
pub page: EventPage,
|
||||
}
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
|
||||
pub enum Rejection {
|
||||
InvalidRequest,
|
||||
WrongCluster,
|
||||
InvalidCursor,
|
||||
StoreUnavailable,
|
||||
ResponseLimit,
|
||||
}
|
||||
#[derive(Debug, Serialize, Deserialize)]
|
||||
#[serde(tag = "status", deny_unknown_fields)]
|
||||
pub enum ReadPageReply {
|
||||
Page { response: ReadPageResponse },
|
||||
Rejected { version: u16, error: Rejection },
|
||||
}
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
pub enum ReaderError {
|
||||
#[error("SOURCE_READER_IO")]
|
||||
Io(#[from] io::Error),
|
||||
#[error("SOURCE_READER_PERMISSION")]
|
||||
Permission,
|
||||
#[error("SOURCE_READER_PATH_OCCUPIED")]
|
||||
Occupied,
|
||||
#[error("SOURCE_READER_PATH_CHANGED")]
|
||||
PathChanged,
|
||||
#[error("SOURCE_READER_TIMEOUT")]
|
||||
Timeout,
|
||||
#[error("SOURCE_READER_PROTOCOL")]
|
||||
Protocol,
|
||||
#[error("SOURCE_READER_REJECTED: {0:?}")]
|
||||
Rejected(Rejection),
|
||||
#[error("SOURCE_READER_WORKER")]
|
||||
Worker(#[source] tokio::task::JoinError),
|
||||
}
|
||||
|
||||
impl crate::Store {
|
||||
fn durable_source_identity(&self) -> Result<NodeIdentity, StoreError> {
|
||||
let tx = self.database.begin_read()?;
|
||||
let meta = tx.open_table(crate::META)?;
|
||||
let identity = meta.get("identity")?.ok_or(StoreError::CorruptRecord)?;
|
||||
crate::decode_identity(identity.value())
|
||||
}
|
||||
}
|
||||
impl NativeLogWriter {
|
||||
/// Read the validated durable identity, never an owner-supplied cluster label.
|
||||
pub async fn durable_identity(&self) -> Result<NodeIdentity, NativeWriteError> {
|
||||
let owner = self.store.clone();
|
||||
tokio::task::spawn_blocking(move || {
|
||||
owner
|
||||
.lock()
|
||||
.map_err(|_| NativeWriteError::Poisoned)?
|
||||
.durable_source_identity()
|
||||
.map_err(NativeWriteError::Store)
|
||||
})
|
||||
.await
|
||||
.map_err(NativeWriteError::Worker)?
|
||||
}
|
||||
}
|
||||
|
||||
fn uid() -> u32 {
|
||||
rustix::process::geteuid().as_raw()
|
||||
}
|
||||
fn fingerprint(meta: &fs::Metadata) -> (u64, u64) {
|
||||
(meta.dev(), meta.ino())
|
||||
}
|
||||
fn private_parent(path: &Path) -> Result<(PathBuf, (u64, u64)), ReaderError> {
|
||||
if !path.is_absolute() || path.file_name().is_none() {
|
||||
return Err(ReaderError::Permission);
|
||||
}
|
||||
let parent = path.parent().ok_or(ReaderError::Permission)?;
|
||||
let meta = fs::symlink_metadata(parent)?;
|
||||
if !meta.is_dir() || meta.uid() != uid() || meta.mode() & 0o077 != 0 {
|
||||
return Err(ReaderError::Permission);
|
||||
}
|
||||
let resolved = fs::canonicalize(parent)?;
|
||||
let resolved_meta = fs::symlink_metadata(&resolved)?;
|
||||
if fingerprint(&meta) != fingerprint(&resolved_meta) {
|
||||
return Err(ReaderError::PathChanged);
|
||||
}
|
||||
Ok((resolved.join(path.file_name().ok_or(ReaderError::Permission)?), fingerprint(&meta)))
|
||||
}
|
||||
fn owned_socket(path: &Path) -> Result<fs::Metadata, ReaderError> {
|
||||
let meta = fs::symlink_metadata(path)?;
|
||||
if !meta.file_type().is_socket() || meta.uid() != uid() {
|
||||
return Err(ReaderError::Permission);
|
||||
}
|
||||
Ok(meta)
|
||||
}
|
||||
fn socket_metadata(path: &Path) -> Result<(u64, u64), ReaderError> {
|
||||
let meta = owned_socket(path)?;
|
||||
if meta.mode() & 0o077 != 0 {
|
||||
return Err(ReaderError::Permission);
|
||||
}
|
||||
Ok(fingerprint(&meta))
|
||||
}
|
||||
fn peer(stream: &UnixStream) -> Result<(), ReaderError> {
|
||||
if stream.peer_cred()?.uid() != uid() {
|
||||
return Err(ReaderError::Permission);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
struct SocketPath {
|
||||
path: PathBuf,
|
||||
inode: Option<(u64, u64)>,
|
||||
parent: (u64, u64),
|
||||
}
|
||||
impl SocketPath {
|
||||
fn remove(&mut self) -> Result<(), ReaderError> {
|
||||
// One cleanup attempt only: never let Drop re-evaluate a later namespace.
|
||||
let Some(inode) = self.inode.take() else {
|
||||
return Ok(());
|
||||
};
|
||||
let (_, parent) = private_parent(&self.path)?;
|
||||
if parent != self.parent || fingerprint(&owned_socket(&self.path)?) != inode {
|
||||
return Err(ReaderError::PathChanged);
|
||||
}
|
||||
fs::remove_file(&self.path)?;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
impl Drop for SocketPath {
|
||||
fn drop(&mut self) {
|
||||
// Explicit shutdown reports cleanup failure; cancellation preserves detected replacements.
|
||||
let _ = self.remove();
|
||||
}
|
||||
}
|
||||
|
||||
/// Signal shutdown, then await the owner's `serve` task to drain workers and clean up.
|
||||
#[derive(Clone)]
|
||||
pub struct Shutdown(watch::Sender<bool>);
|
||||
impl Shutdown {
|
||||
pub fn shutdown(&self) {
|
||||
let _ = self.0.send(true);
|
||||
}
|
||||
}
|
||||
pub struct SourceReaderServer {
|
||||
listener: UnixListener,
|
||||
writer: NativeLogWriter,
|
||||
socket: SocketPath,
|
||||
shutdown: watch::Receiver<bool>,
|
||||
}
|
||||
impl SourceReaderServer {
|
||||
pub fn bind(path: impl AsRef<Path>, writer: NativeLogWriter) -> Result<(Self, Shutdown), ReaderError> {
|
||||
let (path, parent) = private_parent(path.as_ref())?;
|
||||
match fs::symlink_metadata(&path) {
|
||||
Ok(_) => return Err(ReaderError::Occupied),
|
||||
Err(error) if error.kind() == io::ErrorKind::NotFound => {}
|
||||
Err(error) => return Err(error.into()),
|
||||
}
|
||||
// The private parent prevents a foreign UID from observing the initial socket mode.
|
||||
let listener = UnixListener::bind(&path)?;
|
||||
let inode = fingerprint(&fs::symlink_metadata(&path)?);
|
||||
let socket = SocketPath {
|
||||
path,
|
||||
inode: Some(inode),
|
||||
parent,
|
||||
};
|
||||
fs::set_permissions(&socket.path, fs::Permissions::from_mode(0o600))?;
|
||||
if private_parent(&socket.path)?.1 != parent || socket_metadata(&socket.path)? != inode {
|
||||
return Err(ReaderError::PathChanged);
|
||||
}
|
||||
let (sender, shutdown) = watch::channel(false);
|
||||
Ok((
|
||||
Self {
|
||||
listener,
|
||||
writer,
|
||||
socket,
|
||||
shutdown,
|
||||
},
|
||||
Shutdown(sender),
|
||||
))
|
||||
}
|
||||
pub async fn serve(mut self) -> Result<(), ReaderError> {
|
||||
let mut tasks = JoinSet::new();
|
||||
let outcome = async {
|
||||
loop {
|
||||
if *self.shutdown.borrow() {
|
||||
break;
|
||||
}
|
||||
// Admission is shared by every clone of this writer, including re-bound services.
|
||||
let admission = self.writer.source_reader_admission.clone();
|
||||
let permit = tokio::select! {
|
||||
result = admission.acquire_owned() => result.map_err(|_| ReaderError::Protocol)?,
|
||||
_ = self.shutdown.changed() => break,
|
||||
};
|
||||
let stream = tokio::select! {
|
||||
result = self.listener.accept() => result?.0,
|
||||
_ = self.shutdown.changed() => break,
|
||||
};
|
||||
if peer(&stream).is_err() {
|
||||
continue;
|
||||
}
|
||||
let writer = self.writer.clone();
|
||||
tasks.spawn(async move {
|
||||
let _ = connection(stream, writer, permit).await;
|
||||
});
|
||||
while let Some(result) = tasks.try_join_next() {
|
||||
result.map_err(ReaderError::Worker)?;
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
.await;
|
||||
// Ordinary shutdown drains connections and blocking workers, never aborts storage work.
|
||||
while let Some(result) = tasks.join_next().await {
|
||||
result.map_err(ReaderError::Worker)?;
|
||||
}
|
||||
drop(self.listener);
|
||||
self.socket.remove()?;
|
||||
outcome
|
||||
}
|
||||
}
|
||||
|
||||
fn reject(error: Rejection) -> ReadPageReply {
|
||||
ReadPageReply::Rejected {
|
||||
version: WIRE_VERSION,
|
||||
error,
|
||||
}
|
||||
}
|
||||
fn read_page(writer: &NativeLogWriter, request: ReadPage) -> ReadPageReply {
|
||||
if request.version != WIRE_VERSION
|
||||
|| request.expected_cluster == [0; 16]
|
||||
|| request.limit == 0
|
||||
|| request.limit > crate::MAX_EVENT_PAGE
|
||||
{
|
||||
return reject(Rejection::InvalidRequest);
|
||||
}
|
||||
// Lock order: connection admission, then Store. Native reads take no writer-ordering lock.
|
||||
let read = || -> Result<ReadPageReply, NativeWriteError> {
|
||||
let store = writer.store.lock().map_err(|_| NativeWriteError::Poisoned)?;
|
||||
let identity = store.durable_source_identity()?;
|
||||
if identity.cluster_id != request.expected_cluster {
|
||||
return Ok(reject(Rejection::WrongCluster));
|
||||
}
|
||||
let page = match store.created_events_page(request.cursor.as_ref(), request.limit) {
|
||||
Ok(page) => page,
|
||||
Err(StoreError::IdentityMismatch) => return Ok(reject(Rejection::InvalidCursor)),
|
||||
Err(error) => return Err(error.into()),
|
||||
};
|
||||
Ok(ReadPageReply::Page {
|
||||
response: ReadPageResponse {
|
||||
version: WIRE_VERSION,
|
||||
identity,
|
||||
page,
|
||||
},
|
||||
})
|
||||
};
|
||||
read().unwrap_or_else(|_| reject(Rejection::StoreUnavailable))
|
||||
}
|
||||
|
||||
struct BoundedBytes {
|
||||
bytes: Vec<u8>,
|
||||
limit: usize,
|
||||
}
|
||||
impl io::Write for BoundedBytes {
|
||||
fn write(&mut self, bytes: &[u8]) -> io::Result<usize> {
|
||||
if bytes.len() > self.limit.saturating_sub(self.bytes.len()) {
|
||||
return Err(io::Error::other("source reader frame limit"));
|
||||
}
|
||||
self.bytes.extend_from_slice(bytes);
|
||||
Ok(bytes.len())
|
||||
}
|
||||
fn flush(&mut self) -> io::Result<()> {
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
fn encode(value: &impl Serialize, limit: usize) -> Result<Vec<u8>, ReaderError> {
|
||||
let mut buffer = BoundedBytes {
|
||||
bytes: Vec::new(),
|
||||
limit,
|
||||
};
|
||||
serde_json::to_writer(&mut buffer, value).map_err(|_| ReaderError::Protocol)?;
|
||||
Ok(buffer.bytes)
|
||||
}
|
||||
async fn frame_read(stream: &mut UnixStream, limit: usize) -> Result<Vec<u8>, ReaderError> {
|
||||
let len = usize::try_from(stream.read_u32().await?).map_err(|_| ReaderError::Protocol)?;
|
||||
if len == 0 || len > limit {
|
||||
return Err(ReaderError::Protocol);
|
||||
}
|
||||
let mut bytes = vec![0; len];
|
||||
stream.read_exact(&mut bytes).await?;
|
||||
Ok(bytes)
|
||||
}
|
||||
async fn frame_write(stream: &mut UnixStream, bytes: &[u8]) -> Result<(), ReaderError> {
|
||||
stream
|
||||
.write_u32(u32::try_from(bytes.len()).map_err(|_| ReaderError::Protocol)?)
|
||||
.await?;
|
||||
stream.write_all(bytes).await?;
|
||||
Ok(())
|
||||
}
|
||||
async fn connection(mut stream: UnixStream, writer: NativeLogWriter, permit: OwnedSemaphorePermit) -> Result<(), ReaderError> {
|
||||
let bytes = tokio::time::timeout(IO_TIMEOUT, frame_read(&mut stream, MAX_REQUEST_BYTES))
|
||||
.await
|
||||
.map_err(|_| ReaderError::Timeout)??;
|
||||
let request: ReadPage = match serde_json::from_slice(&bytes) {
|
||||
Ok(request) => request,
|
||||
Err(_) => {
|
||||
let bytes = encode(&reject(Rejection::InvalidRequest), MAX_RESPONSE_BYTES)?;
|
||||
return tokio::time::timeout(IO_TIMEOUT, frame_write(&mut stream, &bytes))
|
||||
.await
|
||||
.map_err(|_| ReaderError::Timeout)?;
|
||||
}
|
||||
};
|
||||
// The blocking worker owns admission until read + bounded serialization finish, even
|
||||
// if a deadline, shutdown or a dropped serve task cancels its awaiting connection.
|
||||
let (bytes, _permit) = tokio::task::spawn_blocking(move || {
|
||||
let reply = read_page(&writer, request);
|
||||
let bytes = encode(&reply, MAX_RESPONSE_BYTES).or_else(|_| encode(&reject(Rejection::ResponseLimit), MAX_RESPONSE_BYTES));
|
||||
(bytes, permit)
|
||||
})
|
||||
.await
|
||||
.map_err(ReaderError::Worker)?;
|
||||
tokio::time::timeout(IO_TIMEOUT, frame_write(&mut stream, &bytes?))
|
||||
.await
|
||||
.map_err(|_| ReaderError::Timeout)?
|
||||
}
|
||||
|
||||
/// Connect only to a private socket owned by the effective UID, verified at both ends.
|
||||
#[derive(Clone)]
|
||||
pub struct SourceReaderClient {
|
||||
path: PathBuf,
|
||||
}
|
||||
impl SourceReaderClient {
|
||||
pub fn new(path: impl AsRef<Path>) -> Result<Self, ReaderError> {
|
||||
let (path, _) = private_parent(path.as_ref())?;
|
||||
socket_metadata(&path)?;
|
||||
Ok(Self { path })
|
||||
}
|
||||
pub async fn page(
|
||||
&self,
|
||||
expected_cluster: [u8; 16],
|
||||
cursor: Option<EventCursor>,
|
||||
limit: usize,
|
||||
) -> Result<ReadPageResponse, ReaderError> {
|
||||
let request = ReadPage {
|
||||
version: WIRE_VERSION,
|
||||
expected_cluster,
|
||||
cursor,
|
||||
limit,
|
||||
};
|
||||
tokio::time::timeout(IO_TIMEOUT, self.page_inner(request))
|
||||
.await
|
||||
.map_err(|_| ReaderError::Timeout)?
|
||||
}
|
||||
async fn page_inner(&self, request: ReadPage) -> Result<ReadPageResponse, ReaderError> {
|
||||
let (_, parent) = private_parent(&self.path)?;
|
||||
let inode = socket_metadata(&self.path)?;
|
||||
let mut stream = UnixStream::connect(&self.path).await?;
|
||||
peer(&stream)?;
|
||||
if private_parent(&self.path)?.1 != parent || socket_metadata(&self.path)? != inode {
|
||||
return Err(ReaderError::PathChanged);
|
||||
}
|
||||
frame_write(&mut stream, &encode(&request, MAX_REQUEST_BYTES)?).await?;
|
||||
let bytes = frame_read(&mut stream, MAX_RESPONSE_BYTES).await?;
|
||||
match serde_json::from_slice::<ReadPageReply>(&bytes).map_err(|_| ReaderError::Protocol)? {
|
||||
ReadPageReply::Page { response } => {
|
||||
if response.version != WIRE_VERSION
|
||||
|| response.identity.cluster_id != request.expected_cluster
|
||||
|| response.identity.cluster_id == [0; 16]
|
||||
|| response.page.events.len() > request.limit
|
||||
|| request.limit == 0
|
||||
|| request.limit > crate::MAX_EVENT_PAGE
|
||||
{
|
||||
return Err(ReaderError::Protocol);
|
||||
}
|
||||
let next = response
|
||||
.page
|
||||
.events
|
||||
.last()
|
||||
.map(|event| EventCursor::new(response.identity.cluster_id, event.event_id, &event.captured))
|
||||
.or(request.cursor);
|
||||
if response.page.next != next {
|
||||
return Err(ReaderError::Protocol);
|
||||
}
|
||||
Ok(response)
|
||||
}
|
||||
ReadPageReply::Rejected { version, error } if version == WIRE_VERSION => Err(ReaderError::Rejected(error)),
|
||||
_ => Err(ReaderError::Protocol),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod cleanup_tests {
|
||||
use super::*;
|
||||
#[test]
|
||||
fn source_reader_cleanup_is_disarmed_before_rebind() {
|
||||
let directory = tempfile::tempdir().expect("private socket owner");
|
||||
fs::set_permissions(directory.path(), fs::Permissions::from_mode(0o700)).expect("private directory mode");
|
||||
let (path, parent) = private_parent(&directory.path().join("reader.sock")).expect("private path");
|
||||
let listener = std::os::unix::net::UnixListener::bind(&path).expect("first real socket");
|
||||
fs::set_permissions(&path, fs::Permissions::from_mode(0o600)).expect("first socket mode");
|
||||
let inode = socket_metadata(&path).expect("first socket identity");
|
||||
let mut guard = SocketPath {
|
||||
path: path.clone(),
|
||||
inode: Some(inode),
|
||||
parent,
|
||||
};
|
||||
drop(listener);
|
||||
guard.remove().expect("explicit owner cleanup");
|
||||
assert!(guard.inode.is_none(), "SOURCE_READER_CLEANUP_DISARMED");
|
||||
let listener = std::os::unix::net::UnixListener::bind(&path).expect("immediate new owner bind");
|
||||
fs::set_permissions(&path, fs::Permissions::from_mode(0o600)).expect("new socket mode");
|
||||
let replacement = socket_metadata(&path).expect("new owner socket");
|
||||
drop(guard);
|
||||
assert_eq!(
|
||||
socket_metadata(&path).expect("new socket preserved"),
|
||||
replacement,
|
||||
"SOURCE_READER_OLD_GUARD_PRESERVES_REBIND"
|
||||
);
|
||||
let _client = std::os::unix::net::UnixStream::connect(&path).expect("new service reachable");
|
||||
let _connection = listener.accept().expect("new owner accepts");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,502 @@
|
||||
//! Real NativeLogWriter and socket owner is this test process, not a production S3 owner.
|
||||
use crate::{source_reader::*, *};
|
||||
use std::{
|
||||
collections::{BTreeMap, BTreeSet},
|
||||
os::unix::fs::{MetadataExt, PermissionsExt},
|
||||
path::PathBuf,
|
||||
};
|
||||
use tokio::{
|
||||
io::{AsyncReadExt, AsyncWriteExt},
|
||||
net::UnixStream,
|
||||
};
|
||||
fn identity() -> NodeIdentity {
|
||||
NodeIdentity {
|
||||
cluster_id: [7; 16],
|
||||
node_id: 0,
|
||||
}
|
||||
}
|
||||
fn binding() -> CaptureBinding {
|
||||
CaptureBinding {
|
||||
revision: 9,
|
||||
binding_id: [8; 16],
|
||||
target_id: [9; 16],
|
||||
}
|
||||
}
|
||||
fn id(index: u64) -> LogId {
|
||||
LogId {
|
||||
term: 8,
|
||||
leader_node: 0,
|
||||
index,
|
||||
}
|
||||
}
|
||||
fn command(event: u8) -> DecideCreated {
|
||||
DecideCreated {
|
||||
operation_id: [event; 16],
|
||||
object: ObjectIdentity {
|
||||
bucket_incarnation: [2; 16],
|
||||
key: vec![event],
|
||||
},
|
||||
expected_head: None,
|
||||
prepared: PreparedIdentity {
|
||||
version_id: [event; 16],
|
||||
preparation_id: [4; 16],
|
||||
content_digest: [5; 32],
|
||||
content_length: 123,
|
||||
},
|
||||
binding_revision: 9,
|
||||
}
|
||||
}
|
||||
fn fixture() -> (tempfile::TempDir, NativeLogWriter) {
|
||||
let dir = tempfile::tempdir().expect("real source reader directory");
|
||||
std::fs::set_permissions(dir.path(), std::fs::Permissions::from_mode(0o700)).expect("private owner directory");
|
||||
let mut store = Store::initialize(dir.path().join("db"), identity()).expect("initialize real redb");
|
||||
store.pin_capture_binding(binding()).expect("binding");
|
||||
store.enable_native_empty().expect("native schema");
|
||||
store.promote_created_provenance().expect("provenance");
|
||||
let membership = CaptureMembership::new(
|
||||
Some(id(0)),
|
||||
vec![BTreeSet::from([0])],
|
||||
BTreeMap::from([(0, CaptureNode::new("http://127.0.0.1:7000".into()).expect("member"))]),
|
||||
)
|
||||
.expect("membership");
|
||||
let membership = openraft::StoredMembership::try_from(&membership).expect("stored membership");
|
||||
store
|
||||
.append_native(&[CaptureRaftEntry {
|
||||
log_id: id(0).into(),
|
||||
payload: openraft::EntryPayload::Membership(membership.membership().clone()),
|
||||
}])
|
||||
.expect("membership log");
|
||||
store.save_committed(id(0)).expect("membership commit");
|
||||
store.apply_next_native(id(0)).expect("membership apply");
|
||||
(dir, NativeLogWriter::new(store))
|
||||
}
|
||||
async fn apply(writer: &NativeLogWriter, index: u64, event: u8) {
|
||||
let entry = CaptureRaftEntry {
|
||||
log_id: id(index).into(),
|
||||
payload: openraft::EntryPayload::Normal(CaptureCommand::try_created(command(event)).expect("canonical native command")),
|
||||
};
|
||||
writer
|
||||
.append_native(vec![entry.clone()])
|
||||
.await
|
||||
.expect("live durable log append");
|
||||
let response = writer.apply_committed(vec![entry]).await.expect("live committed apply");
|
||||
assert!(
|
||||
matches!(response[0].created_result(), Some(CreatedResult::Created { .. })),
|
||||
"SOURCE_READER_REAL_APPLY"
|
||||
);
|
||||
}
|
||||
fn start(
|
||||
dir: &tempfile::TempDir,
|
||||
writer: &NativeLogWriter,
|
||||
) -> (PathBuf, SourceReaderClient, Shutdown, tokio::task::JoinHandle<Result<(), ReaderError>>) {
|
||||
let path = dir.path().join("reader.sock");
|
||||
let (server, shutdown) = SourceReaderServer::bind(&path, writer.clone()).expect("owner socket bind");
|
||||
let client = SourceReaderClient::new(&path).expect("trusted local client");
|
||||
let task = tokio::spawn(server.serve());
|
||||
(path, client, shutdown, task)
|
||||
}
|
||||
async fn stop(path: PathBuf, shutdown: Shutdown, task: tokio::task::JoinHandle<Result<(), ReaderError>>) {
|
||||
shutdown.shutdown();
|
||||
task.await.expect("serve task").expect("clean shutdown");
|
||||
assert!(!path.exists(), "SOURCE_READER_SOCKET_CLEANUP");
|
||||
}
|
||||
async fn raw(path: &std::path::Path, value: serde_json::Value) -> ReadPageReply {
|
||||
let mut stream = UnixStream::connect(path).await.expect("real socket connect");
|
||||
let bytes = serde_json::to_vec(&value).expect("wire request");
|
||||
stream
|
||||
.write_u32(bytes.len().try_into().expect("request length"))
|
||||
.await
|
||||
.expect("frame prefix");
|
||||
stream.write_all(&bytes).await.expect("frame bytes");
|
||||
let len = stream.read_u32().await.expect("reply prefix");
|
||||
let mut bytes = vec![0; usize::try_from(len).expect("reply length")];
|
||||
stream.read_exact(&mut bytes).await.expect("reply bytes");
|
||||
serde_json::from_slice(&bytes).expect("strict native reply")
|
||||
}
|
||||
fn request() -> serde_json::Value {
|
||||
serde_json::to_value(ReadPage {
|
||||
version: WIRE_VERSION,
|
||||
expected_cluster: identity().cluster_id,
|
||||
cursor: None,
|
||||
limit: 2,
|
||||
})
|
||||
.expect("native request")
|
||||
}
|
||||
#[tokio::test]
|
||||
async fn source_reader_live_apply() {
|
||||
let (dir, writer) = fixture();
|
||||
let (path, client, shutdown, task) = start(&dir, &writer);
|
||||
assert_eq!(writer.durable_identity().await.expect("durable META identity"), identity());
|
||||
assert!(
|
||||
client
|
||||
.page(identity().cluster_id, None, 2)
|
||||
.await
|
||||
.expect("empty live page")
|
||||
.page
|
||||
.events
|
||||
.is_empty()
|
||||
);
|
||||
apply(&writer, 1, 9).await;
|
||||
let response = client
|
||||
.page(identity().cluster_id, None, 2)
|
||||
.await
|
||||
.expect("live committed page");
|
||||
assert_eq!(response.identity, identity(), "SOURCE_READER_DURABLE_IDENTITY");
|
||||
assert_eq!(response.page.events[0].event_id, [9; 16], "SOURCE_READER_LIVE_EVENT");
|
||||
assert_eq!(response.page.events[0].captured.binding, binding());
|
||||
{
|
||||
let mut corrupt = writer.store.lock().expect("test owner");
|
||||
let tx = corrupt.write_transaction().expect("corrupt META transaction");
|
||||
tx.open_table(META)
|
||||
.expect("META")
|
||||
.insert("identity", &[0; 24][..])
|
||||
.expect("corrupt identity");
|
||||
corrupt.commit(tx).expect("persist corruption");
|
||||
}
|
||||
assert!(writer.durable_identity().await.is_err(), "SOURCE_READER_META_CORRUPTION_REJECTED");
|
||||
assert!(
|
||||
matches!(
|
||||
client.page(identity().cluster_id, None, 2).await,
|
||||
Err(ReaderError::Rejected(Rejection::StoreUnavailable))
|
||||
),
|
||||
"SOURCE_READER_NO_CALLER_IDENTITY_SUBSTITUTION"
|
||||
);
|
||||
stop(path, shutdown, task).await;
|
||||
}
|
||||
#[tokio::test]
|
||||
async fn source_reader_restart_cursor() {
|
||||
let (dir, writer) = fixture();
|
||||
apply(&writer, 1, 9).await;
|
||||
apply(&writer, 2, 7).await;
|
||||
let (path, client, shutdown, task) = start(&dir, &writer);
|
||||
let first = client.page(identity().cluster_id, None, 1).await.expect("first");
|
||||
stop(path, shutdown, task).await;
|
||||
drop(writer);
|
||||
let writer = NativeLogWriter::new(Store::open(dir.path().join("db"), identity()).expect("restart same durable store"));
|
||||
let (path, client, shutdown, task) = start(&dir, &writer);
|
||||
let next = client
|
||||
.page(identity().cluster_id, first.page.next, 1)
|
||||
.await
|
||||
.expect("resume durable cursor");
|
||||
assert_eq!(next.page.events[0].event_id, [7; 16], "SOURCE_READER_RESTART_CONTINUES");
|
||||
stop(path, shutdown, task).await;
|
||||
}
|
||||
#[tokio::test]
|
||||
async fn source_reader_page_boundaries() {
|
||||
let (dir, writer) = fixture();
|
||||
for (index, event) in [(1, 9), (2, 7), (3, 1)] {
|
||||
apply(&writer, index, event).await;
|
||||
}
|
||||
let (path, client, shutdown, task) = start(&dir, &writer);
|
||||
let first = client.page(identity().cluster_id, None, 2).await.expect("first two");
|
||||
assert_eq!(
|
||||
first.page.events.iter().map(|e| e.event_id).collect::<Vec<_>>(),
|
||||
vec![[9; 16], [7; 16]],
|
||||
"SOURCE_READER_DECISION_ORDER"
|
||||
);
|
||||
let next = client
|
||||
.page(identity().cluster_id, first.page.next, 2)
|
||||
.await
|
||||
.expect("remaining");
|
||||
assert_eq!(next.page.events.len(), 1);
|
||||
let end = client
|
||||
.page(identity().cluster_id, next.page.next.clone(), 2)
|
||||
.await
|
||||
.expect("end");
|
||||
assert!(end.page.events.is_empty());
|
||||
assert_eq!(end.page.next, next.page.next, "SOURCE_READER_CURSOR_RETAINED_AT_END");
|
||||
for limit in [0, MAX_EVENT_PAGE + 1] {
|
||||
assert!(
|
||||
matches!(
|
||||
client.page(identity().cluster_id, None, limit).await,
|
||||
Err(ReaderError::Rejected(Rejection::InvalidRequest))
|
||||
),
|
||||
"SOURCE_READER_LIMIT_REJECTED"
|
||||
);
|
||||
}
|
||||
stop(path, shutdown, task).await;
|
||||
}
|
||||
#[tokio::test]
|
||||
async fn source_reader_wrong_identity() {
|
||||
let (dir, writer) = fixture();
|
||||
apply(&writer, 1, 9).await;
|
||||
let (path, client, shutdown, task) = start(&dir, &writer);
|
||||
let mut wrong = request();
|
||||
wrong["expected_cluster"] = serde_json::to_value([6; 16]).expect("wrong cluster");
|
||||
assert!(
|
||||
matches!(
|
||||
raw(&path, wrong).await,
|
||||
ReadPageReply::Rejected {
|
||||
error: Rejection::WrongCluster,
|
||||
..
|
||||
}
|
||||
),
|
||||
"SOURCE_READER_CLUSTER: reject before reading or returning foreign events"
|
||||
);
|
||||
let first = client.page(identity().cluster_id, None, 1).await.expect("real cursor");
|
||||
let mut wrong = serde_json::to_value(first.page.next.expect("cursor")).expect("cursor wire");
|
||||
wrong["event"] = serde_json::to_value([1; 16]).expect("wrong event");
|
||||
let wrong: EventCursor = serde_json::from_value(wrong).expect("syntactically valid foreign cursor");
|
||||
assert!(
|
||||
matches!(
|
||||
client.page(identity().cluster_id, Some(wrong), 1).await,
|
||||
Err(ReaderError::Rejected(Rejection::InvalidCursor))
|
||||
),
|
||||
"SOURCE_READER_CURSOR_BOUND"
|
||||
);
|
||||
for (field, value) in [
|
||||
("version", serde_json::json!(2)),
|
||||
("unknown", serde_json::json!(true)),
|
||||
("cursor", serde_json::json!({"unknown":true})),
|
||||
] {
|
||||
let mut wrong = request();
|
||||
wrong[field] = value;
|
||||
assert!(
|
||||
matches!(
|
||||
raw(&path, wrong).await,
|
||||
ReadPageReply::Rejected {
|
||||
error: Rejection::InvalidRequest,
|
||||
..
|
||||
}
|
||||
),
|
||||
"SOURCE_READER_STRICT_REQUEST"
|
||||
);
|
||||
}
|
||||
stop(path, shutdown, task).await;
|
||||
}
|
||||
#[tokio::test]
|
||||
async fn source_reader_socket_ownership() {
|
||||
let (dir, writer) = fixture();
|
||||
let path = dir.path().join("reader.sock");
|
||||
std::fs::set_permissions(dir.path(), std::fs::Permissions::from_mode(0o750)).expect("insecure directory");
|
||||
assert!(
|
||||
matches!(SourceReaderServer::bind(&path, writer.clone()), Err(ReaderError::Permission)),
|
||||
"SOURCE_READER_PRIVATE_DIRECTORY"
|
||||
);
|
||||
std::fs::set_permissions(dir.path(), std::fs::Permissions::from_mode(0o700)).expect("restore private directory");
|
||||
std::fs::write(&path, b"preserve me").expect("occupied file");
|
||||
assert!(
|
||||
matches!(SourceReaderServer::bind(&path, writer.clone()), Err(ReaderError::Occupied)),
|
||||
"SOURCE_READER_OCCUPIED_PATH"
|
||||
);
|
||||
assert_eq!(std::fs::read(&path).expect("unchanged file"), b"preserve me");
|
||||
std::fs::remove_file(&path).expect("remove own fixture");
|
||||
std::os::unix::fs::symlink(dir.path().join("missing"), &path).expect("unknown symlink");
|
||||
assert!(matches!(SourceReaderServer::bind(&path, writer.clone()), Err(ReaderError::Occupied)));
|
||||
assert!(SourceReaderClient::new(&path).is_err());
|
||||
std::fs::remove_file(&path).expect("remove own symlink");
|
||||
let long = dir.path().join("x".repeat(300));
|
||||
assert!(SourceReaderServer::bind(&long, writer.clone()).is_err(), "SOURCE_READER_LONG_SOCKET_PATH");
|
||||
let parent_link = dir.path().join("parent-link");
|
||||
std::os::unix::fs::symlink(dir.path(), &parent_link).expect("parent symlink");
|
||||
assert!(
|
||||
matches!(
|
||||
SourceReaderServer::bind(parent_link.join("socket"), writer.clone()),
|
||||
Err(ReaderError::Permission)
|
||||
),
|
||||
"SOURCE_READER_PARENT_SYMLINK_DENIED"
|
||||
);
|
||||
let (path, client, shutdown, task) = start(&dir, &writer);
|
||||
let meta = std::fs::symlink_metadata(&path).expect("socket metadata");
|
||||
assert_eq!(meta.mode() & 0o777, 0o600);
|
||||
assert_eq!(meta.uid(), rustix::process::geteuid().as_raw());
|
||||
std::fs::set_permissions(&path, std::fs::Permissions::from_mode(0o660)).expect("insecure socket");
|
||||
assert!(
|
||||
matches!(client.page(identity().cluster_id, None, 1).await, Err(ReaderError::Permission)),
|
||||
"SOURCE_READER_CLIENT_VALIDATES_SOCKET"
|
||||
);
|
||||
std::fs::set_permissions(&path, std::fs::Permissions::from_mode(0o600)).expect("restore socket");
|
||||
std::fs::remove_file(&path).expect("test owner replaces socket");
|
||||
std::fs::write(&path, b"replacement").expect("replacement file");
|
||||
shutdown.shutdown();
|
||||
assert!(task.await.expect("serve exit").is_err(), "SOURCE_READER_REPLACEMENT_CLEANUP_REJECTED");
|
||||
assert_eq!(std::fs::read(&path).expect("replacement preserved"), b"replacement");
|
||||
}
|
||||
#[tokio::test]
|
||||
async fn source_reader_transport_bounds() {
|
||||
let (dir, writer) = fixture();
|
||||
let (path, client, shutdown, task) = start(&dir, &writer);
|
||||
let mut stream = UnixStream::connect(&path).await.expect("oversized input peer");
|
||||
stream
|
||||
.write_u32(u32::try_from(MAX_REQUEST_BYTES + 1).expect("length"))
|
||||
.await
|
||||
.expect("overlong prefix");
|
||||
let mut byte = [0];
|
||||
assert_eq!(
|
||||
stream.read(&mut byte).await.expect("bounded rejection closes"),
|
||||
0,
|
||||
"SOURCE_READER_INPUT_BOUND"
|
||||
);
|
||||
let mut idle = UnixStream::connect(&path).await.expect("idle connection");
|
||||
let start = std::time::Instant::now();
|
||||
assert_eq!(
|
||||
idle.read(&mut byte).await.expect("deadline closes connection"),
|
||||
0,
|
||||
"SOURCE_READER_READ_DEADLINE"
|
||||
);
|
||||
assert!(start.elapsed() >= IO_TIMEOUT, "SOURCE_READER_REAL_READ_DEADLINE");
|
||||
assert!(
|
||||
client.page(identity().cluster_id, None, 1).await.is_ok(),
|
||||
"SOURCE_READER_TIMEOUT_RELEASES_CONNECTION"
|
||||
);
|
||||
stop(path.clone(), shutdown, task).await;
|
||||
// A same-UID peer still cannot supply unbounded responses to the client.
|
||||
let listener = tokio::net::UnixListener::bind(&path).expect("controlled response peer");
|
||||
std::fs::set_permissions(&path, std::fs::Permissions::from_mode(0o600)).expect("private response socket");
|
||||
let client = SourceReaderClient::new(&path).expect("response client");
|
||||
let peer = tokio::spawn(async move {
|
||||
let (mut stream, _) = listener.accept().await.expect("client connects");
|
||||
stream
|
||||
.write_u32(u32::try_from(MAX_RESPONSE_BYTES + 1).expect("oversized response"))
|
||||
.await
|
||||
.expect("response prefix");
|
||||
tokio::time::sleep(std::time::Duration::from_millis(50)).await;
|
||||
});
|
||||
assert!(
|
||||
matches!(client.page(identity().cluster_id, None, 1).await, Err(ReaderError::Protocol)),
|
||||
"SOURCE_READER_RESPONSE_BOUND"
|
||||
);
|
||||
peer.await.expect("peer task");
|
||||
}
|
||||
fn hold_store(writer: &NativeLogWriter) -> (std::sync::mpsc::Sender<()>, std::thread::JoinHandle<()>) {
|
||||
let owner = writer.clone();
|
||||
let (locked_tx, locked_rx) = std::sync::mpsc::channel();
|
||||
let (release_tx, release_rx) = std::sync::mpsc::channel();
|
||||
let thread = std::thread::spawn(move || {
|
||||
let _store = owner.store.lock().expect("actual Store held by test owner");
|
||||
locked_tx.send(()).expect("lock visible");
|
||||
let _ = release_rx.recv();
|
||||
});
|
||||
locked_rx.recv().expect("store locked");
|
||||
(release_tx, thread)
|
||||
}
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||
async fn source_reader_shutdown() {
|
||||
let (dir, writer) = fixture();
|
||||
apply(&writer, 1, 9).await;
|
||||
let (path, _client, shutdown, task) = start(&dir, &writer);
|
||||
let (release_tx, blocker) = hold_store(&writer);
|
||||
let mut streams = Vec::new();
|
||||
for _ in 0..MAX_CONNECTIONS {
|
||||
let mut stream = UnixStream::connect(&path).await.expect("active read socket");
|
||||
let bytes = serde_json::to_vec(&request()).expect("request");
|
||||
stream
|
||||
.write_u32(bytes.len().try_into().expect("length"))
|
||||
.await
|
||||
.expect("prefix");
|
||||
stream.write_all(&bytes).await.expect("request bytes");
|
||||
streams.push(stream);
|
||||
}
|
||||
tokio::time::timeout(std::time::Duration::from_secs(2), async {
|
||||
while writer.source_reader_admission.available_permits() != 0 {
|
||||
tokio::task::yield_now().await;
|
||||
}
|
||||
})
|
||||
.await
|
||||
.expect("all admissions active");
|
||||
drop(streams);
|
||||
tokio::time::sleep(IO_TIMEOUT + std::time::Duration::from_millis(100)).await;
|
||||
assert_eq!(
|
||||
writer.source_reader_admission.available_permits(),
|
||||
0,
|
||||
"SOURCE_READER_CLIENT_TIMEOUT_KEEPS_WORKER_ADMISSION"
|
||||
);
|
||||
shutdown.shutdown();
|
||||
tokio::time::sleep(std::time::Duration::from_millis(100)).await;
|
||||
assert!(!task.is_finished(), "SOURCE_READER_SHUTDOWN_DRAINS_READERS");
|
||||
assert_eq!(
|
||||
writer.source_reader_admission.available_permits(),
|
||||
0,
|
||||
"SOURCE_READER_CANCELLED_CLIENTS_KEEP_ADMISSION"
|
||||
);
|
||||
release_tx.send(()).expect("release real blocking reads");
|
||||
blocker.join().expect("test lock owner exits");
|
||||
task.await.expect("serve completes").expect("shutdown clean");
|
||||
assert!(!path.exists());
|
||||
assert_eq!(
|
||||
writer.source_reader_admission.available_permits(),
|
||||
MAX_CONNECTIONS,
|
||||
"SOURCE_READER_ADMISSION_RELEASED_AFTER_WORKERS"
|
||||
);
|
||||
let (release, blocker) = hold_store(&writer);
|
||||
let (path, _, _shutdown, task) = start(&dir, &writer);
|
||||
let bytes = serde_json::to_vec(&request()).expect("native request");
|
||||
let mut sockets = Vec::new();
|
||||
for _ in 0..MAX_CONNECTIONS {
|
||||
let mut stream = UnixStream::connect(&path).await.expect("cancelled service peer");
|
||||
stream
|
||||
.write_u32(bytes.len().try_into().expect("length"))
|
||||
.await
|
||||
.expect("prefix");
|
||||
stream.write_all(&bytes).await.expect("request");
|
||||
sockets.push(stream);
|
||||
}
|
||||
tokio::time::timeout(std::time::Duration::from_secs(2), async {
|
||||
while writer.source_reader_admission.available_permits() != 0 {
|
||||
tokio::task::yield_now().await;
|
||||
}
|
||||
})
|
||||
.await
|
||||
.expect("cancelled service admits bounded workers");
|
||||
tokio::time::sleep(std::time::Duration::from_millis(100)).await;
|
||||
task.abort();
|
||||
assert!(task.await.expect_err("serve cancellation").is_cancelled());
|
||||
drop(sockets);
|
||||
assert_eq!(
|
||||
writer.source_reader_admission.available_permits(),
|
||||
0,
|
||||
"SOURCE_READER_CANCELLED_SERVE_RETAINS_WORKER_ADMISSION"
|
||||
);
|
||||
let (path, client, shutdown, task) = start(&dir, &writer);
|
||||
let pending = tokio::spawn(async move { client.page(identity().cluster_id, None, 1).await });
|
||||
tokio::time::sleep(std::time::Duration::from_millis(100)).await;
|
||||
assert!(!pending.is_finished(), "SOURCE_READER_REBIND_CANNOT_BYPASS_ADMISSION");
|
||||
assert_eq!(writer.source_reader_admission.available_permits(), 0);
|
||||
release.send(()).expect("release cancelled worker store lock");
|
||||
blocker.join().expect("lock owner completes");
|
||||
assert_eq!(
|
||||
pending
|
||||
.await
|
||||
.expect("new service client")
|
||||
.expect("new service waits for old workers")
|
||||
.page
|
||||
.events
|
||||
.len(),
|
||||
1
|
||||
);
|
||||
stop(path, shutdown, task).await;
|
||||
}
|
||||
#[tokio::test]
|
||||
async fn source_reader_checkpoint_replay() {
|
||||
let (dir, writer) = fixture();
|
||||
apply(&writer, 1, 9).await;
|
||||
apply(&writer, 2, 7).await;
|
||||
let (path, client, shutdown, task) = start(&dir, &writer);
|
||||
let first = client
|
||||
.page(identity().cluster_id, None, 1)
|
||||
.await
|
||||
.expect("pre-checkpoint cursor");
|
||||
let checkpoint = writer
|
||||
.checkpoint_local(CheckpointLimits::default())
|
||||
.await
|
||||
.expect("real checkpoint");
|
||||
assert_eq!(checkpoint.cut(), id(2));
|
||||
let next = client
|
||||
.page(identity().cluster_id, first.page.next.clone(), 1)
|
||||
.await
|
||||
.expect("checkpoint retained events");
|
||||
assert_eq!(next.page.events[0].event_id, [7; 16], "SOURCE_READER_CHECKPOINT_REPLAY");
|
||||
stop(path, shutdown, task).await;
|
||||
drop(writer);
|
||||
let writer = NativeLogWriter::new(Store::open(dir.path().join("db"), identity()).expect("reopen checkpointed store"));
|
||||
let (path, client, shutdown, task) = start(&dir, &writer);
|
||||
assert_eq!(
|
||||
client
|
||||
.page(identity().cluster_id, first.page.next, 1)
|
||||
.await
|
||||
.expect("replay after restart"),
|
||||
next,
|
||||
"SOURCE_READER_CHECKPOINT_RESTART"
|
||||
);
|
||||
stop(path, shutdown, task).await;
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
use crate::{LOGS, META, Store, StoreError, decode_id, decode_log, encode_id};
|
||||
use redb::ReadableTable;
|
||||
|
||||
impl Store {
|
||||
/// Atomically remove every log entry at or after `from`.
|
||||
pub fn truncate_suffix(&mut self, from: u64) -> Result<(), StoreError> {
|
||||
let tx = self.write_transaction()?;
|
||||
{
|
||||
let mut meta = tx.open_table(META)?;
|
||||
let logs = tx.open_table(LOGS)?;
|
||||
if crate::committed::validate_committed(&meta, &logs)?.is_some_and(|id| from <= id.index) {
|
||||
return Err(StoreError::CommittedLogProtected);
|
||||
}
|
||||
drop(logs);
|
||||
let tail = meta.get("tail")?.map(|v| decode_id(v.value())).transpose()?;
|
||||
if tail.is_none_or(|id| from > id.index) {
|
||||
return Ok(());
|
||||
}
|
||||
let mut logs = tx.open_table(LOGS)?;
|
||||
let new_tail = if from == 0 {
|
||||
None
|
||||
} else {
|
||||
let index = from - 1;
|
||||
let id = match logs.get(index)? {
|
||||
Some(record) => decode_log(record.value())?.id,
|
||||
None => crate::checkpoint_baseline::read_purged(&meta)?
|
||||
.filter(|id| id.index == index)
|
||||
.ok_or(StoreError::InvalidLogSequence)?,
|
||||
};
|
||||
if id.index != index {
|
||||
return Err(StoreError::CorruptRecord);
|
||||
}
|
||||
Some(id)
|
||||
};
|
||||
logs.retain(|index, _| index < from)?;
|
||||
match new_tail {
|
||||
Some(id) => {
|
||||
meta.insert("tail", encode_id(id).as_slice())?;
|
||||
}
|
||||
None => {
|
||||
meta.remove("tail")?;
|
||||
}
|
||||
}
|
||||
}
|
||||
self.commit(tx)
|
||||
}
|
||||
}
|
||||
@@ -34,7 +34,6 @@ hotpath-alloc = ["hotpath", "hotpath/hotpath-alloc"]
|
||||
hotpath-cpu = ["hotpath", "hotpath/hotpath-cpu"]
|
||||
|
||||
[dependencies]
|
||||
arc-swap.workspace = true
|
||||
hotpath.workspace = true
|
||||
tokio = { workspace = true, features = ["fs", "rt-multi-thread"] }
|
||||
tonic = { workspace = true, features = ["gzip", "deflate"] }
|
||||
|
||||
@@ -12,10 +12,9 @@
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use arc_swap::ArcSwap;
|
||||
use std::collections::HashMap;
|
||||
use std::sync::LazyLock;
|
||||
use std::sync::atomic::{AtomicU64, Ordering};
|
||||
use std::sync::{Arc, LazyLock};
|
||||
use tokio::sync::RwLock;
|
||||
use tonic::transport::Channel;
|
||||
|
||||
@@ -28,42 +27,6 @@ pub static GLOBAL_ROOT_CERT: LazyLock<RwLock<Option<Vec<u8>>>> = LazyLock::new(|
|
||||
pub static GLOBAL_MTLS_IDENTITY: LazyLock<RwLock<Option<MtlsIdentityPem>>> = LazyLock::new(|| RwLock::new(None));
|
||||
pub static GLOBAL_OUTBOUND_TLS_GENERATION: LazyLock<AtomicU64> = LazyLock::new(|| AtomicU64::new(0));
|
||||
|
||||
#[derive(Clone, Default)]
|
||||
pub struct OutboundTlsSnapshot {
|
||||
pub generation: u64,
|
||||
pub root_ca_pem: Option<Vec<u8>>,
|
||||
pub mtls_identity: Option<MtlsIdentityPem>,
|
||||
}
|
||||
|
||||
static GLOBAL_OUTBOUND_TLS_STATE: LazyLock<ArcSwap<OutboundTlsSnapshot>> =
|
||||
LazyLock::new(|| ArcSwap::from_pointee(OutboundTlsSnapshot::default()));
|
||||
|
||||
pub fn get_global_outbound_tls_snapshot() -> Arc<OutboundTlsSnapshot> {
|
||||
GLOBAL_OUTBOUND_TLS_STATE.load_full()
|
||||
}
|
||||
|
||||
/// Publish identity, trust and generation together; the individual globals are legacy views.
|
||||
pub async fn publish_global_outbound_tls_snapshot(snapshot: OutboundTlsSnapshot) -> u64 {
|
||||
GLOBAL_OUTBOUND_TLS_STATE.rcu(|current| {
|
||||
if current.generation != 0
|
||||
&& current.root_ca_pem == snapshot.root_ca_pem
|
||||
&& current.mtls_identity == snapshot.mtls_identity
|
||||
{
|
||||
return Arc::clone(current);
|
||||
}
|
||||
Arc::new(OutboundTlsSnapshot {
|
||||
generation: snapshot.generation.max(current.generation.saturating_add(1)),
|
||||
root_ca_pem: snapshot.root_ca_pem.clone(),
|
||||
mtls_identity: snapshot.mtls_identity.clone(),
|
||||
})
|
||||
});
|
||||
let accepted = get_global_outbound_tls_snapshot();
|
||||
*GLOBAL_ROOT_CERT.write().await = accepted.root_ca_pem.clone();
|
||||
*GLOBAL_MTLS_IDENTITY.write().await = accepted.mtls_identity.clone();
|
||||
GLOBAL_OUTBOUND_TLS_GENERATION.store(accepted.generation, Ordering::Relaxed);
|
||||
accepted.generation
|
||||
}
|
||||
|
||||
/// Log level to use when reporting cached gRPC connection eviction.
|
||||
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
|
||||
pub enum ConnectionEvictionLogLevel {
|
||||
@@ -122,27 +85,17 @@ pub async fn get_global_addr() -> String {
|
||||
/// # Arguments
|
||||
/// * `cert` - A vector of bytes representing the PEM-encoded root CA certificate.
|
||||
pub async fn set_global_root_cert(cert: Vec<u8>) {
|
||||
GLOBAL_OUTBOUND_TLS_STATE.rcu(|current| {
|
||||
let mut next = (**current).clone();
|
||||
next.root_ca_pem = Some(cert.clone());
|
||||
Arc::new(next)
|
||||
});
|
||||
*GLOBAL_ROOT_CERT.write().await = Some(cert);
|
||||
}
|
||||
|
||||
/// Clear the global root CA certificate for outbound gRPC clients.
|
||||
pub async fn clear_global_root_cert() {
|
||||
GLOBAL_OUTBOUND_TLS_STATE.rcu(|current| {
|
||||
let mut next = (**current).clone();
|
||||
next.root_ca_pem = None;
|
||||
Arc::new(next)
|
||||
});
|
||||
*GLOBAL_ROOT_CERT.write().await = None;
|
||||
}
|
||||
|
||||
/// Get the global root CA certificate for outbound gRPC clients.
|
||||
pub async fn get_global_root_cert() -> Option<Vec<u8>> {
|
||||
get_global_outbound_tls_snapshot().root_ca_pem.clone()
|
||||
GLOBAL_ROOT_CERT.read().await.clone()
|
||||
}
|
||||
|
||||
/// Set the global mTLS identity (cert+key PEM) for outbound gRPC clients.
|
||||
@@ -152,32 +105,22 @@ pub async fn get_global_root_cert() -> Option<Vec<u8>> {
|
||||
/// # Arguments
|
||||
/// * `identity` - An optional MtlsIdentityPem struct containing the cert and key PEM.
|
||||
pub async fn set_global_mtls_identity(identity: Option<MtlsIdentityPem>) {
|
||||
GLOBAL_OUTBOUND_TLS_STATE.rcu(|current| {
|
||||
let mut next = (**current).clone();
|
||||
next.mtls_identity = identity.clone();
|
||||
Arc::new(next)
|
||||
});
|
||||
*GLOBAL_MTLS_IDENTITY.write().await = identity;
|
||||
}
|
||||
|
||||
/// Get the global mTLS identity for outbound gRPC clients.
|
||||
pub async fn get_global_mtls_identity() -> Option<MtlsIdentityPem> {
|
||||
get_global_outbound_tls_snapshot().mtls_identity.clone()
|
||||
GLOBAL_MTLS_IDENTITY.read().await.clone()
|
||||
}
|
||||
|
||||
/// Set the global outbound TLS generation.
|
||||
pub fn set_global_outbound_tls_generation(generation: u64) {
|
||||
GLOBAL_OUTBOUND_TLS_STATE.rcu(|current| {
|
||||
let mut next = (**current).clone();
|
||||
next.generation = generation;
|
||||
Arc::new(next)
|
||||
});
|
||||
GLOBAL_OUTBOUND_TLS_GENERATION.store(generation, Ordering::Relaxed);
|
||||
}
|
||||
|
||||
/// Get the global outbound TLS generation.
|
||||
pub fn get_global_outbound_tls_generation() -> u64 {
|
||||
get_global_outbound_tls_snapshot().generation
|
||||
GLOBAL_OUTBOUND_TLS_GENERATION.load(Ordering::Relaxed)
|
||||
}
|
||||
|
||||
/// Evict a stale/dead connection from the global connection cache.
|
||||
@@ -251,77 +194,8 @@ pub async fn clear_all_connections() {
|
||||
///
|
||||
/// When present, gRPC clients will present this identity to servers requesting/requiring mTLS.
|
||||
/// When absent, clients proceed with standard server-authenticated TLS.
|
||||
#[derive(Clone, PartialEq, Eq)]
|
||||
#[derive(Clone, Debug)]
|
||||
pub struct MtlsIdentityPem {
|
||||
pub cert_pem: Vec<u8>,
|
||||
pub key_pem: Vec<u8>,
|
||||
}
|
||||
|
||||
impl std::fmt::Debug for MtlsIdentityPem {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
f.debug_struct("MtlsIdentityPem")
|
||||
.field("cert_bytes", &self.cert_pem.len())
|
||||
.field("key_pem", &"[REDACTED]")
|
||||
.finish()
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tls_snapshot_tests {
|
||||
use super::*;
|
||||
|
||||
#[tokio::test]
|
||||
async fn outbound_snapshot_publication_is_coherent_and_skips_unchanged_material() {
|
||||
let start = get_global_outbound_tls_generation().saturating_add(1);
|
||||
let snapshot = OutboundTlsSnapshot {
|
||||
generation: start,
|
||||
root_ca_pem: Some(vec![1]),
|
||||
mtls_identity: Some(MtlsIdentityPem {
|
||||
cert_pem: vec![1],
|
||||
key_pem: vec![1],
|
||||
}),
|
||||
};
|
||||
let first = publish_global_outbound_tls_snapshot(snapshot.clone()).await;
|
||||
assert_eq!(
|
||||
publish_global_outbound_tls_snapshot(OutboundTlsSnapshot {
|
||||
generation: first.saturating_add(1),
|
||||
..snapshot
|
||||
})
|
||||
.await,
|
||||
first
|
||||
);
|
||||
let writer = tokio::spawn(async move {
|
||||
for tag in 2_u8..=255 {
|
||||
publish_global_outbound_tls_snapshot(OutboundTlsSnapshot {
|
||||
generation: start.saturating_add(u64::from(tag)),
|
||||
root_ca_pem: Some(vec![tag]),
|
||||
mtls_identity: Some(MtlsIdentityPem {
|
||||
cert_pem: vec![tag],
|
||||
key_pem: vec![tag],
|
||||
}),
|
||||
})
|
||||
.await;
|
||||
tokio::task::yield_now().await;
|
||||
}
|
||||
});
|
||||
while !writer.is_finished() {
|
||||
let state = get_global_outbound_tls_snapshot();
|
||||
let identity = state.mtls_identity.as_ref().expect("identity in complete snapshot");
|
||||
assert_eq!(state.root_ca_pem.as_ref().expect("roots in complete snapshot"), &identity.cert_pem);
|
||||
assert_eq!(identity.cert_pem, identity.key_pem);
|
||||
tokio::task::yield_now().await;
|
||||
}
|
||||
writer.await.expect("writer completes");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn mtls_identity_debug_redacts_private_key() {
|
||||
let identity = MtlsIdentityPem {
|
||||
cert_pem: b"public certificate".to_vec(),
|
||||
key_pem: b"PRIVATE-KEY-MARKER".to_vec(),
|
||||
};
|
||||
let debug = format!("{identity:?}");
|
||||
assert!(!debug.contains("PRIVATE-KEY-MARKER"));
|
||||
assert!(debug.contains("[REDACTED]"));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -51,11 +51,6 @@ pub const ENV_OBS_PROFILING_EXPORT_ENABLED: &str = "RUSTFS_OBS_PROFILING_EXPORT_
|
||||
/// PUT records multiple timers and histograms when attribution is active.
|
||||
pub const ENV_OBS_PUT_STAGE_METRICS_ENABLED: &str = "RUSTFS_OBS_PUT_STAGE_METRICS_ENABLED";
|
||||
|
||||
/// Enables sampled in-process GetObject stage summaries without OTLP histograms.
|
||||
pub const ENV_OBS_GET_STAGE_LOCAL_SUMMARY_ENABLED: &str = "RUSTFS_OBS_GET_STAGE_LOCAL_SUMMARY_ENABLED";
|
||||
pub const ENV_OBS_GET_STAGE_LOCAL_SUMMARY_SAMPLE_RATE: &str = "RUSTFS_OBS_GET_STAGE_LOCAL_SUMMARY_SAMPLE_RATE";
|
||||
pub const ENV_OBS_GET_STAGE_LOCAL_SUMMARY_INTERVAL_SECS: &str = "RUSTFS_OBS_GET_STAGE_LOCAL_SUMMARY_INTERVAL_SECS";
|
||||
|
||||
pub const ENV_OBS_LOGGER_LEVEL: &str = "RUSTFS_OBS_LOGGER_LEVEL";
|
||||
pub const ENV_OBS_LOG_STDOUT_ENABLED: &str = "RUSTFS_OBS_LOG_STDOUT_ENABLED";
|
||||
pub const ENV_OBS_LOG_DIRECTORY: &str = "RUSTFS_OBS_LOG_DIRECTORY";
|
||||
@@ -164,15 +159,6 @@ mod tests {
|
||||
assert_eq!(ENV_OBS_LOGS_EXPORT_ENABLED, "RUSTFS_OBS_LOGS_EXPORT_ENABLED");
|
||||
assert_eq!(ENV_OBS_PROFILING_EXPORT_ENABLED, "RUSTFS_OBS_PROFILING_EXPORT_ENABLED");
|
||||
assert_eq!(ENV_OBS_PUT_STAGE_METRICS_ENABLED, "RUSTFS_OBS_PUT_STAGE_METRICS_ENABLED");
|
||||
assert_eq!(ENV_OBS_GET_STAGE_LOCAL_SUMMARY_ENABLED, "RUSTFS_OBS_GET_STAGE_LOCAL_SUMMARY_ENABLED");
|
||||
assert_eq!(
|
||||
ENV_OBS_GET_STAGE_LOCAL_SUMMARY_SAMPLE_RATE,
|
||||
"RUSTFS_OBS_GET_STAGE_LOCAL_SUMMARY_SAMPLE_RATE"
|
||||
);
|
||||
assert_eq!(
|
||||
ENV_OBS_GET_STAGE_LOCAL_SUMMARY_INTERVAL_SECS,
|
||||
"RUSTFS_OBS_GET_STAGE_LOCAL_SUMMARY_INTERVAL_SECS"
|
||||
);
|
||||
// Test log cleanup related env keys
|
||||
assert_eq!(ENV_OBS_LOG_MAX_TOTAL_SIZE_BYTES, "RUSTFS_OBS_LOG_MAX_TOTAL_SIZE_BYTES");
|
||||
assert_eq!(ENV_OBS_LOG_MAX_SINGLE_FILE_SIZE_BYTES, "RUSTFS_OBS_LOG_MAX_SINGLE_FILE_SIZE_BYTES");
|
||||
|
||||
@@ -1542,15 +1542,6 @@ impl RustFSTestClusterEnvironment {
|
||||
self.start_node_from_binary(node_idx, &binary_path).await
|
||||
}
|
||||
|
||||
/// Start a process and wait only for TCP, allowing tests to bring up a
|
||||
/// quorum one node at a time before the S3 service can become ready.
|
||||
pub async fn start_node_process(&mut self, node_idx: usize) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
|
||||
let binary_path = rustfs_binary_path();
|
||||
let volumes_arg = self.build_volumes_arg();
|
||||
self.spawn_node(node_idx, &binary_path, &volumes_arg)?;
|
||||
self.wait_for_node_ready(&self.nodes[node_idx].address, node_idx).await
|
||||
}
|
||||
|
||||
/// Start one stopped cluster node with a specific RustFS binary while
|
||||
/// preserving the cluster's volume layout and that node's data directory.
|
||||
pub async fn start_node_from_binary(
|
||||
|
||||
@@ -1,512 +0,0 @@
|
||||
// Copyright 2024 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
//! What one stack answered, and how two answers are compared.
|
||||
//!
|
||||
//! An [`Observation`] keeps only what a client acts on: the HTTP status, the S3 error code, the
|
||||
//! allowlisted response headers and a few typed fields decoded from the response. The error
|
||||
//! message is kept for diagnostics and never compared: message wording is judged by the wire
|
||||
//! corpus, not here. The comparator is pure so it can be tested without a server.
|
||||
|
||||
use serde::Serialize;
|
||||
use std::collections::{BTreeMap, BTreeSet};
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
/// Response headers compared exactly (after [`normalized_header_value`]).
|
||||
const HEADER_ALLOWLIST: [&str; 7] = [
|
||||
"content-type",
|
||||
"x-amz-version-id",
|
||||
"etag",
|
||||
"x-amz-delete-marker",
|
||||
"content-range",
|
||||
"accept-ranges",
|
||||
"x-amz-request-charged",
|
||||
];
|
||||
|
||||
/// Every response header with this prefix is compared as well.
|
||||
const HEADER_ALLOWLIST_PREFIX: &str = "x-amz-server-side-encryption";
|
||||
|
||||
/// Placeholder for a field one side did not send.
|
||||
const ABSENT: &str = "<absent>";
|
||||
|
||||
/// The lowercase header name if the comparator looks at this header.
|
||||
pub(crate) fn compared_header(name: &str) -> Option<String> {
|
||||
let name = name.to_ascii_lowercase();
|
||||
(HEADER_ALLOWLIST.contains(&name.as_str()) || name.starts_with(HEADER_ALLOWLIST_PREFIX)).then_some(name)
|
||||
}
|
||||
|
||||
/// A version ID is minted per process, so its value never matches across two servers; only
|
||||
/// whether it is the literal `null` (an unversioned write) carries meaning.
|
||||
fn normalized_header_value(name: &str, value: &str) -> String {
|
||||
if name == "x-amz-version-id" && value != "null" {
|
||||
"<version-id>".to_owned()
|
||||
} else {
|
||||
value.to_owned()
|
||||
}
|
||||
}
|
||||
|
||||
/// One request's outcome as a client sees it.
|
||||
#[derive(Clone, Debug, Serialize)]
|
||||
pub(crate) struct Observation {
|
||||
/// The S3 operation, named as in the `s3s::S3` trait (`GetObject`).
|
||||
pub op: &'static str,
|
||||
/// Which request of the script this was (`normal`, `negative`, or a setup label).
|
||||
pub case: &'static str,
|
||||
/// HTTP status; 0 when no response arrived.
|
||||
pub status: u16,
|
||||
/// The S3 error code, or the SDK's error kind when there was no service error.
|
||||
pub error_code: Option<String>,
|
||||
/// Allowlisted headers only, lowercase names, normalized values.
|
||||
pub headers: BTreeMap<String, String>,
|
||||
/// Typed values decoded from the response body, never free text.
|
||||
pub fields: BTreeMap<String, String>,
|
||||
/// Diagnostic only; never compared.
|
||||
#[serde(skip)]
|
||||
pub message: Option<String>,
|
||||
}
|
||||
|
||||
impl Observation {
|
||||
/// Builds an observation, keeping only the allowlisted headers.
|
||||
pub(crate) fn new<'h>(
|
||||
op: &'static str,
|
||||
case: &'static str,
|
||||
status: u16,
|
||||
error_code: Option<String>,
|
||||
headers: impl IntoIterator<Item = (&'h str, &'h str)>,
|
||||
) -> Self {
|
||||
let headers = headers
|
||||
.into_iter()
|
||||
.filter_map(|(name, value)| compared_header(name).map(|name| (name, value)))
|
||||
.map(|(name, value)| {
|
||||
let value = normalized_header_value(&name, value);
|
||||
(name, value)
|
||||
})
|
||||
.collect();
|
||||
Self {
|
||||
op,
|
||||
case,
|
||||
status,
|
||||
error_code,
|
||||
headers,
|
||||
fields: BTreeMap::new(),
|
||||
message: None,
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn with_field(mut self, name: &str, value: impl Into<String>) -> Self {
|
||||
self.fields.insert(name.to_owned(), value.into());
|
||||
self
|
||||
}
|
||||
|
||||
pub(crate) fn is_success(&self) -> bool {
|
||||
(200..300).contains(&self.status)
|
||||
}
|
||||
}
|
||||
|
||||
/// One field on which the two stacks answered differently.
|
||||
#[derive(Clone, Debug, PartialEq, Eq, Serialize)]
|
||||
pub(crate) struct Difference {
|
||||
pub op: String,
|
||||
pub case: String,
|
||||
pub field: String,
|
||||
pub a: String,
|
||||
pub b: String,
|
||||
}
|
||||
|
||||
/// Every difference between two transcripts of the same script, matched by `(op, case)`.
|
||||
pub(crate) fn compare(a: &[Observation], b: &[Observation]) -> Vec<Difference> {
|
||||
let mut differences = Vec::new();
|
||||
let (index_a, duplicates_a) = index(a);
|
||||
let (index_b, duplicates_b) = index(b);
|
||||
for (op, case) in duplicates_a.union(&duplicates_b) {
|
||||
let count = |side: &[Observation]| {
|
||||
side.iter()
|
||||
.filter(|observation| (observation.op, observation.case) == (*op, *case))
|
||||
.count()
|
||||
.to_string()
|
||||
};
|
||||
differences.push(difference(op, case, "duplicate_case", count(a), count(b)));
|
||||
}
|
||||
let keys: BTreeSet<_> = index_a.keys().chain(index_b.keys()).copied().collect();
|
||||
for key @ (op, case) in keys {
|
||||
match (index_a.get(&key), index_b.get(&key)) {
|
||||
(Some(a), Some(b)) => compare_one(a, b, &mut differences),
|
||||
(a, b) => {
|
||||
let presence = |side: Option<&&Observation>| if side.is_some() { "present" } else { ABSENT }.to_owned();
|
||||
differences.push(difference(op, case, "observation", presence(a), presence(b)));
|
||||
}
|
||||
}
|
||||
}
|
||||
differences
|
||||
}
|
||||
|
||||
type Key = (&'static str, &'static str);
|
||||
|
||||
fn index(side: &[Observation]) -> (BTreeMap<Key, &Observation>, BTreeSet<Key>) {
|
||||
let mut index = BTreeMap::new();
|
||||
let mut duplicates = BTreeSet::new();
|
||||
for observation in side {
|
||||
let key = (observation.op, observation.case);
|
||||
if index.insert(key, observation).is_some() {
|
||||
duplicates.insert(key);
|
||||
}
|
||||
}
|
||||
(index, duplicates)
|
||||
}
|
||||
|
||||
fn difference(op: &str, case: &str, field: &str, a: String, b: String) -> Difference {
|
||||
Difference {
|
||||
op: op.to_owned(),
|
||||
case: case.to_owned(),
|
||||
field: field.to_owned(),
|
||||
a,
|
||||
b,
|
||||
}
|
||||
}
|
||||
|
||||
fn compare_one(a: &Observation, b: &Observation, differences: &mut Vec<Difference>) {
|
||||
let mut field = |name: String, value_a: Option<&str>, value_b: Option<&str>| {
|
||||
if value_a != value_b {
|
||||
let show = |value: Option<&str>| value.unwrap_or(ABSENT).to_owned();
|
||||
differences.push(difference(a.op, a.case, &name, show(value_a), show(value_b)));
|
||||
}
|
||||
};
|
||||
field(
|
||||
"status".to_owned(),
|
||||
Some(a.status.to_string().as_str()),
|
||||
Some(b.status.to_string().as_str()),
|
||||
);
|
||||
field("error_code".to_owned(), a.error_code.as_deref(), b.error_code.as_deref());
|
||||
let headers: BTreeSet<_> = a.headers.keys().chain(b.headers.keys()).collect();
|
||||
for name in headers {
|
||||
field(
|
||||
format!("header.{name}"),
|
||||
a.headers.get(name).map(String::as_str),
|
||||
b.headers.get(name).map(String::as_str),
|
||||
);
|
||||
}
|
||||
let fields: BTreeSet<_> = a.fields.keys().chain(b.fields.keys()).collect();
|
||||
for name in fields {
|
||||
field(
|
||||
format!("body.{name}"),
|
||||
a.fields.get(name).map(String::as_str),
|
||||
b.fields.get(name).map(String::as_str),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/// Operations observed on both sides.
|
||||
pub(crate) fn compared_ops(a: &[Observation], b: &[Observation]) -> BTreeSet<&'static str> {
|
||||
let ops_b: BTreeSet<_> = b.iter().map(|observation| observation.op).collect();
|
||||
a.iter()
|
||||
.map(|observation| observation.op)
|
||||
.filter(|op| ops_b.contains(op))
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// `(op, case)` pairs observed on both sides.
|
||||
pub(crate) fn compared_cases(a: &[Observation], b: &[Observation]) -> usize {
|
||||
let cases_b: BTreeSet<_> = b.iter().map(|observation| (observation.op, observation.case)).collect();
|
||||
a.iter()
|
||||
.map(|observation| (observation.op, observation.case))
|
||||
.collect::<BTreeSet<_>>()
|
||||
.intersection(&cases_b)
|
||||
.count()
|
||||
}
|
||||
|
||||
/// The JSON report written for every run.
|
||||
#[derive(Debug, Serialize)]
|
||||
pub(crate) struct Report {
|
||||
pub schema: u32,
|
||||
pub run: String,
|
||||
pub stack_a: String,
|
||||
pub stack_b: String,
|
||||
pub region_a: Option<String>,
|
||||
pub region_b: Option<String>,
|
||||
pub compared_ops: usize,
|
||||
pub compared_cases: usize,
|
||||
pub differences: Vec<Difference>,
|
||||
}
|
||||
|
||||
impl Report {
|
||||
/// Writes the report as `<directory>/<run>.json` and returns its path.
|
||||
pub(crate) fn write_to(&self, directory: &Path) -> std::io::Result<PathBuf> {
|
||||
std::fs::create_dir_all(directory)?;
|
||||
let path = directory.join(format!("{}.json", self.run));
|
||||
let json = serde_json::to_vec_pretty(self).map_err(std::io::Error::other)?;
|
||||
std::fs::write(&path, json)?;
|
||||
Ok(path)
|
||||
}
|
||||
}
|
||||
|
||||
/// One line per difference, for a failing assertion.
|
||||
pub(crate) fn render(differences: &[Difference]) -> String {
|
||||
differences
|
||||
.iter()
|
||||
.map(|d| format!("({}, {}, {}, a={:?}, b={:?})", d.op, d.case, d.field, d.a, d.b))
|
||||
.collect::<Vec<_>>()
|
||||
.join("\n")
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn ok(op: &'static str) -> Observation {
|
||||
Observation::new(op, "normal", 200, None, [("content-type", "application/xml")])
|
||||
}
|
||||
|
||||
fn fields(differences: &[Difference]) -> Vec<&str> {
|
||||
differences.iter().map(|d| d.field.as_str()).collect()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn identical_transcripts_have_no_difference() {
|
||||
let a = vec![
|
||||
ok("HeadBucket"),
|
||||
ok("GetBucketLocation").with_field("location_constraint", "us-east-1"),
|
||||
];
|
||||
let b = a.clone();
|
||||
assert_eq!(compare(&a, &b), Vec::new());
|
||||
assert_eq!(compared_ops(&a, &b).len(), 2);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_status_difference_is_reported() {
|
||||
let a = vec![ok("PutBucketAcl")];
|
||||
let b = vec![Observation::new(
|
||||
"PutBucketAcl",
|
||||
"normal",
|
||||
403,
|
||||
None,
|
||||
[("content-type", "application/xml")],
|
||||
)];
|
||||
assert_eq!(
|
||||
compare(&a, &b),
|
||||
vec![Difference {
|
||||
op: "PutBucketAcl".into(),
|
||||
case: "normal".into(),
|
||||
field: "status".into(),
|
||||
a: "200".into(),
|
||||
b: "403".into(),
|
||||
}]
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_error_code_difference_is_reported() {
|
||||
let a = vec![Observation::new("GetObject", "negative", 404, Some("NoSuchKey".into()), [])];
|
||||
let b = vec![Observation::new(
|
||||
"GetObject",
|
||||
"negative",
|
||||
404,
|
||||
Some("NoSuchBucket".into()),
|
||||
[],
|
||||
)];
|
||||
let differences = compare(&a, &b);
|
||||
assert_eq!(fields(&differences), ["error_code"]);
|
||||
assert_eq!((differences[0].a.as_str(), differences[0].b.as_str()), ("NoSuchKey", "NoSuchBucket"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_error_code_on_one_side_only_is_reported() {
|
||||
let a = vec![Observation::new("HeadBucket", "negative", 404, Some("NotFound".into()), [])];
|
||||
let b = vec![Observation::new("HeadBucket", "negative", 404, None, [])];
|
||||
let differences = compare(&a, &b);
|
||||
assert_eq!(fields(&differences), ["error_code"]);
|
||||
assert_eq!(differences[0].b, ABSENT);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_allowlisted_header_difference_is_reported() {
|
||||
let a = vec![Observation::new("HeadObject", "normal", 200, None, [("ETag", "\"aa\"")])];
|
||||
let b = vec![Observation::new("HeadObject", "normal", 200, None, [("etag", "\"bb\"")])];
|
||||
assert_eq!(fields(&compare(&a, &b)), ["header.etag"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_header_sent_by_one_side_only_is_reported() {
|
||||
let a = vec![Observation::new(
|
||||
"DeleteObject",
|
||||
"normal",
|
||||
204,
|
||||
None,
|
||||
[("x-amz-delete-marker", "true")],
|
||||
)];
|
||||
let b = vec![Observation::new("DeleteObject", "normal", 204, None, [])];
|
||||
let differences = compare(&a, &b);
|
||||
assert_eq!(fields(&differences), ["header.x-amz-delete-marker"]);
|
||||
assert_eq!((differences[0].a.as_str(), differences[0].b.as_str()), ("true", ABSENT));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn every_server_side_encryption_header_is_compared() {
|
||||
let header = "x-amz-server-side-encryption-customer-key-md5";
|
||||
let a = vec![Observation::new("PutObject", "sse-c", 200, None, [(header, "one")])];
|
||||
let b = vec![Observation::new("PutObject", "sse-c", 200, None, [(header, "two")])];
|
||||
assert_eq!(fields(&compare(&a, &b)), [format!("header.{header}")]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn headers_outside_the_allowlist_are_not_compared() {
|
||||
let a = vec![Observation::new(
|
||||
"ListBuckets",
|
||||
"normal",
|
||||
200,
|
||||
None,
|
||||
[
|
||||
("date", "Mon"),
|
||||
("x-amz-request-id", "1"),
|
||||
("server", "a"),
|
||||
("content-length", "10"),
|
||||
],
|
||||
)];
|
||||
let b = vec![Observation::new(
|
||||
"ListBuckets",
|
||||
"normal",
|
||||
200,
|
||||
None,
|
||||
[
|
||||
("date", "Tue"),
|
||||
("x-amz-request-id", "2"),
|
||||
("server", "b"),
|
||||
("content-length", "11"),
|
||||
],
|
||||
)];
|
||||
assert_eq!(compare(&a, &b), Vec::new());
|
||||
assert!(a[0].headers.is_empty(), "non-allowlisted headers were kept: {:?}", a[0].headers);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn distinct_version_ids_are_not_a_difference() {
|
||||
let a = vec![Observation::new(
|
||||
"PutObject",
|
||||
"normal",
|
||||
200,
|
||||
None,
|
||||
[("x-amz-version-id", "0b1c")],
|
||||
)];
|
||||
let b = vec![Observation::new(
|
||||
"PutObject",
|
||||
"normal",
|
||||
200,
|
||||
None,
|
||||
[("x-amz-version-id", "9f8e")],
|
||||
)];
|
||||
assert_eq!(compare(&a, &b), Vec::new());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_null_version_id_against_a_real_one_is_reported() {
|
||||
let a = vec![Observation::new(
|
||||
"PutObject",
|
||||
"normal",
|
||||
200,
|
||||
None,
|
||||
[("x-amz-version-id", "null")],
|
||||
)];
|
||||
let b = vec![Observation::new(
|
||||
"PutObject",
|
||||
"normal",
|
||||
200,
|
||||
None,
|
||||
[("x-amz-version-id", "9f8e")],
|
||||
)];
|
||||
assert_eq!(fields(&compare(&a, &b)), ["header.x-amz-version-id"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_body_field_difference_is_reported() {
|
||||
let a = vec![ok("GetBucketLocation").with_field("location_constraint", "us-east-1")];
|
||||
let b = vec![ok("GetBucketLocation").with_field("location_constraint", "eu-west-1")];
|
||||
let differences = compare(&a, &b);
|
||||
assert_eq!(fields(&differences), ["body.location_constraint"]);
|
||||
assert_eq!((differences[0].a.as_str(), differences[0].b.as_str()), ("us-east-1", "eu-west-1"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_body_field_on_one_side_only_is_reported() {
|
||||
let a = vec![ok("ListObjectsV2").with_field("keys", "[]")];
|
||||
let b = vec![ok("ListObjectsV2")];
|
||||
assert_eq!(fields(&compare(&a, &b)), ["body.keys"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn error_messages_are_never_compared() {
|
||||
let mut a = Observation::new("GetObject", "negative", 404, Some("NoSuchKey".into()), []);
|
||||
let mut b = a.clone();
|
||||
a.message = Some("The specified key does not exist.".into());
|
||||
b.message = Some("Object not found".into());
|
||||
assert_eq!(compare(&[a], &[b]), Vec::new());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_case_observed_on_one_side_only_is_reported() {
|
||||
let a = vec![ok("HeadBucket"), ok("ListBuckets")];
|
||||
let b = vec![ok("HeadBucket")];
|
||||
let differences = compare(&a, &b);
|
||||
assert_eq!(fields(&differences), ["observation"]);
|
||||
assert_eq!(differences[0].op, "ListBuckets");
|
||||
assert_eq!(compared_ops(&a, &b).into_iter().collect::<Vec<_>>(), ["HeadBucket"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_case_recorded_twice_is_reported() {
|
||||
let a = vec![ok("HeadBucket"), ok("HeadBucket")];
|
||||
let b = vec![ok("HeadBucket")];
|
||||
assert_eq!(fields(&compare(&a, &b)), ["duplicate_case"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn compared_ops_counts_operations_not_cases() {
|
||||
let negative = Observation::new("HeadBucket", "negative", 404, Some("NotFound".into()), []);
|
||||
let a = vec![ok("HeadBucket"), negative, ok("ListBuckets")];
|
||||
let b = a.clone();
|
||||
assert_eq!(compared_ops(&a, &b).len(), 2);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_report_lists_each_difference_as_op_field_a_b() {
|
||||
let directory = std::env::temp_dir().join(format!("dual-stack-report-{}", uuid::Uuid::new_v4()));
|
||||
let report = Report {
|
||||
schema: 1,
|
||||
run: "unit".into(),
|
||||
stack_a: "legacy".into(),
|
||||
stack_b: "legacy".into(),
|
||||
region_a: None,
|
||||
region_b: Some("eu-west-1".into()),
|
||||
compared_ops: 1,
|
||||
compared_cases: 1,
|
||||
differences: compare(
|
||||
&[ok("GetBucketLocation").with_field("location_constraint", "us-east-1")],
|
||||
&[ok("GetBucketLocation").with_field("location_constraint", "eu-west-1")],
|
||||
),
|
||||
};
|
||||
let path = report.write_to(&directory).expect("write the report");
|
||||
let json: serde_json::Value = serde_json::from_slice(&std::fs::read(&path).expect("read the report")).expect("parse");
|
||||
let _ = std::fs::remove_dir_all(&directory);
|
||||
assert_eq!(path.file_name().and_then(|name| name.to_str()), Some("unit.json"));
|
||||
assert_eq!(json["compared_ops"], 1);
|
||||
assert_eq!(
|
||||
json["differences"],
|
||||
serde_json::json!([{
|
||||
"op": "GetBucketLocation",
|
||||
"case": "normal",
|
||||
"field": "body.location_constraint",
|
||||
"a": "us-east-1",
|
||||
"b": "eu-west-1",
|
||||
}])
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -1,197 +0,0 @@
|
||||
// Copyright 2024 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
//! Dual-stack differential: one `rustfs` binary, two processes, one SDK script (rustfs/backlog#2740).
|
||||
//!
|
||||
//! Stack A always runs `RUSTFS_S3_STACK=legacy`. Stack B runs the value of `RUSTFS_E2E_STACK_B`
|
||||
//! (default `legacy` until the gateway stack is assembled), and `RUSTFS_E2E_STACK_B_REGION`, when
|
||||
//! set, starts B in another region so that a difference can be injected by hand. Both servers
|
||||
//! answer the script in `scenarios`, which covers every operation of `impl S3 for FS`; `compare`
|
||||
//! reports each `(op, field, a, b)` on which the answers differ, and every run writes its report
|
||||
//! to `<target>/dual-stack/<run>.json`. Two processes, not two embedded servers: bucket metadata
|
||||
//! is process-global, so two stacks in one process would read each other's buckets.
|
||||
|
||||
mod compare;
|
||||
mod scenarios;
|
||||
|
||||
use crate::common::{RustFSTestEnvironment, init_logging, workspace_root};
|
||||
use compare::{Difference, Observation, Report, compare, compared_cases, compared_ops, render};
|
||||
use std::path::PathBuf;
|
||||
use std::time::{SystemTime, UNIX_EPOCH};
|
||||
|
||||
type BoxError = Box<dyn std::error::Error + Send + Sync>;
|
||||
|
||||
const STACK_A: &str = "legacy";
|
||||
const ENV_STACK_B: &str = "RUSTFS_E2E_STACK_B";
|
||||
const ENV_STACK_B_REGION: &str = "RUSTFS_E2E_STACK_B_REGION";
|
||||
/// Becomes `gateway` once rustfs/backlog#2734 T2.5 assembles the gateway stack.
|
||||
const DEFAULT_STACK_B: &str = "legacy";
|
||||
/// The region the negative control gives stack A explicitly, so an inherited `RUSTFS_REGION`
|
||||
/// cannot erase the injected difference.
|
||||
const CONTROL_REGION_A: &str = "us-east-1";
|
||||
const CONTROL_REGION_B: &str = "eu-west-1";
|
||||
/// `normal` cases the legacy stack must answer with a 2xx. The comparison alone cannot tell a
|
||||
/// script that exercises real behavior from one in which both stacks fail the same way. Five of
|
||||
/// the 73 fail on legacy by design of this script: PutBucketReplication (no registered remote
|
||||
/// target), GetBucketReplication (so no configuration), PutBucketNotificationConfiguration (no
|
||||
/// notification target configured), RestoreObject (the object is not archived) and
|
||||
/// GetObjectTorrent (legacy answers `NoSuchKey`).
|
||||
const MIN_NORMAL_SUCCESSES: usize = 68;
|
||||
|
||||
struct PairConfig {
|
||||
stack_b: String,
|
||||
region_a: Option<String>,
|
||||
region_b: Option<String>,
|
||||
}
|
||||
|
||||
impl PairConfig {
|
||||
fn from_env() -> Self {
|
||||
Self {
|
||||
stack_b: std::env::var(ENV_STACK_B).unwrap_or_else(|_| DEFAULT_STACK_B.to_owned()),
|
||||
region_a: None,
|
||||
region_b: std::env::var(ENV_STACK_B_REGION).ok(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Starts one server on `stack`, overriding its region only when asked.
|
||||
async fn start_stack(stack: &str, region: Option<&str>) -> Result<RustFSTestEnvironment, BoxError> {
|
||||
let mut env = RustFSTestEnvironment::new().await?;
|
||||
let mut vars = vec![("RUSTFS_S3_STACK", stack)];
|
||||
if let Some(region) = region {
|
||||
vars.push(("RUSTFS_REGION", region));
|
||||
}
|
||||
env.start_rustfs_server_without_cleanup_with_env(&vars).await?;
|
||||
Ok(env)
|
||||
}
|
||||
|
||||
/// Starts stack A and stack B side by side, each with its own port and data directory.
|
||||
async fn spawn_pair(config: &PairConfig) -> Result<(RustFSTestEnvironment, RustFSTestEnvironment), BoxError> {
|
||||
tokio::try_join!(
|
||||
start_stack(STACK_A, config.region_a.as_deref()),
|
||||
start_stack(&config.stack_b, config.region_b.as_deref())
|
||||
)
|
||||
}
|
||||
|
||||
fn report_directory() -> PathBuf {
|
||||
let target = std::env::var_os("CARGO_TARGET_DIR").map_or_else(|| PathBuf::from("target"), PathBuf::from);
|
||||
let target = if target.is_absolute() {
|
||||
target
|
||||
} else {
|
||||
workspace_root().join(target)
|
||||
};
|
||||
target.join("dual-stack")
|
||||
}
|
||||
|
||||
struct Run {
|
||||
report: Report,
|
||||
path: PathBuf,
|
||||
a: Vec<Observation>,
|
||||
}
|
||||
|
||||
/// Runs the script against both stacks concurrently and writes the report.
|
||||
async fn run_differential(label: &str, config: &PairConfig) -> Run {
|
||||
let (server_a, server_b) = spawn_pair(config).await.expect("start stack A and stack B");
|
||||
let (a, b) = tokio::join!(Box::pin(scenarios::run(&server_a)), Box::pin(scenarios::run(&server_b)));
|
||||
let millis = SystemTime::now()
|
||||
.duration_since(UNIX_EPOCH)
|
||||
.map_or(0, |elapsed| elapsed.as_millis());
|
||||
let report = Report {
|
||||
schema: 1,
|
||||
run: format!("{label}-{millis}-{}", std::process::id()),
|
||||
stack_a: STACK_A.to_owned(),
|
||||
stack_b: config.stack_b.clone(),
|
||||
region_a: config.region_a.clone(),
|
||||
region_b: config.region_b.clone(),
|
||||
compared_ops: compared_ops(&a, &b).len(),
|
||||
compared_cases: compared_cases(&a, &b),
|
||||
differences: compare(&a, &b),
|
||||
};
|
||||
let path = report.write_to(&report_directory()).expect("write the dual-stack report");
|
||||
Run { report, path, a }
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[tokio::test]
|
||||
async fn both_stacks_answer_every_operation_identically() {
|
||||
init_logging();
|
||||
let config = PairConfig::from_env();
|
||||
let run = run_differential("self-comparison", &config).await;
|
||||
let report = &run.report;
|
||||
|
||||
let mut observed: Vec<_> = run.a.iter().map(|observation| observation.op).collect();
|
||||
observed.sort_unstable();
|
||||
observed.dedup();
|
||||
assert_eq!(
|
||||
observed,
|
||||
scenarios::OPERATIONS,
|
||||
"the script must drive exactly the operations of impl S3 for FS"
|
||||
);
|
||||
assert_eq!(report.compared_ops, scenarios::OPERATIONS.len(), "report: {}", run.path.display());
|
||||
assert!(
|
||||
report.differences.is_empty(),
|
||||
"stack {} and stack {} differ on {} of {} cases (report: {}):\n{}",
|
||||
report.stack_a,
|
||||
report.stack_b,
|
||||
report.differences.len(),
|
||||
report.compared_cases,
|
||||
run.path.display(),
|
||||
render(&report.differences)
|
||||
);
|
||||
|
||||
let not_4xx: Vec<_> = run
|
||||
.a
|
||||
.iter()
|
||||
.filter(|observation| observation.case == "negative" && !(400..500).contains(&observation.status))
|
||||
.collect();
|
||||
assert!(not_4xx.is_empty(), "negative cases must fail with a 4xx on {STACK_A}: {not_4xx:#?}");
|
||||
let successes = run
|
||||
.a
|
||||
.iter()
|
||||
.filter(|observation| observation.case == "normal" && observation.is_success())
|
||||
.count();
|
||||
assert!(
|
||||
successes >= MIN_NORMAL_SUCCESSES,
|
||||
"only {successes} normal cases succeeded on {STACK_A}: {:#?}",
|
||||
run.a
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn differential_detects_an_injected_difference() {
|
||||
init_logging();
|
||||
let config = PairConfig {
|
||||
stack_b: STACK_A.to_owned(),
|
||||
region_a: Some(CONTROL_REGION_A.to_owned()),
|
||||
region_b: Some(CONTROL_REGION_B.to_owned()),
|
||||
};
|
||||
let run = run_differential("injected-region", &config).await;
|
||||
let expected = Difference {
|
||||
op: "GetBucketLocation".to_owned(),
|
||||
case: "normal".to_owned(),
|
||||
field: "body.location_constraint".to_owned(),
|
||||
a: CONTROL_REGION_A.to_owned(),
|
||||
b: CONTROL_REGION_B.to_owned(),
|
||||
};
|
||||
assert!(
|
||||
run.report.differences.contains(&expected),
|
||||
"B started in {CONTROL_REGION_B} but GetBucketLocation was not reported (report: {}):\n{}",
|
||||
run.path.display(),
|
||||
render(&run.report.differences)
|
||||
);
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1191,59 +1191,11 @@ mod tests {
|
||||
.into())
|
||||
}
|
||||
|
||||
fn scanner_cycle_completion_budget(
|
||||
cycle_end: u64,
|
||||
interval: Option<u64>,
|
||||
now: u64,
|
||||
active: bool,
|
||||
) -> Result<Duration, &'static str> {
|
||||
if cycle_end > now {
|
||||
return Err("scanner cycle timestamp is in the future");
|
||||
}
|
||||
if active {
|
||||
return Ok(Duration::from_secs(60));
|
||||
}
|
||||
let interval = interval
|
||||
.filter(|interval| *interval != 0)
|
||||
.ok_or("scanner schedule has no positive interval")?;
|
||||
let next_cycle = cycle_end
|
||||
.checked_add(interval)
|
||||
.ok_or("scanner schedule timestamp overflows")?;
|
||||
let budget = next_cycle
|
||||
.saturating_sub(now)
|
||||
.checked_add(60)
|
||||
.ok_or("scanner completion budget overflows")?;
|
||||
Ok(Duration::from_secs(budget))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn scanner_cycle_completion_budget_accounts_for_captured_retry_schedule() {
|
||||
assert_eq!(
|
||||
scanner_cycle_completion_budget(1_791_815_390, Some(256), 1_791_815_447, false),
|
||||
Ok(Duration::from_secs(259)),
|
||||
);
|
||||
assert_eq!(scanner_cycle_completion_budget(100, Some(1), 110, false), Ok(Duration::from_secs(60)));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn scanner_cycle_completion_budget_does_not_grant_planned_sleep_to_active_cycle() {
|
||||
assert_eq!(scanner_cycle_completion_budget(100, Some(256), 110, true), Ok(Duration::from_secs(60)));
|
||||
assert_eq!(scanner_cycle_completion_budget(0, None, 110, true), Ok(Duration::from_secs(60)));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn scanner_cycle_completion_budget_rejects_invalid_schedule() {
|
||||
for (end, interval, now) in [(101, 1, 100), (100, 0, 100), (u64::MAX, 1, u64::MAX), (1, u64::MAX - 1, 1)] {
|
||||
assert!(scanner_cycle_completion_budget(end, Some(interval), now, false).is_err());
|
||||
}
|
||||
}
|
||||
|
||||
async fn wait_for_scanner_cycle_after(
|
||||
cluster: &RustFSTestClusterEnvironment,
|
||||
previous_cycle_end: u64,
|
||||
) -> Result<u64, Box<dyn Error + Send + Sync>> {
|
||||
let mut deadline = Instant::now() + Duration::from_secs(60);
|
||||
let mut schedule_accounted = false;
|
||||
let deadline = Instant::now() + Duration::from_secs(60);
|
||||
loop {
|
||||
let mut latest_cycle_end = 0;
|
||||
let mut versions_observed = false;
|
||||
@@ -1285,36 +1237,14 @@ mod tests {
|
||||
let versions_scanned = metrics["versions_scanned"]
|
||||
.as_u64()
|
||||
.ok_or("scanner status is missing its version-coverage counter")?;
|
||||
let now = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH)?.as_secs();
|
||||
if cycle_end > now {
|
||||
return Err("scanner cycle timestamp is in the future".into());
|
||||
}
|
||||
let schedule = &status["cycle_schedule"];
|
||||
if !schedule_accounted && schedule["execution_role"].as_str() == Some("leader") {
|
||||
let active = metrics["current_cycle_active"]
|
||||
.as_bool()
|
||||
.ok_or("scanner status is missing its active-cycle flag")?;
|
||||
if active || (cycle_end != 0 && schedule["effective_interval_available"].as_bool() == Some(true)) {
|
||||
let interval = schedule["effective_interval_seconds"].as_u64();
|
||||
let budget = scanner_cycle_completion_budget(cycle_end, interval, now, active)?;
|
||||
deadline = Instant::now().checked_add(budget).ok_or("scanner deadline overflows")?;
|
||||
schedule_accounted = true;
|
||||
}
|
||||
}
|
||||
// Superseded walks complete all sets while withholding quota authority.
|
||||
// Deferred and partial attempts do not certify completed scanning.
|
||||
if matches!(metrics["last_cycle_result"].as_str(), Some("success" | "superseded")) {
|
||||
latest_cycle_end = latest_cycle_end.max(cycle_end);
|
||||
}
|
||||
latest_cycle_end = latest_cycle_end.max(cycle_end);
|
||||
versions_observed |= versions_scanned > 0;
|
||||
observations.push(format!(
|
||||
"node{node_index}: end={cycle_end}, versions={versions_scanned}, cycle={}, active={}, leader={}, result={}, partial_reason={}, schedule={}",
|
||||
"node{node_index}: end={cycle_end}, versions={versions_scanned}, cycle={}, active={}, leader={}, result={}",
|
||||
metrics["current_cycle"],
|
||||
metrics["current_cycle_active"],
|
||||
metrics["leader_lock_state"],
|
||||
metrics["last_cycle_result"],
|
||||
metrics["last_cycle_partial_reason"],
|
||||
schedule,
|
||||
));
|
||||
}
|
||||
// The coordinator records cycle completion, but remote workers
|
||||
@@ -1625,8 +1555,7 @@ mod tests {
|
||||
}
|
||||
|
||||
if background_enabled {
|
||||
let baseline_cycle_floor = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH)?.as_secs();
|
||||
wait_for_scanner_cycle_after(&cluster, baseline_cycle_floor).await?;
|
||||
wait_for_scanner_cycle_after(&cluster, 0).await?;
|
||||
}
|
||||
|
||||
cluster.stop_node(1)?;
|
||||
@@ -2633,156 +2562,4 @@ mod tests {
|
||||
};
|
||||
assert!(!outage_candidate_targets_replacement(&insufficient_peer_shards, 12, replacement_set_slot));
|
||||
}
|
||||
async fn two_node_heal_status(
|
||||
cluster: &RustFSTestClusterEnvironment,
|
||||
bucket: Option<&str>,
|
||||
recreate: bool,
|
||||
scan_mode: u8,
|
||||
) -> Result<serde_json::Value, Box<dyn Error + Send + Sync>> {
|
||||
let url = format!("{}/rustfs/admin/v3/heal/{}", cluster.nodes[0].url, bucket.unwrap_or_default());
|
||||
let options = serde_json::json!({
|
||||
"recursive": true, "dryRun": false, "remove": false,
|
||||
"recreate": recreate, "scanMode": scan_mode, "updateParity": false, "nolock": false,
|
||||
});
|
||||
let started =
|
||||
start_root_heal_when_control_ready(&url, &options.to_string(), &cluster.access_key, &cluster.secret_key).await?;
|
||||
let started: serde_json::Value = serde_json::from_str(&started)?;
|
||||
let token = started["clientToken"]
|
||||
.as_str()
|
||||
.ok_or_else(|| format!("missing heal token: {started}"))?;
|
||||
let status_url = format!("{url}?clientToken={token}");
|
||||
let deadline = Instant::now() + Duration::from_secs(240);
|
||||
loop {
|
||||
let body = timeout(
|
||||
Duration::from_secs(20),
|
||||
signed_admin_post(&status_url, None, &cluster.access_key, &cluster.secret_key),
|
||||
)
|
||||
.await??;
|
||||
let status: serde_json::Value = serde_json::from_str(&body)?;
|
||||
match status["summary"].as_str() {
|
||||
Some("finished" | "stopped") => return Ok(status),
|
||||
Some("running") if Instant::now() < deadline => sleep(Duration::from_millis(250)).await,
|
||||
_ => return Err(format!("heal did not reach a terminal state: {status}").into()),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async fn verify_two_node_directory_recovery(remove_bucket: bool, scan_mode: u8) -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
init_logging();
|
||||
let mut cluster = RustFSTestClusterEnvironment::new(2).await?;
|
||||
// Isolate explicit administrator recovery from scanner, MRF, and disk healing.
|
||||
for key in [
|
||||
"RUSTFS_HEAL_AUTO_HEAL_ENABLE",
|
||||
"RUSTFS_HEAL_MRF_ENABLE",
|
||||
"RUSTFS_SCANNER_ENABLED",
|
||||
"RUSTFS_PUT_RENAME_EARLY_ACK_ENABLE",
|
||||
] {
|
||||
cluster.set_env(key, "false");
|
||||
}
|
||||
cluster.start().await?;
|
||||
let source = cluster.create_s3_client(0)?;
|
||||
let target = cluster.create_s3_client(1)?;
|
||||
let bucket = "two-node-directory-recovery";
|
||||
source.create_bucket().bucket(bucket).send().await?;
|
||||
let objects = [
|
||||
("empty", Vec::new()),
|
||||
("nested/inline", vec![0x3c; 1024]),
|
||||
("nested/external", (0_u8..=255).cycle().take(1024 * 1024).collect::<Vec<_>>()),
|
||||
];
|
||||
for (key, bytes) in &objects {
|
||||
source
|
||||
.put_object()
|
||||
.bucket(bucket)
|
||||
.key(*key)
|
||||
.body(ByteStream::from(bytes.clone()))
|
||||
.send()
|
||||
.await?;
|
||||
}
|
||||
let target_bucket = Path::new(&cluster.nodes[1].data_dir).join(bucket);
|
||||
let original = objects
|
||||
.iter()
|
||||
.map(|(key, _)| census_object_version_on_disk(Path::new(&cluster.nodes[1].data_dir), bucket, key, None))
|
||||
.collect::<Result<Vec<_>, _>>()?;
|
||||
for census in &original {
|
||||
assert!(census.has_xl_meta, "fixture must have a target metadata copy: {census:?}");
|
||||
}
|
||||
assert!(
|
||||
!original[2].present_part_fingerprints.is_empty(),
|
||||
"large fixture must exercise external parts"
|
||||
);
|
||||
let removed = Path::new(&cluster.temp_dir).join("removed");
|
||||
tokio::fs::create_dir(&removed).await?;
|
||||
if remove_bucket {
|
||||
tokio::fs::rename(&target_bucket, removed.join(bucket)).await?;
|
||||
let status = two_node_heal_status(&cluster, None, false, scan_mode).await?;
|
||||
assert_eq!(
|
||||
status["summary"], "stopped",
|
||||
"missing bucket must not look like an empty successful scan: {status}"
|
||||
);
|
||||
assert_eq!(status["outcome"]["execution"]["state"], "aborted");
|
||||
assert_eq!(status["outcome"]["coverage"], "partial");
|
||||
assert_eq!(status["outcome"]["counters"]["processed"], 0);
|
||||
assert!(!target_bucket.exists(), "default discovery must not silently recreate a bucket");
|
||||
let scoped_default = two_node_heal_status(&cluster, Some(bucket), false, scan_mode).await?;
|
||||
assert_eq!(
|
||||
scoped_default["summary"], "stopped",
|
||||
"default namespace quorum protection must remain: {scoped_default}"
|
||||
);
|
||||
} else {
|
||||
for (index, (key, _)) in objects.iter().enumerate() {
|
||||
tokio::fs::rename(target_bucket.join(key), removed.join(index.to_string())).await?;
|
||||
}
|
||||
}
|
||||
let status = two_node_heal_status(&cluster, remove_bucket.then_some(bucket), remove_bucket, scan_mode).await?;
|
||||
assert_eq!(status["summary"], "finished", "explicit recovery should complete: {status}");
|
||||
assert_eq!(status["outcome"]["execution"]["state"], "completed");
|
||||
assert_eq!(status["outcome"]["coverage"], "complete");
|
||||
for ((key, _), before) in objects.iter().zip(&original) {
|
||||
let after = census_object_version_on_disk(Path::new(&cluster.nodes[1].data_dir), bucket, key, None)?;
|
||||
assert!(after.has_xl_meta, "metadata must be restored before GET: {key}");
|
||||
assert_eq!(
|
||||
after.present_part_fingerprints, before.present_part_fingerprints,
|
||||
"external shard bytes must match: {key}"
|
||||
);
|
||||
assert_eq!(
|
||||
after.inline_data_fingerprint, before.inline_data_fingerprint,
|
||||
"inline shard bytes must match: {key}"
|
||||
);
|
||||
}
|
||||
cluster.stop_node(0)?;
|
||||
for (key, expected) in &objects {
|
||||
let actual = timeout(Duration::from_secs(30), async {
|
||||
target
|
||||
.get_object()
|
||||
.bucket(bucket)
|
||||
.key(*key)
|
||||
.send()
|
||||
.await?
|
||||
.body
|
||||
.collect()
|
||||
.await
|
||||
.map(|body| body.into_bytes())
|
||||
.map_err(Box::<dyn Error + Send + Sync>::from)
|
||||
})
|
||||
.await??;
|
||||
assert_eq!(actual.len(), expected.len(), "target-only read length: {key}");
|
||||
assert_eq!(sha256_hex(&actual), sha256_hex(expected), "target-only content: {key}");
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_two_node_bucket_discovery_and_explicit_recreate() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
verify_two_node_directory_recovery(true, 2).await
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_two_node_object_directory_recovery_normal() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
verify_two_node_directory_recovery(false, 1).await
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_two_node_object_directory_recovery_deep() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
verify_two_node_directory_recovery(false, 2).await
|
||||
}
|
||||
}
|
||||
|
||||
@@ -264,7 +264,7 @@ async fn call_make_volume_response(
|
||||
request: MakeVolumeRequest,
|
||||
headers: HeaderMap,
|
||||
) -> Result<Response<MakeVolumeResponse>, Status> {
|
||||
let mut client = node_service_time_out_client_no_auth(url)
|
||||
let mut client = node_service_time_out_client_no_auth(&url.to_string())
|
||||
.await
|
||||
.map_err(|err| Status::unavailable(format!("cannot reach the node service: {err}")))?;
|
||||
let mut rpc_request = Request::new(request);
|
||||
@@ -273,7 +273,7 @@ async fn call_make_volume_response(
|
||||
}
|
||||
|
||||
async fn call_ping_response(url: &str, headers: HeaderMap) -> Result<Response<PingResponse>, Status> {
|
||||
let mut client = node_service_time_out_client_no_auth(url)
|
||||
let mut client = node_service_time_out_client_no_auth(&url.to_string())
|
||||
.await
|
||||
.map_err(|err| Status::unavailable(format!("cannot reach the node service: {err}")))?;
|
||||
let mut rpc_request = Request::new(PingRequest {
|
||||
|
||||
@@ -31,12 +31,6 @@ pub mod chaos;
|
||||
#[cfg(test)]
|
||||
pub mod fake_s3_target;
|
||||
|
||||
// Dual-stack differential (rustfs/backlog#2740): one binary, two processes on
|
||||
// different RUSTFS_S3_STACK values, the same SDK script for every S3 operation,
|
||||
// compared on status, error code, allowlisted headers and typed body fields.
|
||||
#[cfg(test)]
|
||||
mod dual_stack_differential;
|
||||
|
||||
// On-demand migration (backlog#2147): shared two-server environment, admin
|
||||
// wrappers, and the harness self-test (backlog#2151). Behavior scenarios are
|
||||
// added by later ODM tasks.
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use crate::common::{ClusterTopology, RustFSTestClusterEnvironment};
|
||||
use crate::common::RustFSTestClusterEnvironment;
|
||||
use aws_sdk_s3::Client;
|
||||
use aws_sdk_s3::error::SdkError;
|
||||
use bytes::Bytes;
|
||||
@@ -185,113 +185,21 @@ async fn wait_for_quorum_read_admission(clients: &[Client], bucket: &str) -> Tes
|
||||
return Ok(());
|
||||
}
|
||||
if tokio::time::Instant::now() >= deadline {
|
||||
let diagnostics = clients[0].get_object().bucket(bucket).key("warm-small").send().await;
|
||||
return Err(format!(
|
||||
"read quorum did not become available after lease convergence for {bucket}: GET={diagnostics:?}"
|
||||
)
|
||||
.into());
|
||||
return Err(format!("read quorum did not become available after lease convergence for {bucket}").into());
|
||||
}
|
||||
tokio::time::sleep(std::time::Duration::from_millis(100)).await;
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_cold_degraded_object_mutations_require_only_storage_quorum() -> TestResult {
|
||||
crate::common::init_logging();
|
||||
let mut cluster = RustFSTestClusterEnvironment::new(4).await?;
|
||||
cluster.set_env("RUSTFS_STORAGE_CLASS_STANDARD", "EC:2");
|
||||
cluster.set_env("RUSTFS_PUT_RENAME_EARLY_ACK_ENABLE", "false");
|
||||
cluster.set_env("RUSTFS_OBS_METRICS_EXPORT_ENABLED", "false");
|
||||
cluster.set_env("RUSTFS_GET_OBJECT_METADATA_CACHE_DISTRIBUTED_ENABLE", "false");
|
||||
cluster.start().await?;
|
||||
let clients = cluster
|
||||
.create_all_clients()?
|
||||
.into_iter()
|
||||
.map(|client| {
|
||||
Client::from_conf(
|
||||
client
|
||||
.config()
|
||||
.to_builder()
|
||||
.retry_config(aws_sdk_s3::config::retry::RetryConfig::standard().with_max_attempts(1))
|
||||
.build(),
|
||||
)
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
let bucket = "cold-degraded-mutations";
|
||||
clients[0].create_bucket().bucket(bucket).send().await?;
|
||||
// No object mutation may warm a process-wide configuration probe before
|
||||
// the missing peer is introduced. Three shards still satisfy EC:2 writes.
|
||||
cluster.stop_node(3)?;
|
||||
let admission_deadline = Instant::now() + Duration::from_secs(30);
|
||||
for client in &clients[..3] {
|
||||
loop {
|
||||
match client
|
||||
.get_object()
|
||||
.bucket(bucket)
|
||||
.key("never-created-readiness-probe")
|
||||
.send()
|
||||
.await
|
||||
{
|
||||
Err(error) if error.as_service_error().and_then(|error| error.meta().code()) == Some("NoSuchKey") => break,
|
||||
Err(error)
|
||||
if error.raw_response().is_some_and(|response| response.status().as_u16() == 503)
|
||||
&& Instant::now() < admission_deadline =>
|
||||
{
|
||||
tokio::time::sleep(Duration::from_millis(100)).await;
|
||||
}
|
||||
Err(error) => return Err(error.into()),
|
||||
Ok(_) => panic!("a cold readiness probe must not create an object"),
|
||||
}
|
||||
}
|
||||
}
|
||||
let body = b"first write while one peer is offline";
|
||||
clients[0]
|
||||
.put_object()
|
||||
.bucket(bucket)
|
||||
.key("object")
|
||||
.body(Bytes::from_static(body).into())
|
||||
.send()
|
||||
.await?;
|
||||
for client in &clients[..3] {
|
||||
assert_quorum_object_body(client, bucket, "object", body).await?;
|
||||
}
|
||||
// This coordinator has not previously committed an object mutation either.
|
||||
clients[1].delete_object().bucket(bucket).key("object").send().await?;
|
||||
let error = clients[2]
|
||||
.get_object()
|
||||
.bucket(bucket)
|
||||
.key("object")
|
||||
.send()
|
||||
.await
|
||||
.expect_err("acknowledged deletion must be visible at another entrypoint");
|
||||
assert_eq!(error.as_service_error().and_then(|error| error.meta().code()), Some("NoSuchKey"));
|
||||
|
||||
cluster.stop_node(2)?;
|
||||
let error = clients[0]
|
||||
.put_object()
|
||||
.bucket(bucket)
|
||||
.key("below-quorum")
|
||||
.body(Bytes::from_static(body).into())
|
||||
.send()
|
||||
.await
|
||||
.expect_err("removing the cache gate must not weaken storage write quorum");
|
||||
assert_eq!(error.as_service_error().and_then(|error| error.meta().code()), Some("ServiceUnavailable"));
|
||||
cluster.stop();
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_degraded_cluster_read_quorum_follows_erasure_layout() -> TestResult {
|
||||
crate::common::init_logging();
|
||||
|
||||
for (node_count, parity) in [(3, 1), (4, 2), (6, 3), (6, 2), (4, 0)] {
|
||||
for (node_count, parity) in [(4, 2), (6, 3), (6, 2)] {
|
||||
let read_quorum = node_count - parity;
|
||||
let write_quorum = read_quorum + usize::from(read_quorum == parity);
|
||||
let mut cluster = RustFSTestClusterEnvironment::new(node_count).await?;
|
||||
cluster.set_env("RUSTFS_STORAGE_CLASS_STANDARD", format!("EC:{parity}"));
|
||||
if parity == 0 {
|
||||
cluster.set_env("RUSTFS_STORAGE_CLASS_RRS", "EC:0");
|
||||
}
|
||||
// Wait for every seed fanout before removing any physical shard.
|
||||
cluster.set_env("RUSTFS_PUT_RENAME_EARLY_ACK_ENABLE", "false");
|
||||
cluster.set_env("RUSTFS_OBS_METRICS_EXPORT_ENABLED", "false");
|
||||
@@ -430,277 +338,6 @@ async fn test_degraded_cluster_read_quorum_follows_erasure_layout() -> TestResul
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_cold_start_read_quorum_follows_erasure_layout() -> TestResult {
|
||||
crate::common::init_logging();
|
||||
for (node_count, parity) in [(3, 1), (4, 2), (6, 3), (6, 2), (4, 0)] {
|
||||
let read_quorum = node_count - parity;
|
||||
let write_quorum = read_quorum + usize::from(read_quorum == parity);
|
||||
let mut cluster = RustFSTestClusterEnvironment::new(node_count).await?;
|
||||
cluster.set_env("RUSTFS_STORAGE_CLASS_STANDARD", format!("EC:{parity}"));
|
||||
if parity == 0 {
|
||||
cluster.set_env("RUSTFS_STORAGE_CLASS_RRS", "EC:0");
|
||||
}
|
||||
cluster.set_env("RUSTFS_PUT_RENAME_EARLY_ACK_ENABLE", "false");
|
||||
cluster.set_env("RUSTFS_OBS_METRICS_EXPORT_ENABLED", "false");
|
||||
cluster.set_env("RUST_LOG", "warn");
|
||||
cluster.start().await?;
|
||||
let clients = cluster
|
||||
.create_all_clients()?
|
||||
.into_iter()
|
||||
.map(|client| {
|
||||
Client::from_conf(
|
||||
client
|
||||
.config()
|
||||
.to_builder()
|
||||
.retry_config(aws_sdk_s3::config::retry::RetryConfig::standard().with_max_attempts(1))
|
||||
.build(),
|
||||
)
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
let bucket = format!("cold-read-quorum-{node_count}-{parity}");
|
||||
clients[0].create_bucket().bucket(&bucket).send().await?;
|
||||
let small = b"cold startup follows the stored EC layout".to_vec();
|
||||
let large = vec![73; 256 * 1024];
|
||||
for (key, body) in [
|
||||
("warm-small", &small),
|
||||
("warm-large", &large),
|
||||
("cold-large", &large),
|
||||
("below-quorum", &large),
|
||||
] {
|
||||
clients[0]
|
||||
.put_object()
|
||||
.bucket(&bucket)
|
||||
.key(key)
|
||||
.body(Bytes::copy_from_slice(body).into())
|
||||
.send()
|
||||
.await?;
|
||||
for node in &cluster.nodes {
|
||||
let census =
|
||||
crate::chaos::census_object_version_on_disk(std::path::Path::new(&node.data_dir), &bucket, key, None)?;
|
||||
assert!(census.is_complete(), "seed shard must exist before cold startup: {census:?}");
|
||||
assert_eq!((census.data_blocks, census.parity_blocks), (Some(read_quorum), Some(parity)));
|
||||
}
|
||||
}
|
||||
for node in 0..node_count {
|
||||
cluster.stop_node(node)?;
|
||||
}
|
||||
// Rebuild every process's in-memory state below read quorum, then
|
||||
// cross the EC boundary. A format bootstrap must not admit S3 reads
|
||||
// merely because half the peers are online (e.g. six disks, EC:2).
|
||||
for node in 0..read_quorum - 1 {
|
||||
cluster.start_node_process(node).await?;
|
||||
}
|
||||
let error = clients[0]
|
||||
.get_object()
|
||||
.bucket(&bucket)
|
||||
.key("below-quorum")
|
||||
.send()
|
||||
.await
|
||||
.expect_err("cold startup below the configured EC read quorum must stay unavailable");
|
||||
assert_eq!(error.raw_response().map(|response| response.status().as_u16()), Some(503));
|
||||
cluster.start_node_process(read_quorum - 1).await?;
|
||||
wait_for_quorum_read_admission(&clients[..read_quorum], &bucket).await?;
|
||||
for client in clients.iter().take(read_quorum) {
|
||||
assert_quorum_object_body(client, &bucket, "warm-small", &small).await?;
|
||||
assert_quorum_object_body(client, &bucket, "cold-large", &large).await?;
|
||||
let write = client
|
||||
.put_object()
|
||||
.bucket(&bucket)
|
||||
.key("cold-quorum-write")
|
||||
.body(Bytes::copy_from_slice(&small).into())
|
||||
.send()
|
||||
.await;
|
||||
if read_quorum >= write_quorum {
|
||||
write?;
|
||||
assert_quorum_object_body(client, &bucket, "cold-quorum-write", &small).await?;
|
||||
} else {
|
||||
let error = write.expect_err("cold startup at read quorum must preserve the EC write quorum");
|
||||
assert_eq!(error.raw_response().map(|response| response.status().as_u16()), Some(503));
|
||||
}
|
||||
}
|
||||
for node in read_quorum..node_count {
|
||||
cluster.start_node(node).await?;
|
||||
}
|
||||
for client in &clients {
|
||||
assert_quorum_object_body(client, &bucket, "cold-large", &large).await?;
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_four_by_six_cold_start_at_read_quorum() -> TestResult {
|
||||
crate::common::init_logging();
|
||||
let mut cluster = RustFSTestClusterEnvironment::with_topology(ClusterTopology::single_pool_multidrive(4, 6)).await?;
|
||||
// Explicit URLs are consumed in order. Place one drive from each node in
|
||||
// every set, matching a four-host, six-drive-per-host deployment.
|
||||
let volumes = (0..6)
|
||||
.flat_map(|drive| {
|
||||
cluster
|
||||
.nodes
|
||||
.iter()
|
||||
.map(move |node| format!("http://{}{}", node.address, node.data_dirs[drive]))
|
||||
})
|
||||
.collect::<Vec<_>>()
|
||||
.join(" ");
|
||||
cluster.set_env("RUSTFS_VOLUMES", volumes);
|
||||
cluster.set_env("RUSTFS_ERASURE_SET_DRIVE_COUNT", "4");
|
||||
cluster.set_env("RUSTFS_STORAGE_CLASS_STANDARD", "EC:2");
|
||||
cluster.set_env("RUSTFS_PUT_RENAME_EARLY_ACK_ENABLE", "false");
|
||||
cluster.set_env("RUSTFS_OBS_METRICS_EXPORT_ENABLED", "false");
|
||||
cluster.set_env("RUST_LOG", "error");
|
||||
cluster.start().await?;
|
||||
let clients = cluster
|
||||
.create_all_clients()?
|
||||
.into_iter()
|
||||
.map(|client| {
|
||||
Client::from_conf(
|
||||
client
|
||||
.config()
|
||||
.to_builder()
|
||||
.retry_config(aws_sdk_s3::config::retry::RetryConfig::standard().with_max_attempts(1))
|
||||
.build(),
|
||||
)
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
let bucket = "cold-start-read-quorum";
|
||||
clients[0].create_bucket().bucket(bucket).send().await?;
|
||||
let mut fixtures = Vec::new();
|
||||
let mut covered = [[false; 2]; 6];
|
||||
for index in 0..128 {
|
||||
let key = match index {
|
||||
0 => "warm-small".to_string(),
|
||||
1 => "warm-large".to_string(),
|
||||
_ => format!("cold-{index}"),
|
||||
};
|
||||
let size_class = index % 2;
|
||||
let size = if size_class == 0 { 71 } else { 256 * 1024 };
|
||||
let body = (0..size)
|
||||
.map(|offset| u8::try_from(offset % 251).expect("bounded fixture byte"))
|
||||
.collect::<Vec<_>>();
|
||||
clients[0]
|
||||
.put_object()
|
||||
.bucket(bucket)
|
||||
.key(&key)
|
||||
.body(Bytes::copy_from_slice(&body).into())
|
||||
.send()
|
||||
.await?;
|
||||
for node in &cluster.nodes {
|
||||
let mut complete_shards = 0;
|
||||
for (drive, path) in node.data_dirs.iter().enumerate() {
|
||||
let census = crate::chaos::census_object_version_on_disk(std::path::Path::new(path), bucket, &key, None)?;
|
||||
if census.has_xl_meta {
|
||||
assert!(census.is_complete(), "seed shard must be complete before shutdown: {census:?}");
|
||||
assert_eq!((census.data_blocks, census.parity_blocks), (Some(2), Some(2)));
|
||||
covered[drive][size_class] = true;
|
||||
complete_shards += 1;
|
||||
}
|
||||
}
|
||||
assert_eq!(complete_shards, 1, "each node must own one shard of every seed object");
|
||||
}
|
||||
fixtures.push((key, body));
|
||||
if covered.iter().flatten().all(|covered| *covered) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
assert!(
|
||||
covered.iter().flatten().all(|covered| *covered),
|
||||
"fixtures must cover all six sets with inline and large objects"
|
||||
);
|
||||
|
||||
for first in 0..4 {
|
||||
for second in first + 1..4 {
|
||||
for node in 0..4 {
|
||||
cluster.stop_node(node)?;
|
||||
}
|
||||
cluster.start_node_process(first).await?;
|
||||
let error = clients[first]
|
||||
.get_object()
|
||||
.bucket(bucket)
|
||||
.key("warm-large")
|
||||
.send()
|
||||
.await
|
||||
.expect_err("one node cannot satisfy read quorum after a cold start");
|
||||
assert_eq!(error.raw_response().map(|response| response.status().as_u16()), Some(503));
|
||||
cluster.start_node_process(second).await?;
|
||||
wait_for_quorum_read_admission(&[clients[first].clone(), clients[second].clone()], bucket).await?;
|
||||
for node in [first, second] {
|
||||
for (key, body) in &fixtures {
|
||||
assert_quorum_object_body(&clients[node], bucket, key, body).await?;
|
||||
}
|
||||
let range = clients[node]
|
||||
.get_object()
|
||||
.bucket(bucket)
|
||||
.key("warm-large")
|
||||
.range("bytes=17-1023")
|
||||
.send()
|
||||
.await?;
|
||||
assert_eq!(range.body.collect().await?.into_bytes().as_ref(), &fixtures[1].1[17..1024]);
|
||||
let listing = clients[node].list_objects_v2().bucket(bucket).send().await?;
|
||||
for (key, _) in &fixtures {
|
||||
assert!(
|
||||
listing.contents().iter().any(|object| object.key() == Some(key.as_str())),
|
||||
"listing omitted {key}"
|
||||
);
|
||||
}
|
||||
let error = clients[node]
|
||||
.put_object()
|
||||
.bucket(bucket)
|
||||
.key("recovery-write")
|
||||
.body(Bytes::from_static(b"after recovery").into())
|
||||
.send()
|
||||
.await
|
||||
.expect_err("two nodes must not authorize a write");
|
||||
assert_eq!(error.raw_response().map(|response| response.status().as_u16()), Some(503));
|
||||
}
|
||||
let error = clients[first]
|
||||
.delete_object()
|
||||
.bucket(bucket)
|
||||
.key("warm-large")
|
||||
.send()
|
||||
.await
|
||||
.expect_err("two nodes must not authorize a delete");
|
||||
assert_eq!(error.raw_response().map(|response| response.status().as_u16()), Some(503));
|
||||
assert_quorum_object_body(&clients[first], bucket, "warm-large", &fixtures[1].1).await?;
|
||||
|
||||
let remaining = (0..4).filter(|node| *node != first && *node != second).collect::<Vec<_>>();
|
||||
cluster.start_node(remaining[0]).await?;
|
||||
let deadline = tokio::time::Instant::now() + Duration::from_secs(90);
|
||||
loop {
|
||||
match clients[first]
|
||||
.put_object()
|
||||
.bucket(bucket)
|
||||
.key("recovery-write")
|
||||
.body(Bytes::from_static(b"after recovery").into())
|
||||
.send()
|
||||
.await
|
||||
{
|
||||
Ok(_) => break,
|
||||
Err(error)
|
||||
if error.raw_response().is_some_and(|response| response.status().as_u16() == 503)
|
||||
&& tokio::time::Instant::now() < deadline =>
|
||||
{
|
||||
tokio::time::sleep(Duration::from_millis(200)).await
|
||||
}
|
||||
Err(error) => return Err(error.into()),
|
||||
}
|
||||
}
|
||||
for node in [first, second, remaining[0]] {
|
||||
assert_quorum_object_body(&clients[node], bucket, "recovery-write", b"after recovery").await?;
|
||||
}
|
||||
cluster.start_node(remaining[1]).await?;
|
||||
for client in &clients {
|
||||
for (key, body) in &fixtures {
|
||||
assert_quorum_object_body(client, bucket, key, body).await?;
|
||||
}
|
||||
assert_quorum_object_body(client, bucket, "recovery-write", b"after recovery").await?;
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn put_object(client: Client, payload: Vec<u8>, writer_id: usize) -> Result<(), String> {
|
||||
client
|
||||
.put_object()
|
||||
|
||||
@@ -465,13 +465,6 @@ impl NodeService for MinimalLockNodeService {
|
||||
Err(Status::unimplemented("lock-only test server"))
|
||||
}
|
||||
|
||||
async fn recover_delete_transaction(
|
||||
&self,
|
||||
_request: Request<rustfs_protos::proto_gen::node_service::RecoverDeleteTransactionRequest>,
|
||||
) -> Result<Response<rustfs_protos::proto_gen::node_service::RecoverDeleteTransactionResponse>, Status> {
|
||||
Err(Status::unimplemented("delete recovery is not supported by the lock fixture"))
|
||||
}
|
||||
|
||||
async fn settle_part_transaction(
|
||||
&self,
|
||||
_request: Request<rustfs_protos::proto_gen::node_service::SettlePartTransactionRequest>,
|
||||
|
||||
@@ -740,7 +740,7 @@ async fn test_bucket_tags_opa_contract() -> TestResult {
|
||||
.version_id(version)
|
||||
.send()
|
||||
.await?;
|
||||
opa.expect_bucket_tags("s3:GetObjectVersion", source, Some("finance")).await?;
|
||||
opa.expect_bucket_tags("s3:GetObject", source, Some("finance")).await?;
|
||||
client.list_objects_v2().bucket(source).send().await?;
|
||||
opa.expect_bucket_tags("s3:ListBucket", source, Some("finance")).await?;
|
||||
client.list_object_versions().bucket(source).send().await?;
|
||||
|
||||
@@ -2345,7 +2345,7 @@ fn layout_reported_parts(attributes: &aws_sdk_s3::operation::get_object_attribut
|
||||
attributes.object_parts().map(|parts| parts.parts().len())
|
||||
}
|
||||
|
||||
async fn assert_layout_full_body(client: &Client, case: &LayoutCase, context: &str) -> TestResult {
|
||||
async fn assert_layout_readable(client: &Client, case: &LayoutCase, context: &str) -> TestResult {
|
||||
let label = case.label();
|
||||
let head = layout_head(client, case).await?;
|
||||
assert_eq!(
|
||||
@@ -2362,12 +2362,7 @@ async fn assert_layout_full_body(client: &Client, case: &LayoutCase, context: &s
|
||||
let full = layout_get(client, case, None, None).await?.body.collect().await?.into_bytes();
|
||||
assert_eq!(full.len(), case.body.len(), "{context}: {label}: full GET length");
|
||||
assert!(full == case.body, "{context}: {label}: full GET body must equal the rc.5 upload");
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn assert_layout_readable(client: &Client, case: &LayoutCase, context: &str) -> TestResult {
|
||||
assert_layout_full_body(client, case, context).await?;
|
||||
let label = case.label();
|
||||
if case.is_multipart_layout() {
|
||||
let first = case.part_sizes[0];
|
||||
let range = format!("bytes={}-{}", first - 32, first + 31);
|
||||
@@ -2646,11 +2641,10 @@ async fn direct_upgrade_from_rc5_preserves_multipart_layouts() -> TestResult {
|
||||
"rc.5 wrote a legacy layout"
|
||||
);
|
||||
}
|
||||
// Prove the rc.5 writer persisted every original byte before upgrading.
|
||||
// Its compressed cross-part range reader has a legacy limitation; the
|
||||
// upgraded reader must still satisfy every range and partNumber assertion.
|
||||
// The rc.5 writer must itself still read what it wrote, so a later
|
||||
// failure is attributable to the upgrade rather than to the fixture.
|
||||
for case in &cases {
|
||||
assert_layout_full_body(&old_client, case, "rc.5").await?;
|
||||
assert_layout_readable(&old_client, case, "rc.5").await?;
|
||||
}
|
||||
|
||||
// Upgrade in place.
|
||||
|
||||
@@ -122,6 +122,8 @@ test-util = []
|
||||
e2e-test-hooks = []
|
||||
|
||||
[dependencies]
|
||||
rustfs-capture-authority = { workspace = true }
|
||||
openraft = { workspace = true, features = ["storage-v2"] }
|
||||
hotpath.workspace = true
|
||||
rustfs-filemeta.workspace = true
|
||||
rustfs-utils = { workspace = true, features = ["full"] }
|
||||
@@ -183,7 +185,6 @@ sha2 = { workspace = true }
|
||||
hex-simd = { workspace = true }
|
||||
tempfile.workspace = true
|
||||
hyper = { workspace = true, features = ["http2", "http1", "server"] }
|
||||
h2 = { workspace = true }
|
||||
hyper-util = { workspace = true, features = ["tokio", "server-auto", "server-graceful", "tracing"] }
|
||||
hyper-rustls = { workspace = true, default-features = false, features = ["native-tokio", "http1", "tls12", "logging", "http2", "aws-lc-rs"] }
|
||||
hostname.workspace = true
|
||||
@@ -201,8 +202,8 @@ md-5.workspace = true
|
||||
memmap2 = { workspace = true }
|
||||
libc.workspace = true
|
||||
# "process" adds getrlimit for the io_uring fd-cache RLIMIT_NOFILE gate
|
||||
# (backlog#1178); "thread" provides cleanup affinity; "fs" is a workspace default.
|
||||
rustix = { workspace = true, features = ["process", "fs", "thread"] }
|
||||
# (backlog#1178); "fs" comes from the workspace default.
|
||||
rustix = { workspace = true, features = ["process", "fs"] }
|
||||
rustfs-madmin.workspace = true
|
||||
reqwest = { workspace = true }
|
||||
aws-sdk-s3 = { workspace = true, default-features = false, features = ["sigv4a", "default-https-client", "rt-tokio"] }
|
||||
|
||||
@@ -199,10 +199,10 @@ pub mod bucket {
|
||||
get_object_lock_config, get_object_lock_config_state, get_on_demand_migration_config,
|
||||
get_on_demand_migration_config_in, get_public_access_block_config, get_quota_config, get_replication_config,
|
||||
get_request_payment_config, get_sse_config, get_tagging_config, get_versioning_config, get_website_config,
|
||||
init_bucket_metadata_sys, list_bucket_targets, reload_bucket_metadata, remove_bucket_metadata,
|
||||
remove_bucket_metadata_if_absent, set_bucket_metadata, update, update_bucket_targets_under_transaction_lock,
|
||||
update_config_with, update_if_incarnation, update_if_incarnation_at, update_quota_if_incarnation,
|
||||
update_quota_if_incarnation_at, update_under_transaction_lock, update_under_transaction_lock_at,
|
||||
init_bucket_metadata_sys, list_bucket_targets, reload_bucket_metadata, remove_bucket_metadata, set_bucket_metadata,
|
||||
update, update_bucket_targets_under_transaction_lock, update_config_with, update_if_incarnation,
|
||||
update_if_incarnation_at, update_quota_if_incarnation, update_quota_if_incarnation_at, update_under_transaction_lock,
|
||||
update_under_transaction_lock_at,
|
||||
};
|
||||
#[cfg(feature = "test-util")]
|
||||
pub use crate::bucket::metadata_sys::{ConfigWriteLockProbe, test_support};
|
||||
@@ -210,8 +210,7 @@ pub mod bucket {
|
||||
|
||||
pub mod migration {
|
||||
pub use crate::bucket::migration::{
|
||||
LegacyBlobDecryptFn, migration_startup_error, try_migrate_bucket_metadata, try_migrate_bucket_metadata_for_buckets,
|
||||
try_migrate_iam_config,
|
||||
LegacyBlobDecryptFn, migration_startup_error, try_migrate_bucket_metadata, try_migrate_iam_config,
|
||||
};
|
||||
}
|
||||
|
||||
@@ -372,6 +371,43 @@ pub mod config {
|
||||
with_config_object_read_lock, with_config_object_write_lock, with_server_config_read_lock,
|
||||
with_server_config_write_lock,
|
||||
};
|
||||
|
||||
/// Observe persisted config bytes and their reader-associated metadata within a byte limit.
|
||||
pub async fn read_config_observation(
|
||||
api: std::sync::Arc<crate::store::ECStore>,
|
||||
file: &str,
|
||||
max_bytes: usize,
|
||||
) -> crate::error::Result<(Vec<u8>, crate::object_api::ObjectInfo)> {
|
||||
crate::config::com::read_config_observation(api, file, max_bytes).await
|
||||
}
|
||||
|
||||
/// Observe bounded config bytes while the caller retains the object's write owner.
|
||||
pub async fn read_config_observation_no_lock(
|
||||
api: std::sync::Arc<crate::store::ECStore>,
|
||||
file: &str,
|
||||
max_bytes: usize,
|
||||
guard: &crate::object_api::WriteCommitGuard,
|
||||
) -> crate::error::Result<(Vec<u8>, crate::object_api::ObjectInfo)> {
|
||||
crate::config::com::read_config_observation_no_lock(api, file, max_bytes, guard).await
|
||||
}
|
||||
|
||||
/// Read config bytes and metadata without treating an empty payload as absent.
|
||||
pub async fn read_config_preserve_empty_with_metadata_opts(
|
||||
api: std::sync::Arc<crate::store::ECStore>,
|
||||
file: &str,
|
||||
opts: &crate::object_api::ObjectOptions,
|
||||
) -> crate::error::Result<(Vec<u8>, crate::object_api::ObjectInfo)> {
|
||||
crate::config::com::read_config_preserve_empty_with_metadata_opts(api, file, opts).await
|
||||
}
|
||||
|
||||
pub async fn read_config_limited_preserve_empty_with_metadata_opts(
|
||||
api: std::sync::Arc<crate::store::ECStore>,
|
||||
file: &str,
|
||||
opts: &crate::object_api::ObjectOptions,
|
||||
max_bytes: usize,
|
||||
) -> crate::error::Result<(Vec<u8>, crate::object_api::ObjectInfo)> {
|
||||
crate::config::com::read_config_limited_preserve_empty_with_metadata_opts(api, file, opts, max_bytes).await
|
||||
}
|
||||
}
|
||||
|
||||
pub mod storageclass {
|
||||
@@ -423,12 +459,11 @@ pub mod disk {
|
||||
pub use crate::disk::os::{LocalPublicationPause, LocalPublicationStage};
|
||||
pub use crate::disk::{
|
||||
BATCH_READ_VERSION_MAX_ITEMS, BUCKET_META_PREFIX, BatchReadVersionItem, BatchReadVersionReq, BatchReadVersionResp,
|
||||
CheckPartsResp, ConditionalFileUpdate, DELETE_RECOVERY_PROTOCOL_VERSION, DeleteOptions, DeleteRecoveryAction,
|
||||
DeleteRecoveryCursor, DeleteRecoveryDigest, DeleteRecoveryInspection, DeleteRecoveryPage, DeleteRecoveryRpcOperation,
|
||||
DeleteRecoveryRpcReply, Disk, DiskAPI, DiskInfo, DiskInfoOptions, DiskLocation, DiskOption, DiskStore, FileInfoVersions,
|
||||
FileReader, FileWriter, HEALING_MARKER_PATH, NsScannerOpenRequest, OldCurrentSize, PartTransactionAction,
|
||||
RUSTFS_META_BUCKET, ReadMultipleReq, ReadMultipleResp, ReadOptions, RenameDataResp, STORAGE_FORMAT_FILE,
|
||||
SnapshotLeaseToken, UpdateMetadataOpts, VolumeInfo, WalkDirOptions, new_disk, validate_batch_read_version_item_count,
|
||||
CheckPartsResp, ConditionalFileUpdate, DeleteOptions, Disk, DiskAPI, DiskInfo, DiskInfoOptions, DiskLocation, DiskOption,
|
||||
DiskStore, FileInfoVersions, FileReader, FileWriter, HEALING_MARKER_PATH, NsScannerOpenRequest, OldCurrentSize,
|
||||
PartTransactionAction, RUSTFS_META_BUCKET, ReadMultipleReq, ReadMultipleResp, ReadOptions, RenameDataResp,
|
||||
STORAGE_FORMAT_FILE, SnapshotLeaseToken, UpdateMetadataOpts, VolumeInfo, WalkDirOptions, new_disk,
|
||||
validate_batch_read_version_item_count,
|
||||
};
|
||||
pub use bytes::Bytes;
|
||||
pub use endpoint::Endpoint;
|
||||
@@ -521,14 +556,13 @@ pub mod integrity {
|
||||
pub mod object {
|
||||
pub use crate::object_api::{
|
||||
BLOCK_SIZE_V2, ERASURE_ALGORITHM, EncryptionResolutionError, EncryptionResolutionErrorKind, GetObjectBodyCacheHook,
|
||||
GetObjectBodyCacheHookLookup, GetObjectBodySource, GetObjectReadCondition, GetObjectReadMetadata, GetObjectReader,
|
||||
NamespaceLockFence, ObjectEncryptionResolver, ObjectInfo, ObjectLockConfigSnapshot, ObjectMutationHook, ObjectOptions,
|
||||
PutObjReader, QuotaAdmission, RangedDecompressReader, ReadEncryptionMaterial, ReadEncryptionMode, ReadEncryptionRequest,
|
||||
GetObjectBodyCacheHookLookup, GetObjectBodySource, GetObjectReader, NamespaceLockFence, ObjectEncryptionResolver,
|
||||
ObjectInfo, ObjectLockConfigSnapshot, ObjectMutationHook, ObjectOptions, PutObjReader, QuotaAdmission,
|
||||
RangedDecompressReader, ReadEncryptionMaterial, ReadEncryptionMode, ReadEncryptionRequest,
|
||||
SCANNER_PUBLICATION_LEASE_FENCE_METADATA_KEY, ScannerPublicationCommitScope, ScannerPublicationCommitStartError,
|
||||
ScannerPublicationCommitState, ShardIntegrityWriteMode, StreamConsumer, WriteCommitGuard, WriteCompletion,
|
||||
get_object_body_cache_plaintext_len, lookup_get_object_body_cache_hook, register_get_object_body_cache_hook,
|
||||
register_object_mutation_hook, unregister_get_object_body_cache_hook, unregister_object_mutation_hook,
|
||||
with_get_object_read_condition,
|
||||
};
|
||||
pub use crate::store::{
|
||||
PrepareSelectObjectSnapshotError, PreparedGetObjectReader, SelectObjectSnapshot, SelectObjectSnapshotReadError,
|
||||
@@ -563,6 +597,7 @@ pub mod rio {
|
||||
}
|
||||
|
||||
pub mod rpc {
|
||||
pub use crate::cluster::rpc::capture_raft::{CaptureRaftError, CaptureRaftLimits, CaptureRaftNetworkFactory, CaptureRaftRpc};
|
||||
pub use crate::cluster::rpc::{
|
||||
AuthenticatedChannel, KMS_SIGNAL_SUBSYSTEM, LocalPeerS3Client, MAX_NETWORK_PROBE_BYTES, MAX_NETWORK_PROBE_DURATION,
|
||||
NetworkPeerProbeClient, NetworkPeerProbeError, NetworkPeerProbeMeasurement, NetworkPeerTarget, PEER_RESTDRY_RUN,
|
||||
@@ -593,7 +628,6 @@ pub mod set_disk {
|
||||
#[cfg(feature = "test-util")]
|
||||
pub mod test_util {
|
||||
pub use crate::bucket::quota::reservation::fail_next_quota_ledger_save_for_test;
|
||||
pub use crate::set_disk::ConditionalReadBenchmarkMetadataGuard;
|
||||
pub use crate::set_disk::{MultipartCommitBarrier, MultipartCommitPause, PutObjectCommitBarrier, PutObjectCommitPause};
|
||||
|
||||
/// Keep a namespace commit pending until the returned owner is dropped.
|
||||
@@ -610,7 +644,13 @@ pub mod store_list {
|
||||
|
||||
pub mod storage {
|
||||
pub use crate::core::pools::{HealLifecycleExpiryContext, POOL_META_NAME};
|
||||
pub use crate::disk::local::native_prepare::{
|
||||
NativePreparationDescription, NativePreparationProbe, NativePreparationReceipt,
|
||||
};
|
||||
pub use crate::store::HealWalkVersion;
|
||||
pub use crate::store::native_prepare::{
|
||||
NativePreparationFinalizeRequest, NativePreparationRecovery, NativePreparationTarget,
|
||||
};
|
||||
pub use crate::store::{
|
||||
BootstrapLocalTarget, ECStore, SCANNER_PUBLICATION_LEASE_TTL_MS, ScannerDataMovementPauseStatus, all_local_disk,
|
||||
all_local_disk_path, find_local_disk_by_ref, init_local_disks, init_local_disks_with_instance_ctx, init_lock_clients,
|
||||
|
||||
@@ -2417,16 +2417,6 @@ fn is_slow_down(err: &Error) -> bool {
|
||||
matches!(err, Error::SlowDown)
|
||||
}
|
||||
|
||||
/// Lifecycle expiry is idempotent when the exact object or version has already
|
||||
/// disappeared between the scanner listing and the delete admission.
|
||||
///
|
||||
/// Keep this predicate narrower than bucket/volume "not found" helpers: an
|
||||
/// unavailable bucket or disk is an operational failure and must not be
|
||||
/// reported as a completed expiry.
|
||||
fn is_lifecycle_expiry_already_gone(err: &Error) -> bool {
|
||||
is_err_object_not_found(err) || is_err_version_not_found(err)
|
||||
}
|
||||
|
||||
/// Resolves the expiry worker count from the single documented knob,
|
||||
/// `RUSTFS_MAX_EXPIRY_WORKERS`: a set, parsable, non-zero value wins;
|
||||
/// anything else falls back to `min(cpus, 16)`. The historical
|
||||
@@ -4930,20 +4920,6 @@ async fn expire_transitioned_object_with_lock_lost_signal(
|
||||
//audit_log_lifecycle(*oi, ILMExpiry, tags, traceFn);
|
||||
Ok(dobj)
|
||||
}
|
||||
Err(err) if is_lifecycle_expiry_already_gone(&err) => {
|
||||
debug!(
|
||||
event = EVENT_LIFECYCLE_DELETE_COMPLETED,
|
||||
component = LOG_COMPONENT_ECSTORE,
|
||||
subsystem = LOG_SUBSYSTEM_LIFECYCLE,
|
||||
bucket = %oi.bucket,
|
||||
object = %oi.name,
|
||||
operation = "delete_restored_object",
|
||||
reason = "already_gone",
|
||||
"Lifecycle delete target was already absent"
|
||||
);
|
||||
crate::object_api::notify_object_mutation(&oi.bucket, &oi.name).await;
|
||||
Ok(oi.clone())
|
||||
}
|
||||
Err(err) => Err(std::io::Error::other(err)),
|
||||
};
|
||||
}
|
||||
@@ -4954,8 +4930,6 @@ async fn expire_transitioned_object_with_lock_lost_signal(
|
||||
// pointing to a remote tier version that has already been removed. If this
|
||||
// only creates a delete marker, remote cleanup must be driven by persisted
|
||||
// free-version recovery rather than the visible delete result.
|
||||
// Keep remote transitioned not-found errors visible: local metadata
|
||||
// absence alone does not prove that the tier object was cleaned up.
|
||||
let dobj = match api.delete_object(&oi.bucket, &oi.name, opts).await {
|
||||
Ok(obj) => obj,
|
||||
Err(e) => {
|
||||
@@ -5828,20 +5802,6 @@ async fn apply_expiry_on_non_transitioned_objects_with_lock_lost_signal(
|
||||
.await
|
||||
{
|
||||
Ok(dobj) => dobj,
|
||||
Err(err) if is_lifecycle_expiry_already_gone(&err) => {
|
||||
debug!(
|
||||
event = EVENT_LIFECYCLE_DELETE_COMPLETED,
|
||||
component = LOG_COMPONENT_ECSTORE,
|
||||
subsystem = LOG_SUBSYSTEM_LIFECYCLE,
|
||||
bucket = %oi.bucket,
|
||||
object = %oi.name,
|
||||
operation = "delete_object",
|
||||
reason = "already_gone",
|
||||
"Lifecycle delete target was already absent"
|
||||
);
|
||||
crate::object_api::notify_object_mutation(&oi.bucket, &oi.name).await;
|
||||
return true;
|
||||
}
|
||||
Err(e) => {
|
||||
error!(
|
||||
event = EVENT_LIFECYCLE_DELETE_FAILED,
|
||||
@@ -6081,19 +6041,18 @@ mod tests {
|
||||
cleanup_empty_multipart_sha_dirs_on_local_disks, cleanup_stale_multipart_uploads_once_at,
|
||||
enqueue_recovered_free_version_with_state, enqueue_transition_for_existing_objects_scoped,
|
||||
enqueue_transition_with_lifecycle, enqueue_transition_with_lifecycle_report, eval_action_from_lifecycle,
|
||||
get_lock_acquire_timeout, is_lifecycle_expiry_already_gone, jitter_tier_free_version_recovery_delay,
|
||||
lifecycle_action_blocked_by_replication, lifecycle_delete_all_versions_replication_scan, lifecycle_deleted_object,
|
||||
lifecycle_replication_blocks_action, lifecycle_rule_has_date_expiration, lifecycle_version_delete_target,
|
||||
manual_transition_duration_elapsed, manual_transition_has_more_after_limit, manual_transition_recovery_progress_sink,
|
||||
manual_transition_version_marker, manual_transition_worker_failure_reason,
|
||||
mark_delete_opts_skip_decommissioned_on_remote_success, merge_stale_multipart_candidate,
|
||||
persist_manual_transition_job_progress_if_owned, persist_manual_transition_page_checkpoint,
|
||||
recover_manual_transition_job, recover_manual_transition_jobs, resolve_tier_free_version_recovery_enabled,
|
||||
resolve_transition_queue_capacity, resolve_transition_queue_send_timeout, resolve_transition_worker_count,
|
||||
resolve_transition_workers_absolute_max, run_tier_free_version_recovery_coordinator, run_tier_free_version_recovery_loop,
|
||||
select_restore_s3_location, set_lifecycle_observability_observer, set_recovered_free_version_enqueue_observer,
|
||||
should_defer_date_expiry_for_recent_config_update, transitioned_cleanup_tuple, transitioned_object_delete_opts,
|
||||
wait_for_tier_free_version_recovery,
|
||||
get_lock_acquire_timeout, jitter_tier_free_version_recovery_delay, lifecycle_action_blocked_by_replication,
|
||||
lifecycle_delete_all_versions_replication_scan, lifecycle_deleted_object, lifecycle_replication_blocks_action,
|
||||
lifecycle_rule_has_date_expiration, lifecycle_version_delete_target, manual_transition_duration_elapsed,
|
||||
manual_transition_has_more_after_limit, manual_transition_recovery_progress_sink, manual_transition_version_marker,
|
||||
manual_transition_worker_failure_reason, mark_delete_opts_skip_decommissioned_on_remote_success,
|
||||
merge_stale_multipart_candidate, persist_manual_transition_job_progress_if_owned,
|
||||
persist_manual_transition_page_checkpoint, recover_manual_transition_job, recover_manual_transition_jobs,
|
||||
resolve_tier_free_version_recovery_enabled, resolve_transition_queue_capacity, resolve_transition_queue_send_timeout,
|
||||
resolve_transition_worker_count, resolve_transition_workers_absolute_max, run_tier_free_version_recovery_coordinator,
|
||||
run_tier_free_version_recovery_loop, select_restore_s3_location, set_lifecycle_observability_observer,
|
||||
set_recovered_free_version_enqueue_observer, should_defer_date_expiry_for_recent_config_update,
|
||||
transitioned_cleanup_tuple, transitioned_object_delete_opts, wait_for_tier_free_version_recovery,
|
||||
};
|
||||
#[cfg(feature = "test-util")]
|
||||
use super::{delete_free_version_remote_object_then, encode_dir_object, get_transitioned_object_reader_with_tier_manager};
|
||||
@@ -10552,26 +10511,6 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn lifecycle_expiry_already_gone_only_accepts_object_or_version_absence() {
|
||||
assert!(is_lifecycle_expiry_already_gone(&Error::FileNotFound));
|
||||
assert!(is_lifecycle_expiry_already_gone(&Error::ObjectNotFound(
|
||||
"bucket".to_string(),
|
||||
"object".to_string(),
|
||||
)));
|
||||
assert!(is_lifecycle_expiry_already_gone(&Error::FileVersionNotFound));
|
||||
assert!(is_lifecycle_expiry_already_gone(&Error::VersionNotFound(
|
||||
"bucket".to_string(),
|
||||
"object".to_string(),
|
||||
"version".to_string(),
|
||||
)));
|
||||
|
||||
assert!(!is_lifecycle_expiry_already_gone(&Error::VolumeNotFound));
|
||||
assert!(!is_lifecycle_expiry_already_gone(&Error::DiskNotFound));
|
||||
assert!(!is_lifecycle_expiry_already_gone(&Error::ErasureReadQuorum));
|
||||
assert!(!is_lifecycle_expiry_already_gone(&Error::MethodNotAllowed));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn manual_transition_counts_already_transitioned_object() {
|
||||
let lc = latest_transition_lifecycle();
|
||||
@@ -13446,9 +13385,7 @@ mod tests {
|
||||
.bucket_incarnation_id_from_disk(&bucket)
|
||||
.await
|
||||
.expect("bucket incarnation");
|
||||
// Replaying the same scanner snapshot after the delete is an
|
||||
// already-gone success and must not be reported as a failure.
|
||||
for (attempt_incarnation, expected) in [(Uuid::new_v4(), false), (incarnation, true), (incarnation, true)] {
|
||||
for (attempt_incarnation, expected) in [(Uuid::new_v4(), false), (incarnation, true), (incarnation, false)] {
|
||||
assert_eq!(
|
||||
super::apply_expiry_on_non_transitioned_objects(
|
||||
ecstore.clone(),
|
||||
@@ -14277,11 +14214,7 @@ mod tests {
|
||||
#[tokio::test]
|
||||
#[serial]
|
||||
async fn tier_free_version_recovery_production_entrypoint_enqueues_seeded_item() {
|
||||
let (disk_paths, ecstore) =
|
||||
temp_env::async_with_vars([(super::ENV_TIER_FREE_VERSION_RECOVERY_ENABLED, Some("false"))], async {
|
||||
setup_test_env().await
|
||||
})
|
||||
.await;
|
||||
let (disk_paths, ecstore) = setup_test_env().await;
|
||||
let runtime_state = install_unconsumed_runtime_expiry_worker(&ecstore, 1).await;
|
||||
let recovery_rx = {
|
||||
let state = runtime_state.read().await;
|
||||
|
||||
@@ -439,8 +439,6 @@ pub struct BucketMetadata {
|
||||
pub bucket_incarnation_id: Uuid,
|
||||
pub(crate) bucket_incarnation_sidecar: bool,
|
||||
pub(crate) bucket_creation_committed: bool,
|
||||
// A legacy default is not proof of an interrupted creation.
|
||||
pub(crate) bucket_creation_commit_record_present: bool,
|
||||
pub policy_config_json: Vec<u8>,
|
||||
pub notification_config_xml: Vec<u8>,
|
||||
pub lifecycle_config_xml: Vec<u8>,
|
||||
@@ -516,7 +514,6 @@ impl Default for BucketMetadata {
|
||||
bucket_incarnation_id: Uuid::nil(),
|
||||
bucket_incarnation_sidecar: false,
|
||||
bucket_creation_committed: false,
|
||||
bucket_creation_commit_record_present: false,
|
||||
policy_config_json: Default::default(),
|
||||
notification_config_xml: Default::default(),
|
||||
lifecycle_config_xml: Default::default(),
|
||||
@@ -755,10 +752,7 @@ impl BucketMetadata {
|
||||
"TableBucketConfigUpdatedAt" => self.table_bucket_config_updated_at = read_msgp_time_value(rd)?,
|
||||
"DurabilityConfigUpdatedAt" => self.durability_config_updated_at = read_msgp_time_value(rd)?,
|
||||
"OnDemandMigrationConfigUpdatedAt" => self.on_demand_migration_config_updated_at = read_msgp_time_value(rd)?,
|
||||
"BucketCreationCommitted" => {
|
||||
self.bucket_creation_committed = read_msgp_bool(rd)?;
|
||||
self.bucket_creation_commit_record_present = true;
|
||||
}
|
||||
"BucketCreationCommitted" => self.bucket_creation_committed = read_msgp_bool(rd)?,
|
||||
other => {
|
||||
tracing::debug!(field = %other, "BucketMetadata decode_from: skipping unknown field");
|
||||
skip_msgp_value(rd)?;
|
||||
@@ -771,10 +765,8 @@ impl BucketMetadata {
|
||||
|
||||
/// Encode to msgp bytes. Field order follows MinIO BucketMetadata for compatibility.
|
||||
pub fn encode_to<W: Write>(&self, wr: &mut W) -> Result<()> {
|
||||
// Preserve the absence of a legacy commit record across config rewrites.
|
||||
let commit_record_present = self.bucket_creation_commit_record_present || self.bucket_creation_committed;
|
||||
// Map size: MinIO fields (25) + RustFS extensions (21) + optional commit record.
|
||||
let map_len: u32 = 46 + u32::from(commit_record_present);
|
||||
// Map size: MinIO fields (25) + RustFS extensions (22)
|
||||
let map_len: u32 = 47;
|
||||
rmp::encode::write_map_len(wr, map_len)?;
|
||||
|
||||
// MinIO field order (same as Go struct)
|
||||
@@ -855,10 +847,8 @@ impl BucketMetadata {
|
||||
write_msgp_time(wr, self.durability_config_updated_at)?;
|
||||
rmp::encode::write_str(wr, "OnDemandMigrationConfigUpdatedAt")?;
|
||||
write_msgp_time(wr, self.on_demand_migration_config_updated_at)?;
|
||||
if commit_record_present {
|
||||
rmp::encode::write_str(wr, "BucketCreationCommitted")?;
|
||||
rmp::encode::write_bool(wr, self.bucket_creation_committed)?;
|
||||
}
|
||||
rmp::encode::write_str(wr, "BucketCreationCommitted")?;
|
||||
rmp::encode::write_bool(wr, self.bucket_creation_committed)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
@@ -1701,13 +1691,6 @@ mod test {
|
||||
let mut bm = BucketMetadata::unmarshal(&body[4..]).expect("unmarshal recovered blob");
|
||||
assert_eq!(bm.name, "interop");
|
||||
assert!(!bm.bucket_creation_committed, "legacy metadata must default to uncommitted");
|
||||
assert!(!bm.bucket_creation_commit_record_present, "legacy metadata has no creation-commit record");
|
||||
let rewritten = BucketMetadata::unmarshal(&bm.marshal_msg().expect("rewrite legacy metadata"))
|
||||
.expect("read rewritten legacy metadata");
|
||||
assert!(
|
||||
!rewritten.bucket_creation_commit_record_present,
|
||||
"rewriting legacy metadata must not fabricate a creation intent"
|
||||
);
|
||||
bm.parse_all_configs().expect("parse recovered configs");
|
||||
assert!(bm.lifecycle_config.is_some());
|
||||
}
|
||||
@@ -1725,7 +1708,6 @@ mod test {
|
||||
|
||||
assert_eq!(bm.name, new.name);
|
||||
assert!(new.bucket_creation_committed);
|
||||
assert!(new.bucket_creation_commit_record_present);
|
||||
assert!(!bm.bucket_incarnation_id.is_nil());
|
||||
assert_eq!(bm.bucket_incarnation_id, new.bucket_incarnation_id);
|
||||
}
|
||||
|
||||
@@ -178,13 +178,6 @@ pub(crate) fn object_lock_config_state_from_authoritative_metadata(bm: &BucketMe
|
||||
Ok(ObjectLockConfigState::ConfirmedAbsent)
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq)]
|
||||
pub(crate) struct CachedQuotaMetadataSnapshot {
|
||||
pub(crate) quota: Option<BucketQuota>,
|
||||
pub(crate) bucket_incarnation: Uuid,
|
||||
pub(crate) quota_revision: OffsetDateTime,
|
||||
}
|
||||
|
||||
/// Convert the persisted serving-layer configuration into the storage-level
|
||||
/// [`DefaultRetention`](crate::bucket::object_lock::types::DefaultRetention)
|
||||
/// the WORM evaluation code consumes (rustfs/backlog#1842). A rule without a
|
||||
@@ -321,33 +314,6 @@ pub async fn remove_bucket_metadata(bucket: &str) -> Result<bool> {
|
||||
Ok(lock.remove(bucket).await)
|
||||
}
|
||||
|
||||
/// Remove a peer's cached metadata only when the bucket is absent under the
|
||||
/// namespace read fence. A delayed delete notification must not withdraw the
|
||||
/// metadata of a same-name bucket that has already been recreated.
|
||||
pub async fn remove_bucket_metadata_if_absent(api: Arc<ECStore>, bucket: &str) -> Result<bool> {
|
||||
if is_meta_bucketname(bucket) {
|
||||
return Ok(false);
|
||||
}
|
||||
// Lock order: bucket namespace read -> metadata system read (released)
|
||||
// -> metadata publish, matching peer reloads.
|
||||
let namespace_lock = api.new_ns_lock(bucket, bucket).await?;
|
||||
let namespace_guard = namespace_lock
|
||||
.get_read_lock(crate::set_disk::get_lock_acquire_timeout())
|
||||
.await?;
|
||||
let sys = bucket_metadata_sys_of(&api.ctx)?;
|
||||
let sys = sys.read().await.clone();
|
||||
if sys
|
||||
.bucket_exists(bucket, &namespace_guard, "peer bucket metadata removal existence check")
|
||||
.await?
|
||||
{
|
||||
return Ok(false);
|
||||
}
|
||||
await_bucket_namespace_operation(Some(&namespace_guard), bucket, "peer bucket metadata removal", async {
|
||||
Ok(sys.remove(bucket).await)
|
||||
})
|
||||
.await
|
||||
}
|
||||
|
||||
fn start_refresh_buckets_metadata_loop(sys: Arc<RwLock<BucketMetadataSys>>) {
|
||||
let Some(cancel_token) = runtime_sources::background_services_cancel_token() else {
|
||||
warn!("bucket metadata refresh loop skipped because background cancellation token is not initialized");
|
||||
@@ -1457,9 +1423,6 @@ fn quota_config_and_incarnation_from_authority(
|
||||
BucketMetadataAuthority::Authoritative(metadata)
|
||||
if metadata.bucket_incarnation_sidecar && !metadata.bucket_incarnation_id.is_nil() =>
|
||||
{
|
||||
if !metadata.quota_config_json.is_empty() && metadata.quota_config.is_none() {
|
||||
return Err(Error::other("persisted bucket quota configuration is invalid"));
|
||||
}
|
||||
Ok((
|
||||
metadata.quota_config.clone(),
|
||||
metadata.bucket_incarnation_id,
|
||||
@@ -1474,15 +1437,6 @@ fn quota_config_and_incarnation_from_authority(
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) async fn get_cached_quota_config_and_incarnation_in(
|
||||
ctx: &crate::runtime::instance::InstanceContext,
|
||||
bucket: &str,
|
||||
) -> Result<Option<CachedQuotaMetadataSnapshot>> {
|
||||
let bucket_meta_sys_lock = bucket_metadata_sys_of(ctx)?;
|
||||
let bucket_meta_sys = bucket_meta_sys_lock.read().await.clone();
|
||||
bucket_meta_sys.cached_quota_config_and_incarnation(bucket).await
|
||||
}
|
||||
|
||||
pub async fn get_replication_config(bucket: &str) -> Result<(ReplicationConfiguration, OffsetDateTime)> {
|
||||
let bucket_meta_sys_lock = get_bucket_metadata_sys()?;
|
||||
let bucket_meta_sys = bucket_meta_sys_lock.read().await;
|
||||
@@ -1619,27 +1573,9 @@ struct MetadataPublishGuard {
|
||||
_guard: tokio::sync::OwnedMutexGuard<MetadataPublishLockState>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
pub(crate) struct PendingBucketCreationProof {
|
||||
pub(crate) generation: Uuid,
|
||||
pub(crate) intent: Vec<u8>,
|
||||
pub(crate) versioning_requested: bool,
|
||||
pub(crate) witnesses: Vec<crate::disk::os::NativeBucketCreationWitness>,
|
||||
}
|
||||
|
||||
impl PendingBucketCreationProof {
|
||||
pub(crate) fn matches_metadata(&self, metadata: &BucketMetadata) -> Result<bool> {
|
||||
Ok(!metadata.bucket_creation_committed
|
||||
&& metadata.bucket_incarnation_sidecar
|
||||
&& metadata.bucket_incarnation_id == self.generation
|
||||
&& metadata.marshal_msg()? == self.intent)
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct BucketMetadataSys {
|
||||
metadata_map: Arc<RwLock<HashMap<String, Arc<BucketMetadata>>>>,
|
||||
pending_bucket_creations: Arc<RwLock<HashMap<String, PendingBucketCreationProof>>>,
|
||||
/// Serializes metadata-map commits and their derived cache updates for one
|
||||
/// bucket. Namespace locks, when present, are acquired before this lock.
|
||||
metadata_publish_locks: Arc<MetadataPublishLockRegistry>,
|
||||
@@ -1683,7 +1619,6 @@ impl BucketMetadataSys {
|
||||
pub fn new(api: Arc<ECStore>) -> Self {
|
||||
Self {
|
||||
metadata_map: Arc::new(RwLock::new(HashMap::new())),
|
||||
pending_bucket_creations: Arc::new(RwLock::new(HashMap::new())),
|
||||
metadata_publish_locks: Arc::new(MetadataPublishLockRegistry {
|
||||
locks: StdMutex::new(HashMap::new()),
|
||||
}),
|
||||
@@ -1714,81 +1649,6 @@ impl BucketMetadataSys {
|
||||
.expect("bucket metadata object store should still be live")
|
||||
}
|
||||
|
||||
pub(crate) async fn pending_bucket_creation(&self, bucket: &str) -> Option<PendingBucketCreationProof> {
|
||||
self.pending_bucket_creations.read().await.get(bucket).cloned()
|
||||
}
|
||||
|
||||
pub(crate) async fn grant_pending_bucket_creation(&self, bucket: &str, proof: PendingBucketCreationProof) {
|
||||
self.pending_bucket_creations.write().await.insert(bucket.to_owned(), proof);
|
||||
}
|
||||
|
||||
pub(crate) async fn revoke_pending_bucket_creation(&self, bucket: &str) {
|
||||
self.pending_bucket_creations.write().await.remove(bucket);
|
||||
}
|
||||
|
||||
pub(crate) async fn consume_pending_bucket_creation(
|
||||
&self,
|
||||
bucket: &str,
|
||||
metadata: &BucketMetadata,
|
||||
witnesses: &[crate::disk::os::NativeBucketCreationWitness],
|
||||
) -> Result<bool> {
|
||||
let mut pending = self.pending_bucket_creations.write().await;
|
||||
let Some(proof) = pending.get(bucket) else {
|
||||
return Ok(false);
|
||||
};
|
||||
if !proof.matches_metadata(metadata)?
|
||||
|| proof.witnesses.len() != witnesses.len()
|
||||
|| !proof
|
||||
.witnesses
|
||||
.iter()
|
||||
.zip(witnesses)
|
||||
.all(|(old, current)| old.matches(current))
|
||||
|| !crate::disk::os::consume_native_creation_witnesses(witnesses)
|
||||
{
|
||||
return Ok(false);
|
||||
}
|
||||
pending.remove(bucket);
|
||||
Ok(true)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) async fn refresh_bucket_for_test(&self, bucket: &str) -> Result<()> {
|
||||
let expected = self.metadata_map.read().await.get(bucket).cloned();
|
||||
let lock = self.object_store().new_ns_lock(bucket, bucket).await?;
|
||||
let guard = lock.get_read_lock(crate::set_disk::get_lock_acquire_timeout()).await?;
|
||||
self.load_bucket_under_namespace(bucket, MetadataLoadMode::Refresh, expected.as_ref(), &guard)
|
||||
.await
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) async fn publish_persisted_metadata_for_test(&self, bucket: &str) -> Result<()> {
|
||||
let expected = self.metadata_map.read().await.get(bucket).cloned();
|
||||
let lock = self.object_store().new_ns_lock(bucket, bucket).await?;
|
||||
let guard = lock.get_read_lock(crate::set_disk::get_lock_acquire_timeout()).await?;
|
||||
let (metadata, persisted) = await_bucket_namespace_operation(
|
||||
Some(&guard),
|
||||
bucket,
|
||||
"test cached metadata load",
|
||||
load_bucket_metadata_parse_with_presence(self.object_store(), bucket, true),
|
||||
)
|
||||
.await?;
|
||||
self.publish_if_unchanged(bucket, expected.as_ref(), metadata, persisted, &guard)
|
||||
.await
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) async fn migrate_bucket_creation_commit_for_test(&self, bucket: &str) -> Result<()> {
|
||||
self.migrate_bucket_creation_commit(bucket).await.map(|_| ())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) async fn legacy_migration_reports_missing_bucket_for_test(&self, bucket: &str) -> Result<bool> {
|
||||
Ok(matches!(
|
||||
self.migrate_legacy_metadata(bucket).await?,
|
||||
BucketMetadataAuthority::MissingBucket
|
||||
))
|
||||
}
|
||||
|
||||
fn object_store_if_live(&self) -> Option<Arc<ECStore>> {
|
||||
self.api.upgrade()
|
||||
}
|
||||
@@ -1979,7 +1839,6 @@ impl BucketMetadataSys {
|
||||
expected: Option<&Arc<BucketMetadata>>,
|
||||
namespace_guard: &rustfs_lock::NamespaceLockGuard,
|
||||
) -> Result<()> {
|
||||
self.revoke_pending_bucket_creation(bucket).await;
|
||||
if !await_bucket_namespace_operation(
|
||||
Some(namespace_guard),
|
||||
bucket,
|
||||
@@ -2063,7 +1922,6 @@ impl BucketMetadataSys {
|
||||
persisted: bool,
|
||||
namespace_guard: &rustfs_lock::NamespaceLockGuard,
|
||||
) -> Result<()> {
|
||||
self.revoke_pending_bucket_creation(bucket).await;
|
||||
if !persisted {
|
||||
let _publish_guard = self
|
||||
.lock_metadata_publish(bucket, namespace_guard, "refreshed bucket metadata absence publish")
|
||||
@@ -2125,7 +1983,6 @@ impl BucketMetadataSys {
|
||||
}
|
||||
|
||||
pub async fn set(&self, bucket: String, bm: Arc<BucketMetadata>) {
|
||||
self.revoke_pending_bucket_creation(&bucket).await;
|
||||
if !is_meta_bucketname(&bucket) {
|
||||
let publish_lock = self.metadata_publish_lock(&bucket);
|
||||
let _publish_guard = publish_lock.lock().await;
|
||||
@@ -2147,7 +2004,6 @@ impl BucketMetadataSys {
|
||||
if is_meta_bucketname(bucket) {
|
||||
return false;
|
||||
}
|
||||
self.revoke_pending_bucket_creation(bucket).await;
|
||||
let publish_lock = self.metadata_publish_lock(bucket);
|
||||
let _publish_guard = publish_lock.lock().await;
|
||||
let mut map = self.metadata_map.write().await;
|
||||
@@ -2165,7 +2021,6 @@ impl BucketMetadataSys {
|
||||
}
|
||||
|
||||
async fn _reset(&mut self) {
|
||||
self.pending_bucket_creations.write().await.clear();
|
||||
let mut map = self.metadata_map.write().await;
|
||||
map.clear();
|
||||
drop(map);
|
||||
@@ -2304,7 +2159,6 @@ impl BucketMetadataSys {
|
||||
/// server's metadata never leaks into the ambient (first) instance.
|
||||
pub(crate) async fn persist_and_set(&self, bm: BucketMetadata) -> Result<()> {
|
||||
let mut bm = bm;
|
||||
self.revoke_pending_bucket_creation(&bm.name).await;
|
||||
bm.save_with_store(self.object_store()).await?;
|
||||
|
||||
self.set(bm.name.clone(), Arc::new(bm)).await;
|
||||
@@ -2313,7 +2167,6 @@ impl BucketMetadataSys {
|
||||
}
|
||||
|
||||
async fn persist_new_and_set(&self, mut bm: BucketMetadata) -> Result<()> {
|
||||
self.revoke_pending_bucket_creation(&bm.name).await;
|
||||
bm.bucket_creation_committed = true;
|
||||
bm.save_with_store_committed(self.object_store()).await?;
|
||||
save_bucket_incarnation(self.object_store(), &bm.name, bm.bucket_incarnation_id).await?;
|
||||
@@ -2323,9 +2176,7 @@ impl BucketMetadataSys {
|
||||
}
|
||||
|
||||
async fn persist_new_bucket_metadata_intent(&self, mut bm: BucketMetadata) -> Result<()> {
|
||||
self.revoke_pending_bucket_creation(&bm.name).await;
|
||||
bm.bucket_creation_committed = false;
|
||||
bm.bucket_creation_commit_record_present = true;
|
||||
bm.save_with_store(self.object_store()).await?;
|
||||
save_bucket_incarnation(self.object_store(), &bm.name, bm.bucket_incarnation_id).await?;
|
||||
bm.bucket_incarnation_sidecar = true;
|
||||
@@ -2335,7 +2186,6 @@ impl BucketMetadataSys {
|
||||
}
|
||||
|
||||
async fn commit_bucket_metadata(&self, mut bm: BucketMetadata) -> Result<()> {
|
||||
self.revoke_pending_bucket_creation(&bm.name).await;
|
||||
bm.parse_all_configs()?;
|
||||
bm.bucket_incarnation_sidecar = true;
|
||||
// The caller holds the full bucket creation fence (lifecycle, metadata
|
||||
@@ -2384,7 +2234,6 @@ impl BucketMetadataSys {
|
||||
bucket: &str,
|
||||
namespace_guard: &rustfs_lock::NamespaceLockGuard,
|
||||
) -> Result<()> {
|
||||
self.revoke_pending_bucket_creation(bucket).await;
|
||||
let expected = self.metadata_map.read().await.get(bucket).cloned();
|
||||
if !self
|
||||
.bucket_exists(bucket, namespace_guard, "peer bucket metadata existence check")
|
||||
@@ -2441,7 +2290,6 @@ impl BucketMetadataSys {
|
||||
#[cfg(test)]
|
||||
self.lazy_disk_loads.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
|
||||
|
||||
self.revoke_pending_bucket_creation(bucket).await;
|
||||
let lock = self.object_store().new_ns_lock(bucket, bucket).await?;
|
||||
let guard = lock.get_read_lock(crate::set_disk::get_lock_acquire_timeout()).await?;
|
||||
#[cfg(test)]
|
||||
@@ -2750,7 +2598,6 @@ impl BucketMetadataSys {
|
||||
/// revalidated at write quorum, so a stale snapshot can neither revert an
|
||||
/// acknowledged configuration update nor outlive a delete/recreate.
|
||||
async fn migrate_bucket_creation_commit(&self, bucket: &str) -> Result<BucketMetadataAuthority> {
|
||||
self.revoke_pending_bucket_creation(bucket).await;
|
||||
let transaction_lock = self
|
||||
.object_store()
|
||||
.new_ns_lock(RUSTFS_META_BUCKET, &bucket_metadata_transaction_lock_key(bucket))
|
||||
@@ -2828,7 +2675,6 @@ impl BucketMetadataSys {
|
||||
&self,
|
||||
bucket: &str,
|
||||
) -> Result<BucketMetadataAuthority> {
|
||||
self.revoke_pending_bucket_creation(bucket).await;
|
||||
#[cfg(test)]
|
||||
if self.object_lock_disk_read_errors.write().await.remove(bucket) {
|
||||
return Err(Error::other(format!("injected Object Lock metadata disk read failure: {bucket}")));
|
||||
@@ -3106,27 +2952,6 @@ impl BucketMetadataSys {
|
||||
}
|
||||
}
|
||||
|
||||
async fn cached_quota_config_and_incarnation(&self, bucket: &str) -> Result<Option<CachedQuotaMetadataSnapshot>> {
|
||||
let metadata = {
|
||||
let metadata_map = self.metadata_map.read().await;
|
||||
metadata_map.get(bucket).cloned()
|
||||
};
|
||||
let Some(metadata) = metadata else {
|
||||
return Ok(None);
|
||||
};
|
||||
if !metadata.bucket_incarnation_sidecar || metadata.bucket_incarnation_id.is_nil() {
|
||||
return Ok(None);
|
||||
}
|
||||
if !metadata.quota_config_json.is_empty() && metadata.quota_config.is_none() {
|
||||
return Err(Error::other("persisted bucket quota configuration is invalid"));
|
||||
}
|
||||
Ok(Some(CachedQuotaMetadataSnapshot {
|
||||
quota: metadata.quota_config.clone(),
|
||||
bucket_incarnation: metadata.bucket_incarnation_id,
|
||||
quota_revision: metadata.quota_config_updated_at,
|
||||
}))
|
||||
}
|
||||
|
||||
pub async fn get_replication_config(&self, bucket: &str) -> Result<(ReplicationConfiguration, OffsetDateTime)> {
|
||||
let (bm, _) = self.get_config(bucket).await?;
|
||||
|
||||
@@ -3221,7 +3046,6 @@ mod tests {
|
||||
};
|
||||
use crate::bucket::target::{BucketTarget, BucketTargetType, Credentials};
|
||||
use crate::config::com::read_config;
|
||||
use crate::disk::{DiskAPI as _, RUSTFS_META_TMP_BUCKET};
|
||||
use crate::storage_api_contracts::bucket::{BucketOperations as _, DeleteBucketOptions, MakeBucketOptions};
|
||||
use byteorder::{ByteOrder as _, LittleEndian};
|
||||
use serial_test::serial;
|
||||
@@ -3276,180 +3100,6 @@ mod tests {
|
||||
),
|
||||
];
|
||||
|
||||
#[tokio::test]
|
||||
#[serial(storage_class_env)]
|
||||
async fn persistence_entry_failures_revoke_pending_creation_before_cache_publish() {
|
||||
let (dirs, store) = isolated_store_over_temp_disks().await;
|
||||
init_bucket_metadata_sys(store.clone(), Vec::new()).await;
|
||||
let sys = bucket_metadata_sys_of(&store.ctx).expect("instance metadata system");
|
||||
let sys = sys.read().await.clone();
|
||||
let options = MakeBucketOptions {
|
||||
lock_enabled: true,
|
||||
..Default::default()
|
||||
};
|
||||
for entry in ["save", "persist", "persist-new", "commit"] {
|
||||
let bucket = format!("revoke-{entry}-{}", Uuid::new_v4());
|
||||
store.fail_next_bucket_creation_after_intent_for_test(&bucket);
|
||||
store
|
||||
.make_bucket(&bucket, &options)
|
||||
.await
|
||||
.expect_err("stop the real producer before physical publication");
|
||||
sys.pending_bucket_creation(&bucket)
|
||||
.await
|
||||
.expect("the producer must leave a real live creation permission");
|
||||
let (intent, persisted) = get_config_from_disk_with_presence_in(&store.ctx, &bucket)
|
||||
.await
|
||||
.expect("read the original producer intent");
|
||||
assert!(persisted, "{entry}: the complete original intent must be persisted");
|
||||
let original_intent = intent.marshal_msg().expect("encode the original intent");
|
||||
|
||||
// Keep the creation fence order used by the real producer.
|
||||
let lifecycle_guard = store
|
||||
.acquire_bucket_lifecycle_write_lock(&bucket)
|
||||
.await
|
||||
.expect("hold the bucket lifecycle fence");
|
||||
let transaction_guard = acquire_bucket_metadata_transaction_lock_in(&store.ctx, &bucket)
|
||||
.await
|
||||
.expect("hold the metadata transaction fence");
|
||||
let namespace_lock = store
|
||||
.new_ns_lock(&bucket, &bucket)
|
||||
.await
|
||||
.expect("create the exact bucket namespace lock");
|
||||
let namespace_guard = namespace_lock
|
||||
.get_write_lock(crate::set_disk::get_lock_acquire_timeout())
|
||||
.await
|
||||
.expect("hold the exact bucket namespace fence");
|
||||
|
||||
// A file at each native staging root causes actual IO to fail before
|
||||
// metadata can reach the cache-publishing set call. Preserve the
|
||||
// original staging directories so no fixture data is discarded.
|
||||
for dir in &dirs {
|
||||
let staging = dir.path().join(RUSTFS_META_TMP_BUCKET);
|
||||
let saved = dir.path().join(".rustfs.sys/revocation-saved-tmp");
|
||||
std::fs::rename(&staging, &saved).expect("preserve the native staging directory");
|
||||
std::fs::write(&staging, b"block metadata staging with a non-directory")
|
||||
.expect("install an actual non-directory IO obstruction");
|
||||
}
|
||||
let result = match entry {
|
||||
"save" => sys.save(intent).await,
|
||||
"persist" => sys.persist_and_set(intent).await,
|
||||
"persist-new" => sys.persist_new_and_set(intent).await,
|
||||
"commit" => sys.commit_bucket_metadata(intent).await,
|
||||
_ => unreachable!(),
|
||||
};
|
||||
for dir in &dirs {
|
||||
let staging = dir.path().join(RUSTFS_META_TMP_BUCKET);
|
||||
let saved = dir.path().join(".rustfs.sys/revocation-saved-tmp");
|
||||
std::fs::remove_file(&staging).expect("remove only the fixture's staging obstruction");
|
||||
std::fs::rename(&saved, &staging).expect("restore the complete original staging directory");
|
||||
}
|
||||
drop((namespace_guard, transaction_guard, lifecycle_guard));
|
||||
result.expect_err("native persistence must fail before its downstream cache set");
|
||||
assert!(
|
||||
sys.pending_bucket_creation(&bucket).await.is_none(),
|
||||
"{entry}: the entry revoker must retire live permission even when persistence fails"
|
||||
);
|
||||
let (after_failure, present) = get_config_from_disk_with_presence_in(&store.ctx, &bucket)
|
||||
.await
|
||||
.expect("read the intent after the failed persistence entry");
|
||||
assert!(present, "{entry}: a failed persistence entry must retain the original metadata");
|
||||
assert_eq!(
|
||||
after_failure
|
||||
.marshal_msg()
|
||||
.expect("encode the original intent after persistence failure"),
|
||||
original_intent,
|
||||
"{entry}: native IO failure must not change the original generation or complete intent"
|
||||
);
|
||||
let error = store
|
||||
.make_bucket(&bucket, &options)
|
||||
.await
|
||||
.expect_err("a failed ordinary persistence entry cannot preserve creation permission");
|
||||
assert!(error.to_string().contains("administrator recovery"), "{entry}: {error}");
|
||||
let (after_retry, _) = get_config_from_disk_with_presence_in(&store.ctx, &bucket)
|
||||
.await
|
||||
.expect("read the original intent after the rejected retry");
|
||||
assert_eq!(
|
||||
after_retry.marshal_msg().expect("encode the intent after the rejected retry"),
|
||||
original_intent,
|
||||
"{entry}: the rejected retry must preserve the complete original intent"
|
||||
);
|
||||
for disk in store.pools[0].disk_set[0].disks.read().await.iter() {
|
||||
assert!(
|
||||
matches!(
|
||||
disk.as_ref().expect("native disk").stat_volume(&bucket).await,
|
||||
Err(crate::disk::error::DiskError::VolumeNotFound)
|
||||
),
|
||||
"{entry}: failed persistence and the rejected retry must not publish a physical volume"
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[serial(storage_class_env)]
|
||||
async fn metadata_reset_revokes_real_pending_creation_without_changing_persisted_intent() {
|
||||
let (_dirs, store) = isolated_store_over_temp_disks().await;
|
||||
init_bucket_metadata_sys(store.clone(), Vec::new()).await;
|
||||
let bucket = format!("revoke-reset-{}", Uuid::new_v4());
|
||||
let options = MakeBucketOptions {
|
||||
lock_enabled: true,
|
||||
..Default::default()
|
||||
};
|
||||
store.fail_next_bucket_creation_after_intent_for_test(&bucket);
|
||||
store
|
||||
.make_bucket(&bucket, &options)
|
||||
.await
|
||||
.expect_err("stop the real producer before physical publication");
|
||||
let sys = bucket_metadata_sys_of(&store.ctx).expect("instance metadata system");
|
||||
let mut sys = sys.read().await.clone();
|
||||
sys.pending_bucket_creation(&bucket)
|
||||
.await
|
||||
.expect("the real producer must leave live creation permission before reset");
|
||||
let (intent, persisted) = get_config_from_disk_with_presence_in(&store.ctx, &bucket)
|
||||
.await
|
||||
.expect("read the original intent before cache reset");
|
||||
assert!(persisted, "cache reset starts from a complete real persisted intent");
|
||||
let original_intent = intent.marshal_msg().expect("encode the original reset intent");
|
||||
sys._reset().await;
|
||||
assert!(
|
||||
sys.pending_bucket_creation(&bucket).await.is_none(),
|
||||
"reset must revoke the producer-issued permission shared with the instance metadata system"
|
||||
);
|
||||
let (after_reset, present) = get_config_from_disk_with_presence_in(&store.ctx, &bucket)
|
||||
.await
|
||||
.expect("read the original intent after cache reset");
|
||||
assert!(present, "cache reset must retain the persisted intent");
|
||||
assert_eq!(
|
||||
after_reset.marshal_msg().expect("encode the intent after cache reset"),
|
||||
original_intent,
|
||||
"cache reset must leave the original generation and complete persisted intent unchanged"
|
||||
);
|
||||
let error = store
|
||||
.make_bucket(&bucket, &options)
|
||||
.await
|
||||
.expect_err("reset cannot regrant the producer's old creation permission");
|
||||
assert!(error.to_string().contains("administrator recovery"), "{error}");
|
||||
let (after_retry, _) = get_config_from_disk_with_presence_in(&store.ctx, &bucket)
|
||||
.await
|
||||
.expect("read the intent after the reset-induced retry rejection");
|
||||
assert_eq!(
|
||||
after_retry
|
||||
.marshal_msg()
|
||||
.expect("encode the intent after the rejected reset retry"),
|
||||
original_intent,
|
||||
"the reset-induced rejection must preserve the original complete intent"
|
||||
);
|
||||
for disk in store.pools[0].disk_set[0].disks.read().await.iter() {
|
||||
assert!(
|
||||
matches!(
|
||||
disk.as_ref().expect("native disk").stat_volume(&bucket).await,
|
||||
Err(crate::disk::error::DiskError::VolumeNotFound)
|
||||
),
|
||||
"cache reset and the rejected retry must not publish a physical volume"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn g_d3_003_new_writer_replication_loads_without_fail_closed_state() {
|
||||
let (dirs, store) = isolated_store_over_temp_disks().await;
|
||||
@@ -5206,154 +4856,6 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[serial]
|
||||
async fn quota_admission_rejects_stale_cached_no_quota() {
|
||||
let (_dirs, store) = isolated_store_over_temp_disks().await;
|
||||
init_bucket_metadata_sys(store.clone(), Vec::new()).await;
|
||||
let sys = bucket_metadata_sys_of(&store.ctx).expect("scoped metadata system");
|
||||
let bucket = "stale-no-quota-admission";
|
||||
store
|
||||
.make_bucket(bucket, &MakeBucketOptions::default())
|
||||
.await
|
||||
.expect("create bucket");
|
||||
let (stale, _) = sys.read().await.get_config(bucket).await.expect("cache initial metadata");
|
||||
store
|
||||
.update_bucket_metadata_config(bucket, "quota.json", br#"{"quota":1}"#.to_vec())
|
||||
.await
|
||||
.expect("publish quota to authoritative storage");
|
||||
// Model a peer that has not received the newer configuration snapshot.
|
||||
sys.read().await.set(bucket.to_owned(), stale).await;
|
||||
assert!(
|
||||
get_cached_quota_config_and_incarnation_in(&store.ctx, bucket)
|
||||
.await
|
||||
.expect("read stale cache")
|
||||
.expect("cached bucket identity")
|
||||
.quota
|
||||
.is_none()
|
||||
);
|
||||
|
||||
temp_env::async_with_vars([("RUSTFS_QUOTA_BEGIN_SAFE_NO_QUOTA_CACHE_FAST_PATH", Some("true"))], async {
|
||||
let error = crate::bucket::quota::reservation::begin(&store.ctx, bucket, "object", &ObjectOptions::default(), 0, 0)
|
||||
.await
|
||||
.err()
|
||||
.expect("persisted quota must reject admission without its snapshot");
|
||||
assert!(matches!(error, Error::PartMissingOrCorrupt), "{error:?}");
|
||||
})
|
||||
.await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[serial]
|
||||
async fn peer_reload_clears_negative_cache_after_remote_bucket_creation() {
|
||||
let (dirs, node_a, node_b) = two_nodes_over_one_store().await;
|
||||
let bucket = "cross-node-negative-cache-refresh";
|
||||
let node_b_sys = node_b.read().await.clone();
|
||||
|
||||
assert_eq!(
|
||||
node_b_sys.get_bucket_incarnation_id(bucket).await.unwrap_err(),
|
||||
Error::BucketNotFound(bucket.to_string()),
|
||||
"the probe must populate node B's missing-bucket cache"
|
||||
);
|
||||
|
||||
for dir in &dirs {
|
||||
std::fs::create_dir_all(dir.path().join(bucket)).expect("physical bucket should exist before creation metadata");
|
||||
}
|
||||
let created = BucketMetadata::new(bucket);
|
||||
let created_incarnation = created.bucket_incarnation_id;
|
||||
node_a
|
||||
.read()
|
||||
.await
|
||||
.persist_new_and_set(created)
|
||||
.await
|
||||
.expect("node A should publish the created bucket metadata");
|
||||
|
||||
node_b_sys
|
||||
.reload_from_store(bucket)
|
||||
.await
|
||||
.expect("peer reload should clear the stale negative cache");
|
||||
assert_eq!(
|
||||
node_b_sys.get_bucket_incarnation_id(bucket).await.unwrap(),
|
||||
created_incarnation,
|
||||
"node B should resolve the newly created bucket immediately"
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
|
||||
#[serial]
|
||||
async fn peer_delete_clears_metadata_for_absent_bucket() {
|
||||
let (_dirs, store) = isolated_store_over_temp_disks().await;
|
||||
init_bucket_metadata_sys(store.clone(), Vec::new()).await;
|
||||
let sys = bucket_metadata_sys_of(&store.ctx).expect("metadata owner");
|
||||
let bucket = "peer-delete-absent-bucket";
|
||||
|
||||
store
|
||||
.make_bucket(bucket, &MakeBucketOptions::default())
|
||||
.await
|
||||
.expect("initial bucket creation");
|
||||
let cached = sys.read().await.get(bucket).await.expect("initial cached metadata");
|
||||
store
|
||||
.delete_bucket(bucket, &DeleteBucketOptions::default())
|
||||
.await
|
||||
.expect("bucket deletion");
|
||||
|
||||
// Model a peer that still caches the metadata after the physical delete.
|
||||
sys.read().await.set(bucket.to_string(), cached).await;
|
||||
assert!(
|
||||
remove_bucket_metadata_if_absent(store.clone(), bucket)
|
||||
.await
|
||||
.expect("conditional peer delete"),
|
||||
"the peer must evict the deleted bucket's cached metadata"
|
||||
);
|
||||
let sys = sys.read().await;
|
||||
assert!(matches!(sys.get(bucket).await, Err(Error::ConfigNotFound)));
|
||||
assert_eq!(
|
||||
sys.get_bucket_incarnation_id(bucket)
|
||||
.await
|
||||
.expect_err("deleted bucket lookup"),
|
||||
Error::BucketNotFound(bucket.to_string()),
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
|
||||
#[serial]
|
||||
async fn delayed_peer_delete_preserves_recreated_bucket_metadata() {
|
||||
let (_dirs, store) = isolated_store_over_temp_disks().await;
|
||||
init_bucket_metadata_sys(store.clone(), Vec::new()).await;
|
||||
let sys = bucket_metadata_sys_of(&store.ctx).expect("metadata owner");
|
||||
let bucket = "delayed-peer-delete-recreated-bucket";
|
||||
|
||||
store
|
||||
.make_bucket(bucket, &MakeBucketOptions::default())
|
||||
.await
|
||||
.expect("initial bucket creation");
|
||||
let old_incarnation = store.bucket_incarnation_id_from_disk(bucket).await.expect("old incarnation");
|
||||
store
|
||||
.delete_bucket(bucket, &DeleteBucketOptions::default())
|
||||
.await
|
||||
.expect("bucket deletion");
|
||||
store
|
||||
.make_bucket(bucket, &MakeBucketOptions::default())
|
||||
.await
|
||||
.expect("bucket recreation");
|
||||
let new_incarnation = store.bucket_incarnation_id_from_disk(bucket).await.expect("new incarnation");
|
||||
assert_ne!(old_incarnation, new_incarnation);
|
||||
|
||||
let removed = remove_bucket_metadata_if_absent(store.clone(), bucket)
|
||||
.await
|
||||
.expect("conditional peer delete");
|
||||
assert!(!removed, "a delayed delete must not remove metadata for a live recreated bucket");
|
||||
assert_eq!(
|
||||
sys.read()
|
||||
.await
|
||||
.get(bucket)
|
||||
.await
|
||||
.expect("recreated metadata should remain cached")
|
||||
.bucket_incarnation_id,
|
||||
new_incarnation,
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
|
||||
#[serial]
|
||||
async fn stale_config_request_cannot_mutate_a_recreated_bucket() {
|
||||
|
||||
@@ -273,30 +273,6 @@ where
|
||||
|
||||
let buckets: Vec<String> = buckets_list.into_iter().map(|b| b.name).collect();
|
||||
|
||||
try_migrate_bucket_metadata_for_buckets(store, &buckets).await
|
||||
}
|
||||
|
||||
/// Migrate the already discovered startup candidates without repeating a
|
||||
/// majority-only namespace listing. Every migration write retains its quorum.
|
||||
pub async fn try_migrate_bucket_metadata_for_buckets<S>(store: Arc<S>, buckets: &[String]) -> Result<()>
|
||||
where
|
||||
S: ObjectIO<
|
||||
Error = Error,
|
||||
RangeSpec = HTTPRangeSpec,
|
||||
HeaderMap = HeaderMap,
|
||||
ObjectOptions = ObjectOptions,
|
||||
ObjectInfo = ObjectInfo,
|
||||
GetObjectReader = GetObjectReader,
|
||||
PutObjectReader = PutObjReader,
|
||||
> + ObjectOperations<
|
||||
Error = Error,
|
||||
ObjectInfo = ObjectInfo,
|
||||
ObjectOptions = ObjectOptions,
|
||||
FileInfo = FileInfo,
|
||||
ObjectToDelete = ObjectToDelete,
|
||||
DeletedObject = DeletedObject,
|
||||
>,
|
||||
{
|
||||
if buckets.is_empty() {
|
||||
debug!("No migrating bucket metadata found");
|
||||
return Ok(());
|
||||
|
||||
@@ -850,11 +850,6 @@ pub(crate) async fn begin(
|
||||
let snapshot_admission = opts.quota_admission;
|
||||
let data_movement = opts.data_movement;
|
||||
if crate::bucket::utils::is_meta_bucketname(bucket) {
|
||||
let meta_bucket_fast_path_started = rustfs_io_metrics::put_stage_timer();
|
||||
rustfs_io_metrics::record_put_object_stage_duration_from(
|
||||
rustfs_io_metrics::PUT_STAGE_PUT_OBJECT_QUOTA_BEGIN_META_BUCKET_FAST_PATH,
|
||||
meta_bucket_fast_path_started,
|
||||
);
|
||||
return Ok(QuotaContext {
|
||||
store: None,
|
||||
bucket: bucket.to_string(),
|
||||
@@ -911,63 +906,9 @@ pub(crate) async fn begin(
|
||||
});
|
||||
}
|
||||
|
||||
let metadata_lock_started = rustfs_io_metrics::put_stage_timer();
|
||||
let metadata_guard = metadata_sys::acquire_bucket_metadata_transaction_read_lock_for_options_in(ctx, bucket, opts).await?;
|
||||
rustfs_io_metrics::record_put_object_stage_duration_from(
|
||||
rustfs_io_metrics::PUT_STAGE_PUT_OBJECT_QUOTA_BEGIN_METADATA_LOCK,
|
||||
metadata_lock_started,
|
||||
);
|
||||
let cache_lookup_started = rustfs_io_metrics::put_stage_timer();
|
||||
let cached_quota_snapshot = if rustfs_io_metrics::put_stage_metrics_enabled() {
|
||||
match metadata_sys::get_cached_quota_config_and_incarnation_in(ctx, bucket).await {
|
||||
Ok(Some(snapshot)) => {
|
||||
rustfs_io_metrics::record_put_object_quota_cache_decision(
|
||||
"candidate",
|
||||
quota_cache_reason(snapshot.quota.as_ref()),
|
||||
);
|
||||
Some(snapshot)
|
||||
}
|
||||
Ok(None) => {
|
||||
rustfs_io_metrics::record_put_object_quota_cache_decision("miss", "no_authoritative_cache");
|
||||
None
|
||||
}
|
||||
Err(_) => {
|
||||
rustfs_io_metrics::record_put_object_quota_cache_decision("miss", "invalid_cached_quota");
|
||||
None
|
||||
}
|
||||
}
|
||||
} else {
|
||||
None
|
||||
};
|
||||
rustfs_io_metrics::record_put_object_stage_duration_from(
|
||||
rustfs_io_metrics::PUT_STAGE_PUT_OBJECT_QUOTA_BEGIN_CACHE_LOOKUP,
|
||||
cache_lookup_started,
|
||||
);
|
||||
let config_read_started = rustfs_io_metrics::put_stage_timer();
|
||||
let (quota, bucket_incarnation, quota_revision) =
|
||||
metadata_sys::get_quota_config_and_incarnation_from_disk_for_options_in(ctx, bucket, opts, &metadata_guard).await?;
|
||||
if let Some(cached) = cached_quota_snapshot.as_ref() {
|
||||
let reason = quota_cache_reason(quota.as_ref());
|
||||
if cached.quota == quota && cached.bucket_incarnation == bucket_incarnation && cached.quota_revision == quota_revision {
|
||||
rustfs_io_metrics::record_put_object_quota_cache_decision("authoritative_match", reason);
|
||||
} else {
|
||||
rustfs_io_metrics::record_put_object_quota_cache_decision("authoritative_mismatch", reason);
|
||||
if cached.quota != quota {
|
||||
rustfs_io_metrics::record_put_object_quota_cache_decision("authoritative_mismatch_field", "quota");
|
||||
}
|
||||
if cached.bucket_incarnation != bucket_incarnation {
|
||||
rustfs_io_metrics::record_put_object_quota_cache_decision("authoritative_mismatch_field", "bucket_incarnation");
|
||||
}
|
||||
if cached.quota_revision != quota_revision {
|
||||
rustfs_io_metrics::record_put_object_quota_cache_decision("authoritative_mismatch_field", "quota_revision");
|
||||
}
|
||||
}
|
||||
}
|
||||
rustfs_io_metrics::record_put_object_stage_duration_from(
|
||||
rustfs_io_metrics::PUT_STAGE_PUT_OBJECT_QUOTA_BEGIN_CONFIG_READ,
|
||||
config_read_started,
|
||||
);
|
||||
let lock_lost_check_started = rustfs_io_metrics::put_stage_timer();
|
||||
if metadata_guard.is_lock_lost() {
|
||||
return Err(StorageError::NamespaceLockQuorumUnavailable {
|
||||
mode: "quota_config",
|
||||
@@ -977,11 +918,6 @@ pub(crate) async fn begin(
|
||||
achieved: 0,
|
||||
});
|
||||
}
|
||||
rustfs_io_metrics::record_put_object_stage_duration_from(
|
||||
rustfs_io_metrics::PUT_STAGE_PUT_OBJECT_QUOTA_BEGIN_LOCK_LOST_CHECK,
|
||||
lock_lost_check_started,
|
||||
);
|
||||
let policy_evaluate_started = rustfs_io_metrics::put_stage_timer();
|
||||
if quota
|
||||
.as_ref()
|
||||
.is_some_and(|quota| quota.has_unsupported_reservation_protocol())
|
||||
@@ -990,11 +926,6 @@ pub(crate) async fn begin(
|
||||
return Err(StorageError::PartMissingOrCorrupt);
|
||||
}
|
||||
let durable_quota = quota.as_ref().filter(|quota| quota.uses_durable_reservations());
|
||||
rustfs_io_metrics::record_put_object_stage_duration_from(
|
||||
rustfs_io_metrics::PUT_STAGE_PUT_OBJECT_QUOTA_BEGIN_POLICY_EVALUATE,
|
||||
policy_evaluate_started,
|
||||
);
|
||||
let capability_proof_started = rustfs_io_metrics::put_stage_timer();
|
||||
let capability_proof = if durable_quota.is_some() {
|
||||
Some(
|
||||
crate::services::notification_sys::acquire_cross_pool_fence_fleet_proof()
|
||||
@@ -1003,12 +934,7 @@ pub(crate) async fn begin(
|
||||
} else {
|
||||
None
|
||||
};
|
||||
rustfs_io_metrics::record_put_object_stage_duration_from(
|
||||
rustfs_io_metrics::PUT_STAGE_PUT_OBJECT_QUOTA_BEGIN_CAPABILITY_PROOF,
|
||||
capability_proof_started,
|
||||
);
|
||||
let durable_quota_limit = durable_quota.and_then(|quota| quota.quota);
|
||||
let snapshot_admission_started = rustfs_io_metrics::put_stage_timer();
|
||||
let reservation_protocol = durable_quota.and_then(|quota| quota.reservation_protocol);
|
||||
let snapshot_admission = match quota.as_ref().filter(|quota| !quota.uses_durable_reservations()) {
|
||||
Some(quota) => match (quota.quota, snapshot_admission) {
|
||||
@@ -1028,10 +954,6 @@ pub(crate) async fn begin(
|
||||
},
|
||||
None => None,
|
||||
};
|
||||
rustfs_io_metrics::record_put_object_stage_duration_from(
|
||||
rustfs_io_metrics::PUT_STAGE_PUT_OBJECT_QUOTA_BEGIN_SNAPSHOT_ADMISSION,
|
||||
snapshot_admission_started,
|
||||
);
|
||||
let legacy_data_movement = durable_quota_limit.is_none()
|
||||
&& quota.as_ref().and_then(|quota| quota.quota).is_some()
|
||||
&& snapshot_admission.is_none()
|
||||
@@ -1043,21 +965,11 @@ pub(crate) async fn begin(
|
||||
.then(|| quota.as_ref().and_then(|quota| quota.quota))
|
||||
.flatten()
|
||||
});
|
||||
let object_store_lookup_started = rustfs_io_metrics::put_stage_timer();
|
||||
let store = if durable_quota_limit.is_some() {
|
||||
Some(metadata_sys::object_store_in(ctx).await?)
|
||||
} else {
|
||||
None
|
||||
};
|
||||
rustfs_io_metrics::record_put_object_stage_duration_from(
|
||||
rustfs_io_metrics::PUT_STAGE_PUT_OBJECT_QUOTA_BEGIN_OBJECT_STORE_LOOKUP,
|
||||
object_store_lookup_started,
|
||||
);
|
||||
let context_build_started = rustfs_io_metrics::put_stage_timer();
|
||||
rustfs_io_metrics::record_put_object_stage_duration_from(
|
||||
rustfs_io_metrics::PUT_STAGE_PUT_OBJECT_QUOTA_BEGIN_CONTEXT_BUILD,
|
||||
context_build_started,
|
||||
);
|
||||
Ok(QuotaContext {
|
||||
store,
|
||||
bucket: bucket.to_string(),
|
||||
@@ -1076,15 +988,6 @@ pub(crate) async fn begin(
|
||||
})
|
||||
}
|
||||
|
||||
fn quota_cache_reason(quota: Option<&crate::bucket::quota::BucketQuota>) -> &'static str {
|
||||
match quota {
|
||||
None => "no_quota",
|
||||
Some(quota) if quota.uses_durable_reservations() => "durable_quota",
|
||||
Some(quota) if quota.quota.is_some() => "snapshot_quota",
|
||||
Some(_) => "quota_without_limit",
|
||||
}
|
||||
}
|
||||
|
||||
fn quota_capability_error(bucket: &str, object: &str) -> StorageError {
|
||||
StorageError::NamespaceLockQuorumUnavailable {
|
||||
mode: "quota_capability",
|
||||
|
||||
@@ -448,26 +448,6 @@ fn is_version_id_format_mismatch(err: &SdkError<HeadObjectError>) -> bool {
|
||||
is_version_id_mismatch(code, raw_status)
|
||||
}
|
||||
|
||||
/// A version-addressed HEAD rejected because the target cannot address the
|
||||
/// source version id (AWS S3: bodiless 400). Narrower than
|
||||
/// [`is_version_id_format_mismatch`]: a bodiless 403 may be a genuine
|
||||
/// `s3:GetObjectVersion` denial, so it is not accepted where a mutation or a
|
||||
/// completion verdict follows instead of another non-destructive HEAD.
|
||||
fn rejects_source_version_id(err: &SdkError<HeadObjectError>) -> bool {
|
||||
is_version_id_format_mismatch(err) && !has_raw_status(err, 403)
|
||||
}
|
||||
|
||||
/// Whether the target's latest version of `object` is a delete marker. For
|
||||
/// targets that mint their own version ids, which cannot be asked about the
|
||||
/// source marker id: S3 answers a versionless HEAD on such a key with 404
|
||||
/// (405 on some targets) plus `x-amz-delete-marker: true`.
|
||||
async fn latest_target_version_is_delete_marker(tgt_client: &TargetClient, object: &str) -> bool {
|
||||
match head_object_for_worker(tgt_client, &tgt_client.bucket, object, None).await {
|
||||
Ok(head) => head.delete_marker == Some(true),
|
||||
Err(e) => raw_header_value(e.as_ref(), "x-amz-delete-marker").as_deref() == Some("true"),
|
||||
}
|
||||
}
|
||||
|
||||
async fn mark_replication_target_offline_if_needed(target_client: &Arc<TargetClient>, err: &(impl Display + ?Sized)) {
|
||||
if is_replication_target_offline_error(err) {
|
||||
ReplicationTargetStore::mark_target_offline(target_client).await;
|
||||
@@ -1866,17 +1846,7 @@ async fn verify_resync_head_result(
|
||||
// only absence proves completion. All other outcomes remain
|
||||
// failed (backlog#862 / #799 B13).
|
||||
let retryable = if roi.version_purge_status.is_empty() {
|
||||
match classify_delete_marker_head_error(&err) {
|
||||
// A target that mints its own version ids never holds the
|
||||
// source marker id; verify the marker on the latest version.
|
||||
DeleteMarkerHeadOutcome::Ambiguous => {
|
||||
let mints_own = rejects_source_version_id(&err)
|
||||
|| ReplicationTargetStore::version_identity_capability(&target_client.arn)
|
||||
.version_addressing_unreliable();
|
||||
!(mints_own && latest_target_version_is_delete_marker(target_client, &roi.name).await)
|
||||
}
|
||||
DeleteMarkerHeadOutcome::Exists | DeleteMarkerHeadOutcome::Missing => false,
|
||||
}
|
||||
matches!(classify_delete_marker_head_error(&err), DeleteMarkerHeadOutcome::Ambiguous)
|
||||
} else {
|
||||
!matches!(classify_delete_marker_head_error(&err), DeleteMarkerHeadOutcome::Missing)
|
||||
};
|
||||
@@ -3597,16 +3567,7 @@ async fn replicate_delete_to_target(
|
||||
}
|
||||
}
|
||||
|
||||
// A target that mints its own version ids never holds the source marker
|
||||
// id, so a version-addressed pre-check cannot succeed there; the marker
|
||||
// is created by the versionless DELETE below.
|
||||
let version_addressable =
|
||||
!ReplicationTargetStore::version_identity_capability(&tgt_client.arn).version_addressing_unreliable();
|
||||
if version_addressable
|
||||
&& !is_version_purge
|
||||
&& dobj.delete_object.delete_marker
|
||||
&& dobj.delete_object.delete_marker_version_id.is_some()
|
||||
{
|
||||
if !is_version_purge && dobj.delete_object.delete_marker && dobj.delete_object.delete_marker_version_id.is_some() {
|
||||
match head_object_for_worker(
|
||||
tgt_client.as_ref(),
|
||||
&tgt_client.bucket,
|
||||
@@ -3615,11 +3576,6 @@ async fn replicate_delete_to_target(
|
||||
)
|
||||
.await
|
||||
{
|
||||
// The verdict is not known yet (e.g. no PUT since restart) and the
|
||||
// target rejected the source id: learn it as the PUT path does.
|
||||
Err(e) if rejects_source_version_id(e.as_ref()) => {
|
||||
ReplicationTargetStore::record_version_identity_capability(&tgt_client.arn, VersionIdentityCapability::MintsOwn);
|
||||
}
|
||||
Ok(head) if head.delete_marker == Some(true) => {
|
||||
// Some targets expose an existing marker as a successful HEAD
|
||||
// with the marker bit instead of the usual 405. Treat that as
|
||||
@@ -6719,93 +6675,6 @@ mod tests {
|
||||
assert!(seen[0].starts_with("HEAD "), "{seen:?}");
|
||||
}
|
||||
|
||||
/// AWS S3 answers a HEAD for a version id it did not mint with a bodiless
|
||||
/// 400. On a target with no verdict yet, that teaches `MintsOwn` and the
|
||||
/// marker is still created with one versionless DELETE.
|
||||
#[tokio::test]
|
||||
async fn live_delete_marker_worker_learns_mints_own_from_bodiless_400() {
|
||||
let (endpoint, server) = spawn_scripted_target_server(2, |line| {
|
||||
if line.starts_with("HEAD ") {
|
||||
empty_response("400 Bad Request")
|
||||
} else if line.starts_with("DELETE ") {
|
||||
empty_response("204 No Content")
|
||||
} else {
|
||||
empty_response("500 Unexpected")
|
||||
}
|
||||
});
|
||||
let target = test_target_client(endpoint);
|
||||
register_test_target(&target).await;
|
||||
let dobj = marker_creation_dobj(&target.arn);
|
||||
|
||||
let rinfo = replicate_delete_to_target(&dobj, target.clone(), None).await;
|
||||
|
||||
assert_eq!(rinfo.replication_status, ReplicationStatusType::Completed, "{rinfo:?}");
|
||||
assert_eq!(
|
||||
ReplicationTargetStore::version_identity_capability(&target.arn),
|
||||
VersionIdentityCapability::MintsOwn
|
||||
);
|
||||
let seen = server.join().expect("test HTTP server should finish");
|
||||
assert_eq!(seen.len(), 2, "{seen:?}");
|
||||
assert!(seen[0].starts_with("HEAD "), "{seen:?}");
|
||||
assert!(seen[1].starts_with("DELETE "), "{seen:?}");
|
||||
assert!(!seen[1].contains("versionId="), "marker creation must remain versionless: {seen:?}");
|
||||
}
|
||||
|
||||
/// A bodiless 403 on the version-addressed HEAD may be a genuine
|
||||
/// GetObjectVersion denial on an id-adopting target. It must fail closed:
|
||||
/// no DELETE, and no `MintsOwn` verdict cached for the ARN.
|
||||
#[tokio::test]
|
||||
async fn live_delete_marker_worker_keeps_bodiless_403_failure_closed() {
|
||||
let (endpoint, server) = spawn_scripted_target_server(1, |line| {
|
||||
if line.starts_with("HEAD ") {
|
||||
empty_response("403 Forbidden")
|
||||
} else if line.starts_with("DELETE ") {
|
||||
empty_response("204 No Content")
|
||||
} else {
|
||||
empty_response("500 Unexpected")
|
||||
}
|
||||
});
|
||||
let target = test_target_client(endpoint);
|
||||
register_test_target(&target).await;
|
||||
let dobj = marker_creation_dobj(&target.arn);
|
||||
|
||||
let rinfo = replicate_delete_to_target(&dobj, target.clone(), None).await;
|
||||
|
||||
assert_eq!(rinfo.replication_status, ReplicationStatusType::Failed, "{rinfo:?}");
|
||||
assert_ne!(
|
||||
ReplicationTargetStore::version_identity_capability(&target.arn),
|
||||
VersionIdentityCapability::MintsOwn
|
||||
);
|
||||
let seen = server.join().expect("test HTTP server should finish");
|
||||
assert_eq!(seen.len(), 1, "a denied HEAD must not trigger DELETE: {seen:?}");
|
||||
assert!(seen[0].starts_with("HEAD "), "{seen:?}");
|
||||
}
|
||||
|
||||
/// A target already known to mint its own version ids is never asked for
|
||||
/// the source marker id: the marker is created by the versionless DELETE.
|
||||
#[tokio::test]
|
||||
async fn live_delete_marker_worker_skips_version_head_on_mints_own_target() {
|
||||
let (endpoint, server) = spawn_scripted_target_server(1, |line| {
|
||||
if line.starts_with("DELETE ") {
|
||||
empty_response("204 No Content")
|
||||
} else {
|
||||
empty_response("500 Unexpected")
|
||||
}
|
||||
});
|
||||
let target = test_target_client(endpoint);
|
||||
register_test_target(&target).await;
|
||||
ReplicationTargetStore::record_version_identity_capability(&target.arn, VersionIdentityCapability::MintsOwn);
|
||||
let dobj = marker_creation_dobj(&target.arn);
|
||||
|
||||
let rinfo = replicate_delete_to_target(&dobj, target.clone(), None).await;
|
||||
|
||||
assert_eq!(rinfo.replication_status, ReplicationStatusType::Completed, "{rinfo:?}");
|
||||
let seen = server.join().expect("test HTTP server should finish");
|
||||
assert_eq!(seen.len(), 1, "no version-addressed HEAD on a MintsOwn target: {seen:?}");
|
||||
assert!(seen[0].starts_with("DELETE "), "{seen:?}");
|
||||
assert!(!seen[0].contains("versionId="), "marker creation must remain versionless: {seen:?}");
|
||||
}
|
||||
|
||||
/// A target answers `HEAD ?versionId=<delete marker>` with a bodiless
|
||||
/// 405, so the SDK reports no error code. That is the marker having
|
||||
/// propagated, not a failure (rustfs/backlog#2479).
|
||||
@@ -6896,76 +6765,6 @@ mod tests {
|
||||
server.join().expect("test HTTP server should finish");
|
||||
}
|
||||
|
||||
/// AWS answers `HEAD ?versionId=<source marker id>` with a bodiless 400.
|
||||
/// The marker is verified through the latest version instead: a
|
||||
/// versionless 404 with `x-amz-delete-marker: true` proves it propagated.
|
||||
#[tokio::test]
|
||||
async fn resync_verification_accepts_latest_delete_marker_when_target_rejects_source_id() {
|
||||
let (endpoint, server) = spawn_scripted_target_server(2, |line| {
|
||||
if line.contains("versionId=") {
|
||||
empty_response("400 Bad Request")
|
||||
} else {
|
||||
"HTTP/1.1 404 Not Found\r\nX-Amz-Delete-Marker: true\r\nX-Amz-Version-Id: target-marker\r\nContent-Length: 0\r\nConnection: close\r\n\r\n"
|
||||
.to_string()
|
||||
}
|
||||
});
|
||||
let target = test_target_client(endpoint);
|
||||
let roi = delete_marker_roi();
|
||||
let mut st = TargetReplicationResyncStatus::default();
|
||||
|
||||
let head_result =
|
||||
head_object_for_worker(target.as_ref(), &target.bucket, &roi.name, roi.version_id.map(|v| v.to_string())).await;
|
||||
let (size, err) = verify_resync_head_result(head_result, &roi, &mut st, &target).await;
|
||||
|
||||
assert!(err.is_none(), "{err:?}");
|
||||
assert_eq!((size, st.replicated_count, st.failed_count), (0, 1, 0));
|
||||
let seen = server.join().expect("test HTTP server should finish");
|
||||
assert!(!seen[1].contains("versionId="), "the re-check must address the latest version: {seen:?}");
|
||||
}
|
||||
|
||||
/// A live latest version on a target that rejects the source id means the
|
||||
/// marker has not propagated: the verification stays failed.
|
||||
#[tokio::test]
|
||||
async fn resync_verification_fails_delete_marker_when_latest_target_version_is_live() {
|
||||
let (endpoint, server) = spawn_scripted_target_server(2, |line| {
|
||||
if line.contains("versionId=") {
|
||||
empty_response("400 Bad Request")
|
||||
} else {
|
||||
empty_response("200 OK")
|
||||
}
|
||||
});
|
||||
let target = test_target_client(endpoint);
|
||||
let roi = delete_marker_roi();
|
||||
let mut st = TargetReplicationResyncStatus::default();
|
||||
|
||||
let head_result =
|
||||
head_object_for_worker(target.as_ref(), &target.bucket, &roi.name, roi.version_id.map(|v| v.to_string())).await;
|
||||
let (size, err) = verify_resync_head_result(head_result, &roi, &mut st, &target).await;
|
||||
|
||||
assert!(err.is_some(), "a live latest version must not verify the marker");
|
||||
assert_eq!((size, st.replicated_count, st.failed_count), (0, 0, 1));
|
||||
server.join().expect("test HTTP server should finish");
|
||||
}
|
||||
|
||||
/// A bodiless 403 may be a genuine permission denial: it is not evidence
|
||||
/// that the target mints its own ids, so no latest-version re-check runs.
|
||||
#[tokio::test]
|
||||
async fn resync_verification_keeps_delete_marker_failed_on_bodiless_403() {
|
||||
let (endpoint, server) = spawn_scripted_target_server(1, |_| empty_response("403 Forbidden"));
|
||||
let target = test_target_client(endpoint);
|
||||
let roi = delete_marker_roi();
|
||||
let mut st = TargetReplicationResyncStatus::default();
|
||||
|
||||
let head_result =
|
||||
head_object_for_worker(target.as_ref(), &target.bucket, &roi.name, roi.version_id.map(|v| v.to_string())).await;
|
||||
let (size, err) = verify_resync_head_result(head_result, &roi, &mut st, &target).await;
|
||||
|
||||
assert!(err.is_some(), "a 403 must not count as a propagated delete marker");
|
||||
assert_eq!((size, st.replicated_count, st.failed_count), (0, 0, 1));
|
||||
let seen = server.join().expect("test HTTP server should finish");
|
||||
assert_eq!(seen.len(), 1, "{seen:?}");
|
||||
}
|
||||
|
||||
/// Serves exactly `requests` connections, answering each from
|
||||
/// `respond(request_line)`, and returns the request lines it saw. Reads
|
||||
/// the whole request (headers plus `Content-Length` body, honoring
|
||||
|
||||
@@ -0,0 +1,806 @@
|
||||
//! Bounded authenticated Raft RPC, mountable without a second storage owner.
|
||||
use super::{client, http_auth};
|
||||
use openraft::{
|
||||
DefensiveError, ErrorSubject, ErrorVerb, RaftNetwork, RaftNetworkFactory, StorageError, StorageIOError, Violation,
|
||||
error::{Fatal, InstallSnapshotError, RPCError, RaftError, RemoteError, Unreachable},
|
||||
network::RPCOption,
|
||||
raft::{
|
||||
AppendEntriesRequest, AppendEntriesResponse, InstallSnapshotRequest, InstallSnapshotResponse, VoteRequest, VoteResponse,
|
||||
},
|
||||
};
|
||||
use rustfs_capture_authority::{CaptureMembership, CaptureNode, CaptureTypeConfig, NativeRaftOwner, NodeIdentity};
|
||||
use rustfs_protos::proto_gen::node_service::{
|
||||
CaptureRaftRequest, CaptureRaftResponse,
|
||||
capture_raft_service_server::{CaptureRaftService, CaptureRaftServiceServer},
|
||||
};
|
||||
use serde::{Deserialize, Serialize, de::DeserializeOwned};
|
||||
use serde_json::value::RawValue;
|
||||
use std::{collections::BTreeMap, io::Write, sync::Arc, time::Duration};
|
||||
use tonic::{Request, Response, Status};
|
||||
|
||||
#[derive(Clone, Copy, Debug)]
|
||||
pub struct CaptureRaftLimits {
|
||||
pub max_request_bytes: usize,
|
||||
pub max_response_bytes: usize,
|
||||
pub max_entries: usize,
|
||||
pub max_snapshot_chunk_bytes: usize,
|
||||
pub max_inflight: usize,
|
||||
pub connect_timeout: Duration,
|
||||
pub request_timeout: Duration,
|
||||
}
|
||||
impl Default for CaptureRaftLimits {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
max_request_bytes: 16 * 1024 * 1024,
|
||||
max_response_bytes: 1024 * 1024,
|
||||
max_entries: 300,
|
||||
max_snapshot_chunk_bytes: 3 * 1024 * 1024,
|
||||
max_inflight: 16,
|
||||
connect_timeout: Duration::from_secs(3),
|
||||
request_timeout: Duration::from_secs(5),
|
||||
}
|
||||
}
|
||||
}
|
||||
impl CaptureRaftLimits {
|
||||
fn validate(&self) -> Result<(), CaptureRaftError> {
|
||||
let chunk = self
|
||||
.max_snapshot_chunk_bytes
|
||||
.checked_mul(4)
|
||||
.and_then(|n| n.checked_add(16384))
|
||||
.ok_or(CaptureRaftError::Limits)?;
|
||||
if self.max_request_bytes < chunk
|
||||
|| self.max_request_bytes > 64 * 1024 * 1024
|
||||
|| self.max_response_bytes < 4096
|
||||
|| self.max_response_bytes > 4 * 1024 * 1024
|
||||
|| self.max_entries == 0
|
||||
|| self.max_entries > 1024
|
||||
|| self.max_snapshot_chunk_bytes == 0
|
||||
|| self.max_inflight == 0
|
||||
|| self.max_inflight > 128
|
||||
|| self.connect_timeout.is_zero()
|
||||
|| self.request_timeout.is_zero()
|
||||
|| self.request_timeout > Duration::from_secs(60)
|
||||
|| self.connect_timeout > Duration::from_secs(60)
|
||||
{
|
||||
return Err(CaptureRaftError::Limits);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
pub enum CaptureRaftError {
|
||||
#[error("capture Raft message limit exceeded")]
|
||||
Limits,
|
||||
#[error("capture Raft request requires a smaller append batch")]
|
||||
RequestTooLarge,
|
||||
#[error("invalid capture Raft message")]
|
||||
Protocol,
|
||||
#[error("capture Raft identity mismatch")]
|
||||
Identity,
|
||||
#[error("capture Raft authentication failed")]
|
||||
Authentication,
|
||||
#[error("capture Raft channel unavailable")]
|
||||
ChannelUnavailable,
|
||||
#[error("capture Raft deadline exceeded")]
|
||||
Deadline,
|
||||
#[error(transparent)]
|
||||
Io(#[from] std::io::Error),
|
||||
#[error(transparent)]
|
||||
Json(#[from] serde_json::Error),
|
||||
#[error(transparent)]
|
||||
Node(#[from] rustfs_capture_authority::CaptureNodeError),
|
||||
#[error(transparent)]
|
||||
Status(Box<Status>),
|
||||
}
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
|
||||
pub(crate) enum Method {
|
||||
AppendEntries,
|
||||
Vote,
|
||||
InstallSnapshot,
|
||||
}
|
||||
impl Method {
|
||||
pub(crate) fn path(self) -> &'static str {
|
||||
match self {
|
||||
Self::AppendEntries => "/node_service.CaptureRaftService/AppendEntries",
|
||||
Self::Vote => "/node_service.CaptureRaftService/Vote",
|
||||
Self::InstallSnapshot => "/node_service.CaptureRaftService/InstallSnapshot",
|
||||
}
|
||||
}
|
||||
}
|
||||
#[derive(Serialize, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub(crate) struct WireRequest {
|
||||
pub version: u32,
|
||||
pub cluster: [u8; 16],
|
||||
pub source: u64,
|
||||
pub target: u64,
|
||||
pub method: Method,
|
||||
pub nonce: [u8; 16],
|
||||
pub payload: Box<RawValue>,
|
||||
}
|
||||
struct Bounded {
|
||||
bytes: Vec<u8>,
|
||||
max: usize,
|
||||
}
|
||||
impl Write for Bounded {
|
||||
fn write(&mut self, bytes: &[u8]) -> std::io::Result<usize> {
|
||||
let end = self
|
||||
.bytes
|
||||
.len()
|
||||
.checked_add(bytes.len())
|
||||
.ok_or_else(|| std::io::Error::other("capture RPC limit"))?;
|
||||
if end > self.max {
|
||||
return Err(std::io::Error::other("capture RPC limit"));
|
||||
}
|
||||
self.bytes.try_reserve(bytes.len()).map_err(std::io::Error::other)?;
|
||||
self.bytes.extend_from_slice(bytes);
|
||||
Ok(bytes.len())
|
||||
}
|
||||
fn flush(&mut self) -> std::io::Result<()> {
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
fn encoded<T: Serialize>(value: &T, max: usize) -> Result<Vec<u8>, CaptureRaftError> {
|
||||
let mut out = Bounded { bytes: Vec::new(), max };
|
||||
serde_json::to_writer(&mut out, value).map_err(|error| {
|
||||
if error.is_io() {
|
||||
CaptureRaftError::Limits
|
||||
} else {
|
||||
CaptureRaftError::Json(error)
|
||||
}
|
||||
})?;
|
||||
Ok(out.bytes)
|
||||
}
|
||||
fn raw<T: Serialize>(value: &T, max: usize) -> Result<Box<RawValue>, CaptureRaftError> {
|
||||
Ok(RawValue::from_string(
|
||||
String::from_utf8(encoded(value, max)?).map_err(|_| CaptureRaftError::Protocol)?,
|
||||
)?)
|
||||
}
|
||||
pub(crate) fn encode_request<P: Serialize>(
|
||||
local: NodeIdentity,
|
||||
target: u64,
|
||||
method: Method,
|
||||
payload: &P,
|
||||
limits: CaptureRaftLimits,
|
||||
) -> Result<CaptureRaftRequest, CaptureRaftError> {
|
||||
let wire = WireRequest {
|
||||
version: 1,
|
||||
cluster: local.cluster_id,
|
||||
source: local.node_id,
|
||||
target,
|
||||
method,
|
||||
nonce: *uuid::Uuid::new_v4().as_bytes(),
|
||||
payload: raw(payload, limits.max_request_bytes)?,
|
||||
};
|
||||
Ok(CaptureRaftRequest {
|
||||
body: encoded(&wire, limits.max_request_bytes)?.into(),
|
||||
})
|
||||
}
|
||||
pub(crate) fn canonical_request(body: &[u8]) -> Vec<u8> {
|
||||
let mut out = b"rustfs.capture-raft.request.v1\0".to_vec();
|
||||
out.extend_from_slice(body);
|
||||
out
|
||||
}
|
||||
fn decode_wire(body: &[u8], max: usize) -> Result<WireRequest, CaptureRaftError> {
|
||||
if body.len() > max {
|
||||
return Err(CaptureRaftError::Limits);
|
||||
}
|
||||
let wire: WireRequest = serde_json::from_slice(body)?;
|
||||
if wire.version != 1 || wire.cluster == [0; 16] || wire.nonce == [0; 16] || encoded(&wire, max)? != body {
|
||||
return Err(CaptureRaftError::Protocol);
|
||||
}
|
||||
Ok(wire)
|
||||
}
|
||||
fn decode_payload<P: Serialize + DeserializeOwned>(wire: &WireRequest, max: usize) -> Result<P, CaptureRaftError> {
|
||||
let value: P = serde_json::from_str(wire.payload.get())?;
|
||||
if encoded(&value, max)?.as_slice() != wire.payload.get().as_bytes() {
|
||||
return Err(CaptureRaftError::Protocol);
|
||||
}
|
||||
Ok(value)
|
||||
}
|
||||
#[derive(Serialize, Deserialize)]
|
||||
#[serde(tag = "kind", deny_unknown_fields)]
|
||||
pub(crate) enum RemoteFailure {
|
||||
Stopped,
|
||||
Panicked,
|
||||
StorageIo {
|
||||
operation: Option<IoOperation>,
|
||||
},
|
||||
StorageDefensive {
|
||||
subject: ErrorSubject<u64>,
|
||||
violation: Violation<u64>,
|
||||
},
|
||||
SnapshotMismatch {
|
||||
error: InstallSnapshotError,
|
||||
},
|
||||
}
|
||||
#[derive(Serialize, Deserialize)]
|
||||
pub(crate) struct IoOperation {
|
||||
subject: ErrorSubject<u64>,
|
||||
verb: ErrorVerb,
|
||||
}
|
||||
fn fatal(error: Fatal<u64>) -> RemoteFailure {
|
||||
match error {
|
||||
Fatal::Stopped => RemoteFailure::Stopped,
|
||||
Fatal::Panicked => RemoteFailure::Panicked,
|
||||
Fatal::StorageError(StorageError::IO { source }) => RemoteFailure::StorageIo {
|
||||
operation: encoded(&source, 16384)
|
||||
.ok()
|
||||
.and_then(|bytes| serde_json::from_slice(&bytes).ok()),
|
||||
},
|
||||
Fatal::StorageError(StorageError::Defensive { source }) => RemoteFailure::StorageDefensive {
|
||||
subject: source.subject,
|
||||
violation: source.violation,
|
||||
},
|
||||
}
|
||||
}
|
||||
#[derive(Serialize, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
enum WireReply {
|
||||
Success { payload: Box<RawValue> },
|
||||
Failure { error: RemoteFailure },
|
||||
}
|
||||
fn response_context(request: &CaptureRaftRequest, body: &[u8]) -> Result<Vec<u8>, CaptureRaftError> {
|
||||
let mut out = b"rustfs.capture-raft.response.v1\0".to_vec();
|
||||
out.try_reserve(
|
||||
request
|
||||
.body
|
||||
.len()
|
||||
.checked_add(body.len())
|
||||
.and_then(|n| n.checked_add(16))
|
||||
.ok_or(CaptureRaftError::Limits)?,
|
||||
)
|
||||
.map_err(std::io::Error::other)?;
|
||||
out.extend(
|
||||
u64::try_from(request.body.len())
|
||||
.map_err(|_| CaptureRaftError::Limits)?
|
||||
.to_be_bytes(),
|
||||
);
|
||||
out.extend_from_slice(&request.body);
|
||||
out.extend(u64::try_from(body.len()).map_err(|_| CaptureRaftError::Limits)?.to_be_bytes());
|
||||
out.extend_from_slice(body);
|
||||
Ok(out)
|
||||
}
|
||||
fn reply<P: Serialize>(
|
||||
request: &CaptureRaftRequest,
|
||||
result: Result<P, RemoteFailure>,
|
||||
limits: CaptureRaftLimits,
|
||||
) -> Result<CaptureRaftResponse, CaptureRaftError> {
|
||||
let wire = match result {
|
||||
Ok(value) => WireReply::Success {
|
||||
payload: raw(&value, limits.max_response_bytes)?,
|
||||
},
|
||||
Err(error) => WireReply::Failure { error },
|
||||
};
|
||||
let body = encoded(&wire, limits.max_response_bytes)?;
|
||||
let response_proof = http_auth::sign_tonic_rpc_response_proof(&response_context(request, &body)?)?;
|
||||
Ok(CaptureRaftResponse {
|
||||
body: body.into(),
|
||||
response_proof: response_proof.into(),
|
||||
})
|
||||
}
|
||||
pub(crate) fn verify_response<P: Serialize + DeserializeOwned>(
|
||||
request: &CaptureRaftRequest,
|
||||
response: CaptureRaftResponse,
|
||||
limits: CaptureRaftLimits,
|
||||
) -> Result<Result<P, RemoteFailure>, CaptureRaftError> {
|
||||
if request.body.len() > limits.max_request_bytes
|
||||
|| response.body.len() > limits.max_response_bytes
|
||||
|| response.response_proof.len() != 32
|
||||
{
|
||||
return Err(CaptureRaftError::Limits);
|
||||
}
|
||||
http_auth::verify_tonic_rpc_response_proof(&response_context(request, &response.body)?, &response.response_proof)?;
|
||||
let wire: WireReply = serde_json::from_slice(&response.body)?;
|
||||
if encoded(&wire, limits.max_response_bytes)?.as_slice() != response.body {
|
||||
return Err(CaptureRaftError::Protocol);
|
||||
}
|
||||
match wire {
|
||||
WireReply::Failure { error } => Ok(Err(error)),
|
||||
WireReply::Success { payload } => {
|
||||
let value: P = serde_json::from_str(payload.get())?;
|
||||
if encoded(&value, limits.max_response_bytes)?.as_slice() != payload.get().as_bytes() {
|
||||
return Err(CaptureRaftError::Protocol);
|
||||
}
|
||||
Ok(Ok(value))
|
||||
}
|
||||
}
|
||||
}
|
||||
fn restored_fatal(error: RemoteFailure) -> Result<Fatal<u64>, CaptureRaftError> {
|
||||
Ok(match error {
|
||||
RemoteFailure::Stopped => Fatal::Stopped,
|
||||
RemoteFailure::Panicked => Fatal::Panicked,
|
||||
RemoteFailure::StorageIo { operation } => {
|
||||
let (subject, verb) = operation
|
||||
.map(|op| (op.subject, op.verb))
|
||||
.unwrap_or((ErrorSubject::None, ErrorVerb::Read));
|
||||
Fatal::StorageError(
|
||||
StorageIOError::new(
|
||||
subject,
|
||||
verb,
|
||||
openraft::AnyError::new(&std::io::Error::other("remote Raft storage I/O failed; detailed source redacted")),
|
||||
)
|
||||
.into(),
|
||||
)
|
||||
}
|
||||
RemoteFailure::StorageDefensive { subject, violation } => Fatal::StorageError(StorageError::Defensive {
|
||||
source: DefensiveError {
|
||||
subject,
|
||||
violation,
|
||||
backtrace: None,
|
||||
},
|
||||
}),
|
||||
RemoteFailure::SnapshotMismatch { .. } => return Err(CaptureRaftError::Protocol),
|
||||
})
|
||||
}
|
||||
fn peers_valid(local: NodeIdentity, peers: &BTreeMap<u64, CaptureNode>) -> Result<(), CaptureRaftError> {
|
||||
if local.cluster_id == [0; 16] || !peers.contains_key(&local.node_id) {
|
||||
return Err(CaptureRaftError::Identity);
|
||||
}
|
||||
let mut addresses = std::collections::BTreeSet::new();
|
||||
for node in peers.values() {
|
||||
node.validate()?;
|
||||
if !addresses.insert(node.rpc_uri()) {
|
||||
return Err(CaptureRaftError::Identity);
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
type WorkerPause = Arc<std::sync::Mutex<Option<(Arc<tokio::sync::Notify>, Arc<tokio::sync::Notify>)>>>;
|
||||
#[derive(Clone)]
|
||||
pub struct CaptureRaftRpc {
|
||||
owner: Arc<NativeRaftOwner>,
|
||||
peers: Arc<BTreeMap<u64, CaptureNode>>,
|
||||
audience: String,
|
||||
limits: CaptureRaftLimits,
|
||||
admission: Arc<tokio::sync::Semaphore>,
|
||||
accepting: Arc<std::sync::atomic::AtomicBool>,
|
||||
#[cfg(test)]
|
||||
pub(crate) worker_pause: WorkerPause,
|
||||
}
|
||||
impl CaptureRaftRpc {
|
||||
pub fn new(
|
||||
owner: Arc<NativeRaftOwner>,
|
||||
peers: BTreeMap<u64, CaptureNode>,
|
||||
limits: CaptureRaftLimits,
|
||||
) -> Result<Self, CaptureRaftError> {
|
||||
limits.validate()?;
|
||||
let identity = owner.identity();
|
||||
peers_valid(identity, &peers)?;
|
||||
let node = peers.get(&identity.node_id).ok_or(CaptureRaftError::Identity)?;
|
||||
let uri: http::Uri = node.rpc_uri().parse().map_err(|_| CaptureRaftError::Identity)?;
|
||||
let audience = http_auth::normalize_tonic_rpc_audience(uri.authority().ok_or(CaptureRaftError::Identity)?.as_str())?;
|
||||
Ok(Self {
|
||||
owner,
|
||||
peers: Arc::new(peers),
|
||||
audience,
|
||||
limits,
|
||||
#[cfg(test)]
|
||||
worker_pause: Arc::new(std::sync::Mutex::new(None)),
|
||||
accepting: Arc::new(std::sync::atomic::AtomicBool::new(true)),
|
||||
admission: Arc::new(tokio::sync::Semaphore::new(limits.max_inflight)),
|
||||
})
|
||||
}
|
||||
pub fn into_service(self) -> CaptureRaftServiceServer<Self> {
|
||||
let request = self.limits.max_request_bytes + 64;
|
||||
let response = self.limits.max_response_bytes + 128;
|
||||
CaptureRaftServiceServer::new(self)
|
||||
.max_decoding_message_size(request)
|
||||
.max_encoding_message_size(response)
|
||||
}
|
||||
fn prepare<P: Serialize + DeserializeOwned>(
|
||||
&self,
|
||||
request: &Request<CaptureRaftRequest>,
|
||||
method: Method,
|
||||
) -> Result<(WireRequest, P, tokio::sync::OwnedSemaphorePermit), Status> {
|
||||
if !self.accepting.load(std::sync::atomic::Ordering::Acquire) {
|
||||
return Err(Status::unavailable("capture Raft service stopping"));
|
||||
}
|
||||
let permit = self
|
||||
.admission
|
||||
.clone()
|
||||
.try_acquire_owned()
|
||||
.map_err(|_| Status::resource_exhausted("capture Raft admission full"))?;
|
||||
if !self.accepting.load(std::sync::atomic::Ordering::Acquire) {
|
||||
return Err(Status::unavailable("capture Raft service stopping"));
|
||||
}
|
||||
if request.get_ref().body.len() > self.limits.max_request_bytes {
|
||||
return Err(Status::resource_exhausted("capture Raft request limit"));
|
||||
}
|
||||
if request
|
||||
.metadata()
|
||||
.get(http_auth::RPC_REPLAY_SCOPE_VERSION_HEADER)
|
||||
.and_then(|v| v.to_str().ok())
|
||||
!= Some("3")
|
||||
{
|
||||
return Err(auth_rejected("missing_replay_scope"));
|
||||
}
|
||||
http_auth::verify_tonic_rpc_signature_with_bootstrap(&self.audience, method.path(), request.metadata().as_ref(), false)
|
||||
.map_err(|_| auth_rejected("invalid_signature"))?;
|
||||
http_auth::verify_tonic_canonical_body_digest(request, &canonical_request(&request.get_ref().body))
|
||||
.map_err(|_| auth_rejected("body_digest_mismatch"))?;
|
||||
let wire = decode_wire(&request.get_ref().body, self.limits.max_request_bytes)
|
||||
.map_err(|_| Status::invalid_argument("capture Raft wire rejected"))?;
|
||||
let local = self.owner.identity();
|
||||
if wire.cluster != local.cluster_id
|
||||
|| wire.target != local.node_id
|
||||
|| wire.method != method
|
||||
|| !self.peers.contains_key(&wire.source)
|
||||
{
|
||||
return Err(Status::permission_denied("capture Raft identity rejected"));
|
||||
}
|
||||
let payload = decode_payload(&wire, self.limits.max_request_bytes)
|
||||
.map_err(|_| Status::invalid_argument("capture Raft payload rejected"))?;
|
||||
Ok((wire, payload, permit))
|
||||
}
|
||||
#[cfg(test)]
|
||||
async fn paused(pause: WorkerPause) {
|
||||
let gate = pause.lock().expect("worker pause lock").take();
|
||||
if let Some((entered, resume)) = gate {
|
||||
entered.notify_one();
|
||||
resume.notified().await;
|
||||
}
|
||||
}
|
||||
/// Stop admission and wait for all actual RPC tasks, including cancelled HTTP waiters.
|
||||
pub async fn shutdown(&self) -> Result<(), CaptureRaftError> {
|
||||
self.accepting.store(false, std::sync::atomic::Ordering::Release);
|
||||
let count = u32::try_from(self.limits.max_inflight).map_err(|_| CaptureRaftError::Limits)?;
|
||||
let _all = self
|
||||
.admission
|
||||
.clone()
|
||||
.acquire_many_owned(count)
|
||||
.await
|
||||
.map_err(|_| CaptureRaftError::ChannelUnavailable)?;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
fn signed_response<P: Serialize>(
|
||||
raw: &CaptureRaftRequest,
|
||||
result: Result<P, RemoteFailure>,
|
||||
limits: CaptureRaftLimits,
|
||||
audience: &str,
|
||||
challenge: Option<uuid::Uuid>,
|
||||
) -> Result<Response<CaptureRaftResponse>, Status> {
|
||||
let mut response =
|
||||
Response::new(reply(raw, result, limits).map_err(|_| Status::internal("capture Raft response unavailable"))?);
|
||||
if let Some(challenge) = challenge {
|
||||
response.metadata_mut().as_mut().extend(
|
||||
http_auth::tonic_boot_epoch_response_headers(audience, challenge)
|
||||
.map_err(|_| Status::internal("capture Raft epoch proof unavailable"))?,
|
||||
);
|
||||
}
|
||||
Ok(response)
|
||||
}
|
||||
#[tonic::async_trait]
|
||||
impl CaptureRaftService for CaptureRaftRpc {
|
||||
async fn append_entries(&self, request: Request<CaptureRaftRequest>) -> Result<Response<CaptureRaftResponse>, Status> {
|
||||
let (wire, payload, permit) = self.prepare::<AppendEntriesRequest<CaptureTypeConfig>>(&request, Method::AppendEntries)?;
|
||||
validate_append(&payload, wire.source, self.limits)
|
||||
.map_err(|_| Status::invalid_argument("capture Raft append rejected"))?;
|
||||
let challenge = http_auth::tonic_boot_epoch_challenge(request.metadata().as_ref())
|
||||
.map_err(|_| Status::unauthenticated("capture Raft challenge rejected"))?;
|
||||
let raw = request.into_inner();
|
||||
let owner = self.owner.clone();
|
||||
let audience = self.audience.clone();
|
||||
let limits = self.limits;
|
||||
#[cfg(test)]
|
||||
let pause = self.worker_pause.clone();
|
||||
tokio::spawn(async move {
|
||||
let _permit = permit;
|
||||
#[cfg(test)]
|
||||
Self::paused(pause).await;
|
||||
let result = owner.raft().append_entries(payload).await.map_err(|error| match error {
|
||||
RaftError::Fatal(error) => fatal(error),
|
||||
RaftError::APIError(error) => match error {},
|
||||
});
|
||||
drop(owner);
|
||||
signed_response(&raw, result, limits, &audience, challenge)
|
||||
})
|
||||
.await
|
||||
.map_err(|_| Status::internal("capture Raft worker failed"))?
|
||||
}
|
||||
async fn vote(&self, request: Request<CaptureRaftRequest>) -> Result<Response<CaptureRaftResponse>, Status> {
|
||||
let (wire, payload, permit) = self.prepare::<VoteRequest<u64>>(&request, Method::Vote)?;
|
||||
if payload.vote.leader_id.node_id != wire.source {
|
||||
return Err(Status::invalid_argument("capture Raft candidate rejected"));
|
||||
}
|
||||
let challenge = http_auth::tonic_boot_epoch_challenge(request.metadata().as_ref())
|
||||
.map_err(|_| Status::unauthenticated("capture Raft challenge rejected"))?;
|
||||
let raw = request.into_inner();
|
||||
let owner = self.owner.clone();
|
||||
let audience = self.audience.clone();
|
||||
let limits = self.limits;
|
||||
#[cfg(test)]
|
||||
let pause = self.worker_pause.clone();
|
||||
tokio::spawn(async move {
|
||||
let _permit = permit;
|
||||
#[cfg(test)]
|
||||
Self::paused(pause).await;
|
||||
let result = owner.raft().vote(payload).await.map_err(|error| match error {
|
||||
RaftError::Fatal(error) => fatal(error),
|
||||
RaftError::APIError(error) => match error {},
|
||||
});
|
||||
drop(owner);
|
||||
signed_response(&raw, result, limits, &audience, challenge)
|
||||
})
|
||||
.await
|
||||
.map_err(|_| Status::internal("capture Raft worker failed"))?
|
||||
}
|
||||
async fn install_snapshot(&self, request: Request<CaptureRaftRequest>) -> Result<Response<CaptureRaftResponse>, Status> {
|
||||
let (wire, payload, permit) =
|
||||
self.prepare::<InstallSnapshotRequest<CaptureTypeConfig>>(&request, Method::InstallSnapshot)?;
|
||||
validate_snapshot(&payload, wire.source, self.limits)
|
||||
.map_err(|_| Status::invalid_argument("capture Raft snapshot rejected"))?;
|
||||
let challenge = http_auth::tonic_boot_epoch_challenge(request.metadata().as_ref())
|
||||
.map_err(|_| Status::unauthenticated("capture Raft challenge rejected"))?;
|
||||
let raw = request.into_inner();
|
||||
let owner = self.owner.clone();
|
||||
let audience = self.audience.clone();
|
||||
let limits = self.limits;
|
||||
#[cfg(test)]
|
||||
let pause = self.worker_pause.clone();
|
||||
tokio::spawn(async move {
|
||||
let _permit = permit;
|
||||
#[cfg(test)]
|
||||
Self::paused(pause).await;
|
||||
let result = owner.raft().install_snapshot(payload).await.map_err(|error| match error {
|
||||
RaftError::Fatal(error) => fatal(error),
|
||||
RaftError::APIError(error) => RemoteFailure::SnapshotMismatch { error },
|
||||
});
|
||||
drop(owner);
|
||||
signed_response(&raw, result, limits, &audience, challenge)
|
||||
})
|
||||
.await
|
||||
.map_err(|_| Status::internal("capture Raft worker failed"))?
|
||||
}
|
||||
}
|
||||
fn validate_append(
|
||||
request: &AppendEntriesRequest<CaptureTypeConfig>,
|
||||
source: u64,
|
||||
limits: CaptureRaftLimits,
|
||||
) -> Result<(), CaptureRaftError> {
|
||||
if request.vote.leader_id.node_id != source {
|
||||
return Err(CaptureRaftError::Identity);
|
||||
}
|
||||
if request.entries.len() > limits.max_entries {
|
||||
return Err(CaptureRaftError::RequestTooLarge);
|
||||
}
|
||||
for entry in &request.entries {
|
||||
if let openraft::EntryPayload::Membership(value) = &entry.payload {
|
||||
CaptureMembership::try_from(&openraft::StoredMembership::new(Some(entry.log_id), value.clone()))
|
||||
.map_err(|_| CaptureRaftError::Protocol)?;
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
fn validate_snapshot(
|
||||
request: &InstallSnapshotRequest<CaptureTypeConfig>,
|
||||
source: u64,
|
||||
limits: CaptureRaftLimits,
|
||||
) -> Result<(), CaptureRaftError> {
|
||||
if request.vote.leader_id.node_id != source
|
||||
|| request.data.len() > limits.max_snapshot_chunk_bytes
|
||||
|| request
|
||||
.offset
|
||||
.checked_add(u64::try_from(request.data.len()).map_err(|_| CaptureRaftError::Limits)?)
|
||||
.is_none()
|
||||
|| request.meta.snapshot_id.is_empty()
|
||||
|| request.meta.snapshot_id.len() > 1024
|
||||
{
|
||||
return Err(CaptureRaftError::Limits);
|
||||
}
|
||||
CaptureMembership::try_from(&request.meta.last_membership).map_err(|_| CaptureRaftError::Protocol)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct CaptureRaftNetworkFactory {
|
||||
local: NodeIdentity,
|
||||
peers: Arc<BTreeMap<u64, CaptureNode>>,
|
||||
limits: CaptureRaftLimits,
|
||||
admission: Arc<tokio::sync::Semaphore>,
|
||||
}
|
||||
impl CaptureRaftNetworkFactory {
|
||||
pub fn new(
|
||||
local: NodeIdentity,
|
||||
peers: BTreeMap<u64, CaptureNode>,
|
||||
config: Arc<openraft::Config>,
|
||||
limits: CaptureRaftLimits,
|
||||
) -> Result<Self, CaptureRaftError> {
|
||||
limits.validate()?;
|
||||
peers_valid(local, &peers)?;
|
||||
if usize::try_from(config.max_payload_entries).map_err(|_| CaptureRaftError::Limits)? > limits.max_entries {
|
||||
return Err(CaptureRaftError::Limits);
|
||||
}
|
||||
if usize::try_from(config.snapshot_max_chunk_size).map_err(|_| CaptureRaftError::Limits)?
|
||||
> limits.max_snapshot_chunk_bytes
|
||||
{
|
||||
return Err(CaptureRaftError::Limits);
|
||||
}
|
||||
Ok(Self {
|
||||
local,
|
||||
peers: Arc::new(peers),
|
||||
limits,
|
||||
admission: Arc::new(tokio::sync::Semaphore::new(limits.max_inflight)),
|
||||
})
|
||||
}
|
||||
}
|
||||
pub struct CaptureRaftPeer {
|
||||
factory: CaptureRaftNetworkFactory,
|
||||
target: u64,
|
||||
node: CaptureNode,
|
||||
valid: bool,
|
||||
}
|
||||
impl RaftNetworkFactory<CaptureTypeConfig> for CaptureRaftNetworkFactory {
|
||||
type Network = CaptureRaftPeer;
|
||||
async fn new_client(&mut self, target: u64, node: &CaptureNode) -> Self::Network {
|
||||
CaptureRaftPeer {
|
||||
factory: self.clone(),
|
||||
target,
|
||||
node: node.clone(),
|
||||
valid: self.peers.get(&target) == Some(node),
|
||||
}
|
||||
}
|
||||
}
|
||||
impl CaptureRaftPeer {
|
||||
async fn exchange<P: Serialize, R: Serialize + DeserializeOwned>(
|
||||
&self,
|
||||
method: Method,
|
||||
payload: &P,
|
||||
option: &RPCOption,
|
||||
) -> Result<Result<R, RemoteFailure>, CaptureRaftError> {
|
||||
if !self.valid {
|
||||
return Err(CaptureRaftError::Identity);
|
||||
}
|
||||
let ttl = self.factory.limits.request_timeout.min(option.soft_ttl());
|
||||
tokio::time::timeout(ttl, async {
|
||||
let _permit = self
|
||||
.factory
|
||||
.admission
|
||||
.clone()
|
||||
.acquire_owned()
|
||||
.await
|
||||
.map_err(|_| CaptureRaftError::ChannelUnavailable)?;
|
||||
let raw =
|
||||
encode_request(self.factory.local, self.target, method, payload, self.factory.limits).map_err(
|
||||
|error| match error {
|
||||
CaptureRaftError::Limits => CaptureRaftError::RequestTooLarge,
|
||||
error => error,
|
||||
},
|
||||
)?;
|
||||
let mut request = Request::new(raw.clone());
|
||||
http_auth::set_tonic_canonical_body_digest(&mut request, &canonical_request(&raw.body))?;
|
||||
request.set_timeout(ttl);
|
||||
let mut client = client::capture_raft_time_out_client(
|
||||
self.node.rpc_uri(),
|
||||
self.factory.limits.connect_timeout.min(ttl),
|
||||
self.factory.limits.max_request_bytes + 64,
|
||||
self.factory.limits.max_response_bytes + 128,
|
||||
)
|
||||
.await?;
|
||||
let response = match method {
|
||||
Method::AppendEntries => client.append_entries(request).await,
|
||||
Method::Vote => client.vote(request).await,
|
||||
Method::InstallSnapshot => client.install_snapshot(request).await,
|
||||
}
|
||||
.map_err(|status| CaptureRaftError::Status(Box::new(status)))?;
|
||||
verify_response(&raw, response.into_inner(), self.factory.limits)
|
||||
})
|
||||
.await
|
||||
.map_err(|_| CaptureRaftError::Deadline)?
|
||||
}
|
||||
fn network_error<E: std::error::Error>(
|
||||
&self,
|
||||
error: CaptureRaftError,
|
||||
method: Method,
|
||||
option: &RPCOption,
|
||||
) -> RPCError<u64, CaptureNode, E> {
|
||||
match error {
|
||||
CaptureRaftError::Deadline => RPCError::Timeout(openraft::error::Timeout {
|
||||
action: match method {
|
||||
Method::AppendEntries => openraft::RPCTypes::AppendEntries,
|
||||
Method::Vote => openraft::RPCTypes::Vote,
|
||||
Method::InstallSnapshot => openraft::RPCTypes::InstallSnapshot,
|
||||
},
|
||||
id: self.factory.local.node_id,
|
||||
target: self.target,
|
||||
timeout: self.factory.limits.request_timeout.min(option.soft_ttl()),
|
||||
}),
|
||||
error @ CaptureRaftError::ChannelUnavailable => RPCError::Unreachable(Unreachable::new(&error)),
|
||||
error => RPCError::Network(openraft::error::NetworkError::new(&error)),
|
||||
}
|
||||
}
|
||||
fn append_error<E: std::error::Error>(
|
||||
&self,
|
||||
error: CaptureRaftError,
|
||||
count: usize,
|
||||
option: &RPCOption,
|
||||
) -> RPCError<u64, CaptureNode, E> {
|
||||
if matches!(error, CaptureRaftError::RequestTooLarge) && count > 1 {
|
||||
let hint = u64::try_from((count / 2).max(1).min(self.factory.limits.max_entries)).unwrap_or(1);
|
||||
return RPCError::PayloadTooLarge(openraft::error::PayloadTooLarge::new_entries_hint(hint));
|
||||
}
|
||||
self.network_error(error, Method::AppendEntries, option)
|
||||
}
|
||||
fn remote<E: std::error::Error>(&self, error: E) -> RPCError<u64, CaptureNode, E> {
|
||||
RPCError::RemoteError(RemoteError::new_with_node(self.target, self.node.clone(), error))
|
||||
}
|
||||
}
|
||||
impl RaftNetwork<CaptureTypeConfig> for CaptureRaftPeer {
|
||||
async fn append_entries(
|
||||
&mut self,
|
||||
request: AppendEntriesRequest<CaptureTypeConfig>,
|
||||
option: RPCOption,
|
||||
) -> Result<AppendEntriesResponse<u64>, RPCError<u64, CaptureNode, RaftError<u64>>> {
|
||||
let count = request.entries.len();
|
||||
validate_append(&request, self.factory.local.node_id, self.factory.limits)
|
||||
.map_err(|error| self.append_error(error, count, &option))?;
|
||||
match self
|
||||
.exchange(Method::AppendEntries, &request, &option)
|
||||
.await
|
||||
.map_err(|error| self.append_error(error, count, &option))?
|
||||
{
|
||||
Ok(value) => Ok(value),
|
||||
Err(error) => Err(self.remote(RaftError::Fatal(
|
||||
restored_fatal(error).map_err(|error| self.network_error(error, Method::AppendEntries, &option))?,
|
||||
))),
|
||||
}
|
||||
}
|
||||
async fn vote(
|
||||
&mut self,
|
||||
request: VoteRequest<u64>,
|
||||
option: RPCOption,
|
||||
) -> Result<VoteResponse<u64>, RPCError<u64, CaptureNode, RaftError<u64>>> {
|
||||
if request.vote.leader_id.node_id != self.factory.local.node_id {
|
||||
return Err(self.network_error(CaptureRaftError::Identity, Method::Vote, &option));
|
||||
}
|
||||
match self
|
||||
.exchange(Method::Vote, &request, &option)
|
||||
.await
|
||||
.map_err(|error| self.network_error(error, Method::Vote, &option))?
|
||||
{
|
||||
Ok(value) => Ok(value),
|
||||
Err(error) => Err(self.remote(RaftError::Fatal(
|
||||
restored_fatal(error).map_err(|error| self.network_error(error, Method::Vote, &option))?,
|
||||
))),
|
||||
}
|
||||
}
|
||||
async fn install_snapshot(
|
||||
&mut self,
|
||||
request: InstallSnapshotRequest<CaptureTypeConfig>,
|
||||
option: RPCOption,
|
||||
) -> Result<InstallSnapshotResponse<u64>, RPCError<u64, CaptureNode, RaftError<u64, InstallSnapshotError>>> {
|
||||
validate_snapshot(&request, self.factory.local.node_id, self.factory.limits)
|
||||
.map_err(|error| self.network_error(error, Method::InstallSnapshot, &option))?;
|
||||
match self
|
||||
.exchange(Method::InstallSnapshot, &request, &option)
|
||||
.await
|
||||
.map_err(|error| self.network_error(error, Method::InstallSnapshot, &option))?
|
||||
{
|
||||
Ok(value) => Ok(value),
|
||||
Err(error) => {
|
||||
let source = match error {
|
||||
RemoteFailure::SnapshotMismatch { error } => RaftError::APIError(error),
|
||||
error => RaftError::Fatal(
|
||||
restored_fatal(error).map_err(|error| self.network_error(error, Method::InstallSnapshot, &option))?,
|
||||
),
|
||||
};
|
||||
Err(self.remote(source))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn auth_rejected(reason: &'static str) -> Status {
|
||||
use rustfs_io_metrics::internode_metrics::{
|
||||
INTERNODE_OPERATION_GRPC_OTHER, INTERNODE_TRANSPORT_BACKEND_GRPC, global_internode_metrics,
|
||||
};
|
||||
global_internode_metrics().record_rpc_auth_failure_for_operation_and_backend(
|
||||
INTERNODE_OPERATION_GRPC_OTHER,
|
||||
INTERNODE_TRANSPORT_BACKEND_GRPC,
|
||||
reason,
|
||||
);
|
||||
Status::unauthenticated("capture Raft authentication rejected")
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -24,11 +24,10 @@ use crate::cluster::rpc::{gen_tonic_replay_scope_headers, gen_tonic_signature_he
|
||||
#[cfg(test)]
|
||||
use crate::cluster::rpc::{tonic_boot_epoch_challenge, tonic_boot_epoch_response_headers};
|
||||
use crate::disk::error::{DiskError, Error as DiskErrorType, RpcStatusError};
|
||||
#[cfg(test)]
|
||||
use crate::runtime::sources as runtime_sources;
|
||||
use http::{Request as HttpRequest, Response as HttpResponse, Uri};
|
||||
use rustfs_protos::{
|
||||
ChannelClass, get_channel_for_class,
|
||||
ChannelClass, create_new_channel, get_channel_for_class,
|
||||
proto_gen::node_service::{
|
||||
heal_control_service_client::HealControlServiceClient, node_service_client::NodeServiceClient,
|
||||
scanner_control_service_client::ScannerControlServiceClient,
|
||||
@@ -54,7 +53,7 @@ use super::context_propagation::{inject_request_id_into_metadata, inject_trace_c
|
||||
/// 3. Subsequent calls will attempt fresh connections
|
||||
/// 4. If node is still down, connection will fail fast (3s timeout)
|
||||
pub async fn node_service_time_out_client(
|
||||
addr: &str,
|
||||
addr: &String,
|
||||
interceptor: TonicInterceptor,
|
||||
) -> Result<NodeServiceClient<InterceptedService<AuthenticatedChannel, TonicInterceptor>>, Box<dyn Error>> {
|
||||
// Default to the latency-sensitive control channel; bulk `bytes` RPCs opt in via the
|
||||
@@ -67,9 +66,12 @@ pub(crate) async fn scanner_control_time_out_client(
|
||||
interceptor: TonicInterceptor,
|
||||
) -> crate::error::Result<ScannerControlServiceClient<InterceptedService<AuthenticatedChannel, TonicInterceptor>>> {
|
||||
let interceptor = interceptor.with_rpc_audience(addr)?;
|
||||
let channel = get_channel_for_class(addr, ChannelClass::Control)
|
||||
.await
|
||||
.map_err(|err| crate::error::Error::other(err.to_string()))?;
|
||||
let channel = match runtime_sources::cached_node_channel(addr).await {
|
||||
Some(channel) => channel,
|
||||
None => create_new_channel(addr)
|
||||
.await
|
||||
.map_err(|err| crate::error::Error::other(err.to_string()))?,
|
||||
};
|
||||
let channel = ReplayScopeChannel::new(channel, interceptor.replay_scope_audience());
|
||||
let limit = rustfs_protos::scoped_dirty_usage::SCOPED_DIRTY_USAGE_MAX_REQUEST_BYTES as usize;
|
||||
Ok(ScannerControlServiceClient::with_interceptor(channel, interceptor)
|
||||
@@ -82,7 +84,10 @@ pub async fn heal_control_time_out_client(
|
||||
interceptor: TonicInterceptor,
|
||||
) -> Result<HealControlServiceClient<InterceptedService<AuthenticatedChannel, TonicInterceptor>>, Box<dyn Error>> {
|
||||
let interceptor = interceptor.with_rpc_audience(addr)?;
|
||||
let channel = get_channel_for_class(addr, ChannelClass::Control).await?;
|
||||
let channel = match runtime_sources::cached_node_channel(addr).await {
|
||||
Some(channel) => channel,
|
||||
None => create_new_channel(addr).await?,
|
||||
};
|
||||
let max_message_size = rustfs_protos::HEAL_CONTROL_RPC_MAX_MESSAGE_SIZE;
|
||||
let channel = ReplayScopeChannel::new(channel, interceptor.replay_scope_audience());
|
||||
Ok(HealControlServiceClient::with_interceptor(channel, interceptor)
|
||||
@@ -95,7 +100,10 @@ pub async fn tier_mutation_control_time_out_client(
|
||||
interceptor: TonicInterceptor,
|
||||
) -> Result<TierMutationControlServiceClient<InterceptedService<AuthenticatedChannel, TonicInterceptor>>, Box<dyn Error>> {
|
||||
let interceptor = interceptor.with_rpc_audience(addr)?;
|
||||
let channel = get_channel_for_class(addr, ChannelClass::Control).await?;
|
||||
let channel = match runtime_sources::cached_node_channel(addr).await {
|
||||
Some(channel) => channel,
|
||||
None => create_new_channel(addr).await?,
|
||||
};
|
||||
let max_message_size = rustfs_protos::TIER_MUTATION_RPC_MAX_MESSAGE_SIZE;
|
||||
let channel = ReplayScopeChannel::new(channel, interceptor.replay_scope_audience());
|
||||
Ok(TierMutationControlServiceClient::with_interceptor(channel, interceptor)
|
||||
@@ -110,12 +118,22 @@ pub async fn tier_mutation_control_time_out_client(
|
||||
/// from lock/health RPCs; everything else uses [`ChannelClass::Control`]. When isolation is
|
||||
/// disabled the two classes resolve to the same cached channel, i.e. legacy behavior.
|
||||
pub async fn node_service_time_out_client_for_class(
|
||||
addr: &str,
|
||||
addr: &String,
|
||||
interceptor: TonicInterceptor,
|
||||
class: ChannelClass,
|
||||
) -> Result<NodeServiceClient<InterceptedService<AuthenticatedChannel, TonicInterceptor>>, Box<dyn Error>> {
|
||||
let interceptor = interceptor.with_rpc_audience(addr)?;
|
||||
let channel = get_channel_for_class(addr, class).await?;
|
||||
let channel = match class {
|
||||
ChannelClass::Control => match runtime_sources::cached_node_channel(addr).await {
|
||||
Some(channel) => {
|
||||
debug!("Using cached gRPC channel for: {}", addr);
|
||||
channel
|
||||
}
|
||||
// No cached connection, create new one.
|
||||
None => create_new_channel(addr).await?,
|
||||
},
|
||||
ChannelClass::Bulk => get_channel_for_class(addr, ChannelClass::Bulk).await?,
|
||||
};
|
||||
|
||||
let max_message_size = rustfs_protos::internode_rpc_max_message_size();
|
||||
let channel = ReplayScopeChannel::new(channel, interceptor.replay_scope_audience());
|
||||
@@ -124,24 +142,8 @@ pub async fn node_service_time_out_client_for_class(
|
||||
.max_encoding_message_size(max_message_size))
|
||||
}
|
||||
|
||||
pub(crate) async fn node_service_delete_recovery_client(
|
||||
addr: &str,
|
||||
interceptor: TonicInterceptor,
|
||||
timeout: std::time::Duration,
|
||||
) -> Result<NodeServiceClient<InterceptedService<AuthenticatedChannel, TonicInterceptor>>, DiskError> {
|
||||
let interceptor = interceptor.with_rpc_audience(addr).map_err(DiskError::from)?;
|
||||
let channel = rustfs_protos::create_channel_with_timeout(addr, timeout)
|
||||
.await
|
||||
.map_err(|error| DiskError::RemoteClientUnavailable(error.to_string()))?;
|
||||
let channel = ReplayScopeChannel::new(channel, interceptor.replay_scope_audience());
|
||||
let max_message_size = rustfs_protos::internode_rpc_max_message_size();
|
||||
Ok(NodeServiceClient::with_interceptor(channel, interceptor)
|
||||
.max_decoding_message_size(max_message_size)
|
||||
.max_encoding_message_size(max_message_size))
|
||||
}
|
||||
|
||||
pub async fn node_service_time_out_client_no_auth(
|
||||
addr: &str,
|
||||
addr: &String,
|
||||
) -> Result<NodeServiceClient<InterceptedService<AuthenticatedChannel, TonicInterceptor>>, Box<dyn Error>> {
|
||||
node_service_time_out_client(addr, TonicInterceptor::NoOp(NoOpInterceptor)).await
|
||||
}
|
||||
@@ -353,13 +355,6 @@ fn apply_peer_replay_response(
|
||||
}
|
||||
}
|
||||
|
||||
fn rename_data_grpc_stage(path: &str) -> bool {
|
||||
matches!(
|
||||
path,
|
||||
"/node_service.NodeService/RenameData" | "/node_service.NodeService/RenameDataAtIncarnation"
|
||||
)
|
||||
}
|
||||
|
||||
impl<S, ReqBody, ResBody> Service<HttpRequest<ReqBody>> for ReplayScopeChannel<S>
|
||||
where
|
||||
S: Service<HttpRequest<ReqBody>, Response = HttpResponse<ResBody>>,
|
||||
@@ -377,12 +372,6 @@ where
|
||||
}
|
||||
|
||||
fn call(&mut self, mut request: HttpRequest<ReqBody>) -> Self::Future {
|
||||
let observe_rename_data = rustfs_io_metrics::put_stage_metrics_enabled() && rename_data_grpc_stage(request.uri().path());
|
||||
let request_scope_started = if observe_rename_data {
|
||||
rustfs_io_metrics::put_stage_timer()
|
||||
} else {
|
||||
None
|
||||
};
|
||||
let authenticated = self.audience.as_ref().is_some_and(|_| {
|
||||
request
|
||||
.headers()
|
||||
@@ -417,30 +406,11 @@ where
|
||||
}
|
||||
}
|
||||
}
|
||||
rustfs_io_metrics::record_put_object_stage_duration_from(
|
||||
rustfs_io_metrics::PUT_STAGE_SET_DISK_RENAME_REMOTE_CLIENT_REQUEST_SCOPE,
|
||||
request_scope_started,
|
||||
);
|
||||
|
||||
let audience = self.audience.clone();
|
||||
let future = self.inner.call(request);
|
||||
Box::pin(async move {
|
||||
let response = if observe_rename_data {
|
||||
rustfs_io_metrics::observe_put_stage_future(
|
||||
future,
|
||||
rustfs_io_metrics::PUT_STAGE_SET_DISK_RENAME_REMOTE_CLIENT_TRANSPORT_CALL,
|
||||
rustfs_io_metrics::PUT_STAGE_SET_DISK_RENAME_REMOTE_CLIENT_TRANSPORT_CALL_POLL_PENDING_COUNT,
|
||||
rustfs_io_metrics::PUT_STAGE_SET_DISK_RENAME_REMOTE_CLIENT_TRANSPORT_CALL_FIRST_PENDING_TO_READY,
|
||||
)
|
||||
.await?
|
||||
} else {
|
||||
future.await?
|
||||
};
|
||||
let replay_response_started = if observe_rename_data {
|
||||
rustfs_io_metrics::put_stage_timer()
|
||||
} else {
|
||||
None
|
||||
};
|
||||
let response = future.await?;
|
||||
if let (Some(audience), Some(challenge)) = (audience, challenge) {
|
||||
let response_state = verify_tonic_peer_replay_capabilities_response(&audience, challenge, response.headers());
|
||||
if let Err(error) = &response_state
|
||||
@@ -458,10 +428,6 @@ where
|
||||
}
|
||||
apply_peer_replay_response(audience, sent_state, response_state);
|
||||
}
|
||||
rustfs_io_metrics::record_put_object_stage_duration_from(
|
||||
rustfs_io_metrics::PUT_STAGE_SET_DISK_RENAME_REMOTE_CLIENT_REPLAY_RESPONSE,
|
||||
replay_response_started,
|
||||
);
|
||||
Ok(response)
|
||||
})
|
||||
}
|
||||
@@ -569,6 +535,62 @@ impl tonic::service::Interceptor for TonicInterceptor {
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) type CaptureRaftClient = rustfs_protos::proto_gen::node_service::capture_raft_service_client::CaptureRaftServiceClient<
|
||||
InterceptedService<AuthenticatedChannel, TonicInterceptor>,
|
||||
>;
|
||||
|
||||
/// Capture RPCs always perform the real authenticated epoch handshake, never seed replay state.
|
||||
pub(crate) async fn capture_raft_time_out_client(
|
||||
addr: &str,
|
||||
connect_timeout: std::time::Duration,
|
||||
request_max: usize,
|
||||
response_max: usize,
|
||||
) -> Result<CaptureRaftClient, super::capture_raft::CaptureRaftError> {
|
||||
use super::capture_raft::CaptureRaftError;
|
||||
let interceptor = TonicInterceptor::Signature(gen_tonic_signature_interceptor()).with_rpc_audience(addr)?;
|
||||
let channel = tokio::time::timeout(connect_timeout, async {
|
||||
match runtime_sources::cached_node_channel(addr).await {
|
||||
Some(channel) => Ok(channel),
|
||||
None => create_new_channel(addr)
|
||||
.await
|
||||
.map_err(|_| CaptureRaftError::ChannelUnavailable),
|
||||
}
|
||||
})
|
||||
.await
|
||||
.map_err(|_| CaptureRaftError::Deadline)??;
|
||||
let audience = interceptor
|
||||
.replay_scope_audience()
|
||||
.ok_or(CaptureRaftError::Authentication)?
|
||||
.to_owned();
|
||||
let authenticated = ReplayScopeChannel::new(channel, Some(audience.clone()));
|
||||
let mut ping = NodeServiceClient::with_interceptor(authenticated.clone(), interceptor)
|
||||
.max_encoding_message_size(1024)
|
||||
.max_decoding_message_size(8192);
|
||||
ping.ping(tonic::Request::new(rustfs_protos::proto_gen::node_service::PingRequest {
|
||||
version: 1,
|
||||
body: bytes::Bytes::new(),
|
||||
}))
|
||||
.await
|
||||
.map_err(|status| CaptureRaftError::Status(Box::new(status)))?;
|
||||
{
|
||||
let peers = PEER_REPLAY_STATES.lock().map_err(|_| CaptureRaftError::Authentication)?;
|
||||
let state = peers.get(&audience).ok_or(CaptureRaftError::Authentication)?;
|
||||
if !matches!(state.cache_capability, Some(PeerReplayCapability::Capable { boot_epoch }) if Some(boot_epoch) == state.boot_epoch)
|
||||
{
|
||||
return Err(CaptureRaftError::Authentication);
|
||||
}
|
||||
}
|
||||
let interceptor = TonicInterceptor::Signature(gen_tonic_signature_interceptor()).with_rpc_audience(addr)?;
|
||||
Ok(
|
||||
rustfs_protos::proto_gen::node_service::capture_raft_service_client::CaptureRaftServiceClient::with_interceptor(
|
||||
authenticated,
|
||||
interceptor,
|
||||
)
|
||||
.max_encoding_message_size(request_max)
|
||||
.max_decoding_message_size(response_max),
|
||||
)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
@@ -580,126 +602,6 @@ mod tests {
|
||||
use tracing_opentelemetry::OpenTelemetrySpanExt;
|
||||
use tracing_subscriber::{Registry, layer::SubscriberExt};
|
||||
|
||||
#[tokio::test]
|
||||
async fn delete_recovery_channel_uses_its_scoped_deadline() {
|
||||
use bytes::Bytes;
|
||||
use http_body_util::StreamBody;
|
||||
use hyper::{body::Frame, service::service_fn};
|
||||
use hyper_util::rt::{TokioExecutor, TokioIo};
|
||||
use rustfs_protos::proto_gen::node_service::{RecoverDeleteTransactionRequest, RecoverDeleteTransactionResponse};
|
||||
use tonic_prost::prost::Message;
|
||||
let listener = tokio::net::TcpListener::bind("127.0.0.1:0")
|
||||
.await
|
||||
.expect("bind recovery peer");
|
||||
let addr = format!("http://{}", listener.local_addr().expect("peer address"));
|
||||
let server = tokio::spawn(async move {
|
||||
loop {
|
||||
let (stream, _) = listener.accept().await.expect("accept recovery connection");
|
||||
tokio::spawn(async move {
|
||||
let service = service_fn(|_request: HttpRequest<hyper::body::Incoming>| async {
|
||||
tokio::time::sleep(std::time::Duration::from_millis(500)).await;
|
||||
let payload = RecoverDeleteTransactionResponse {
|
||||
success: true,
|
||||
protocol_version: 1,
|
||||
result: Bytes::new(),
|
||||
error: None,
|
||||
}
|
||||
.encode_to_vec();
|
||||
let mut data = vec![0];
|
||||
data.extend_from_slice(&u32::try_from(payload.len()).expect("small response").to_be_bytes());
|
||||
data.extend_from_slice(&payload);
|
||||
let mut trailers = http::HeaderMap::new();
|
||||
trailers.insert("grpc-status", "0".parse().expect("status"));
|
||||
let frames: Vec<Result<Frame<Bytes>, std::convert::Infallible>> =
|
||||
vec![Ok(Frame::data(data.into())), Ok(Frame::trailers(trailers))];
|
||||
let mut response = HttpResponse::new(StreamBody::new(futures::stream::iter(frames)));
|
||||
response
|
||||
.headers_mut()
|
||||
.insert("content-type", "application/grpc".parse().expect("content type"));
|
||||
Ok::<_, std::convert::Infallible>(response)
|
||||
});
|
||||
let _ = hyper::server::conn::http2::Builder::new(TokioExecutor::new())
|
||||
.serve_connection(TokioIo::new(stream), service)
|
||||
.await;
|
||||
});
|
||||
}
|
||||
});
|
||||
let request = || RecoverDeleteTransactionRequest {
|
||||
disk: "disk".into(),
|
||||
volume: "bucket".into(),
|
||||
protocol_version: 1,
|
||||
operation: Bytes::new(),
|
||||
};
|
||||
// Seed an existing short-lived control channel to reproduce the inherited deadline.
|
||||
let control = tonic::transport::Endpoint::from_shared(addr.clone())
|
||||
.expect("test endpoint")
|
||||
.timeout(std::time::Duration::from_millis(50))
|
||||
.connect()
|
||||
.await
|
||||
.expect("control connect");
|
||||
rustfs_common::cache_connection(addr.clone(), control).await;
|
||||
let mut foreground = node_service_time_out_client(&addr, TonicInterceptor::NoOp(NoOpInterceptor))
|
||||
.await
|
||||
.expect("control client");
|
||||
let error = foreground
|
||||
.recover_delete_transaction(request())
|
||||
.await
|
||||
.expect_err("short control deadline");
|
||||
assert!(matches!(error.code(), tonic::Code::Cancelled | tonic::Code::DeadlineExceeded));
|
||||
// The 2-second test override bypasses the production range parser, which rejects 2.
|
||||
let mut recovery = node_service_delete_recovery_client(
|
||||
&addr,
|
||||
TonicInterceptor::NoOp(NoOpInterceptor),
|
||||
std::time::Duration::from_secs(2),
|
||||
)
|
||||
.await
|
||||
.expect("scoped recovery client");
|
||||
assert!(
|
||||
recovery
|
||||
.recover_delete_transaction(request())
|
||||
.await
|
||||
.expect("scoped deadline must survive control deadline")
|
||||
.into_inner()
|
||||
.success
|
||||
);
|
||||
server.abort();
|
||||
rustfs_protos::evict_failed_connection(&addr).await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn rpc_client_factories_do_not_reuse_https_channels_without_tls_generation() {
|
||||
let listener = std::net::TcpListener::bind("127.0.0.1:0").expect("reserve local address");
|
||||
let addr = format!("https://{}", listener.local_addr().expect("local address"));
|
||||
drop(listener);
|
||||
for factory in 0..4 {
|
||||
let placeholder = tonic::transport::Endpoint::from_static("http://127.0.0.1:1").connect_lazy();
|
||||
runtime_sources::cache_test_node_channel(addr.clone(), placeholder).await;
|
||||
let interceptor = TonicInterceptor::NoOp(NoOpInterceptor);
|
||||
let _result = match factory {
|
||||
0 => scanner_control_time_out_client(&addr, interceptor)
|
||||
.await
|
||||
.map(|_| ())
|
||||
.map_err(|e| e.to_string()),
|
||||
1 => heal_control_time_out_client(&addr, interceptor)
|
||||
.await
|
||||
.map(|_| ())
|
||||
.map_err(|e| e.to_string()),
|
||||
2 => tier_mutation_control_time_out_client(&addr, interceptor)
|
||||
.await
|
||||
.map(|_| ())
|
||||
.map_err(|e| e.to_string()),
|
||||
_ => node_service_time_out_client(&addr, interceptor)
|
||||
.await
|
||||
.map(|_| ())
|
||||
.map_err(|e| e.to_string()),
|
||||
};
|
||||
assert!(
|
||||
!runtime_sources::test_node_channel_is_cached(&addr).await,
|
||||
"factory {factory} must evict an unbound HTTPS cache entry before attempting a fresh dial"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone)]
|
||||
struct EpochProofService {
|
||||
audience: String,
|
||||
|
||||
@@ -13,6 +13,9 @@
|
||||
// limitations under the License.
|
||||
|
||||
pub(crate) mod background_monitor;
|
||||
pub mod capture_raft;
|
||||
#[cfg(test)]
|
||||
mod capture_raft_tests;
|
||||
pub(crate) mod client;
|
||||
pub(crate) mod context_propagation;
|
||||
pub(crate) mod http_auth;
|
||||
|
||||
@@ -289,9 +289,13 @@ async fn client(
|
||||
>,
|
||||
NetworkPeerProbeError,
|
||||
> {
|
||||
node_service_time_out_client_for_class(address, TonicInterceptor::Signature(gen_tonic_signature_interceptor()), class)
|
||||
.await
|
||||
.map_err(|_| NetworkPeerProbeError::Unreachable)
|
||||
node_service_time_out_client_for_class(
|
||||
&address.to_owned(),
|
||||
TonicInterceptor::Signature(gen_tonic_signature_interceptor()),
|
||||
class,
|
||||
)
|
||||
.await
|
||||
.map_err(|_| NetworkPeerProbeError::Unreachable)
|
||||
}
|
||||
|
||||
fn ping_request(payload: &[u8]) -> PingRequest {
|
||||
@@ -325,24 +329,6 @@ fn map_status(status: tonic::Status) -> NetworkPeerProbeError {
|
||||
match status.code() {
|
||||
Code::Unavailable | Code::Unknown => NetworkPeerProbeError::Unreachable,
|
||||
Code::DeadlineExceeded => NetworkPeerProbeError::TimedOut,
|
||||
Code::Cancelled | Code::Internal => {
|
||||
let mut source = std::error::Error::source(&status);
|
||||
while let Some(error) = source {
|
||||
if error
|
||||
.downcast_ref::<h2::Error>()
|
||||
.is_some_and(|error| matches!(error.reason(), Some(h2::Reason::CANCEL | h2::Reason::NO_ERROR)))
|
||||
{
|
||||
return NetworkPeerProbeError::Unreachable;
|
||||
}
|
||||
source = if let Some(error) = error.downcast_ref::<std::io::Error>() {
|
||||
// io::Error::source skips its immediate custom error.
|
||||
error.get_ref().map(|inner| inner as &(dyn std::error::Error + 'static))
|
||||
} else {
|
||||
error.source()
|
||||
};
|
||||
}
|
||||
NetworkPeerProbeError::ProtocolFailure
|
||||
}
|
||||
_ => NetworkPeerProbeError::ProtocolFailure,
|
||||
}
|
||||
}
|
||||
@@ -353,35 +339,6 @@ mod tests {
|
||||
use crate::layout::endpoint::Endpoint;
|
||||
use crate::layout::endpoints::{Endpoints, PoolEndpoints};
|
||||
|
||||
#[test]
|
||||
fn peer_transport_resets_are_unreachable_without_reclassifying_application_errors() {
|
||||
for reason in [h2::Reason::CANCEL, h2::Reason::NO_ERROR] {
|
||||
let status = tonic::Status::from_error(Box::new(h2::Error::from(reason)));
|
||||
assert!(matches!(status.code(), Code::Cancelled | Code::Internal));
|
||||
let code = status.code();
|
||||
assert_eq!(map_status(status), NetworkPeerProbeError::Unreachable);
|
||||
let mut wrapped = tonic::Status::new(code, "wrapped transport reset");
|
||||
wrapped.set_source(Arc::new(std::io::Error::other(h2::Error::from(reason))));
|
||||
assert_eq!(map_status(wrapped), NetworkPeerProbeError::Unreachable);
|
||||
}
|
||||
for reason in [h2::Reason::PROTOCOL_ERROR, h2::Reason::COMPRESSION_ERROR] {
|
||||
let status = tonic::Status::from_error(Box::new(h2::Error::from(reason)));
|
||||
assert_eq!(map_status(status), NetworkPeerProbeError::ProtocolFailure);
|
||||
}
|
||||
for status in [
|
||||
tonic::Status::cancelled("peer cancelled the application request"),
|
||||
tonic::Status::internal("peer rejected the probe"),
|
||||
tonic::Status::unauthenticated("authentication rejected"),
|
||||
tonic::Status::permission_denied("authorization rejected"),
|
||||
] {
|
||||
assert_eq!(map_status(status), NetworkPeerProbeError::ProtocolFailure);
|
||||
}
|
||||
assert_eq!(
|
||||
map_status(tonic::Status::deadline_exceeded("probe deadline elapsed")),
|
||||
NetworkPeerProbeError::TimedOut
|
||||
);
|
||||
}
|
||||
|
||||
fn pacing(duration: Duration) -> Arc<DiagnosticPacing> {
|
||||
NetworkPeerProbeClient::from_endpoint_pools(&topology())
|
||||
.with_diagnostic_pacing(Instant::now(), duration)
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -449,6 +449,64 @@ where
|
||||
Ok(data)
|
||||
}
|
||||
|
||||
pub(crate) async fn read_config_observation<S>(api: Arc<S>, file: &str, max_bytes: usize) -> Result<(Vec<u8>, ObjectInfo)>
|
||||
where
|
||||
S: EcstoreObjectIO,
|
||||
{
|
||||
let opts = ObjectOptions {
|
||||
suppress_read_repair: true,
|
||||
no_lock: false,
|
||||
skip_verify_bitrot: false,
|
||||
..Default::default()
|
||||
};
|
||||
crate::object_api::without_get_object_body_cache_hook(read_config_limited_preserve_empty_with_metadata_opts(
|
||||
api, file, &opts, max_bytes,
|
||||
))
|
||||
.await
|
||||
}
|
||||
|
||||
pub(crate) async fn read_config_observation_no_lock<S>(
|
||||
api: Arc<S>,
|
||||
file: &str,
|
||||
max_bytes: usize,
|
||||
guard: &crate::object_api::WriteCommitGuard,
|
||||
) -> Result<(Vec<u8>, ObjectInfo)>
|
||||
where
|
||||
S: EcstoreObjectIO,
|
||||
{
|
||||
if !guard.matches(RUSTFS_META_BUCKET, file) {
|
||||
return Err(Error::InvalidArgument(
|
||||
RUSTFS_META_BUCKET.to_owned(),
|
||||
file.to_owned(),
|
||||
"locked observation requires a matching write owner".to_owned(),
|
||||
));
|
||||
}
|
||||
let lock_lost_error = || Error::NamespaceLockQuorumUnavailable {
|
||||
mode: "locked_config_observation",
|
||||
bucket: RUSTFS_META_BUCKET.to_owned(),
|
||||
object: file.to_owned(),
|
||||
required: 1,
|
||||
achieved: 0,
|
||||
};
|
||||
if guard.is_lock_lost() {
|
||||
return Err(lock_lost_error());
|
||||
}
|
||||
let opts = ObjectOptions {
|
||||
suppress_read_repair: true,
|
||||
no_lock: true,
|
||||
skip_verify_bitrot: false,
|
||||
..Default::default()
|
||||
};
|
||||
let result = crate::object_api::without_get_object_body_cache_hook(read_config_limited_preserve_empty_with_metadata_opts(
|
||||
api, file, &opts, max_bytes,
|
||||
))
|
||||
.await;
|
||||
if guard.is_lock_lost() {
|
||||
return Err(lock_lost_error());
|
||||
}
|
||||
result
|
||||
}
|
||||
|
||||
pub(crate) async fn read_config_limited_preserve_empty<S>(api: Arc<S>, file: &str, max_bytes: usize) -> Result<Vec<u8>>
|
||||
where
|
||||
S: EcstoreObjectIO,
|
||||
@@ -495,10 +553,22 @@ pub(crate) async fn read_config_preserve_empty<S>(api: Arc<S>, file: &str) -> Re
|
||||
where
|
||||
S: EcstoreObjectIO,
|
||||
{
|
||||
let (data, _obj) = read_config_with_metadata_inner(api, file, &ObjectOptions::default(), true, None).await?;
|
||||
let (data, _obj) = read_config_preserve_empty_with_metadata_opts(api, file, &ObjectOptions::default()).await?;
|
||||
Ok(data)
|
||||
}
|
||||
|
||||
/// Preserve an empty config payload, its metadata, and caller-supplied read options.
|
||||
pub(crate) async fn read_config_preserve_empty_with_metadata_opts<S>(
|
||||
api: Arc<S>,
|
||||
file: &str,
|
||||
opts: &ObjectOptions,
|
||||
) -> Result<(Vec<u8>, ObjectInfo)>
|
||||
where
|
||||
S: EcstoreObjectIO,
|
||||
{
|
||||
read_config_with_metadata_inner(api, file, opts, true, None).await
|
||||
}
|
||||
|
||||
pub async fn read_config_no_lock<S>(api: Arc<S>, file: &str) -> Result<Vec<u8>>
|
||||
where
|
||||
S: ObjectIO<
|
||||
@@ -527,15 +597,13 @@ pub(crate) async fn read_config_no_lock_preserve_empty_with_metadata<S>(api: Arc
|
||||
where
|
||||
S: EcstoreObjectIO,
|
||||
{
|
||||
read_config_with_metadata_inner(
|
||||
read_config_preserve_empty_with_metadata_opts(
|
||||
api,
|
||||
file,
|
||||
&ObjectOptions {
|
||||
no_lock: true,
|
||||
..Default::default()
|
||||
},
|
||||
true,
|
||||
None,
|
||||
)
|
||||
.await
|
||||
}
|
||||
@@ -2815,9 +2883,10 @@ mod tests {
|
||||
config_task_join_error, configs_semantically_equal, decode_server_config_blob, encode_server_config_blob,
|
||||
heal_config_descriptor, is_standard_object_server_config, lookup_configs, map_system_metadata_write_error,
|
||||
new_and_save_server_config, read_config, read_config_no_lock_preserve_empty_with_metadata, read_config_preserve_empty,
|
||||
read_config_with_metadata, read_config_without_migrate, read_server_config_snapshot, save_config_with_opts_inner,
|
||||
save_server_config, save_server_config_snapshot, save_server_config_snapshot_with_generation,
|
||||
server_config_transaction_lock_path, should_warn_ignored_scalar_section, storage_class_kvs_mut,
|
||||
read_config_preserve_empty_with_metadata_opts, read_config_with_metadata, read_config_without_migrate,
|
||||
read_server_config_snapshot, save_config_with_opts_inner, save_server_config, save_server_config_snapshot,
|
||||
save_server_config_snapshot_with_generation, server_config_transaction_lock_path, should_warn_ignored_scalar_section,
|
||||
storage_class_kvs_mut,
|
||||
};
|
||||
use crate::config::{audit, heal, notify, oidc, scanner};
|
||||
use crate::disk::{RUSTFS_META_BUCKET, endpoint::Endpoint};
|
||||
@@ -5065,6 +5134,7 @@ mod tests {
|
||||
heal_replacement: Option<Vec<u8>>,
|
||||
heal_calls: AtomicUsize,
|
||||
write_calls: AtomicUsize,
|
||||
last_get_no_lock: AtomicBool,
|
||||
last_put_no_lock: AtomicBool,
|
||||
last_put_preconditions: Mutex<Option<HTTPPreconditions>>,
|
||||
revision: AtomicUsize,
|
||||
@@ -5080,6 +5150,7 @@ mod tests {
|
||||
heal_replacement,
|
||||
heal_calls: AtomicUsize::new(0),
|
||||
write_calls: AtomicUsize::new(0),
|
||||
last_get_no_lock: AtomicBool::new(false),
|
||||
last_put_no_lock: AtomicBool::new(false),
|
||||
last_put_preconditions: Mutex::new(None),
|
||||
revision: AtomicUsize::new(1),
|
||||
@@ -5135,8 +5206,9 @@ mod tests {
|
||||
_object: &str,
|
||||
_range: Option<HTTPRangeSpec>,
|
||||
_h: HeaderMap,
|
||||
_opts: &ObjectOptions,
|
||||
opts: &ObjectOptions,
|
||||
) -> Result<GetObjectReader> {
|
||||
self.last_get_no_lock.store(opts.no_lock, Ordering::SeqCst);
|
||||
let data = match &*self.state.lock().expect("state lock poisoned") {
|
||||
RecoveryReadState::Missing => return Err(Error::ConfigNotFound),
|
||||
RecoveryReadState::Blob(data) => data.clone(),
|
||||
@@ -5411,6 +5483,329 @@ mod tests {
|
||||
assert_eq!(store.write_calls.load(Ordering::SeqCst), 0);
|
||||
}
|
||||
|
||||
struct ObservationStream {
|
||||
inner: Cursor<Vec<u8>>,
|
||||
consumed: Arc<AtomicUsize>,
|
||||
fail: bool,
|
||||
eof_gate: Option<(Option<tokio::sync::oneshot::Sender<()>>, tokio::sync::oneshot::Receiver<()>)>,
|
||||
}
|
||||
|
||||
impl AsyncRead for ObservationStream {
|
||||
fn poll_read(mut self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>) -> Poll<std::io::Result<()>> {
|
||||
if self.fail {
|
||||
return Poll::Ready(Err(std::io::Error::other("observation stream failed")));
|
||||
}
|
||||
if self.inner.position() == u64::try_from(self.inner.get_ref().len()).expect("fixture length")
|
||||
&& let Some((ready, release)) = self.eof_gate.as_mut()
|
||||
{
|
||||
if let Some(ready) = ready.take() {
|
||||
ready.send(()).expect("EOF observer remains active");
|
||||
}
|
||||
match std::future::Future::poll(Pin::new(release), cx) {
|
||||
Poll::Pending => return Poll::Pending,
|
||||
Poll::Ready(result) => result.expect("EOF gate released"),
|
||||
}
|
||||
self.eof_gate = None;
|
||||
}
|
||||
let before = buf.filled().len();
|
||||
let result = Pin::new(&mut self.inner).poll_read(cx, buf);
|
||||
self.consumed.fetch_add(buf.filled().len() - before, Ordering::SeqCst);
|
||||
result
|
||||
}
|
||||
}
|
||||
|
||||
struct ObservationStore {
|
||||
body: Vec<u8>,
|
||||
declared_size: i64,
|
||||
error: Option<Error>,
|
||||
stream_error: bool,
|
||||
gets: AtomicUsize,
|
||||
eof_gate: std::sync::Mutex<Option<(Option<tokio::sync::oneshot::Sender<()>>, tokio::sync::oneshot::Receiver<()>)>>,
|
||||
consumed: Arc<AtomicUsize>,
|
||||
options: std::sync::Mutex<Option<(bool, bool, bool)>>,
|
||||
writes: AtomicUsize,
|
||||
}
|
||||
|
||||
impl Debug for ObservationStore {
|
||||
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
|
||||
f.debug_struct("ObservationStore").finish()
|
||||
}
|
||||
}
|
||||
|
||||
impl ObservationStore {
|
||||
fn new(body: Vec<u8>, declared_size: i64) -> Self {
|
||||
Self {
|
||||
body,
|
||||
declared_size,
|
||||
error: None,
|
||||
stream_error: false,
|
||||
gets: AtomicUsize::new(0),
|
||||
eof_gate: std::sync::Mutex::new(None),
|
||||
consumed: Arc::new(AtomicUsize::new(0)),
|
||||
options: std::sync::Mutex::new(None),
|
||||
writes: AtomicUsize::new(0),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl crate::storage_api_contracts::object::ObjectIO for ObservationStore {
|
||||
type Error = Error;
|
||||
type RangeSpec = HTTPRangeSpec;
|
||||
type HeaderMap = HeaderMap;
|
||||
type ObjectOptions = ObjectOptions;
|
||||
type ObjectInfo = ObjectInfo;
|
||||
type GetObjectReader = GetObjectReader;
|
||||
type PutObjectReader = PutObjReader;
|
||||
|
||||
async fn get_object_reader(
|
||||
&self,
|
||||
bucket: &str,
|
||||
object: &str,
|
||||
range: Option<HTTPRangeSpec>,
|
||||
_headers: HeaderMap,
|
||||
opts: &ObjectOptions,
|
||||
) -> Result<GetObjectReader> {
|
||||
assert_eq!(bucket, RUSTFS_META_BUCKET);
|
||||
assert_eq!(object, "config/observation.bin");
|
||||
self.gets.fetch_add(1, Ordering::SeqCst);
|
||||
assert!(range.is_none());
|
||||
*self.options.lock().expect("observation options") =
|
||||
Some((opts.suppress_read_repair, opts.no_lock, opts.skip_verify_bitrot));
|
||||
if let Some(error) = &self.error {
|
||||
return Err(error.clone());
|
||||
}
|
||||
Ok(GetObjectReader {
|
||||
stream: Box::new(ObservationStream {
|
||||
inner: Cursor::new(self.body.clone()),
|
||||
consumed: self.consumed.clone(),
|
||||
fail: self.stream_error,
|
||||
eof_gate: self.eof_gate.lock().expect("EOF gate").take(),
|
||||
}),
|
||||
object_info: ObjectInfo {
|
||||
size: self.declared_size,
|
||||
etag: Some("observation-etag".to_string()),
|
||||
..Default::default()
|
||||
},
|
||||
buffered_body: None,
|
||||
body_source: Default::default(),
|
||||
})
|
||||
}
|
||||
|
||||
async fn put_object(
|
||||
&self,
|
||||
_bucket: &str,
|
||||
_object: &str,
|
||||
_data: &mut PutObjReader,
|
||||
_opts: &ObjectOptions,
|
||||
) -> Result<ObjectInfo> {
|
||||
self.writes.fetch_add(1, Ordering::SeqCst);
|
||||
Err(Error::other("observation must not write"))
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn locked_observation_preserves_options_and_typed_errors() {
|
||||
let object = "config/observation.bin";
|
||||
let manager = Arc::new(rustfs_lock::GlobalLockManager::new());
|
||||
let wrapper = rustfs_lock::NamespaceLockWrapper::new(
|
||||
rustfs_lock::NamespaceLock::with_local_manager("locked-observation-options".to_owned(), manager.clone()),
|
||||
rustfs_lock::ObjectKey::new(RUSTFS_META_BUCKET, object),
|
||||
"locked-observation-options".to_owned(),
|
||||
);
|
||||
let guard = crate::object_api::WriteCommitGuard::acquire(&wrapper, std::time::Duration::from_secs(5))
|
||||
.await
|
||||
.expect("matching real owner");
|
||||
let store = Arc::new(ObservationStore::new(b"raw".to_vec(), 3));
|
||||
let result = super::read_config_observation_no_lock(store.clone(), object, 3, &guard).await;
|
||||
assert_eq!(result.is_ok(), true, "I06L_READ_FLAGS: {result:?}");
|
||||
assert_eq!(
|
||||
*store.options.lock().expect("options") == Some((true, true, false)),
|
||||
true,
|
||||
"I06L_READ_FLAGS"
|
||||
);
|
||||
assert_eq!(result.expect("raw observation").0, b"raw");
|
||||
assert_eq!(store.writes.load(Ordering::SeqCst), 0);
|
||||
for (bucket, key) in [(RUSTFS_META_BUCKET, "config/other.bin"), ("wrong-bucket", object)] {
|
||||
let wrapper = rustfs_lock::NamespaceLockWrapper::new(
|
||||
rustfs_lock::NamespaceLock::with_local_manager("locked-observation-target".to_owned(), manager.clone()),
|
||||
rustfs_lock::ObjectKey::new(bucket, key),
|
||||
"locked-observation-target".to_owned(),
|
||||
);
|
||||
let wrong = crate::object_api::WriteCommitGuard::acquire(&wrapper, std::time::Duration::from_secs(5))
|
||||
.await
|
||||
.expect("wrong-target real owner");
|
||||
let store = Arc::new(ObservationStore::new(Vec::new(), 0));
|
||||
let result = super::read_config_observation_no_lock(store.clone(), object, 8, &wrong).await;
|
||||
assert_eq!(matches!(result, Err(Error::InvalidArgument(..))), true, "I06L_TARGET_REJECTED");
|
||||
assert_eq!(store.gets.load(Ordering::SeqCst) == 0, true, "I06L_TARGET_REJECTED");
|
||||
}
|
||||
for error in [
|
||||
Error::FileNotFound,
|
||||
Error::ObjectNotFound(RUSTFS_META_BUCKET.to_owned(), object.to_owned()),
|
||||
Error::ErasureReadQuorum,
|
||||
] {
|
||||
let expected = if error == Error::FileNotFound || matches!(error, Error::ObjectNotFound(..)) {
|
||||
Error::ConfigNotFound
|
||||
} else {
|
||||
error.clone()
|
||||
};
|
||||
let mut fixture = ObservationStore::new(Vec::new(), 0);
|
||||
fixture.error = Some(error);
|
||||
let store = Arc::new(fixture);
|
||||
assert_eq!(
|
||||
super::read_config_observation_no_lock(store.clone(), object, 8, &guard)
|
||||
.await
|
||||
.expect_err("typed error"),
|
||||
expected
|
||||
);
|
||||
assert_eq!(store.writes.load(Ordering::SeqCst), 0);
|
||||
}
|
||||
let mut fixture = ObservationStore::new(Vec::new(), 0);
|
||||
fixture.stream_error = true;
|
||||
let store = Arc::new(fixture);
|
||||
let err = super::read_config_observation_no_lock(store.clone(), object, 8, &guard)
|
||||
.await
|
||||
.expect_err("stream failure");
|
||||
assert_eq!(err.to_string().contains("observation stream failed"), true, "I06L_TYPED_STREAM_ERROR");
|
||||
assert_eq!(store.writes.load(Ordering::SeqCst), 0);
|
||||
let store = Arc::new(ObservationStore::new(vec![7; 64], 0));
|
||||
let result = super::read_config_observation_no_lock(store.clone(), object, 8, &guard).await;
|
||||
assert_eq!(matches!(result, Err(Error::CorruptedFormat)), true, "I06L_STREAM_BOUND");
|
||||
assert_eq!(store.consumed.load(Ordering::SeqCst) == 9, true, "I06L_STREAM_BOUND");
|
||||
assert_eq!(store.writes.load(Ordering::SeqCst), 0);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn locked_observation_rejects_actual_owner_loss_before_and_after_read() {
|
||||
let object = "config/observation.bin";
|
||||
for after_read in [false, true] {
|
||||
let manager = Arc::new(rustfs_lock::GlobalLockManager::new());
|
||||
let client = Arc::new(RefreshControlledClient::new(manager));
|
||||
let wrapper = rustfs_lock::NamespaceLockWrapper::new(
|
||||
rustfs_lock::NamespaceLock::new("locked-observation-loss".to_owned(), client.clone()),
|
||||
rustfs_lock::ObjectKey::new(RUSTFS_META_BUCKET, object),
|
||||
"locked-observation-loss".to_owned(),
|
||||
);
|
||||
let guard = crate::object_api::WriteCommitGuard::acquire(&wrapper, std::time::Duration::from_secs(5))
|
||||
.await
|
||||
.expect("real distributed owner");
|
||||
let signal = guard.lock_lost_signal().expect("acquired distributed owner signal");
|
||||
let store = Arc::new(ObservationStore::new(b"raw".to_vec(), 3));
|
||||
if after_read {
|
||||
let (ready_tx, ready_rx) = tokio::sync::oneshot::channel();
|
||||
let (release_tx, release_rx) = tokio::sync::oneshot::channel();
|
||||
*store.eof_gate.lock().expect("EOF gate") = Some((Some(ready_tx), release_rx));
|
||||
let mut read = Box::pin(super::read_config_observation_no_lock(store.clone(), object, 3, &guard));
|
||||
tokio::time::timeout(std::time::Duration::from_secs(60), async {
|
||||
tokio::select! {
|
||||
ready = ready_rx => ready.expect("read reached EOF"),
|
||||
result = &mut read => assert_eq!(false, true, "I06L_LOSS_AFTER_READ: returned before EOF gate: {result:?}"),
|
||||
}
|
||||
}).await.expect("EOF watchdog");
|
||||
client.reject_refreshes();
|
||||
tokio::time::timeout(std::time::Duration::from_secs(60), signal.notified())
|
||||
.await
|
||||
.expect("actual owner loss watchdog");
|
||||
assert_eq!(guard.is_lock_lost(), true, "I06L_LOSS_AFTER_READ");
|
||||
release_tx.send(()).expect("release EOF");
|
||||
let result = tokio::time::timeout(std::time::Duration::from_secs(60), read)
|
||||
.await
|
||||
.expect("read watchdog");
|
||||
assert_eq!(
|
||||
matches!(
|
||||
result,
|
||||
Err(Error::NamespaceLockQuorumUnavailable {
|
||||
mode: "locked_config_observation",
|
||||
..
|
||||
})
|
||||
),
|
||||
true,
|
||||
"I06L_LOSS_AFTER_READ"
|
||||
);
|
||||
assert_eq!(store.gets.load(Ordering::SeqCst), 1);
|
||||
} else {
|
||||
client.reject_refreshes();
|
||||
tokio::time::timeout(std::time::Duration::from_secs(60), signal.notified())
|
||||
.await
|
||||
.expect("actual owner loss watchdog");
|
||||
assert_eq!(guard.is_lock_lost(), true, "I06L_LOSS_BEFORE_GET");
|
||||
let result = super::read_config_observation_no_lock(store.clone(), object, 3, &guard).await;
|
||||
assert_eq!(
|
||||
matches!(
|
||||
result,
|
||||
Err(Error::NamespaceLockQuorumUnavailable {
|
||||
mode: "locked_config_observation",
|
||||
..
|
||||
})
|
||||
),
|
||||
true,
|
||||
"I06L_LOSS_BEFORE_GET"
|
||||
);
|
||||
assert_eq!(store.gets.load(Ordering::SeqCst) == 0, true, "I06L_LOSS_BEFORE_GET");
|
||||
}
|
||||
assert_eq!(store.writes.load(Ordering::SeqCst), 0);
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn observation_preserves_options_and_errors() {
|
||||
for body in [Vec::new(), b"raw config".to_vec()] {
|
||||
let store = Arc::new(ObservationStore::new(body.clone(), i64::try_from(body.len()).expect("fixture size")));
|
||||
let result = super::read_config_observation(store.clone(), "config/observation.bin", 32).await;
|
||||
assert!(result.is_ok(), "observation must preserve empty and nonempty objects: {result:?}");
|
||||
let (observed, info) = result.expect("successful observation");
|
||||
assert_eq!(observed, body);
|
||||
assert_eq!(info.etag.as_deref(), Some("observation-etag"));
|
||||
assert_eq!(
|
||||
*store.options.lock().expect("options"),
|
||||
Some((true, false, false)),
|
||||
"I05_REPAIR_SUPPRESSED"
|
||||
);
|
||||
assert_eq!(store.writes.load(Ordering::SeqCst), 0);
|
||||
}
|
||||
for (source, expected) in [
|
||||
(Error::FileNotFound, Error::ConfigNotFound),
|
||||
(
|
||||
Error::ObjectNotFound(RUSTFS_META_BUCKET.to_string(), "config/observation.bin".to_string()),
|
||||
Error::ConfigNotFound,
|
||||
),
|
||||
(Error::ErasureReadQuorum, Error::ErasureReadQuorum),
|
||||
] {
|
||||
let mut fixture = ObservationStore::new(Vec::new(), 0);
|
||||
fixture.error = Some(source);
|
||||
let store = Arc::new(fixture);
|
||||
let result = super::read_config_observation(store.clone(), "config/observation.bin", 32).await;
|
||||
assert_eq!(result.expect_err("read error must propagate"), expected);
|
||||
assert_eq!(store.writes.load(Ordering::SeqCst), 0);
|
||||
}
|
||||
let mut fixture = ObservationStore::new(Vec::new(), 0);
|
||||
fixture.stream_error = true;
|
||||
let store = Arc::new(fixture);
|
||||
let result = super::read_config_observation(store.clone(), "config/observation.bin", 32).await;
|
||||
let error = result.expect_err("stream error must propagate");
|
||||
assert!(error.to_string().contains("observation stream failed"));
|
||||
assert_eq!(store.writes.load(Ordering::SeqCst), 0);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn observation_enforces_byte_limit() {
|
||||
let store = Arc::new(ObservationStore::new(vec![7; 64], 0));
|
||||
let result = super::read_config_observation(store.clone(), "config/observation.bin", 8).await;
|
||||
assert_eq!(result.is_err(), true, "I05_BOUND_ENFORCED");
|
||||
assert_eq!(
|
||||
result.expect_err("bounded observation error"),
|
||||
Error::CorruptedFormat,
|
||||
"I05_BOUND_ENFORCED"
|
||||
);
|
||||
assert_eq!(store.consumed.load(Ordering::SeqCst), 9, "I05_BOUND_ENFORCED: drain exactly limit + 1");
|
||||
let store = Arc::new(ObservationStore::new(vec![7; 8], 8));
|
||||
let result = super::read_config_observation(store.clone(), "config/observation.bin", 8).await;
|
||||
assert!(result.is_ok(), "exact byte limit must succeed: {result:?}");
|
||||
assert_eq!(result.expect("exact limit").0, vec![7; 8]);
|
||||
assert_eq!(store.consumed.load(Ordering::SeqCst), 8);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn read_config_preserve_empty_distinguishes_empty_object() {
|
||||
let store = Arc::new(RecoveryMockStore::new(RecoveryReadState::Blob(Vec::new()), None));
|
||||
@@ -5431,6 +5826,60 @@ mod tests {
|
||||
assert!(data.is_empty());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn read_config_preserve_empty_metadata_keeps_empty_and_options() {
|
||||
let store = Arc::new(RecoveryMockStore::new(RecoveryReadState::Blob(Vec::new()), None));
|
||||
for no_lock in [false, true] {
|
||||
let opts = ObjectOptions {
|
||||
no_lock,
|
||||
..Default::default()
|
||||
};
|
||||
let (data, info) = read_config_preserve_empty_with_metadata_opts(store.clone(), "config/empty.json", &opts)
|
||||
.await
|
||||
.expect("an existing empty config must retain its payload and metadata");
|
||||
assert!(data.is_empty());
|
||||
assert_eq!(info.size, 0);
|
||||
assert_eq!(info.actual_size, 0);
|
||||
assert_eq!(info.etag.as_deref(), Some("config-1"));
|
||||
assert_eq!(info.data_dir, Some(uuid::Uuid::from_u128(1)));
|
||||
assert_eq!(store.last_get_no_lock.load(Ordering::SeqCst), no_lock);
|
||||
}
|
||||
let err = read_config(store, "config/empty.json")
|
||||
.await
|
||||
.expect_err("the existing reader must still treat empty configs as missing");
|
||||
assert!(matches!(err, Error::ConfigNotFound));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn read_config_preserve_empty_metadata_keeps_payload_and_metadata() {
|
||||
let payload = b"original config bytes".to_vec();
|
||||
let store = Arc::new(RecoveryMockStore::new(RecoveryReadState::Blob(payload.clone()), None));
|
||||
let (data, info) =
|
||||
read_config_preserve_empty_with_metadata_opts(store, "config/nonempty.json", &ObjectOptions::default())
|
||||
.await
|
||||
.expect("a nonempty config must retain its payload and metadata");
|
||||
assert_eq!(data, payload);
|
||||
let size = i64::try_from(payload.len()).expect("test payload size fits i64");
|
||||
assert_eq!(info.size, size);
|
||||
assert_eq!(info.actual_size, size);
|
||||
assert_eq!(info.etag.as_deref(), Some("config-1"));
|
||||
assert_eq!(info.data_dir, Some(uuid::Uuid::from_u128(1)));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn read_config_preserve_empty_metadata_preserves_read_errors() {
|
||||
let missing = Arc::new(RecoveryMockStore::new(RecoveryReadState::Missing, None));
|
||||
let err = read_config_preserve_empty_with_metadata_opts(missing, "config/missing.json", &ObjectOptions::default())
|
||||
.await
|
||||
.expect_err("physical absence must remain ConfigNotFound");
|
||||
assert!(matches!(err, Error::ConfigNotFound));
|
||||
let quorum = Arc::new(RecoveryMockStore::new(RecoveryReadState::QuorumError, None));
|
||||
let err = read_config_preserve_empty_with_metadata_opts(quorum, "config/quorum.json", &ObjectOptions::default())
|
||||
.await
|
||||
.expect_err("a quorum failure must retain its typed read error");
|
||||
assert!(matches!(err, Error::ErasureReadQuorum));
|
||||
}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl StorageAdminApi for RecoveryMockStore {
|
||||
type BackendInfo = rustfs_madmin::BackendInfo;
|
||||
|
||||
@@ -72,38 +72,6 @@ type WalkOptions = StorageWalkOptions<fn(&FileInfo) -> bool>;
|
||||
|
||||
const LIST_MULTIPART_SETS_CONCURRENCY: usize = 4;
|
||||
|
||||
#[cfg(test)]
|
||||
type TestSetLockers = HashMap<usize, Vec<Arc<dyn rustfs_lock::LockClient>>>;
|
||||
|
||||
#[cfg(test)]
|
||||
static TEST_SET_LOCKERS: std::sync::LazyLock<std::sync::Mutex<TestSetLockers>> =
|
||||
std::sync::LazyLock::new(|| std::sync::Mutex::new(HashMap::new()));
|
||||
|
||||
/// Keep a fixture's real locker domain scoped to its owning instance.
|
||||
#[cfg(test)]
|
||||
pub(crate) struct ScopedSetLockers(Arc<InstanceContext>);
|
||||
|
||||
#[cfg(test)]
|
||||
impl ScopedSetLockers {
|
||||
pub(crate) fn install(ctx: Arc<InstanceContext>, lockers: Vec<Arc<dyn rustfs_lock::LockClient>>) -> Self {
|
||||
let key = Arc::as_ptr(&ctx) as usize;
|
||||
let mut domains = TEST_SET_LOCKERS.lock().expect("test set lockers mutex");
|
||||
assert!(!domains.contains_key(&key), "the instance already owns a test locker domain");
|
||||
domains.insert(key, lockers);
|
||||
Self(ctx)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
impl Drop for ScopedSetLockers {
|
||||
fn drop(&mut self) {
|
||||
TEST_SET_LOCKERS
|
||||
.lock()
|
||||
.expect("test set lockers mutex")
|
||||
.remove(&(Arc::as_ptr(&self.0) as usize));
|
||||
}
|
||||
}
|
||||
|
||||
fn is_idempotent_delete_prefix_error(err: &Error) -> bool {
|
||||
is_err_object_not_found(err) || is_err_strict_volume_not_found(err)
|
||||
}
|
||||
@@ -305,14 +273,6 @@ impl Sets {
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
let pool_lockers = TEST_SET_LOCKERS
|
||||
.lock()
|
||||
.expect("test set lockers mutex")
|
||||
.get(&(Arc::as_ptr(&instance_ctx) as usize))
|
||||
.cloned()
|
||||
.unwrap_or_else(|| pool_lockers.clone());
|
||||
|
||||
let set_disks = SetDisks::new_with_instance_ctx(
|
||||
runtime_sources::local_node_name().await,
|
||||
Arc::new(RwLock::new(set_drive)),
|
||||
|
||||
@@ -15,9 +15,7 @@
|
||||
use crate::cluster::rpc::{
|
||||
ScannerBucketListing, TonicInterceptor, gen_tonic_signature_interceptor, node_service_time_out_client,
|
||||
};
|
||||
use crate::data_usage::{
|
||||
DATA_USAGE_CACHE_NAME, DATA_USAGE_ROOT, load_admin_data_usage_from_backend_cached as load_server_info_usage_snapshot,
|
||||
};
|
||||
use crate::data_usage::{DATA_USAGE_CACHE_NAME, DATA_USAGE_ROOT, load_data_usage_from_backend_cached};
|
||||
use crate::error::{Error, Result};
|
||||
use crate::{
|
||||
disk::endpoint::{Endpoint, EndpointType},
|
||||
@@ -44,11 +42,7 @@ use std::{
|
||||
use time::OffsetDateTime;
|
||||
use tokio::time::timeout;
|
||||
use tonic::Request;
|
||||
use tracing::{error, trace, warn};
|
||||
|
||||
const EVENT_SERVER_PING: &str = "server_ping";
|
||||
const LOG_COMPONENT_ECSTORE: &str = "ecstore";
|
||||
const LOG_SUBSYSTEM_DIAGNOSTICS: &str = "diagnostics";
|
||||
use tracing::warn;
|
||||
|
||||
use shadow_rs::shadow;
|
||||
|
||||
@@ -163,22 +157,11 @@ async fn is_server_resolvable(endpoint: &Endpoint) -> Result<()> {
|
||||
|
||||
let response: PingResponse = client.ping(request).await?.into_inner();
|
||||
|
||||
if flatbuffers::root::<PingBody>(&response.body).is_err() {
|
||||
error!(
|
||||
event = EVENT_SERVER_PING,
|
||||
component = LOG_COMPONENT_ECSTORE,
|
||||
subsystem = LOG_SUBSYSTEM_DIAGNOSTICS,
|
||||
result = "invalid_response",
|
||||
"Server ping response decoding failed"
|
||||
);
|
||||
let ping_response_body = flatbuffers::root::<PingBody>(&response.body);
|
||||
if let Err(e) = ping_response_body {
|
||||
eprintln!("{e}");
|
||||
} else {
|
||||
trace!(
|
||||
event = EVENT_SERVER_PING,
|
||||
component = LOG_COMPONENT_ECSTORE,
|
||||
subsystem = LOG_SUBSYSTEM_DIAGNOSTICS,
|
||||
result = "success",
|
||||
"Server ping completed"
|
||||
);
|
||||
println!("ping_resp:body(flatbuffer): {ping_response_body:?}");
|
||||
}
|
||||
|
||||
Ok(())
|
||||
@@ -311,7 +294,7 @@ pub async fn get_server_info(get_pools: bool) -> InfoMessage {
|
||||
if let Some(store) = runtime_sources::object_store_handle() {
|
||||
mode = ITEM_ONLINE;
|
||||
apply_data_usage_result(
|
||||
load_server_info_usage_snapshot(store.clone()).await,
|
||||
load_data_usage_from_backend_cached(store.clone()).await,
|
||||
&mut buckets,
|
||||
&mut objects,
|
||||
&mut versions,
|
||||
@@ -984,93 +967,6 @@ mod tests {
|
||||
assert_eq!(usage.size, 6);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[serial]
|
||||
async fn server_info_reads_complete_observation_without_promoting_authority() {
|
||||
use crate::bucket::metadata_sys::test_support::isolated_store_over_temp_disks;
|
||||
use crate::config::com::{read_config, save_config};
|
||||
use crate::data_usage::{
|
||||
DATA_USAGE_OBJ_NAME_PATH, DATA_USAGE_OBSERVED_OBJ_NAME_PATH, invalidate_data_usage_snapshot_cache,
|
||||
load_data_usage_from_backend_cached,
|
||||
};
|
||||
use rustfs_data_usage::{BucketUsageInfo, DataUsageInfo};
|
||||
use std::time::{Duration, SystemTime};
|
||||
|
||||
let (_dirs, store) = isolated_store_over_temp_disks().await;
|
||||
let primary = DataUsageInfo {
|
||||
last_update: Some(SystemTime::UNIX_EPOCH + Duration::from_secs(1)),
|
||||
scanner_epoch: Some(1),
|
||||
usage_snapshot_bootstrap_pending: true,
|
||||
usage_snapshot_converged: Some(false),
|
||||
..Default::default()
|
||||
};
|
||||
let observed = DataUsageInfo {
|
||||
last_update: Some(SystemTime::UNIX_EPOCH + Duration::from_secs(2)),
|
||||
scanner_epoch: Some(1),
|
||||
scanner_cycle: Some(1),
|
||||
buckets_count: 1,
|
||||
objects_total_count: 3,
|
||||
versions_total_count: 4,
|
||||
delete_markers_total_count: 1,
|
||||
objects_total_size: 6,
|
||||
buckets_usage: [(
|
||||
"bucket".to_string(),
|
||||
BucketUsageInfo {
|
||||
objects_count: 3,
|
||||
versions_count: 4,
|
||||
delete_markers_count: 1,
|
||||
size: 6,
|
||||
..Default::default()
|
||||
},
|
||||
)]
|
||||
.into_iter()
|
||||
.collect(),
|
||||
usage_snapshot_complete: true,
|
||||
usage_snapshot_converged: Some(false),
|
||||
usage_snapshot_authoritative_baseline: Some(primary.snapshot_identity()),
|
||||
..Default::default()
|
||||
};
|
||||
let primary_bytes = serde_json::to_vec(&primary).expect("bootstrap should encode");
|
||||
save_config(store.clone(), DATA_USAGE_OBJ_NAME_PATH.as_str(), primary_bytes.clone())
|
||||
.await
|
||||
.expect("bootstrap should persist");
|
||||
save_config(
|
||||
store.clone(),
|
||||
DATA_USAGE_OBSERVED_OBJ_NAME_PATH.as_str(),
|
||||
serde_json::to_vec(&observed).expect("observation should encode"),
|
||||
)
|
||||
.await
|
||||
.expect("observation should persist");
|
||||
invalidate_data_usage_snapshot_cache().await;
|
||||
|
||||
let displayed = super::load_server_info_usage_snapshot(store.clone())
|
||||
.await
|
||||
.expect("server info should load the complete observation");
|
||||
assert_eq!(displayed.usage_snapshot_converged, Some(false));
|
||||
let mut buckets = rustfs_madmin::Buckets::default();
|
||||
let mut objects = rustfs_madmin::Objects::default();
|
||||
let mut versions = rustfs_madmin::Versions::default();
|
||||
let mut delete_markers = rustfs_madmin::DeleteMarkers::default();
|
||||
let mut usage = rustfs_madmin::Usage::default();
|
||||
apply_data_usage_result(Ok(displayed), &mut buckets, &mut objects, &mut versions, &mut delete_markers, &mut usage);
|
||||
assert!(objects.error.is_none());
|
||||
assert_eq!(
|
||||
(buckets.count, objects.count, versions.count, delete_markers.count, usage.size),
|
||||
(1, 3, 4, 1, 6)
|
||||
);
|
||||
let quota = load_data_usage_from_backend_cached(store.clone())
|
||||
.await
|
||||
.expect("quota should retain its bootstrap state");
|
||||
assert!(!quota.is_complete_bucket_usage_snapshot());
|
||||
assert_eq!(
|
||||
read_config(store, DATA_USAGE_OBJ_NAME_PATH.as_str())
|
||||
.await
|
||||
.expect("primary should remain readable"),
|
||||
primary_bytes
|
||||
);
|
||||
invalidate_data_usage_snapshot_cache().await;
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn incomplete_data_usage_is_unavailable_in_server_info() {
|
||||
let mut buckets = rustfs_madmin::Buckets::default();
|
||||
|
||||
@@ -182,7 +182,6 @@ pub(crate) const GET_METADATA_CACHE_REASON_DELETE_MARKER: &str = "delete_marker"
|
||||
pub(crate) const GET_METADATA_CACHE_REASON_DIST_ERASURE: &str = "dist_erasure";
|
||||
pub(crate) const GET_METADATA_CACHE_REASON_INCL_FREE_VERSIONS: &str = "incl_free_versions";
|
||||
pub(crate) const GET_METADATA_CACHE_REASON_INSUFFICIENT_CACHED_QUORUM: &str = "insufficient_cached_quorum";
|
||||
pub(crate) const GET_METADATA_CACHE_REASON_BODY_LAYOUT_REQUIRED: &str = "body_layout_required";
|
||||
pub(crate) const GET_METADATA_CACHE_REASON_META_BUCKET: &str = "meta_bucket";
|
||||
pub(crate) const GET_METADATA_CACHE_REASON_NO_LOCK: &str = "no_lock";
|
||||
pub(crate) const GET_METADATA_CACHE_REASON_NOT_FOUND_OR_EXPIRED: &str = "not_found_or_expired";
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user