add additional type information and remove redis and psql (dydxinterviews#2)

Author: samweinberg23

Diff for: Dockerfile

@@ -1,6 +1,7 @@
 <p align='center'><img src='https://dydx.exchange/logo.svg' width='256' /></p>
 
 The goal of this repository is to verify that your development environment is set up to start working on code at dYdX. Successfully running the tests in this repo confirms that your environment is close to or completely set up to work with dYdX repositories.
+We also provide examples of common Typescript types you will encounter at dYdX in `src/types`. These objects are then used and tested in `__tests__/basicFlowTests`.
 
 ## Git
 Clone the repository with one of the following
@@ -47,16 +48,11 @@ Set your node version to 12. NVM is a good tool for managing your node version.
 
 ```nvm use 12```
 
-## Docker
-
-We use docker locally to support running tests against a realistic environment, with (e.g.) postgres and redis running in dockerized containers. You’ll need to [download](https://www.docker.com/get-started) and start docker locally, as well as install [docker-compose](https://docs.docker.com/compose/install).
-
 ## Running Tests
 
 * Run all commands from the root directory of the repository.
 * In one terminal run `npm run compile:watch`. This will allow for continual building as you make changes to files.
-* In a second terminal run `docker-compose up`. This will bring up an instance of redis, postgres and kafka locally to be used in tests.
-* In a third terminal run your tests with `npm run test`. You can add a test filename as an optional argument if you don’t want to run the whole test suite. This command pattern matches for all files with .test.ts so you don’t need to include the entire path, for example `npm test -- __tests__/basicFlowTests`.
+* In a second terminal run your tests with `npm run test`. You can add a test filename as an optional argument if you don’t want to run the whole test suite. This command pattern matches for all files with .test.ts so you don’t need to include the entire path, for example `npm test -- __tests__/basicFlowTests`.
 
 ## Additional Links
 

Diff for: README.md

@@ -1,25 +1,31 @@
-import { knexPrimary } from '../src/db/knexfile';
-import { createRedisClient, getAsync, setAsync } from '../src/db/redis';
-
-const res = createRedisClient('redis://localhost:6382', 500);
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const redis: any = res?.client;
-export const connect = res?.connect;
+import { Market, MarketInformation } from '../src/types';
 
 describe('tests', () => {
-  it('test postgres connection', async () => {
-    const queryDB = await knexPrimary.raw('select * from pg_indexes');
-    expect(queryDB).not.toEqual(null);
-  });
+  it('basic test', async () => {
+    const btcInformation: MarketInformation = {
+      market: Market.BTC_USD,
+      creationDate: ' 2021-12-17T23:00:00.000Z',
+      exchangePrices: {
+        coinbase: {
+          lastPrice: 49000,
+          marketId: '1',
+        },
+        ftx: {
+          lastPrice: 49800,
+          marketId: '2',
+        },
+      },
+    };
 
-  it('test redis', async () => {
-    await setAsync({
-      key: 'key',
-      value: 'value',
-    }, redis);
+    expect(btcInformation.market).toEqual(Market.BTC_USD);
+    expect(btcInformation.exchangePrices.coinbase.lastPrice).toEqual(49000);
 
-    const val: string | null = await getAsync('key', redis);
-    expect(val).toEqual('value');
+    // iterating over the keys of the exchangePrices
+    Object.keys(btcInformation.exchangePrices).forEach((exchange: string) => {
+      expect([
+        'coinbase',
+        'ftx',
+      ].includes(exchange));
+    });
   });
 });

Diff for: __tests__/basicFlowTests.test.ts

@@ -1,2 +1,21 @@
-// Use the base configuration as-is.
-module.exports = require('./node_modules/@dydxprotocol/node-service-base-dev/jest.config.js');
+module.exports = {
+  roots: [
+    '<rootDir>/__tests__',
+  ],
+  transform: {
+    '^.+\\.ts$': 'ts-jest',
+  },
+  testRegex: '__tests__\\/.*\\.test\\.ts$',
+  moduleFileExtensions: [
+    'ts',
+    'js',
+    'json',
+    'node',
+  ],
+  globalSetup: './jest.globalSetup.js',
+  resetMocks: true,
+  setupFilesAfterEnv: ['./jest.setup.js'],
+  testEnvironment: 'node',
+  testPathIgnorePatterns: ['/node_modules/', '/__tests__/helpers/'],
+  testTimeout: 5000,
+};

Diff for: docker-compose.yml

@@ -1,5 +1,5 @@
 // This function runs once before all tests.
 module.exports = () => {
-  // eslint-disable-next-line
-  require('dotenv-flow').config();
+  // eslint-disable-next-line global-require
+  require('dotenv-flow/config');
 };