printnanny-services 0.33.1

Library of MQTT, API, and other services used by PrintNanny
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
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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
use log::{debug, error, info, warn};
use printnanny_settings::vcs::VersionControlledSettings;
use std::collections::HashMap;
use std::fs::File;
use std::future::Future;
use std::io::BufReader;
use std::path::{Path, PathBuf};

use chrono::{ Utc};
use serde;
use serde_json;
use tokio::fs;

// settings modules
use printnanny_settings::error::PrintNannySettingsError;
use printnanny_settings::printnanny::{PrintNannyApiConfig, PrintNannySettings};
use printnanny_settings::sys_info;

use printnanny_api_client::apis::accounts_api;
use printnanny_api_client::apis::configuration::Configuration as ReqwestConfig;
use printnanny_api_client::apis::crash_reports_api;
use printnanny_api_client::apis::devices_api;
use printnanny_api_client::apis::octoprint_api;
use printnanny_api_client::apis::videos_api;
use printnanny_api_client::models;

use printnanny_edge_db::diesel;

use printnanny_gst_pipelines::factory::PrintNannyPipelineFactory;

use crate::cpuinfo::RpiCpuInfo;
use crate::crash_report::write_crash_report_zip;
use crate::error::{ServiceError, VideoRecordingUpdateOrCreateError};
use crate::file::open;
use crate::metadata;
use crate::os_release::OsRelease;

#[derive(Debug, Clone)]
pub struct ApiService {
    pub sqlite_connection: String,
    pub api_config: PrintNannyApiConfig,
    pub pi: Option<models::Pi>,
    pub user: Option<models::User>,
}

pub fn read_model_json<T: serde::de::DeserializeOwned>(path: &Path) -> Result<T, std::io::Error> {
    let file = open(path)?;
    let reader = BufReader::new(file);
    let result: T = serde_json::from_reader(reader)?;
    Ok(result)
}

pub fn save_model_json<T: serde::Serialize>(model: &T, path: &Path) -> Result<(), std::io::Error> {
    serde_json::to_writer(&File::create(path)?, model)?;
    Ok(())
}

impl ApiService {
    // config priority:
    // args >> api_config.json >> anonymous api usage only
    pub fn new(api_config: PrintNannyApiConfig, sqlite_connection: String) -> Self {
        Self {
            api_config,
            sqlite_connection,
            pi: None,
            user: None,
        }
    }

    fn reqwest_config(&self) -> ReqwestConfig {
        ReqwestConfig {
            base_path: self.api_config.api_base_path.clone(),
            bearer_access_token: self.api_config.api_bearer_access_token.clone(),
            ..ReqwestConfig::default()
        }
    }

    pub async fn connect_cloud_account(
        mut self,
        api_base_path: String,
        api_bearer_access_token: String,
    ) -> Result<Self, ServiceError> {
        let mut settings = PrintNannySettings::new().await?;

        info!("Updated printnanny_cloud_api_config sqlite record");
        let api_bearer_access_token = Some(api_bearer_access_token);
        if self.api_config.api_bearer_access_token != api_bearer_access_token {
            self.api_config.api_base_path = api_base_path.clone();
            self.api_config.api_bearer_access_token = api_bearer_access_token.clone();
            warn!("connect_cloud_account saving new api_bearer_access_token");
            settings.cloud.api_base_path = api_base_path;
            settings.cloud.api_bearer_access_token = api_bearer_access_token;
            let content = settings.to_toml_string()?;
            settings
                .save_and_commit(
                    &content,
                    Some("Updated PrintNanny Cloud API auth".to_string()),
                )
                .await?;
        }

        // sync data models
        self.sync().await?;
        let pi_id = printnanny_edge_db::cloud::Pi::get_id(&self.sqlite_connection)?;

        // refresh NATS nkey credentials
        self.refresh_nats_creds().await?;

        // mark setup complete
        let req = models::PatchedPiRequest {
            setup_finished: Some(true),
            // None values are skipped by serde serializer
            sbc: None,
            hostname: None,
            favorite: None,
        };
        self.pi_partial_update(pi_id, req).await?;
        Ok(self)
    }

