enh(welcome): 🌟 improving the first login experience on DESKTOP incarnation #128

Author: dvorka

CHANGELOG.md

@@ -8,10 +8,14 @@ This MyTraL **minor** release brings:
 - .
 
 ### Added
-- .
+- Smooth first start for the desktop application: when no user profile exists
+  yet, a default `athlete` user ("MyTraL Athlete") is auto-created and
+  auto-logged in, landing straight on the dashboard - no sign-up/login step
+  required. Logging out disables auto-login until the next explicit login,
+  so a second/third user can be added or logged into from the login page.
 
 ### Fixed
-- .
+- Fixed path(s) in Snap which pointed outside of strict confinement filesystem.
 
 ### Documentation
 - .

INSTALLATION.md

@@ -33,6 +33,16 @@ Tarball:
 # Install
 Install MyTraL desktop application.
 
+### First launch
+
+The desktop application is ready to use right after install - no sign-up or
+login is needed. On the very first start, when no user profile exists yet, a
+default `athlete` user ("MyTraL Athlete") is created automatically and you are
+logged straight into the dashboard. You can rename this user, change its
+password, or create additional users from the profile page at any time.
+Logging out disables auto-login until you log back in explicitly, so the
+login page lets you pick an existing user or add a new one.
+
 
 
 ## Install on Ubuntu from PPA

docs/CHANGELOG.md

@@ -8,10 +8,14 @@ This MyTraL **minor** release brings:
 - .
 
 ### Added
-- .
+- Smooth first start for the desktop application: when no user profile exists
+  yet, a default `athlete` user ("MyTraL Athlete") is auto-created and
+  auto-logged in, landing straight on the dashboard - no sign-up/login step
+  required. Logging out disables auto-login until the next explicit login,
+  so a second/third user can be added or logged into from the login page.
 
 ### Fixed
-- .
+- Fixed path(s) in Snap which pointed outside of strict confinement filesystem.
 
 ### Documentation
 - .

docs/INSTALLATION.md

@@ -33,6 +33,16 @@ Tarball:
 # Install
 Install MyTraL desktop application.
 
+### First launch
+
+The desktop application is ready to use right after install - no sign-up or
+login is needed. On the very first start, when no user profile exists yet, a
+default `athlete` user ("MyTraL Athlete") is created automatically and you are
+logged straight into the dashboard. You can rename this user, change its
+password, or create additional users from the profile page at any time.
+Logging out disables auto-login until you log back in explicitly, so the
+login page lets you pick an existing user or add a new one.
+
 
 
 ## Install on Ubuntu from PPA

mytral/__init__.py

@@ -18,6 +18,7 @@
 """MyTraL main module: configure and start the web application."""
 
 from mytral import blobstore as _blobstore_pkg
+from mytral import bootstraps
 from mytral import config
 from mytral import loggers
 from mytral import releng
@@ -62,6 +63,12 @@
 app_ds = dataset.MyTraLDataset(mytral_config=app_config, logger=app_logger)
 # MyTraL user dataset: persistence agnostic access to the user data
 app_user_ds = app_ds.user()
+
+# smooth first start: auto-create the default athlete user on desktop
+# installations which don't have any user profile yet
+if app_config.incarnation == config.MytralIncarnation.DESKTOP:
+    bootstraps.bootstrap_default_desktop_user(ds=app_user_ds, logger=app_logger)
+
 # blob store for activity attachments (GPX files and photos)
 app_blobstore = _blobstore_pkg.create_blobstore(app_config)
 

mytral/backends/dataset.py

@@ -94,7 +94,9 @@ def register_new_user(
         self,
         user_name: str = commons.DEFAULT_USER_NAME,
         user_id: str = "",
+        user_display_name: str = "",
         password_enc: str = "",
+        auto_login: bool = False,
     ):
         """Create new user (sandbox / entries / tables).
 
@@ -104,8 +106,13 @@ def register_new_user(
             Username.
         user_id : str
             Unique user ID.
+        user_display_name : str
+            Display name shown in the UI.
         password_enc : str
             Encrypted password.
+        auto_login : bool
+            Whether the new profile should have auto-login enabled
+            (DESKTOP incarnation only).
 
         """
         raise NotImplementedError

mytral/backends/datasets/dataset_json.py

@@ -1081,6 +1081,7 @@ def register_new_user(
         user_id: str = "",
         user_display_name: str = "",
         password_enc: str = "",
+        auto_login: bool = False,
     ):
         self.user_dir(user_id)
 
@@ -1100,6 +1101,7 @@ def register_new_user(
                 born_day=commons.BOOTSTRAP_BORN_DAY,
                 height=commons.BOOTSTRAP_HEIGHT_CM,
                 gender=True,
+                auto_login=auto_login,
             )
         )
 

mytral/blueprints/auth_uri_space.py

@@ -31,6 +31,7 @@
 from mytral import security
 from mytral import settings as user_settings
 from mytral.migrations import FsPersistenceMigrations
