Merge Development --> Staging

.all-contributorsrc

@@ -63,7 +63,7 @@
       "name": "Sujan Adhikari",
       "avatar_url": "https://avatars.githubusercontent.com/u/109404840?v=4",
       "profile": "https://github.com/Sujanadh",
-      "contributions": ["code"]
+      "contributions": ["code", "maintenance"]
     },
     {
       "login": "Mudi-business",
@@ -77,7 +77,7 @@
       "name": "Nishit Suwal",
       "avatar_url": "https://avatars.githubusercontent.com/u/81785002?v=4",
       "profile": "https://github.com/NSUWAL123",
-      "contributions": ["code"]
+      "contributions": ["code", "maintenance"]
     },
     {
       "login": "biomassives",
@@ -154,7 +154,14 @@
       "name": "Manjita Pandey",
       "avatar_url": "https://avatars.githubusercontent.com/u/97273021?v=4",
       "profile": "https://github.com/manjitapandey",
-      "contributions": ["bug"]
+      "contributions": ["bug", "doc", "ideas"]
+    },
+    {
+      "login": "susmina94",
+      "name": "Susmina_Manandhar",
+      "avatar_url": "https://avatars.githubusercontent.com/u/108750444?v=4",
+      "profile": "https://github.com/susmina94",
+      "contributions": ["doc", "ideas", "bug"]
     }
   ],
   "contributorsPerLine": 7,

.env.example

@@ -21,6 +21,7 @@ OSM_URL=${OSM_URL:-"https://www.openstreetmap.org"}
 OSM_SCOPE=${OSM_SCOPE:-"read_prefs"}
 OSM_LOGIN_REDIRECT_URI="http${FMTM_DOMAIN:+s}://${FMTM_DOMAIN:-127.0.0.1:7051}/osmauth/"
 OSM_SECRET_KEY=${OSM_SECRET_KEY}
+OSM_SVC_ACCOUNT_TOKEN=${OSM_SVC_ACCOUNT_TOKEN}
 
 ### S3 File Storage ###
 S3_ENDPOINT=${S3_ENDPOINT:-"http://s3:9000"}
@@ -43,3 +44,14 @@ FMTM_DB_NAME=${FMTM_DB_NAME:-"fmtm"}
 
 ### Underpass (optional override) ###
 UNDERPASS_API_URL=${UNDERPASS_API_URL:-"https://api-prod.raw-data.hotosm.org/v1"}
+
+# Monitoring (OpenTelemetry). Options: 'openobserve', 'sentry'.
+MONITORING=${MONITORING}
+# Monitoring (OpenObserve)
+OPENOBSERVE_USER=${OTEL_USERNAME:-${ODK_CENTRAL_USER:-"[email protected]"}}
+OPENOBSERVE_PASSWORD=${OPENOBSERVE_PASSWORD:-"testuserpassword"}
+OPENOBSERVE_RETENTION_DAYS=${OPENOBSERVE_RETENTION_DAYS:-90}
+OTEL_ENDPOINT=${OTEL_ENDPOINT}
+OTEL_AUTH_TOKEN=${OTEL_AUTH_TOKEN}
+# Monitoring (Sentry)
+SENTRY_DSN=${SENTRY_DSN}

.github/workflows/build_and_deploy.yml

@@ -17,7 +17,7 @@ on:
 
 jobs:
   pytest:
-    uses: hotosm/gh-workflows/.github/workflows/test_compose.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/test_compose.yml@1.5.1
     with:
       image_name: ghcr.io/${{ github.repository }}/backend
       build_context: src/backend
@@ -29,20 +29,20 @@ jobs:
     secrets: inherit
 
   frontend-tests:
-    uses: hotosm/gh-workflows/.github/workflows/test_pnpm.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/test_pnpm.yml@1.5.1
     with:
       working_dir: src/frontend
 
   backend-build:
-    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.5.1
     needs: [pytest]
     with:
       context: src/backend
       build_target: prod
       image_name: ghcr.io/${{ github.repository }}/backend
 
   frontend-build:
-    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.5.1
     needs: [frontend-tests]
     with:
       context: src/frontend
@@ -152,7 +152,7 @@ jobs:
     needs:
       - smoke-test-backend
       - smoke-test-frontend
-    uses: hotosm/gh-workflows/.github/workflows/remote_deploy.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/remote_deploy.yml@1.5.1
     with:
       environment: ${{ github.ref_name }}
       docker_compose_file: "docker-compose.${{ github.ref_name }}.yml"

.github/workflows/build_ci_img.yml

@@ -16,7 +16,7 @@ on:
 
 jobs:
   backend-ci-build:
-    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.5.1
     with:
       context: src/backend
       build_target: ci

.github/workflows/build_odk_imgs.yml

@@ -13,7 +13,7 @@ on:
 
 jobs:
   build-odkcentral:
-    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.5.1
     with:
       context: odkcentral/api
       image_tags: |
@@ -26,7 +26,7 @@ jobs:
       # multi_arch: true
 
   build-odkcentral-ui:
-    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.5.1
     with:
       context: odkcentral/ui
       image_tags: |

.github/workflows/build_proxy_imgs.yml

@@ -10,7 +10,7 @@ on:
 
 jobs:
   build-cert-init-main:
