Merge pull request #277 from nevermined-io/feature/find-associated-datasets

Find associated datasets

Author: spielcrypto

.github/workflows/testing.yml

@@ -34,7 +34,7 @@ jobs:
         with:
           node-version: "17.x"
           registry-url: https://registry.npmjs.org/
-      - uses: nevermined-io/nvm-tools-actions@v0.7.1
+      - uses: nevermined-io/nvm-tools-actions@v0.8.0
         with:
           token: ${{ secrets.API_TOKEN_GITHUB }}
           opengsn: 'true'

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v1.2.0](https://github.com/nevermined-io/components-catalog/compare/v1.1.10...v1.2.0)
+
+> 20 March 2023
+
+- Feature add subscription funtionalities [`#275`](https://github.com/nevermined-io/components-catalog/pull/275)
+- add subscription functionalities [`01f4c28`](https://github.com/nevermined-io/components-catalog/commit/01f4c288a322ba2a0e00ce8486acf4690dce2bb1)
+- Adding v1.1.10 Changelog updates [`ddbe5ef`](https://github.com/nevermined-io/components-catalog/commit/ddbe5effd13d2dc73732ab10d1d0eac20af2ffce)
+- update React Components version [`29da903`](https://github.com/nevermined-io/components-catalog/commit/29da903598cdd3ae6622d664b1527d2475b9ebb4)
+
 #### [v1.1.10](https://github.com/nevermined-io/components-catalog/compare/v1.1.9...v1.1.10)
 
 > 16 March 2023

catalog/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@nevermined-io/catalog",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
     "@nevermined-io/sdk-dtp": "^0.4.1",
-    "@nevermined-io/sdk": "^1.2.0",
+    "@nevermined-io/sdk": "^1.3.0",
     "@types/jsonwebtoken": "^8.5.8",
     "axios": "^0.27.2",
     "axios-retry": "^3.3.1",

catalog/src/catalog.tsx

@@ -22,7 +22,8 @@ import {
   TransferNFTConditionMethod,
   BigNumber,
   SubscriptionsAndServicesDDOs,
-  OrderProgressStep
+  OrderProgressStep,
+  SubscriptionsAndDatasetsDDOs
 } from './types'
 import {
   conductOrder,
@@ -32,6 +33,7 @@ import {
   getAgreementId,
   handlePostRequest,
   getSubscriptionsAndServices,
+  getSubscriptionsAndDatasets,
   executeWithProgressEvent,
 } from './utils'
 import { _getCryptoConfig, _getDTPInstance, _grantAccess } from './utils/dtp'
@@ -230,6 +232,17 @@ export const NeverminedProvider = ({ children, config, verbose }: NeverminedProv
       }
     },
 
+    getPublishedSubscriptionsAndDatasets: async (): Promise<SubscriptionsAndDatasetsDDOs[]> => {
+      try {
+        const account = await getCurrentAccount(sdk)
+        const query = await sdk.search.subscriptionsCreated(account)
+        return getSubscriptionsAndDatasets(query.results, sdk)
+      } catch (error) {
+        verbose && Logger.error(error)
+        return []
+      }
+    },
+
     getPurchasedSubscriptions: async (): Promise<DDO[]> => {
       try {
         const account = await getCurrentAccount(sdk)
@@ -252,6 +265,17 @@ export const NeverminedProvider = ({ children, config, verbose }: NeverminedProv
       }
     },
 
+    getPurchasedSubscriptionsAndDatasets: async (): Promise<SubscriptionsAndDatasetsDDOs[]> => {
+      try {
+        const account = await getCurrentAccount(sdk)
+        const query = await sdk.search.subscriptionsPurchased(account)
+        return getSubscriptionsAndDatasets(query.results, sdk)
+      } catch (error) {
+        verbose && Logger.error(error)
+        return []
+      }
+    },
+
     getAssociatedServices: async (did: string): Promise<DDO[]> => {
       try {
         const query = await sdk.search.servicesBySubscription(did)
@@ -262,6 +286,16 @@ export const NeverminedProvider = ({ children, config, verbose }: NeverminedProv
       }
     },
 
+    getAssociatedDatasets: async (did: string): Promise<DDO[]> => {
+      try {
+        const query = await sdk.search.datasetsBySubscription(did)
+        return query.results
+      } catch (error) {
+        verbose && Logger.error(error)
+        return []
+      }
+    },
+
     isAssetHolder: async (
       did: string,
       walletAddress: string,

catalog/src/types/index.ts

@@ -409,18 +409,29 @@ export interface AccountModule {
    */
   getPublishedSubscriptions: (address: string) => Promise<DDO[]>
   /**
-   * Get all the services associated
-   * @param address the address which published the subscription returned
+   * Get all the services associated a subscription
+   * @param address the subscription address
    * @returns associated services to subscriptions
    */
   getAssociatedServices: (did: string) => Promise<DDO[]>
+  /**
+   * Get all the datasets associated to a subscription
+   * @param address the subscription address
+   * @returns associated datasets to subscriptions
+   */
+  getAssociatedDatasets: (did: string) => Promise<DDO[]>
   /**
    * Get all the published subscriptions and services associated from the wallet address passed
-   * Get only published Subscriptions
    * @param did the did of the subscription
    * @returns published subscriptions and service
    */
   getPublishedSubscriptionsAndServices: (address: string) => Promise<SubscriptionsAndServicesDDOs[]>
+  /**
+   * Get all the published subscriptions and datasets associated from the wallet address passed
+   * @param did the did of the subscription
+   * @returns published subscriptions and its datasets
+   */
+  getPublishedSubscriptionsAndDatasets: (address: string) => Promise<SubscriptionsAndDatasetsDDOs[]>
   /**
    * Get only purchased Subscriptions
    * @param address the address which purchased the subscription returned
@@ -433,6 +444,12 @@ export interface AccountModule {
    * @returns purchased subscriptions and services
    */
   getPurchasedSubscriptionsAndServices: (address: string) => Promise<SubscriptionsAndServicesDDOs[]>
+  /**
+   * Get all the purchased subscriptions and datasets associated from the wallet address passed
+   * @param did the did of the subscription
+   * @returns purchased subscriptions and its datasets
+   */
+  getPurchasedSubscriptionsAndDatasets: (address: string) => Promise<SubscriptionsAndDatasetsDDOs[]>
   /**
    * Generate a token for authentication in the Marketplace API
    * @returns The new generated token
@@ -948,3 +965,8 @@ export interface SubscriptionsAndServicesDDOs {
   subscription: DDO
   services: DDO[]
 }
+
+export interface SubscriptionsAndDatasetsDDOs {
+  subscription: DDO
+  datasets: DDO[]
+}

catalog/src/utils/index.ts

@@ -186,6 +186,19 @@ export const getSubscriptionsAndServices = async (subscriptionsDDOs: DDO[], sdk:
   )
 }
 
+export const getSubscriptionsAndDatasets = async (subscriptionsDDOs: DDO[], sdk: Nevermined) => {
+  return Promise.all(
+    subscriptionsDDOs.map(async (ddo) => {
+      const query = await sdk.search.datasetsBySubscription(ddo.id)
+
+      return {
+        subscription: ddo,
+        datasets: query.results,
+      }
+    }),
+  )
+}
+
 export const executeWithProgressEvent = async <T>(
   subscribableAction: () => SubscribablePromise<any, T>,
   onEvent?: (next: any) => void,

catalog/unit-tests/catalog/catalog.account.spec.tsx

@@ -2,9 +2,9 @@ import React, { useEffect, useState } from 'react'
 import { renderHook, waitFor } from '@testing-library/react'
 import { generateTestingUtils } from 'eth-testing'
 import { appConfig } from '../config'
-import { Catalog, AuthToken, SubscriptionsAndServicesDDOs, DDO } from '../../src'
+import { Catalog, AuthToken, SubscriptionsAndServicesDDOs, SubscriptionsAndDatasetsDDOs, DDO } from '../../src'
 import jwt from 'jsonwebtoken'
-import { ddo, ddo2, ddo3, walletAddress, nevermined } from '../mockups'
+import { ddo, ddo2, ddo3, ddo4, ddo5, walletAddress, nevermined } from '../mockups'
 import { faker } from '@faker-js/faker'
 
 jest.mock('@nevermined-io/sdk', () => ({
@@ -716,4 +716,118 @@ describe('Nevermined account', () => {
       expect(result.current).toStrictEqual([ddo2, ddo3])
     })
   })
+
+  it('should get all the subscriptions published and datasets by the address passed', async () =>{
+    const { result } = renderHook(
+      () => {
+        const { account, isLoadingSDK, updateSDK } = Catalog.useNevermined()
+        const [ subscriptions, setSubscriptions ] = useState<SubscriptionsAndDatasetsDDOs[]>([])
+
+        useEffect(() => {
+          if (isLoadingSDK) {
+            appConfig.web3Provider = testingUtils.getProvider()
+            updateSDK(appConfig)
+            return
+          }
+
+          (async () => {
+            try {
+              const result = await account.getPublishedSubscriptionsAndDatasets(walletAddress)
+
+              setSubscriptions([...result])
+            } catch (error: any) {
+              console.error(error.message)
+            }
+          })()
+        }, [isLoadingSDK])
+
+        return subscriptions
+      },
+      {
+        wrapper: wrapperProvider
+      }
+    )
+
+    await waitFor(() => {
+      expect(result.current).toStrictEqual([{
+        subscription: ddo,
+        datasets: [ddo4, ddo5]
+      }])
+    })
+  })
+
+  it('should get all the subscriptions purchased and datasets by the address passed', async () =>{
+    const { result } = renderHook(
+      () => {
+        const { account, isLoadingSDK, updateSDK } = Catalog.useNevermined()
+        const [ subscriptions, setSubscriptions ] = useState<SubscriptionsAndDatasetsDDOs[]>([])
+
+        useEffect(() => {
+          if (isLoadingSDK) {
+            appConfig.web3Provider = testingUtils.getProvider()
+            updateSDK(appConfig)
+            return
+          }
+
+          (async () => {
+            try {
+              const result = await account.getPublishedSubscriptionsAndDatasets(walletAddress)
+
+              setSubscriptions([...result])
+            } catch (error: any) {
+              console.error(error.message)
+            }
+          })()
+        }, [isLoadingSDK])
+
+        return subscriptions
+      },
+      {
+        wrapper: wrapperProvider
+      }
+    )
+
+    await waitFor(() => {
+      expect(result.current).toStrictEqual([{
+        subscription: ddo,
+        datasets: [ddo4, ddo5]
+      }])
+    })
+  })
+
+  it('should get all the datasets associated to the subscription id passed', async () =>{
+    const { result } = renderHook(
+      () => {
+        const { account, isLoadingSDK, updateSDK } = Catalog.useNevermined()
+        const [ datasets, setDatasets ] = useState<DDO[]>([])
+
+        useEffect(() => {
+          if (isLoadingSDK) {
+            appConfig.web3Provider = testingUtils.getProvider()
+            updateSDK(appConfig)
+            return
+          }
+
+          (async () => {
+            try {
+              const result = await account.getAssociatedDatasets(ddo.id)
+
+              setDatasets([...result])
+            } catch (error: any) {
+              console.error(error.message)
+            }
+          })()
+        }, [isLoadingSDK])
+
+        return datasets
+      },
+      {
+        wrapper: wrapperProvider
+      }
+    )
+
+    await waitFor(() => {
+      expect(result.current).toStrictEqual([ddo4, ddo5])
+    })
+  })
 })