Some clients have unique global setting defaults (and unique global settings)
For example: the web vault defaults to light theme, but most clients with theme support default to system theme.
The current way we handle GlobalState is buried in jslib and not easily extendible in clients.
To fix this, we need to treat GlobalState as a generic in the StateService and StateMigration service and allow for its extension in those methods and anywhere GlobalState is inited.
There is a use case that overrides locally set environmentUrls: an initial boot of a logged out application.
We override environmentUrls with whatever the tempory settings store has, even if different urls are added before authenticating.
This commit ensures we always use input environmentUrls.
The following data points are currently scoped to an account but are made global with this commit:
* Enable Menu Bar Icon
* Minimize To Menu Bar
* Close To Menu Bar
* Start To Menu Bar
Note: these are all electron specific fields
Currently the StateMigrationService depends on a userId key for running migrations, but if there is not an authenticated user saved to storage that userId is not present.
These changes allow for migrating state data even without an active user. For account specific settings like clearClipboard we now temporarily store those values together in disk state until an account is authed that they can be added to. Temp account state is then cleared.
Some notes:
* In order for this to work we need GlobalState.stateVersion to have a default value of StateVersion.One instead of StateVersion.Latest. Defaulting it to latest was causing migrations to not run on some clients (like desktop) that try to access storage before migrations have been run but save a version as if migrations did run.
* I also noticed we aren't clearing old state items from before migrating, and added a case for this to the migrator.
* I extracted a few bits of reused code into private methods in the stateMigration service. Things like get/set from storage, default options, etc.
* [bug] Improve state management performance
Large vaults see a clear degrade in performance using the state service, especially when multiple vaults are authed and unlocked at the same time.
Some changes made to address this:
1. Clearing in memory decrypted data for non active accounts. This really should have been something we were doing anyway, but letting go of that memory burden has a noticable performance boost.
2. Not loading a bunch of unecsassary data from disk accounts into memory on application startup. This was being done to initilize in memory accounts, but brought a lot of extra baggage with it like storing encrypted data in memory, even though it is never referenced that way.
3. Breaking the on disk state object up into seperate keys for accounts instead of storing everything together under a "state" key. This ensures there is less information fetched from disk each time we call for an account.
There were some restructuring changes needed to facilitate these items:
1. We need to be able to construct an account in the StateService, but typescript doesn't allow for new() constraints on generics so a factory needs to be created and passed into the StateService for this to work.
2. Since we can't reference an all-knowing "accounts" object for on disk state anymore we have to maintain a list of authenticated accounts, and this has been added.
3. The StateMigration service needed to be updated to break up the accounts object, so current dev and QA state will be broken and need to be reset.
Some other general refactorings that were helpful gettings this working:
1. Added a constant for keys to the StateService and StateMigrationService.
2. Bundling everything needed to deauthenticate a user into a dedicated method.
3. Bundling all the disk storage clear methods (that should be refactored later into client specific state services) into one helper method.
4. Bundling everything needed to dynamically select a new active user into a dedicated method.
* [bug] Set environmentUrls appropriatly on account add
* [bug] Stop tracking activity without an active user
* [bug] Remove lastActive from globalState and globalState migration
* [style] Ran prettier
* [bug] Fully initilize environmentUrls default value
We want the full environmentUrls object to be saved to storage with null values as an indicator of using BW cloud.
Currently the initilization behavior creates an empty object instead. Setting property values returns the correct behavior.
* [bug] Return the correct environmentUrls when scaffloging a new account
To allow for setting environmentUrls before an account is created we save that value as a global setting and then apply it to any newly authed accounts.
There is a bug that will instead save the urls used by the previous logged in account, making account switching with multiple servers cause errors.
This commit resolves this by specifically getting environementUrls from global state when creating a new account
* [refactor] Restructure EnvironmentUrls in state
* Patch up (add missing fields) and more extensivly use the EnvironmentUrls class instead of passing around an any
* Add environmentUrls to the AccountSettings model in addition to GlobalState for use in both scopes
* Move EnvironmentUrls initialization to the model level and out of StateSerice
* Adjust the StateMigrationService to account for these changes
* [refactor] Improve order of operations for LockGuardService
We currently jump through a bunch of hoops to verify users can access the Lock page, like checking authentication first.
If a user is not authenticated, they are not locked, so we can improve performance for the happy path of this serivice by checking isLocked first and using isAuthenticated to deviate from the normal flow if needed.
* [bug] Subscribe to State.accounts in EnvironmentService and set urls accordingly
The EnvironmentService has no context for account changes currently and does not update actively used urls based on active account.
This commit addresses this issue by subscribing to State.accounts and resetting the service's urls on account change.
* [bug] Clear AccessToken from State on clean
In order for logout flows to function as expected we need to deauthenticate users when cleaning up state before checking for the next active user
Otherwise the service will continue to think the user being logged out is active
* [refactor] Stop pushing accounts when modifying disk state
There is no reason to push new accounts to subscribers when updating disk state.
Subscribers recieve a copy of in memory state, so changes to disk will not be refelected and have to be fetched seperatly from the service.
Pushing when saving disk state is just creating an unecassary performance burden.
* [refactor] Default to in memory active user if availible, even when accessing disk state
Sometimes we need to pull activeUserId from storage to access a bit of data, like on initial boot, but most of the time this isn't necassary.
Since we pull this userId a lot, checking disk each time is a performance burden. Defaulting to the in memory user ID if avaible helps alleviate this.
* [style] Ran prettier
* [style] Change a let to a const
* [feat(Account Switching)] Allow for extending application state
* [bug(Account Switching)] Remove hardcoded dev urls
* [bug(Account Switching)] Init Account when signing in
* [bug(Account Switching)] Check for state migration version in local storage for web
* [bug(Account Switching)] Fix never lock configurations
* [chore] Prettier merge
* [bug] Move environmentUrls to global state
* [chore] Ran prettier
* [bug]change storage location for enityId and type
* [style] Ran prettier
Co-authored-by: Robyn MacCallum <robyntmaccallum@gmail.com>
* [refactor] Extract, rename, and expand StorageServiceOptions
* Pulled StorageServiceOptions into its own file
* Renamed StorageServiceOptions to StorageOptions
* Pulled KeySuffixOpptions into its own file
* Converted KeySuffixOptions into an enum from a union type
* [refactor] Expand StateService into a full coverage storage proxy
* Expand StateService to allow it to manage all data points of the application state regardless of memory.
* Expand StateService to allow for storing and managing multiple accounts
* [refactor] Create helper services for managing organization and provider state data
* [refactor] Implement StateService across service layer
* Remove service level variables used for in memory data storage and replaced with calls to StateService
* Remove direct calls to StorageService in favor of using StateService as a proxy
* [feature] Implement account switching capable services across components and processes
* Replace calls to StorageService and deprecated services with calls to a StateService
* [chore] Remove unused services
Several services are no longer in use because of the expanded state service. These have simply been removed.
* [bug] Add loginRedirect to the account model
* [bug] Add awaits to newly async calls in TokenService
* [bug] Add several missing awaits
* [bug] Add state service handlers for AutoConfirmFingerprint
* [bug] Move TwoFactorToken to global state
* Update unauth-guard.service.ts
Add back return true
* [refactor] Slim down the boilerplate needed to manage options on StateService calls
* [bug] Allow the lock message handler to manipulate a specific acount
* [bug] Add missing await to auth guard
* [bug] Adjust state scope of several biometric data points
* [bug] Ensure vault locking logic can operate over non-active accounts
* [style] Fix lint complaints
* [bug] Move disableFavicon to global state
* [refactor] Remove an unecassary parameter from a StorageOptions instance
* [bug] Ensure HtmlStorageService paths are accounted for in StateService
* [feature] Add a server url helper to the account model for the account switcher
* [refactor] Remove some unused getters from the account model
* [bug] Ensure locking and logging out can function over any user
* Fix account getting set to null in getAccountFromDisk
* [bug] Ensure lock component is always working with the latest active account in state
* [chore] Update recent KeyConnector changes to use stateService
* [style] Fix lint complaints
* [chore] Resolve TokenService merge issues from KeyConnector
* [bug] Add missing service arguement
* [bug] Correct several default storage option types
* [bug] Check for the right key in hasEncKey
* [bug] Add enableFullWidth to the account model
* [style] Fix lint complaints
* [review] Revist remember email
* [refactor] Remove RememberEmail from state
* setDisableFavicon to correct storage location
* [bug] Convert vault lock loop returns into continues to not skip secondary accounts
* [review] Sorted state service methods
* [bug] Correct neverDomains type on the account model
* [review] Rename stateService.purge to stateService.clean
* [review] [refactor] Extract lock refresh logic to a load function
* [review] [refactor] Extract some timeout logic to dedicated functions
* [review] [refactor] Move AuthenticationStatus to a dedicated file
* [review] [refactor] Rename Globals to GlobalState
* [style] Fix lint complaints
* [review] Remove unused global state property for decodedToken
* [review] [bug] Adjust state scope for OrganizationInvitation
* [review] [bug] Put back the homepage variable in lock guard
* [review] Un-try-catch the window creation function
* Revert "[review] [bug] Adjust state scope for OrganizationInvitation"
This reverts commit caa4574a65d9d0c3573a7529ed2221764fd55497.
* [bug] Change || to && in recent vault timeout refactor
* [bug] Keep up with entire state in storage instead of just accounts and globals
Not having access to the last active user was creating issues across clients when restarting the process.
For example: when refreshing the page on web we no longer maintain an understanding of who is logged in.
To resolve this I converted all storage save operations to get and save an entire state object, instead of specifying accounts and globals.
This allows for more flexible saving, like saving activeUserId as a top level storage item.
* [style] Fix lint complaints
* Revert "[bug] Keep up with entire state in storage instead of just accounts and globals"
This reverts commit e8970725be472386358c1e2f06f53663c4979e0e.
* [bug] Initialize GlobalState by default
* [bug] Only get key hash from storage
* [bug] Remove settings storage location overrides
* [bug] Only save accessToken to storage
* [refactor] Remove unecassary argements from electron crypto state calls
* [bug] Ensure keys and tokens load and save to the right locations for web
* [style] Fix lint complaints
* [bug] Remove keySuffix storage option and split uses into unique methods
The keySuffix options don't work with saving serialized json as a storage object - use cases simply overwrite each other in state.
This commit breaks Auto and Biometric keys into distinct storage items and adjusts logic accordingly.
* [bug] Add default vault timeouts to new accounts
* [bug] Save appId as a top level storage item
* [bug] Add missing await to timeout logic
* [bug] Adjust state scope for everBeenUnlocked
* [bug] Clear access tokens when loading account state from disk
* [bug] Adjust theme to be a global state item
* [bug] Adjust null checking for window in state
* [bug] Correct getGlobals not pulling from the stored state item
* [bug] Null check in memory account before claiming it has a userId
* [bug] Scaffold secure storage service when building storage objects on init
* [bug] Adjusted state scope of event collection
* [bug] Adjusted state scope of vault timeout and action
* [bug] Grab account from normal storage if secure storage is requested but does not exist
* [bug] Create a State if one is requested from memory before it exists
* [bug] Ensure all storage locations are cleared on state clean
* [style] Fix lint complaints
* [bug] Remove uneeded clearing of access token
* [bug] Reset tokens when toggling
* [refactor] Split up the Account model
Until this point the account model has been very flat, holding many kinds of data.
In order to be able to prune data at appropriate times, for example clearing keys at logout without clearing QoL settings like locale,
the Account model has been divided into logical chunks.
* [bug] Correct the serverUrl helpers return
* Fix sends always coming back as empty in browser
* Get settings properly (I think)
* [bug] Fix lint error
* [bug] Add missing await to identity token refresh
This was causing weird behavior in web that was creating a lot of 429s
* [bug] Scaffold memory storage for web
Not properly creating storage objects on signin was creating weird behavior when logging out, locking, and logging back in.
Namely, encrypted data that was recently synced had nowhere to save to and was lost.
* [bug] Implement better null handling in a few places for retrieving state
* [bug] Update correct storage locations on account removal
* [bug] Added missing awaits to lock component
* [bug] Reload lock component on account switching vs. account update
* [bug] Store master keys correctly
* [bug] Move some biometrics storage items to global state
* [feature] Add platform helper isMac()
* [refactor] Comment emphasis and call order refresh
* [refactor] Remove unecassary using
* [bug] Relocate authenticationStatus check logic to component
* [bug] Stop not clearing everything on state clean
* [style] Fix lint complaints
* [bug] Correct mismatched uses of encrypted and decrypted pin states
* Add browser specific state classes and methods
* lint fixes
* [bug] Migrate existing persistant data to new schema
* [style] Fix lint complaints
* [bug] Dont clear settings on state clean
* [bug] Maintain the right storage items on logout
* [chore] resolve issues from merge
* [bug] Resolve settings clearing on lock
* [chore] Added a comment
* [review] fromatting for code review
* Revert browser state items
Co-authored-by: Robyn MacCallum <nickersthecat@gmail.com>
Co-authored-by: Robyn MacCallum <robyntmaccallum@gmail.com>
Addison Beck
Addison Beck
Daniel James Smith
Thomas Rittson
Robyn MacCallum
Jake Fink
Oscar Hinton