Skip to content

Latest commit

 

History

History
148 lines (102 loc) · 6.57 KB

README.md

File metadata and controls

148 lines (102 loc) · 6.57 KB
Raw

Server

This folder contains the main backend server for NavigaTUM.

Getting started

Prerequisites

For getting started, there are some system dependencies which you will need. Please follow the system dependencies docs before trying to run this part of our project.

Additional dependency

We have a few API endpoints which require additional dependencies.

As a general rule of thumb, if you probably want to skip the tileserver, but need to do the SQLite Database and MeiliSearch setup. The reason for this is, that the preview endpoint is the only endpoint, which requires the tileserver and said endpoint is a non-essential part of the project.

How to Set up the Databases

At the beginning of the main API we set up both meilisearch and the database. This will ensure that the sqlite database and meilisearch index is created.

This requires meilisearch to be online. To set up MeiliSearch, either follow their installation instructions or use

docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest

MeiliSearch provides an interactive interface at http://localhost:7700.

To set up the Postgis, run the following command:

docker run -it --rm -e POSTGRES_PASSWORD=CHANGE_ME -p 5432:5432 postgis/postgis:latest

Starting the server

Run cargo run to start the server. The server should now be available on localhost:8080 if you have configured the correct environment.

Note

cargo run --release is used to start the server for an optimised production build (use this if you want to profile the search or preview functions, it makes quite a difference).

Environment Variables

variable module usage/description
POSTGRES_{USER,PASSWORD,URL,DB} all required Used to connect to the db
GIT_COMMIT_SHA main optional Shown in the status endpint (also set at build time in docker)
LOG_LEVEL main optional Controlls what is being logged (default=info in release and debug in development mode)
GITHUB_TOKEN feedback A GitHub token with write access to repo.
This is used to create issues/PRs on the repository.
JWT_KEY feedback A key used to sign JWTs.
This is used to authenticate that feedback tokens were given out by us.
MIELI_{URL,MASTER_KEY} search Allows searching via meiliserch
CDN_URL setup required
can be skipped via flags		 Source of truth of the data

Adding Migrations

For the database-connector we use sqlx. Migrations can be run with the sqlx-cli tool. Said tool can be installed with:

cargo install sqlx-cli

Migrations can be added using

cargo sqlx migrate add -r <migration-name>

Adding/editing database queries

To get compiletime guarantees for our queries, we use sqlx. To add/edit a query, you will need to run the following command:

cargo sqlx migrate run --database-url postgres://postgres:CHANGE_ME@localhost:5432/postgres
cargo sqlx prepare --database-url postgres://postgres:CHANGE_ME@localhost:5432/postgres

How to Set up the tileserver (needed for the preview endpoint)

To set up your tileserver, head over to the map folder and follow the instructions there.

API-Changes

Editing

If you have made changes to the API, you need to update the API documentation.

There are two editors for the API documentation (both are imperfect):

Testing

Of course documentation is one part of the process. Run API-Fuzz-Test and schemathesis on API Server to ensure specification is up-to-date and without holes. To do so, run the following commands against the API Server:

python -m venv venv
source venv/bin/activate
pip install schemathesis
st run --workers=auto --base-url=http://localhost:3003 --checks=all ../openapi.yaml

Some fuzzing-goals may not be available for you locally, as they require prefix-routing (f.ex./cdn to the CDN) and some fuzzing-goals are automatically tested in our CI.
You can exchange --base-url=http://localhost:3003 to --base-url=https://nav.tum.de for the full public API, or restrict your scope using an option like --endpoint=/api/search.

Approval tests

Some of our tests are approval tests. Please install insta to have a working environment.

You can then run cargo insta test instead of cargo test to review the needed changes. If you don't want to do this, using the version we provide via CI is fine, but the DX is way better with the correct tooling.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.