Skip to main content

meta_srv/procedure/region_migration/
close_downgraded_region.rs

1// Copyright 2023 Greptime Team
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::any::Any;
16
17use api::v1::meta::MailboxMessage;
18use common_meta::RegionIdent;
19use common_meta::distributed_time_constants::default_distributed_time_constants;
20use common_meta::instruction::{Instruction, InstructionReply, SimpleReply};
21use common_procedure::{Context as ProcedureContext, Status};
22use common_telemetry::tracing_context::TracingContext;
23use common_telemetry::{info, warn};
24use serde::{Deserialize, Serialize};
25use snafu::ResultExt;
26
27use crate::error::{self, Result};
28use crate::handler::HeartbeatMailbox;
29use crate::procedure::region_migration::migration_end::RegionMigrationEnd;
30use crate::procedure::region_migration::{Context, State};
31use crate::procedure::utils::instruction_error_result;
32use crate::service::mailbox::Channel;
33
34#[derive(Debug, Serialize, Deserialize)]
35pub struct CloseDowngradedRegion;
36
37#[async_trait::async_trait]
38#[typetag::serde]
39impl State for CloseDowngradedRegion {
40    async fn next(
41        &mut self,
42        ctx: &mut Context,
43        _procedure_ctx: &ProcedureContext,
44    ) -> Result<(Box<dyn State>, Status)> {
45        if let Err(err) = self.close_downgraded_leader_region(ctx).await {
46            let downgrade_leader_datanode = &ctx.persistent_ctx.from_peer;
47            let region_ids = &ctx.persistent_ctx.region_ids;
48            warn!(err; "Failed to close downgraded leader regions: {region_ids:?} on datanode {:?}", downgrade_leader_datanode);
49        }
50        info!(
51            "Region migration is finished: regions: {:?}, from_peer: {}, to_peer: {}, trigger_reason: {}, {}",
52            ctx.persistent_ctx.region_ids,
53            ctx.persistent_ctx.from_peer,
54            ctx.persistent_ctx.to_peer,
55            ctx.persistent_ctx.trigger_reason,
56            ctx.volatile_ctx.metrics,
57        );
58        Ok((Box::new(RegionMigrationEnd), Status::done()))
59    }
60
61    fn as_any(&self) -> &dyn Any {
62        self
63    }
64}
65
66impl CloseDowngradedRegion {
67    /// Builds close region instruction.
68    ///
69    /// Abort(non-retry):
70    /// - Datanode Table is not found.
71    async fn build_close_region_instruction(&self, ctx: &mut Context) -> Result<Instruction> {
72        let pc = &ctx.persistent_ctx;
73        let downgrade_leader_datanode_id = pc.from_peer.id;
74        let region_ids = &ctx.persistent_ctx.region_ids;
75        let mut idents = Vec::with_capacity(region_ids.len());
76
77        for region_id in region_ids {
78            idents.push(RegionIdent {
79                datanode_id: downgrade_leader_datanode_id,
80                table_id: region_id.table_id(),
81                region_number: region_id.region_number(),
82                // The `engine` field is not used for closing region.
83                engine: String::new(),
84            });
85        }
86
87        Ok(Instruction::CloseRegions(idents))
88    }
89
90    /// Closes the downgraded leader region.
91    async fn close_downgraded_leader_region(&self, ctx: &mut Context) -> Result<()> {
92        let close_instruction = self.build_close_region_instruction(ctx).await?;
93        let region_ids = &ctx.persistent_ctx.region_ids;
94        let pc = &ctx.persistent_ctx;
95        let downgrade_leader_datanode = &pc.from_peer;
96        let tracing_ctx = TracingContext::from_current_span();
97        let msg = MailboxMessage::json_message(
98            &format!("Close downgraded regions: {:?}", region_ids),
99            &format!("Metasrv@{}", ctx.server_addr()),
100            &format!(
101                "Datanode-{}@{}",
102                downgrade_leader_datanode.id, downgrade_leader_datanode.addr
103            ),
104            common_time::util::current_time_millis(),
105            &close_instruction,
106            Some(tracing_ctx.to_w3c()),
107        )
108        .with_context(|_| error::SerializeToJsonSnafu {
109            input: close_instruction.to_string(),
110        })?;
111
112        let ch = Channel::Datanode(downgrade_leader_datanode.id);
113        let receiver = ctx
114            .mailbox
115            .send(&ch, msg, default_distributed_time_constants().region_lease)
116            .await?;
117
118        match receiver.await {
119            Ok(msg) => {
120                let reply = HeartbeatMailbox::json_reply(&msg)?;
121                info!(
122                    "Received close downgraded leade region reply: {:?}, region: {:?}",
123                    reply, region_ids
124                );
125                let InstructionReply::CloseRegions(SimpleReply { result, error }) = reply else {
126                    return error::UnexpectedInstructionReplySnafu {
127                        mailbox_message: msg.to_string(),
128                        reason: "expect close region reply",
129                    }
130                    .fail();
131                };
132
133                if result {
134                    Ok(())
135                } else if let Some(error) = error {
136                    instruction_error_result(
137                        &error,
138                        format!(
139                            "Failed to close downgraded leader region: {region_ids:?} on datanode {:?}, error: {error:?}",
140                            downgrade_leader_datanode,
141                        ),
142                    )
143                } else {
144                    error::UnexpectedSnafu {
145                        violated: format!(
146                            "Failed to close downgraded leader region: {region_ids:?} on datanode {:?}",
147                            downgrade_leader_datanode,
148                        ),
149                    }
150                    .fail()
151                }
152            }
153
154            Err(e) => Err(e),
155        }
156    }
157}