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
use crate::core::{Reply, Request};
use derive_more::{Display, Error};
use jsonpath_lib as jsonpath;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// Represents an error that can occur when transforming request replyd on
/// prior results from a sequential operation
#[derive(Debug, Display, Error)]
pub enum TransformRequestError {
    RequestToJsonFailed(serde_json::Error),
    JsonToRequestFailed(serde_json::Error),
    #[display(fmt = "{:?}", _0)]
    ExtractingReplyValueFailed(#[error(ignore)] jsonpath::JsonPathError),
    ReplyValueMissing {
        path: String,
    },
    ReplyValueNotScalar {
        path: String,
    },
    #[display(fmt = "{:?}", _0)]
    ReplacementFailed(#[error(ignore)] jsonpath::JsonPathError),
}

/// Represents request that will be transformed at runtime replyd on some
/// prior input
#[derive(JsonSchema, Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct LazilyTransformedRequest {
    /// Represents collection of transformation rules to apply to raw request
    pub rules: Vec<TransformRule>,

    /// Represents request prior to being transformed
    pub raw_request: Request,
}

impl LazilyTransformedRequest {
    pub fn new(raw_request: Request, rules: Vec<TransformRule>) -> Self {
        Self { rules, raw_request }
    }

    /// Converts to the raw request with no transformations applied
    pub fn into_raw_request(self) -> Request {
        self.raw_request
    }

    /// Performs the transformation of request by applying all rules in order
    /// and returning the resulting request
    pub fn transform_with_reply(
        &self,
        reply: &Reply,
    ) -> Result<Request, TransformRequestError> {
        let mut value = serde_json::to_value(&self.raw_request)
            .map_err(TransformRequestError::RequestToJsonFailed)?;
        let reply_value = serde_json::to_value(reply)
            .map_err(TransformRequestError::RequestToJsonFailed)?;

        for rule in self.rules.iter() {
            // For now, we're assuming that the replacement value must be
            // a singular value (not replacing with an array, object, etc)
            let mut new_values = jsonpath::select(&reply_value, &rule.value)
                .map_err(TransformRequestError::ExtractingReplyValueFailed)?;
            if new_values.is_empty() {
                return Err(TransformRequestError::ReplyValueMissing {
                    path: rule.value.clone(),
                });
            } else if new_values.len() > 1 {
                return Err(TransformRequestError::ReplyValueNotScalar {
                    path: rule.value.clone(),
                });
            }
            let new_value = new_values.drain(0..=0).last();

            value = jsonpath::replace_with(value, &rule.path, &mut |_| {
                new_value.cloned()
            })
            .map_err(TransformRequestError::ReplacementFailed)?;
        }

        serde_json::from_value(value)
            .map_err(TransformRequestError::JsonToRequestFailed)
    }
}

impl crate::core::SchemaInfo for LazilyTransformedRequest {}

/// Represents a transformation to apply against some request; uses syntax
/// like JSONPath in that $.field can be used to reference the fields of the
/// objects
#[derive(JsonSchema, Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct TransformRule {
    /// Represents the key (at a JSON level) to transform for some request;
    /// this will be interpolated using $ to represent the root of the current
    /// object (request)
    pub path: String,

    /// Represents the new value to apply to the key; this will be interpolated
    /// replyd on a previous result if present using $ to represent the root
    /// of the previous output request as a JSON object and dot notation for
    /// the nested keys
    pub value: String,
}

