feat!: Store the dashboard address as a URL

Using a IP address or hostname like for the server address prevented one from defining a port
(useful for local development) and prevented all sorts of possible scenarios.

Using a URL simplifies a lot of things.

This commit also updates the `demo` scenario to make it ready to send invitations
(the Dashboard URL was in a configuration key that was removed in #188).

Author: RemiBardon

CHANGELOG.md

@@ -34,7 +34,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - feat!: Implement factory reset (`DELETE /`) (@RemiBardon in #188).
-- feat: Add `PUT /v1/pod/config/dashboard-address` (@RemiBardon in #188).
+- feat: Add `PUT /v1/pod/config/dashboard-url` (@RemiBardon in #188 and #197).
 - feat(tasks): Update changelog in `task release` (@RemiBardon).
 - feat: Enable the `register` module in Prosody (@RemiBardon in #196).
 

Cargo.lock

@@ -58,6 +58,7 @@ tower = { version = "0.5", default-features = false }
 tower-http = { version = "0.6", default-features = false }
 tracing = { version = "0.1", default-features = false }
 tracing-subscriber = { version = "0.3", default-features = false }
+url = { version = "2", default-features = false }
 url_serde = { version = "0.2", default-features = false }
 urlencoding = { version = "2", default-features = false }
 uuid = { version = "1", default-features = false }

Cargo.toml

@@ -74,41 +74,41 @@ paths:
         description: Pod address has no value
       "401": { $ref: "../shared.yaml#/components/responses/Unauthorized" }
       "403": { $ref: "../shared.yaml#/components/responses/Forbidden" }
-  set_dashboard_address:
+  set_dashboard_url:
     tags: ["Pod / Configuration"]
-    summary: Set Dashboard address
+    summary: Set Dashboard URL
     description: Tells the API how the Dashboard is publicly accessible.
-    operationId: set_dashboard_address
+    operationId: set_dashboard_url
     security: []
     requestBody:
       required: true
       content:
         application/json:
-          schema: { $ref: "#/components/schemas/SetDashboardAddressRequest" }
+          schema: { $ref: "#/components/schemas/SetDashboardUrlRequest" }
     responses:
       "200":
         description: Success
         content:
           application/json:
-            schema: { $ref: "#/components/schemas/NetworkAddress" }
+            schema: { $ref: "#/components/schemas/GetDashboardUrlResponse" }
       "401": { $ref: "../shared.yaml#/components/responses/Unauthorized" }
       "403": { $ref: "../shared.yaml#/components/responses/Forbidden" }
       "422": { $ref: "../shared.yaml#/components/responses/UnprocessableEntity" }
-  get_dashboard_address:
+  get_dashboard_url:
     tags: ["Pod / Configuration"]
-    summary: Get Dashboard address
+    summary: Get Dashboard URL
     description: Get the current address of the Prose Pod Dashboard.
-    operationId: get_dashboard_address
+    operationId: get_dashboard_url
     security:
       - BearerAuth: []
     responses:
       "200":
-        description: Dashboard address has a value
+        description: Dashboard URL has a value
         content:
           application/json:
-            schema: { $ref: "#/components/schemas/NetworkAddress" }
+            schema: { $ref: "#/components/schemas/GetDashboardUrlResponse" }
       "204":
-        description: Dashboard address has no value
+        description: Dashboard URL has no value
       "401": { $ref: "../shared.yaml#/components/responses/Unauthorized" }
       "403": { $ref: "../shared.yaml#/components/responses/Forbidden" }
 components:
@@ -117,11 +117,20 @@ components:
       type: object
       required:
         - address
-        - dashboard_address
+        - dashboard_url
       properties:
         address: { $ref: "#/components/schemas/SetPodAddressRequest" }
-        dashboard_address: { $ref: "#/components/schemas/SetDashboardAddressRequest" }
-    SetNetworkAddressRequest:
+        dashboard_url: { $ref: "#/components/schemas/DashboardUrl" }
+    PodConfig:
+      type: object
+      required: []
+      properties:
+        address:
+          $ref: "#/components/schemas/NetworkAddress"
+          type: [object, "null"]
+        dashboard_url:
+          $ref: "#/components/schemas/DashboardUrl"
+    SetPodAddressRequest:
       type: object
       required: []
       properties:
@@ -134,24 +143,22 @@ components:
         hostname:
           type: string
           example: crisp.chat
-    SetPodAddressRequest:
-      $ref: "#/components/schemas/SetNetworkAddressRequest"
-      example:
-        hostname: crisp.chat
-    SetDashboardAddressRequest:
-      $ref: "#/components/schemas/SetNetworkAddressRequest"
-      example:
-        hostname: admin.prose.crisp.chat
-    PodConfig:
+    DashboardUrl:
+      type: [string, "null"]
+      format: uri
+      example: https://admin.prose.crisp.chat/
+    SetDashboardUrlRequest:
       type: object
-      required: []
+      required: [dashboard_url]
       properties:
-        address:
-          $ref: "#/components/schemas/NetworkAddress"
-          type: [object, "null"]
-        dashboard_address:
-          $ref: "#/components/schemas/NetworkAddress"
-          type: [object, "null"]
+        dashboard_url: { $ref: "#/components/schemas/DashboardUrl" }
+    GetDashboardUrlResponse:
+      type: object
+      required: [dashboard_url]
+      properties:
+        dashboard_url:
+          $ref: "#/components/schemas/DashboardUrl"
+          type: string
     NetworkAddress:
       type: object
       required:
@@ -206,14 +213,14 @@ components:
                 const: pod_address_not_initialized
           example:
             error: pod_address_not_initialized
-    DashboardAddressNotInitialized:
-      description: Dashboard address not initialized
+    DashboardUrlNotInitialized:
+      description: Dashboard URL not initialized
       content:
         application/json:
           schema:
             $ref: "../shared.yaml#/components/schemas/Error"
             properties:
               error:
-                const: dashboard_address_not_initialized
+                const: dashboard_url_not_initialized
           example:
-            error: dashboard_address_not_initialized
+            error: dashboard_url_not_initialized

docs/openapi/features/pod-config.yaml

@@ -73,9 +73,9 @@ paths:
   "/v1/pod/config/address":
     put: { $ref: "features/pod-config.yaml#/paths/set_pod_address" }
     get: { $ref: "features/pod-config.yaml#/paths/get_pod_address" }
-  "/v1/pod/config/dashboard-address":
-    put: { $ref: "features/pod-config.yaml#/paths/set_dashboard_address" }
-    get: { $ref: "features/pod-config.yaml#/paths/get_dashboard_address" }
+  "/v1/pod/config/dashboard-url":
+    put: { $ref: "features/pod-config.yaml#/paths/set_dashboard_url" }
+    get: { $ref: "features/pod-config.yaml#/paths/get_dashboard_url" }
   "/v1/workspace":
     put: { $ref: "features/workspace.yaml#/paths/init_workspace" }
     get: { $ref: "features/workspace.yaml#/paths/get_workspace" }

docs/openapi/openapi.yaml

@@ -115,7 +115,7 @@ VirtualHost "prose-demo.org.local"
   }
   oauth2_access_token_ttl = 10800
   oauth2_refresh_token_ttl = 0
-  oauth2_registration_key = "hs3W8InJLICq7Sx1NfBbB1za_56HaBPBj1yJOFOB79rqVSdnGSwCpcTe-sgW--cbCK9mIIVE1ks_gnlu7VT84faHULdPdae6ppC_XvX155n-55eGF2vZi-iB4yfeLsVA0q4sc_222XpKWeplJCHK_sahx--_bzqB2kP2l-cdK9DZShYxtbjeV-EyS0pGBCU5AQSccDTu4EeEkdET03Pd4VEX-ld6qd6VU13awDgcHPS4tTPSJJE32czF37hT6QbEMnXU_kovloh2swCykueHqZP9zX4TMXlAaDtW7moHFUbnMSqrz9-WORRCtqqYqRvwhm3dJurLMekwyOL3ffwA9g"
+  oauth2_registration_key = "Q8UB3ua8o6ZtNsPLliIY3Komfjz18eOJTpOF-hrEUXaG9hWWLTmZkep0ZRDKCItHKORMFHuBLAoFTqM-L9w7gvM3ptnH5sinpYLQjm_Hs3b6aAHDm9NOQ89X0vGg_fjidNXwQ1w2F2uYJeXpnqtwVmX8E1peMLSTSzpJWE1NNpiariwBirnW0zEj1bgLr1ys-Bk7WCAK7GF661t607C3xcG8B5lMjgpCXqcdBJ9BUNroAYumnYmtReX8q47jsN4nU5GrRMerVAmMOMfC4laF9Zaty2n7dyvhzpyDqCXfTyUwD7Fgi04grJh0JdMcWpxPC5kUxyEzbEpOyytR1iHqhg"
 
 VirtualHost "admin.prose.org.local"
   admins = { "[email protected]" }

local-run/scenarios/demo/database.sqlite

@@ -1,8 +1,8 @@
 return {
+	["salt"] = "9b0e2dae-6277-4940-91ca-fd2927b53d49";
+	["stored_key"] = "61d363707d91680dee01d421506ec0cce7ecbd8c";
+	["created"] = 1743457706;
+	["updated"] = 1743457706;
 	["iteration_count"] = 10000;
-	["stored_key"] = "1935c5dc2048db96313c2166314ae2ed78f04cc1";
-	["created"] = 1737408582;
-	["salt"] = "f7dfb1d1-e0f3-48b8-bb4e-cbd03d03b537";
-	["updated"] = 1737408582;
-	["server_key"] = "1f07f5600f977063f9bbd2d438115d22a341be5f";
+	["server_key"] = "ff58cc0b1346b2913528460a0226cd8874dd99c6";
 };

local-run/scenarios/demo/prosody/config/prosody.cfg.lua

@@ -1,3 +1,3 @@
 return {
-	["tokenauth/clear_expired_grants"] = 1737408583;
+	["tokenauth/clear_expired_grants"] = 1743446143;
 };

local-run/scenarios/demo/prosody/data/admin%2eprose%2eorg%2elocal/accounts/prose%2dpod%2dapi.dat

@@ -1,8 +1,8 @@
 return {
-	["iteration_count"] = 10000;
-	["stored_key"] = "82d242f56ca4669ad2baedf23c0d3c9b9f60d0c1";
+	["salt"] = "e50c16e0-4266-472a-a262-07fb78bcd644";
+	["stored_key"] = "8207d68ab1532294c9eab6720df21d2ccd7d8566";
 	["created"] = 1737408583;
-	["salt"] = "0b265224-b291-46f2-ac12-5bf198902ff9";
-	["updated"] = 1737408583;
-	["server_key"] = "b33550fdd3ff17ab127d02137929aa134766f476";
+	["updated"] = 1743457706;
+	["iteration_count"] = 10000;
+	["server_key"] = "bc8ddc1c33ffb7fb0e3010e65e3d9ef75ab7ac9d";
 };