Skip to content

Backend

Jump to bottom
svchot edited this page Oct 26, 2024 · 21 revisions

Backend Deployment for Development

The recommended way to run FMTM is with Docker.

You can also develop on your local machine outside of Docker, see below.

NOTE: If you haven't yet downloaded the Repository and setup your local environment, please check the docs here.

Now let's get started 👍

1. Start the API with Docker

The easiest way to get up and running is by using the FMTM Docker deployment. Docker creates a virtual environment, isolated from your computer's environment, installs all necessary dependencies, and creates a container for each the database, the api, and the frontend. These containers talk to each other via the URLs defined in the docker-compose file and your env file.

  1. You will need to Install Docker and ensure that it is running on your local machine.
  2. From the command line: navigate to the top level directory of the FMTM project.
  3. From the command line run: docker-compose pull. This will pull the latest container builds from main branch.
  4. Make sure you have a .env file with all required variables, see here.
  5. Once everything is pulled, from the command line run: docker compose up -d api
  6. If everything goes well you should now be able to navigate to the project in your browser: http://api.fmtm.localhost:7050/docs

Note: If that link doesn't work, check the logs with docker compose logs api. Note: the database host fmtm-db is automatically resolved by docker compose to the database container IP.

Bundled ODK Central

  • FMTM uses ODK Central to store ODK data.
  • To facilitate faster development, the Docker setup includes a Central server.
  • The credentials are provided via the .env file, and the default URL to access Central from within containers is: https://proxy.

Alternatively, you may provide credentials to an external Central server in the .env.

To run the local development setup without ODK Central (use external server):

dc --profile no-odk up -d

# Or via Just
just start without-central

2. Start the API without Docker

  • To run FMTM without Docker, you will need to start the database, then the API.
  • First start a Postgres database running on a port on your machine.
    • The database must have the Postgis extension installed.
  • After starting the database, from the command line:
  1. Navigate to the top level directory of the FMTM project.
  2. Install PDM with: pip install pdm
  3. Install backend dependencies with PDM: pdm install
  4. Run the Fast API backend with: pdm run uvicorn app.main:api --host 0.0.0.0 --port 8000

The API should now be accessible at: http://api.fmtm.localhost:7050/docs

Backend Tips

Database Migration

Creating Migration Files

  • Migrations can be written to src/backend/migrations.
  • Each file must be an SQL script that is:
    • Idempotent: can be run multiple times without consequence.
    • Atomic: Run within a BEGIN/COMMIT transaction.
  • Migrations must also include an equivalent revert migration under: src/backend/migrations/revert

Applying Migrations

  • Should occur automatically as part of the docker compose stack (migration service).
  • To run manually:
docker compose up -d migrations

# Or via Just
just migrate

Type Checking

  • It is a good idea to have your code 'type checked' to avoid potential future bugs.
  • To do this, install pyright (VSCode has an extension).
  • You may need to add the backend dependencies to extraPaths. In VSCode your settings.json would include:
{
  "python.analysis.extraPaths": ["src/backend/__pypackages__/3.12/lib/"]
}

Interactive Debugging

  • The docker-compose.yml builds FMTM using the debug target in the Dockerfile.
  • The debug image contains debugpy to assist debugging in the container.

To use it:

  1. Re-build the docker image docker compose build api

  2. Uncomment the debug port in docker-compose.yml:

    services:
  ...
  api:
    ...
    ports:
      - "7052:8000"
    #   - "5678:5678" # Debugger port

  3. Start the docker container docker compose up -d api

  4. Connect to the debugger on port 5678.

You can configure your IDE to do this with the build in debugger.

Example launch.json config for vscode:

{
  "configurations": [
    {
      "name": "Remote - Server Debug",
      "type": "python",
      "request": "attach",
      "host": "localhost",
      "port": 5678,
      "pathMappings": [
        {
          "localRoot": "${workspaceFolder}/src/backend/app",
          "remoteRoot": "/opt/app"
        }
      ],
      "justMyCode": false
    }
  ]
}

Note: either port 5678 needs to be bound to your localhost (default), or the host parameter can be set to the container IP address.

Running Tests

To run the backend tests locally, run:

docker compose run --rm api pytest

# Or via Just
just test backend

To assess coverage of tests, run:

docker compose run --rm --entrypoint='sh -c' api \
  'coverage run -m pytest && coverage report -m'

# Or via Just
just test coverage

To assess performance of endpoints:

  • We can use the pyinstrument profiler.
  • While in debug mode (DEBUG=True), access any endpoint.
  • Add the ?profile=true arg to the URL to view the execution time.

Debugging osm-fieldwork

osm-fieldwork is an integral package for much of the functionality in FMTM.

Creating a new release during development may not always be feasible.

  • A development version of osm-fieldwork can be mounted into the FMTM container via bind mount.
  • Clone the osm-fieldwork repo to the same root directory as FMTM.
  • Uncomment the line in docker-compose.yml
- ../osm-fieldwork/osm_fieldwork:/home/appuser/.local/lib/python3.11/site-packages/osm_fieldwork
  • Run the docker container with your local version of osm-fieldwork.
  • Code changes to osm-fieldwork should be reflected immediately. If they are not, run: docker compose restart api.

Note: this is useful for debugging features during active development.

Accessing S3 Files use s3fs

The s3fs tool allows you to mount an S3 bucket on your filesystem, to browse like any other directory.

Create a credentials file:

# Replace ACCESS_KEY_ID and SECRET_ACCESS_KEY
echo ACCESS_KEY_ID:SECRET_ACCESS_KEY > ${HOME}/.passwd-s3fs
chmod 600 ${HOME}/.passwd-s3fs

Mount local S3 using Just

just mount-s3

Mount S3 manually

Install s3fs:

sudo apt update
sudo apt install s3fs

Mount your bucket:

If you wish for this to be permanent, see below.

sudo mkdir /mnt/fmtm/local
sudo chown $(whoami):$(whoami) /mnt/fmtm/local
s3fs fmtm-data /mnt/fmtm/local \
  -o passwd_file=/home/$(whoami)/s3-creds/fmtm-local \
  -o url=http://s3.fmtm.localhost:7050 \
  -o use_path_request_style

Access the files like a directory under: /mnt/fmtm/local.

To mount permanently, add the following to /etc/fstab:

fmtm-data /mnt/fmtm/local fuse.s3fs _netdev,allow_other,\ use_path_request_style,passwd_file=/home/USERNAME/s3-creds/fmtm-local,\ url=http://s3.fmtm.localhost:7050 0 0

Note: you should replace USERNAME with your linux username.

Running JOSM in the dev stack

  • Run JOSM with FMTM via Just:
just start josm

This adds JOSM to the docker compose stack for local development.

You can now call the JOSM API from FMTM and changes will be reflected in the GUI.

Debugging local services on mobile

  • It's difficult to debug services running on localhost from your mobile phone.
  • An easy way to do this is by tunneling: Cloudflare provides a great free solution for this (an alternative is Ngrok).
  • We may also wish to debug our local ODK Central instance forms on our mobile ODK Collect.
  • To handle both of these instances set up tunnels for all services with:
just start tunnel

To complete this setup, two additional steps must be complete:

  • Requirement 1: For login to work, use the temporary login.

  • Requirement 2: During project creation, set the ODK Central server URL to the provided tunnel URL for the ODK Central API.

    The credentials for the local ODK Central instance are: Username: [email protected] Password: Password1234

Now when you access the project via a QRCode on mobile, the connection to ODK Central should work.

Clone this wiki locally