Release/sdk v2.0.0 beta.12 (#398)

ErwanDecoster · web-flow · commit aae6aecc3e82 · 2025-02-05T15:50:08.000+01:00
diff --git a/.drone.yml b/.drone.yml
@@ -668,43 +668,49 @@ trigger:
   event:
     - promote
   target:
-    # deploy the dataprotector subgraph
-    - subgraph-deploy-dev
     # deploy the dataprotector subgraph for the staging environment
     - subgraph-deploy-staging
+    # deploy the dataprotector subgraph
+    - subgraph-deploy-tmp
     # deploy the dataprotector subgraph for the prod environment
     - subgraph-deploy-prod
   branch:
     - develop
     - main
 
 steps:
-  - name: deploy-v2-dev
+  - name: install deps
+    image: node:18.19
+    pull: always
+    commands:
+      - cd packages/subgraph
+      - npm ci
+
+  - name: deploy-v2-staging
     image: node:18.19
     params:
       - START_BLOCK
     environment:
       GRAPHNODE_URL:
-        from_secret: graphnode-url
+        from_secret: graphnode-url-staging
       IPFS_URL:
-        from_secret: ipfs-url
-      ENV: prod
+        from_secret: ipfs-url-staging
+      ENV: staging
     commands:
       - cd packages/subgraph
-      - export SUBGRAPH_NAME=bellecour/dev-dataprotector-v2
+      - export SUBGRAPH_NAME=bellecour/staging-dataprotector-v2
       - echo "deploying commit $DRONE_COMMIT on subgraph $SUBGRAPH_NAME"
-      - npm ci
       - npm run codegen
       - npm run build
       - npx graph create --node $GRAPHNODE_URL $SUBGRAPH_NAME
-      - npx graph deploy --node $GRAPHNODE_URL $SUBGRAPH_NAME --ipfs $IPFS_URL --version-label $DRONE_COMMIT
+      - npx graph deploy --node $GRAPHNODE_URL $SUBGRAPH_NAME --ipfs $IPFS_URL --version-label $(npm pkg get version)
     when:
       target:
-        - subgraph-deploy-dev
+        - subgraph-deploy-staging
       branch:
         - develop
 
-  - name: deploy-v2-prod
+  - name: deploy-v2-tmp
     image: node:18.19
     params:
       - START_BLOCK
@@ -716,20 +722,19 @@ steps:
       ENV: prod
     commands:
       - cd packages/subgraph
-      - export SUBGRAPH_NAME=bellecour/dataprotector-v2
+      - export SUBGRAPH_NAME=bellecour/tmp-dataprotector-v2
       - echo "deploying commit $DRONE_COMMIT on subgraph $SUBGRAPH_NAME"
-      - npm ci
       - npm run codegen
       - npm run build
       - npx graph create --node $GRAPHNODE_URL $SUBGRAPH_NAME
-      - npx graph deploy --node $GRAPHNODE_URL $SUBGRAPH_NAME --ipfs $IPFS_URL --version-label $(npm pkg get version)
+      - npx graph deploy --node $GRAPHNODE_URL $SUBGRAPH_NAME --ipfs $IPFS_URL --version-label $DRONE_COMMIT
     when:
       target:
-        - subgraph-deploy-prod
+        - subgraph-deploy-tmp
       branch:
         - main
 
-  - name: deploy-v2-staging
+  - name: deploy-v2-prod
     image: node:18.19
     params:
       - START_BLOCK
@@ -738,21 +743,20 @@ steps:
         from_secret: graphnode-url
       IPFS_URL:
         from_secret: ipfs-url
-      ENV: staging
+      ENV: prod
     commands:
       - cd packages/subgraph
-      - export SUBGRAPH_NAME=bellecour/staging-dataprotector-v2
+      - export SUBGRAPH_NAME=bellecour/dataprotector-v2
       - echo "deploying commit $DRONE_COMMIT on subgraph $SUBGRAPH_NAME"
-      - npm ci
       - npm run codegen
       - npm run build
       - npx graph create --node $GRAPHNODE_URL $SUBGRAPH_NAME
       - npx graph deploy --node $GRAPHNODE_URL $SUBGRAPH_NAME --ipfs $IPFS_URL --version-label $(npm pkg get version)
     when:
       target:
-        - subgraph-deploy-staging
+        - subgraph-deploy-prod
       branch:
-        - develop
+        - main
 
 ---
 #pipeline to deploy app whitelist on iexec
@@ -937,7 +941,7 @@ steps:
         from_secret: nexus-password
       tags:
         - dev
-        - 'dev-${DRONE_COMMIT}'
+        - "dev-${DRONE_COMMIT}"
     when:
       branch:
         - develop
diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md
@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.0.0-beta.12] (2025-02-04)
+
+### Added
+
+- Added optional `path` parameter to `processProtectedData` method
+
+### Changed
+
+- Moved `getResultFromCompletedTask` method from DataProtectorSharing module (DPS) to DataProtectorCore module (DPC).
+
 ## [2.0.0-beta.11] (2025-01-29)
 
 ### Added
