issue #3895 Show all fingerprints for recipient (#4003)

* issue 3895 Show all fingerprints for recipient

* move to flaky tests

* Fix filtering expired keys

* separate valid, revoked and expired in one pass

* Move common methods to the class ComposePageRecipe

Co-authored-by: Ivan Pizhenko <IvanPizhenko@users.noreply.github.com>
Co-authored-by: Roman Shevchenko <rrrooommmaaa@mail.ru>

Author: IvanPizhenko

.gitignore

@@ -18,3 +18,5 @@
 release/log.txt
 release/*
 npm-debug.log
+/rt.sh
+/grt.sh

extension/chrome/elements/compose-modules/compose-recipients-module.ts

@@ -3,7 +3,7 @@
 'use strict';
 
 import { ChunkedCb, EmailProviderContact, RecipientType } from '../../../js/common/api/shared/api.js';
-import { Contact } from '../../../js/common/core/crypto/key.js';
+import { Contact, KeyUtil } from '../../../js/common/core/crypto/key.js';
 import { PUBKEY_LOOKUP_RESULT_FAIL, PUBKEY_LOOKUP_RESULT_WRONG } from './compose-err-module.js';
 import { ProviderContactsQuery, Recipients } from '../../../js/common/api/email-provider/email-provider-api.js';
 import { RecipientElement, RecipientStatus } from './compose-types.js';
@@ -20,7 +20,7 @@ import { moveElementInArray } from '../../../js/common/platform/util.js';
 import { ViewModule } from '../../../js/common/view-module.js';
 import { ComposeView } from '../compose.js';
 import { AcctStore } from '../../../js/common/platform/store/acct-store.js';
-import { ContactPreview, ContactStore, ContactUpdate } from '../../../js/common/platform/store/contact-store.js';
+import { ContactPreview, ContactStore, ContactUpdate, PubkeyInfo } from '../../../js/common/platform/store/contact-store.js';
 
 /**
  * todo - this class is getting too big
@@ -84,7 +84,9 @@ export class ComposeRecipientsModule extends ViewModule<ComposeView> {
     this.view.S.cached('compose_table').click(this.view.setHandler(() => this.hideContacts(), this.view.errModule.handle(`hide contact box`)));
     this.view.S.cached('add_their_pubkey').click(this.view.setHandler(() => this.addTheirPubkeyClickHandler(), this.view.errModule.handle('add pubkey')));
     BrowserMsg.addListener('addToContacts', this.checkReciepientsKeys);
-    BrowserMsg.addListener('reRenderRecipient', async ({ contact }: Bm.ReRenderRecipient) => await this.reRenderRecipientFor(contact));
+    BrowserMsg.addListener('reRenderRecipient', async ({ contact }: Bm.ReRenderRecipient) => {
+      await this.reRenderRecipientFor(contact.email);
+    });
     BrowserMsg.listen(this.view.parentTabId);
   }
 
@@ -196,13 +198,18 @@ export class ComposeRecipientsModule extends ViewModule<ComposeView> {
       this.view.S.now('send_btn_text').text(this.BTN_LOADING);
       this.view.sizeModule.setInputTextHeightManuallyIfNeeded();
       recipient.evaluating = (async () => {
-        let pubkeyLookupRes: Contact | 'fail' | 'wrong';
+        let pubkeyLookupRes: PubkeyInfo[] | 'fail' | 'wrong' = 'wrong';
+        // console.log(`>>>> evaluateRecipients: ${JSON.stringify(recipient)}`);
         if (recipient.status !== RecipientStatus.WRONG) {
-          pubkeyLookupRes = await this.view.storageModule.lookupPubkeyFromKeyserversThenOptionallyFetchExpiredByFingerprintAndUpsertDb(recipient.email, undefined);
+          pubkeyLookupRes = await this.view.storageModule.
+            lookupPubkeyFromKeyserversThenOptionallyFetchExpiredByFingerprintAndUpsertDb(
+              recipient.email, undefined);
+        }
+        if (pubkeyLookupRes === 'fail' || pubkeyLookupRes === 'wrong') {
+          await this.renderPubkeyResult(recipient, pubkeyLookupRes);
         } else {
-          pubkeyLookupRes = 'wrong';
+          await this.renderPubkeyResult(recipient, pubkeyLookupRes);
         }
-        await this.renderPubkeyResult(recipient, pubkeyLookupRes);
         recipient.evaluating = undefined; // Clear promise when it finished
       })();
     }
@@ -336,10 +343,14 @@ export class ComposeRecipientsModule extends ViewModule<ComposeView> {
     }
   }
 
-  public reRenderRecipientFor = async (contact: Contact): Promise<void> => {
-    for (const recipient of this.addedRecipients.filter(r => r.email === contact.email)) {
-      this.view.errModule.debug(`re-rendering recipient: ${contact.email}`);
-      await this.renderPubkeyResult(recipient, contact);
+  public reRenderRecipientFor = async (email: string): Promise<void> => {
+    if (this.addedRecipients.every(r => r.email !== email)) {
+      return;
+    }
+    const emailAndPubkeys = await ContactStore.getOneWithAllPubkeys(undefined, email);
+    for (const recipient of this.addedRecipients.filter(r => r.email === email)) {
+      this.view.errModule.debug(`re-rendering recipient: ${email}`);
+      await this.renderPubkeyResult(recipient, emailAndPubkeys ? emailAndPubkeys.sortedPubkeys : []);
       this.view.recipientsModule.showHideCcAndBccInputsIfNeeded();
       await this.view.recipientsModule.setEmailsPreview(this.getRecipients());
     }
@@ -753,11 +764,8 @@ export class ComposeRecipientsModule extends ViewModule<ComposeView> {
         toLookup.push(contact);
       }
     }
-    await Promise.all(toLookup.map(c => this.view.storageModule.lookupPubkeyFromKeyserversAndUpsertDb(c.email, c.name || undefined, undefined).then(lookupRes => {
-      if (lookupRes === 'fail') {
-        this.failedLookupEmails.push(c.email);
-      }
-    })));
+    await Promise.all(toLookup.map(c => this.view.storageModule.lookupPubkeyFromKeyserversAndUpsertDb(
+      c.email, c.name || undefined).catch(() => this.failedLookupEmails.push(c.email))));
   }
 
   private renderSearchResultsLoadingDone = () => {
@@ -798,58 +806,74 @@ export class ComposeRecipientsModule extends ViewModule<ComposeView> {
   }
 
   private checkReciepientsKeys = async () => {
-    for (const recipientEl of this.addedRecipients.filter(r => r.element.className.includes('no_pgp'))) {
+    for (const recipientEl of this.addedRecipients.filter(
+      r => r.element.className.includes('no_pgp'))) {
       const email = $(recipientEl).text().trim();
-      const [dbContact] = await ContactStore.get(undefined, [email]);
-      if (dbContact) {
+      const dbContacts = await ContactStore.getOneWithAllPubkeys(undefined, email);
+      if (dbContacts && dbContacts.sortedPubkeys && dbContacts.sortedPubkeys.length) {
         recipientEl.element.classList.remove('no_pgp');
-        await this.renderPubkeyResult(recipientEl, dbContact);
+        await this.renderPubkeyResult(recipientEl, dbContacts.sortedPubkeys);
       }
     }
   }
 
-  private renderPubkeyResult = async (recipient: RecipientElement, contact: Contact | 'fail' | 'wrong') => {
+  private renderPubkeyResult = async (
+    recipient: RecipientElement, sortedPubkeyInfos: PubkeyInfo[] | 'fail' | 'wrong'
+  ) => {
+    // console.log(`>>>> renderPubkeyResult: ${JSON.stringify(sortedPubkeyInfos)}`);
     const el = recipient.element;
     this.view.errModule.debug(`renderPubkeyResult.emailEl(${String(recipient.email)})`);
     this.view.errModule.debug(`renderPubkeyResult.email(${recipient.email})`);
-    this.view.errModule.debug(`renderPubkeyResult.contact(${JSON.stringify(contact)})`);
+    this.view.errModule.debug(`renderPubkeyResult.contact(${JSON.stringify(sortedPubkeyInfos)})`);
     $(el).children('img, i').remove();
     const contentHtml = '<img src="/img/svgs/close-icon.svg" alt="close" class="close-icon svg" />' +
       '<img src="/img/svgs/close-icon-black.svg" alt="close" class="close-icon svg display_when_sign" />';
     Xss.sanitizeAppend(el, contentHtml)
       .find('img.close-icon')
       .click(this.view.setHandler(target => this.removeRecipient(target.parentElement!), this.view.errModule.handle('remove recipient')));
     $(el).removeClass(['failed', 'wrong', 'has_pgp', 'no_pgp', 'expired']);
-    if (contact === PUBKEY_LOOKUP_RESULT_FAIL) {
+    if (sortedPubkeyInfos === PUBKEY_LOOKUP_RESULT_FAIL) {
       recipient.status = RecipientStatus.FAILED;
       $(el).attr('title', 'Failed to load, click to retry');
       $(el).addClass("failed");
       Xss.sanitizeReplace($(el).children('img:visible'), '<img src="/img/svgs/repeat-icon.svg" class="repeat-icon action_retry_pubkey_fetch">' +
         '<img src="/img/svgs/close-icon-black.svg" class="close-icon-black svg remove-reciepient">');
       $(el).find('.action_retry_pubkey_fetch').click(this.view.setHandler(async () => await this.refreshRecipients(), this.view.errModule.handle('refresh recipient')));
       $(el).find('.remove-reciepient').click(this.view.setHandler(element => this.removeRecipient(element.parentElement!), this.view.errModule.handle('remove recipient')));
-    } else if (contact === PUBKEY_LOOKUP_RESULT_WRONG) {
+    } else if (sortedPubkeyInfos === PUBKEY_LOOKUP_RESULT_WRONG) {
       recipient.status = RecipientStatus.WRONG;
       this.view.errModule.debug(`renderPubkeyResult: Setting email to wrong / misspelled in harsh mode: ${recipient.email}`);
       $(el).attr('title', 'This email address looks misspelled. Please try again.');
       $(el).addClass("wrong");
-    } else if (contact.pubkey && ((contact.expiresOn || Infinity) <= Date.now() || contact.pubkey.usableForEncryptionButExpired)) {
-      recipient.status = RecipientStatus.EXPIRED;
-      $(el).addClass("expired");
-      Xss.sanitizePrepend(el, '<img src="/img/svgs/expired-timer.svg" class="revoked-or-expired">');
-      $(el).attr('title', 'Does use encryption but their public key is expired. You should ask them to send ' +
-        'you an updated public key.' + this.recipientKeyIdText(contact));
-    } else if (contact.revoked) {
-      recipient.status = RecipientStatus.REVOKED;
-      $(el).addClass("revoked");
-      Xss.sanitizePrepend(el, '<img src="/img/svgs/revoked.svg" class="revoked-or-expired">');
-      $(el).attr('title', 'Does use encryption but their public key is revoked. You should ask them to send ' +
-        'you an updated public key.' + this.recipientKeyIdText(contact));
-    } else if (contact.pubkey) {
-      recipient.status = RecipientStatus.HAS_PGP;
-      $(el).addClass('has_pgp');
-      Xss.sanitizePrepend(el, '<img class="lock-icon" src="/img/svgs/locked-icon.svg" />');
-      $(el).attr('title', 'Does use encryption' + this.recipientKeyIdText(contact));
+    } else if (sortedPubkeyInfos.length) {
+      // New logic:
+      // 1. Keys are sorted in a special way.
+      // 2. If there is at least one key:
+      //    - if first key is valid (non-expired, non-revoked) public key, then it's HAS_PGP.
+      //    - else if first key is revoked, then REVOKED.
+      //    - else EXPIRED.
+      // 3. Otherwise NO_PGP.
+      const firstKeyInfo = sortedPubkeyInfos[0];
+      if (!firstKeyInfo.revoked && !KeyUtil.expired(firstKeyInfo.pubkey)) {
+        recipient.status = RecipientStatus.HAS_PGP;
+        $(el).addClass('has_pgp');
+        Xss.sanitizePrepend(el, '<img class="lock-icon" src="/img/svgs/locked-icon.svg" />');
+        $(el).attr('title', 'Does use encryption\n\n' + this.formatPubkeysHintText(sortedPubkeyInfos));
+      } else if (firstKeyInfo.revoked) {
+        recipient.status = RecipientStatus.REVOKED;
+        $(el).addClass("revoked");
+        Xss.sanitizePrepend(el, '<img src="/img/svgs/revoked.svg" class="revoked-or-expired">');
+        $(el).attr('title', 'Does use encryption but their public key is revoked. ' +
+          'You should ask them to send you an updated public key.\n\n' +
+          this.formatPubkeysHintText(sortedPubkeyInfos));
+      } else {
+        recipient.status = RecipientStatus.EXPIRED;
+        $(el).addClass("expired");
+        Xss.sanitizePrepend(el, '<img src="/img/svgs/expired-timer.svg" class="revoked-or-expired">');
+        $(el).attr('title', 'Does use encryption but their public key is expired. ' +
+          'You should ask them to send you an updated public key.\n\n' +
+          this.formatPubkeysHintText(sortedPubkeyInfos));
+      }
     } else {
       recipient.status = RecipientStatus.NO_PGP;
       $(el).addClass("no_pgp");
@@ -860,6 +884,30 @@ export class ComposeRecipientsModule extends ViewModule<ComposeView> {
     this.view.myPubkeyModule.reevaluateShouldAttachOrNot();
   }
 
+  private formatPubkeysHintText = (pubkeyInfos: PubkeyInfo[]): string => {
+    const valid: PubkeyInfo[] = [];
+    const expired: PubkeyInfo[] = [];
+    const revoked: PubkeyInfo[] = [];
+    for (const pubkeyInfo of pubkeyInfos) {
+      if (pubkeyInfo.revoked) {
+        revoked.push(pubkeyInfo);
+      } else if (KeyUtil.expired(pubkeyInfo.pubkey)) {
+        expired.push(pubkeyInfo);
+      } else {
+        valid.push(pubkeyInfo);
+      }
+    }
+    return [
+      { groupName: 'Valid public key fingerprints:', pubkeyInfos: valid },
+      { groupName: 'Expired public key fingerprints:', pubkeyInfos: expired },
+      { groupName: 'Revoked public key fingerprints:', pubkeyInfos: revoked }
+    ].filter(g => g.pubkeyInfos.length).map(g => this.formatKeyGroup(g.groupName, g.pubkeyInfos)).join('\n\n');
+  }
+
+  private formatKeyGroup = (groupName: string, pubkeyInfos: PubkeyInfo[]): string => {
+    return [groupName, ...pubkeyInfos.map(info => this.formatPubkeyId(info))].join('\n');
+  }
+
   private removeRecipient = (element: HTMLElement) => {
     const index = this.addedRecipients.findIndex(r => r.element.isEqualNode(element));
     this.addedRecipients[index].element.remove();
@@ -878,12 +926,8 @@ export class ComposeRecipientsModule extends ViewModule<ComposeView> {
     await this.reEvaluateRecipients(failedRecipients);
   }
 
-  private recipientKeyIdText = (contact: Contact) => {
-    if (contact.fingerprint) {
-      return `\n\nRecipient public key fingerprint:\n${Str.spaced(contact.fingerprint)}`;
-    } else {
-      return '';
-    }
+  private formatPubkeyId = (pubkeyInfo: PubkeyInfo): string => {
+    return `${Str.spaced(pubkeyInfo.pubkey.id)} (${pubkeyInfo.pubkey.type})`;
   }
 
   private generateRecipientId = (): string => {