Merge 70904ff1a8 into d28e05af87

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>

assets/js/versions.template.js

@@ -14,8 +14,11 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// This oddity is an attempt at producing a readable Hugo template while avoiding
+// Determine the current version as defined in hugo.toml. This will either be
-// JS syntax errors in your IDE
+// "unstable" or "vX.X" and doesn't depend on the current URL.
+//
+// The oddity below is an attempt at producing a readable Hugo template while
+// avoiding JS syntax errors in your IDE.
 const currentVersion = `{{ if eq .Site.Params.version.status "unstable" }}
     {{- /**/ -}}
     unstable
@@ -26,20 +29,31 @@ const currentVersion = `{{ if eq .Site.Params.version.status "unstable" }}
     {{- /**/ -}}
 {{ end }}`;
 
+// Determine the current version segment by regex matching the URL. This will either
+// be "unstable", "latest", "vX.X" (production) or undefined (local & netlify).
+const href = window.location.href;
+const segmentMatches = href.match(/(?<=\/)unstable|latest|v\d+.\d+(?=\/)/);
+const currentSegment = segmentMatches ? segmentMatches[0] : undefined;
+
+// Determine the selected menu element. If we were able to obtain the version
+// segment from the URL (production), use that. Otherwise (local & netlify),
+// fall back to the version as defined in Hugo.
+const selected = currentSegment ?? currentVersion;
+
 function appendVersion(parent, name, url) {
     // The list item
     const li = document.createElement("li");
-    if (name === currentVersion) {
+    if (name === selected) {
-        li.classList.add("selected")
+        li.classList.add("selected");
     }
-    if (name === "unstable") {
+    if (name === "latest") {
-        li.classList.add("unstable")
+        li.classList.add("latest");
     }
     parent.appendChild(li);
 
     // The link
     const a = document.createElement("a");
-    a.classList.add("dropdown-item")
+    a.classList.add("dropdown-item");
     a.setAttribute("href", url);
     li.appendChild(a);
 
@@ -51,20 +65,16 @@ function appendVersion(parent, name, url) {
             return;
         }
 
-        // Stop further event handling
+        // If we couldn't determine the current segment, we cannot safely replace
-        ev.preventDefault();
+        // it and have to let the browser load the (root) URL instead
-        ev.stopPropagation();
+        if (!currentSegment) {
-
-        // Try to find the current version segment
-        const href = window.location.href;
-        const matches = href.match(/\/unstable\/|\/latest\/|\/v\d+.\d+\//g);
-        if (!matches) {
-            window.location.href = url;
             return;
         }
 
-        // Replace the segment
+        // Otherwise, stop further event handling and replace the segment
-        window.location.href = href.replace(matches[0], `/${name}/`);
+        ev.preventDefault();
+        ev.stopPropagation();
+        window.location.href = href.replace(`/${currentSegment}/`, `/${name}/`);
     });
 
     // The link text
@@ -83,8 +93,9 @@ fetch("/versions.json")
             return;
         }
 
-        // Add an entry for the unstable version
+        // Add a entries for the unstable version and the "latest" shortcut
         appendVersion(ul, "unstable", "https://spec.matrix.org/unstable");
+        appendVersion(ul, "latest", "https://spec.matrix.org/latest");
 
         // Add an entry for each proper version
         for (const version of versions) {

assets/scss/_styles_project.scss

@@ -58,11 +58,11 @@ Custom SCSS for the Matrix spec
   }
 
   ul#version-selector li.selected a {
-    color: $secondary;
+    font-weight: bold;
   }
 
-  ul#version-selector li.unstable:not(.selected) a {
+  ul#version-selector li.latest a {
-    color: $warning;
+    color: $secondary;
   }
 }
 

changelogs/client_server/newsfragments/2255.clarification

@@ -0,0 +1 @@
+Usage of the `event_id_only` format for push notifications is not mandatory.

data/api/client-server/pusher.yaml

@@ -230,11 +230,14 @@ paths:
                     format:
                       type: string
                       description: |-
-                        The format to send notifications in to Push Gateways if the
+                        The format in which to send notifications to the push gateway
-                        `kind` is `http`. The details about what fields the
+                        if the `kind` is `http`. The details about what fields the
-                        homeserver should send to the push gateway are defined in the
+                        homeserver should include are defined in the
-                        [Push Gateway Specification](/push-gateway-api/). Currently the only format
+                        [Push Gateway Specification](/push-gateway-api/). If omitted,
-                        available is 'event_id_only'.
+                        the server is expected to populate all of the event-related fields
+                        specified in [`/_matrix/push/v1/notify`](/push-gateway-api/#post_matrixpushv1notify).
+                      enum:
+                        - "event_id_only"
                 append:
                   type: boolean
                   description: |-