    pub async fn refresh_nats_creds(&self) -> Result<(), ServiceError> {
        let pi_id = printnanny_edge_db::cloud::Pi::get_id(&self.sqlite_connection)?;
        self.pi_download_license(pi_id, false).await?;
        Ok(())
    }

    pub async fn crash_report_create(
        &self,
        description: Option<&str>,
        email: Option<&str>,
        browser_version: Option<&str>,
        browser_logs: Option<PathBuf>,
        status: Option<models::CrashReportStatusEnum>,
        posthog_session: Option<&str>,
        crash_report_paths: Vec<PathBuf>,
    ) -> Result<models::CrashReport, ServiceError> {
        let file = tempfile::Builder::new()
            .prefix("crash-report")
            .suffix(".zip")
            .rand_bytes(6)
            .tempfile()?;
        let (file, filename) = &file.keep()?;

        write_crash_report_zip(file, crash_report_paths).await?;
        warn!("Wrote crash report logs to {}", filename.display());

        let serial = match RpiCpuInfo::new() {
            Ok(rpi_cpuinfo) => rpi_cpuinfo.serial,
            Err(e) => {
                error!("Failed to read RpiCpuInfo with error={}", e);
                None
            }
        };

        let os_release = OsRelease::new()?;

        let pi = self.pi.as_ref().map(|pi| pi.id);
        let result = crash_reports_api::crash_reports_create(
            &self.reqwest_config(),
            description,
            email,
            Some(&os_release.version),
            Some(filename.to_path_buf()),
            browser_version,
            browser_logs,
            serial.as_deref(),
            posthog_session,
            status,
            None,
            pi,
        )
        .await?;
        warn!("Finished uploading {}, removing file", filename.display());
        fs::remove_file(filename).await?;
        Ok(result)
    }

    pub async fn crash_report_update(
        &self,
        id: &str,
        crash_report_paths: Vec<PathBuf>,
    ) -> Result<models::CrashReport, ServiceError> {
        let os_release = OsRelease::new()?;
        let file = tempfile::Builder::new()
            .prefix("crash-report")
            .suffix(".zip")
            .rand_bytes(6)
            .tempfile()?;
        let (file, filename) = &file.keep()?;

        write_crash_report_zip(file, crash_report_paths).await?;
        warn!("Wrote crash report logs to {}", filename.display());

        let serial = match RpiCpuInfo::new() {
            Ok(rpi_cpuinfo) => rpi_cpuinfo.serial,
            Err(e) => {
                error!("Failed to read RpiCpuInfo with error={}", e);
                None
            }
        };

        let pi = self.pi.as_ref().map(|pi| pi.id);

        let result = crash_reports_api::crash_reports_partial_update(
            &self.reqwest_config(),
            id,
            None,
            None,
            Some(&os_release.version),
            Some(filename.to_path_buf()),
            None,
            None,
            serial.as_deref(),
            None,
            None,
            None,
            pi,
        )
        .await?;

        Ok(result)
    }

    pub async fn auth_user_retreive(&self) -> Result<models::User, ServiceError> {
        Ok(accounts_api::accounts_user_retrieve(&self.reqwest_config()).await?)
    }

    pub async fn auth_email_create(
        &self,
        email: String,
    ) -> Result<models::EmailAuth, ServiceError> {
        let req = models::EmailAuthRequest { email };
        Ok(accounts_api::accounts2fa_auth_email_create(&self.reqwest_config(), req).await?)
    }
    pub async fn auth_token_validate(
        &self,
        email: &str,
        token: &str,
    ) -> Result<models::CallbackTokenAuth, ServiceError> {
        let req = models::CallbackTokenAuthRequest {
            email: Some(email.to_string()),
            token: token.to_string(),
            mobile: None,
        };
        Ok(accounts_api::accounts2fa_auth_token_create(&self.reqwest_config(), req).await?)
    }

