feat: add getChannelByTopic in data-access (#305)

**Data-access**:
* add getChannelByTopic

**Transaction manager**:
* add getChannelByTopic

**Request logic**:
* integrate getChannelByTopic

**Request node**:
* add getChannelByTopic

**Request client**:
* integrate getChannelByTopic

Author: vrolland

.eslintrc

@@ -59,6 +59,7 @@
           "tx",
           "txs",
           "tsconfig",
+          "typedef",
           "typeof",
           "utils",
           "validator",

packages/data-access/src/data-access.ts

@@ -271,6 +271,77 @@ export default class DataAccess implements DataAccessTypes.IDataAccess {
     );
   }
 
+  /**
+   * Function to get a list of channels indexed by topic
+   *
+   * @param topic topic to retrieve the transaction from
+   * @param updatedBetween filter the channels that have received new data within the time boundaries
+   *
+   * @returns list of channels indexed by topic
+   */
+  public async getChannelsByTopic(
+    topic: string,
+    updatedBetween?: DataAccessTypes.ITimestampBoundaries,
+  ): Promise<DataAccessTypes.IReturnGetChannelsByTopic> {
+    if (!this.locationByTopic) {
+      throw new Error('DataAccess must be initialized');
+    }
+
+    // Gets the list of locationStorage grouped by channel id for the topic given
+    const storageLocationByChannelId = this.locationByTopic.getStorageLocationFromTopicGroupedByChannelId(
+      topic,
+    );
+
+    let channelIds = Object.keys(storageLocationByChannelId);
+
+    // Filters the channels to only keep the modified ones during the time boundaries
+    if (updatedBetween) {
+      channelIds = channelIds.filter(channelId => {
+        return storageLocationByChannelId[channelId].find(dataId =>
+          this.timestampByLocation.isDataInBoundaries(dataId, updatedBetween),
+        );
+      });
+    }
+
+    // Gets the transactions per channel id
+    const transactionsAndMeta = await Promise.all(
+      channelIds.map(channelId =>
+        this.getTransactionsByChannelId(channelId).then(transactionsWithMeta => ({
+          channelId,
+          transactionsWithMeta,
+        })),
+      ),
+    );
+
+    // Gather all the transaction in one object
+    return transactionsAndMeta.reduce(
+      (finalResult: DataAccessTypes.IReturnGetChannelsByTopic, channelIdAndTransactions: any) => {
+        const id = channelIdAndTransactions.channelId;
+
+        // Adds the storage location of the channel's data
+        finalResult.meta.transactionsStorageLocation[id] =
+          channelIdAndTransactions.transactionsWithMeta.meta.transactionsStorageLocation;
+
+        // Adds the meta of the channel
+        finalResult.meta.storageMeta[id] =
+          channelIdAndTransactions.transactionsWithMeta.meta.storageMeta;
+
+        // Adds the transaction of the channel
+        finalResult.result.transactions[id] =
+          channelIdAndTransactions.transactionsWithMeta.result.transactions;
+
+        return finalResult;
+      },
+      {
+        meta: {
+          storageMeta: {},
+          transactionsStorageLocation: {},
+        },
+        result: { transactions: {} },
+      },
+    );
+  }
+
   /**
    * Function to synchronize with the new dataIds on the storage
    */

packages/data-access/src/location-by-topic.ts

@@ -1,12 +1,6 @@
 import { DataAccess as DataAccessTypes } from '@requestnetwork/types';
 import Utils from '@requestnetwork/utils';
 
