stackless-stripe-projects 0.2.0

Stripe Projects CLI driver for stackless
Documentation 
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

//! Stripe Projects errors (neutral `stripe.projects.*` fault codes).

use stackless_core::fault::{ErrorContext, Fault, codes};

#[derive(Debug, thiserror::Error)]
pub enum ProjectsError {
    #[error("the Stripe CLI or its `projects` plugin is unavailable: {detail}")]
    Unavailable { detail: String },

    #[error("Stripe Projects is not authenticated: {detail}")]
    Auth { detail: String },

    #[error("`stripe projects {command}` failed: {detail}")]
    Failed { command: String, detail: String },

    #[error(
        "another stackless process holds the Stripe Projects lock for {definition_dir}: {detail}"
    )]
    LockHeld {
        definition_dir: String,
        detail: String,
    },

    #[error("cannot anchor the stack's Stripe project: {detail}")]
    ProjectAnchor { detail: String },

    #[error("provisioning {resource:?} via Stripe Projects did not complete: {detail}")]
    ProvisionFailed { resource: String, detail: String },

    #[error("the Stripe Projects catalog has no service {reference:?}")]
    CatalogMissing { reference: String },

    #[error("config for {reference:?} does not match the Stripe Projects catalog: {}", violations.join("; "))]
    ConfigSchema {
        reference: &'static str,
        violations: Vec<String>,
    },
}

impl Fault for ProjectsError {
    fn code(&self) -> &'static str {
        match self {
            Self::Unavailable { .. } => codes::STRIPE_PROJECTS_UNAVAILABLE,
            Self::Auth { .. } => codes::STRIPE_PROJECTS_AUTH,
            Self::Failed { .. } => codes::STRIPE_PROJECTS_FAILED,
            Self::LockHeld { .. } => codes::STRIPE_PROJECTS_LOCK_HELD,
            Self::ProjectAnchor { .. } => codes::STRIPE_PROJECT_ANCHOR,
            Self::ProvisionFailed { .. } => codes::STRIPE_PROJECTS_PROVISION_FAILED,
            Self::CatalogMissing { .. } => codes::STRIPE_PROJECTS_CATALOG_MISSING,
            Self::ConfigSchema { .. } => codes::STRIPE_PROJECTS_CONFIG_SCHEMA,
        }
    }

    fn remediation(&self) -> String {
        match self {
            Self::Unavailable { .. } => {
                "install the Stripe CLI (https://docs.stripe.com/stripe-cli), then run \
                 `stripe plugin install projects`"
                    .into()
            }
            Self::Auth { .. } => "run `stripe login`, then re-run `up`".into(),
            Self::Failed { command, .. } => {
                format!(
                    "run `stackless doctor` to see aggregated preflight blockers, or \
                     `stripe projects {command}` by hand, then re-run"
                )
            }
            Self::LockHeld { .. } => {
                "another `stackless up` is provisioning Stripe Projects in this definition dir; \
                 wait for it to finish, then re-run `up`"
                    .into()
            }
            Self::ProjectAnchor { .. } => {
                "ensure the definition dir is writable and `stripe projects status` reports a \
                 linked project, then re-run `up`"
                    .into()
            }
            Self::ProvisionFailed { .. } => {
                "wait a minute for the provider to finish provisioning and re-run `up` to resume"
                    .into()
            }
            Self::CatalogMissing { reference } => {
                let provider = reference
                    .split_once('/')
                    .map(|(p, _)| p)
                    .unwrap_or(reference);
                format!(
                    "run `stripe projects catalog {provider} --json`; the filter token may not \
                     match this provider, or the service may have been renamed or removed"
                )
            }
            Self::ConfigSchema { .. } => {
                "the service's catalog `configuration_schema` changed; update the plugin's typed \
                 config to match (the catalog gap test pins this)"
                    .into()
            }
        }
    }

    fn context(&self) -> ErrorContext {
        ErrorContext::default()
    }
}