Add health check endpoint(s) to support a public status page #132

benefacto · 2021-05-07T00:21:41Z

Closes #125

okjintao · 2021-05-15T04:33:27Z

This PR is worrying me a bit with the massive number of ABI being included. Lambda applications are not meant to have over 50mb zipped data so I will be interested to see the sizing impact this has. Also, there is already a section and naming convention for abi files (and all other files). Please try to keep in line with the set style for the repository.

benefacto · 2021-05-17T19:54:17Z

Hey @axejintao , thanks for the feedback on this. Allow to respond to your concerns individually:

Number of ABI being included: The number of the contracts that API-2: [feat. request]: Add health check endpoint(s) to support a public status page #125 is supposed to cover is quite large, so I'm definitely open to ideas on this whether it be pairing it back or breaking this new feature out into another API. Let me know if you have an alternative proposal so that we can keep this application at or under its recommended size.
Section and naming convention for abi files: I noticed that you have your ABIs present in the abi folder with a flat structure, an abi file name postfix, and the abis manually declared as TypeScript variables rather than using generated code like TypeChain does. I will rework the ABIs I'm adding to match the existing style and structure. Let me know if you would like me to otherwise do differently.

okjintao · 2021-05-17T20:50:08Z

i guess for my first point we would want to see how big it gets.
it could be fine and we don't need to worry or, as you suggest we could break it out into its own api i think that is reasonable.

I actually hadn't heard of type chain before but I will look into it. If we have space for it we way want to use it but again worried since we are already at 42mb i think. It is something i'll have to toy with. regardless, i think it doesn't hurt to continue implementation here and if we need to split it out then we can fork the repo and cut out the non health API pieces and dependencies.

.eslintrc.js

docs/health.md

src/chains/config/chain.config.ts

src/config/abi/health-bsc-abis.ts

src/config/abi/health-eth-abis.ts

src/health/health.config.ts

src/health/health.controller.ts

src/health/health.service.spec.ts

src/health/health.service.ts

src/health/health.config.ts

src/health/health.service.ts

src/indexer/sett-snapshots-indexer.spec.ts

src/protocols/pancake/pancakeswap.service.ts

src/setts/setts.controller.spec.ts

src/test/jest.setup.ts

okjintao

overall i've taken the time to understand the approach and i think it makes sense.
i think we will want to address some of the things i've brought up in these comments for the scope of this PR.
there will probably be follow up improvements possible here for reducing latency / costs via caching or something but that's out of scope for now.

src/health/health.controller.ts

src/health/health.service.spec.ts

src/health/health.service.ts

package.json

src/health/health.service.ts

okjintao · 2021-07-28T20:55:01Z

merged and rebased on a separate pr

benefacto self-assigned this May 7, 2021