Skip to content

eat: implement strict migration import version compatibility policy#358

Open
Abidoyesimze wants to merge 19 commits intoRemitwise-Org:mainfrom
Abidoyesimze:feature/migration-version-compatibility-policy
Open

eat: implement strict migration import version compatibility policy#358
Abidoyesimze wants to merge 19 commits intoRemitwise-Org:mainfrom
Abidoyesimze:feature/migration-version-compatibility-policy

Conversation

@Abidoyesimze
Copy link
Copy Markdown

Summary
Introduces an explicit allow/deny policy for data migration imports with deterministic behavior across forward, backward, and unsupported schema versions. Ensures imports fail closed by default and surface precise error classes.
Motivation
Prevent accidental acceptance of unreviewed schema versions
Provide deterministic, auditable import decisions
Make emergency version blocks possible without code changes to logic
What’s changed
Added explicit policy and evaluator in data_migration/src/lib.rs:
Constants: SCHEMA_VERSION, MIN_SUPPORTED_VERSION, ALLOWED_IMPORT_VERSIONS, DENIED_IMPORT_VERSIONS
Enum: VersionCompatibility (Allowed, DeniedByPolicy, UnsupportedLegacy, UnsupportedFuture)
Functions:
evaluate_version_compatibility(version: u32) -> VersionCompatibility
check_version_compatibility(version: u32) -> Result<(), MigrationError>
Import flow validates version before checksum for fast, deterministic failures
Added/expanded unit tests covering policy edges and behavior
Documented policy and security rationale in README.md (Data Migration Import Version Policy section)
Policy decision order

  1. Deny-list match → hard reject
  2. < MIN_SUPPORTED_VERSION → UnsupportedLegacy
  3. SCHEMA_VERSION → UnsupportedFuture

  4. Allow-list match → Allowed
  5. Otherwise → DeniedByPolicy (fail-closed)
    Current policy values
    MIN_SUPPORTED_VERSION = 1
    SCHEMA_VERSION = 1
    ALLOWED_IMPORT_VERSIONS = [1]
    DENIED_IMPORT_VERSIONS = []
    Security considerations
    Default-deny for unknown in-range versions
    Deny-list precedence enables emergency blocks
    Deterministic error classes improve monitoring and incident response
    Version checks run before checksum to short-circuit unsupported snapshots
    Testing
    Unit tests: cargo test -p data_migration
    11 tests, all passing
    Covers checksum round-trip, JSON/binary import, CSV import for goals, forward/backward rejections, deny precedence, and error message stability
    Documentation
    Updated README.md with the import policy, decision order, current constants, and security notes.
    Backward compatibility
    No breaking changes to external contract APIs. Import behavior is now explicitly defined and fail-closed for non-allowed versions.

closes #320

@Baskarayelu
Copy link
Copy Markdown
Contributor

@Abidoyesimze Please resolve the conflicts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implement strict version compatibility policy for imports

2 participants