Add missing types to session store module

This found apparent missing checks for a null `profile.userid` (ie. current user
is logged out) in several places. These places should not be reachable
when the user is logged out due to checks elsewhere, but add explicit
checks for the user being logged in.

src/sidebar/components/Annotation/Annotation.js

@@ -88,7 +88,7 @@ function Annotation({
     !isReply && !isEditing && !hasAppliedFilter && replyCount > 0;
 
   const onReply = () => {
-    if (annotation && isSaved(annotation)) {
+    if (annotation && isSaved(annotation) && userid) {
       annotationsService.reply(annotation, userid);
     }
   };

src/sidebar/helpers/account-id.js

@@ -22,7 +22,7 @@ export function parseAccountID(user) {
 /**
  * Returns the username part of an account ID or an empty string.
  *
- * @param {string} user
+ * @param {string|null} user
  */
 export function username(user) {
   const account = parseAccountID(user);

src/sidebar/services/annotations.js

@@ -68,6 +68,10 @@ export class AnnotationsService {
     }
 
     const userid = profile.userid;
+    if (!userid) {
+      throw new Error('Cannot create annotation when logged out');
+    }
+
     const userInfo = profile.user_info;
 
     // We need a unique local/app identifier for this new annotation such

src/sidebar/services/test/annotations-test.js

@@ -14,6 +14,14 @@ describe('AnnotationsService', () => {
 
   let svc;
 
+  function setLoggedIn(loggedIn) {
+    const profile = loggedIn
+      ? { userid: 'acct:foo@bar.com', user_info: {} }
+      : { userid: null };
+    fakeStore.profile.returns(profile);
+    fakeStore.isLoggedIn.returns(loggedIn);
+  }
+
   beforeEach(() => {
     fakeAnnotationActivity = {
       reportActivity: sinon.stub(),
@@ -59,6 +67,8 @@ describe('AnnotationsService', () => {
       updateFlagStatus: sinon.stub(),
     };
 
+    setLoggedIn(true);
+
     $imports.$mock({
       '../helpers/annotation-metadata': fakeMetadata,
       '../helpers/permissions': {
@@ -90,10 +100,6 @@ describe('AnnotationsService', () => {
       now = new Date();
 
       fakeStore.focusedGroupId.returns('mygroup');
-      fakeStore.profile.returns({
-        userid: 'acct:foo@bar.com',
-        user_info: {},
-      });
     });
 
     it('extends the provided annotation object with defaults', () => {
@@ -232,6 +238,14 @@ describe('AnnotationsService', () => {
       assert.calledWith(fakeStore.setExpanded, 'yetanotherancestor', true);
     });
 
+    it('throws if the user is not logged in', () => {
+      setLoggedIn(false);
+
+      assert.throws(() => {
+        svc.create(fixtures.newAnnotation(), now);
+      }, 'Cannot create annotation when logged out');
+    });
+
     it('throws an error if there is no focused group', () => {
       fakeStore.focusedGroupId.returns(null);
 
@@ -243,7 +257,7 @@ describe('AnnotationsService', () => {
 
   describe('createPageNote', () => {
     it('should open the login-prompt panel if the user is not logged in', () => {
-      fakeStore.isLoggedIn.returns(false);
+      setLoggedIn(false);
 
       svc.createPageNote();
 

src/sidebar/store/modules/session.js

-import * as util from '../util';
-
-import { createStoreModule } from '../create-store';
+import { createStoreModule, makeAction } from '../create-store';
 
 /**
  * @typedef {import('../../../types/api').Profile} Profile
@@ -49,28 +47,28 @@ function initialState(settings) {
 }
 
 const reducers = {
-  UPDATE_PROFILE: function (state, action) {
+  /**
+   * @param {State} state
+   * @param {{ profile: Profile }} action
+   */
+  UPDATE_PROFILE(state, action) {
     return {
       profile: { ...action.profile },
     };
   },
 };
 
-const actions = util.actionTypes(reducers);
-
 /**
  * Update the profile information for the current user.
+ *
+ * @param {Profile} profile
  */
 function updateProfile(profile) {
-  return {
-    type: actions.UPDATE_PROFILE,
-    profile,
-  };
+  return makeAction(reducers, 'UPDATE_PROFILE', { profile });
 }
 
 /**
- *
- * @return {string}
+ * @param {State} state
  */
 function defaultAuthority(state) {
   return state.defaultAuthority;
@@ -79,7 +77,7 @@ function defaultAuthority(state) {
 /**
  * Return true if a user is logged in and false otherwise.
  *
- * @param {object} state - The application state
+ * @param {State} state
  */
 function isLoggedIn(state) {
   return state.profile.userid !== null;
@@ -88,7 +86,7 @@ function isLoggedIn(state) {
 /**
  * Return true if a given feature flag is enabled for the current user.
  *
- * @param {object} state - The application state
+ * @param {State} state
  * @param {string} feature - The name of the feature flag. This matches the
  *        name of the feature flag as declared in the Hypothesis service.
  */
@@ -100,6 +98,8 @@ function isFeatureEnabled(state, feature) {
  * Return true if the user's profile has been fetched. This can be used to
  * distinguish the dummy profile returned by `profile()` on startup from a
  * logged-out user profile returned by the server.
+ *
+ * @param {State} state
  */
 function hasFetchedProfile(state) {
   return state.profile !== initialProfile;
@@ -112,6 +112,8 @@ function hasFetchedProfile(state) {
  *
  * If the profile has not yet been fetched yet, a dummy logged-out profile is
  * returned. This allows code to skip a null check.
+ *
+ * @param {State} state
  */
 function profile(state) {
   return state.profile;