@redpanda-data/docs-extensions-and-macros 3.2.4 → 3.2.5

package/README.adoc

@@ -180,6 +180,27 @@ antora:
   - require: '@redpanda-data/docs-extensions-and-macros/extensions/add-global-attributes'
 ```
 
+=== Modify redirects file
+
+This extension removes redundant redirects from the Netlify redirects file. The need for this extension arises from an issue where the use of the `indexify` feature in Antora, combined with page aliases, can inadvertently create redirect loops or redundant redirects where the source and target URLs are identical.
+
+The issue is https://antora.zulipchat.com/#narrow/stream/282400-users/topic/Redirect.20Loop.20Issue.20with.20Page.20Renaming.20and.20Indexify/near/433691700[recognized as a bug] within Antora's redirect producer, which does not currently
+check if the source and target URLs are the same before creating a redirect.
+
+The purpose of this script is to scan the `_redirects` file and remove any entries that point
+a URL to itself, which not only prevents redirect loops but also optimizes the redirect process
+by eliminating unnecessary entries. This cleanup helps ensure that the redirects file only contains valid and useful redirection rules.
+
+By integrating this script into the Antora pipeline, we ensure that each build's output is optimized and free from potential issues related to improper redirects, enhancing both site performance and user experience.
+
+==== Registration example
+
+```yaml
+antora:
+  extensions:
+  - '@redpanda-data/docs-extensions-and-macros/extensions/modify-redirects'
+```
+
 === Replace attributes in attachments
 
 This extension replaces AsciiDoc attribute placeholders with their respective values in attachment files, such as CSS, HTML, and YAML.

package/extensions/modify-redirects.js

@@ -0,0 +1,36 @@
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+
+function redirectModifier(files, outputDir, logger) {
+  files.forEach((file) => {
+    const filePath = path.join(outputDir, file);
+    if (!fs.existsSync(filePath)) return
+    let content = fs.readFileSync(filePath, 'utf8');
+    const lines = content.split('\n');
+
+    // Filter out redirects that point to themselves
+    const modifiedLines = lines.filter((line) => {
+      const parts = line.split(' ');
+      if (parts[0] == parts[1]) logger.info(`Removed redirect that points to itself: ${line}`)
+      return parts[0] !== parts[1]; // Ensure the source and target are not the same
+    });
+
+    // Join the array back into a string and write it back to the file
+    const modifiedContent = modifiedLines.join('\n');
+    fs.writeFileSync(filePath, modifiedContent, 'utf8');
+    logger.info(`Processed and updated redirects in ${filePath}`);
+  })
+}
+
+module.exports.register = function ({ config }) {
+  const logger = this.getLogger('redirects-produced');
+  this.on('sitePublished', async ({ publications }) => {
+    publications.forEach(publication => {
+      const outputDir = publication.resolvedPath;
+      const redirectFile = ['_redirects'];
+      redirectModifier(redirectFile, outputDir, logger);
+    });
+  });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redpanda-data/docs-extensions-and-macros",
-  "version": "3.2.4",
+  "version": "3.2.5",
   "description": "Antora extensions and macros developed for Redpanda documentation.",
   "keywords": [
     "antora",
@@ -35,6 +35,7 @@
     "./extensions/validate-attributes": "./extensions/validate-attributes.js",
     "./extensions/find-related-docs": "./extensions/find-related-docs.js",
     "./extensions/find-related-labs": "./extensions/find-related-labs.js",
+    "./extensions/modify-redirects": "./extensions/modify-redirects.js",
     "./extensions/algolia-indexer/index": "./extensions/algolia-indexer/index.js",
     "./extensions/aggregate-terms": "./extensions/aggregate-terms.js",
     "./macros/glossary": "./macros/glossary.js",