more RSS tuning, add support for legacy items

Author: KianNH

src/components/changelog-next/Header.astro

@@ -39,7 +39,7 @@ const products = await uniqueProducts(notes);
 		<p>
 			New updates and improvements at Cloudflare.
 			<a
-				href="/changelog-next/rss.xml"
+				href="/changelog-next/rss/index.xml"
 				class="dark:!hover:text-[#79B1FF] -mx-2 whitespace-nowrap px-2 text-[#056DFF] no-underline hover:rounded-[4px] hover:bg-[#DCEBFF] hover:!text-[#056DFF] dark:text-[#79B1FF] dark:hover:bg-[#002B66] max-sm:block"
 			>
 				Subscribe to RSS

src/content/docs/ddos-protection/change-log/http/scheduled-changes.mdx

@@ -7,7 +7,8 @@ head:
   - tag: title
     content: Scheduled changes — HTTP DDoS
 changelog:
-  date: 2024-04-29
+  date: 2024-04-19
+  scheduled: 2024-04-29
 ---
 
 import { RuleID } from "~/components"

src/content/docs/ddos-protection/change-log/network/scheduled-changes.mdx

@@ -6,8 +6,8 @@ sidebar:
 head:
   - tag: title
     content: Scheduled changes — Network-layer DDoS
-changelog:
-  date: 2024-10-10
+# changelog:
+#   scheduled: 2024-10-10
 ---
 
 

src/content/docs/waf/change-log/2025-01-06.mdx

@@ -5,6 +5,8 @@ pcx_content_type: changelog
 sidebar:
   order: 806
 tableOfContents: false
+changelog:
+  date: 2025-01-06
 ---
 
 import { RuleID } from "~/components";

src/content/docs/waf/change-log/scheduled-changes.mdx

@@ -6,7 +6,8 @@ sidebar:
   order: 2
 tableOfContents: false
 changelog:
-  date: 2025-02-10
+  date: 2025-02-03
+  scheduled: 2025-02-10
 ---
 
 import { RuleID } from "~/components";

src/pages/changelog-next/index.astro

@@ -60,7 +60,7 @@ const props = {
 									<div>
 										<h3 class="leading-none">
 											<a
-												href={`/changelog-next/${entry.id}/`}
+												href={entry.data.link}
 												class="mb-4 !text-black no-underline hover:underline"
 											>
 												{entry.data.title}

src/pages/changelog-next/index.xml.ts

@@ -0,0 +1,21 @@
+import rss from "@astrojs/rss";
+import type { APIRoute } from "astro";
+import { getChangelogs, getRSSItems } from "~/util/changelogs";
+
+export const GET: APIRoute = async ({ locals }) => {
+	const notes = await getChangelogs({});
+
+	const items = await getRSSItems({
+		notes,
+		locals,
+		legacy: true,
+	});
+
+	return rss({
+		title: "Cloudflare release notes",
+		description: `Updates to various Cloudflare products.`,
+		site: "https://developers.cloudflare.com/changelog-next/",
+		trailingSlash: false,
+		items,
+	});
+};

src/schemas/base.ts

@@ -103,9 +103,21 @@ export const baseSchema = z.object({
 		),
 	changelog: z
 		.object({
-			products: z.array(reference("products")).optional(),
-			date: z.coerce.date().optional(),
+			date: z.coerce
+				.date()
+				.describe(
+					"An ISO-8601 date to indicate when this page should be published in RSS feeds.",
+				),
+			scheduled: z.coerce
+				.date()
+				.optional()
+				.describe(
+					"An ISO-8601 date to indicate this page is a future-dated entry in the RSS feed title. The publish date is still taken from the `date` field.",
+				),
 		})
 		.strict()
-		.optional(),
+		.optional()
+		.describe(
+			"Used for pages in the 'docs' collection that should be used as changelog entries.",
+		),
 });

src/util/changelogs.ts

@@ -13,9 +13,32 @@ import rehypeRemark from "rehype-remark";
 import remarkGfm from "remark-gfm";
 import remarkStringify from "remark-stringify";
 
+function toISODate(date: Date) {
+	return date.toISOString().slice(0, 10);
+}
+
 type DocsToChangelogOptions = {
-	name: string;
+	/**
+	 * An optional title to be prefixed before the date.
+	 * This is only necessary if you require an extra product name.
+	 *
+	 * @example
+	 * `HTTP DDoS managed ruleset`
+	 */
+	name?: string;
+	/**
+	 * Name of a product which must match a filename in the
+	 * src/content/products/ collection, without the
+	 * file extension.
+	 *
+	 * @example
+	 * `ddos-protection`
+	 */
 	product: string;
+	/**
+	 * A changelog entry from the `getChangelogs({})` function.
+	 * @see {@link getChangelogs}
+	 */
 	entry: CollectionEntry<"docs">;
 };
 