+from mytral.routes import COOKIE_AUTO_LOGIN_SUPPRESSED
 from mytral.routes import COOKIE_MOBILE
 from mytral.routes import COOKIE_TOKEN
 from mytral.routes import COOKIE_USER
@@ -162,6 +163,8 @@ def signup():
             # log user in - store user_id (UUID) not username
             flask.session[COOKIE_USER] = user_id
             flask.session[COOKIE_TOKEN] = uuid.uuid4()
+            # a fresh, explicit login re-enables auto-login for the next boot
+            flask.session.pop(COOKIE_AUTO_LOGIN_SUPPRESSED, None)
 
             flask.flash(
                 message=f"Welcome {new_username}! Your account has been created.",
@@ -204,7 +207,24 @@ def login():
 
         auto_login_usernames = []
         if app_config.incarnation == config.MytralIncarnation.DESKTOP:
-            auto_login_usernames = list(ds.list_profile_names(auto_login=True).keys())
+            auto_login_profiles = ds.list_profile_names(auto_login=True)
+            auto_login_usernames = list(auto_login_profiles.keys())
+
+            # smooth first start / single-user desktop: silently log in as the
+            # sole auto-login user, unless the user just logged out on purpose
+            if len(auto_login_profiles) == 1 and not flask.session.get(
+                COOKIE_AUTO_LOGIN_SUPPRESSED, False
+            ):
+                user_name, user_id = next(iter(auto_login_profiles.items()))
+
+                flask.session[COOKIE_USER] = user_id
+                flask.session[COOKIE_TOKEN] = str(uuid.uuid4())
+
+                flask.flash(
+                    message=f"Auto logged in as user '{user_name}'",
+                    category="success",
+                )
+                return flask.redirect(flask.url_for("home"))
 
         return flask.render_template(
             "log-in.html",
@@ -294,6 +314,8 @@ def login():
         flask.session[COOKIE_USER] = user_id
         # safe foo token to client cookies
         flask.session[COOKIE_TOKEN] = str(uuid.uuid4())
+        # a fresh, explicit login re-enables auto-login for the next boot
+        flask.session.pop(COOKIE_AUTO_LOGIN_SUPPRESSED, None)
 
         # if the page width is <800px, then switch to mobile view
         app_logger.debug(f"Storing page width to session: {form.page_width.data}")
@@ -362,6 +384,9 @@ def logout():
     flask.session.pop(COOKIE_TOKEN, None)
     if user_id:
         ds.cache_evict(user_id=user_id)
+    # desktop: suppress auto-login so the user can pick/create another account
+    if app_config.incarnation == config.MytralIncarnation.DESKTOP:
+        flask.session[COOKIE_AUTO_LOGIN_SUPPRESSED] = True
     return flask.redirect(flask.url_for("login"))
 
 

mytral/bootstraps.py

@@ -16,3 +16,47 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 """Bootstrap related code."""
+
+import uuid
+
+from mytral import commons
+from mytral import loggers
+from mytral import security
+from mytral.backends import dataset
+
+
+def bootstrap_default_desktop_user(
+    ds: dataset.UserDataset, logger: loggers.MytralStructLogger
+) -> None:
+    """Auto-create the default athlete user on the first DESKTOP boot.
+
+    Smooth first start: DESKTOP incarnation with no user profile on disk yet
+    gets a default user (with auto-login enabled) so that it can go straight
+    to the dashboard, without sign-up/login. Installations which already have
+    at least one profile are left untouched.
+
+    Parameters
+    ----------
+    ds : dataset.UserDataset
+        User dataset used to check for existing profiles and register the
+        default user.
+    logger : loggers.MytralStructLogger
+        Logger used to record that the default user was created.
+
+    """
+    if ds.list_profiles():
+        return
+
+    user_id = str(uuid.uuid4())
+    ds.register_new_user(
+        user_name=commons.DEFAULT_DESKTOP_USER_NAME,
+        user_id=user_id,
+        user_display_name=commons.DEFAULT_DESKTOP_USER_DISPLAY_NAME,
+        password_enc=security.hash_password(commons.DEFAULT_DESKTOP_USER_PASSWORD),
+        auto_login=True,
+    )
+    logger.info(
+        "Bootstrapped default desktop user",
+        user_name=commons.DEFAULT_DESKTOP_USER_NAME,
+        user_id=user_id,
+    )

mytral/commons.py

@@ -29,6 +29,11 @@
 # default user name (desktop app installation)
 DEFAULT_USER_NAME = "dvorka"
 
+# default user auto-created on the first DESKTOP boot when no user exists yet
+DEFAULT_DESKTOP_USER_NAME = "athlete"
+DEFAULT_DESKTOP_USER_DISPLAY_NAME = "MyTraL Athlete"
+DEFAULT_DESKTOP_USER_PASSWORD = "changeit"
+
 #
 # DATASETS & PERSISTENCE
 #