-// Interface of the object to store the storageLocation indexed by channel id
-// We use a Set data structure because dataIds are unique
-interface IStorageLocationByChannelId {
-  [key: string]: Set<string>;
-}
-
 // Interface of the object to store the channel ids indexed by topic
 interface IChannelIdByTopics {
   [key: string]: Set<string>;
@@ -20,7 +14,7 @@ export default class LocalLocationIndex {
    * Storage location by channel id
    * maps channelId => [storageLocation]
    */
-  private storageLocationByChannelId: IStorageLocationByChannelId = {};
+  private storageLocationByChannelId: DataAccessTypes.IStorageLocationByChannelId = {};
 
   /**
    * Channel Ids by topic
@@ -58,11 +52,11 @@ export default class LocalLocationIndex {
   }
 
   /**
-   * Function to get location from a topic
+   * Get locations from a topic
    *
    * @param topic topic to retrieve the dataId
    *
-   * @return list of the location connected to the topic
+   * @return list of the locations connected to the topic
    */
   public getStorageLocationFromTopic(topic: string): string[] {
     return Utils.unique(
@@ -72,6 +66,23 @@ export default class LocalLocationIndex {
     ).uniqueItems;
   }
 
+  /**
+   * Get locations from a topic grouped by channel id
+   *
+   * @param topic topic to retrieve the storage location from
+   *
+   * @return list of the locations connected to the topic
+   */
+  public getStorageLocationFromTopicGroupedByChannelId(topic: string): { [key: string]: string[] } {
+    return this.getChannelIdsFromTopic(topic).reduce(
+      (result: { [key: string]: string[] }, channelId: string) => {
+        result[channelId] = Array.from(this.getStorageLocationsFromChannelId(channelId));
+        return result;
+      },
+      {},
+    );
+  }
+
   /**
    * Function to get the channel ids from a topic
    *

packages/data-access/test/data-access.test.ts

@@ -402,6 +402,59 @@ describe('data-access', () => {
     });
   });
 
+  describe('getChannelByTopic', () => {
+    let dataAccess: any;
+
+    beforeEach(async () => {
+      const testTopics: Promise<StorageTypes.IGetDataIdReturn> = Promise.resolve(getDataIdResult);
+
+      const fakeStorage: StorageTypes.IStorage = {
+        append: chai.spy(),
+        getData: (): any => chai.spy(),
+        getDataId: (): any => testTopics,
+        read: (param: string): any => {
+          const dataIdBlock2txFake: StorageTypes.IOneContentAndMeta = {
+            meta: { timestamp: 10 },
+            result: { content: JSON.stringify(blockWith2tx) },
+          };
+          const result: any = {
+            dataIdBlock2tx: dataIdBlock2txFake,
+          };
+          return result[param];
+        },
+      };
+
+      dataAccess = new DataAccess(fakeStorage);
+      await dataAccess.initialize();
+    });
+
+    it('can getChannelByTopic() with boundaries', async () => {
+      expect(
+        await dataAccess.getChannelsByTopic(arbitraryTopic1, { from: 9, to: 100 }),
+        'result with arbitraryTopic1 wrong',
+      ).to.deep.equal({
+        meta: {
+          storageMeta: { [arbitraryId1]: [{ timestamp: 10 }] },
+          transactionsStorageLocation: { [arbitraryId1]: ['dataIdBlock2tx'] },
+        },
+        result: { transactions: { [arbitraryId1]: [transactionMock1] } },
+      });
+    });
+
+    it('can getChannelByTopic() with boundaries too restrictive', async () => {
+      expect(
+        await dataAccess.getChannelsByTopic(arbitraryTopic1, { from: 11, to: 100 }),
+        'result with arbitraryTopic1 wrong',
+      ).to.deep.equal({
+        meta: {
+          storageMeta: {},
+          transactionsStorageLocation: {},
+        },
+        result: { transactions: {} },
+      });
+    });
+  });
+
   describe('persistTransaction', () => {
     it('can persistTransaction()', async () => {
       const fakeStorageSpied: StorageTypes.IStorage = {

packages/request-client.js/src/http-data-access.ts

@@ -61,14 +61,16 @@ export default class HttpDataAccess implements DataAccessTypes.IDataAccess {
    * Gets the transactions for a topic from the node through HTTP.
    *
    * @param topic The topic to search for
+   * @param timestampBoundaries filter timestamp boundaries
    */
   public async getTransactionsByTopic(
     topic: string,
+    timestampBoundaries?: DataAccessTypes.ITimestampBoundaries,
   ): Promise<DataAccessTypes.IReturnGetTransactions> {
     const { data } = await axios.get(
       '/getTransactionsByTopic',
       Object.assign(this.axiosConfig, {
-        params: { topic },
+        params: { topic, timestampBoundaries },
       }),
     );
     return data;
@@ -78,14 +80,35 @@ export default class HttpDataAccess implements DataAccessTypes.IDataAccess {
    * Gets the transactions for a channel from the node through HTTP.
    *
    * @param channelId The channel id to search for
+   * @param timestampBoundaries filter timestamp boundaries
    */
   public async getTransactionsByChannelId(
     channelId: string,
+    timestampBoundaries?: DataAccessTypes.ITimestampBoundaries,
   ): Promise<DataAccessTypes.IReturnGetTransactions> {
     const { data } = await axios.get(
       '/getTransactionsByChannelId',
       Object.assign(this.axiosConfig, {
-        params: { channelId },
+        params: { channelId, timestampBoundaries },
+      }),
+    );
+    return data;
+  }
+
+  /**
+   * Gets all the transactions of channel indexed by topic from the node through HTTP.
+   *
+   * @param topic topic to search for
+   * @param updatedBetween filter timestamp boundaries
+   */
+  public async getChannelsByTopic(
+    topic: string,
+    updatedBetween?: DataAccessTypes.ITimestampBoundaries,
+  ): Promise<DataAccessTypes.IReturnGetChannelsByTopic> {
+    const { data } = await axios.get(
+      '/getChannelsByTopic',
+      Object.assign(this.axiosConfig, {
+        params: { topic, updatedBetween },
       }),
     );
     return data;

packages/request-client.js/test/api/request-network.test.ts

@@ -10,6 +10,9 @@ import Request from '../../src/api/request';
 import * as TestData from '../data-test';
 
 const mockDataAccess: DataAccessTypes.IDataAccess = {
+  async getChannelsByTopic(): Promise<any> {
+    return;
+  },
   async getTransactionsByChannelId(): Promise<any> {
     return;
   },
@@ -37,6 +40,9 @@ describe('api/request-network', () => {
   describe('createRequest', () => {
     it('cannot createRequest() with extensionsData', async () => {
       const mockDataAccessWithTxs: DataAccessTypes.IDataAccess = {
+        async getChannelsByTopic(): Promise<any> {
+          return;
+        },
         async getTransactionsByChannelId(): Promise<any> {
           return;
         },
@@ -73,6 +79,9 @@ describe('api/request-network', () => {
   describe('fromRequestId', () => {
     it('can get request with payment network fromRequestId', async () => {
       const mockDataAccessWithTxs: DataAccessTypes.IDataAccess = {
+        async getChannelsByTopic(): Promise<any> {
+          return;
+        },
         async getTransactionsByChannelId(): Promise<any> {
           return {
             result: { transactions: [{ data: JSON.stringify(TestData.action) }] },
@@ -99,6 +108,9 @@ describe('api/request-network', () => {
   describe('fromIdentity', () => {
     it('can get requests with payment network fromIdentity', async () => {
       const mockDataAccessWithTxs: DataAccessTypes.IDataAccess = {
+        async getChannelsByTopic(): Promise<any> {
+          return;
+        },
         async getTransactionsByChannelId(channelId: string): Promise<any> {
           let transactions: any[] = [];
           if (channelId === TestData.actionRequestId) {

packages/request-logic/test/index.test.ts

@@ -43,6 +43,7 @@ const fakeMetaTransactionManager = {
   result: { topics: [fakeTxHash] },
 };
 const fakeTransactionManager: TransactionTypes.ITransactionManager = {
+  getChannelsByTopic: chai.spy(),
   getTransactionsByChannelId: chai.spy(),
   getTransactionsByTopic: chai.spy(),
   persistTransaction: chai.spy.returns(fakeMetaTransactionManager),
@@ -382,6 +383,7 @@ describe('index', () => {
       });
 
       const fakeTransactionManagerGet: TransactionTypes.ITransactionManager = {
+        getChannelsByTopic: chai.spy(),
         getTransactionsByChannelId: (): Promise<TransactionTypes.IReturnGetTransactions> =>
           listActions,
         getTransactionsByTopic: chai.spy(),
@@ -519,6 +521,7 @@ describe('index', () => {
       });
 
       const fakeTransactionManagerGet: TransactionTypes.ITransactionManager = {
+        getChannelsByTopic: chai.spy(),
         getTransactionsByChannelId: (): Promise<TransactionTypes.IReturnGetTransactions> =>
           listActions,
         getTransactionsByTopic: chai.spy(),
@@ -657,6 +660,7 @@ describe('index', () => {
       });
 
       const fakeTransactionManagerGet: TransactionTypes.ITransactionManager = {
+        getChannelsByTopic: chai.spy(),
         getTransactionsByChannelId: (): Promise<TransactionTypes.IReturnGetTransactions> =>
           listActions,
         getTransactionsByTopic: chai.spy(),
@@ -739,6 +743,7 @@ describe('index', () => {
       });
 
       const fakeTransactionManagerGet: TransactionTypes.ITransactionManager = {
+        getChannelsByTopic: chai.spy(),
         getTransactionsByChannelId: (): Promise<TransactionTypes.IReturnGetTransactions> =>
           listActions,
         getTransactionsByTopic: chai.spy(),
@@ -782,6 +787,7 @@ describe('index', () => {
       });
 
       const fakeTransactionManagerGet: TransactionTypes.ITransactionManager = {
+        getChannelsByTopic: chai.spy(),
         getTransactionsByChannelId: (): Promise<TransactionTypes.IReturnGetTransactions> =>
           listActions,
         getTransactionsByTopic: chai.spy(),
@@ -969,6 +975,7 @@ describe('index', () => {
       });
 
       const fakeTransactionManagerGet: TransactionTypes.ITransactionManager = {
+        getChannelsByTopic: chai.spy(),
         getTransactionsByChannelId: (
           topic: string,
         ): Promise<TransactionTypes.IReturnGetTransactions> => {
@@ -1055,6 +1062,7 @@ describe('index', () => {
       });
 
       const fakeTransactionManagerGet: TransactionTypes.ITransactionManager = {
+        getChannelsByTopic: chai.spy(),
         getTransactionsByChannelId: (
           topic: string,
         ): Promise<TransactionTypes.IReturnGetTransactions> => {