fix: add dealId in sendEmail response

Author: PierreJeanjacquot

src/web3mail/sendEmail.ts

@@ -316,7 +316,7 @@ export const sendEmail = async ({
     const requestorder = await iexec.order.signRequestorder(requestorderToSign);
 
     // Match orders and compute task ID
-    const { dealid } = await iexec.order.matchOrders(
+    const { dealid: dealId } = await iexec.order.matchOrders(
       {
         apporder: apporder,
         datasetorder: datasetorder,
@@ -326,10 +326,11 @@ export const sendEmail = async ({
       { useVoucher: vUseVoucher }
     );
 
-    const taskId = await iexec.deal.computeTaskId(dealid, 0);
+    const taskId = await iexec.deal.computeTaskId(dealId, 0);
 
     return {
       taskId,
+      dealId,
     };
   } catch (error) {
     handleIfProtocolError(error);

src/web3mail/types.ts

@@ -85,7 +85,14 @@ export type FetchUserContactsParams = {
 } & FetchMyContactsParams;
 
 export type SendEmailResponse = {
+  /**
+   * ID of the task
+   */
   taskId: string;
+  /**
+   * ID of the deal containing the task
+   */
+  dealId: string;
 };
 
 /**

tests/e2e/sendEmail.test.ts

@@ -171,7 +171,10 @@ describe('web3mail.sendEmail()', () => {
             protectedData: validProtectedData.address,
             workerpoolMaxPrice: prodWorkerpoolPublicPrice,
           });
-          expect(sendEmailResponse.taskId).toBeDefined();
+          expect(sendEmailResponse).toStrictEqual({
+            taskId: expect.any(String),
+            dealId: expect.any(String),
+          });
         },
         2 * MAX_EXPECTED_BLOCKTIME + MAX_EXPECTED_WEB2_SERVICES_TIME
       );
@@ -273,7 +276,10 @@ describe('web3mail.sendEmail()', () => {
         protectedData: validProtectedData.address,
         workerpoolAddressOrEns: learnProdWorkerpoolAddress,
       });
-      expect(sendEmailResponse.taskId).toBeDefined();
+      expect(sendEmailResponse).toStrictEqual({
+        taskId: expect.any(String),
+        dealId: expect.any(String),
+      });
     },
     2 * MAX_EXPECTED_BLOCKTIME + MAX_EXPECTED_WEB2_SERVICES_TIME
   );
@@ -303,7 +309,10 @@ describe('web3mail.sendEmail()', () => {
         protectedData: protectedDataForWhitelist.address,
         workerpoolAddressOrEns: learnProdWorkerpoolAddress,
       });
-      expect(sendEmailResponse.taskId).toBeDefined();
+      expect(sendEmailResponse).toStrictEqual({
+        taskId: expect.any(String),
+        dealId: expect.any(String),
+      });
     },
     2 * MAX_EXPECTED_BLOCKTIME + MAX_EXPECTED_WEB2_SERVICES_TIME
   );
@@ -319,7 +328,10 @@ describe('web3mail.sendEmail()', () => {
         contentType: 'text/html',
         workerpoolAddressOrEns: learnProdWorkerpoolAddress,
       });
-      expect(sendEmailResponse.taskId).toBeDefined();
+      expect(sendEmailResponse).toStrictEqual({
+        taskId: expect.any(String),
+        dealId: expect.any(String),
+      });
     },
     2 * MAX_EXPECTED_BLOCKTIME + MAX_EXPECTED_WEB2_SERVICES_TIME
   );
@@ -334,7 +346,10 @@ describe('web3mail.sendEmail()', () => {
         senderName: 'Product Team',
         workerpoolAddressOrEns: learnProdWorkerpoolAddress,
       });
-      expect(sendEmailResponse.taskId).toBeDefined();
+      expect(sendEmailResponse).toStrictEqual({
+        taskId: expect.any(String),
+        dealId: expect.any(String),
+      });
     },
     2 * MAX_EXPECTED_BLOCKTIME + MAX_EXPECTED_WEB2_SERVICES_TIME
   );
@@ -353,7 +368,10 @@ describe('web3mail.sendEmail()', () => {
         senderName: 'Product Team',
         workerpoolAddressOrEns: learnProdWorkerpoolAddress,
       });
-      expect(sendEmailResponse.taskId).toBeDefined();
+      expect(sendEmailResponse).toStrictEqual({
+        taskId: expect.any(String),
+        dealId: expect.any(String),
+      });
     },
     2 * MAX_EXPECTED_BLOCKTIME + MAX_EXPECTED_WEB2_SERVICES_TIME
   );
@@ -368,7 +386,10 @@ describe('web3mail.sendEmail()', () => {
         workerpoolAddressOrEns: learnProdWorkerpoolAddress,
         label: 'ID1234678',
       });
-      expect(sendEmailResponse.taskId).toBeDefined();
+      expect(sendEmailResponse).toStrictEqual({
+        taskId: expect.any(String),
+        dealId: expect.any(String),
+      });
       // TODO check label in created deal
     },
     2 * MAX_EXPECTED_BLOCKTIME + MAX_EXPECTED_WEB2_SERVICES_TIME
@@ -457,7 +478,10 @@ describe('web3mail.sendEmail()', () => {
             // workerpoolAddressOrEns: prodWorkerpoolAddress, // default
             useVoucher: true,
           });
-          expect(sendEmailResponse.taskId).toBeDefined();
+          expect(sendEmailResponse).toStrictEqual({
+            taskId: expect.any(String),
+            dealId: expect.any(String),
+          });
         },
         2 * MAX_EXPECTED_BLOCKTIME +
           MAX_EXPECTED_WEB2_SERVICES_TIME +
@@ -567,7 +591,10 @@ describe('web3mail.sendEmail()', () => {
               workerpoolMaxPrice: nonSponsoredAmount,
               useVoucher: true,
             });
-            expect(sendEmailResponse.taskId).toBeDefined();
+            expect(sendEmailResponse).toStrictEqual({
+              taskId: expect.any(String),
+              dealId: expect.any(String),
+            });
           },
           2 * MAX_EXPECTED_BLOCKTIME +
             MAX_EXPECTED_WEB2_SERVICES_TIME +