impl crate::core::SchemaInfo for TransformRule {}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::core::reply::{CustomArgs, FileOpenedArgs};

    #[test]
    fn transform_with_reply_should_fail_if_rule_value_not_found() {
        let raw_request = Request::ReadFile(Default::default());
        let reply = Reply::FileOpened(FileOpenedArgs {
            id: 123,
            sig: 456,
            ..Default::default()
        });

        let lazy_request = LazilyTransformedRequest {
            raw_request: raw_request.clone(),
            rules: vec![TransformRule {
                // Replace id of raw request
                path: String::from("$.payload.id"),

                // Apply missing field from reply request
                value: String::from("$.payload.missing_field"),
            }],
        };

        match lazy_request.transform_with_reply(&reply) {
            Err(TransformRequestError::ReplyValueMissing { .. }) => (),
            x => panic!("Unexpected request: {:?}", x),
        }
    }

    #[test]
    fn transform_with_reply_should_fail_if_rule_value_not_scalar() {
        let raw_request = Request::ReadFile(Default::default());
        let reply = Reply::Custom(CustomArgs {
            data: vec![0, 1, 2],
        });

        let lazy_request = LazilyTransformedRequest {
            raw_request: raw_request.clone(),
            rules: vec![TransformRule {
                // Replace id of raw request
                path: String::from("$.payload.id"),

                // Apply array data field from reply request
                value: String::from("$.payload.data[*]"),
            }],
        };

        match lazy_request.transform_with_reply(&reply) {
            Err(TransformRequestError::ReplyValueNotScalar { .. }) => (),
            x => panic!("Unexpected request: {:?}", x),
        }
    }

    #[test]
    fn transform_with_reply_should_fail_if_rule_value_not_same_type_as_path() {
        let raw_request = Request::Custom(Default::default());
        let reply = Reply::FileOpened(FileOpenedArgs {
            id: 123,
            sig: 456,
            ..Default::default()
        });

        let lazy_request = LazilyTransformedRequest {
            raw_request: raw_request.clone(),
            rules: vec![TransformRule {
                // Replace data of raw request
                path: String::from("$.payload.data"),

                // Apply id from reply request
                value: String::from("$.payload.id"),
            }],
        };

        match lazy_request.transform_with_reply(&reply) {
            Err(TransformRequestError::JsonToRequestFailed(_)) => (),
            x => panic!("Unexpected request: {:?}", x),
        }
    }

    #[test]
    fn transform_with_reply_should_return_raw_request_if_rule_path_missing() {
        let raw_request = Request::ReadFile(Default::default());
        let reply = Reply::FileOpened(FileOpenedArgs {
            id: 123,
            sig: 456,
            ..Default::default()
        });

        let lazy_request = LazilyTransformedRequest {
            raw_request: raw_request.clone(),
            rules: vec![TransformRule {
                // Replace missing field of raw request
                path: String::from("$.payload.missing_field"),

                // Apply id from reply request
                value: String::from("$.payload.id"),
            }],
        };

        match lazy_request.transform_with_reply(&reply) {
            Ok(request) => {
                assert_eq!(request, raw_request, "Raw request altered")
            }
            x => panic!("Unexpected request: {:?}", x),
        }
    }

    #[test]
    fn transform_with_reply_should_succeed_if_able_to_replace_path_with_value()
    {
        let raw_request = Request::ReadFile(Default::default());
        let reply = Reply::FileOpened(FileOpenedArgs {
            id: 123,
            sig: 456,
            ..Default::default()
        });

        let lazy_request = LazilyTransformedRequest {
            raw_request: raw_request.clone(),
            rules: vec![TransformRule {
                // Replace id of raw request
                path: String::from("$.payload.id"),

                // Apply id from reply request
                value: String::from("$.payload.id"),
            }],
        };

        let transformed_request = lazy_request
            .transform_with_reply(&reply)
            .expect("Failed to transform");

        match transformed_request {
            Request::ReadFile(args) => {
                assert_eq!(args.id, 123);
                assert_ne!(args.sig, 456);
            }
            x => panic!("Unexpected request: {:?}", x),
        }
    }

    #[test]
    fn transform_with_reply_should_apply_rules_in_sequence() {
        let raw_request = Request::ReadFile(Default::default());
        let reply = Reply::FileOpened(FileOpenedArgs {
            id: 123,
            sig: 456,
            ..Default::default()
        });

        let lazy_request = LazilyTransformedRequest {
            raw_request: raw_request.clone(),
            rules: vec![
                TransformRule {
                    // Replace id of raw request
                    path: String::from("$.payload.id"),

                    // Apply id from reply request
                    value: String::from("$.payload.id"),
                },
                TransformRule {
                    // Replace sig of raw request
                    path: String::from("$.payload.sig"),

                    // Apply sig from reply request
                    value: String::from("$.payload.sig"),
                },
            ],
        };

        let transformed_request = lazy_request
            .transform_with_reply(&reply)
            .expect("Failed to transform");

        match transformed_request {
            Request::ReadFile(args) => {
                assert_eq!(args.id, 123);
                assert_eq!(args.sig, 456);
            }
            x => panic!("Unexpected request: {:?}", x),
        }
    }
}