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 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// 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 in the LICENSE file at the
// root of this repository, or online 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.
//! Context types for command implementations.
//!
//! The implementation of each command in the [crate::command] module takes exactly
//! one of these context types, depending on whether it requires access to a
//! valid authentication profile and active region.
use std::path::PathBuf;
use std::sync::Arc;
use crate::config_file::ConfigFile;
use crate::error::Error;
use crate::sql_client::{Client as SqlClient, ClientConfig as SqlClientConfig};
use crate::ui::{OutputFormat, OutputFormatter};
use mz_cloud_api::client::cloud_provider::CloudProvider;
use mz_cloud_api::client::region::{Region, RegionInfo};
use mz_cloud_api::client::Client as CloudClient;
use mz_cloud_api::config::{
ClientBuilder as CloudClientBuilder, ClientConfig as CloudClientConfig,
};
use mz_frontegg_client::client::{Authentication, Client as AdminClient};
use mz_frontegg_client::config::{
ClientBuilder as AdminClientBuilder, ClientConfig as AdminClientConfig,
};
use url::{ParseError, Url};
/// Arguments for [`Context::load`].
pub struct ContextLoadArgs {
/// An override for the configuration file path to laod.
///
/// If unspecified, the default configuration file path is used.
pub config_file_path: Option<PathBuf>,
/// The output format to use.
pub output_format: OutputFormat,
/// Whether to suppress color output.
pub no_color: bool,
/// Global optional region.
pub region: Option<String>,
/// Global optional profile.
pub profile: Option<String>,
}
/// Context for a basic command.
#[derive(Clone)]
pub struct Context {
config_file: ConfigFile,
output_formatter: OutputFormatter,
region: Option<String>,
profile: Option<String>,
}
impl Context {
/// Loads the context from the provided arguments.
pub async fn load(
ContextLoadArgs {
config_file_path,
output_format,
no_color,
region,
profile,
}: ContextLoadArgs,
) -> Result<Context, Error> {
let config_file_path = match config_file_path {
None => ConfigFile::default_path()?,
Some(path) => path,
};
let config_file = ConfigFile::load(config_file_path).await?;
Ok(Context {
config_file,
output_formatter: OutputFormatter::new(output_format, no_color),
region,
profile,
})
}
/// Retrieves the admin endpoint from the configuration file.
///
/// - If an admin-endpoint is provided, it uses its value.
/// - If only a cloud-endpoint is provided, it constructs the admin endpoint based on it.
/// - If neither an admin-endpoint nor a cloud-endpoint is provided, default values are used.
pub fn get_admin_endpoint(
&self,
cloud_endpoint: Option<Url>,
admin_endpoint: Option<&str>,
) -> Result<Option<Url>, ParseError> {
if let Some(admin_endpoint) = admin_endpoint {
return Ok(Some(admin_endpoint.parse()?));
} else if let Some(cloud_endpoint) = cloud_endpoint {
let mut admin_endpoint_url = cloud_endpoint;
if let Some(host) = admin_endpoint_url.host_str().as_mut() {
if let Some(host) = host.strip_prefix("api.") {
admin_endpoint_url.set_host(Some(&format!("admin.{}", host)))?;
}
return Ok(Some(admin_endpoint_url));
}
}
Ok(None)
}
/// Returns the global profile option.
pub fn get_global_profile(&self) -> Option<String> {
self.profile.clone()
}
/// Converts this context into a [`ProfileContext`].
///
/// If a profile is not specified, the default profile is activated.
pub fn activate_profile(self) -> Result<ProfileContext, Error> {
let profile_name = self
.profile
.clone()
.unwrap_or_else(|| self.config_file.profile().into());
let config_file = self.config_file.clone();
let profile = config_file.load_profile(&profile_name)?;
// Parse the endpoint form the string in the config to URL.
let cloud_endpoint = match profile.cloud_endpoint() {
Some(endpoint) => Some(endpoint.parse::<Url>()?),
None => None,
};
// Build clients
let mut admin_client_builder = AdminClientBuilder::default();
if let Ok(Some(admin_endpoint)) =
self.get_admin_endpoint(cloud_endpoint.clone(), profile.admin_endpoint())
{
admin_client_builder = admin_client_builder.endpoint(admin_endpoint);
}
let admin_client: Arc<AdminClient> =
Arc::new(admin_client_builder.build(AdminClientConfig {
authentication: Authentication::AppPassword(
profile.app_password(config_file.vault())?.parse()?,
),
}));
let mut cloud_client_builder = CloudClientBuilder::default();
if let Some(cloud_endpoint) = cloud_endpoint {
cloud_client_builder = cloud_client_builder.endpoint(cloud_endpoint);
}
let cloud_client = cloud_client_builder.build(CloudClientConfig {
auth_client: Arc::clone(&admin_client),
});
// The sql client is created here to avoid having to handle the config around. E.g. reading config from config_file
// this happens because profile is 'a static, and adding it to the profile context would make also the context 'a, etc.
let sql_client = SqlClient::new(SqlClientConfig {
app_password: profile.app_password(config_file.vault())?.parse()?,
});
Ok(ProfileContext {
context: self,
profile_name,
admin_client,
cloud_client,
sql_client,
})
}
/// Returns the configuration file loaded by this context.
pub fn config_file(&self) -> &ConfigFile {
&self.config_file
}
/// Returns the output_formatter associated with this context.
pub fn output_formatter(&self) -> &OutputFormatter {
&self.output_formatter
}
}
/// Context for a command that requires a valid authentication profile.
pub struct ProfileContext {
context: Context,
profile_name: String,
admin_client: Arc<AdminClient>,
cloud_client: CloudClient,
sql_client: SqlClient,
}
impl ProfileContext {
/// Loads the profile and returns a region context.
pub fn activate_region(self) -> Result<RegionContext, Error> {
let profile = self
.context
.config_file
.load_profile(&self.profile_name)
.unwrap();
// Region must be lower case.
// Cloud's API response returns the region in
// lower case.
let region_name = self
.context
.region
.clone()
.or(profile.region().map(|r| r.to_string()))
.ok_or_else(|| panic!("no region configured"))
.unwrap()
.to_lowercase();
Ok(RegionContext {
context: self,
region_name,
})
}
/// Returns the admin API client associated with this context.
pub fn admin_client(&self) -> &AdminClient {
&self.admin_client
}
/// Returns the cloud API client associated with this context.
pub fn cloud_client(&self) -> &CloudClient {
&self.cloud_client
}
/// Returns the configuration file loaded by this context.
pub fn config_file(&self) -> &ConfigFile {
&self.context.config_file
}
/// Returns the output_formatter associated with this context.
pub fn output_formatter(&self) -> &OutputFormatter {
&self.context.output_formatter
}
/// Returns the context profile.
/// If a global profile has been set, it will return the global profile.
/// Otherwise returns the config's profile.
pub fn get_profile(&self) -> String {
self.context
.get_global_profile()
.unwrap_or(self.config_file().profile().to_string())
}
}
/// Context for a command that requires a valid authentication profile
/// and an active region.
pub struct RegionContext {
context: ProfileContext,
region_name: String,
}
impl RegionContext {
/// Returns the admin API client associated with this context.
pub fn admin_client(&self) -> &AdminClient {
&self.context.admin_client
}
/// Returns the admin API client associated with this context.
pub fn cloud_client(&self) -> &CloudClient {
&self.context.cloud_client
}
/// Returns a SQL client connected to region associated with this context.
pub fn sql_client(&self) -> &SqlClient {
&self.context.sql_client
}
/// Returns the cloud provider from the profile context.
pub async fn get_cloud_provider(&self) -> Result<CloudProvider, Error> {
let client = &self.context.cloud_client;
let cloud_providers = client.list_cloud_regions().await?;
let provider = cloud_providers
.into_iter()
.find(|x| x.id == self.region_name)
.ok_or(Error::CloudRegionMissing)?;
Ok(provider)
}
/// Returns the cloud provider region of the context.
pub async fn get_region(&self) -> Result<Region, Error> {
let client = self.cloud_client();
let cloud_provider = self.get_cloud_provider().await?;
let region = client.get_region(cloud_provider).await?;
Ok(region)
}
/// Returns the cloud provider region of the context.
pub async fn get_region_info(&self) -> Result<RegionInfo, Error> {
let client = self.cloud_client();
let cloud_provider = self.get_cloud_provider().await?;
let region = client.get_region(cloud_provider).await?;
region.region_info.ok_or_else(|| Error::NotReadyRegion)
}
/// Returns the configuration file loaded by this context.
pub fn config_file(&self) -> &ConfigFile {
self.context.config_file()
}
/// Returns the region profile.
/// As in the context, if a global profile has been set,
/// it will return the global profile.
/// Otherwise returns the config's profile.
pub fn get_profile(&self) -> String {
self.context.get_profile()
}
/// Returns the output_formatter associated with this context.
pub fn output_formatter(&self) -> &OutputFormatter {
self.context.output_formatter()
}
}