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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
use crate::app::event::Event;
use crate::app::state::{Consumed, SessionHelper, SessionState};
use crate::app::DynError;
use crate::sketchbook::data_structs::{
    ChangeIdData, DatasetData, DatasetMetaData, ObservationData,
};
use crate::sketchbook::event_utils::{
    make_refresh_event, make_reversible, mk_obs_event, mk_obs_state_change,
};
use crate::sketchbook::ids::{DatasetId, ObservationId};
use crate::sketchbook::observations::{Dataset, ObservationManager};
use crate::sketchbook::JsonSerde;

/* Constants for event path segments in `ObservationManager` for datasets and observations. */

// add a new prepared dataset
const ADD_DATASET_PATH: &str = "add";
// add a new default dataset
const ADD_DEFAULT_DATASET_PATH: &str = "add_default";
// load dataset from a specific file
const LOAD_DATASET_PATH: &str = "load";
// remove particular dataset
const REMOVE_DATASET_PATH: &str = "remove";
// set ID of a particular dataset
const SET_DATASET_ID_PATH: &str = "set_id";
// set whole content of a particular dataset
const SET_DATASET_CONTENT_PATH: &str = "set_content";
// set metadata of a particular dataset (name, variables) - does not set observations
const SET_DATASET_METADATA_PATH: &str = "set_metadata";
// remove a particular variable from dataset
const REMOVE_VARIABLE_PATH: &str = "remove_var";
// add variable to a dataset
const ADD_VARIABLE_PATH: &str = "add_var";
// set ID of a particular variable in a dataset
const SET_VARIABLE_ID_PATH: &str = "set_var_id";
// push observation to a dataset
const PUSH_OBS_PATH: &str = "push_obs";
// push empty observation to a dataset
const PUSH_EMPTY_OBS_PATH: &str = "push_empty_obs";
// pop observation from a dataset
const POP_OBS_PATH: &str = "pop_obs";
// refresh all datasets
const GET_ALL_DATASETS_PATH: &str = "get_all_datasets";
// refresh particular dataset
const GET_DATASET_PATH: &str = "get_dataset";
// refresh a given observation of a particular dataset
const GET_OBSERVATION_PATH: &str = "get_observation";

impl SessionHelper for ObservationManager {}

impl SessionState for ObservationManager {
    fn perform_event(&mut self, event: &Event, at_path: &[&str]) -> Result<Consumed, DynError> {
        let component_name = "observations";

        // there is either adding/loading of a new dataset, or modifying/removing an existing one
        // when adding new dataset, the `at_path` is just ["add"], ["add_default"], or ["load"]
        // when editing existing dataset, the `at_path` is ["dataset_id", ...]

        if Self::starts_with(ADD_DEFAULT_DATASET_PATH, at_path).is_some() {
            Self::assert_path_length(at_path, 1, component_name)?;
            self.event_add_default_dataset(event)
        } else if Self::starts_with(ADD_DATASET_PATH, at_path).is_some() {
            Self::assert_path_length(at_path, 1, component_name)?;
            self.event_add_dataset(event)
        } else if Self::starts_with(LOAD_DATASET_PATH, at_path).is_some() {
            Self::assert_path_length(at_path, 1, component_name)?;
            self.event_load_dataset(event)
        } else {
            let dataset_id_str = at_path.first().unwrap();
            let dataset_id = self.get_dataset_id(dataset_id_str)?;
            self.event_modify_dataset(event, &at_path[1..], dataset_id)
        }
    }

