Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: SNS Gov canister should deserialize to proto Governance, not API Governance #3391

Merged
merged 1 commit into from
Jan 10, 2025
Merged

fix: SNS Gov canister should deserialize to proto Governance, not API Governance #3391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions rs/sns/governance/canister/canister.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ use ic_sns_governance_api::pb::v1::{
GetModeResponse, GetNeuron, GetNeuronResponse, GetProposal, GetProposalResponse,
GetRunningSnsVersionRequest, GetRunningSnsVersionResponse,
GetSnsInitializationParametersRequest, GetSnsInitializationParametersResponse,
GetUpgradeJournalRequest, GetUpgradeJournalResponse, Governance as GovernanceProto,
GetUpgradeJournalRequest, GetUpgradeJournalResponse, Governance as GovernanceApi,
ListNervousSystemFunctionsResponse, ListNeurons, ListNeuronsResponse, ListProposals,
ListProposalsResponse, ManageNeuron, ManageNeuronResponse, NervousSystemParameters,
RewardEvent, SetMode, SetModeResponse,
Expand Down Expand Up @@ -208,11 +208,13 @@ fn caller() -> PrincipalId {
PrincipalId::from(cdk_caller())
}

/// In contrast to canister_init(), this method does not do deserialization.
/// In addition to canister_init, this method is called by canister_post_upgrade.
#[init]
fn canister_init_(init_payload: GovernanceProto) {
fn canister_init(init_payload: GovernanceApi) {
let init_payload = sns_gov_pb::Governance::from(init_payload);
canister_init_(init_payload);
}

fn canister_init_(init_payload: sns_gov_pb::Governance) {
let init_payload = ValidGovernanceProto::try_from(init_payload).expect(
"Cannot start canister, because the deserialized \
GovernanceProto is invalid in some way",
Expand Down Expand Up @@ -277,7 +279,7 @@ fn canister_post_upgrade() {

let reader = BufferedStableMemReader::new(STABLE_MEM_BUFFER_SIZE);

match GovernanceProto::decode(reader) {
match sns_gov_pb::Governance::decode(reader) {
Err(err) => {
log!(
ERROR,
Expand All @@ -304,7 +306,7 @@ fn canister_post_upgrade() {
log!(INFO, "Completed post upgrade");
}

fn populate_finalize_disbursement_timestamp_seconds(governance_proto: &mut GovernanceProto) {
fn populate_finalize_disbursement_timestamp_seconds(governance_proto: &mut sns_gov_pb::Governance) {
for neuron in governance_proto.neurons.values_mut() {
for disbursement in neuron.disburse_maturity_in_progress.iter_mut() {
disbursement.finalize_disbursement_timestamp_seconds = Some(
Expand Down
16 changes: 7 additions & 9 deletions rs/sns/governance/canister/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
use super::*;
use assert_matches::assert_matches;
use candid_parser::utils::{service_equal, CandidSource};
use ic_sns_governance_api::pb::v1::{DisburseMaturityInProgress, Neuron};
use ic_sns_governance::pb::v1::{
governance::{Version, Versions},
upgrade_journal_entry::{Event, UpgradeStepsRefreshed},
DisburseMaturityInProgress, Neuron, UpgradeJournal, UpgradeJournalEntry,
};
use maplit::btreemap;
use pretty_assertions::assert_eq;
use std::collections::HashSet;
Expand Down Expand Up @@ -61,7 +65,7 @@ fn test_set_time_warp() {
fn test_populate_finalize_disbursement_timestamp_seconds() {
// Step 1: prepare a neuron with 2 in progress disbursement, one with
// finalize_disbursement_timestamp_seconds as None, and the other has incorrect timestamp.
let mut governance_proto = GovernanceProto {
let mut governance_proto = sns_gov_pb::Governance {
neurons: btreemap! {
"1".to_string() => Neuron {
disburse_maturity_in_progress: vec![
Expand All @@ -86,7 +90,7 @@ fn test_populate_finalize_disbursement_timestamp_seconds() {
populate_finalize_disbursement_timestamp_seconds(&mut governance_proto);

// Step 3: verifies that both disbursements have the correct finalization timestamps.
let expected_governance_proto = GovernanceProto {
let expected_governance_proto = sns_gov_pb::Governance {
neurons: btreemap! {
"1".to_string() => Neuron {
disburse_maturity_in_progress: vec![
Expand All @@ -111,12 +115,6 @@ fn test_populate_finalize_disbursement_timestamp_seconds() {

#[test]
fn test_upgrade_journal() {
use ic_sns_governance::pb::v1::{
governance::{Version, Versions},
upgrade_journal_entry::{Event, UpgradeStepsRefreshed},
UpgradeJournal, UpgradeJournalEntry,
};

let journal = UpgradeJournal {
entries: vec![UpgradeJournalEntry {
timestamp_seconds: Some(1000),
Expand Down
Loading