Make redirect pages for categories (#4037)

szakarias · web-flow · commit ad65ae894e63 · 2025-04-25T10:42:47.000+02:00
diff --git a/lib/src/generator/generator_backend.dart b/lib/src/generator/generator_backend.dart
@@ -86,8 +86,7 @@ abstract class GeneratorBackend {
       );
     }
     var e = data.self;
-    writer.write(filename, content,
-        element: e is Warnable ? e : null);
+    writer.write(filename, content, element: e is Warnable ? e : null);
   }
 
   /// Emits JSON describing the [categories] defined by the package.
@@ -122,6 +121,11 @@ abstract class GeneratorBackend {
     var data = CategoryTemplateData(options, packageGraph, category);
     var content = templates.renderCategory(data);
     write(writer, category.filePath, data, content);
+    if (category.filePath != category.redirectFilePath) {
+      var redirectContent = templates.renderCategoryRedirect(data);
+      write(writer, category.redirectFilePath, data, redirectContent);
+    }
+
     runtimeStats.incrementAccumulator('writtenCategoryFileCount');
   }
 
diff --git a/lib/src/generator/templates.aot_renderers_for_html.dart b/lib/src/generator/templates.aot_renderers_for_html.dart
@@ -234,6 +234,41 @@ String renderCategory(CategoryTemplateData context0) {
   return buffer.toString();
 }
 
