refactor: merge grantAccess standard and bulk workflows

Author: PierreJeanjacquot

packages/sdk/src/lib/dataProtectorCore/grantAccess.ts

@@ -1,6 +1,5 @@
 import { ZeroAddress } from 'ethers';
-import { NULL_ADDRESS } from 'iexec/utils';
-import { createBulkOrder } from '../../utils/createBulkOrder.js';
+import { DATASET_INFINITE_VOLUME, NULL_ADDRESS } from 'iexec/utils';
 import {
   ValidationError,
   WorkflowError,
@@ -49,7 +48,7 @@ export const grantAccess = async ({
   protectedData,
   authorizedApp,
   authorizedUser,
-  pricePerAccess,
+  pricePerAccess = 0,
   numberOfAccess,
   allowBulk = false,
   onStatusUpdate = () => {},
@@ -65,10 +64,10 @@ export const grantAccess = async ({
   const vAuthorizedUser = addressOrEnsSchema()
     .label('authorizedUser')
     .validateSync(authorizedUser);
-  const vPricePerAccess = positiveIntegerStringSchema()
+  let vPricePerAccess = positiveIntegerStringSchema()
     .label('pricePerAccess')
     .validateSync(pricePerAccess);
-  const vNumberOfAccess = positiveStrictIntegerStringSchema()
+  let vNumberOfAccess = positiveStrictIntegerStringSchema()
     .label('numberOfAccess')
     .validateSync(numberOfAccess);
   const vAllowBulk = booleanSchema().label('allowBulk').validateSync(allowBulk);
@@ -77,6 +76,25 @@ export const grantAccess = async ({
       onStatusUpdate
     );
 
+  // Validate consistency between allowBulk, pricePerAccess and numberOfAccess
+  if (vAllowBulk) {
+    if (vPricePerAccess && vPricePerAccess !== '0') {
+      throw new ValidationError(
+        'allowBulk requires pricePerAccess to be 0 or undefined'
+      );
+    }
+    vPricePerAccess = '0';
+    if (
+      vNumberOfAccess &&
+      vNumberOfAccess !== DATASET_INFINITE_VOLUME.toString()
+    ) {
+      throw new ValidationError(
+        `allowBulk requires numberOfAccess to be ${DATASET_INFINITE_VOLUME.toString()} or undefined`
+      );
+    }
+    vNumberOfAccess = DATASET_INFINITE_VOLUME.toString();
+  }
+
   if (vAuthorizedApp && isEnsTest(vAuthorizedApp)) {
     const resolved = await iexec.ens.resolveName(vAuthorizedApp);
     if (!resolved) {
@@ -127,95 +145,52 @@ export const grantAccess = async ({
     });
   }
 
-  let datasetorder;
-
-  if (vAllowBulk) {
-    vOnStatusUpdate({
-      title: 'CREATE_BULK_ORDER',
-      isDone: false,
-    });
+  vOnStatusUpdate({
+    title: 'CREATE_DATASET_ORDER',
+    isDone: false,
+  });
 
-    datasetorder = await createBulkOrder(iexec, {
+  const datasetorder = await iexec.order
+    .createDatasetorder({
       dataset: vProtectedData,
-      app: vAuthorizedApp,
-      requester: vAuthorizedUser,
+      apprestrict: vAuthorizedApp,
+      requesterrestrict: vAuthorizedUser,
+      datasetprice: vPricePerAccess,
+      volume: vNumberOfAccess,
       tag,
-    }).catch((e) => {
-      throw new WorkflowError({
-        message: 'Failed to create bulk order',
-        errorCause: e,
-      });
-    });
-
-    vOnStatusUpdate({
-      title: 'CREATE_BULK_ORDER',
-      isDone: true,
-    });
-
-    vOnStatusUpdate({
-      title: 'PUBLISH_BULK_ORDER',
-      isDone: false,
-    });
-
-    await iexec.order.publishDatasetorder(datasetorder).catch((e) => {
-      handleIfProtocolError(e);
+    })
+    .then((datasetorderTemplate) =>
+      iexec.order.signDatasetorder(datasetorderTemplate)
+    )
+    .catch((e) => {
       throw new WorkflowError({
-        message: 'Failed to publish bulk order',
+        message: 'Failed to sign data access',
         errorCause: e,
       });
     });
 
-    vOnStatusUpdate({
-      title: 'PUBLISH_BULK_ORDER',
-      isDone: true,
-    });
-  } else {
-    vOnStatusUpdate({
-      title: 'CREATE_DATASET_ORDER',
-      isDone: false,
-    });
-
-    datasetorder = await iexec.order
-      .createDatasetorder({
-        dataset: vProtectedData,
-        apprestrict: vAuthorizedApp,
-        requesterrestrict: vAuthorizedUser,
-        datasetprice: vPricePerAccess,
-        volume: vNumberOfAccess,
-        tag,
-      })
-      .then((datasetorderTemplate) =>
-        iexec.order.signDatasetorder(datasetorderTemplate)
-      )
-      .catch((e) => {
-        throw new WorkflowError({
-          message: 'Failed to sign data access',
-          errorCause: e,
-        });
-      });
+  vOnStatusUpdate({
+    title: 'CREATE_DATASET_ORDER',
+    isDone: true,
+  });
 
-    vOnStatusUpdate({
-      title: 'CREATE_DATASET_ORDER',
-      isDone: true,
-    });
+  vOnStatusUpdate({
+    title: 'PUBLISH_DATASET_ORDER',
+    isDone: false,
+  });
 
-    vOnStatusUpdate({
-      title: 'PUBLISH_DATASET_ORDER',
-      isDone: false,
+  await iexec.order.publishDatasetorder(datasetorder).catch((e) => {
+    handleIfProtocolError(e);
+    throw new WorkflowError({
+      message: 'Failed to publish data access',
+      errorCause: e,
     });
+  });
 
-    await iexec.order.publishDatasetorder(datasetorder).catch((e) => {
-      handleIfProtocolError(e);
-      throw new WorkflowError({
-        message: 'Failed to publish data access',
-        errorCause: e,
-      });
-    });
+  vOnStatusUpdate({
+    title: 'PUBLISH_DATASET_ORDER',
+    isDone: true,
+  });
 
-    vOnStatusUpdate({
-      title: 'PUBLISH_DATASET_ORDER',
-      isDone: true,
-    });
-  }
   return formatGrantedAccess(datasetorder, parseInt(datasetorder.volume));
 };

packages/sdk/src/lib/types/coreTypes.ts

@@ -193,6 +193,9 @@ export type GrantAccessParams = {
 
   /**
    * Enable bulk processing for the granted access
+   *
+   * Bulk processing allows multiple protected data to be processed in a single task without paying per access.
+   * `pricePerAccess` and `numberOfAccess` should be left undefined when `allowBulk` is true.
    */
   allowBulk?: boolean;
 

packages/sdk/src/utils/createBulkOrder.ts

@@ -279,19 +279,19 @@ describe('dataProtectorCore.grantAccess()', () => {
       expect(grantedAccess.volume).toBe('9007199254740991'); // Number.MAX_SAFE_INTEGER
       expect(grantedAccess.datasetprice).toBe('0'); // Price should be 0 for bulk orders
       expect(onStatusUpdateMock).toHaveBeenNthCalledWith(1, {
-        title: 'CREATE_BULK_ORDER',
+        title: 'CREATE_DATASET_ORDER',
         isDone: false,
       });
       expect(onStatusUpdateMock).toHaveBeenNthCalledWith(2, {
-        title: 'CREATE_BULK_ORDER',
+        title: 'CREATE_DATASET_ORDER',
         isDone: true,
       });
       expect(onStatusUpdateMock).toHaveBeenNthCalledWith(3, {
-        title: 'PUBLISH_BULK_ORDER',
+        title: 'PUBLISH_DATASET_ORDER',
         isDone: false,
       });
       expect(onStatusUpdateMock).toHaveBeenNthCalledWith(4, {
-        title: 'PUBLISH_BULK_ORDER',
+        title: 'PUBLISH_DATASET_ORDER',
         isDone: true,
       });
     },