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
//! The declaration mistakes of a resource's tenancy, and their wording.
use std::fmt;
/// Why a resource's tenancy cannot scope its rows:
/// [`DeclarationErrorKind::Tenancy`](super::DeclarationErrorKind::Tenancy).
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum TenancyFault {
/// No tenancy declared over a model with a `TenantId` column, which would serve every
/// tenant's rows.
///
/// Declare `Tenancy::column` over that field, or `Tenancy::none()` to serve every tenant.
Undeclared {
/// The model's name.
model: &'static str,
/// The model's tenant columns.
columns: Vec<&'static str>,
},
/// No tenancy declared over a model that belongs to one a mounted resource scopes by tenant,
/// which would serve every tenant's children.
///
/// Declare `Tenancy::via` through that relation, or `Tenancy::none()` to serve every tenant.
UndeclaredChild {
/// The model's name.
model: &'static str,
/// The `belongs_to` relation to the tenant-owned parent.
relation: String,
},
/// No tenancy declared on a panel that acts for tenants: it offers a tenant registration or
/// settings page, or mounts a resource over tenant-owned rows.
///
/// Declare `Tenancy::column` or `Tenancy::via`, or `Tenancy::none()` to serve every tenant.
UndeclaredOnTenantPanel {
/// The model's name.
model: &'static str,
},
/// A `Tenancy::column` lens that names no field of the model.
///
/// Name the model's `TenantId` field, or use `Tenancy::via`.
ColumnNotAField,
/// A `Tenancy::via` lens that names one field of the model.
///
/// Use `Tenancy::column`.
ViaOwnColumn,
/// A `Tenancy::via` lens whose first step is no `belongs_to` relation.
///
/// Start at the relation whose parent holds the tenant.
ViaWithoutBelongsTo,
/// A `Tenancy::via` resource whose form writes the parent's foreign key other than through a
/// relationship field over a tenant-scoped resource of the parent's model.
///
/// Write the key through such a choice, so the write re-checks its tenant.
UnguardedForeignKey {
/// The `belongs_to` relation the lens steps through.
relation: String,
/// The foreign-key columns written another way.
keys: Vec<String>,
},
}
impl fmt::Display for TenancyFault {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Undeclared { model, columns } => write!(
f,
"`{model}` has the tenant column `{}` and the resource declares no tenancy, so \
it would serve every tenant's rows: declare \
`Tenancy::column(lens!({model}.{}))`, or `Tenancy::none()` to serve every \
tenant on purpose",
columns.join("`, `"),
columns.first().copied().unwrap_or_default(),
),
Self::UndeclaredChild { model, relation } => write!(
f,
"`{model}` belongs to `{relation}`, whose rows a tenant-scoped resource serves, \
and the resource declares no tenancy, so it would serve every tenant's rows: \
declare `Tenancy::via({model}::fields().{relation}().<tenant column>())`, or \
`Tenancy::none()` to serve every tenant on purpose"
),
Self::UndeclaredOnTenantPanel { model } => write!(
f,
"the panel acts for tenants and the resource over `{model}` declares no tenancy: \
declare `Tenancy::column` or `Tenancy::via` when its rows belong to a tenant, or \
`Tenancy::none()` to serve every tenant on purpose"
),
Self::ColumnNotAField => f.write_str(
"the `Tenancy::column` lens names no field of the model: name a field typed \
`TenantId`, or use `Tenancy::via` for a tenant reached through a relation",
),
Self::ViaOwnColumn => f.write_str(
"the `Tenancy::via` lens names one field of the model: use `Tenancy::column` for \
the model's own tenant column",
),
Self::ViaWithoutBelongsTo => f.write_str(
"the `Tenancy::via` lens does not start at a `belongs_to` relation: the tenant \
must be the parent's its foreign key names",
),
Self::UnguardedForeignKey { relation, keys } => write!(
f,
"foreign key `{}` is not written through a relationship field over a \
tenant-scoped resource of `{relation}`'s model: the write re-checks only such a \
field's key, so any other could attach the row to another tenant's parent",
keys.join("`, `")
),
}
}
}