Get and maintain a handy optimized data structure of recent PM conversations

src/__tests__/lib/exampleData.js

@@ -539,6 +539,7 @@ export const action = deepFreeze({
       realm_users: [],
       user_id: 4,
       realm_user_groups: [],
+      recent_private_conversations: [],
       streams: [],
       never_subscribed: [],
       subscriptions: [],
@@ -592,6 +593,7 @@ export const action = deepFreeze({
     numAfter: 50,
     foundNewest: undefined,
     foundOldest: undefined,
+    ownUserId: selfUser.user_id,
   },
 });
 

src/actionTypes.js

@@ -220,6 +220,7 @@ type MessageFetchCompleteAction = {|
   numAfter: number,
   foundNewest: boolean | void,
   foundOldest: boolean | void,
+  ownUserId: number,
 |};
 
 type InitialFetchStartAction = {|

src/api/initialDataTypes.js

@@ -4,6 +4,7 @@ import type {
   CrossRealmBot,
   RealmEmojiById,
   RealmFilter,
+  RecentPrivateConversation,
   Stream,
   Subscription,
   User,
@@ -129,6 +130,14 @@ export type InitialDataRealmUserGroups = {|
   realm_user_groups?: UserGroup[],
 |};
 
+export type InitialDataRecentPmConversations = {|
+  // * Added in server commit 2.1-dev-384-g4c3c669b41.
+  // * `user_id` fields are sorted as of commit 2.2-dev-53-g405a529340, which
+  //    was backported to 2.1.1-50-gd452ad31e0 -- meaning that they are _not_
+  //    sorted in either v2.1.0 or v2.1.1.
+  recent_private_conversations?: RecentPrivateConversation[],
+|};
+
 type NeverSubscribedStream = {|
   description: string,
   invite_only: boolean,
@@ -307,6 +316,7 @@ export type InitialData = {|
   ...InitialDataRealmFilters,
   ...InitialDataRealmUser,
   ...InitialDataRealmUserGroups,
+  ...InitialDataRecentPmConversations,
   ...InitialDataStream,
   ...InitialDataSubscription,
   ...InitialDataUpdateDisplaySettings,

src/api/modelTypes.js

@@ -579,3 +579,29 @@ export type Message = $ReadOnly<{|
   subject: string,
   subject_links: $ReadOnlyArray<string>,
 |}>;
+
+//
+//
+//
+// ===================================================================
+// Summaries of messages and conversations.
+//
+//
+
+/**
+ * Describes a single recent PM conversation.
+ *
+ * See API documentation under `recent_private_conversations` at:
+ *   https://chat.zulip.org/api/register-queue
+ *
+ * Note that `user_ids` does not contain the `user_id` of the current user.
+ * Consequently, a user's conversation with themselves will be listed here
+ * as [], which is unlike the behaviour found in some other parts of the
+ * codebase.
+ */
+export type RecentPrivateConversation = {|
+  max_message_id: number,
+  // When received from the server, these are guaranteed to be sorted only after
+  // 2.2-dev-53-g405a529340. To be safe, we always sort them on receipt.
+  user_ids: number[],
+|};

src/boot/__tests__/__snapshots__/replaceRevive-test.js.snap

@@ -4,6 +4,8 @@ exports[`Stringify fallbackAvatarURL 1`] = `"{\\"data\\":\\"https://zulip.exampl
 
 exports[`Stringify gravatarURL 1`] = `"{\\"data\\":\\"https://secure.gravatar.com/avatar/3b01d0f626dc6944ed45dbe6c86d3e30?d=identicon\\",\\"__serializedType__\\":\\"GravatarURL\\"}"`;
 
+exports[`Stringify list 1`] = `"{\\"data\\":[1,2,\\"a\\",null],\\"__serializedType__\\":\\"ImmutableList\\"}"`;
+
 exports[`Stringify map 1`] = `"{\\"data\\":{\\"a\\":1,\\"b\\":2,\\"c\\":3,\\"d\\":4},\\"__serializedType__\\":\\"ImmutableMap\\"}"`;
 
 exports[`Stringify mapWithTypeKey 1`] = `"{\\"data\\":{\\"__serializedType__\\":\\"Object\\",\\"data\\":{\\"a\\":1},\\"__serializedType__value\\":{\\"__serializedType__\\":\\"Object\\",\\"data\\":{\\"b\\":[2]},\\"__serializedType__value\\":{\\"c\\":[3]}}},\\"__serializedType__\\":\\"ImmutableMap\\"}"`;

src/boot/__tests__/replaceRevive-test.js

@@ -10,6 +10,7 @@ import { stringify, parse, SERIALIZED_TYPE_FIELD_NAME } from '../replaceRevive';
 import * as eg from '../../__tests__/lib/exampleData';
 
 const data = {
+  list: Immutable.List([1, 2, 'a', null]),
   map: Immutable.Map({ a: 1, b: 2, c: 3, d: 4 }),
   mapWithTypeKey: Immutable.Map({
     a: 1,

src/boot/reducers.js

@@ -18,6 +18,7 @@ import narrows from '../chat/narrowsReducer';
 import messages from '../message/messagesReducer';
 import mute from '../mute/muteReducer';
 import outbox from '../outbox/outboxReducer';
+import { reducer as pmConversations } from '../pm-conversations/pmConversationsModel';
 import presence from '../presence/presenceReducer';
 import realm from '../realm/realmReducer';
 import session from '../session/sessionReducer';
@@ -46,6 +47,7 @@ const reducers = {
   narrows,
   mute,
   outbox,
+  pmConversations,
   presence,
   realm,
   session,

src/boot/replaceRevive.js

@@ -73,6 +73,8 @@ function replacer(key, value) {
         data: FallbackAvatarURL.serialize(value),
         [SERIALIZED_TYPE_FIELD_NAME]: 'FallbackAvatarURL',
       };
+    case (Immutable.List.prototype: $FlowFixMe):
+      return { data: value, [SERIALIZED_TYPE_FIELD_NAME]: 'ImmutableList' };
     case (Immutable.Map.prototype: $FlowFixMe):
       return { data: value, [SERIALIZED_TYPE_FIELD_NAME]: 'ImmutableMap' };
     default: {
@@ -132,6 +134,8 @@ function reviver(key, value) {
         return UploadedAvatarURL.deserialize(data);
       case 'FallbackAvatarURL':
         return FallbackAvatarURL.deserialize(data);
+      case 'ImmutableList':
+        return Immutable.List(data);
       case 'ImmutableMap':
         return Immutable.Map(data);
       case 'Object':

src/boot/store.js

@@ -67,7 +67,7 @@ export const storeKeys: Array<$Keys<GlobalState>> = [
  */
 // prettier-ignore
 export const cacheKeys: Array<$Keys<GlobalState>> = [
-  'flags', 'messages', 'mute', 'narrows', 'realm', 'streams',
+  'flags', 'messages', 'mute', 'narrows', 'pmConversations', 'realm', 'streams',
   'subscriptions', 'unread', 'userGroups', 'users',
 ];
 

src/chat/__tests__/narrowsReducer-test.js

@@ -379,6 +379,7 @@ describe('narrowsReducer', () => {
         numAfter: 100,
         foundNewest: false,
         foundOldest: false,
+        ownUserId: eg.selfUser.user_id,
       });
 
       const expectedState = Immutable.Map({
@@ -407,6 +408,7 @@ describe('narrowsReducer', () => {
         numAfter: 100,
         foundNewest: false,
         foundOldest: false,
+        ownUserId: eg.selfUser.user_id,
       });
 
       const expectedState = Immutable.Map({
@@ -434,6 +436,7 @@ describe('narrowsReducer', () => {
         numAfter: 100,
         foundNewest: false,
         foundOldest: false,
+        ownUserId: eg.selfUser.user_id,
       });
 
       const expectedState = Immutable.Map({
@@ -461,6 +464,7 @@ describe('narrowsReducer', () => {
         numAfter: 100,
         foundNewest: false,
         foundOldest: false,
+        ownUserId: eg.selfUser.user_id,
       });
 
       const expectedState = Immutable.Map({
@@ -487,6 +491,7 @@ describe('narrowsReducer', () => {
         numAfter: 0,
         foundNewest: true,
         foundOldest: false,
+        ownUserId: eg.selfUser.user_id,
       });
 
       const expectedState = Immutable.Map({

src/config.js

@@ -33,6 +33,7 @@ const config: Config = {
     'realm_filters',
     'realm_user',
     'realm_user_groups',
+    'recent_private_conversations',
     'stream',
     'subscription',
     'update_display_settings',

src/message/__tests__/fetchActions-test.js

@@ -133,6 +133,7 @@ describe('fetchActions', () => {
 
     const baseState = eg.reduxState({
       accounts: [eg.makeAccount()],
+      realm: { ...eg.baseReduxState.realm, user_id: eg.selfUser.user_id },
       narrows: Immutable.Map({
         [streamNarrowStr]: [message1.id],
       }),
@@ -299,6 +300,7 @@ describe('fetchActions', () => {
       const store = mockStore<GlobalState, Action>(
         eg.reduxState({
           accounts: [eg.selfAccount],
+          realm: { ...eg.baseReduxState.realm, user_id: eg.selfUser.user_id },
           narrows: Immutable.Map({
             [streamNarrowStr]: [1],
           }),
@@ -324,6 +326,7 @@ describe('fetchActions', () => {
       const store = mockStore<GlobalState, Action>(
         eg.reduxState({
           accounts: [eg.selfAccount],
+          realm: { ...eg.baseReduxState.realm, user_id: eg.selfUser.user_id },
           narrows: Immutable.Map({
             [streamNarrowStr]: [1],
           }),
@@ -348,6 +351,7 @@ describe('fetchActions', () => {
       const store = mockStore<GlobalState, Action>(
         eg.reduxState({
           accounts: [eg.selfAccount],
+          realm: { ...eg.baseReduxState.realm, user_id: eg.selfUser.user_id },
           narrows: Immutable.Map({
             [streamNarrowStr]: [1],
           }),

src/message/fetchActions.js

@@ -32,7 +32,8 @@ import { realmInit } from '../realm/realmActions';
 import { startEventPolling } from '../events/eventActions';
 import { logout } from '../account/accountActions';
 import { ZulipVersion } from '../utils/zulipVersion';
-import { getAllUsersById } from '../users/userSelectors';
+import { getAllUsersById, getOwnUserId } from '../users/userSelectors';
+import { MIN_RECENTPMS_SERVER_VERSION } from '../pm-conversations/pmConversationsModel';
 
 const messageFetchStart = (narrow: Narrow, numBefore: number, numAfter: number): Action => ({
   type: MESSAGE_FETCH_START,
@@ -58,8 +59,18 @@ const messageFetchComplete = (args: {|
   numAfter: number,
   foundNewest?: boolean,
   foundOldest?: boolean,
+  ownUserId: number,
 |}): Action => {
-  const { messages, narrow, anchor, numBefore, numAfter, foundNewest, foundOldest } = args;
+  const {
+    messages,
+    narrow,
+    anchor,
+    numBefore,
+    numAfter,
+    foundNewest,
+    foundOldest,
+    ownUserId,
+  } = args;
   return {
     type: MESSAGE_FETCH_COMPLETE,
     messages,
@@ -69,6 +80,7 @@ const messageFetchComplete = (args: {|
     numAfter,
     foundNewest,
     foundOldest,
+    ownUserId,
   };
 };
 
@@ -98,6 +110,7 @@ export const fetchMessages = (fetchArgs: {|
         messages,
         foundNewest: found_newest,
         foundOldest: found_oldest,
+        ownUserId: getOwnUserId(getState()),
       }),
     );
     return messages;
@@ -227,13 +240,14 @@ export const fetchMessagesInNarrow = (
 /**
  * Fetch the few most recent PMs.
  *
- * We do this eagerly in `doInitialFetch`, where it mainly serves to let us
- * show something useful in the PM conversations screen.  Recent server
- * versions have a custom-made API to help us do this better, which we hope
- * to use soon: see #3133.
+ * For old servers, we do this eagerly in `doInitialFetch`, in order to
+ * let us show something useful in the PM conversations screen.
+ * Zulip Server 2.1 added a custom-made API to help us do this better;
+ * see #3133.
  *
  * See `fetchMessagesInNarrow` for further background.
  */
+// TODO(server-2.1): Delete this.
 const fetchPrivateMessages = () => async (dispatch: Dispatch, getState: GetState) => {
   const auth = getAuth(getState());
   const { messages, found_newest, found_oldest } = await api.getMessages(auth, {
@@ -251,6 +265,7 @@ const fetchPrivateMessages = () => async (dispatch: Dispatch, getState: GetState
       numAfter: 0,
       foundNewest: found_newest,
       foundOldest: found_oldest,
+      ownUserId: getOwnUserId(getState()),
     }),
   );
 };
@@ -335,11 +350,14 @@ export const doInitialFetch = () => async (dispatch: Dispatch, getState: GetStat
     return;
   }
 
-  dispatch(realmInit(initData, new ZulipVersion(serverSettings.zulip_version)));
+  const serverVersion = new ZulipVersion(serverSettings.zulip_version);
+  dispatch(realmInit(initData, serverVersion));
   dispatch(initialFetchComplete());
   dispatch(startEventPolling(initData.queue_id, initData.last_event_id));
 
-  dispatch(fetchPrivateMessages());
+  if (!serverVersion.isAtLeast(MIN_RECENTPMS_SERVER_VERSION)) {
+    dispatch(fetchPrivateMessages());
+  }
 
   dispatch(sendOutbox());
   dispatch(initNotifications());