Flights PowerUs 🛫

This repository hosts a service designed to retrieve flight information from various sources. The service consolidates flight data from these sources, eliminating duplicates in the process.

You can locate the routing for accessing flight data in flight.controller.ts, specifically under the GET /flights endpoint.

The FlightService encapsulates the logic responsible for fetching flight data and handling duplicate removal. In case any of the data providers used for fetching flights are unavailable, the service gracefully returns empty data for the affected provider.

Installation and running the app

$ npm install
$ npm run start

You can then curl localhost:3000/flights

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Unit tests are available for both the service and controller. Additionally, an end-to-end (e2e) test verifies the correctness of data retrieved from the specified URLs.

E2E tests

To run E2E we use a Wiremock server. You can create one using

docker run -it --rm \
  -p 8080:8080 \
  --name wiremock \
  wiremock/wiremock:3.5.2

Then you can run the e2e test using npm run test:e2e. The e2e tests will verify that the endpoint doesn't take longer than 1s.

Caching

Data obtained from the flight services will be cached in memory. This cache operates in-memory and will be cleared upon restart, necessitating the recaching of data. The Time-To-Live (TTL) for caching is set to 1 hour.

Configuration

The .env file contains three configurable parameters. You can specify new URLs from which to fetch data, adjust the cache TTL, and adjust the timeout according to your requirements.