Merge pull request #753 from Stremio/feat/ctx-delete-account

feat: add ctx delete account action

src/models/ctx/ctx.rs

@@ -114,10 +114,15 @@ impl<E: Env + 'static> Update<E> for Ctx {
                 self.status = CtxStatus::Loading(auth_request.to_owned());
                 Effects::one(authenticate::<E>(auth_request)).unchanged()
             }
-            Msg::Action(Action::Ctx(ActionCtx::Logout)) | Msg::Internal(Internal::Logout) => {
+            Msg::Action(Action::Ctx(ActionCtx::Logout)) => {
+                Effects::msg(Msg::Internal(Internal::Logout(false))).unchanged()
+            }
+            Msg::Internal(Internal::Logout(deleted)) => {
                 let uid = self.profile.uid();
                 let session_effects = match self.profile.auth_key() {
-                    Some(auth_key) => Effects::one(delete_session::<E>(auth_key)).unchanged(),
+                    Some(auth_key) if !deleted => {
+                        Effects::one(delete_session::<E>(auth_key)).unchanged()
+                    }
                     _ => Effects::none().unchanged(),
                 };
                 let profile_effects =

src/models/ctx/update_events.rs

@@ -18,7 +18,7 @@ pub fn update_events<E: Env + 'static>(
     msg: &Msg,
 ) -> Effects {
     match msg {
-        Msg::Action(Action::Ctx(ActionCtx::Logout)) | Msg::Internal(Internal::Logout) => {
+        Msg::Internal(Internal::Logout(_)) => {
             let next_dismissed_events = DismissedEventsBucket::default();
             *dismissed_events = next_dismissed_events;
             Effects::msg(Msg::Internal(Internal::DismissedEventsChanged))

src/models/ctx/update_library.rs

@@ -33,7 +33,7 @@ pub fn update_library<E: Env + 'static>(
 ) -> Effects {
     let auth_key = profile.auth_key();
     match msg {
-        Msg::Action(Action::Ctx(ActionCtx::Logout)) | Msg::Internal(Internal::Logout) => {
+        Msg::Internal(Internal::Logout(_)) => {
             let next_library = LibraryBucket::default();
             if *library != next_library {
                 *library = next_library;

src/models/ctx/update_notifications.rs

@@ -122,7 +122,7 @@ pub fn update_notifications<E: Env + 'static>(
             Msg::Internal(Internal::DismissNotificationItem(id.to_owned())),
         )
         .unchanged(),
-        Msg::Action(Action::Ctx(ActionCtx::Logout)) | Msg::Internal(Internal::Logout) => {
+        Msg::Internal(Internal::Logout(_)) => {
             let notification_catalogs_effects = eq_update(notification_catalogs, vec![]);
             let next_notifications = NotificationsBucket::new::<E>(profile.uid(), vec![]);
             let notifications_effects = if *notifications != next_notifications {

src/models/ctx/update_profile.rs

@@ -11,7 +11,7 @@ use crate::types::addon::Descriptor;
 use crate::types::api::{
     fetch_api, APIError, APIRequest, APIResult, CollectionResponse, SuccessResponse,
 };
-use crate::types::profile::{Auth, AuthKey, Profile, Settings, User};
+use crate::types::profile::{Auth, AuthKey, Password, Profile, Settings, User};
 use crate::types::streams::StreamsBucket;
 
 pub fn update_profile<E: Env + 'static>(
@@ -21,7 +21,7 @@ pub fn update_profile<E: Env + 'static>(
     msg: &Msg,
 ) -> Effects {
     match msg {
-        Msg::Action(Action::Ctx(ActionCtx::Logout)) | Msg::Internal(Internal::Logout) => {
+        Msg::Internal(Internal::Logout(_)) => {
             let next_profile = Profile::default();
             if *profile != next_profile {
                 *profile = next_profile;
@@ -30,6 +30,14 @@ pub fn update_profile<E: Env + 'static>(
                 Effects::none().unchanged()
             }
         }
+        Msg::Action(Action::Ctx(ActionCtx::DeleteAccount(password))) => match profile.auth_key() {
+            Some(auth_key) => Effects::one(delete_account::<E>(auth_key, password)).unchanged(),
+            _ => Effects::msg(Msg::Event(Event::Error {
+                error: CtxError::from(OtherError::UserNotLoggedIn),
+                source: Box::new(Event::UserAccountDeleted { uid: profile.uid() }),
+            }))
+            .unchanged(),
+        },
         Msg::Action(Action::Ctx(ActionCtx::PushUserToAPI)) => match &profile.auth {
             Some(Auth { key, user }) => {
                 Effects::one(push_user_to_api::<E>(user.to_owned(), key)).unchanged()
@@ -369,7 +377,7 @@ pub fn update_profile<E: Env + 'static>(
                 Err(error) => {
                     let session_expired_effects = match error {
                         CtxError::API(APIError { code, .. }) if *code == 1 => {
-                            Effects::msg(Msg::Internal(Internal::Logout)).unchanged()
+                            Effects::msg(Msg::Internal(Internal::Logout(false))).unchanged()
                         }
                         _ => Effects::none().unchanged(),
                     };
@@ -382,6 +390,17 @@ pub fn update_profile<E: Env + 'static>(
                 }
             }
         }
+        Msg::Internal(Internal::DeleteAccountAPIResult(
+            APIRequest::DeleteAccount { auth_key, .. },
+            result,
+        )) if profile.auth_key() == Some(auth_key) => match result {
+            Ok(_) => Effects::msg(Msg::Internal(Internal::Logout(true))).unchanged(),
+            Err(error) => Effects::msg(Msg::Event(Event::Error {
+                error: error.to_owned(),
+                source: Box::new(Event::UserAccountDeleted { uid: profile.uid() }),
+            }))
+            .unchanged(),
+        },
         _ => Effects::none().unchanged(),
     }
 }
@@ -491,6 +510,24 @@ fn push_profile_to_storage<E: Env + 'static>(profile: &Profile) -> Effect {
     .into()
 }
 
+fn delete_account<E: Env + 'static>(auth_key: &AuthKey, password: &Password) -> Effect {
+    let request = APIRequest::DeleteAccount {
+        auth_key: auth_key.to_owned(),
+        password: password.to_owned(),
+    };
+    EffectFuture::Concurrent(
+        fetch_api::<E, _, _, _>(&request)
+            .map_err(CtxError::from)
+            .and_then(|result| match result {
+                APIResult::Ok(result) => future::ok(result),
+                APIResult::Err(error) => future::err(CtxError::from(error)),
+            })
+            .map(move |result| Msg::Internal(Internal::DeleteAccountAPIResult(request, result)))
+            .boxed_env(),
+    )
+    .into()
+}
+
 fn addon_upgrade_error_effects(addon: &Descriptor, error: OtherError) -> Effects {
     addon_action_error_effects(
         error,

src/models/ctx/update_search_history.rs

@@ -13,7 +13,7 @@ pub fn update_search_history<E: Env + 'static>(
     msg: &Msg,
 ) -> Effects {
     match msg {
-        Msg::Action(Action::Ctx(ActionCtx::Logout)) | Msg::Internal(Internal::Logout) => {
+        Msg::Internal(Internal::Logout(_)) => {
             let next_search_history = SearchHistoryBucket::default();
             *search_history = next_search_history;
             Effects::msg(Msg::Internal(Internal::SearchHistoryChanged))

src/models/ctx/update_streams.rs

@@ -5,7 +5,7 @@ use std::collections::hash_map::Entry;
 use crate::constants::STREAMS_STORAGE_KEY;
 use crate::models::common::{Loadable, ResourceLoadable};
 use crate::models::ctx::{CtxError, CtxStatus};
-use crate::runtime::msg::{Action, ActionCtx, CtxAuthResponse, Event, Internal, Msg};
+use crate::runtime::msg::{CtxAuthResponse, Event, Internal, Msg};
 use crate::runtime::{Effect, EffectFuture, Effects, Env, EnvFutureExt};
 use crate::types::streams::{StreamsBucket, StreamsItem, StreamsItemKey};
 
@@ -15,7 +15,7 @@ pub fn update_streams<E: Env + 'static>(
     msg: &Msg,
 ) -> Effects {
     match msg {
-        Msg::Action(Action::Ctx(ActionCtx::Logout)) | Msg::Internal(Internal::Logout) => {
+        Msg::Internal(Internal::Logout(_)) => {
             let next_streams = StreamsBucket::default();
             if *streams != next_streams {
                 *streams = next_streams;

src/models/ctx/update_trakt_addon.rs

@@ -23,9 +23,7 @@ pub fn update_trakt_addon<E: Env + 'static>(
     msg: &Msg,
 ) -> Effects {
     match msg {
-        Msg::Action(Action::Ctx(ActionCtx::Logout)) | Msg::Internal(Internal::Logout) => {
-            eq_update(trakt_addon, None)
-        }
+        Msg::Internal(Internal::Logout(_)) => eq_update(trakt_addon, None),
         Msg::Action(Action::Ctx(ActionCtx::InstallTraktAddon)) => {
             Effects::msg(Msg::Internal(Internal::InstallTraktAddon))
         }

src/runtime/msg/action.rs

@@ -3,6 +3,7 @@ use std::ops::Range;
 use serde::Deserialize;
 use url::Url;
 
+use crate::types::profile::Password;
 use crate::types::streams::StreamItemState;
 use crate::{
     models::{
@@ -34,6 +35,7 @@ use crate::{
 pub enum ActionCtx {
     Authenticate(AuthRequest),
     Logout,
+    DeleteAccount(Password),
     InstallAddon(Descriptor),
     InstallTraktAddon,
     LogoutTrakt,

src/runtime/msg/event.rs

@@ -88,6 +88,9 @@ pub enum Event {
     UserLoggedOut {
         uid: UID,
     },
+    UserAccountDeleted {
+        uid: UID,
+    },
     SessionDeleted {
         auth_key: AuthKey,
     },

src/runtime/msg/internal.rs

@@ -49,12 +49,14 @@ pub enum Internal {
     AddonsAPIResult(APIRequest, Result<Vec<Descriptor>, CtxError>),
     /// Result for pull user from API.
     UserAPIResult(APIRequest, Result<User, CtxError>),
+    /// Result for deleting account from API.
+    DeleteAccountAPIResult(APIRequest, Result<SuccessResponse, CtxError>),
     /// Result for library sync plan with API.
     LibrarySyncPlanResult(DatastoreRequest, Result<LibraryPlanResponse, CtxError>),
     /// Result for pull library items from API.
     LibraryPullResult(DatastoreRequest, Result<Vec<LibraryItem>, CtxError>),
-    /// Dispatched when expired session is detected
-    Logout,
+    /// Dispatched when the user session needs to be cleared with a flag if the session was already deleted server-side
+    Logout(bool),
     /// Internal event dispatched on user action or login
     /// to install the addon if it's not present
     InstallTraktAddon,

src/types/api/request.rs

@@ -3,7 +3,7 @@ use core::fmt;
 use crate::constants::{API_URL, LINK_API_URL};
 use crate::types::addon::Descriptor;
 use crate::types::library::LibraryItem;
-use crate::types::profile::{AuthKey, GDPRConsent, User};
+use crate::types::profile::{AuthKey, GDPRConsent, Password, User};
 use crate::types::resource::SeriesInfo;
 use chrono::{DateTime, Local};
 #[cfg(test)]
@@ -50,6 +50,11 @@ pub enum APIRequest {
         auth_key: AuthKey,
     },
     #[serde(rename_all = "camelCase")]
+    DeleteAccount {
+        auth_key: AuthKey,
+        password: Password,
+    },
+    #[serde(rename_all = "camelCase")]
     AddonCollectionGet {
         auth_key: AuthKey,
         update: bool,
@@ -155,6 +160,7 @@ impl FetchRequestParams<APIRequest> for APIRequest {
             APIRequest::Auth(AuthRequest::Facebook { .. }) => "authWithFacebook".to_owned(),
             APIRequest::Auth(AuthRequest::Register { .. }) => "register".to_owned(),
             APIRequest::Logout { .. } => "logout".to_owned(),
+            APIRequest::DeleteAccount { .. } => "deleteUser".to_owned(),
             APIRequest::AddonCollectionGet { .. } => "addonCollectionGet".to_owned(),
             APIRequest::AddonCollectionSet { .. } => "addonCollectionSet".to_owned(),
             APIRequest::GetUser { .. } => "getUser".to_owned(),

src/types/profile/auth.rs

@@ -1,4 +1,4 @@
-use std::fmt::Display;
+use std::fmt::{Debug, Display};
 
 use crate::types::profile::User;
 use serde::{Deserialize, Serialize};
@@ -19,3 +19,19 @@ pub struct Auth {
     pub key: AuthKey,
     pub user: User,
 }
+
+#[derive(Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[cfg_attr(test, derive(Default))]
+pub struct Password(pub String);
+
+impl Display for Password {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}", self.0)
+    }
+}
+
+impl Debug for Password {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "<SENSITIVE>>")
+    }
+}