Resolve conflicts, pr comments (#90)

Author: vponline

README.md

@@ -185,6 +185,10 @@ The batch size of active dAPIs that are to be fetched in a single RPC call.
 
 The fetch interval in seconds between retrievals of signed API data.
 
+#### `signedApiUrls`
+
+A list of signed API URLs to call along with URLs fetched from the chain.
+
 ## Docker
 
 ### Build

config/airseeker.example.json

@@ -23,5 +23,6 @@
     }
   },
   "deviationThresholdCoefficient": 1,
-  "signedDataFetchInterval": 10
+  "signedDataFetchInterval": 10,
+  "signedApiUrls": []
 }

jest-e2e.config.js

@@ -9,6 +9,7 @@ module.exports = {
   collectCoverage: false, // It doesn't make sense to collect coverage for e2e tests because they target high level features and interaction with other services.
   maxWorkers: 1, // We don't want to run tests in parallel because they might interfere with each other. This option is the same as --runInBand. See: https://stackoverflow.com/a/46489246.
 
+  mockReset: true,
   preset: 'ts-jest',
   restoreMocks: true,
   setupFiles: [join(__dirname, './jest.setup.js')],

jest-unit.config.js

@@ -11,6 +11,7 @@ module.exports = {
   coveragePathIgnorePatterns: ['node_modules', '<rootDir>/src/typechain-types'], // Coverage is collected for all files imported by the tests. We want to exclude files generated by Typechain.
   coverageProvider: 'v8',
 
+  mockReset: true,
   preset: 'ts-jest',
   restoreMocks: true,
   setupFiles: [join(__dirname, './jest.setup.js')],

local-test-configuration/airseeker/airseeker.example.json

@@ -23,5 +23,6 @@
     }
   },
   "deviationThresholdCoefficient": 1,
-  "signedDataFetchInterval": 10
+  "signedDataFetchInterval": 10,
+  "signedApiUrls": []
 }

src/config/schema.ts

@@ -141,6 +141,7 @@ export const configSchema = z
     chains: chainsSchema,
     signedDataFetchInterval: z.number().positive(),
     deviationThresholdCoefficient: deviationThresholdCoefficientSchema,
+    signedApiUrls: z.array(z.string().url()),
   })
   .strict();
 

src/signed-api-fetch/data-fetcher.test.ts

@@ -4,13 +4,14 @@ import { initializeState } from '../../test/fixtures/mock-config';
 import * as localDataStore from '../signed-data-store';
 import { updateState } from '../state';
 
-import { runDataFetcher, stopDataFetcher } from './data-fetcher';
+import * as dataFetcherModule from './data-fetcher';
 
 const mockedAxios = axios as jest.MockedFunction<typeof axios>;
 jest.mock('axios');
 
 describe('data fetcher', () => {
   beforeEach(() => {
+    jest.resetAllMocks();
     initializeState();
     localDataStore.clear();
     updateState((draft) => {
@@ -63,13 +64,28 @@ describe('data fetcher', () => {
       })
     );
 
-    const dataFetcherPromise = runDataFetcher();
-
+    const dataFetcherPromise = dataFetcherModule.runDataFetcher();
     await expect(dataFetcherPromise).resolves.toBeDefined();
-
-    stopDataFetcher();
+    dataFetcherModule.stopDataFetcher();
 
     expect(mockedAxios).toHaveBeenCalledTimes(1);
     expect(setStoreDataPointSpy).toHaveBeenCalledTimes(3);
   });
+
+  it('calls signed api urls from config', async () => {
+    jest.spyOn(dataFetcherModule, 'callSignedDataApi');
+
+    const signedApiUrl = 'http://some.url/0xbF3137b0a7574563a23a8fC8badC6537F98197CC';
+    updateState((draft) => {
+      draft.config.signedApiUrls = [signedApiUrl];
+    });
+
+    const dataFetcherPromise = dataFetcherModule.runDataFetcher();
+
+    await expect(dataFetcherPromise).resolves.toBeDefined();
+    dataFetcherModule.stopDataFetcher();
+
+    expect(mockedAxios).toHaveBeenCalledTimes(2);
+    expect(dataFetcherModule.callSignedDataApi).toHaveBeenCalledWith(signedApiUrl);
+  });
 });

src/signed-api-fetch/data-fetcher.ts

@@ -36,10 +36,10 @@ export const stopDataFetcher = () => {
 };
 
 /**
- * Calls a remote signed data URL and inserts the result into the datastore
+ * Calls a remote signed data URL.
  * @param url
  */
-const callSignedDataApi = async (url: string): Promise<SignedData[] | null> => {
+export const callSignedDataApi = async (url: string): Promise<SignedData[] | null> => {
   const goAxiosCall = await go<Promise<AxiosResponse>, AxiosError>(
     async () =>
       axios({
@@ -72,7 +72,7 @@ export const runDataFetcher = async () => {
     logger.debug('Running data fetcher');
     const state = getState();
     const {
-      config: { signedDataFetchInterval },
+      config: { signedDataFetchInterval, signedApiUrls },
       signedApiUrlStore,
       dataFetcherInterval,
     } = state;
@@ -86,12 +86,13 @@ export const runDataFetcher = async () => {
       });
     }
 
-    const urls = uniq(
-      Object.values(signedApiUrlStore)
+    const urls = uniq([
+      ...Object.values(signedApiUrlStore)
         .flatMap((urlsPerProvider) => Object.values(urlsPerProvider))
         .flatMap((urlsPerAirnode) => Object.values(urlsPerAirnode))
-        .flat()
-    );
+        .flat(),
+      ...signedApiUrls,
+    ]);
 
     logger.debug('Fetching data from signed APIs', { urls });
     return Promise.all(

test/fixtures/mock-config.ts

@@ -25,6 +25,7 @@ export const generateTestConfig = (): Config => ({
   },
   signedDataFetchInterval: 10,
   deviationThresholdCoefficient: 1,
+  signedApiUrls: [],
 });
 
 export const initializeState = (config: Config = generateTestConfig()) => setInitialState(config);