feat: add name, accessPrice, remainingAccess and isUserStrict properties to Contact (#221)

* feat: add name, accessPrice, remainingAccess and isUserStrict properties to Contact

fix: stop exporting internal types

Author: PierreJeanjacquot

src/utils/subgraphQuery.ts

@@ -1,6 +1,10 @@
 import { GraphQLClient, gql } from 'graphql-request';
-import { Contact, GraphQLResponse, ProtectedDataQuery } from '../index.js';
+import { Contact } from '../index.js';
 import { WorkflowError } from './errors.js';
+import {
+  GraphQLResponse,
+  ProtectedDataQuery,
+} from '../web3mail/internalTypes.js';
 
 const checkProtectedDataQuery = gql`
   query GetValidContacts(
@@ -21,13 +25,14 @@ const checkProtectedDataQuery = gql`
       orderDirection: desc
     ) {
       id
+      name
     }
   }
 `;
 
 export const getValidContact = async (
   graphQLClient: GraphQLClient,
-  contacts: Contact[]
+  contacts: Omit<Contact, 'name'>[]
 ): Promise<Contact[]> => {
   if (contacts.length === 0) {
     return [];
@@ -66,13 +71,17 @@ export const getValidContact = async (
     );
 
     // Convert protectedData[] into Contact[] using the map for constant time lookups
-    return protectedDataList.map(({ id }) => {
+    return protectedDataList.map(({ id, name }) => {
       const contact = contactsMap.get(id);
       if (contact) {
         return {
           address: id,
+          name: name,
+          remainingAccess: contact.remainingAccess,
+          accessPrice: contact.accessPrice,
           owner: contact.owner,
           accessGrantTimestamp: contact.accessGrantTimestamp,
+          isUserStrict: contact.isUserStrict,
         };
       }
     });

src/web3mail/fetchMyContacts.ts

@@ -1,13 +1,12 @@
 import { booleanSchema, throwIfMissing } from '../utils/validators.js';
 import { fetchUserContacts } from './fetchUserContacts.js';
 import {
-  Contact,
   DappAddressConsumer,
   DappWhitelistAddressConsumer,
-  FetchMyContactsParams,
   IExecConsumer,
   SubgraphConsumer,
-} from './types.js';
+} from './internalTypes.js';
+import { Contact, FetchMyContactsParams } from './types.js';
 
 export type FetchMyContacts = typeof fetchMyContacts;
 

src/web3mail/fetchUserContacts.ts

@@ -1,3 +1,6 @@
+import { PublishedDatasetorder } from 'iexec/IExecOrderbookModule';
+import { ZeroAddress } from 'ethers';
+import { IExec } from 'iexec';
 import { ANY_DATASET_ADDRESS } from '../config/config.js';
 import { handleIfProtocolError, WorkflowError } from '../utils/errors.js';
 import { autoPaginateRequest } from '../utils/paginate.js';
@@ -9,14 +12,13 @@ import {
   isEnsTest,
   throwIfMissing,
 } from '../utils/validators.js';
+import { Contact, FetchUserContactsParams } from './types.js';
 import {
-  Contact,
   DappAddressConsumer,
   DappWhitelistAddressConsumer,
-  FetchUserContactsParams,
   IExecConsumer,
   SubgraphConsumer,
-} from './types.js';
+} from './internalTypes.js';
 
 export const fetchUserContacts = async ({
   graphQLClient = throwIfMissing(),
@@ -63,7 +65,7 @@ export const fetchUserContacts = async ({
     ]);
 
     const orders = dappOrders.concat(whitelistOrders);
-    const myContacts: Contact[] = [];
+    const myContacts: Omit<Contact, 'name'>[] = [];
     let web3DappResolvedAddress = vDappAddressOrENS;
     if (isEnsTest(vDappAddressOrENS)) {
       web3DappResolvedAddress = await iexec.ens.resolveName(vDappAddressOrENS);
@@ -78,7 +80,10 @@ export const fetchUserContacts = async ({
         const contact = {
           address: order.order.dataset.toLowerCase(),
           owner: order.signer.toLowerCase(),
+          remainingAccess: order.remaining,
+          accessPrice: order.order.datasetprice,
           accessGrantTimestamp: order.publicationTimestamp,
+          isUserStrict: order.order.requesterrestrict !== ZeroAddress,
         };
         myContacts.push(contact);
       }
@@ -102,7 +107,12 @@ async function fetchAllOrdersByApp({
   userAddress,
   appAddress,
   isUserStrict,
-}) {
+}: {
+  iexec: IExec;
+  userAddress: string;
+  appAddress: string;
+  isUserStrict: boolean;
+}): Promise<PublishedDatasetorder[]> {
   const ordersFirstPage = iexec.orderbook.fetchDatasetOrderbook(
     ANY_DATASET_ADDRESS,
     {

src/web3mail/internalTypes.ts

@@ -0,0 +1,36 @@
+import { IExec } from 'iexec';
+import { AddressOrENS } from './types.js';
+import { GraphQLClient } from 'graphql-request';
+
+export type ProtectedDataQuery = {
+  id: string;
+  name: string;
+};
+
+export type GraphQLResponse = {
+  protectedDatas: ProtectedDataQuery[];
+};
+
+export type DappAddressConsumer = {
+  dappAddressOrENS: AddressOrENS;
+};
+
+export type IpfsNodeConfigConsumer = {
+  ipfsNode: string;
+};
+
+export type IpfsGatewayConfigConsumer = {
+  ipfsGateway: string;
+};
+
+export type DappWhitelistAddressConsumer = {
+  dappWhitelistAddress: string;
+};
+
+export type IExecConsumer = {
+  iexec: IExec;
+};
+
+export type SubgraphConsumer = {
+  graphQLClient: GraphQLClient;
+};

src/web3mail/sendEmail.ts

@@ -26,16 +26,15 @@ import {
   checkUserVoucher,
   filterWorkerpoolOrders,
 } from './sendEmail.models.js';
+import { SendEmailParams, SendEmailResponse } from './types.js';
 import {
   DappAddressConsumer,
   DappWhitelistAddressConsumer,
   IExecConsumer,
   IpfsGatewayConfigConsumer,
   IpfsNodeConfigConsumer,
-  SendEmailParams,
-  SendEmailResponse,
   SubgraphConsumer,
-} from './types.js';
+} from './internalTypes.js';
 
 export type SendEmail = typeof sendEmail;
 

src/web3mail/types.ts

@@ -1,13 +1,8 @@
-import { GraphQLClient } from 'graphql-request';
-import { EnhancedWallet, IExec } from 'iexec';
+import { EnhancedWallet } from 'iexec';
 import { IExecConfigOptions } from 'iexec/IExecConfig';
 
 export type Web3SignerProvider = EnhancedWallet;
 
-export type IExecConsumer = {
-  iexec: IExec;
-};
-
 export type ENS = string;
 
 export type AddressOrENS = Address | ENS;
@@ -20,6 +15,10 @@ export type Contact = {
   address: Address;
   owner: Address;
   accessGrantTimestamp: TimeStamp;
+  isUserStrict: boolean;
+  name: string;
+  remainingAccess: number;
+  accessPrice: number;
 };
 
 export type SendEmailParams = {
@@ -54,21 +53,6 @@ export type SendEmailResponse = {
   taskId: string;
 };
 
-/**
- * Internal props for querying the subgraph
- */
-export type ProtectedDataQuery = {
-  id: string;
-};
-
-export type GraphQLResponse = {
-  protectedDatas: ProtectedDataQuery[];
-};
-
-export type SubgraphConsumer = {
-  graphQLClient: GraphQLClient;
-};
-
 /**
  * Configuration options for Web3Mail.
  */
@@ -116,19 +100,3 @@ export type Web3MailConfigOptions = {
    */
   allowExperimentalNetworks?: boolean;
 };
-
-export type DappAddressConsumer = {
-  dappAddressOrENS: AddressOrENS;
-};
-
-export type IpfsNodeConfigConsumer = {
-  ipfsNode: string;
-};
-
-export type IpfsGatewayConfigConsumer = {
-  ipfsGateway: string;
-};
-
-export type DappWhitelistAddressConsumer = {
-  dappWhitelistAddress: string;
-};

tests/e2e/fetchUserContacts.test.ts

@@ -43,6 +43,33 @@ describe('web3mail.fetchMyContacts()', () => {
   }, 4 * MAX_EXPECTED_BLOCKTIME + MAX_EXPECTED_WEB2_SERVICES_TIME);
 
   describe('when no access is granted', () => {
+    it('contacts should contain name, accessPrice, remainingAccess, owner, accessGrantTimestamp, and isUserStrict', async () => {
+      const userWithAccess = Wallet.createRandom().address;
+
+      await web3mail.init();
+      // eslint-disable-next-line @typescript-eslint/dot-notation
+      const authorizedApp = web3mail['dappAddressOrENS'];
+
+      await dataProtector.grantAccess({
+        authorizedApp: authorizedApp,
+        protectedData: protectedData1.address,
+        authorizedUser: userWithAccess,
+      });
+
+      const contacts = await web3mail.fetchUserContacts({
+        userAddress: userWithAccess,
+        isUserStrict: true,
+      });
+      expect(contacts.length).toBe(1);
+      expect(contacts[0].address).toBe(protectedData1.address.toLowerCase());
+      expect(contacts[0].owner).toBeDefined();
+      expect(contacts[0].accessPrice).toBe(0);
+      expect(contacts[0].remainingAccess).toBe(1);
+      expect(contacts[0].accessGrantTimestamp).toBeDefined();
+      expect(contacts[0].isUserStrict).toBe(true);
+      expect(contacts[0].name).toBe('test do not use');
+    });
+
     it(
       'should return an empty contact array',
       async () => {

tests/unit/utils/subgraphQuery.test.ts

@@ -8,7 +8,7 @@ import type { Contact } from '../../../src/web3mail/types.js';
 
 describe('getValidContact', () => {
   // Define the variables in the outermost scope
-  let contacts: Contact[];
+  let contacts: Omit<Contact, 'name'>[];
   let graphQLClient: GraphQLClient;
 
   beforeAll(() => {
@@ -18,16 +18,25 @@ describe('getValidContact', () => {
         address: 'address1',
         owner: 'owner1',
         accessGrantTimestamp: '2023-06-08T09:32:29.761Z',
+        remainingAccess: 1,
+        accessPrice: 0,
+        isUserStrict: true,
       },
       {
         address: 'address2',
         owner: 'owner2',
         accessGrantTimestamp: '2023-06-09T14:21:17.231Z',
+        remainingAccess: 1,
+        accessPrice: 0,
+        isUserStrict: true,
       },
       {
         address: 'address3',
         owner: 'owner3',
         accessGrantTimestamp: '2023-06-10T14:21:17.231Z',
+        remainingAccess: 1,
+        accessPrice: 0,
+        isUserStrict: true,
       },
     ];
 
@@ -38,7 +47,10 @@ describe('getValidContact', () => {
   it('should fetch valid contacts', async () => {
     // Mock the request method of the GraphQLClient instance
     jest.spyOn(graphQLClient, 'request').mockResolvedValue({
-      protectedDatas: [{ id: 'address1' }, { id: 'address3' }],
+      protectedDatas: [
+        { id: 'address1', name: 'Contact 1' },
+        { id: 'address3', name: 'Contact 3' },
+      ],
     });
 
     const validContacts = await getValidContact(graphQLClient, contacts);
@@ -48,11 +60,19 @@ describe('getValidContact', () => {
         address: 'address1',
         owner: 'owner1',
         accessGrantTimestamp: '2023-06-08T09:32:29.761Z',
+        name: 'Contact 1',
+        remainingAccess: 1,
+        accessPrice: 0,
+        isUserStrict: true,
       },
       {
         address: 'address3',
         owner: 'owner3',
         accessGrantTimestamp: '2023-06-10T14:21:17.231Z',
+        name: 'Contact 3',
+        remainingAccess: 1,
+        accessPrice: 0,
+        isUserStrict: true,
       },
     ]);