redux types: Split PerAccountSessionState from SessionState

Author: gnprice

src/session/sessionReducer.js

@@ -19,6 +19,41 @@ import {
 } from '../actionConstants';
 import { getHasAuth } from '../account/accountsSelectors';
 
+/**
+ * Miscellaneous non-persistent state specific to a particular account.
+ *
+ * See {@link SessionState} for discussion of what "non-persistent" means.
+ */
+export type PerAccountSessionState = $ReadOnly<{
+  eventQueueId: number,
+
+  /**
+   * Whether the /register request is in progress.
+   *
+   * This happens on startup, or on re-init following a dead event
+   * queue after 10 minutes of inactivity.
+   */
+  loading: boolean,
+
+  needsInitialFetch: boolean,
+
+  outboxSending: boolean,
+
+  /**
+   * Whether `ServerCompatNotice` (which we'll add soon) has been
+   *   dismissed this session.
+   *
+   * We put this in the per-session state deliberately, so that users
+   * see the notice on every startup until the server is upgraded.
+   * That's a better experience than not being able to load the realm
+   * on mobile at all, which is what will happen soon if the user
+   * doesn't act on the notice.
+   */
+  hasDismissedServerCompatNotice: boolean,
+
+  ...
+}>;
+
 /**
  * Miscellaneous non-persistent state about this run of the app.
  *
@@ -28,25 +63,19 @@ import { getHasAuth } from '../account/accountsSelectors';
  * initialized to their default values.
  */
 export type SessionState = $ReadOnly<{|
-  eventQueueId: number,
+  ...$Exact<PerAccountSessionState>,
+
+  // The properties below are data about the device and the app as a whole,
+  // independent of any particular Zulip server or account.
+  // For per-account data, see PerAccountSessionState.
 
   // `null` if we don't know. See the place where we set this, for what that
   // means.
   isOnline: boolean | null,
 
   isHydrated: boolean,
 
-  /**
-   * Whether the /register request is in progress.
-   *
-   * This happens on startup, or on re-init following a dead event
-   * queue after 10 minutes of inactivity.
-   */
-  loading: boolean,
-
-  needsInitialFetch: boolean,
   orientation: Orientation,
-  outboxSending: boolean,
 
   /**
    * Our actual device token, as most recently learned from the system.
@@ -67,20 +96,13 @@ export type SessionState = $ReadOnly<{|
   pushToken: string | null,
 
   debug: Debug,
-
-  /**
-   * Whether `ServerCompatNotice` (which we'll add soon) has been
-   *   dismissed this session.
-   *
-   * We put this in the per-session state deliberately, so that users
-   * see the notice on every startup until the server is upgraded.
-   * That's a better experience than not being able to load the realm
-   * on mobile at all, which is what will happen soon if the user
-   * doesn't act on the notice.
-   */
-  hasDismissedServerCompatNotice: boolean,
 |}>;
 
+// As part of letting GlobalState freely convert to PerAccountState,
+// we'll want the same for SessionState.  (This is also why
+// PerAccountSessionState is inexact.)
+(s: SessionState): PerAccountSessionState => s; // eslint-disable-line no-unused-expressions
+
 const initialState: SessionState = {
   eventQueueId: -1,