+String renderCategoryRedirect(CategoryTemplateData context0) {
+  final buffer = StringBuffer();
+  buffer.write('''<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <link rel="canonical" href="''');
+  if (context0.useBaseHref) {
+    var context1 = context0.htmlBase;
+    buffer.write(context0.htmlBase);
+  }
+  buffer.writeEscaped(context0.self.href);
+  buffer.write('''" />
+    <meta http-equiv="refresh" content="0; url=''');
+  if (context0.useBaseHref) {
+    var context2 = context0.htmlBase;
+    buffer.write(context0.htmlBase);
+  }
+  buffer.writeEscaped(context0.self.href);
+  buffer.write('''" />
+  </head>
+  <body>
+    <p><a href="''');
+  if (context0.useBaseHref) {
+    var context3 = context0.htmlBase;
+    buffer.write(context0.htmlBase);
+  }
+  buffer.writeEscaped(context0.self.href);
+  buffer.write('''">New URL</a></p>
+  </body>
+</html>
+''');
+
+  return buffer.toString();
+}
+
 String renderClass(ClassTemplateData context0) {
   final buffer = StringBuffer();
   buffer.write(_renderClass_partial_head_0(context0));
diff --git a/lib/src/generator/templates.dart b/lib/src/generator/templates.dart
@@ -12,6 +12,9 @@
 
 @Renderer(#renderCategory, Context<CategoryTemplateData>(), 'category',
     visibleTypes: _visibleTypes)
+@Renderer(#renderCategoryRedirect, Context<CategoryTemplateData>(),
+    'category_redirect',
+    visibleTypes: _visibleTypes)
 @Renderer(#renderClass, Context<ClassTemplateData>(), 'class')
 @Renderer(#renderConstructor, Context<ConstructorTemplateData>(), 'constructor')
 @Renderer(#renderEnum, Context<EnumTemplateData>(), 'enum')
@@ -92,6 +95,7 @@ const _visibleTypes = {
 /// The collection of [Template] objects.
 abstract class Templates {
   String renderCategory(CategoryTemplateData context);
+  String renderCategoryRedirect(CategoryTemplateData context);
   String renderClass<T extends Class>(ClassTemplateData context);
   String renderConstructor(ConstructorTemplateData context);
   String renderEnum(EnumTemplateData context);
@@ -141,6 +145,10 @@ class HtmlAotTemplates implements Templates {
   String renderCategory(CategoryTemplateData context) =>
       aot_renderers_for_html.renderCategory(context);
 
+  @override
+  String renderCategoryRedirect(CategoryTemplateData context) =>
+      aot_renderers_for_html.renderCategoryRedirect(context);
+
   @override
   String renderClass<T extends Class>(ClassTemplateData context) =>
       aot_renderers_for_html.renderClass(context);
@@ -222,6 +230,10 @@ class RuntimeTemplates implements Templates {
   String renderCategory(CategoryTemplateData context) =>
       runtime_renderers.renderCategory(context, _categoryTemplate);
 
+  @override
+  String renderCategoryRedirect(CategoryTemplateData context) =>
+      runtime_renderers.renderCategoryRedirect(context, _categoryTemplate);
+
   @override
   String renderClass<T extends Class>(ClassTemplateData context) =>
       runtime_renderers.renderClass(context, _classTemplate);
diff --git a/lib/src/generator/templates.runtime_renderers.dart b/lib/src/generator/templates.runtime_renderers.dart
@@ -1846,6 +1846,38 @@ class _Renderer_Category extends RendererBase<Category> {
                   );
                 },
               ),
+              'fileName': Property(
+                getValue: (CT_ c) => c.fileName,
+                renderVariable: (
+                  CT_ c,
+                  Property<CT_> self,
+                  List<String> remainingNames,
+                ) {
+                  if (remainingNames.isEmpty) {
+                    return self.getValue(c).toString();
+                  }
+                  var name = remainingNames.first;
+                  var nextProperty = _Renderer_String.propertyMap().getValue(
+                    name,
+                  );
+                  return nextProperty.renderVariable(
+                    self.getValue(c) as String,
+                    nextProperty,
+                    [...remainingNames.skip(1)],
+                  );
+                },
+
+                isNullValue: (CT_ c) => false,
+
+                renderValue: (
+                  CT_ c,
+                  RendererBase<CT_> r,
+                  List<MustachioNode> ast,
+                  StringSink sink,
+                ) {
+                  _render_String(c.fileName, ast, r.template, sink, parent: r);
+                },
+              ),
               'filePath': Property(
                 getValue: (CT_ c) => c.filePath,
                 renderVariable: (
@@ -2155,6 +2187,44 @@ class _Renderer_Category extends RendererBase<Category> {
                   );
                 },
               ),
+              'redirectFilePath': Property(
+                getValue: (CT_ c) => c.redirectFilePath,
+                renderVariable: (
+                  CT_ c,
+                  Property<CT_> self,
+                  List<String> remainingNames,
+                ) {
+                  if (remainingNames.isEmpty) {
+                    return self.getValue(c).toString();
+                  }
+                  var name = remainingNames.first;
+                  var nextProperty = _Renderer_String.propertyMap().getValue(
+                    name,
+                  );
+                  return nextProperty.renderVariable(
+                    self.getValue(c) as String,
+                    nextProperty,
+                    [...remainingNames.skip(1)],
+                  );
+                },
+
+                isNullValue: (CT_ c) => false,
+
+                renderValue: (
+                  CT_ c,
+                  RendererBase<CT_> r,
+                  List<MustachioNode> ast,
+                  StringSink sink,
+                ) {
+                  _render_String(
+                    c.redirectFilePath,
+                    ast,
+                    r.template,
+                    sink,
+                    parent: r,
+                  );
+                },
+              ),
               'referenceChildren': Property(
                 getValue: (CT_ c) => c.referenceChildren,
                 renderVariable:
@@ -2285,7 +2355,7 @@ class _Renderer_Category extends RendererBase<Category> {
   }
 }
 
-String renderCategory(CategoryTemplateData context, Template template) {
+String renderCategoryRedirect(CategoryTemplateData context, Template template) {
   var buffer = StringBuffer();
   _render_CategoryTemplateData(context, template.ast, template, buffer);
   return buffer.toString();
@@ -2543,6 +2613,12 @@ class _Renderer_CategoryTemplateData
   }
 }
 
+String renderCategory(CategoryTemplateData context, Template template) {
+  var buffer = StringBuffer();
+  _render_CategoryTemplateData(context, template.ast, template, buffer);
+  return buffer.toString();
+}
+
 void _render_Class(
   Class context,
   List<MustachioNode> ast,
@@ -19948,7 +20024,7 @@ class _Renderer_Package extends RendererBase<Package> {
   }
 }
 
-String renderIndex(PackageTemplateData context, Template template) {
+String renderSearchPage(PackageTemplateData context, Template template) {
   var buffer = StringBuffer();
   _render_PackageTemplateData(context, template.ast, template, buffer);
   return buffer.toString();
@@ -20305,13 +20381,13 @@ class _Renderer_PackageTemplateData extends RendererBase<PackageTemplateData> {
   }
 }
 
-String renderError(PackageTemplateData context, Template template) {
+String renderIndex(PackageTemplateData context, Template template) {
   var buffer = StringBuffer();
   _render_PackageTemplateData(context, template.ast, template, buffer);
   return buffer.toString();
 }
 
-String renderSearchPage(PackageTemplateData context, Template template) {
+String renderError(PackageTemplateData context, Template template) {
   var buffer = StringBuffer();
   _render_PackageTemplateData(context, template.ast, template, buffer);
   return buffer.toString();
diff --git a/lib/src/model/category.dart b/lib/src/model/category.dart
@@ -105,11 +105,17 @@ class Category
   late final bool isDocumented =
       documentedWhere != DocumentLocation.missing && documentationFile != null;
 
-  String get filePath {
+  String get fileName {
     assert(_name != null);
-    return 'topics/$_name-topic.html';
+    return '$_name-topic.html';
   }
 
+  String get filePath => 'topics/$fileName';
+
+  /// Prior to dartdoc 8.3.4 the `displayName` was used in the file path
+  /// for category pages. We now create a redirect file here instead.
+  String get redirectFilePath => 'topics/$name-topic.html';
+
   @override
   String? get href => isCanonical ? '${package.baseHref}$filePath' : null;
 
diff --git a/lib/templates/category_redirect.html b/lib/templates/category_redirect.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <link rel="canonical" href="{{ #useBaseHref }}{{ #htmlBase }}{{{ htmlBase }}}{{ /htmlBase }}{{ /useBaseHref }}{{ self.href }}" />
+    <meta http-equiv="refresh" content="0; url={{ #useBaseHref }}{{ #htmlBase }}{{{ htmlBase }}}{{ /htmlBase }}{{ /useBaseHref }}{{ self.href }}" />
+  </head>
+  <body>
+    <p><a href="{{ #useBaseHref }}{{ #htmlBase }}{{{ htmlBase }}}{{ /htmlBase }}{{ /useBaseHref }}{{ self.href }}">New URL</a></p>
+  </body>
+</html>
diff --git a/test/end2end/model_test.dart b/test/end2end/model_test.dart
@@ -730,6 +730,11 @@ void main() async {
     });
   });
 
+  test('Verify redirectFilePath set', () {
+    var category = packageGraph.publicPackages.first.categories.first;
+    expect(category.redirectFilePath, 'topics/Superb-topic.html');
+  });
+
   group('LibraryContainer', () {
     late final TestLibraryContainer topLevel;
     var sortOrderBasic = ['theFirst', 'second', 'fruit'];
diff --git a/test/templates/category_test.dart b/test/templates/category_test.dart

Original file line number	Diff line number	Diff line change
`@@ -86,8 +86,7 @@ abstract class GeneratorBackend {`
`86`	`86`	`);`
`87`	`87`	`}`
`88`	`88`	`var e = data.self;`
`89`		`- writer.write(filename, content,`
`90`		`- element: e is Warnable ? e : null);`
	`89`	`+ writer.write(filename, content, element: e is Warnable ? e : null);`
`91`	`90`	`}`
`92`	`91`
`93`	`92`	`/// Emits JSON describing the [categories] defined by the package.`
`@@ -122,6 +121,11 @@ abstract class GeneratorBackend {`
`122`	`121`	`var data = CategoryTemplateData(options, packageGraph, category);`
`123`	`122`	`var content = templates.renderCategory(data);`
`124`	`123`	`write(writer, category.filePath, data, content);`
	`124`	`+ if (category.filePath != category.redirectFilePath) {`
	`125`	`+ var redirectContent = templates.renderCategoryRedirect(data);`
	`126`	`+ write(writer, category.redirectFilePath, data, redirectContent);`
	`127`	`+ }`
	`128`	`+`
`125`	`129`	`runtimeStats.incrementAccumulator('writtenCategoryFileCount');`
`126`	`130`	`}`
`127`	`131`