@redpanda-data/docs-extensions-and-macros 5.3.4 → 5.3.6

package/extensions/README.adoc

@@ -86,6 +86,7 @@ IMPORTANT: Extensions must be registered under the `antora.extensions` key in yo
 * **add-global-attributes** - Add attributes globally to all pages
 * **add-pages-to-root** - Add pages to the root navigation
 * **process-context-switcher** - Handle context-dependent content
+* **set-available-attachment-versions** - Point UI templates at the newest generated JSON attachments that exist in the catalog
 * **validate-attributes** - Validate AsciiDoc attributes
 
 === AI-friendly documentation

package/extensions/REFERENCE.adoc

@@ -456,6 +456,35 @@ antora:
   - '@redpanda-data/docs-extensions-and-macros/extensions/version-fetcher/set-latest-version'
 ```
 
+== Set available attachment versions
+
+This extension scans the content catalog for generated JSON attachments and sets attributes that point UI templates at the newest file that actually exists, instead of the newest released version. Release-tracking attributes such as `latest-redpanda-tag` and `latest-connect-version` can be ahead of the newest generated JSON in the catalog; without this extension, the docs-ui `head-meta` partial falls back to a constructed production URL that returns 404 on every page view.
+
+It sets the following attributes on component versions (never overwriting a value that is already set, so they can be pinned in `antora.yml`):
+
+* `available-properties-tag`: newest `redpanda-properties-<tag>.json` attachment in the `reference` module of each version of the streaming component (`streaming`, or `ROOT` on older branches).
+* `available-connect-version`: newest `connect-<version>.json` attachment in the `components` module of the connect component (`connect`, or `redpanda-connect` on older branches).
+* `page-disable-property-tooltips`: set to `true` on streaming versions that have no properties JSON at all, so browsers never request a URL that cannot exist.
+
+=== Environment variables
+
+This extension does not require any environment variables.
+
+=== Configuration options
+
+There are no configurable options for this extension.
+
+=== Registration
+
+Register the `set-available-attachment-versions` extension in the Antora playbook under the `antora.extensions` key like so:
+
+[source,yaml]
+----
+antora:
+  extensions:
+    - require: '@redpanda-data/docs-extensions-and-macros/extensions/set-available-attachment-versions'
+----
+
 == Validate attributes
 
 This extension ensures the consistency and validity of page attributes, focusing on validating page categories against a predefined list of valid categories and subcategories. It automatically adds missing parent categories for any specified subcategories and removes any specified categories that are invalid. Additionally, it processes specific environment attributes, setting corresponding page-level attributes when environment conditions are met.

package/extensions/set-available-attachment-versions.js

@@ -0,0 +1,105 @@
+'use strict'
+
+const semver = require('semver')
+
+/**
+ * Points UI templates at generated JSON attachments that actually exist.
+ *
+ * The docs-ui head-meta partial builds <meta name="properties-json-url"> and
+ * <meta name="connect-json-url"> tags from version attributes such as
+ * latest-redpanda-tag and latest-connect-version. Those attributes track the
+ * newest GitHub release, which can be ahead of the newest generated JSON in
+ * the content catalog. When that happens the template's production fallback
+ * URL points at a file that does not exist, and every page view requests a
+ * guaranteed 404.
+ *
+ * This extension scans the catalog on contentClassified and sets, per
+ * component version:
+ *
+ * - available-properties-tag: newest redpanda-properties-<tag>.json attachment
+ *   in the reference module of each streaming (ROOT) component version
+ * - available-connect-version: newest connect-<version>.json attachment in the
+ *   components module of the connect component
+ * - page-disable-property-tooltips: 'true' on streaming versions that have no
+ *   properties JSON at all, so browsers never request a URL that cannot exist
+ *
+ * Attributes already set (for example, pinned in antora.yml) are never
+ * overwritten.
+ */
+
+const PROPERTIES_COMPONENTS = ['ROOT', 'streaming']
+const CONNECT_COMPONENTS = ['connect', 'redpanda-connect']
+
+const PROPERTIES_JSON_RX = /^redpanda-properties-(v\d+\.\d+\.\d+(?:-[\w.]+)?)\.json$/
+const CONNECT_JSON_RX = /^connect-(\d+\.\d+\.\d+(?:-[\w.]+)?)\.json$/
+
+module.exports.register = function () {
+  const logger = this.getLogger('set-available-attachment-versions-extension')
+
+  this.once('contentClassified', ({ contentCatalog }) => {
+    contentCatalog.getComponents().forEach((component) => {
+      const isProperties = PROPERTIES_COMPONENTS.includes(component.name)
+      const isConnect = CONNECT_COMPONENTS.includes(component.name)
+      if (!isProperties && !isConnect) return
+
+      component.versions.forEach((compVer) => {
+        const attributes = ((compVer.asciidoc = compVer.asciidoc || {}).attributes =
+          compVer.asciidoc.attributes || {})
+        const attachments = contentCatalog.findBy({
+          component: component.name,
+          version: compVer.version,
+          family: 'attachment',
+        })
+
+        if (isProperties) {
+          const newest = findNewestVersion(attachments, 'reference', PROPERTIES_JSON_RX)
+          if (newest) {
+            if (!attributes['available-properties-tag']) {
+              attributes['available-properties-tag'] = newest
+              logger.info(
+                `Set available-properties-tag=${newest} for ${component.name}@${compVer.version}`
+              )
+            }
+          } else if (attributes['latest-redpanda-tag'] && !attributes['available-properties-tag']) {
+            // Tooltips would request a JSON that does not exist for this version
+            if (!attributes['page-disable-property-tooltips']) {
+              attributes['page-disable-property-tooltips'] = 'true'
+              logger.info(
+                `No properties JSON found for ${component.name}@${compVer.version}; disabling property tooltips`
+              )
+            }
+          }
+        }
+
+        if (isConnect) {
+          const newest = findNewestVersion(attachments, 'components', CONNECT_JSON_RX)
+          if (newest && !attributes['available-connect-version']) {
+            attributes['available-connect-version'] = newest
+            logger.info(
+              `Set available-connect-version=${newest} for ${component.name}@${compVer.version}`
+            )
+          }
+        }
+      })
+    })
+  })
+}
+
+function findNewestVersion (attachments, module, rx) {
+  let newestRaw = null
+  let newestSemver = null
+  attachments.forEach((attachment) => {
+    if (attachment.src.module !== module) return
+    const basename = attachment.src.relative.split('/').pop()
+    const match = basename.match(rx)
+    if (!match) return
+    const raw = match[1]
+    const parsed = semver.coerce(raw, { includePrerelease: true })
+    if (!parsed) return
+    if (!newestSemver || semver.gt(parsed, newestSemver)) {
+      newestSemver = parsed
+      newestRaw = raw
+    }
+  })
+  return newestRaw
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redpanda-data/docs-extensions-and-macros",
-  "version": "5.3.4",
+  "version": "5.3.6",
   "description": "Antora extensions and macros developed for Redpanda documentation.",
   "keywords": [
     "antora",
@@ -60,6 +60,7 @@
     "./extensions/generate-rp-connect-info": "./extensions/generate-rp-connect-info.js",
     "./extensions/generate-fields-only-pages": "./extensions/generate-fields-only-pages.js",
     "./extensions/add-global-attributes": "./extensions/add-global-attributes.js",
+    "./extensions/set-available-attachment-versions": "./extensions/set-available-attachment-versions.js",
     "./extensions/git-full-clone": "./extensions/git-full-clone.js",
     "./extensions/add-git-dates": "./extensions/add-git-dates.js",
     "./extensions/add-faq-structured-data": "./extensions/add-faq-structured-data.js",