Merge pull request #26 from itk-dev/feature/api

Use the real API

Author: rimi-itk

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "api"]
+	path = api
+	url = https://github.com/AAK-MBU/Process_Dashboard_API

.markdownlintignore

@@ -10,3 +10,5 @@ web/*.md
 web/core/
 web/libraries/
 web/*/contrib/
+
+/api/

.prettierignore

@@ -1,2 +1,5 @@
 # The Svelte standalone widgets have a life of their own …
 widgets/
+
+# The API must also not be touched
+api/

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * [PR-27](https://github.com/itk-dev/rpa-process-overview/pull/27)
   Added pre-defined users in OIDC mock
+* [PR-26](https://github.com/itk-dev/rpa-process-overview/pull/26)
+  Added [the real API](https://github.com/AAK-MBU/Process_Dashboard_API) for local development and testing
 * [PR-24](https://github.com/itk-dev/rpa-process-overview/pull/24)
   Remove search from url
 * [PR-25](https://github.com/itk-dev/rpa-process-overview/pull/25)

README.md

@@ -28,37 +28,67 @@ Run
 task site:update
 ```
 
-to get things started.
+> [!NOTE]
+> Running `task site:update` on [macOS (darwin)](https://en.wikipedia.org/wiki/Darwin_(operating_system)) will pull and
+> patch the API Git submodule (cf. [#api](API)). See [`Taskfile.yml`](Taskfile.yml) for details.
 
 Load fixtures with
 
 ``` shell
-task fixtures:load
+task app:fixtures:load
 ```
 
+> [!TIP]
+> Pro tip! Run
+>
+> ``` shell
+> task fixtures:load --yes
+> ```
+>
+> to load all fixtures in succession (including the fixtures mentioned below).
+
 ### Icons
 
 The icons are copied from [heroicons](https://heroicons.com).
 
-## API Mock
+## API
+
+For development, we run [AAK-MBU/Process_Dashboard_API](https://github.com/AAK-MBU/Process_Dashboard_API) locally. The
+API is added as a [Git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) in the [api](./api) folder.
+
+``` shell
+task api:create:api-keys
+```
 
-We use a [FastAPI](https://fastapi.tiangolo.com) app to mock the RPA process overview API.
+Test access to the API:
 
 ``` shell
-curl "http://$(docker compose port api 8000)/openapi.json"
-curl "http://$(docker compose port api 8000)/api/v1/process"
-curl "http://$(docker compose port api 8000)/api/v1/process" --header 'x-api-key: a-not-so-secret-key'
+task api:test
+task api:get API_PATH=/api/v1/auth/me
+
+task api:get API_PATH='/api/v1/runs/?process_id=1'
+task api:get API_PATH='/api/v1/runs/?process_id=1&meta_filter=name:Gregory%20Mendez'
 ```
 
-Create some fixture data for the API:
+See [`docker-compose.api.yml`](docker-compose.api.yml) for the docker compose setup for the API.
+
+## Updating the API
+
+Run
 
 ``` shell
-task api:fixtures:load
-curl "http://$(docker compose port api 8000)/api/v1/process/" --header 'x-api-key: a-not-so-secret-key'
+task api:update
 ```
 
-See [api/README.md](api/README.md) for some more details (and [`docker-compose.api.yml`](docker-compose.api.yml) for the
-docker compose setup).
+to update the API to the latest version (the [`main`
+branch](https://github.com/AAK-MBU/Process_Dashboard_API/tree/main)).
+
+### Loading data
+
+``` shell
+task api:script:run SCRIPT_PATH=«path to seed_data.py»
+task api:script:run SCRIPT_PATH=«path to seed_data_aktindsigt.py»
+```
 
 ## CORS
 

Taskfile.yml

@@ -37,6 +37,16 @@ tasks:
       - task: compose
         vars:
           TASK_ARGS: pull
+
+      # Additional setup for local development (assuming we're running on maxOS (darwin))
+      - cmd: |
+          git -C api checkout .
+          git submodule update --init
+          # Apply a patch to support MySQL in the API and make building it work.
+          git -C api apply < patches/Process_Dashboard_API.patch
+        # https://taskfile.dev/docs/reference/schema#platforms
+        platforms: [darwin]
+
       - task: compose
         vars:
           TASK_ARGS: up --build --detach --wait
@@ -83,21 +93,21 @@ tasks:
         vars:
           TASK_ARGS: cache:clear
 
-  fixtures:load:
-    desc: Load fixtures
+  app:fixtures:load:
+    desc: Load app fixtures
     prompt: This will reset your database. Continue?
     cmds:
       - task: console
         vars:
           TASK_ARGS: hautelook:fixtures:load --no-interaction
 
-  api:fixtures:load:
-    desc: Load API fixtures
-    prompt: Continue?
+  fixtures:load:
+    desc: Load all fixtures
+    prompt: This will reset your databases. Continue?
     cmds:
-      - task: compose
-        vars:
-          TASK_ARGS: exec api uv run python -m src.api.fixtures
+      - task: api:fixtures:load
+      - task: app:fixtures:load
+      - task: oidc:fixtures:load
 
   translations:extract:
     cmds:
@@ -134,3 +144,73 @@ tasks:
     vars:
       BUILD_DIR: widgets/static/dist/
       PUBLIC_DIR: public/widgets
+
+  api:create:api-keys:
+    desc: Create API keys
+    cmds:
+      - task: api:script:run
+        vars:
+          SCRIPT_PATH: scripts/api/create_api_keys.py
+
+  api:fixtures:load:
+    desc: Load API fixtures
+    prompt: Continue?
+    cmds:
+      # Install faker and load fixtures
+      - task: compose
+        vars:
+          TASK_ARGS: exec api uv add --dev faker
+      - task: api:create:api-keys
+      - task: api:script:run
+        vars:
+          SCRIPT_PATH: scripts/api/fixtures.py
+
+  api:update:
+    desc: Update API to latest version (https://github.com/AAK-MBU/Process_Dashboard_API/tree/main)
+    prompt: Really?
+    cmds:
+      - git -C api checkout .
+      - git -C api checkout main
+      - git -C api pull
+      # Check that our patch can be applied.
+      - git -C api apply --check < patches/Process_Dashboard_API.patch
+
+  api:script:run:
+    desc: "Run script inside API service container, example: `task {{.TASK}} SCRIPT_PATH=test/load_data.py"
+    silent: true
+    cmds:
+      - echo "Running {{.SCRIPT_PATH}} inside API service"
+      - task: compose
+        vars:
+          TASK_ARGS: cp {{.SCRIPT_PATH}} api:/app/scripts
+      - task: compose
+        vars:
+          TASK_ARGS: exec api python scripts/$(basename {{.SCRIPT_PATH}})
+    requires:
+      vars: [SCRIPT_PATH]
+    preconditions:
+      - sh: test -f {{.SCRIPT_PATH}}
+        msg: "{{.SCRIPT_PATH}} does not exist"
+
+  api:get:
+    desc: "Perform a GET request to an API endpoint, examples: `task {{.TASK}} API_PATH=/api/v1/auth/me`, `task {{.TASK}} API_PATH=/api/v1/auth/me API_KEY=my-api-key`"
+    cmds:
+      - |-
+        task compose -- exec phpfpm curl --silent --verbose --header 'x-api-key: {{.API_KEY}}' '{{.API_BASE_URL}}{{.API_PATH}}' | docker run --rm --interactive ghcr.io/jqlang/jq:latest
+    requires:
+      vars: [API_PATH]
+    vars:
+      API_BASE_URL: http://api:8000
+      # Cf. scripts/api/create_api_keys.py
+      API_KEY: '{{ .API_KEY | default "user-api-key" }}'
+    silent: true
+
+  api:test:
+    cmds:
+      - for:
+          - /api/v1/auth/me
+          - /api/v1/processes/processes/
+          - /api/v1/processes/processes/1
+        task: api:get
+        vars:
+          API_PATH: "{{.ITEM}}"