cat_cafe/README.md

CI with SonarCloud

Cat Café

Table of Contents

• REST API
• WebSocket
• API type choices
• API Gateway

Global architecture

Concept

This application attempts to modelize a cat café, with cafés (called "bars" here), cats, and customers.

REST API

Those three entities can be persisted via a REST API. They can also be updated, queried, and removed.

We used an ASP .NET Web API, with a Swagger configuration to visualize the interface.

WebSocket

A WebSocket was set up to notify clients (who subscribe to it) whenever a Cat is POSTed.

Clients need to subscribe by typing the following code in the console of their browser, in developer mode :

new WebSocket("wss://localhost:5003/gateway/ws").onmessage = function (event) {
  if (event.data === "entity-created") {
    alert("A new entity was created!");
  }
};

Note:

• while the app uses port 7229 in our default config, you should use port 5003 anyway to subscribe to our WebSocket through our API Gateway
• "entity-created" is a hard-coded event ID and should not be changed.
• you are free to change the content of the Alert itself, of course

API type choices

REST API

REST APIs are scalable, standardized, loosely coupled with clients, stateless, and flexible.

Indeed, they can can easily handle multiple requests simultaneously, making them scalable for applications with increasing demands. They use standard HTTP methods and return data in a format (JSON, XML, YAML, etc.) that can be easily consumed by a wide range of clients, including mobiles.

Besides, they can easily be cached and optimized for performance.

WebSocket

WebSockets provide real-time bi-directionnal communication, which is very useful for gaming, chat applications, or setting up notifications. Said communication is not only bi-directionnal, but also full-duplex: clients and servers can send and receive data simultaneously.

Since the connection is opened once and closed once, we avoid any performance loss linked to opening and closing a connection for each request-response cycle. Similarly, a server that uses a websocket can reduce its load, because it is now pushing updates directly instead of being polled regularly by many clients.

API Gateway

An Ocelot API Gateway manages the whole system.

It can be started using Visual Studio if you first right-click the cat-cafe.sln Solution, and go to Properties.

Then set all relevant projects' "Action" to "Start", and they will all be launched simultaneously.

Now you can click "Start" to launch the "Multiple Startup Project".

And observe the API gateway in action.

Overall, the architecture may be summed up like so:

Ports

What	Where
REST API	https://localhost/7229
API Gateway	https://localhost/5003
WebSocket	...

Routes

The Gateway routes offer access to the REST API in a similar way as the REST API itself, with a small transformation: there is a new port, and the word "gateway" replaces "api". The REST API's Swagger UI will give you all the information required about those routes.

REST(old)	Gateway(current)
GET on https://localhost/7229/api/cats	GET on https://localhost/5003/gateway/cats
POST on https://localhost/7229/api/bars/{id}	GET on https://localhost/5003/gateway/bars/{id}

...and for the websocket:

• old :

new WebSocket("wss://localhost:7229/ws").onmessage = function (event) {...};

• new :

new WebSocket("wss://localhost:5003/gateway/ws").onmessage = function (event) {...};

Caching

The gateway uses caching to ensure that the entire list of customers is only queried from the database once every 10 seconds. The rest of the time, clients sending GET-all requests get served the contents of a cache.

    ...
    {
      "UpstreamPathTemplate": "/gateway/customers",
      "UpstreamHttpMethod": [ "Get" ],
      "DownstreamPathTemplate": "/api/customers",
      "DownstreamScheme": "https",
      "DownstreamHostAndPorts": [
        {
          "Host": "localhost",
          "Port": 7229
        }
      ],
      "FileCacheOptions": {
        "TtlSeconds": 10
      }
    } ...

Rate Limiting

The gateway uses rate limiting to make sure that clients cannot send an all-inclusive GET on cats or on bars more than once per second.

...
    {
      "UpstreamPathTemplate": "/gateway/bars",
      "UpstreamHttpMethod": [ "Get" ],
      "DownstreamPathTemplate": "/api/bars",
      "DownstreamScheme": "https",
      "DownstreamHostAndPorts": [
        {
          "Host": "localhost",
          "Port": 7229
        }
      ],
      "RateLimitOptions": {
        "EnableRateLimiting": true,
        "Period": "1s",
        "PeriodTimespan": 1,
        "Limit": 1
      }
    } ...

---

To contribute (workflow)

We are using the feature branch workflow (details here, or see the summary below)

1 - Sync with the remote

Make sure you're working with the latest version of the project

git checkout master
git fetch origin 
git reset --hard origin/master

2 - Create a new branch

Give your new branch a name referring to an issue (or maybe a group of similar issues)

git checkout -b branch-name-that-describes-the-new-feature

Regularly, you might want to get all the new code from your master branch (yeah, we forgot to rename it "main", sorry), to work with an up-to-date codebase:

git pull --rebase origin master

3 - Code

🔥🧑‍💻🐛🔥............✅

4 - Save your changes to your new branch

For a refresher, see details about add, commit, push, etc. here

It should involve creating a corresponding feature branch on the remote repository

git push -u origin branch-name-that-describes-the-new-feature

5 - Create a Pull Request

On the repository's main page, or on your new branch's master page, look for a New Pull Request button.

It should then allow you to merge into: ...:master and pull from: ...:new-feature

Follow the platform's instructions, until you've made a "work in progress" (WIP) pull request. You can now assign reviewers among your colleagues. They will get familiar with your new code -- and will either accept the branch as it is, or help you arrange it.