Line data Source code
1 : //! Code to manage safekeepers
2 : //!
3 : //! In the local test environment, the data for each safekeeper is stored in
4 : //!
5 : //! ```text
6 : //! .neon/safekeepers/<safekeeper id>
7 : //! ```
8 : use std::io::Write;
9 : use std::path::PathBuf;
10 : use std::{io, result};
11 :
12 : use anyhow::Context;
13 : use camino::Utf8PathBuf;
14 : use postgres_connection::PgConnectionConfig;
15 : use reqwest::{IntoUrl, Method};
16 : use thiserror::Error;
17 : use utils::{http::error::HttpErrorBody, id::NodeId};
18 :
19 : use crate::{
20 : background_process,
21 : local_env::{LocalEnv, SafekeeperConf},
22 : };
23 :
24 0 : #[derive(Error, Debug)]
25 : pub enum SafekeeperHttpError {
26 : #[error("Reqwest error: {0}")]
27 : Transport(#[from] reqwest::Error),
28 :
29 : #[error("Error: {0}")]
30 : Response(String),
31 : }
32 :
33 : type Result<T> = result::Result<T, SafekeeperHttpError>;
34 :
35 : #[async_trait::async_trait]
36 : pub trait ResponseErrorMessageExt: Sized {
37 : async fn error_from_body(self) -> Result<Self>;
38 : }
39 :
40 : #[async_trait::async_trait]
41 : impl ResponseErrorMessageExt for reqwest::Response {
42 0 : async fn error_from_body(self) -> Result<Self> {
43 0 : let status = self.status();
44 0 : if !(status.is_client_error() || status.is_server_error()) {
45 0 : return Ok(self);
46 0 : }
47 0 :
48 0 : // reqwest does not export its error construction utility functions, so let's craft the message ourselves
49 0 : let url = self.url().to_owned();
50 0 : Err(SafekeeperHttpError::Response(
51 0 : match self.json::<HttpErrorBody>().await {
52 0 : Ok(err_body) => format!("Error: {}", err_body.msg),
53 0 : Err(_) => format!("Http error ({}) at {}.", status.as_u16(), url),
54 : },
55 : ))
56 0 : }
57 : }
58 :
59 : //
60 : // Control routines for safekeeper.
61 : //
62 : // Used in CLI and tests.
63 : //
64 0 : #[derive(Debug)]
65 : pub struct SafekeeperNode {
66 : pub id: NodeId,
67 :
68 : pub conf: SafekeeperConf,
69 :
70 : pub pg_connection_config: PgConnectionConfig,
71 : pub env: LocalEnv,
72 : pub http_client: reqwest::Client,
73 : pub http_base_url: String,
74 : }
75 :
76 : impl SafekeeperNode {
77 0 : pub fn from_env(env: &LocalEnv, conf: &SafekeeperConf) -> SafekeeperNode {
78 0 : SafekeeperNode {
79 0 : id: conf.id,
80 0 : conf: conf.clone(),
81 0 : pg_connection_config: Self::safekeeper_connection_config(conf.pg_port),
82 0 : env: env.clone(),
83 0 : http_client: reqwest::Client::new(),
84 0 : http_base_url: format!("http://127.0.0.1:{}/v1", conf.http_port),
85 0 : }
86 0 : }
87 :
88 : /// Construct libpq connection string for connecting to this safekeeper.
89 0 : fn safekeeper_connection_config(port: u16) -> PgConnectionConfig {
90 0 : PgConnectionConfig::new_host_port(url::Host::parse("127.0.0.1").unwrap(), port)
91 0 : }
92 :
93 0 : pub fn datadir_path_by_id(env: &LocalEnv, sk_id: NodeId) -> PathBuf {
94 0 : env.safekeeper_data_dir(&format!("sk{sk_id}"))
95 0 : }
96 :
97 0 : pub fn datadir_path(&self) -> PathBuf {
98 0 : SafekeeperNode::datadir_path_by_id(&self.env, self.id)
99 0 : }
100 :
101 0 : pub fn pid_file(&self) -> Utf8PathBuf {
102 0 : Utf8PathBuf::from_path_buf(self.datadir_path().join("safekeeper.pid"))
103 0 : .expect("non-Unicode path")
104 0 : }
105 :
106 0 : pub async fn start(&self, extra_opts: Vec<String>) -> anyhow::Result<()> {
107 0 : print!(
108 0 : "Starting safekeeper at '{}' in '{}'",
109 0 : self.pg_connection_config.raw_address(),
110 0 : self.datadir_path().display()
111 0 : );
112 0 : io::stdout().flush().unwrap();
113 0 :
114 0 : let listen_pg = format!("127.0.0.1:{}", self.conf.pg_port);
115 0 : let listen_http = format!("127.0.0.1:{}", self.conf.http_port);
116 0 : let id = self.id;
117 0 : let datadir = self.datadir_path();
118 0 :
119 0 : let id_string = id.to_string();
120 0 : // TODO: add availability_zone to the config.
121 0 : // Right now we just specify any value here and use it to check metrics in tests.
122 0 : let availability_zone = format!("sk-{}", id_string);
123 :
124 0 : let mut args = vec![
125 0 : "-D".to_owned(),
126 0 : datadir
127 0 : .to_str()
128 0 : .with_context(|| {
129 0 : format!("Datadir path {datadir:?} cannot be represented as a unicode string")
130 0 : })?
131 0 : .to_owned(),
132 0 : "--id".to_owned(),
133 0 : id_string,
134 0 : "--listen-pg".to_owned(),
135 0 : listen_pg,
136 0 : "--listen-http".to_owned(),
137 0 : listen_http,
138 0 : "--availability-zone".to_owned(),
139 0 : availability_zone,
140 : ];
141 0 : if let Some(pg_tenant_only_port) = self.conf.pg_tenant_only_port {
142 0 : let listen_pg_tenant_only = format!("127.0.0.1:{}", pg_tenant_only_port);
143 0 : args.extend(["--listen-pg-tenant-only".to_owned(), listen_pg_tenant_only]);
144 0 : }
145 0 : if !self.conf.sync {
146 0 : args.push("--no-sync".to_owned());
147 0 : }
148 :
149 0 : let broker_endpoint = format!("{}", self.env.broker.client_url());
150 0 : args.extend(["--broker-endpoint".to_owned(), broker_endpoint]);
151 0 :
152 0 : let mut backup_threads = String::new();
153 0 : if let Some(threads) = self.conf.backup_threads {
154 0 : backup_threads = threads.to_string();
155 0 : args.extend(["--backup-threads".to_owned(), backup_threads]);
156 0 : } else {
157 0 : drop(backup_threads);
158 0 : }
159 :
160 0 : if let Some(ref remote_storage) = self.conf.remote_storage {
161 0 : args.extend(["--remote-storage".to_owned(), remote_storage.clone()]);
162 0 : }
163 :
164 0 : let key_path = self.env.base_data_dir.join("auth_public_key.pem");
165 0 : if self.conf.auth_enabled {
166 0 : let key_path_string = key_path
167 0 : .to_str()
168 0 : .with_context(|| {
169 0 : format!("Key path {key_path:?} cannot be represented as a unicode string")
170 0 : })?
171 0 : .to_owned();
172 0 : args.extend([
173 0 : "--pg-auth-public-key-path".to_owned(),
174 0 : key_path_string.clone(),
175 0 : ]);
176 0 : args.extend([
177 0 : "--pg-tenant-only-auth-public-key-path".to_owned(),
178 0 : key_path_string.clone(),
179 0 : ]);
180 0 : args.extend([
181 0 : "--http-auth-public-key-path".to_owned(),
182 0 : key_path_string.clone(),
183 0 : ]);
184 0 : }
185 :
186 0 : args.extend(extra_opts);
187 0 :
188 0 : background_process::start_process(
189 0 : &format!("safekeeper-{id}"),
190 0 : &datadir,
191 0 : &self.env.safekeeper_bin(),
192 0 : &args,
193 0 : [],
194 0 : background_process::InitialPidFile::Expect(self.pid_file()),
195 0 : || async {
196 0 : match self.check_status().await {
197 0 : Ok(()) => Ok(true),
198 0 : Err(SafekeeperHttpError::Transport(_)) => Ok(false),
199 0 : Err(e) => Err(anyhow::anyhow!("Failed to check node status: {e}")),
200 : }
201 0 : },
202 0 : )
203 0 : .await
204 0 : }
205 :
206 : ///
207 : /// Stop the server.
208 : ///
209 : /// If 'immediate' is true, we use SIGQUIT, killing the process immediately.
210 : /// Otherwise we use SIGTERM, triggering a clean shutdown
211 : ///
212 : /// If the server is not running, returns success
213 : ///
214 0 : pub fn stop(&self, immediate: bool) -> anyhow::Result<()> {
215 0 : background_process::stop_process(
216 0 : immediate,
217 0 : &format!("safekeeper {}", self.id),
218 0 : &self.pid_file(),
219 0 : )
220 0 : }
221 :
222 0 : fn http_request<U: IntoUrl>(&self, method: Method, url: U) -> reqwest::RequestBuilder {
223 0 : // TODO: authentication
224 0 : //if self.env.auth_type == AuthType::NeonJWT {
225 0 : // builder = builder.bearer_auth(&self.env.safekeeper_auth_token)
226 0 : //}
227 0 : self.http_client.request(method, url)
228 0 : }
229 :
230 0 : pub async fn check_status(&self) -> Result<()> {
231 0 : self.http_request(Method::GET, format!("{}/{}", self.http_base_url, "status"))
232 0 : .send()
233 0 : .await?
234 0 : .error_from_body()
235 0 : .await?;
236 0 : Ok(())
237 0 : }
238 : }
|
