presence: Encapsulate getUserLastActiveAsRelativeTimeString's various data needs

This will make it easier for this selector to add yet one more little
piece of data it needs to consult.

It'll also give us the opportunity to simplify the logic a bit;
we'll do that next.

While here, reduce the number of separate times we consult Date.now.

Author: gnprice

src/presence/__tests__/presenceModel-test.js

@@ -2,16 +2,18 @@
 
 import deepFreeze from 'deep-freeze';
 
+import Immutable from 'immutable';
 import * as eg from '../../__tests__/lib/exampleData';
 import { PRESENCE_RESPONSE, EVENT_PRESENCE } from '../../actionConstants';
 import {
   reducer as presenceReducer,
   getAggregatedPresence,
-  userLastActiveAsRelativeTimeString,
   statusFromPresence,
   statusFromPresenceAndUserStatus,
+  getUserLastActiveAsRelativeTimeString,
 } from '../presenceModel';
 import { makePresenceState } from './presence-testlib';
+import type { UserPresence, UserStatus } from '../../api/modelTypes';
 
 const currentTimestamp = Date.now() / 1000;
 
@@ -85,52 +87,59 @@ describe('getAggregatedPresence', () => {
   });
 });
 
-describe('userLastActiveAsRelativeTimeString', () => {
-  test('given a presence return a relative time', () => {
-    expect(
-      userLastActiveAsRelativeTimeString(
-        {
-          aggregated: { client: 'website', status: 'active', timestamp: currentTimestamp - 240 },
-        },
-        { away: false, status_text: null, status_emoji: null },
-        eg.recentZulipFeatureLevel,
-      ),
-    ).toBe('4 minutes ago');
+describe('getUserLastActiveAsRelativeTimeString', () => {
+  function lastActiveString(args: {
+    userPresence: UserPresence,
+    userStatus: UserStatus,
+    zulipFeatureLevel?: number,
+  }): string | null {
+    const { userPresence, userStatus, zulipFeatureLevel = eg.recentZulipFeatureLevel } = args;
+    return getUserLastActiveAsRelativeTimeString(
+      eg.reduxStatePlus({
+        presence: makePresenceState([[eg.otherUser, userPresence]]),
+        userStatuses: Immutable.Map([[eg.otherUser.user_id, userStatus]]),
+        accounts: [{ ...eg.plusReduxState.accounts[0], zulipFeatureLevel }],
+      }),
+      eg.otherUser,
+      currentTimestamp * 1000,
+    );
+  }
+
+  test('a recent time', () => {
+    const userPresence = {
+      aggregated: { client: 'website', status: 'active', timestamp: currentTimestamp - 240 },
+    };
+    const userStatus = { away: false, status_text: null, status_emoji: null };
+    expect(lastActiveString({ userPresence, userStatus })).toBe('4 minutes ago');
   });
 
   test('if less than a threshold, the user is currently active', () => {
-    expect(
-      userLastActiveAsRelativeTimeString(
-        {
-          aggregated: { client: 'website', status: 'active', timestamp: currentTimestamp - 100 },
-        },
-        { away: false, status_text: null, status_emoji: null },
-        eg.recentZulipFeatureLevel,
-      ),
-    ).toBe('now');
+    const userPresence = {
+      aggregated: { client: 'website', status: 'active', timestamp: currentTimestamp - 100 },
+    };
+    const userStatus = { away: false, status_text: null, status_emoji: null };
+    expect(lastActiveString({ userPresence, userStatus })).toBe('now');
   });
 
   // TODO(server-6.0): Remove
   test('Pre-FL 148: if less than a day and user is "away", use imprecise "today"', () => {
-    expect(
-      userLastActiveAsRelativeTimeString(
-        { aggregated: { client: 'website', status: 'active', timestamp: currentTimestamp - 100 } },
-        { away: true, status_text: null, status_emoji: null },
-        147,
-      ),
-    ).toBe('today');
+    const userPresence = {
+      aggregated: { client: 'website', status: 'active', timestamp: currentTimestamp - 100 },
+    };
+    const userStatus = { away: true, status_text: null, status_emoji: null };
+    const zulipFeatureLevel = 147;
+    expect(lastActiveString({ userPresence, userStatus, zulipFeatureLevel })).toBe('today');
   });
 
   // TODO(server-6.0): Remove, once this test case is redundant with those
   //   above after the status parameter is gone.
   test('FL 148: if less than a day and user is "away", *don\'t* use imprecise "today"', () => {
-    expect(
-      userLastActiveAsRelativeTimeString(
-        { aggregated: { client: 'website', status: 'active', timestamp: currentTimestamp - 100 } },
-        { away: true, status_text: null, status_emoji: null },
-        148,
-      ),
-    ).not.toBe('today');
+    const userPresence = {
+      aggregated: { client: 'website', status: 'active', timestamp: currentTimestamp - 100 },
+    };
+    const userStatus = { away: true, status_text: null, status_emoji: null };
+    const zulipFeatureLevel = 148;
+    expect(lastActiveString({ userPresence, userStatus, zulipFeatureLevel })).not.toBe('today');
   });
 });
 

src/presence/presenceModel.js

@@ -25,6 +25,7 @@ import {
   REGISTER_COMPLETE,
   RESET_ACCOUNT_DATA,
 } from '../actionConstants';
+import type { UserOrBot } from '../api/modelTypes';
 
 //
 //
@@ -111,11 +112,18 @@ export const getAggregatedPresence = (presence: UserPresence): ClientPresence =>
   return { client, status, timestamp };
 };
 
-export const userLastActiveAsRelativeTimeString = (
-  presence: UserPresence,
-  status: UserStatus,
-  zulipFeatureLevel: number,
-): string => {
+export function getUserLastActiveAsRelativeTimeString(
+  state: PerAccountState,
+  user: UserOrBot,
+  dateNow: number,
+): string | null {
+  const presence = getUserPresenceByEmail(getPresence(state), user.email);
+  if (!presence) {
+    return null;
+  }
+  const userStatus = getUserStatus(state, user.user_id);
+  const zulipFeatureLevel = getZulipFeatureLevel(state);
+
   if (!presence || !presence.aggregated) {
     return 'never';
   }
@@ -124,17 +132,17 @@ export const userLastActiveAsRelativeTimeString = (
 
   // "Invisible mode", new in FL 148, doesn't involve UserStatus['away']:
   //   https://chat.zulip.org/#narrow/stream/2-general/topic/.22unavailable.22.20status/near/1454779
-  // TODO(server-6.0): Remove this `if` block and the `status` parameter.
-  if (zulipFeatureLevel < 148 && status.away && differenceInDays(Date.now(), lastTimeActive) < 1) {
+  // TODO(server-6.0): Simplify this away.
+  if (zulipFeatureLevel < 148 && userStatus.away && differenceInDays(dateNow, lastTimeActive) < 1) {
     // Be vague when an unavailable user is recently online.
     // TODO: This phrasing doesn't really match the logic and can be misleading.
     return 'today';
   }
 
-  return differenceInSeconds(Date.now(), lastTimeActive) < OFFLINE_THRESHOLD_SECS
+  return differenceInSeconds(dateNow, lastTimeActive) < OFFLINE_THRESHOLD_SECS
     ? 'now'
     : `${formatDistanceToNow(lastTimeActive)} ago`;
-};
+}
 
 export const statusFromPresence = (presence: UserPresence | void): PresenceStatus => {
   if (!presence || !presence.aggregated) {

src/title/ActivityText.js

@@ -6,13 +6,7 @@ import type { TextStyleProp } from 'react-native/Libraries/StyleSheet/StyleSheet
 
 import type { UserOrBot } from '../types';
 import { useSelector } from '../react-redux';
-import { getZulipFeatureLevel } from '../selectors';
-import {
-  getPresence,
-  getUserPresenceByEmail,
-  userLastActiveAsRelativeTimeString,
-} from '../presence/presenceModel';
-import { getUserStatus } from '../user-statuses/userStatusesModel';
+import { getUserLastActiveAsRelativeTimeString } from '../presence/presenceModel';
 import ZulipText from '../common/ZulipText';
 
 type Props = $ReadOnly<{|
@@ -21,19 +15,14 @@ type Props = $ReadOnly<{|
 |}>;
 
 export default function ActivityText(props: Props): Node {
-  const { style } = props;
+  const { style, user } = props;
 
-  const zulipFeatureLevel = useSelector(getZulipFeatureLevel);
-  const presence = useSelector(state =>
-    getUserPresenceByEmail(getPresence(state), props.user.email),
+  const activeTime = useSelector(state =>
+    getUserLastActiveAsRelativeTimeString(state, user, Date.now()),
   );
-  const userStatus = useSelector(state => getUserStatus(state, props.user.user_id));
-
-  if (!presence) {
+  if (activeTime == null) {
     return null;
   }
 
-  const activeTime = userLastActiveAsRelativeTimeString(presence, userStatus, zulipFeatureLevel);
-
   return <ZulipText style={style} text={`Active ${activeTime}`} />;
 }