    async fn sync_pi_models(
        &self,
        edge_pi: printnanny_edge_db::cloud::Pi,
    ) -> Result<models::Pi, ServiceError> {
        // async PrintNanny Cloud SystemInfo model
        info!(
            "Synchronizing models for Pi with id={}: system_info_update_or_create()",
            edge_pi.id
        );
        let system_info = self.system_info_update_or_create(edge_pi.id).await?;
        info!("Success! Updated SystemInfo model: {:?}", system_info);

        // sync PrintNanny Cloud OctoPrintServer model
        match &edge_pi.octoprint_server_id {
            Some(octoprint_server_id) => {
                let octoprint_server = self
                    .octoprint_server_update(octoprint_server_id, &edge_pi.id)
                    .await?;
                info!(
                    "Success! Updated OctoPrintServer model: {:?}",
                    octoprint_server
                );
            }
            None => (),
        }

        // sync PrintNanny Cloud Pi model
        let pi = self.pi_retrieve(Some(edge_pi.id)).await?;
        let pi_id = pi.id;
        let changeset: printnanny_edge_db::cloud::UpdatePi = pi.clone().into();
        printnanny_edge_db::cloud::Pi::update(&self.sqlite_connection, pi_id, changeset)?;

        // sync PrintNanny Cloud PiNatsApp model
        match printnanny_edge_db::nats_app::NatsApp::get(&self.sqlite_connection) {
            Ok(nats_app) => {
                let row = *pi
                    .nats_app
                    .clone()
                    .expect("Expected PiNatsApp to be available on cloud model");
                printnanny_edge_db::nats_app::NatsApp::update(
                    &self.sqlite_connection,
                    nats_app.id,
                    row.into(),
                )?;
            }
            Err(e) => match e {
                diesel::result::Error::NotFound => {
                    let row = *pi
                        .nats_app
                        .clone()
                        .expect("Expected PiNatsApp to be available on cloud model");
                    printnanny_edge_db::nats_app::NatsApp::insert(
                        &self.sqlite_connection,
                        row.into(),
                    )?;
                }
                _ => {
                    error!("Error sychronizing PiNatsApp: {}", e);
                }
            },
        };

        Ok(pi)
    }

    async fn init_pi_model(&self) -> Result<models::Pi, ServiceError> {
        warn!("Pi is not registered, attempting to register");
        // TODO detect board, but for now only Raspberry Pi 4 is supported so
        let _sbc = Some(models::SbcEnum::Rpi4);
        let hostname = sys_info::hostname().unwrap_or_else(|_| "printnanny".to_string());

        let favorite = true;
        let setup_finished = true;

        let req = models::PiRequest {
            sbc: models::SbcEnum::Rpi4,
            hostname,
            favorite,
            setup_finished,
        };
        let pi = devices_api::pi_update_or_create(&self.reqwest_config(), req).await?;
        info!("Success! Registered Pi: {:#?}", &pi);
        printnanny_edge_db::cloud::Pi::insert(&self.sqlite_connection, pi.clone().into())?;
        let pi = self.sync_pi_models(pi.into()).await?;
        Ok(pi)
    }

    // syncs Raspberry Pi data with PrintNanny Cloud
    // performs any necessary one-time setup tasks
    pub async fn sync(&self) -> Result<printnanny_api_client::models::Pi, ServiceError> {
        match printnanny_edge_db::cloud::Pi::get(&self.sqlite_connection) {
            Ok(pi_sqlite) => self.sync_pi_models(pi_sqlite).await,
            Err(e) => match e {
                // if edge Pi model isn't found, initialize
                printnanny_edge_db::diesel::result::Error::NotFound => self.init_pi_model().await,
                // re-raise all other errors
                _ => Err(ServiceError::SqliteDBError(e)),
            },
        }
    }

