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
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.
//! This module implements Materialize cloud API methods
//! to GET, CREATE or DELETE a region.
//! To delete an region correctly make sure to
//! contact support.
//!
//! For a better experience retrieving all the available
//! environments, use [`Client::get_all_regions()`]
use std::time::Duration;
use chrono::{DateTime, Utc};
use reqwest::Method;
use serde::{Deserialize, Deserializer, Serialize};
use crate::client::cloud_provider::CloudProvider;
use crate::client::{Client, Error};
/// A customer region is represented in this structure
#[derive(Debug, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct Region {
/// The connection info and metadata corresponding to this Region
/// may not be set if the region is in the process
/// of being created (see [RegionState] for details)
pub region_info: Option<RegionInfo>,
/// The state of this Region
pub region_state: RegionState,
}
/// Connection details for an active region
#[derive(Debug, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct RegionInfo {
/// Represents the environmentd PG wire protocol address.
///
/// E.g.: 3es24sg5rghjku7josdcs5jd7.eu-west-1.aws.materialize.cloud:6875
pub sql_address: String,
/// Represents the environmentd HTTP address.
///
/// E.g.: 3es24sg5rghjku7josdcs5jd7.eu-west-1.aws.materialize.cloud:443
pub http_address: String,
/// Indicates true if the address is resolvable by DNS.
pub resolvable: bool,
/// The time at which the region was enabled
pub enabled_at: Option<DateTime<Utc>>,
}
/// The state of a customer region
#[derive(Debug, Deserialize, Clone)]
#[serde(rename_all = "kebab-case")]
pub enum RegionState {
/// Enabled region
Enabled,
/// Enablement Pending
/// [region_info][Region::region_info] field will be `null` while the region is in this state
EnablementPending,
/// Deletion Pending
/// [region_info][Region::region_info] field will be `null` while the region is in this state
DeletionPending,
/// Soft deleted; Pending hard deletion
/// [region_info][Region::region_info] field will be `null` while the region is in this state
SoftDeleted,
}
impl Client {
/// Get a customer region in a partciular cloud region for the current user.
pub async fn get_region(&self, provider: CloudProvider) -> Result<Region, Error> {
// Send request to the subdomain
let req = self
.build_region_request(Method::GET, ["api", "region"], None, &provider, Some(1))
.await?;
match self.send_request::<Region>(req).await {
Ok(region) => match region.region_state {
RegionState::SoftDeleted => Err(Error::EmptyRegion),
RegionState::DeletionPending => Err(Error::EmptyRegion),
RegionState::Enabled => Ok(region),
RegionState::EnablementPending => Ok(region),
},
Err(Error::SuccesfullButNoContent) => Err(Error::EmptyRegion),
Err(e) => Err(e),
}
}
/// Get all the available customer regions for the current user.
pub async fn get_all_regions(&self) -> Result<Vec<Region>, Error> {
let cloud_providers: Vec<CloudProvider> = self.list_cloud_regions().await?;
let mut regions: Vec<Region> = vec![];
for cloud_provider in cloud_providers {
match self.get_region(cloud_provider).await {
Ok(region) => {
regions.push(region);
}
// Skip cloud regions with no customer region
Err(Error::EmptyRegion) => {}
Err(e) => return Err(e),
}
}
Ok(regions)
}
/// Creates a customer region in a particular cloud region for the current user
pub async fn create_region(
&self,
version: Option<String>,
environmentd_extra_args: Vec<String>,
cloud_provider: CloudProvider,
) -> Result<Region, Error> {
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
struct Body {
#[serde(skip_serializing_if = "Option::is_none")]
environmentd_image_ref: Option<String>,
#[serde(skip_serializing_if = "Vec::is_empty")]
environmentd_extra_args: Vec<String>,
}
let body = Body {
environmentd_image_ref: version.map(|v| match v.split_once(':') {
None => format!("materialize/environmentd:{v}"),
Some((user, v)) => format!("{user}/environmentd:{v}"),
}),
environmentd_extra_args,
};
let req = self
.build_region_request(
Method::PATCH,
["api", "region"],
None,
&cloud_provider,
Some(1),
)
.await?;
let req = req.json(&body);
// Creating a region can take some time
let req = req.timeout(Duration::from_secs(60));
self.send_request(req).await
}
/// Deletes a customer region in a particular cloud region for the current user.
///
/// Soft deletes by default.
///
/// NOTE that this operation is only available to Materialize employees
/// This operation has a long duration, it can take
/// several minutes to complete.
/// The first few requests will return a 504,
/// indicating that the API is working on the deletion.
/// A request returning a 202 indicates that
/// no region is available to delete (the delete request is complete.)
pub async fn delete_region(
&self,
cloud_provider: CloudProvider,
hard: bool,
) -> Result<(), Error> {
/// A struct that deserializes nothing.
///
/// Useful for deserializing empty response bodies.
struct Empty;
impl<'de> Deserialize<'de> for Empty {
fn deserialize<D>(_: D) -> Result<Empty, D::Error>
where
D: Deserializer<'de>,
{
Ok(Empty)
}
}
let query = if hard {
Some([("hardDelete", "true")].as_slice())
} else {
None
};
// We need to continuously try to delete the environment
// until it succeeds (Status code: 202) or an unexpected error occurs.
let mut loops = 0;
loop {
loops += 1;
let req = self
.build_region_request(
Method::DELETE,
["api", "region"],
query,
&cloud_provider,
Some(1),
)
.await?;
// This timeout corresponds to the same in our cloud services tests.
let req = req.timeout(Duration::from_secs(305));
match self.send_request::<Empty>(req).await {
Ok(_) => break Ok(()), // The request was successful, no environment is available to delete anymore.
Err(Error::Api(err)) => {
if err.status_code != 504 {
// The error was not a timeout (status code 504), so it's unexpected and we should return it
return Err(Error::Api(err));
}
// If the error was a timeout, it means the API is still working on deleting the environment.
}
Err(Error::Transport(e)) => {
if !e.is_timeout() {
return Err(Error::Transport(e));
}
}
// The request failed with a non-API error, so we should return it
Err(e) => return Err(e),
}
// Too many requests/timeouts were reached.
if loops == 10 {
return Err(Error::TimeoutError);
}
}
}
}