risingwave_meta/rpc/election/
dummy.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
// Copyright 2024 RisingWave Labs
//
// 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.

use tokio::sync::watch::{self, Receiver, Sender};

use crate::{ElectionClient, ElectionMember, MetaResult};

/// A dummy implementation of [`ElectionClient`] for scenarios where only one meta node is running,
/// typically for testing purposes such as an in-memory meta store.
///
/// This can be used to unify the code paths no matter there's HA or not.
pub struct DummyElectionClient {
    id: String,

    /// A dummy watcher that never changes, indicating we are always the leader.
    dummy_watcher: Sender<bool>,
}

impl DummyElectionClient {
    pub fn new(id: String) -> Self {
        Self {
            id,
            dummy_watcher: watch::channel(true).0,
        }
    }

    fn self_member(&self) -> ElectionMember {
        ElectionMember {
            id: self.id.clone(),
            is_leader: true,
        }
    }
}

#[async_trait::async_trait]
impl ElectionClient for DummyElectionClient {
    fn id(&self) -> MetaResult<String> {
        Ok(self.id.clone())
    }

    async fn run_once(&self, _ttl: i64, mut stop: Receiver<()>) -> MetaResult<()> {
        // Only exit when the stop signal is received.
        let _ = stop.changed().await;
        Ok(())
    }

    fn subscribe(&self) -> Receiver<bool> {
        self.dummy_watcher.subscribe()
    }

    async fn leader(&self) -> MetaResult<Option<ElectionMember>> {
        Ok(Some(self.self_member()))
    }

    async fn get_members(&self) -> MetaResult<Vec<ElectionMember>> {
        Ok(vec![self.self_member()])
    }

    fn is_leader(&self) -> bool {
        true
    }
}