@@ -25,23 +48,31 @@ function docsToChangelog({
 	entry,
 }: DocsToChangelogOptions): CollectionEntry<"changelogs-next"> {
 	const { data } = entry;
-	const { title, changelog } = data;
 
-	let date;
-	if (changelog?.date) {
-		date = changelog.date;
+	// `data.changelog` will exist as the existence of this
+	// property is part of the `getChangelogs` filter.
+	const date = data.changelog!.date;
+	const scheduled = data.changelog!.scheduled;
+
+	const iso8601 = toISODate(date);
+
+	let title;
+	if (scheduled) {
+		title = `Scheduled for ${toISODate(scheduled)}`;
 	} else {
-		date = new Date(data.title.split(" ")[0]);
+		title = iso8601;
 	}
 
-	const iso8601 = date.toISOString().slice(0, 10);
+	if (name) {
+		title = `${name} - ${title}`;
+	}
 
 	return {
 		...entry,
 		collection: "changelogs-next",
 		data: {
 			title,
-			description: `${name} - ${iso8601}`,
+			description: `${name} - ${toISODate(date)}`,
 			date,
 			products: [{ collection: "products", id: product }],
 			link: `/${entry.id}/`,
@@ -66,8 +97,7 @@ export async function getChangelogs({
 
 	const ddosHttp = await getCollection("docs", (e) => {
 		return (
-			e.id.startsWith("ddos-protection/change-log/http/") &&
-			e.data.pcx_content_type === "changelog"
+			e.id.startsWith("ddos-protection/change-log/http/") && e.data.changelog
 		);
 	});
 
@@ -83,8 +113,7 @@ export async function getChangelogs({
 
 	const ddosNetwork = await getCollection("docs", (e) => {
 		return (
-			e.id.startsWith("ddos-protection/change-log/network/") &&
-			e.data.pcx_content_type === "changelog"
+			e.id.startsWith("ddos-protection/change-log/network/") && e.data.changelog
 		);
 	});
 
@@ -99,16 +128,12 @@ export async function getChangelogs({
 		.forEach((e) => entries.push(e));
 
 	const waf = await getCollection("docs", (e) => {
-		return (
-			e.id.startsWith("waf/change-log/") &&
-			e.data.pcx_content_type === "changelog"
-		);
+		return e.id.startsWith("waf/change-log/") && e.data.changelog;
 	});
 
 	waf
 		.map((e) =>
 			docsToChangelog({
-				name: "WAF",
 				product: "waf",
 				entry: e,
 			}),
@@ -136,41 +161,51 @@ type GetRSSItemsOptions = {
 	locals: App.Locals;
 	/**
 	 * Returns Markdown in the `<content:encoded>` field instead of HTML.
-	 * Markdown will contain `\n` in the output, as fast-xml-parser outputs
-	 * single-line strings.
-	 *
-	 * @example
-	 * # heading\n\ntext\ntext
 	 */
 	markdown?: boolean;
+	/**
+	 * Creates items in the same way as historic changelogs. The behaviour of
+	 * this option should not be changed, all improvements should be made
+	 * to the normal RSS feeds.
+	 *
+	 * The differences between normal items and legacy items are:
+	 *
+	 * - HTML is not filtered by our `filter-elements` plugin.
+	 * - HTML is in the `description` element rather than `content:encoded`.
+	 * - Only the first product can be shown in the title and the custom `<product>` element.
+	 */
+	legacy?: boolean;
 };
 
 export async function getRSSItems({
 	notes,
 	locals,
 	markdown,
+	legacy,
 }: GetRSSItemsOptions): Promise<Array<RSSFeedItem>> {
 	return await Promise.all(
 		notes.map(async (note) => {
 			const { title, description, date, products, link } = note.data;
 
 			const productEntries = await getEntries(products);
-			const productTitles = productEntries.map((p) => p.data.name);
+			const productTitles = productEntries.map((p) => p.data.name as string);
 
 			const html = await entryToString(note, locals);
 
-			let plugins: PluggableList = [
-				rehypeParse,
-				rehypeBaseUrl,
-				rehypeFilterElements,
-			];
+			const plugins: PluggableList = [rehypeParse, rehypeBaseUrl];
+
+			if (!legacy) {
+				plugins.push(...[rehypeFilterElements]);
+			}
 
 			if (markdown) {
-				plugins = plugins.concat([rehypeRemark, remarkGfm, remarkStringify]);
+				plugins.push(...[rehypeRemark, remarkGfm, remarkStringify]);
 			} else {
-				plugins = plugins.concat([rehypeStringify]);
+				plugins.push(...[rehypeStringify]);
 			}
 
+			console.log(plugins);
+
 			const file = await unified()
 				.data("settings", {
 					fragment: true,
@@ -180,6 +215,19 @@ export async function getRSSItems({
 
 			const content = String(file).trim();
 
+			if (legacy) {
+				// Only a single product title is supported in legacy items.
+				const productTitle = productTitles.at(0);
+
+				return {
+					title: `${productTitle} - ${title}`,
+					description: content,
+					pubDate: date,
+					link,
+					customData: `<product>${productTitle}</product>`,
+				};
+			}
+
 			return {
 				title: `${productTitles.join(", ")} - ${title}`,
 				description,