    pub async fn pi_retrieve(&self, pi_id: Option<i32>) -> Result<models::Pi, ServiceError> {
        let pi_id = match pi_id {
            Some(i) => Ok(i),
            None => printnanny_edge_db::cloud::Pi::get_id(&self.sqlite_connection),
        }?;
        let res = devices_api::pis_retrieve(&self.reqwest_config(), pi_id).await?;
        Ok(res)
    }

    pub async fn pi_partial_update(
        &self,
        pi_id: i32,
        req: models::PatchedPiRequest,
    ) -> Result<models::Pi, ServiceError> {
        let res = devices_api::pis_partial_update(&self.reqwest_config(), pi_id, Some(req)).await?;
        Ok(res)
    }

    pub async fn pi_download_license(&self, pi_id: i32, backup: bool) -> Result<(), ServiceError> {
        let settings = PrintNannySettings::new().await?;
        let res = devices_api::pis_license_zip_retrieve(&self.reqwest_config(), pi_id).await?;
        settings.paths.write_license_zip(res, backup).await?;
        tokio::task::spawn_blocking(move || settings.paths.unpack_license(backup)).await??;
        // settings.paths.unpack_license(backup).await?;
        Ok(())
    }

    async fn system_info_update_or_create(
        &self,
        pi: i32,
    ) -> Result<models::SystemInfo, ServiceError> {
        let system_info = tokio::task::spawn_blocking(metadata::system_info).await??;
        let os_release_json: HashMap<String, serde_json::Value> =
            serde_json::from_str(&serde_json::to_string(&system_info.os_release)?)?;

        let request = models::SystemInfoRequest {
            pi,
            os_build_id: Some(system_info.os_release.build_id),
            os_version_id: Some(system_info.os_release.version_id),
            os_release_json: Some(os_release_json),

            machine_id: system_info.machine_id,
            serial: system_info.serial,
            revision: system_info.revision,
            model: system_info.model,
            cores: system_info.cores,
            ram: system_info.ram,
            bootfs_size: system_info.bootfs_size,
            bootfs_used: system_info.bootfs_used,
            datafs_size: system_info.datafs_size,
            datafs_used: system_info.datafs_used,
            rootfs_size: system_info.rootfs_size,
            rootfs_used: system_info.rootfs_used,
            uptime: system_info.uptime,
        };
        info!("device_system_info_update_or_create request {:?}", request);
        let res =
            devices_api::system_info_update_or_create(&self.reqwest_config(), pi, request).await?;
        Ok(res)
    }

    pub async fn octoprint_server_update(
        &self,
        octoprint_server_id: &i32,
        pi_id: &i32,
    ) -> Result<models::OctoPrintServer, ServiceError> {
        let settings = PrintNannySettings::new().await?;
        let helper = settings.to_octoprint_settings();
        let python_version = helper.python_version();
        let pip_version = helper.pip_version();
        let pip_packages = helper.pip_packages().await?;
        let octoprint_version = helper.octoprint_version(&pip_packages);
        let printnanny_plugin_version = helper.printnanny_plugin_version(&pip_packages);
        let req = models::PatchedOctoPrintServerRequest {
            octoprint_version,
            printnanny_plugin_version,
            pip_version: pip_version.await?,
            python_version: python_version.await?,
            pi: Some(*pi_id),
            ..models::PatchedOctoPrintServerRequest::new()
        };
        debug!(
            "Sending request {:?} to octoprint_server_update_or_create",
            req
        );
        let res = octoprint_api::octoprint_partial_update(
            &self.reqwest_config(),
            *octoprint_server_id,
            Some(req),
        )
        .await?;
        Ok(res)
    }