-    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.5.1
     with:
       context: nginx
       build_target: certs-init-main
@@ -21,7 +21,7 @@ jobs:
       multi_arch: true
 
   build-cert-init-dev:
-    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.5.1
     with:
       context: nginx
       build_target: certs-init-development
@@ -33,7 +33,7 @@ jobs:
       multi_arch: true
 
   build-proxy-main:
-    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.5.1
     with:
       context: nginx
       build_target: main
@@ -44,7 +44,7 @@ jobs:
       multi_arch: true
 
   build-proxy-dev:
-    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.5.1
     with:
       context: nginx
       build_target: development

.github/workflows/docs.yml

@@ -12,19 +12,19 @@ on:
 
 jobs:
   build_doxygen:
-    uses: hotosm/gh-workflows/.github/workflows/doxygen_build.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/doxygen_build.yml@1.5.1
     with:
       output_path: docs/apidocs
 
   build_openapi_json:
-    uses: hotosm/gh-workflows/.github/workflows/openapi_build.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/openapi_build.yml@1.5.1
     with:
       image: ghcr.io/${{ github.repository }}/backend:ci-${{ github.ref_name }}
       example_env_file_path: ".env.example"
       output_path: docs/openapi.json
 
   publish_docs:
-    uses: hotosm/gh-workflows/.github/workflows/mkdocs_build.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/mkdocs_build.yml@1.5.1
     needs:
       - build_doxygen
       - build_openapi_json

.github/workflows/pr_test_backend.yml

@@ -14,7 +14,7 @@ on:
 
 jobs:
   pytest:
-    uses: hotosm/gh-workflows/.github/workflows/test_compose.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/test_compose.yml@1.5.1
     with:
       image_name: ghcr.io/${{ github.repository }}/backend
       build_context: src/backend

.github/workflows/pr_test_frontend.yml

@@ -13,7 +13,14 @@ on:
   workflow_dispatch:
 
 jobs:
-  frontend-tests:
-    uses: hotosm/gh-workflows/.github/workflows/test_pnpm.yml@1.4.9
+  unit-tests:
+    uses: hotosm/gh-workflows/.github/workflows/test_pnpm.yml@1.5.1
     with:
       working_dir: src/frontend
+
+  e2e-tests:
+    uses: hotosm/gh-workflows/.github/workflows/test_pnpm.yml@main
+    with:
+      container_config: '{"image": "mcr.microsoft.com/playwright:v1.43.0"}'
+      working_dir: src/frontend
+      run_command: "test:e2e"

.github/workflows/tag_build.yml

@@ -9,7 +9,7 @@ on:
 
 jobs:
   backend-build:
-    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/image_build.yml@1.5.1
     with:
       context: src/backend
       build_target: prod

.github/workflows/wiki.yml

@@ -10,6 +10,6 @@ on:
 
 jobs:
   publish-docs-to-wiki:
-    uses: hotosm/gh-workflows/.github/workflows/wiki.yml@1.4.9
+    uses: hotosm/gh-workflows/.github/workflows/wiki.yml@1.5.1
     with:
       homepage_path: "wiki_redirect.md"

.gitignore

@@ -89,3 +89,6 @@ envsubst
 
 # Scripts
 **/openapi.json
+
+# Chart dependencies
+chart/charts

INSTALL.md

@@ -62,7 +62,7 @@ If more details are required, check out the
       - [Build the Frontend](#build-the-frontend)
       - [Start the Containers](#start-the-containers)
     - [Setup ODK Central User (Optional)](#setup-odk-central-user-optional)
-    - [Import Test Data (Optional)](#import-test-data-optional)
+    - [Set Up Monitoring (Optional)](#set-up-monitoring-optional)
     - [Check Authentication (Optional)](#check-authentication-optional)
   - [Alternative Operating Systems](#alternative-operating-systems)
     - [Windows](#windows)
@@ -218,15 +218,21 @@ docker-compose exec central odk-cmd --email [email protected] user-promo
 
 > Note: Alternatively, you may use an external Central server and user.
 
-### Import Test Data (Optional)
+### Set Up Monitoring (Optional)
 
-If running a local test version, test data is available to get started quickly.
+- There is an optional configuration for application monitoring via OpenTelemetry.
+- To enable this set in your `.env` file:
 
-- Navigate to the `import-test-data` endpoint in the API docs page:
+  ```dotenv
+  # For OpenObserve
+  MONITORING="openobserve"
+  # For Sentry
+  MONITORING="sentry"
+  ```
 
-<http://api.fmtm.localhost:7050/docs#/debug/import_test_data_debug_import_test_data_get>
-
-- Click `Try it out`, then `execute`.
+- Check the `.env.example` for additional required parameters.
+- Everything should be configured for you to see endpoint calls in the
+  selected web dashboard, providing full error tracebacks and stats.
 
 ### Check Authentication (Optional)
 

Justfile

@@ -52,7 +52,7 @@ test-backend:
   docker compose run --rm api pytest
 
 test-frontend:
-  docker compose run -e CI=True --rm --entrypoint='sh -c' ui 'npm run test'
+  docker compose run --rm ui-test
 
 test: test-backend test-frontend