diff --git a/packages/sdk/package-lock.json b/packages/sdk/package-lock.json
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@iexec/dataprotector",
-  "version": "2.0.0-beta.11",
+  "version": "2.0.0-beta.12",
   "description": "This product enables users to confidentially store data–such as mail address, documents, personal information ...",
   "type": "module",
   "types": "dist/src/index.d.ts",
diff --git a/packages/sdk/src/lib/dataProtectorCore/IExecDataProtectorCore.ts b/packages/sdk/src/lib/dataProtectorCore/IExecDataProtectorCore.ts
@@ -10,6 +10,8 @@ import {
   ProcessProtectedDataResponse,
   ProtectDataParams,
   ProtectedData,
+  GetResultFromCompletedTaskParams,
+  GetResultFromCompletedTaskResponse,
   ProtectedDataWithSecretProps,
   RevokeAllAccessParams,
   RevokedAccess,
@@ -18,6 +20,7 @@ import {
 } from '../types/index.js';
 import { getGrantedAccess } from './getGrantedAccess.js';
 import { getProtectedData } from './getProtectedData.js';
+import { getResultFromCompletedTask } from './getResultFromCompletedTask.js';
 import { grantAccess } from './grantAccess.js';
 import { processProtectedData } from './processProtectedData.js';
 import { protectData } from './protectData.js';
@@ -84,6 +87,16 @@ class IExecDataProtectorCore extends IExecDataProtectorModule {
   ): Promise<GrantedAccessResponse> {
     return getGrantedAccess({ ...args, iexec: this.iexec });
   }
+
+  async getResultFromCompletedTask(
+    args: GetResultFromCompletedTaskParams
+  ): Promise<GetResultFromCompletedTaskResponse> {
+    await isValidProvider(this.iexec);
+    return getResultFromCompletedTask({
+      ...args,
+      iexec: this.iexec,
+    });
+  }
 }
 
 export { IExecDataProtectorCore };
diff --git a/packages/sdk/src/lib/dataProtectorCore/getResultFromCompletedTask.ts b/packages/sdk/src/lib/dataProtectorCore/getResultFromCompletedTask.ts
diff --git a/packages/sdk/src/lib/dataProtectorCore/processProtectedData.ts b/packages/sdk/src/lib/dataProtectorCore/processProtectedData.ts
@@ -22,7 +22,7 @@ import {
   validateOnStatusUpdateCallback,
 } from '../../utils/validators.js';
 import { isERC734 } from '../../utils/whitelist.js';
