Maltiize/TA_GQL

TheFork backend test

Notes to the fork

To complete the project, I added a redis instance, and a little gihub workflow to run my tests.

One other possible improvement would be to also create an image after each commit and send it to a repository manager

Maybe also handling the config with a .env file instead of having it inside the repo within a hard coded file.

anyway, have a good read and a nice day :)

Goal

Creation of a graphql API in NodeJS.

Context

The purpose of this project is to create a simple graphQL API in charge of exposing Restaurant information fetched from an external service (image-service) and from a local database.

Infrastructure

Infrastructure is available in the docker-compose file and composed as follow:

• a NodeJs GraphQL micro-service (restaurant-service) You can use the playground to test it http://localhost:3000/graphql
• a PostgreSQL database
• a REST micro-service (image-service)

Database

Database tables are created through migrations and the database is populated with test data through seeds (you don't need to modify migrations and seed directories)

• restaurant (restaurant_uuid, name, country_code)
• restaurant_has_images (restaurant_uuid, image_uuid)
• country (country_code, locales) - (locales is an psql array of texts)

Image service (DO NOT EDIT THIS PROJECT)

This service is exposing 2 endpoints:

• GET /images returning all images (no filter)

Expected response:

{
    "images": [
        {
            "imageUuid": "imageUuid",
            "url": "url"
        }
    ]
}

Important information:

• This endpoint must NOT be modified (even if it's badly designed)
• This project has no database. Data are persisted in memory only. Every server restart will reset everything.

TO DO

Create a graphQL query

Create a graphQL query returning restaurant information.

Response must be paginated (set a default value if none is provided) and optionnaly filtered by:

• the restaurant name
• with images only (i.e. return only restaurants having images. By default, all restaurants are returned)

Expected response:

{
  "restaurants": [
      {
          "restaurantUuid": "restaurantUuid",
          "name": "name",
          "country": {
              "code": "code",
              "locales": ["fr_FR"]
          },
          "images": [ "http://image.url" ],
          "allowReview": true
      }
  ],
  "pagination": {
      "total": 1,
      "pageCount": 1,
      "currentPage": 1
  }
}

Additional information

• This project is initialized with a basic config. You must keep this stack but feel free to improve the project structure if you see any improvement
• Please produce code with what is for you production quality standards as if you'll have to maintain codebase during the next coming years
• To provide discussion material for technical interview, you can list any optimizations that you don't have time to implement but consider important