    fn refresh(&self, full_path: &[String], at_path: &[&str]) -> Result<Event, DynError> {
        let component_name = "observations";

        // currently three options: get all datasets, a single dataset, a single observation
        match at_path.first() {
            Some(&GET_ALL_DATASETS_PATH) => {
                Self::assert_path_length(at_path, 1, component_name)?;
                let mut dataset_list: Vec<DatasetData> = self
                    .datasets
                    .iter()
                    .map(|(id, dataset)| DatasetData::from_dataset(id, dataset))
                    .collect();
                // return the list sorted, so that it is deterministic
                dataset_list.sort_by(|a, b| a.id.cmp(&b.id));
                make_refresh_event(full_path, dataset_list)
            }
            Some(&GET_DATASET_PATH) => {
                // path specifies dataset's ID
                Self::assert_path_length(at_path, 2, component_name)?;
                let dataset_id_str = at_path[1];

                let dataset_id = self.get_dataset_id(dataset_id_str)?;
                let dataset = self.get_dataset(&dataset_id)?;
                let dataset_data = DatasetData::from_dataset(&dataset_id, dataset);
                let payload = Some(dataset_data.to_json_str());

                let mut path = full_path.to_vec();
                path.pop(); // remove the id from the path

                Ok(Event { path, payload })
            }
            Some(&GET_OBSERVATION_PATH) => {
                // path specifies 1) dataset's ID and 2) observation's ID
                Self::assert_path_length(at_path, 3, component_name)?;
                let dataset_id_str = at_path[1];
                let dataset_id = self.get_dataset_id(dataset_id_str)?;
                let obs_id_str = at_path[2];

                let observation = self.get_obs_by_str(dataset_id_str, obs_id_str)?;
                let obs_data = ObservationData::from_obs(observation, &dataset_id);
                let payload = Some(obs_data.to_json_str());

                let mut path = full_path.to_vec();
                path.truncate(path.len() - 2); // remove the two ids from the path

                Ok(Event { path, payload })
            }
            _ => Self::invalid_path_error_generic(at_path),
        }
    }
}

/// Implementation for events related to modifying `datasets`.
impl ObservationManager {
    /// Perform event of adding a new `dataset` to this `ObservationManager`.
    pub(super) fn event_add_dataset(&mut self, event: &Event) -> Result<Consumed, DynError> {
        let component_name = "observations";

        // get payload components and perform the event
        let payload = Self::clone_payload_str(event, component_name)?;
        let dataset_data = DatasetData::from_json_str(payload.as_str())?;
        let dataset = dataset_data.to_dataset()?;
        self.add_dataset_by_str(&dataset_data.id, dataset)?;

        // prepare the state-change and reverse event (which is a remove event)
        let reverse_event = mk_obs_event(&[&dataset_data.id, "remove"], None);
        Ok(make_reversible(event.clone(), event, reverse_event))
    }

    /// Perform event of adding a new DEFAULT (empty) `dataset` to this `ObservationsManager`.
    pub(super) fn event_add_default_dataset(
        &mut self,
        event: &Event,
    ) -> Result<Consumed, DynError> {
        let component_name = "observations";
        Self::assert_payload_empty(event, component_name)?;

        // generate new ID (and name at the same time), start indexing at 1
        let dataset_id = self.generate_dataset_id("dataset", Some(1));
        let dataset = Dataset::default(dataset_id.as_str());
        let dataset_data = DatasetData::from_dataset(&dataset_id, &dataset);

        self.add_dataset(dataset_id, dataset)?;

        // prepare the state-change and reverse event (which is a remove event)
        let state_change = mk_obs_state_change(&["add"], &dataset_data);
        let reverse_event = mk_obs_event(&[&dataset_data.id, "remove"], None);
        Ok(make_reversible(state_change, event, reverse_event))
    }

    /// Perform event of loading (and adding) new `dataset` to this `ObservationManager`.
    pub(super) fn event_load_dataset(&mut self, event: &Event) -> Result<Consumed, DynError> {
        let component_name = "observations";

        // get the payload - a path to a csv file with dataset
        let file_path = Self::clone_payload_str(event, component_name)?;

        // generate new ID (and name at the same time), start indexing at 1
        let dataset_id: DatasetId = self.generate_dataset_id("dataset", Some(1));
        // load the dataset and add it
        let dataset = Self::load_dataset(dataset_id.as_str(), &file_path)?;
        let dataset_data = DatasetData::from_dataset(&dataset_id, &dataset);
        self.add_dataset_by_str(&dataset_data.id, dataset)?;

        // prepare the state-change event (which sends the loaded dataset to frontend)
        let state_change = mk_obs_state_change(&["load"], &dataset_data);
        // and also prepare the reverse, which is a classical `remove` event
        let reverse_event = mk_obs_event(&[&dataset_data.id, "remove"], None);
        Ok(make_reversible(state_change, event, reverse_event))
    }

