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
use crate::{
  payload::{Payload, PayloadInvalidity},
  template::{Template, TemplateInvalidity},
  topic::{Topic, TopicInvalidity},
  validation::ValidateContextExt,
};
use semval::{context::Context, Validate, ValidationResult};
use serde::{Deserialize, Serialize};

/// When availability is configured, this controls the conditions needed to set the entity to available.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
pub enum AvailabilityMode {
  /// If set to all, `payload_available` must be received on all configured availability topics before the entity is marked as online.
  #[serde(rename = "all")]
  All,

  /// If set to any, `payload_available` must be received on at least one configured availability topic before the entity is marked as online.
  #[serde(rename = "any")]
  Any,

  /// If set to latest, the last `payload_available` or `payload_not_available` received on any configured availability topic controls the availability.
  ///
  /// This is the default mode if not specified.
  #[serde(rename = "latest")]
  Latest,
}

impl AvailabilityMode {
  #[inline]
  pub const fn is_default(&self) -> bool {
    matches!(self, Self::Latest)
  }
}

impl Default for AvailabilityMode {
  #[inline]
  fn default() -> Self {
    Self::Latest
  }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Availability<'a> {
  /// An MQTT topic subscribed to receive availability (online/offline) updates.
  #[serde(borrow)]
  pub topic: Topic<'a>,

  /// The payload that represents the available state.
  ///
  /// The default (used if `None`) is `online`.
  #[serde(borrow, default, skip_serializing_if = "Option::is_none")]
  pub payload_available: Option<Payload<'a>>,

  /// The payload that represents the unavailable state.
  ///
  /// The default (used if `None`) is `offline`.
  #[serde(borrow, default, skip_serializing_if = "Option::is_none")]
  pub payload_not_available: Option<Payload<'a>>,

  /// Defines a template to extract device’s availability from the topic.
  ///
  /// To determine the devices’s availability result of this template
  /// will be compared to payload_available and payload_not_available.
  #[serde(borrow, default, skip_serializing_if = "Option::is_none")]
  pub value_template: Option<Template<'a>>,
}

impl<'a> Availability<'a> {
  pub fn new(topic: impl Into<Topic<'a>>) -> Self {
    Self {
      topic: topic.into(),
      payload_available: None,
      payload_not_available: None,
      value_template: None,
    }
  }

  pub fn new_with_payloads(
    topic: impl Into<Topic<'a>>,
    available_payload: impl Into<Payload<'a>>,
    not_available_payload: impl Into<Payload<'a>>,
  ) -> Self {
    Self {
      topic: topic.into(),
      payload_available: Some(available_payload.into()),
      payload_not_available: Some(not_available_payload.into()),
      value_template: None,
    }
  }
}

#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum AvailabilityDataInvalidity {
  Topic(TopicInvalidity),
  PayloadAvailable(PayloadInvalidity),
  PayloadNotAvailable(PayloadInvalidity),
  ValueTemplate(TemplateInvalidity),
}

impl<'a> Validate for Availability<'a> {
  type Invalidity = AvailabilityDataInvalidity;

  fn validate(&self) -> ValidationResult<Self::Invalidity> {
    Context::new()
      .validate_with(&self.topic, AvailabilityDataInvalidity::Topic)
      .validate_with_opt(
        &self.payload_available,
        AvailabilityDataInvalidity::PayloadAvailable,
      )
      .validate_with_opt(
        &self.payload_not_available,
        AvailabilityDataInvalidity::PayloadNotAvailable,
      )
      .validate_with_opt(
        &self.value_template,
        AvailabilityDataInvalidity::ValueTemplate,
      )
      .into()
  }
}

#[cfg(test)]
mod tests {
  use super::*;
  use assert_matches::assert_matches;
  use nameof::{name_of, name_of_type};
  use serde_test::{assert_tokens, Token};
  use std::borrow::Cow;

  #[test]
  fn no_payloads() {
    assert_tokens(
      &Availability {
        topic: Topic(Cow::Borrowed("the/topic")),
        payload_available: None,
        payload_not_available: None,
        value_template: None,
      },
      &[
        Token::Struct {
          name: name_of_type!(Availability),
          len: 1,
        },
        Token::Str(name_of!(topic in Availability)),
        Token::Str("the/topic"),
        Token::StructEnd,
      ],
    )
  }

  #[test]
  fn with_payloads() {
    assert_tokens(
      &Availability {
        topic: Topic(Cow::Borrowed("the/topic")),
        payload_available: Some(Payload(Cow::Borrowed("available"))),
        payload_not_available: Some(Payload(Cow::Borrowed("not_available"))),
        value_template: Some(Template(Cow::Borrowed("{{value}}"))),
      },
      &[
        Token::Struct {
          name: name_of_type!(Availability),
          len: 4,
        },
        Token::Str(name_of!(topic in Availability)),
        Token::Str("the/topic"),
        Token::Str(name_of!(payload_available in Availability)),
        Token::Some,
        Token::Str("available"),
        Token::Str(name_of!(payload_not_available in Availability)),
        Token::Some,
        Token::Str("not_available"),
        Token::Str(name_of!(value_template in Availability)),
        Token::Some,
        Token::Str("{{value}}"),
        Token::StructEnd,
      ],
    )
  }

  #[test]
  fn deserialize_json_borrows() {
    let json = r##"{"topic":"the/topic"}"##;
    let availability: Availability = serde_json::from_str(json).expect("should parse");
    assert_matches!(availability.topic, Topic(Cow::Borrowed(_)));
  }

  #[test]
  fn invalid_payload_available_is_invalid() {
    let err: Vec<_> = Availability {
      topic: Topic::from("topic"),
      payload_available: Some(Payload::from("")),
      payload_not_available: None,
      value_template: None,
    }
    .validate()
    .expect_err("should be invalid")
    .into_iter()
    .collect();

    assert_eq!(
      &*err,
      &[AvailabilityDataInvalidity::PayloadAvailable(
        PayloadInvalidity::Empty
      )]
    )
  }

  #[test]
  fn invalid_payload_not_available_is_invalid() {
    let err: Vec<_> = Availability {
      topic: Topic::from("topic"),
      payload_available: None,
      payload_not_available: Some(Payload::from("")),
      value_template: None,
    }
    .validate()
    .expect_err("should be invalid")
    .into_iter()
    .collect();

    assert_eq!(
      &*err,
      &[AvailabilityDataInvalidity::PayloadNotAvailable(
        PayloadInvalidity::Empty
      )]
    )
  }

  #[test]
  fn invalid_topic_is_invalid() {
    let err: Vec<_> = Availability {
      topic: Topic::from(""),
      payload_available: None,
      payload_not_available: None,
      value_template: None,
    }
    .validate()
    .expect_err("should be invalid")
    .into_iter()
    .collect();

    assert_eq!(
      &*err,
      &[AvailabilityDataInvalidity::Topic(TopicInvalidity::Empty)]
    )
  }
}