evanshortiss / fh-health

Module to add a "health" endpoint to a nodeapp.

🖖 Hi! I'm Evan.

I work as a Developer Advocate at Neon. I live and work in Los Angeles 🇺🇸, but I was born and raised in Ireland 🇮🇪.

Seems like everyone has a fancy README on their profile these days, doesn't it? Here's my take on the trend; a README that automatically updates at ~0600 UTC every day to provide you with some insight into things I'm up to.

🎮 What I'm Playing

Here's an autogenerated list of games I've been playing recently, along with the respective percentage of trophies/achievements I've collected in that game.

Game	Platform	Achievements	Last Played
SHADOW OF THE COLOSSUS™	PS4	Unknown	This week
Rocket League®	PS4	57%	9/2023
Gran Turismo® 7	PS5	Unknown	9/2023
PUBG: BATTLEGROUNDS	PC	86%	9/2023
DREDGE	PS5	3%	8/2023
FINAL FANTASY XV	PS4	37%	8/2023
Rocket League	PC	28%	6/2023
The Witcher 3: Wild Hunt	PC	35%	6/2023
Red Dead Redemption 2	PC	10%	3/2023
Cyberpunk 2077	PC	26%	1/2023

👾 Retro Games We're Playing

These are the retro games that myself and my girlfriend have been playing. The data is scraped from my Raspberry Pi that's running RetroPie.

Game	Platform	Last Played
Tomb Raider	PSX	3/2023
Metal Gear Solid	PSX	3/2023
Tekken 3	PSX	3/2023
Snatcher	Sega CD	3/2023
Oddworld - Abe's Oddysee	PSX	2/2023
Harry Potter and the Sorcerer's Stone	PSX	2/2023
Sonic The Hedgehog 2.md	Sega Mega Drive	2/2023
Tenchu - Stealth Assassins	PSX	2/2023

⏰ Last updated: 2023-10-08T06:06:51.398Z

fh-health's Issues

Assign a timeout to runTests function

If a single test takes a large amount of time to complete the entire test case is affected by this and proxy timeout may cause the request to fail.

Need to implement a default timeout which will cancel any long running tests and force a response to be returned.

Exceptions within test callbacks cause unexpected behavior

I need to build a better test to be certain of the behaviour, but when you have multiple tests and one of them crashes it's possible for the health check function to call the callback and indicate that tests have completed while it's still running some of the tests. I think some sort of try/catch around the call to the test is needed, with exceptions resulting in test failures.

Track the time taken by each test item

Add timers to each test case and return the run time for each in it's response data.

{
"description": "Test connection to service X",
"test_status": "ok",
"result": "Received a response from X"
"time": "60ms"
}