feat(drive): platform version patching and state migrations #1941

shumkov · 2024-07-10T19:27:30Z

Issue being fixed or feature implemented

To be able to recover from chain halt and fix urgent bugs without waiting for protocol version upgrade (which happens only on epoch change), we need to provide a mechanism to apply fixes and modify the corrupted state.

What was done?

Introduced PlatfromVersion patching logic based on protocol version and block height range. PlatfromVersion is a map from the protocol version to the function version. The patching mechanism allows to change of function versions at any specific height.
Introduced state migration logic that allows to call of migration functions at a specific height.

How Has This Been Tested?

Introduced example patches and migrations and running strategy tests with tracing enabled.

Breaking Changes

None

Checklist:

I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have added or updated relevant unit/integration/functional/e2e tests
I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

I have assigned this pull request to a milestone

QuantumExplorer

I feel like I reviewed this too early, maybe it wasn't done, please keep PRs in draft form until ready.

QuantumExplorer · 2024-07-11T00:46:54Z

packages/rs-drive-abci/src/execution/engine/run_block_proposal/v0/mod.rs

+        patch_platform_version(&block_info, platform_version, &mut block_platform_state)?;
+
+        // Perform state migration to fix bugs or support new features
+        self.migrate_state(&block_info, &mut block_platform_state)?;


This should be one call only. We should call it, check_for_chain_halt_hot_fix.

And it should do everything inside.

Migrations aren't only for chain halts. We might want to migrate data for features as well.

QuantumExplorer · 2024-07-11T00:48:02Z

packages/rs-drive-abci/src/execution/platform_events/block_start/migrate_state/mod.rs

@@ -0,0 +1,27 @@
+mod migration_42_example;


This should not be inside the build...

QuantumExplorer · 2024-07-11T00:49:59Z

packages/rs-drive-abci/src/execution/platform_events/block_start/migrate_state/mod.rs

