vatger / datafeed-cache

The Datafeed Cache project is a wrapper around VATSIM's Datafeed service which provides basic caching functionality as well as failure detection

Datafeed Cache

The Datafeed Cache project is a wrapper around VATSIM's Datafeed service which provides basic caching functionality as well as failure detection. Every response includes an extra flag failed which indicates whether the last update made by the server was successful, or whether the datafeed failed to update. If failed is true, then the previously cached datafeed is returned as the response in data.

The API Documentation can be found in the wiki.

If you wish to contribute and/or make changes, please check out our contribution guide here.

Contact

Name	Responsible for	Contact
Nikolas G. - 1373921	*	git[at]vatger.de

Prerequisites

• Node.js (https://nodejs.org/en)
• Typescript (Optional)
  • Typescript is included in the project's dependencies, can however be installed globally using npm install -g typescript. This may however not be necessary in your situation and is more of a recommendation rather than a requirement.

Running the Application

Using Node.js

Assuming node.js is installed, running the application (locally) should be as simple as executing the following two commands.

1. Run npm install
2. Run npm run start:dev

Using Docker

Using the included docker-compose.yml you should simply be able to build and run the application. The included compose file exposes port 8000 on the host by default, however can be configured at will to fit any deployment scheme.

datafeed-cache's Issues

Mark DF as failed if timestamps don't differ

Currently, the cache only marks the datafeed as "failed", if there has been a rapid decrease in pilots, or the request to VATSIM's API failed outright.
Add a check to verify that the last timestamp of the datafeed is different to the current one. To allow for some discrepancy, we should trigger this at around a minute or two. I.e. if the current time is >= 120secs off the last update_timestamp, then mark the DF as "failed".