From 633c6b39f6a1dd98613898287499ec7696a95099 Mon Sep 17 00:00:00 2001
From: Luke Barnard <lukeb@openmarket.com>
Date: Tue, 16 May 2017 11:58:37 +0100
Subject: [PATCH] Add comment to Lifecycle

---
 src/Lifecycle.js | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/Lifecycle.js b/src/Lifecycle.js
index decb544b3c..20d5836dae 100644
--- a/src/Lifecycle.js
+++ b/src/Lifecycle.js
@@ -185,6 +185,14 @@ function _registerAsGuest(hsUrl, isUrl, defaultDeviceDisplayName) {
 
 // returns a promise which resolves to true if a session is found in
 // localstorage
+//
+// N.B. Lifecycle.js should not maintain any further localStorage state, we
+//      are moving towards using SessionStore to keep track of state related
+//      to the current session (which is typically backed by localStorage).
+//
+//      The plan is to gradually move the localStorage access done here into
+//      SessionStore to avoid bugs where the view becomes out-of-sync with
+//      localStorage (e.g. teamToken, isGuest etc.)
 function _restoreFromLocalStorage() {
     if (!localStorage) {
         return q(false);