-import { getResultFromCompletedTask } from '../dataProtectorSharing/getResultFromCompletedTask.js';
+import { getResultFromCompletedTask } from './getResultFromCompletedTask.js';
 import {
   OnStatusUpdateFn,
   ProcessProtectedDataParams,
@@ -41,6 +41,7 @@ export const processProtectedData = async ({
   app,
   userWhitelist,
   maxPrice = DEFAULT_MAX_PRICE,
+  path,
   args,
   inputFiles,
   secrets,
@@ -62,6 +63,7 @@ export const processProtectedData = async ({
   const vMaxPrice = positiveNumberSchema()
     .label('maxPrice')
     .validateSync(maxPrice);
+  const vPath = stringSchema().label('path').validateSync(path);
   const vInputFiles = urlArraySchema()
     .label('inputFiles')
     .validateSync(inputFiles);
@@ -236,6 +238,7 @@ export const processProtectedData = async ({
     const { result } = await getResultFromCompletedTask({
       iexec,
       taskId,
+      path: vPath,
       onStatusUpdate: vOnStatusUpdate,
     });
 
diff --git a/packages/sdk/src/lib/dataProtectorSharing/IExecDataProtectorSharing.ts b/packages/sdk/src/lib/dataProtectorSharing/IExecDataProtectorSharing.ts
@@ -20,8 +20,6 @@ import {
   GetProtectedDataPricingParamsResponse,
   GetRentalsParams,
   GetRentalsResponse,
-  GetResultFromCompletedTaskParams,
-  GetResultFromCompletedTaskResponse,
   GetUserAppWhitelistParams,
   GetUserAppWhitelistResponse,
   RemoveCollectionParams,
@@ -50,7 +48,6 @@ import { getCollectionSubscriptions } from './getCollectionSubscriptions.js';
 import { getProtectedDataInCollections } from './getProtectedDataInCollections.js';
 import { getProtectedDataPricingParams } from './getProtectedDataPricingParams.js';
 import { getRentals } from './getRentals.js';
-import { getResultFromCompletedTask } from './getResultFromCompletedTask.js';
 import { getUserAddOnlyAppWhitelist } from './getUserAddOnlyAppWhitelist.js';
 import { removeCollection } from './removeCollection.js';
 import { removeProtectedDataForSale } from './removeProtectedDataForSale.js';
@@ -254,16 +251,6 @@ class IExecDataProtectorSharing extends IExecDataProtectorModule {
     });
   }
 
-  async getResultFromCompletedTask(
-    args: GetResultFromCompletedTaskParams
-  ): Promise<GetResultFromCompletedTaskResponse> {
-    await isValidProvider(this.iexec);
-    return getResultFromCompletedTask({
-      ...args,
-      iexec: this.iexec,
-    });
-  }
-
   // -------------------- Apps whitelist --------------------
 
   async createAddOnlyAppWhitelist(): Promise<CreateAppWhitelistResponse> {
diff --git a/packages/sdk/src/lib/dataProtectorSharing/consumeProtectedData.ts b/packages/sdk/src/lib/dataProtectorSharing/consumeProtectedData.ts
@@ -17,6 +17,7 @@ import {
   throwIfMissing,
   validateOnStatusUpdateCallback,
   positiveNumberSchema,
+  stringSchema,
 } from '../../utils/validators.js';
 import {
   ConsumeProtectedDataParams,
@@ -26,7 +27,7 @@ import {
   SharingContractConsumer,
 } from '../types/index.js';
 import { IExecConsumer } from '../types/internalTypes.js';
-import { getResultFromCompletedTask } from './getResultFromCompletedTask.js';
+import { getResultFromCompletedTask } from '../dataProtectorCore/getResultFromCompletedTask.js';
 import { getAppWhitelistContract } from './smartContract/getAddOnlyAppWhitelistContract.js';
 import { getSharingContract } from './smartContract/getSharingContract.js';
 import {
@@ -56,6 +57,7 @@ export const consumeProtectedData = async ({
   const vMaxPrice = positiveNumberSchema()
     .label('maxPrice')
     .validateSync(maxPrice);
+  const vPath = stringSchema().label('path').validateSync(path);
   let vApp = addressOrEnsSchema().required().label('app').validateSync(app);
   let vWorkerpool = addressOrEnsSchema()
     .label('workerpool')
@@ -215,7 +217,7 @@ export const consumeProtectedData = async ({
     const { result } = await getResultFromCompletedTask({
       iexec,
       taskId,
-      path,
+      path: vPath,
       pemPrivateKey: privateKey,
       onStatusUpdate: vOnStatusUpdate,
     });
diff --git a/packages/sdk/src/lib/types/coreTypes.ts b/packages/sdk/src/lib/types/coreTypes.ts
@@ -209,6 +209,23 @@ export type GrantedAccessResponse = {
   grantedAccess: GrantedAccess[];
 };
 
+// ---------------------GetResultFromCompletedTask Types------------------------------------
+
+export type GetResultFromCompletedTaskStatuses =
+  | 'CONSUME_RESULT_DOWNLOAD'
+  | 'CONSUME_RESULT_DECRYPT';
+
+export type GetResultFromCompletedTaskParams = {
+  taskId: string;
+  path?: string;
+  pemPrivateKey?: string;
+  onStatusUpdate?: OnStatusUpdateFn<GetResultFromCompletedTaskStatuses>;
+};
+
+export type GetResultFromCompletedTaskResponse = {
+  result: ArrayBuffer;
+};
+
 // ---------------------RevokeAccess Types------------------------------------
 export type RevokeAllAccessStatuses =
   | 'RETRIEVE_ALL_GRANTED_ACCESS'
@@ -291,6 +308,11 @@ export type ProcessProtectedDataParams = {
   */
   maxPrice?: number;
 
+  /**
+   * The file name of the desired file in the returned ZIP file.
+   */
+  path?: string;
+
   /**
    * Arguments to pass to the application during execution.
    */
diff --git a/packages/sdk/src/lib/types/sharingTypes.ts b/packages/sdk/src/lib/types/sharingTypes.ts
@@ -120,21 +120,6 @@ export type ConsumeProtectedDataResponse = {
   pemPrivateKey: string;
 };
 
-export type GetResultFromCompletedTaskStatuses =
-  | 'CONSUME_RESULT_DOWNLOAD'
-  | 'CONSUME_RESULT_DECRYPT';
-
-export type GetResultFromCompletedTaskParams = {
-  taskId: string;
-  path?: string;
-  pemPrivateKey?: string;
-  onStatusUpdate?: OnStatusUpdateFn<GetResultFromCompletedTaskStatuses>;
-};
-
-export type GetResultFromCompletedTaskResponse = {
-  result: ArrayBuffer;
-};
-
 // ---------------------Collection Types------------------------------------
 
 export type Collection = {
diff --git a/packages/sdk/tests/e2e/dataProtectorCore/processProtectedData.test.ts b/packages/sdk/tests/e2e/dataProtectorCore/processProtectedData.test.ts
@@ -82,7 +82,7 @@ describe.skip('dataProtectorCore.processProtectedData()', () => {
 
       const mockArrayBuffer = new ArrayBuffer(8);
       jest.unstable_mockModule(
-        '../../../src/lib/dataProtectorSharing/getResultFromCompletedTask.js',
+        '../../../src/lib/dataProtectorCore/getResultFromCompletedTask.js',
         () => {
           return {
             getResultFromCompletedTask: jest
@@ -108,6 +108,7 @@ describe.skip('dataProtectorCore.processProtectedData()', () => {
           2: 'email content for test processData',
         },
         args: '_args_test_process_data_',
+        path: 'computed.json',
         onStatusUpdate: onStatusUpdateMock,
       });
 
diff --git a/packages/sdk/tests/unit/dataProtectorCore/processProtectedData/processProtectedData.test.ts b/packages/sdk/tests/unit/dataProtectorCore/processProtectedData/processProtectedData.test.ts
@@ -153,6 +153,26 @@ describe('processProtectedData', () => {
       });
     });
 
+    describe('When given path is NOT a valid string', () => {
+      it('should throw a yup ValidationError with the correct message', async () => {
+        // --- GIVEN
+        const invalidPath = 42;
+
+        await expect(
+          // --- WHEN
+          processProtectedData({
+            // @ts-expect-error No need for iexec here
+            iexec: {},
+            protectedData: getRandomAddress(),
+            app: getRandomAddress(),
+            // @ts-expect-error Type 'number' is not assignable to type 'string'
+            path: invalidPath,
+          })
+          // --- THEN
+        ).rejects.toThrow(new ValidationError('path should be a string'));
+      });
+    });
+
     describe('When maxPrice is not a positive number', () => {
       it('should throw a yup ValidationError with the correct message', async () => {
         // --- GIVEN
diff --git a/packages/sdk/tests/unit/dataProtectorSharing/consumeProtectedData.test.ts b/packages/sdk/tests/unit/dataProtectorSharing/consumeProtectedData.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@iexec/dataprotector",`
`3`		`- "version": "2.0.0-beta.11",`
	`3`	`+ "version": "2.0.0-beta.12",`
`4`	`4`	`"description": "This product enables users to confidentially store data–such as mail address, documents, personal information ...",`
`5`	`5`	`"type": "module",`
`6`	`6`	`"types": "dist/src/index.d.ts",`