    pub async fn video_recordings_create(
        &self,
        video_path: PathBuf,
    ) -> Result<
        printnanny_edge_db::video_recording::VideoRecording,
        VideoRecordingUpdateOrCreateError,
    > {
        let recording = printnanny_edge_db::video_recording::VideoRecording::start_new(
            &self.sqlite_connection,
            video_path,
        )?;

        info!("Attempting to start new recording id={}", &recording.id);

        let factory = PrintNannyPipelineFactory::default();
        factory
            .start_video_recording_pipeline(&recording.dir)
            .await
            .expect("Failed to initialize connection to gstd");

        info!("Gstreamer mp4 recording pipeline is now playing");

        let now = Utc::now();
        let update = printnanny_edge_db::video_recording::UpdateVideoRecording {
            recording_start: Some(&now),
            dir: None,
            cloud_sync_done: None,
            recording_end: None,
            gcode_file_name: None, // TODO
        };
        printnanny_edge_db::video_recording::VideoRecording::update(
            &self.sqlite_connection,
            &recording.id,
            update,
        )?;
        let recording = printnanny_edge_db::video_recording::VideoRecording::get_by_id(
            &self.sqlite_connection,
            &recording.id,
        )?;

        let result =
            videos_api::videos_create(&self.reqwest_config(), Some(recording.clone().into()))
                .await?;

        info!("Created PrintNanny Cloud VideoRecording {:?}", result);
        Ok(recording)
    }

    pub async fn video_recording_parts_update_or_create(
        &self,
        request: models::VideoRecordingPartRequest,
    ) -> Result<models::VideoRecordingPart, VideoRecordingUpdateOrCreateError> {
        let result = videos_api::video_recording_parts_update_or_create(
            &self.reqwest_config(),
            &request.id.clone(),
            request,
        )
        .await?;

        Ok(result)
    }

    pub async fn video_recording_parts_partial_update(&self,
        id: &str,
        request: models::PatchedVideoRecordingPartRequest) -> Result<models::VideoRecordingPart, VideoRecordingUpdateOrCreateError> {
        // apply patch request via cloud api
        let result = videos_api::video_parts_partial_update(
            &self.reqwest_config(),
            id,
            Some(request)
        ).await?;
        // update edge model
        printnanny_edge_db::video_recording::VideoRecordingPart::update_from_cloud(&self.sqlite_connection, &result)?;
        Ok(result)
    }

    pub async fn video_recording_partial_update(&self, id: &str, request: models::PatchedVideoRecordingRequest) -> Result<models::VideoRecording, VideoRecordingUpdateOrCreateError> {
        let result = videos_api::videos_partial_update(
            &self.reqwest_config(),
            id,
            Some(request)
        ).await?;
        // update edge model
        printnanny_edge_db::video_recording::VideoRecording::update_from_cloud(&self.sqlite_connection, &result)?;
        Ok(result)
    }

    // read <models::<T>>.json from disk cache @ /var/run/printnanny
    // hydrate cache if not found using fallback fn f (must return a Future)
    pub async fn load_model<T: serde::de::DeserializeOwned + serde::Serialize + std::fmt::Debug>(
        &self,
        path: &Path,
        f: impl Future<Output = Result<T, PrintNannySettingsError>>,
    ) -> Result<T, PrintNannySettingsError> {
        let m = read_model_json::<T>(path);
        match m {
            Ok(v) => Ok(v),
            Err(_e) => {
                warn!(
                    "Failed to read {:?} - falling back to load remote model",
                    path
                );
                let res = f.await;
                match res {
                    Ok(v) => {
                        match save_model_json::<T>(&v, path) {
                            Ok(()) => Ok(()),
                            Err(error) => Err(PrintNannySettingsError::WriteIOError {
                                path: path.to_path_buf(),
                                error,
                            }),
                        }?;
                        info!("Saved model {:?} to {:?}", &v, path);
                        Ok(v)
                    }
                    Err(e) => Err(e),
                }
            }
        }
    }
}

impl From<&PrintNannySettings> for ApiService {
    fn from(settings: &PrintNannySettings) -> ApiService {
        ApiService::new(
            settings.cloud.clone(),
            settings.paths.db().display().to_string(),
        )
    }
}