Merge pull request #132 from rage/notif

updated the warning system to support different kinds of messages

Author: Heliozoa

plugins/python3/src/plugin.rs

@@ -19,7 +19,7 @@ use tmc_langs_framework::{
 };
 use tmc_langs_util::{
     file_util,
-    warning_reporter::{self, Warning},
+    notification_reporter::{self, Notification},
 };
 use walkdir::WalkDir;
 
@@ -122,7 +122,7 @@ impl Python3Plugin {
         let (major, minor, patch) = Self::get_local_python_ver()?;
 
         if major < recommended_major || major == recommended_major && minor < recommended_minor {
-            warning_reporter::warn(Warning::new(format!("Your Python is out of date. Minimum maintained release is {}.{}, your Python version was detected as {}.{}. Updating to a newer release is recommended.", recommended_major, recommended_minor, major, minor)));
+            notification_reporter::notify(Notification::warning(format!("Your Python is out of date. Minimum maintained release is {}.{}, your Python version was detected as {}.{}. Updating to a newer release is recommended.", recommended_major, recommended_minor, major, minor)));
         }
 
         if major < minimum_major

tmc-langs-cli/api/warnings.json

@@ -1,4 +1,5 @@
 {
-  "output-kind": "warning",
-  "warning": "some warning"
+  "output-kind": "notification",
+  "notification-kind": "warning",
+  "message": "some warning"
 }

tmc-langs-cli/src/lib.rs

@@ -19,7 +19,7 @@ use std::io::{Read, Write};
 use std::ops::Deref;
 use std::path::{Path, PathBuf};
 use std::{env, io::Cursor};
-use tmc_langs::{file_util, warning_reporter, CommandError, StyleValidationResult};
+use tmc_langs::{file_util, notification_reporter, CommandError, StyleValidationResult};
 use tmc_langs::{
     ClientError, Credentials, DownloadOrUpdateCourseExercisesResult, DownloadResult,
     FeedbackAnswer, TmcClient, TmcConfig,
@@ -75,8 +75,8 @@ fn run_inner() -> Result<(), ()> {
     let matches = app::create_app().get_matches();
     let pretty = matches.is_present("pretty");
 
-    warning_reporter::init(Box::new(move |warning| {
-        let warning_output = Output::Warning(warning);
+    notification_reporter::init(Box::new(move |warning| {
+        let warning_output = Output::Notification(warning);
         if let Err(err) = print_output(&warning_output, pretty) {
             log::error!("printing warning failed: {}", err);
         }

tmc-langs-cli/src/output.rs

@@ -4,7 +4,7 @@ use schemars::JsonSchema;
 use serde::Serialize;
 use std::path::PathBuf;
 use tmc_langs::{
-    warning_reporter::Warning, ClientUpdateData, CombinedCourseData, ConfigValue, Course,
+    notification_reporter::Notification, ClientUpdateData, CombinedCourseData, ConfigValue, Course,
     CourseData, CourseDetails, CourseExercise, DownloadOrUpdateCourseExercisesResult, ExerciseDesc,
     ExerciseDetails, ExerciseDownload, ExercisePackagingConfiguration, LocalExercise,
     NewSubmission, Organization, Review, RunResult, StyleValidationResult, Submission,
@@ -22,7 +22,7 @@ pub enum Output {
     /// Status update output as a command progresses.
     StatusUpdate(StatusUpdateData),
     /// Additional warnings, such as for an outdated Python dependency.
-    Warning(Warning),
+    Notification(Notification),
 }
 
 impl Output {
@@ -240,8 +240,8 @@ mod test {
     }
 
     #[test]
-    fn warning() {
-        let status_update = Output::Warning(Warning::new("some warning"));
+    fn notification() {
+        let status_update = Output::Notification(Notification::warning("some warning"));
         let actual = serde_json::to_string_pretty(&status_update).unwrap();
         let expected = read_api_file("warnings.json");
         assert_eq!(actual, expected);

tmc-langs-util/src/lib.rs

@@ -4,7 +4,7 @@
 
 pub mod error;
 pub mod file_util;
+pub mod notification_reporter;
 pub mod progress_reporter;
-pub mod warning_reporter;
 
 pub use error::FileError;

tmc-langs-util/src/notification_reporter.rs

@@ -0,0 +1,51 @@
+//! Contains an utility for reporting warnings.
+
+use once_cell::sync::OnceCell;
+use serde::Serialize;
+
+type NotificationClosure = Box<dyn 'static + Sync + Send + Fn(Notification)>;
+
+static NOTIFICATION_REPORTER: OnceCell<NotificationClosure> = OnceCell::new();
+
+/// Initializes the warning reporter with the given closure to be called with any warnings.
+/// Can only be initialized once, repeated calls do nothing.
+pub fn init(reporter: NotificationClosure) {
+    NOTIFICATION_REPORTER.get_or_init(|| reporter);
+}
+
+/// Calls the warning closure with the given warning.
+pub fn notify(notification: Notification) {
+    if let Some(reporter) = NOTIFICATION_REPORTER.get() {
+        reporter(notification);
+    }
+}
+
+#[derive(Debug, Serialize)]
+#[serde(rename_all = "kebab-case")]
+pub struct Notification {
+    notification_kind: NotificationKind,
+    message: String,
+}
+
+#[derive(Debug, Serialize)]
+#[serde(rename_all = "lowercase")]
+pub enum NotificationKind {
+    Warning,
+    Info,
+}
+
+impl Notification {
+    pub fn warning(message: impl ToString) -> Self {
+        Self {
+            notification_kind: NotificationKind::Warning,
+            message: message.to_string(),
+        }
+    }
+
+    pub fn info(message: impl ToString) -> Self {
+        Self {
+            notification_kind: NotificationKind::Info,
+            message: message.to_string(),
+        }
+    }
+}

tmc-langs-util/src/warning_reporter.rs

@@ -32,7 +32,7 @@ pub use tmc_langs_framework::{
 };
 pub use tmc_langs_util::{
     file_util::{self, FileLockGuard},
-    warning_reporter,
+    notification_reporter,
 };
 
 use crate::config::ProjectsConfig;