packages/account/securityCheckup/helpers/getSecurityCheckupRecommendations.ts

   1 import {
   2     getIsAlmostPerfectEmailState,
   3     getIsAlmostPerfectPhoneState,
   4     getIsPerfectDeviceRecoveryState,
   5     getIsPerfectEmailState,
   6     getIsPerfectPhoneState,
   7     getIsPerfectPhraseState,
   8 } from '@proton/shared/lib/helpers/securityCheckup';
   9 import type { SecurityCheckupAction } from '@proton/shared/lib/interfaces/securityCheckup';
  10 import SecurityCheckupCohort from '@proton/shared/lib/interfaces/securityCheckup/SecurityCheckupCohort';
  11 import type SecurityState from '@proton/shared/lib/interfaces/securityCheckup/SecurityState';
  12
  13 class Actions {
  14     private actionsSet: Set<SecurityCheckupAction>;
  15
  16     private securityState: SecurityState;
  17
  18     private isPerfectPhraseState: boolean;
  19
  20     private isPerfectEmailState: boolean;
  21
  22     private isPerfectPhoneState: boolean;
  23
  24     private isPerfectDeviceRecoveryState: boolean;
  25
  26     public shouldActionDevice: boolean;
  27
  28     constructor(securityState: SecurityState) {
  29         this.actionsSet = new Set<SecurityCheckupAction>();
  30
  31         this.securityState = securityState;
  32
  33         this.isPerfectPhraseState = getIsPerfectPhraseState(securityState);
  34         this.isPerfectEmailState = getIsPerfectEmailState(securityState);
  35         this.isPerfectPhoneState = getIsPerfectPhoneState(securityState);
  36         this.isPerfectDeviceRecoveryState = getIsPerfectDeviceRecoveryState(securityState);
  37
  38         this.shouldActionDevice =
  39             (this.isPerfectEmailState || this.isPerfectPhoneState) && !this.isPerfectDeviceRecoveryState;
  40     }
  41
  42     public phrase() {
  43         if (!this.securityState.phrase.isAvailable) {
  44             return;
  45         }
  46
  47         if (!this.isPerfectPhraseState) {
  48             this.actionsSet.add('phrase');
  49         }
  50     }
  51
  52     public email() {
  53         if (!this.isPerfectEmailState) {
  54             this.actionsSet.add('email');
  55         }
  56     }
  57
  58     public phone() {
  59         if (!this.isPerfectPhoneState) {
  60             this.actionsSet.add('phone');
  61         }
  62     }
  63
  64     public emailOrPhone() {
  65         this.email();
  66         this.phone();
  67     }
  68
  69     public device() {
  70         if (!this.securityState.deviceRecovery.isAvailable) {
  71             return;
  72         }
  73
  74         if (this.shouldActionDevice) {
  75             this.actionsSet.add('device');
  76         }
  77     }
  78
  79     public toArray() {
  80         return Array.from(this.actionsSet);
  81     }
  82 }
  83
  84 interface SecurityCheckupHealth {
  85     cohort: SecurityCheckupCohort;
  86     actions: SecurityCheckupAction[];
  87     furtherActions: SecurityCheckupAction[];
  88 }
  89
  90 const getSecurityCheckupRecommendations = (securityState: SecurityState): SecurityCheckupHealth => {
  91     const isPerfectPhraseState = getIsPerfectPhraseState(securityState);
  92
  93     const isPerfectEmailState = getIsPerfectEmailState(securityState);
  94     const isAlmostPerfectEmailState = getIsAlmostPerfectEmailState(securityState);
  95
  96     const isPerfectPhoneState = getIsPerfectPhoneState(securityState);
  97     const isAlmostPerfectPhoneState = getIsAlmostPerfectPhoneState(securityState);
  98
  99     const isPerfectEmailOrPhoneState = isPerfectEmailState || isPerfectPhoneState;
 100
 101     const isPerfectDeviceState = getIsPerfectDeviceRecoveryState(securityState);
 102
 103     const actions = new Actions(securityState);
 104     const furtherActions = new Actions(securityState);
 105
 106     const serialize = ({
 107         cohort,
 108         actions,
 109         furtherActions,
 110     }: {
 111         cohort: SecurityCheckupCohort;
 112         actions: Actions;
 113         furtherActions: Actions;
 114     }) => {
 115         return {
 116             cohort,
 117             actions: actions.toArray(),
 118             furtherActions: furtherActions.toArray(),
 119         };
 120     };
 121
 122     /**
 123      * COMPLETE_RECOVERY_MULTIPLE
 124      **/
 125     if (isPerfectPhraseState && isPerfectEmailOrPhoneState && isPerfectDeviceState) {
 126         actions.device();
 127         furtherActions.emailOrPhone();
 128
 129         return serialize({
 130             cohort: SecurityCheckupCohort.COMPLETE_RECOVERY_MULTIPLE,
 131             actions,
 132             furtherActions,
 133         });
 134     }
 135
 136     /**
 137      * COMPLETE_RECOVERY_SINGLE
 138      **/
 139     if (isPerfectPhraseState && !isPerfectEmailOrPhoneState) {
 140         actions.emailOrPhone();
 141
 142         return serialize({
 143             cohort: SecurityCheckupCohort.COMPLETE_RECOVERY_SINGLE,
 144             actions,
 145             furtherActions,
 146         });
 147     }
 148
 149     if (isPerfectPhraseState && isPerfectEmailOrPhoneState && !isPerfectDeviceState) {
 150         actions.device();
 151
 152         furtherActions.emailOrPhone();
 153
 154         return serialize({
 155             cohort: SecurityCheckupCohort.COMPLETE_RECOVERY_SINGLE,
 156             actions,
 157             furtherActions,
 158         });
 159     }
 160
 161     if (!isPerfectPhraseState && isPerfectEmailOrPhoneState && isPerfectDeviceState) {
 162         actions.phrase();
 163
 164         furtherActions.emailOrPhone();
 165
 166         return serialize({
 167             cohort: SecurityCheckupCohort.COMPLETE_RECOVERY_SINGLE,
 168             actions,
 169             furtherActions,
 170         });
 171     }
 172
 173     /**
 174      * ACCOUNT_RECOVERY_ENABLED
 175      **/
 176     if (!isPerfectPhraseState && isPerfectEmailOrPhoneState && !isPerfectDeviceState) {
 177         actions.device();
 178
 179         furtherActions.phrase();
 180         furtherActions.emailOrPhone();
 181
 182         return serialize({
 183             cohort: SecurityCheckupCohort.ACCOUNT_RECOVERY_ENABLED,
 184             actions,
 185             furtherActions,
 186         });
 187     }
 188
 189     /**
 190      * NO_RECOVERY_METHOD
 191      **/
 192     if (isAlmostPerfectEmailState || isAlmostPerfectPhoneState) {
 193         if (isAlmostPerfectEmailState) {
 194             actions.email();
 195         }
 196         if (isAlmostPerfectPhoneState) {
 197             actions.phone();
 198         }
 199     }
 200
 201     actions.phrase();
 202
 203     if (!isAlmostPerfectEmailState) {
 204         furtherActions.email();
 205     }
 206
 207     if (!isAlmostPerfectPhoneState) {
 208         furtherActions.phone();
 209     }
 210
 211     return serialize({
 212         cohort: SecurityCheckupCohort.NO_RECOVERY_METHOD,
 213         actions,
 214         furtherActions,
 215     });
 216 };
 217
 218 export default getSecurityCheckupRecommendations;