    /// Perform event of modifying or removing existing `dataset` component of this
    /// `ObservationManager`.
    pub(super) fn event_modify_dataset(
        &mut self,
        event: &Event,
        at_path: &[&str],
        dataset_id: DatasetId,
    ) -> Result<Consumed, DynError> {
        let component_name = "observations";

        // there are two possible options:
        //     1) modify a dataset directly, with `at_path` being just [<ACTION>]
        //     2) modify a specific observation with `at_path` being ["observation_id", ...]
        // the second option is handled by the dataset instance itself

        match at_path.first() {
            Some(&REMOVE_DATASET_PATH) => {
                Self::assert_payload_empty(event, component_name)?;

                // save the original dataset data for state change and reverse event
                let original_dataset = self.get_dataset(&dataset_id)?.clone();
                let dataset_data = DatasetData::from_dataset(&dataset_id, &original_dataset);

                // perform the event, prepare the state-change variant (move IDs from path to payload)
                self.remove_dataset(&dataset_id)?;
                let state_change = mk_obs_state_change(&["remove"], &dataset_data);

                // prepare the reverse 'add' event (path has no ids, all info carried by payload)
                let payload = dataset_data.to_json_str();
                let reverse_event = mk_obs_event(&["add"], Some(&payload));
                Ok(make_reversible(state_change, event, reverse_event))
            }
            Some(&SET_DATASET_ID_PATH) => {
                // get the payload - string for "new_id"
                let new_id = Self::clone_payload_str(event, component_name)?;
                if dataset_id.as_str() == new_id.as_str() {
                    return Ok(Consumed::NoChange);
                }

                // perform the event, prepare the state-change variant (move id from path to payload)
                self.set_dataset_id_by_str(dataset_id.as_str(), new_id.as_str())?;
                let id_change_data = ChangeIdData::new(dataset_id.as_str(), new_id.as_str());
                let state_change = mk_obs_state_change(&["set_id"], &id_change_data);

                // prepare the reverse event (setting the original ID back)
                let payload = dataset_id.as_str();
                let reverse_event = mk_obs_event(&[new_id.as_str(), "set_id"], Some(payload));
                Ok(make_reversible(state_change, event, reverse_event))
            }
            Some(&SET_DATASET_CONTENT_PATH) => {
                // get the payload - json string encoding a new dataset data
                let payload = Self::clone_payload_str(event, component_name)?;
                let new_dataset_data = DatasetData::from_json_str(&payload)?;
                let new_dataset = new_dataset_data.to_dataset()?;
                let orig_dataset = self.get_dataset(&dataset_id)?;
                if orig_dataset == &new_dataset {
                    return Ok(Consumed::NoChange);
                }

                // perform the event, prepare the state-change variant (move id from path to payload)
                let orig_dataset_data = DatasetData::from_dataset(&dataset_id, orig_dataset);
                self.swap_dataset_content(&dataset_id, new_dataset)?;
                let state_change = mk_obs_state_change(&["set_content"], &new_dataset_data);

                // prepare the reverse event (setting the original ID back)
                let reverse_at_path = [dataset_id.as_str(), "set_content"];
                let payload = orig_dataset_data.to_json_str();
                let reverse_event = mk_obs_event(&reverse_at_path, Some(&payload));
                Ok(make_reversible(state_change, event, reverse_event))
            }
            Some(&SET_DATASET_METADATA_PATH) => {
                // get the payload - json string encoding metadata with (potentially) new name/annotation/variables
                let payload = Self::clone_payload_str(event, component_name)?;
                let new_metadata = DatasetMetaData::from_json_str(&payload)?;
                let orig_dataset = self.get_dataset(&dataset_id)?;
                if orig_dataset.get_name() == new_metadata.name
                    && orig_dataset.get_annotation() == new_metadata.annotation
                    && orig_dataset.variable_names() == new_metadata.variables
                {
                    return Ok(Consumed::NoChange);
                }

                // perform the event, prepare the state-change variant (move id from path to payload)
                let orig_metadata = DatasetMetaData::from_dataset(&dataset_id, orig_dataset);
                self.set_dataset_name(&dataset_id, &new_metadata.name)?;
                self.set_dataset_annot(&dataset_id, &new_metadata.annotation)?;
                let variables = new_metadata.variables.iter().map(|v| v.as_str()).collect();
                self.set_all_variables_by_str(dataset_id.as_str(), variables)?;
                let state_change = mk_obs_state_change(&["set_metadata"], &new_metadata);

                // prepare the reverse event (setting the original ID back)
                let reverse_at_path = [dataset_id.as_str(), "set_metadata"];
                let payload = orig_metadata.to_json_str();
                let reverse_event = mk_obs_event(&reverse_at_path, Some(&payload));
                Ok(make_reversible(state_change, event, reverse_event))
            }
            Some(&REMOVE_VARIABLE_PATH) => {
                // get the payload - string encoding variable ID
                let var_id_str = Self::clone_payload_str(event, component_name)?;

                // perform the event, prepare the state-change variant (move id from path to payload)
                self.remove_var_by_str(dataset_id.as_str(), var_id_str.as_str())?;
                let new_dataset = self.get_dataset(&dataset_id)?;
                let new_dataset_data = DatasetData::from_dataset(&dataset_id, new_dataset);
                let state_change = mk_obs_state_change(&["remove_var"], &new_dataset_data);

                // TODO: make this potentially reversible?
                Ok(Consumed::Irreversible {
                    state_change,
                    reset: true,
                })
            }
            Some(&ADD_VARIABLE_PATH) => {
                Self::assert_payload_empty(event, component_name)?;

                // prepare the placeholder var and add it
                let var_id = self.generate_var_id(&dataset_id, "var", Some(1));
                self.add_var(&dataset_id, var_id)?;

                // prepare the state-change variant (move id from path to payload)
                let new_dataset = self.get_dataset(&dataset_id)?;
                let new_dataset_data = DatasetData::from_dataset(&dataset_id, new_dataset);
                let state_change = mk_obs_state_change(&["add_var"], &new_dataset_data);

                // TODO: make this potentially reversible?
                Ok(Consumed::Irreversible {
                    state_change,
                    reset: true,
                })
            }
            Some(&SET_VARIABLE_ID_PATH) => {
                // get the payload - string for ChangeIdData
                let payload = Self::clone_payload_str(event, component_name)?;
                let id_change_data = ChangeIdData::from_json_str(&payload)?;
                let orig_id = id_change_data.original_id;
                let new_id = id_change_data.new_id;
                if orig_id == new_id {
                    return Ok(Consumed::NoChange);
                }

                // perform the event, prepare the state-change variant (move id from path to payload)
                let orig_dataset = self.get_dataset(&dataset_id)?;
                let orig_metadata = DatasetMetaData::from_dataset(&dataset_id, orig_dataset);
                self.set_var_id_by_str(dataset_id.as_str(), &orig_id, &new_id)?;
                let state_change = mk_obs_state_change(&["set_var_id"], &orig_metadata);

                // prepare the reverse event
                let reverse_at_path = [dataset_id.as_str(), "set_var_id"];
                let payload = ChangeIdData::new(&new_id, &orig_id).to_json_str();
                let reverse_event = mk_obs_event(&reverse_at_path, Some(&payload));
                Ok(make_reversible(state_change, event, reverse_event))
            }
            Some(&PUSH_OBS_PATH) => {
                // Adding particular observation to the end of a specific dataset
                // This is handled by the `Dataset` itself

                // the ID is valid (checked before), we can unwrap
                let dataset = self.datasets.get_mut(&dataset_id).unwrap();
                dataset.event_push_observation(event, dataset_id)
            }
            Some(&PUSH_EMPTY_OBS_PATH) => {
                // Adding new empty observation to the end of a specific dataset
                // This is handled by the `Dataset` itself

                // the ID is valid (checked before), we can unwrap
                let dataset = self.datasets.get_mut(&dataset_id).unwrap();
                dataset.event_push_empty_observation(event, dataset_id)
            }
            Some(&POP_OBS_PATH) => {
                // Removing last observation from the end of a specific dataset
                // This is handled by the `Dataset` itself

                // the ID is valid (checked before), we can unwrap
                let dataset = self.datasets.get_mut(&dataset_id).unwrap();
                dataset.event_pop_observation(event, dataset_id)
            }
            _ => {
                // Finally, remaining events must be some kind of modification of a specific observation
                // The `at_path` must be ["observation_id", <ACTION>]

                // We just extract the particular ID and let the `Dataset` handle it itself
                Self::assert_path_length(at_path, 2, component_name)?;
                let observation_id_str = at_path[0];
                let obs_id = ObservationId::new(observation_id_str)?;
                let action = at_path[1];

                // the ID is valid (checked before), we can unwrap
                let dataset = self.datasets.get_mut(&dataset_id).unwrap();
                dataset.event_modify_observation(event, action, dataset_id, obs_id)
            }
        }
    }
}