feat: add campaignRequest validation

Author: PierreJeanjacquot

src/utils/validators.ts

@@ -1,6 +1,7 @@
 import { isAddress } from 'ethers';
 import { IExec } from 'iexec';
-import { ValidationError, boolean, number, string } from 'yup';
+import { NULL_ADDRESS } from 'iexec/utils';
+import { ValidationError, boolean, number, object, string } from 'yup';
 
 export const isValidProvider = async (iexec: IExec) => {
   const client = await iexec.config.resolveContractsClient();
@@ -61,3 +62,59 @@ export const positiveNumberSchema = () =>
 
 export const booleanSchema = () =>
   boolean().strict().typeError('${path} should be a boolean');
+
+const isPositiveIntegerStringTest = (value: string) => /^\d+$/.test(value);
+
+const stringSchema = () =>
+  string().strict().typeError('${path} should be a string');
+
+const positiveIntegerStringSchema = () =>
+  string().test(
+    'is-positive-int',
+    '${path} should be a positive integer',
+    (value) => isUndefined(value) || isPositiveIntegerStringTest(value)
+  );
+
+const positiveStrictIntegerStringSchema = () =>
+  string().test(
+    'is-positive-strict-int',
+    '${path} should be a strictly positive integer',
+    (value) =>
+      isUndefined(value) ||
+      (value !== '0' && isPositiveIntegerStringTest(value))
+  );
+
+export const campaignRequestSchema = () =>
+  object({
+    app: addressSchema().required(),
+    appmaxprice: positiveIntegerStringSchema().required(),
+    workerpool: addressSchema().required(),
+    workerpoolmaxprice: positiveIntegerStringSchema().required(),
+    dataset: addressSchema().oneOf([NULL_ADDRESS]).required(),
+    datasetmaxprice: positiveIntegerStringSchema().oneOf(['0']).required(),
+    params: stringSchema()
+      .test(
+        'is-valid-bulk-params',
+        '${path} should be a valid JSON string with bulk_cid field',
+        (value) => {
+          try {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            const { bulk_cid } = JSON.parse(value);
+            if (typeof bulk_cid === 'string') {
+              return true;
+            }
+          } catch {}
+          return false;
+        }
+      )
+      .required(),
+    requester: addressSchema().required(),
+    beneficiary: addressSchema().required(),
+    callback: addressSchema().required(),
+    category: positiveIntegerStringSchema().required(),
+    volume: positiveStrictIntegerStringSchema().required(),
+    tag: stringSchema().required(),
+    trust: positiveIntegerStringSchema().required(),
+    salt: stringSchema().required(),
+    sign: stringSchema().required(),
+  }).typeError('${path} should be a BulkRequest object');

src/web3mail/sendEmailCampaign.ts

@@ -1,8 +1,16 @@
 import { NULL_ADDRESS } from 'iexec/utils';
 import { ValidationError } from 'yup';
 import { handleIfProtocolError, WorkflowError } from '../utils/errors.js';
-import { addressOrEnsSchema, throwIfMissing } from '../utils/validators.js';
-import { SendEmailCampaignParams, SendEmailCampaignResponse } from './types.js';
+import {
+  addressOrEnsSchema,
+  campaignRequestSchema,
+  throwIfMissing,
+} from '../utils/validators.js';
+import {
+  CampaignRequest,
+  SendEmailCampaignParams,
+  SendEmailCampaignResponse,
+} from './types.js';
 import { DataProtectorConsumer } from './internalTypes.js';
 
 export type SendEmailCampaign = typeof sendEmailCampaign;
@@ -13,14 +21,20 @@ export const sendEmailCampaign = async ({
   campaignRequest,
 }: DataProtectorConsumer &
   SendEmailCampaignParams): Promise<SendEmailCampaignResponse> => {
+  const vCampaignRequest = campaignRequestSchema()
+    .required()
+    .label('campaignRequest')
+    .validateSync(campaignRequest) as CampaignRequest;
+
   const vWorkerpoolAddressOrEns = addressOrEnsSchema()
     .required()
     .label('workerpoolAddressOrEns')
     .validateSync(workerpoolAddressOrEns);
+
   if (
-    campaignRequest?.workerpool !== NULL_ADDRESS &&
-    vWorkerpoolAddressOrEns.toLowerCase() !==
-      campaignRequest.workerpool.toLowerCase()
+    vCampaignRequest.workerpool !== NULL_ADDRESS &&
+    vCampaignRequest.workerpool.toLowerCase() !==
+      vWorkerpoolAddressOrEns.toLowerCase()
   ) {
     throw new ValidationError(
       "workerpoolAddressOrEns doesn't match campaignRequest workerpool"
@@ -29,12 +43,11 @@ export const sendEmailCampaign = async ({
 
   try {
     // Process the prepared bulk request
-    const processBulkRequestResponse: SendEmailCampaignResponse =
-      await dataProtector.processBulkRequest({
-        bulkRequest: campaignRequest,
-        workerpool: vWorkerpoolAddressOrEns,
-        waitForResult: false,
-      });
+    const processBulkRequestResponse = await dataProtector.processBulkRequest({
+      bulkRequest: vCampaignRequest,
+      workerpool: vWorkerpoolAddressOrEns,
+      waitForResult: false,
+    });
 
     return processBulkRequestResponse;
   } catch (error) {