+        match block_info.height {
+            42 => self.migration_42_example(block_info, block_platform_state),
+            52 => self.migration_42_example(block_info, block_platform_state),
+            _ => {}


Why did we leave in examples?

For people so they see how to follow. I will hide it for builds

Removed all test data from the code. Now it's defined in tests

QuantumExplorer · 2024-07-11T00:50:53Z

packages/rs-drive-abci/src/execution/platform_events/block_start/patch_platform_version/mod.rs

+    current_platform_version: &PlatformVersion,
+    block_platform_state: &mut PlatformState,
+) -> Result<(), Error> {
+    // Check if a patch that matches protocol version and block height is already applied


We should be able to apply more than one patch.

More than one patch for the same version? You can.

Per block height

QuantumExplorer · 2024-07-12T15:41:21Z

packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs

@@ -82,11 +85,31 @@ Your software version: {}, latest supported protocol version: {}."#,

            next_platform_version
        } else {
-            // Stay on the last committed platform version
+            // Stay on the last committed plat version


QuantumExplorer · 2024-07-12T15:54:58Z

packages/rs-drive-abci/tests/strategy_tests/patch_platform_tests.rs

+                dbg!(
+                    state
+                        .last_committed_block_info()
+                        .as_ref()
+                        .unwrap()
+                        .basic_info()
+                        .height
+                );


QuantumExplorer · 2024-07-12T15:57:49Z

packages/rs-drive-abci/src/platform_types/platform_state/v0/mod.rs

@@ -42,6 +42,10 @@ pub struct PlatformStateV0 {
    pub current_validator_set_quorum_hash: QuorumHash,
    /// next quorum
    pub next_validator_set_quorum_hash: Option<QuorumHash>,
+    /// This is a clone of current platform version based on


this is not a clone

QuantumExplorer · 2024-07-12T15:59:39Z

packages/rs-drive-abci/src/platform_types/platform_state/patch_platform_version/mod.rs

+static PATCHES: Lazy<HashMap<ProtocolVersion, HeightToPatchRanges>> = Lazy::new(|| {
+    HashMap::from_iter(vec![
+        #[cfg(feature = "test-patch-platform")]
+        {
+            (
+                1,
+                BTreeMap::from_iter(vec![
+                    (5, patch_1_5_test as PatchFn),
+                    (10, patch_1_10_test as PatchFn),
+                ]),
+            )
+        },
+        #[cfg(feature = "test-patch-platform")]
+        {
+            (
+                TEST_PROTOCOL_VERSION_2,
+                BTreeMap::from_iter(vec![(30, patch_2_30_test as PatchFn)]),
+            )
+        },
+    ])
+});


patches should be in versioning crate.

QuantumExplorer · 2024-07-12T16:55:24Z

...drive-abci/src/execution/platform_events/protocol_upgrade/upgrade_protocol_version/v0/mod.rs

-                block_platform_state
-                    .set_current_protocol_version_in_consensus(current_block_protocol_version);


This needs to remain here.

Agreed to move inside if-condition in run_block_proposal to make PlatformState consistent with patching

QuantumExplorer · 2024-07-12T17:09:22Z

packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs

+        // Set current protocol version to the block platform state
+        block_platform_state
+            .set_current_protocol_version_in_consensus(block_platform_version.protocol_version);


move above into condition

QuantumExplorer · 2024-07-12T17:11:18Z

packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs

+        // Patch platform version and run migrations
+        // It modifies the protocol version to function version mapping to apply hotfixes
+        // Also it performs migrations to fix corrupted state or prepare it for new features
+        let block_platform_version = if let Some(patched_platform_version) = self.patch_platform(
+            block_proposal.height,
+            &mut block_platform_state,
+            transaction,
+        )? {
+            patched_platform_version
+        } else {
+            block_platform_version
+        };


I would do an if needed { do things }

We can't do if, because we need to run some logic anyway (clean up patches). Also, we would need to acquire a read lock twice. I renamed the function and updated the comment.

…migrations # Conflicts: # Cargo.lock # packages/rs-platform-version/Cargo.toml # packages/rs-platform-version/src/version/v1.rs

…process

…migrations # Conflicts: # packages/rs-drive-abci/tests/strategy_tests/upgrade_fork_tests.rs # packages/rs-platform-version/src/version/mod.rs

feat(drive): platform version patching and state migrations

be2b0cc

shumkov added this to the v1.0.0 milestone Jul 10, 2024

shumkov requested a review from QuantumExplorer as a code owner July 10, 2024 19:27

shumkov added 3 commits July 11, 2024 02:31

chore: remove duplicate dependency

a4d0988

refactor: unnecessary reference

b45a1db

docs: update field documentation

bbad647

QuantumExplorer requested changes Jul 11, 2024

View reviewed changes

refactor: fix review comments

82dbe71

QuantumExplorer requested changes Jul 12, 2024

View reviewed changes

shumkov and others added 21 commits July 13, 2024 13:57

refactor: move patches to version crate

4e5a790

refactor: rename patch function and move version setting to if condition

3857883

docs: fix comment

386cb65

refactor: remove dbg

90e984b

docs: reword patched_platform_version doc

3fb9e7a

Merge branch 'refs/heads/v1.0-dev' into feat/drive/version-patch-and-…

17c7c72

…migrations # Conflicts: # Cargo.lock # packages/rs-platform-version/Cargo.toml # packages/rs-platform-version/src/version/v1.rs

test: use default_minimal_verifications

a8f2746

chore: add logging to migration function

fc90dac

modifed yaml file for AWS secrets

3c68376

updated workflos to use AWS secrets from github secrets

b23e693

aws login credentials github secrets

dacdf32

added aws account id

9e6312b

configre sccache env

a2e62b7

small fix

b644ac7

fix2

975e57a

fix

eb972df

fix

25eefa8

fix

94bfc42

fix_fin

6cb211b

fic

f7ef6b3

fix

febed5e

vivekgsharma and others added 12 commits July 15, 2024 02:57

printing env varibles to see if aws creds are there during the build …

ffb2607

…process

ci: pass AWS creds to docker build

a9621f3

build: remove aws debug call

127ceae

Changed to github secrets for Rust packages workflows

4d7eb3e

proto fix

f98b441

chore: remove unused once_cell

c0552dc

chore: kick off CI

26cd101

Merge branch 'refs/heads/v1.0-dev' into feat/drive/version-patch-and-…

cb923ac

…migrations # Conflicts: # packages/rs-drive-abci/tests/strategy_tests/upgrade_fork_tests.rs # packages/rs-platform-version/src/version/mod.rs

revert: ci changes

b67c6d0

chore: fix code after merging v1

29e5314

Merge branch 'v1.0-dev' into feat/drive/version-patch-and-migrations

5139ca7

Merge branch 'v1.0-dev' into feat/drive/version-patch-and-migrations

31734aa

QuantumExplorer approved these changes Jul 16, 2024

View reviewed changes

QuantumExplorer merged commit 257be50 into v1.0-dev Jul 16, 2024
75 checks passed

QuantumExplorer deleted the feat/drive/version-patch-and-migrations branch July 16, 2024 14:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(drive): platform version patching and state migrations #1941

feat(drive): platform version patching and state migrations #1941

shumkov commented Jul 10, 2024

QuantumExplorer left a comment

QuantumExplorer Jul 11, 2024

QuantumExplorer Jul 11, 2024

shumkov Jul 11, 2024

QuantumExplorer Jul 11, 2024

shumkov Jul 11, 2024

QuantumExplorer Jul 11, 2024

shumkov Jul 11, 2024

shumkov Jul 13, 2024

QuantumExplorer Jul 11, 2024

shumkov Jul 11, 2024

QuantumExplorer Jul 11, 2024

shumkov Jul 13, 2024

QuantumExplorer Jul 12, 2024

QuantumExplorer Jul 12, 2024

QuantumExplorer Jul 12, 2024

QuantumExplorer Jul 12, 2024

shumkov Jul 13, 2024

QuantumExplorer Jul 12, 2024

shumkov Jul 13, 2024 •

edited

Loading

QuantumExplorer Jul 12, 2024

QuantumExplorer Jul 12, 2024

shumkov Jul 13, 2024 •

edited

Loading

		block_platform_state
		.set_current_protocol_version_in_consensus(current_block_protocol_version);

feat(drive): platform version patching and state migrations #1941

feat(drive): platform version patching and state migrations #1941

Conversation

shumkov commented Jul 10, 2024

Issue being fixed or feature implemented

What was done?

How Has This Been Tested?

Breaking Changes

Checklist:

QuantumExplorer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shumkov Jul 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shumkov Jul 13, 2024 • edited Loading

Choose a reason for hiding this comment

shumkov Jul 13, 2024 •

edited

Loading

shumkov Jul 13, 2024 •

edited

Loading