[3.x] HTTP API healthcheck #413

rennokki · 2021-03-04T14:22:45Z

The concept of having an API for the bot can ease multiple tasks:

~~sending commands to the bot via HTTP (opens up new ways of implementing SDKs for tf2autobot, implementable in any language since it's REST)~~
~~reading information about the BOT, including current item configurations for trading~~
periodic healthchecks performed on the bot via HTTP endpoint (useful for Docker/Kubernetes, but not limited to)

Roadmap

Base implementation, /health endpoint for checking readiness/aliveness
Uptime endpoint for reading the current uptime status
~~Configured items/bots endpoint for reading the configured items and bots~~
~~Tests, lots of tests~~

The GUI v3 rework already has an entrypoint for the API, so sticking just with healthchecks and uptime should be fine. 👍🏼

idinium96 · 2021-03-04T14:29:23Z

Love the idea. I will let the others share their thoughts too.

arik123 · 2021-03-04T15:03:17Z

I'm working on something simular - but I'm using mode-IPC for it, is gonna be used for GUI

rennokki · 2021-03-04T16:06:57Z

Discussed with @arik123 earlier on Discord about IPC and the need of having an API server on a bot. The main points were:

Having a bot running is not going to start the second one since the API is already running on the specified port. This isn't an issue on Docker or any other distributed system since the API is isolated from external networking, and will only be accessible at their respective container names.
The GUI is on its way and will act as a master for all bot processes. This is an excellent idea because it doesn't expose the bot on the network and the other functionalities on this PR are redundant, so I put a strike on them on the roadmap.

The only left issue is the healthcheck functionality. The healthcheck can pass/fail if I either:

call an URL present on the process (200 = pass, non-200 = fail)
ping a TCP socket (established = pass, rejected = fail)
execute a command (exit code zero = pass, exit code non-zero = fail)

I was looking for the TCP or the command execs for healthchecks, but I'm not sure which one to pick or how we can acheive this. The HTTP /health check is still good, but it doesn't work for simple processes, outside Docker/Kubernetes, excepting if a different port is set for each one.

idinium96 · 2021-03-04T16:22:03Z

Thanks for the update. You may keep this pull request open so every progress/discussion can be seen here.
This may sound weird but a built-in GUI (not enabled by default) might be good, but not sure if that will use a lot of resources.

arik123 · 2021-03-04T16:27:47Z

it could be probably implemented such that, it would take near to nothing if not enabled, but then the whole part of GUI that I have planned - Managment of multiple bots would not work

idinium96 · 2021-03-04T16:33:07Z

it could be probably implemented such that, it would take near to nothing if not enabled, but then the whole part of GUI that I have planned - Managment of multiple bots would not work

Oh right true. in that case, probably best to make the GUI a separate app.

rennokki · 2021-03-04T16:56:08Z

Maybe the API can still exist (and be disabled by default) for non-GUI-based applications, like managing your own bots?

idinium96 · 2021-03-04T17:01:53Z

Maybe the API can still exist (and be disabled by default) for non-GUI-based applications, like managing your own bots?

Yes, sure thing.

Added parser for numbers

src/app.ts

arik123

What about setting default port to something random, so there is smaller chance of collision with other programs.

arik123 · 2021-03-04T17:39:26Z

src/app.ts

@@ -4,6 +4,7 @@ const { version: BOT_VERSION } = require('../package.json');
 import { getPricer } from '@pricer/pricer';
 import Pricer, { GetPricerFn } from './classes/Pricer';
 import { loadOptions } from './classes/Options';
+import HttpManager from './classes/HttpManager';


What about importing only if enabled, to reduce memory usage slightly, but this is not that important

ES6 and TS don't allow importing with import from within classes.

I know, either use require or let it be like it is now

src/classes/HttpManager.ts

arik123 · 2021-03-04T17:44:32Z

Also maybe add some note to the source, that tells everyone about GUI as main API provider.

idinium96 · 2021-03-04T18:22:49Z

Now let say I want to use this and want to check my bot uptime via an API, and I am running my bot on a VPS, I need to type this on my browser URL:
http://<IP_ADDRESS>:<PORT>/uptime

right?

rennokki · 2021-03-04T18:34:16Z

@idinium96 Yes.

idinium96

roger that 👍

merging before going to bed...

@joekiller

#411 ## Added - Mainly if you're using generic Unusual buy order feature: - ✨option to not automatically add bought Unusual item to the pricelist (usual because buying with Generic Unusual buy order - #412, [Wiki](https://github.com/TF2Autobot/tf2autobot/wiki/Configure-your-options.json-file#--automatic-add-invalid-unusual--)) - @joekiller - new options added: - `pricelist.autoAddInvalidUnusual.enable` (default is `false`) - `sendAlert.receivedUnusualNotInPricelist` (default if `true`) - ✨HTTP API health check (and others in the future - #413, [Wiki](https://github.com/TF2Autobot/tf2autobot/wiki/Configuring-the-bot#api)) - @rennokki - new env variables: - `ENABLE_HTTP_API` (default is `false`) - `HTTP_API_PORT` (default is `3001`) - ✨option to show proper item name in trade/offer summary (with "The", no short - #415, [Wiki](https://github.com/TF2Autobot/tf2autobot/wiki/Configure-your-options.json-file#-trade-summary-settings-)) - @idinium96 - new options added: - `tradeSummary.showProperName` (default is `false`) ## Updates - Partial price update feature (updated #337): - ⛔ do not partial price Mann Co. Supply Crate Key (#407) - @idinium96 - ✅ add an option to exclude items for partial price update (#408, [Wiki](https://github.com/TF2Autobot/tf2autobot/wiki/Configure-your-options.json-file#--partial-price-update--)) - @idinium96 - new options.json property: `pricelist.partialPriceUpdate.excludeSKU` (default is `[]`) - 💅 include name in partial price update summary (#409) - @idinium96 - ⛔ do not perform usual update if grouped (#410) - @idinium96 - 🔨 refactor Bot.ts (#399) - @arik123 - 🔎🔑 keyPrices verification (2) and 🔨 small refactor on Pricelist.ts (#416) - @idinium96 - 🔕 ignore some error on fail action or to accept mobile confirmation (#419) - @idinium96 - 🔨 refactor: use Map and Set (#420) - @idinium96 - 🎨 show amount offering/offered/taking/taken in overstocked/understocked review/trade summary (#421) - @idinium96

rennokki added 2 commits March 4, 2021 16:21

Implemented HttpManager for Express.js

8b33c51

⏲ Uptime endpoint

600d500

rennokki changed the title ~~[3.x] HTTP API server~~ [3.x] HTTP API healthcheck Mar 4, 2021

rennokki and others added 4 commits March 4, 2021 19:15

Added ENABLE_HTTP_API and HTTP_API_PORT for the API

a4098b4

Fixed default port number

6e8a307

Added parser for numbers

🔄 reposition env variables

53e96ec

end of file

74c1f5b

rennokki requested review from idinium96 and arik123 and removed request for idinium96 March 4, 2021 17:27

rennokki marked this pull request as ready for review March 4, 2021 17:27

rennokki marked this pull request as draft March 4, 2021 17:28

idinium96 reviewed Mar 4, 2021

View reviewed changes

src/app.ts Outdated Show resolved Hide resolved

rennokki added 2 commits March 4, 2021 19:35

Reverted uptime changes

5ce6234

Conditionally initialize & run the API

6a67423

rennokki marked this pull request as ready for review March 4, 2021 17:39

rennokki requested a review from idinium96 March 4, 2021 17:39

arik123 reviewed Mar 4, 2021

View reviewed changes

rennokki added 3 commits March 4, 2021 19:45

Removed server member.

81504bd

Setting default port to 3001

1251430

Setting default 3001 on the options

d2e09a3

rennokki added 2 commits March 4, 2021 19:53

Added info when starting the HTTP server.

94d8048

Resolve after log.

8b84c98

rennokki requested a review from arik123 March 4, 2021 17:55

arik123 approved these changes Mar 4, 2021

View reviewed changes

idinium96 approved these changes Mar 4, 2021

View reviewed changes

idinium96 merged commit 41b7558 into development Mar 4, 2021

idinium96 mentioned this pull request Mar 4, 2021

prepare v3.6.0 #411

Merged

rennokki deleted the feature/api branch March 4, 2021 19:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[3.x] HTTP API healthcheck #413

[3.x] HTTP API healthcheck #413

rennokki commented Mar 4, 2021 •

edited

idinium96 commented Mar 4, 2021

arik123 commented Mar 4, 2021

rennokki commented Mar 4, 2021

idinium96 commented Mar 4, 2021

arik123 commented Mar 4, 2021 •

edited

idinium96 commented Mar 4, 2021

rennokki commented Mar 4, 2021

idinium96 commented Mar 4, 2021

arik123 left a comment

arik123 Mar 4, 2021

rennokki Mar 4, 2021

arik123 Mar 4, 2021

arik123 commented Mar 4, 2021

idinium96 commented Mar 4, 2021 •

edited

rennokki commented Mar 4, 2021

idinium96 left a comment

[3.x] HTTP API healthcheck #413

[3.x] HTTP API healthcheck #413

Conversation

rennokki commented Mar 4, 2021 • edited

Roadmap

idinium96 commented Mar 4, 2021

arik123 commented Mar 4, 2021

rennokki commented Mar 4, 2021

idinium96 commented Mar 4, 2021

arik123 commented Mar 4, 2021 • edited

idinium96 commented Mar 4, 2021

rennokki commented Mar 4, 2021

idinium96 commented Mar 4, 2021

arik123 left a comment

Choose a reason for hiding this comment

arik123 Mar 4, 2021

Choose a reason for hiding this comment

rennokki Mar 4, 2021

Choose a reason for hiding this comment

arik123 Mar 4, 2021

Choose a reason for hiding this comment

arik123 commented Mar 4, 2021

idinium96 commented Mar 4, 2021 • edited

rennokki commented Mar 4, 2021

idinium96 left a comment

Choose a reason for hiding this comment

rennokki commented Mar 4, 2021 •

edited

arik123 commented Mar 4, 2021 •

edited

idinium96 commented Mar 4, 2021 •

edited