Merge branch 'master' into node-version

getodk · Jan 21, 2025 · b4cd3b1 · b4cd3b1
2 parents bb8a304 + e7b04da
commit b4cd3b1
Show file tree

Hide file tree

Showing 6 changed files with 85 additions and 9 deletions.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,9 @@
+docker-compose-dev := docker compose --profile central -f docker-compose.yml -f docker-compose.dev.yml
+
+.PHONY: dev
+dev:
+	$(docker-compose-dev) up -d
+
+.PHONY: stop
+stop:
+	$(docker-compose-dev) stop
diff --git a/README.md b/README.md
@@ -30,8 +30,13 @@ In addition to the Backend and the Frontend, Central deploys services:
 * Central relies on [pyxform-http](https://github.com/getodk/pyxform-http) for converting Forms from XLSForm. It generally shouldn't be needed in development but can be run locally.
 * Central relies on [Enketo](https://github.com/enketo/enketo-express) for Web Form functionality. Enketo can be run locally and configured to work with Frontend and Backend in development by following [these instructions](https://github.com/getodk/central-frontend/blob/master/docs/enketo.md).
 
-## Operations
+If you want to work on the Central codebase and don't want to setup dependent services like Postgresql, Enketo, etc manually then you can run `make dev`, which will start those services as Docker containers. This setup requires a local domain name, `central-dev` is a good choice. Add this name in the following places:
+
+* Set `DOMAIN=central-dev` in the `.env` file. 
+* Add an entry in your `/etc/hosts` file for `127.0.0.1 central-dev`.
+* Create `local.json` in the central-backend directory and set the value of `default.env.domain` to `http://central-dev:8989`
 
+## Operations
 This repository serves administrative functions, but it also contains the Docker code for building and running a production Central stack.
 
 To learn how to run such a stack in production, please take a look at [our DigitalOcean installation guide](https://docs.getodk.org/central-install-digital-ocean/).

diff --git a/client b/client
diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml
@@ -0,0 +1,62 @@
+# Assumption: This file will be merged by `docker compose`
+#
+# What it does:
+# Sets profiles for each service depending on whether that 
+# service is required for Central development or not.
+#  
+# depends_on of some services are reset using !reset custom yml tag
+# nb: can't replace depends_on so we have removed all the values, ok for dev
+services:
+  postgres14:
+    profiles:
+      - central
+    ports:
+      - 5432:5432
+  postgres:
+    profiles:
+      - central
+    image: debian:bullseye
+    command: /bin/sh -c 'mkdir -p /var/lib/postgresql/14/data && touch /var/lib/postgresql/14/.postgres14-upgrade-successful'
+  mail:
+    profiles:
+      - none
+  service:
+    profiles:
+      - none
+  nginx:
+    profiles:
+      - none
+  pyxform:
+    profiles:
+      - central
+    ports:
+      - 5001:80
+  secrets:
+    profiles:
+      - central
+    volumes:
+      - dev_secrets:/etc/secrets
+    working_dir: /etc/secrets
+    command: /bin/sh -c 'echo "s0m3v3rys3cr3tk3y" > enketo-secret && echo "this $3cr3t key is crackable" > enketo-less-secret && echo "enketorules" > enketo-api-key'
+  enketo:
+    profiles:
+      - central
+    volumes:
+      - dev_secrets:/etc/secrets
+    depends_on: !override
+      - secrets
+      - enketo_redis_main
+    environment:
+      - ENV=DEV
+    extra_hosts:
+    - "${DOMAIN}:host-gateway"
+    ports:
+      - 8005:8005
+  enketo_redis_main:
+    profiles:
+      - central
+  enketo_redis_cache:
+    profiles:
+      - central
+volumes:
+  dev_secrets:
diff --git a/docs/news.html b/docs/news.html
@@ -7,15 +7,15 @@
   </head>
   <body>
     <div class="news-item">
-      <span class="item-date">2024/12/17</span>
-      <a href="https://forum.getodk.org/t/odk-central-v2024-3-year-end-goodies/51515" target="_blank">
-        ODK Central v2024.3
+      <span class="item-date">2025/01/13</span>
+      <a href="https://forum.getodk.org/t/odk-central-v2024-3-offline-entities-submission-deletes-and-faster-form-uploads/51515/3" target="_blank">
+        ODK Central v2024.3.1
       </a>
     </div>
     <div class="news-item">
-      <span class="item-date">2024/10/17</span>
-      <a href="https://forum.getodk.org/t/odk-central-v2024-2-submission-deletes-and-s3-media-storage/49742/3" target="_blank">
-        ODK Central v2024.2.1
+      <span class="item-date">2024/12/17</span>
+      <a href="https://forum.getodk.org/t/odk-central-v2024-3-year-end-goodies/51515" target="_blank">
+        ODK Central v2024.3
       </a>
     </div>
     <script defer src='https://static.cloudflareinsights.com/beacon.min.js' data-cf-beacon='{"token": "81f288331d6e4638be205e0e63388165"}'></script>

diff --git a/server b/server
+4 −0		src/components/dl-data.vue
+80 −0		test/components/hover-card/entity.spec.js
+51 −0		.github/workflows/db-migrations.yml
+1 −0		.mocharc.js
+6 −0		Makefile
+10 −0		config/db-migration-test.json
+3 −1		lib/external/s3.js
+8 −0		test/db-migrations/.eslintrc.js
+1 −0		test/db-migrations/.gitignore
+46 −0		test/db-migrations/20241008-01-add-user_preferences.spec.js
+108 −0		test/db-migrations/migrator.js
+36 −0		test/db-migrations/mocha-setup.js
+123 −0		test/db-migrations/utils.js
+1 −0		test/e2e/s3/test-forms/1-attachments/cities.geojson
+2 −0		test/e2e/s3/test-forms/1-attachments/some.nomime
+8 −0		test/e2e/s3/test-forms/1.xml
+6 −3		test/e2e/s3/test.js
+16 −10		test/e2e/util/api.js
+44 −0		test/integration/api/submissions.js