internalLinks: Parse '/dm/…' and '/is/dm' in narrow links

These are synonymous with '/pm-with/…' and '/is/private',
respectively, and they'll start appearing in messages on newer
servers, as part of the renaming of "private message" to "direct
message".

Mobile still generates links with the old '/pm-with/…' format in
quote-and-reply. Those will still probably be supported
indefinitely, but it'd be cleanest to switch to generating the new
format, with a feature-level condition. Once the server/web-app
merge code that uses the new format, we'll know what feature level
to use.

Fixes: #5692

Author: chrisbobbe

src/utils/__tests__/internalLinks-test.js

@@ -47,7 +47,8 @@ describe('isNarrowLink', () => {
     [true, 'with numeric stream ID', urlOnRealm('#narrow/stream/123-jest')],
     [true, 'with numeric stream ID and topic', urlOnRealm('#narrow/stream/123-jest/topic/topic1')],
 
-    [true, 'with numeric pm user IDs', urlOnRealm('#narrow/pm-with/123-mark')],
+    [true, 'with numeric pm user IDs (new operator)', urlOnRealm('#narrow/dm/123-mark')],
+    [true, 'with numeric pm user IDs (old operator)', urlOnRealm('#narrow/pm-with/123-mark')],
 
     [false, 'wrong fragment', urlOnRealm('#nope')],
     [false, 'wrong path', urlOnRealm('/user_uploads/#narrow/stream/jest')],
@@ -183,6 +184,15 @@ describe('getNarrowFromNarrowLink (part 1)', () => {
     ].forEach(hash => check(hash));
   });
 
+  describe('"/#narrow/dm/<…>" is a PM link', () => {
+    const check = mkCheck(isPmNarrow);
+    [
+      '/#narrow/dm/1,2-group',
+      '/#narrow/dm/1,2-group/near/1',
+      '/#narrow/dm/a.40b.2Ecom.2Ec.2Ed.2Ecom/near/3',
+    ].forEach(hash => check(hash));
+  });
+
   describe('"/#narrow/pm-with/<…>" is a PM link', () => {
     const check = mkCheck(isPmNarrow);
     [
@@ -194,9 +204,12 @@ describe('getNarrowFromNarrowLink (part 1)', () => {
 
   describe('"/#narrow/is/<…>" with valid operand is a special link', () => {
     const check = mkCheck(isSpecialNarrow);
-    ['/#narrow/is/private', '/#narrow/is/starred', '/#narrow/is/mentioned'].forEach(hash =>
-      check(hash),
-    );
+    [
+      '/#narrow/is/dm',
+      '/#narrow/is/private',
+      '/#narrow/is/starred',
+      '/#narrow/is/mentioned',
+    ].forEach(hash => check(hash));
   });
 
   describe('unexpected link shape gives null', () => {
@@ -375,6 +388,9 @@ describe('getNarrowFromNarrowLink (part 2)', () => {
 
   test('on group PM link', () => {
     const ids = `${userB.user_id},${userC.user_id}`;
+    expect(get(`https://example.com/#narrow/dm/${ids}-group`, [])).toEqual(
+      pmNarrowFromUsersUnsafe([userB, userC]),
+    );
     expect(get(`https://example.com/#narrow/pm-with/${ids}-group`, [])).toEqual(
       pmNarrowFromUsersUnsafe([userB, userC]),
     );
@@ -383,19 +399,26 @@ describe('getNarrowFromNarrowLink (part 2)', () => {
   test('on group PM link including self', () => {
     // The webapp doesn't generate these, but best to handle them anyway.
     const ids = `${eg.selfUser.user_id},${userB.user_id},${userC.user_id}`;
+    expect(get(`https://example.com/#narrow/dm/${ids}-group`, [])).toEqual(
+      pmNarrowFromUsersUnsafe([userB, userC]),
+    );
     expect(get(`https://example.com/#narrow/pm-with/${ids}-group`, [])).toEqual(
       pmNarrowFromUsersUnsafe([userB, userC]),
     );
   });
 
   test('on a special link', () => {
+    expect(get('/#narrow/is/dm', [])).toEqual(ALL_PRIVATE_NARROW);
     expect(get('/#narrow/is/private', [])).toEqual(ALL_PRIVATE_NARROW);
     expect(get('/#narrow/is/starred', [])).toEqual(STARRED_NARROW);
     expect(get('/#narrow/is/mentioned', [])).toEqual(MENTIONED_NARROW);
   });
 
   test('on a message link', () => {
     const ids = `${userB.user_id},${userC.user_id}`;
+    expect(get(`https://example.com/#narrow/dm/${ids}-group/near/2`, [])).toEqual(
+      pmNarrowFromUsersUnsafe([userB, userC]),
+    );
     expect(get(`https://example.com/#narrow/pm-with/${ids}-group/near/2`, [])).toEqual(
       pmNarrowFromUsersUnsafe([userB, userC]),
     );
@@ -421,6 +444,7 @@ describe('getNearOperandFromLink', () => {
   });
 
   test('when link is a group link, return anchor message id', () => {
+    expect(getNearOperandFromLink(new URL('/#narrow/dm/1,3-group/near/1/', realm), realm)).toBe(1);
     expect(
       getNearOperandFromLink(new URL('/#narrow/pm-with/1,3-group/near/1/', realm), realm),
     ).toBe(1);

src/utils/internalLinks.js

@@ -144,8 +144,11 @@ export const getNarrowFromNarrowLink = (
   const hashSegments = getHashSegmentsFromNarrowLink(url, realm);
 
   if (
-    (hashSegments.length === 2 && hashSegments[0] === 'pm-with')
-    || (hashSegments.length === 4 && hashSegments[0] === 'pm-with' && hashSegments[2] === 'near')
+    // 'dm' is new in server-7.0; means the same as 'pm-with'
+    (hashSegments.length === 2 && (hashSegments[0] === 'pm-with' || hashSegments[0] === 'dm'))
+    || (hashSegments.length === 4
+      && (hashSegments[0] === 'pm-with' || hashSegments[0] === 'dm')
+      && hashSegments[2] === 'near')
   ) {
     // TODO: This case is pretty useless in practice, due to basically a
     //   bug in the webapp: the URL that appears in the location bar for a
@@ -175,9 +178,18 @@ export const getNarrowFromNarrowLink = (
     && hashSegments[0] === 'is'
     && (hashSegments[1] === 'starred'
       || hashSegments[1] === 'mentioned'
+      || hashSegments[1] === 'dm' // new in server-7.0; means the same as 'private'
       || hashSegments[1] === 'private')
   ) {
-    return specialNarrow(hashSegments[1]);
+    switch (hashSegments[1]) {
+      case 'starred':
+        return specialNarrow('starred');
+      case 'mentioned':
+        return specialNarrow('mentioned');
+      case 'dm':
+      case 'private':
+        return specialNarrow('dm');
+    }
   }
 
   return null; // TODO(?) Give HOME_NARROW

src/utils/narrow.js

@@ -124,13 +124,13 @@ export const pmNarrowFromUsersUnsafe = (recipients: $ReadOnlyArray<UserOrBot>):
 export const pm1to1NarrowFromUser = (user: UserOrBot): Narrow =>
   pmNarrowInternal(pmKeyRecipientsFor1to1(user.user_id));
 
-export const specialNarrow = (operand: 'starred' | 'mentioned' | 'private'): Narrow => {
+export const specialNarrow = (operand: 'starred' | 'mentioned' | 'dm'): Narrow => {
   switch (operand) {
     case 'starred':
       return Object.freeze({ type: 'starred' });
     case 'mentioned':
       return Object.freeze({ type: 'mentioned' });
-    case 'private':
+    case 'dm':
       return Object.freeze({ type: 'all-pm' });
     default:
       ensureUnreachable(operand);
@@ -146,7 +146,7 @@ export const MENTIONED_NARROW: Narrow = specialNarrow('mentioned');
 
 export const MENTIONED_NARROW_STR: string = keyFromNarrow(MENTIONED_NARROW);
 
-export const ALL_PRIVATE_NARROW: Narrow = specialNarrow('private');
+export const ALL_PRIVATE_NARROW: Narrow = specialNarrow('dm');
 
 export const ALL_PRIVATE_NARROW_STR: string = keyFromNarrow(ALL_PRIVATE_NARROW);
 
@@ -437,13 +437,16 @@ export const apiNarrowOfNarrow = (
     ],
     pm: ids => {
       const emails = ids.map(id => get('user', allUsersById, id).email);
+      // TODO(server-7.0): send `dm` rather than `pm-with`
       // TODO(server-2.1): just send IDs instead
       return [{ operator: 'pm-with', operand: emails.join(',') }];
     },
     search: query => [{ operator: 'search', operand: query }],
     home: () => [],
     starred: () => [{ operator: 'is', operand: 'starred' }],
     mentioned: () => [{ operator: 'is', operand: 'mentioned' }],
+
+    // TODO(server-7.0): send `is:dm` rather than `is:private`
     allPrivate: () => [{ operator: 'is', operand: 'private' }],
   });
 };