GmailElementReplacer refactoring

.semaphore/semaphore.yml

@@ -12,7 +12,7 @@ blocks:
   - name: Mock UI Tests
     dependencies: []
     execution_time_limit:
-      minutes: 30
+      minutes: 45
     task:
       secrets:
         - name: flowcrypt-browser-ci-secrets

extension/chrome/dev/export.ts

@@ -87,7 +87,7 @@ Catch.try(async () => {
     const fetchableAttachments: Attachment[] = [];
     const skippedAttachments: Attachment[] = [];
     for (const msg of messages) {
-      for (const attachment of GmailParser.findAttachments(msg)) {
+      for (const attachment of GmailParser.findAttachments(msg, msg.id)) {
         if (attachment.length > 1024 * 1024 * 7) {
           // over 7 mb - attachment too big
           skippedAttachments.push(
@@ -102,7 +102,7 @@ Catch.try(async () => {
         }
       }
     }
-    await gmail.fetchAttachments(fetchableAttachments, percent => print(`Percent attachments done: ${percent}`));
+    await gmail.fetchAttachmentsMissingData(fetchableAttachments, percent => print(`Percent attachments done: ${percent}`));
     const attachments: { [id: string]: { data: string; size: number } } = {};
     for (const attachment of fetchableAttachments.concat(skippedAttachments)) {
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion

extension/chrome/elements/attachment.ts

@@ -8,7 +8,7 @@ import { PromiseCancellation, Str, Url } from '../../js/common/core/common.js';
 import { Api } from '../../js/common/api/shared/api.js';
 import { ApiErr } from '../../js/common/api/shared/api-error.js';
 import { Assert } from '../../js/common/assert.js';
-import { Attachment } from '../../js/common/core/attachment.js';
+import { Attachment, AttachmentId } from '../../js/common/core/attachment.js';
 import { Browser } from '../../js/common/browser/browser.js';
 import { Catch } from '../../js/common/platform/catch.js';
 import { Gmail } from '../../js/common/api/email-provider/gmail/gmail.js';
@@ -32,10 +32,8 @@ export class AttachmentDownloadView extends View {
   protected readonly isEncrypted: boolean;
   protected readonly errorDetailsOpened: boolean;
   protected readonly type: string | undefined;
-  protected readonly msgId: string | undefined;
-  protected readonly id: string | undefined;
   protected readonly name: string | undefined;
-  protected readonly url: string | undefined;
+  protected readonly attachmentId: AttachmentId;
   protected readonly gmail: Gmail;
   protected attachment!: Attachment;
   protected ppChangedPromiseCancellation: PromiseCancellation = { cancel: false };
@@ -73,11 +71,17 @@ export class AttachmentDownloadView extends View {
     this.errorDetailsOpened = uncheckedUrlParams.errorDetailsOpened === true;
     this.size = uncheckedUrlParams.size ? parseInt(String(uncheckedUrlParams.size)) : undefined;
     this.type = Assert.urlParamRequire.optionalString(uncheckedUrlParams, 'type');
-    this.msgId = Assert.urlParamRequire.optionalString(uncheckedUrlParams, 'msgId');
-    this.id = Assert.urlParamRequire.optionalString(uncheckedUrlParams, 'attachmentId');
     this.name = Assert.urlParamRequire.optionalString(uncheckedUrlParams, 'name');
     // url contains either actual url of remote content or objectUrl for direct content, either way needs to be downloaded
-    this.url = Assert.urlParamRequire.optionalString(uncheckedUrlParams, 'url');
+    const url = Assert.urlParamRequire.optionalString(uncheckedUrlParams, 'url');
+    if (url) {
+      this.attachmentId = { url };
+    } else {
+      this.attachmentId = {
+        msgId: Assert.urlParamRequire.string(uncheckedUrlParams, 'msgId'),
+        id: Assert.urlParamRequire.string(uncheckedUrlParams, 'attachmentId'),
+      };
+    }
     this.gmail = new Gmail(this.acctEmail);
   }
 
@@ -91,11 +95,9 @@ export class AttachmentDownloadView extends View {
     this.fesUrl = storage.fesUrl;
     try {
       this.attachment = new Attachment({
+        ...this.attachmentId,
         name: this.origNameBasedOnFilename,
         type: this.type,
-        msgId: this.msgId,
-        id: this.id,
-        url: this.url,
       });
     } catch (e) {
       Catch.reportErr(e);
@@ -107,9 +109,9 @@ export class AttachmentDownloadView extends View {
     this.renderHeader();
     $('#name').attr('title', this.name || '');
     $('img#file-format').attr('src', this.getFileIconSrc());
-    if (!this.size && this.url) {
+    if (!this.size && 'url' in this.attachmentId) {
       // download url of a file that has an unknown size
-      this.getUrlFileSize(this.url)
+      this.getUrlFileSize(this.attachmentId.url)
         .then(fileSize => {
           if (typeof fileSize !== 'undefined') {
             this.size = fileSize;
@@ -162,7 +164,7 @@ export class AttachmentDownloadView extends View {
       this.attachment.setData(await Api.download(this.attachment.url, this.renderProgress));
     } else if (this.attachment.id && this.attachment.msgId) {
       // gmail attId
-      const { data } = await this.gmail.attachmentGet(this.attachment.msgId, this.attachment.id, this.renderProgress);
+      const { data } = await this.gmail.attachmentGet(this.attachment.msgId, this.attachment.id, { download: this.renderProgress });
       this.attachment.setData(data);
     } else {
       throw new Error('File is missing both id and url - this should be fixed');
@@ -246,6 +248,7 @@ export class AttachmentDownloadView extends View {
 
   private processAsPublicKeyAndHideAttachmentIfAppropriate = async () => {
     // todo: we should call this detection in the main `core/Attachment.treatAs` (e.g. in the context of GmailElementReplacer and InboxActiveThreadModule)
+    // and we'll also be able to minimize the pgp_pubkey block if isOutgoing
     // should be possible after #4906 is done
     if (((this.attachment.msgId && this.attachment.id) || this.attachment.url) && this.attachment.isPublicKey()) {
       // this is encrypted public key - download && decrypt & parse & render

extension/chrome/elements/attachment_preview.ts

@@ -36,11 +36,9 @@ View.run(
       try {
         Xss.sanitizeRender(this.attachmentPreviewContainer, `${Ui.spinner('green', 'large_spinner')}<span class="download_progress"></span>`);
         this.attachment = new Attachment({
+          ...this.attachmentId,
           name: this.origNameBasedOnFilename,
           type: this.type,
-          msgId: this.msgId,
-          id: this.id,
-          url: this.url,
         });
         await this.downloadDataIfNeeded();
         const result = this.isEncrypted ? await this.decrypt() : this.attachment.getData();

extension/chrome/elements/backup.htm

@@ -21,7 +21,7 @@
       </div>
       <div class="line fingerprints hide_if_compact">Key Fingerprint: <span class="fingerprint good"></span></div>
       <div class="line">
-        <span class="private_key_status"></span>
+        <span class="private_key_status" data-test="private-key-status"></span>
       </div>
     </div>
 

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

@@ -12,7 +12,7 @@ import { Ui } from '../../../js/common/browser/ui.js';
 import { Buf } from '../../../js/common/core/buf.js';
 import { Str, Url } from '../../../js/common/core/common.js';
 import { DecryptErrTypes, MsgUtil } from '../../../js/common/core/crypto/pgp/msg-util.js';
-import { Mime, MimeContent, MimeProccesedMsg } from '../../../js/common/core/mime.js';
+import { Mime, MimeContentWithHeaders, MimeProccesedMsg } from '../../../js/common/core/mime.js';
 import { MsgBlockParser } from '../../../js/common/core/msg-block-parser.js';
 import { Catch } from '../../../js/common/platform/catch.js';
 import { GlobalStore } from '../../../js/common/platform/store/global-store.js';
@@ -298,7 +298,7 @@ export class ComposeDraftModule extends ViewModule<ComposeView> {
     }
   };
 
-  private fillAndRenderDraftHeaders = async (decoded: MimeContent) => {
+  private fillAndRenderDraftHeaders = async (decoded: MimeContentWithHeaders) => {
     this.view.recipientsModule.addRecipientsAndShowPreview({ to: decoded.to, cc: decoded.cc, bcc: decoded.bcc });
     if (decoded.from) {
       this.view.S.now('input_from').val(decoded.from);

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

@@ -3,7 +3,7 @@
 'use strict';
 
 import { Bm, BrowserMsg } from '../../../js/common/browser/browser-msg.js';
-import { FormatError, MsgUtil, DecryptErrTypes } from '../../../js/common/core/crypto/pgp/msg-util.js';
+import { MsgUtil, DecryptErrTypes } from '../../../js/common/core/crypto/pgp/msg-util.js';
 import { ApiErr } from '../../../js/common/api/shared/api-error.js';
 import { Buf } from '../../../js/common/core/buf.js';
 import { Catch } from '../../../js/common/platform/catch.js';
@@ -123,29 +123,31 @@ export class ComposeQuoteModule extends ViewModule<ComposeView> {
           decryptedAndFormatedContent.push(Xss.htmlUnescape(htmlParsed));
         } else if (block.type === 'plainHtml') {
           decryptedAndFormatedContent.push(Xss.htmlUnescape(Xss.htmlSanitizeAndStripAllTags(stringContent, '\n', false)));
-        } else if (['encryptedAttachment', 'decryptedAttachment', 'plainAttachment'].includes(block.type)) {
-          if (block.attachmentMeta?.data) {
-            let attachmentMeta: { content: Buf; filename?: string } | undefined;
-            if (block.type === 'encryptedAttachment') {
-              this.setQuoteLoaderProgress('decrypting...');
-              const result = await MsgUtil.decryptMessage({
-                kisWithPp: await KeyStore.getAllWithOptionalPassPhrase(this.view.acctEmail),
-                encryptedData: block.attachmentMeta.data,
-                verificationPubs: [], // todo: #4158 signature verification of attachments
-              });
-              if (result.success) {
-                attachmentMeta = { content: result.content, filename: result.filename };
-              }
-            } else {
-              attachmentMeta = {
-                content: Buf.fromUint8(block.attachmentMeta.data),
-                filename: block.attachmentMeta.name,
-              };
-            }
-            if (attachmentMeta) {
-              const file = new File([attachmentMeta.content], attachmentMeta.filename || '');
-              decryptedFiles.push(file);
+        } else if (
+          block.attachmentMeta &&
+          'data' in block.attachmentMeta &&
+          ['encryptedAttachment', 'decryptedAttachment', 'plainAttachment'].includes(block.type)
+        ) {
+          let attachmentMeta: { content: Buf; filename?: string } | undefined;
+          if (block.type === 'encryptedAttachment') {
+            this.setQuoteLoaderProgress('decrypting...');
+            const result = await MsgUtil.decryptMessage({
+              kisWithPp: await KeyStore.getAllWithOptionalPassPhrase(this.view.acctEmail),
+              encryptedData: block.attachmentMeta.data,
+              verificationPubs: [], // todo: #4158 signature verification of attachments
+            });
+            if (result.success) {
+              attachmentMeta = { content: result.content, filename: result.filename };
             }
+          } else {
+            attachmentMeta = {
+              content: Buf.fromUint8(block.attachmentMeta.data),
+              filename: block.attachmentMeta.name,
+            };
+          }
+          if (attachmentMeta) {
+            const file = new File([attachmentMeta.content], attachmentMeta.filename || '');
+            decryptedFiles.push(file);
           }
         } else {
           decryptedAndFormatedContent.push(stringContent);
@@ -158,9 +160,7 @@ export class ComposeQuoteModule extends ViewModule<ComposeView> {
         decryptedFiles,
       };
     } catch (e) {
-      if (e instanceof FormatError) {
-        Xss.sanitizeAppend(this.view.S.cached('input_text'), `<br/>\n<br/>\n<br/>\n${Xss.escape(e.data)}`);
-      } else if (ApiErr.isNetErr(e)) {
+      if (ApiErr.isNetErr(e)) {
         // todo: retry
       } else if (ApiErr.isAuthErr(e)) {
         BrowserMsg.send.notificationShowAuthPopupNeeded(this.view.parentTabId, { acctEmail: this.view.acctEmail });

extension/chrome/elements/pgp_block.htm

@@ -40,14 +40,6 @@
     <script src="/lib/linkify.min.js"></script>
     <script src="/lib/linkify-html.min.js"></script>
     <script src="/lib/filesize.js"></script>
-    <script src="/lib/iso-8859-2.js"></script>
-    <script src="/lib/emailjs/punycode.js"></script>
-    <script src="/lib/emailjs/emailjs-stringencoding.js"></script>
-    <script src="/lib/emailjs/emailjs-mime-codec.js"></script>
-    <script src="/lib/emailjs/emailjs-mime-types.js"></script>
-    <script src="/lib/emailjs/emailjs-addressparser.js"></script>
-    <script src="/lib/emailjs/emailjs-mime-builder.js"></script>
-    <script src="/lib/emailjs/emailjs-mime-parser.js"></script>
     <script src="pgp_block.js" type="module"></script>
   </body>
 </html>