mirror of
https://github.com/gethomepage/homepage.git
synced 2026-09-23 04:25:51 -07:00
Compare commits
7 Commits
dev
..
feature/feeds
| Author | SHA1 | Date | |
|---|---|---|---|
| df52670871 | |||
| 3b26d0d3f6 | |||
| 76ad5d03cc | |||
| 9c3544eeef | |||
| e031209d68 | |||
| 802201d2a9 | |||
| 8619f93ab4 |
@@ -39,6 +39,7 @@
|
||||
"react-i18next": "^17.0.12",
|
||||
"react-icons": "^5.6.0",
|
||||
"recharts": "^3.1.2",
|
||||
"sax": "^1.6.1",
|
||||
"swr": "^2.5.1",
|
||||
"systeminformation": "^5.33.1",
|
||||
"tough-cookie": "^6.0.2",
|
||||
|
||||
Generated
+3
@@ -83,6 +83,9 @@ importers:
|
||||
recharts:
|
||||
specifier: ^3.1.2
|
||||
version: 3.10.1(@types/react@19.2.18)(react-dom@19.2.8(react@19.2.8))(react-is@17.0.2)(react@19.2.8)(redux@5.0.1)
|
||||
sax:
|
||||
specifier: ^1.6.1
|
||||
version: 1.6.1
|
||||
swr:
|
||||
specifier: ^2.5.1
|
||||
version: 2.5.1(react@19.2.8)
|
||||
|
||||
@@ -1258,5 +1258,8 @@
|
||||
"wanted": "Wanted",
|
||||
"queued": "Queued",
|
||||
"leagues": "Leagues"
|
||||
},
|
||||
"feed": {
|
||||
"noItems": "No items"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -353,6 +353,9 @@ export function cleanServiceGroups(groups) {
|
||||
expandOneStreamToTwoRows,
|
||||
showEpisodeNumber,
|
||||
|
||||
// feed
|
||||
layout,
|
||||
|
||||
// frigate
|
||||
enableRecentEvents,
|
||||
|
||||
@@ -675,6 +678,9 @@ export function cleanServiceGroups(groups) {
|
||||
if (showTime) widget.showTime = showTime;
|
||||
if (timezone) widget.timezone = timezone;
|
||||
}
|
||||
if (type === "feed") {
|
||||
if (layout) widget.layout = layout;
|
||||
}
|
||||
if (type === "dockhand") {
|
||||
if (environment) widget.environment = environment;
|
||||
}
|
||||
|
||||
@@ -37,6 +37,7 @@ const components = {
|
||||
emby: dynamic(() => import("./emby/component")),
|
||||
esphome: dynamic(() => import("./esphome/component")),
|
||||
evcc: dynamic(() => import("./evcc/component")),
|
||||
feed: dynamic(() => import("./feed/component")),
|
||||
filebrowser: dynamic(() => import("./filebrowser/component")),
|
||||
fileflows: dynamic(() => import("./fileflows/component")),
|
||||
firefly: dynamic(() => import("./firefly/component")),
|
||||
|
||||
@@ -0,0 +1,125 @@
|
||||
/* eslint-disable @next/next/no-img-element */
|
||||
import classNames from "classnames";
|
||||
import { useTranslation } from "next-i18next/pages";
|
||||
import { useContext } from "react";
|
||||
|
||||
import Container from "components/services/widget/container";
|
||||
import { SettingsContext } from "utils/contexts/settings";
|
||||
import useWidgetAPI from "utils/proxy/use-widget-api";
|
||||
|
||||
const rowClassName = "rounded-md bg-theme-200/50 dark:bg-theme-900/20 text-theme-700 dark:text-theme-200 text-xs";
|
||||
const hideBrokenImage = (e) => {
|
||||
e.currentTarget.style.visibility = "hidden";
|
||||
};
|
||||
|
||||
function FeedLink({ item, target, className, children }) {
|
||||
if (!item.link) return <div className={className}>{children}</div>;
|
||||
return (
|
||||
<a
|
||||
href={item.link}
|
||||
target={target}
|
||||
rel="noopener noreferrer"
|
||||
className={classNames(className, "hover:bg-theme-300/50 dark:hover:bg-theme-800/20")}
|
||||
>
|
||||
{children}
|
||||
</a>
|
||||
);
|
||||
}
|
||||
|
||||
function RelativeDate({ date }) {
|
||||
const { t } = useTranslation();
|
||||
if (!date) return null;
|
||||
return (
|
||||
<span className="shrink-0 text-theme-500 dark:text-theme-400">
|
||||
{t("common.relativeDate", { value: date, formatParams: { value: { style: "narrow", numeric: "auto" } } })}
|
||||
</span>
|
||||
);
|
||||
}
|
||||
|
||||
function ListItem({ item, target }) {
|
||||
return (
|
||||
<FeedLink
|
||||
item={item}
|
||||
target={target}
|
||||
className={classNames(rowClassName, "flex items-center gap-2 px-2", item.image ? "py-1" : "h-5")}
|
||||
>
|
||||
{item.image && (
|
||||
<img
|
||||
src={item.image}
|
||||
alt=""
|
||||
loading="lazy"
|
||||
decoding="async"
|
||||
referrerPolicy="no-referrer"
|
||||
onError={hideBrokenImage}
|
||||
className="w-12 h-8 shrink-0 rounded-sm object-cover"
|
||||
/>
|
||||
)}
|
||||
<span className="grow truncate text-left">{item.title}</span>
|
||||
<RelativeDate date={item.date} />
|
||||
</FeedLink>
|
||||
);
|
||||
}
|
||||
|
||||
function GridItem({ item, target }) {
|
||||
return (
|
||||
<FeedLink item={item} target={target} className={classNames(rowClassName, "flex flex-col overflow-hidden")}>
|
||||
<div className="relative aspect-video w-full overflow-hidden bg-theme-200/50 dark:bg-theme-900/30">
|
||||
{item.image && (
|
||||
<img
|
||||
src={item.image}
|
||||
alt=""
|
||||
loading="lazy"
|
||||
decoding="async"
|
||||
referrerPolicy="no-referrer"
|
||||
onError={hideBrokenImage}
|
||||
className="absolute inset-0 w-full h-full object-cover"
|
||||
/>
|
||||
)}
|
||||
</div>
|
||||
<div className="flex flex-col gap-0.5 px-2 py-1.5 text-left">
|
||||
<span className="line-clamp-2">{item.title}</span>
|
||||
<RelativeDate date={item.date} />
|
||||
</div>
|
||||
</FeedLink>
|
||||
);
|
||||
}
|
||||
|
||||
export default function Component({ service }) {
|
||||
const { t } = useTranslation();
|
||||
const { settings } = useContext(SettingsContext);
|
||||
const { widget } = service;
|
||||
|
||||
const { data, error } = useWidgetAPI(widget, undefined, undefined, { refreshInterval: 10 * 60 * 1000 });
|
||||
|
||||
if (error) {
|
||||
return <Container service={service} error={error} />;
|
||||
}
|
||||
|
||||
const target = service.target ?? settings?.target ?? "_blank";
|
||||
const isGrid = widget.layout === "grid";
|
||||
const Item = isGrid ? GridItem : ListItem;
|
||||
|
||||
let content;
|
||||
if (!data) {
|
||||
content = [0, 1, 2].map((i) => (
|
||||
<div key={i} className={classNames(rowClassName, "animate-pulse", isGrid ? "aspect-video" : "h-5")} />
|
||||
));
|
||||
} else if (!data.items?.length) {
|
||||
content = <div className={classNames(rowClassName, "h-5 px-2 flex items-center")}>{t("feed.noItems")}</div>;
|
||||
} else {
|
||||
content = data.items.map((item, i) => <Item key={`${item.link ?? item.title}-${i}`} item={item} target={target} />);
|
||||
}
|
||||
|
||||
return (
|
||||
<Container service={service}>
|
||||
<div
|
||||
className={classNames(
|
||||
"w-full p-1",
|
||||
isGrid ? "grid grid-cols-[repeat(auto-fill,minmax(8rem,1fr))] gap-2" : "flex flex-col gap-1",
|
||||
)}
|
||||
>
|
||||
{content}
|
||||
</div>
|
||||
</Container>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
// @vitest-environment jsdom
|
||||
|
||||
import { screen } from "@testing-library/react";
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
import { renderWithProviders } from "test-utils/render-with-providers";
|
||||
|
||||
const { useWidgetAPI } = vi.hoisted(() => ({ useWidgetAPI: vi.fn() }));
|
||||
vi.mock("utils/proxy/use-widget-api", () => ({ default: useWidgetAPI }));
|
||||
|
||||
import Component from "./component";
|
||||
|
||||
const items = [
|
||||
{
|
||||
title: "With image",
|
||||
link: "https://example.com/1",
|
||||
date: "2020-01-01T00:00:00Z",
|
||||
image: "https://example.com/1.jpg",
|
||||
},
|
||||
{ title: "No link", link: null, date: null },
|
||||
];
|
||||
|
||||
function render(widget = {}, settings = {}) {
|
||||
return renderWithProviders(<Component service={{ widget: { type: "feed", ...widget } }} />, {
|
||||
settings: { hideErrors: false, ...settings },
|
||||
});
|
||||
}
|
||||
|
||||
describe("widgets/feed/component", () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
it("renders placeholders while loading", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: undefined, error: undefined });
|
||||
const { container } = render();
|
||||
expect(container.querySelectorAll(".animate-pulse")).toHaveLength(3);
|
||||
});
|
||||
|
||||
it("renders an error", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: undefined, error: { message: "Invalid feed" } });
|
||||
render();
|
||||
expect(screen.getAllByText(/Invalid feed/).length).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
it("renders an empty feed", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: { items: [] }, error: undefined });
|
||||
render();
|
||||
expect(screen.getByText("feed.noItems")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders list items with links and images", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: { items }, error: undefined });
|
||||
const { container } = render({}, { target: "_self" });
|
||||
|
||||
const link = screen.getByText("With image").closest("a");
|
||||
expect(link).toHaveAttribute("href", "https://example.com/1");
|
||||
expect(link).toHaveAttribute("target", "_self");
|
||||
expect(link.querySelector("img")).toHaveAttribute("src", "https://example.com/1.jpg");
|
||||
expect(screen.getByText("No link").closest("a")).toBeNull();
|
||||
expect(container.querySelectorAll("img")).toHaveLength(1);
|
||||
});
|
||||
|
||||
it("renders the grid layout with image placeholders", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: { items }, error: undefined });
|
||||
const { container } = render({ layout: "grid" });
|
||||
|
||||
expect(container.querySelector(".grid")).not.toBeNull();
|
||||
expect(container.querySelectorAll(".aspect-video")).toHaveLength(2);
|
||||
expect(container.querySelectorAll("img")).toHaveLength(1);
|
||||
});
|
||||
|
||||
it("hides images that fail to load", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: { items }, error: undefined });
|
||||
const { container } = render();
|
||||
const img = container.querySelector("img");
|
||||
img.dispatchEvent(new Event("error"));
|
||||
expect(img.style.visibility).toBe("hidden");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,61 @@
|
||||
import cache from "memory-cache";
|
||||
|
||||
import { parseFeed } from "./utils";
|
||||
|
||||
import getServiceWidget from "utils/config/service-helpers";
|
||||
import createLogger from "utils/logger";
|
||||
import { sanitizeErrorURL } from "utils/proxy/api-helpers";
|
||||
import { httpProxy } from "utils/proxy/http";
|
||||
|
||||
const logger = createLogger("feedProxyHandler");
|
||||
const CACHE_MS = 10 * 60 * 1000;
|
||||
|
||||
export default async function feedProxyHandler(req, res) {
|
||||
const { group, service, index } = req.query;
|
||||
const widget = await getServiceWidget(group, service, index);
|
||||
|
||||
if (!widget?.url) {
|
||||
return res.status(400).json({ error: "Missing feed URL" });
|
||||
}
|
||||
|
||||
let url;
|
||||
try {
|
||||
url = new URL(widget.url);
|
||||
} catch {
|
||||
return res.status(400).json({ error: "Invalid feed URL" });
|
||||
}
|
||||
|
||||
const cacheKey = `feed:${url.href}`;
|
||||
let items = cache.get(cacheKey);
|
||||
|
||||
if (!items) {
|
||||
const [status, , data] = await httpProxy(url, {
|
||||
headers: {
|
||||
"User-Agent": `gethomepage/${process.env.NEXT_PUBLIC_VERSION || "dev"}`,
|
||||
Accept: "application/rss+xml, application/atom+xml, application/xml;q=0.9, text/xml;q=0.9, */*;q=0.8",
|
||||
},
|
||||
});
|
||||
|
||||
if (status !== 200) {
|
||||
logger.debug("HTTP %d retrieving feed %s//%s%s", status, url.protocol, url.host, url.pathname);
|
||||
return res.status(status).json({ error: { message: "HTTP Error", url: sanitizeErrorURL(url) } });
|
||||
}
|
||||
|
||||
try {
|
||||
items = parseFeed(Buffer.from(data).toString(), url.href);
|
||||
} catch (e) {
|
||||
logger.debug("Error parsing feed %s//%s%s: %s", url.protocol, url.host, url.pathname, e.message);
|
||||
return res.status(500).json({ error: { message: "Invalid feed", url: sanitizeErrorURL(url) } });
|
||||
}
|
||||
|
||||
// only successful fetches are cached
|
||||
cache.put(cacheKey, items, CACHE_MS);
|
||||
}
|
||||
|
||||
const maxItems = parseInt(widget.maxItems, 10) || 5;
|
||||
const showImages = widget.images !== false && widget.images !== "false";
|
||||
|
||||
return res.status(200).json({
|
||||
items: items.slice(0, maxItems).map(({ image, ...item }) => (showImages && image ? { ...item, image } : item)),
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,148 @@
|
||||
import cache from "memory-cache";
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
import createMockRes from "test-utils/create-mock-res";
|
||||
|
||||
const { httpProxy, getServiceWidget, logger } = vi.hoisted(() => ({
|
||||
httpProxy: vi.fn(),
|
||||
getServiceWidget: vi.fn(),
|
||||
logger: {
|
||||
debug: vi.fn(),
|
||||
},
|
||||
}));
|
||||
|
||||
vi.mock("utils/logger", () => ({
|
||||
default: () => logger,
|
||||
}));
|
||||
|
||||
vi.mock("utils/config/service-helpers", () => ({
|
||||
default: getServiceWidget,
|
||||
}));
|
||||
|
||||
vi.mock("utils/proxy/http", () => ({
|
||||
httpProxy,
|
||||
}));
|
||||
|
||||
import feedProxyHandler from "./proxy";
|
||||
|
||||
const items = Array.from(
|
||||
{ length: 7 },
|
||||
(_, i) => `<item><title>Item ${i}</title><link>https://example.com/${i}</link>
|
||||
<media:thumbnail url="https://example.com/${i}.jpg" /></item>`,
|
||||
).join("");
|
||||
const feed = `<rss xmlns:media="http://search.yahoo.com/mrss/"><channel>${items}</channel></rss>`;
|
||||
|
||||
const req = { query: { group: "g", service: "svc", index: "0" } };
|
||||
|
||||
describe("widgets/feed/proxy", () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
cache.clear();
|
||||
});
|
||||
|
||||
it("returns 400 when the url is missing or invalid", async () => {
|
||||
getServiceWidget.mockResolvedValueOnce({ type: "feed" });
|
||||
let res = createMockRes();
|
||||
await feedProxyHandler(req, res);
|
||||
expect(res.statusCode).toBe(400);
|
||||
expect(res.body).toEqual({ error: "Missing feed URL" });
|
||||
|
||||
getServiceWidget.mockResolvedValueOnce({ type: "feed", url: "nope" });
|
||||
res = createMockRes();
|
||||
await feedProxyHandler(req, res);
|
||||
expect(res.statusCode).toBe(400);
|
||||
expect(res.body).toEqual({ error: "Invalid feed URL" });
|
||||
expect(httpProxy).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("returns the first 5 items by default", async () => {
|
||||
getServiceWidget.mockResolvedValue({ type: "feed", url: "https://example.com/feed.xml" });
|
||||
httpProxy.mockResolvedValueOnce([200, "application/rss+xml", Buffer.from(feed)]);
|
||||
|
||||
const res = createMockRes();
|
||||
await feedProxyHandler(req, res);
|
||||
|
||||
expect(httpProxy.mock.calls[0][0].href).toBe("https://example.com/feed.xml");
|
||||
expect(res.statusCode).toBe(200);
|
||||
expect(res.body.items).toHaveLength(5);
|
||||
expect(res.body.items[0]).toEqual({
|
||||
title: "Item 0",
|
||||
link: "https://example.com/0",
|
||||
date: null,
|
||||
image: "https://example.com/0.jpg",
|
||||
});
|
||||
});
|
||||
|
||||
it("respects maxItems and drops images when disabled", async () => {
|
||||
getServiceWidget.mockResolvedValue({
|
||||
type: "feed",
|
||||
url: "https://example.com/feed.xml",
|
||||
maxItems: "2",
|
||||
images: false,
|
||||
});
|
||||
httpProxy.mockResolvedValueOnce([200, "application/rss+xml", Buffer.from(feed)]);
|
||||
|
||||
const res = createMockRes();
|
||||
await feedProxyHandler(req, res);
|
||||
|
||||
expect(res.body.items).toEqual([
|
||||
{ title: "Item 0", link: "https://example.com/0", date: null },
|
||||
{ title: "Item 1", link: "https://example.com/1", date: null },
|
||||
]);
|
||||
});
|
||||
|
||||
it("passes through http errors without leaking the url", async () => {
|
||||
getServiceWidget.mockResolvedValue({ type: "feed", url: "https://example.com/feed.xml?token=secret" });
|
||||
httpProxy.mockResolvedValueOnce([404, "text/html", Buffer.from("Not found")]);
|
||||
|
||||
const res = createMockRes();
|
||||
await feedProxyHandler(req, res);
|
||||
|
||||
expect(res.statusCode).toBe(404);
|
||||
expect(res.body).toEqual({ error: { message: "HTTP Error", url: "example.com (see logs for details)" } });
|
||||
});
|
||||
|
||||
it("returns 500 for unparseable feeds", async () => {
|
||||
getServiceWidget.mockResolvedValue({ type: "feed", url: "https://example.com/feed.xml" });
|
||||
httpProxy.mockResolvedValueOnce([200, "text/html", Buffer.from("<html></html>")]);
|
||||
|
||||
const res = createMockRes();
|
||||
await feedProxyHandler(req, res);
|
||||
|
||||
expect(res.statusCode).toBe(500);
|
||||
expect(res.body).toEqual({ error: { message: "Invalid feed", url: "example.com (see logs for details)" } });
|
||||
});
|
||||
|
||||
it("shares one cached fetch across widgets with different options", async () => {
|
||||
getServiceWidget
|
||||
.mockResolvedValueOnce({ type: "feed", url: "https://example.com/feed.xml", maxItems: 1 })
|
||||
.mockResolvedValueOnce({ type: "feed", url: "https://example.com/feed.xml", images: false });
|
||||
httpProxy.mockResolvedValue([200, "application/rss+xml", Buffer.from(feed)]);
|
||||
|
||||
const first = createMockRes();
|
||||
await feedProxyHandler(req, first);
|
||||
const second = createMockRes();
|
||||
await feedProxyHandler(req, second);
|
||||
|
||||
expect(httpProxy).toHaveBeenCalledTimes(1);
|
||||
expect(first.body.items).toHaveLength(1);
|
||||
expect(second.body.items).toHaveLength(5);
|
||||
expect(second.body.items[0].image).toBeUndefined();
|
||||
});
|
||||
|
||||
it("does not cache failures", async () => {
|
||||
getServiceWidget.mockResolvedValue({ type: "feed", url: "https://example.com/feed.xml" });
|
||||
httpProxy
|
||||
.mockResolvedValueOnce([404, "text/html", Buffer.from("Not found")])
|
||||
.mockResolvedValueOnce([200, "application/rss+xml", Buffer.from(feed)]);
|
||||
|
||||
const failed = createMockRes();
|
||||
await feedProxyHandler(req, failed);
|
||||
const recovered = createMockRes();
|
||||
await feedProxyHandler(req, recovered);
|
||||
|
||||
expect(failed.statusCode).toBe(404);
|
||||
expect(recovered.statusCode).toBe(200);
|
||||
expect(httpProxy).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,104 @@
|
||||
import sax from "sax";
|
||||
import { xml2js } from "xml-js";
|
||||
|
||||
const asArray = (value) => (value === undefined || value === null ? [] : [].concat(value));
|
||||
|
||||
function getText(node) {
|
||||
const first = asArray(node)[0];
|
||||
if (first === undefined) return "";
|
||||
if (typeof first !== "object") return String(first);
|
||||
return asArray(first._cdata ?? first._text).join("");
|
||||
}
|
||||
|
||||
export function httpUrl(value, baseUrl) {
|
||||
if (!value) return null;
|
||||
try {
|
||||
const url = new URL(value.trim(), baseUrl);
|
||||
return ["http:", "https:"].includes(url.protocol) ? url.href : null;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
function parseDate(value) {
|
||||
const time = Date.parse(value);
|
||||
return Number.isNaN(time) ? null : new Date(time).toISOString();
|
||||
}
|
||||
|
||||
const attrs = (node) => node?._attributes ?? {};
|
||||
const isImage = (node) => attrs(node).medium === "image" || attrs(node).type?.startsWith("image/");
|
||||
|
||||
function findImage(item) {
|
||||
const groups = [item, ...asArray(item["media:group"])];
|
||||
const candidates = [
|
||||
...groups.flatMap((group) => asArray(group["media:thumbnail"])),
|
||||
...groups.flatMap((group) => asArray(group["media:content"])).filter(isImage),
|
||||
...asArray(item.enclosure).filter(isImage),
|
||||
...asArray(item.link).filter((link) => attrs(link).rel === "enclosure" && isImage(link)),
|
||||
];
|
||||
const image = candidates.find((node) => attrs(node).url || attrs(node).href);
|
||||
return image ? attrs(image).url || attrs(image).href : null;
|
||||
}
|
||||
|
||||
const isPixel = ({ width, height }) => ["0", "1"].includes(width) || ["0", "1"].includes(height);
|
||||
|
||||
// first usable <img> in item html using sax tokenizer
|
||||
function findHtmlImage(htmls, baseUrl) {
|
||||
for (const html of htmls) {
|
||||
if (!html) continue;
|
||||
let image = null;
|
||||
const parser = sax.parser(false, { lowercase: true });
|
||||
parser.onopentag = ({ name, attributes }) => {
|
||||
if (!image && name === "img" && !isPixel(attributes)) image = httpUrl(attributes.src, baseUrl);
|
||||
};
|
||||
parser.onerror = () => {
|
||||
parser.error = null;
|
||||
parser.resume();
|
||||
};
|
||||
parser.write(html).close();
|
||||
if (image) return image;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function parseRssItem(item) {
|
||||
const guid = asArray(item.guid)[0];
|
||||
const guidLink = attrs(guid).isPermaLink !== "false" ? getText(guid) : null;
|
||||
return {
|
||||
title: getText(item.title),
|
||||
link: getText(item.link) || guidLink,
|
||||
date: getText(item.pubDate) || getText(item["dc:date"]),
|
||||
image: findImage(item),
|
||||
html: [getText(item["content:encoded"]), getText(item.description)],
|
||||
};
|
||||
}
|
||||
|
||||
function parseAtomEntry(entry) {
|
||||
const links = asArray(entry.link);
|
||||
const link = links.find((l) => (attrs(l).rel ?? "alternate") === "alternate") ?? links[0];
|
||||
return {
|
||||
title: getText(entry.title),
|
||||
link: attrs(link).href,
|
||||
date: getText(entry.published) || getText(entry.updated),
|
||||
image: findImage(entry),
|
||||
html: [getText(entry.content), getText(entry.summary)],
|
||||
};
|
||||
}
|
||||
|
||||
export function parseFeed(xml, baseUrl) {
|
||||
const doc = xml2js(xml, { compact: true });
|
||||
|
||||
let items;
|
||||
if (doc.rss) items = asArray(doc.rss.channel?.item).map(parseRssItem);
|
||||
else if (doc.feed) items = asArray(doc.feed.entry).map(parseAtomEntry);
|
||||
else throw new Error("Unsupported feed format");
|
||||
|
||||
return items
|
||||
.map((item) => ({
|
||||
title: item.title.trim(),
|
||||
link: httpUrl(item.link, baseUrl),
|
||||
date: parseDate(item.date),
|
||||
image: httpUrl(item.image, baseUrl) ?? findHtmlImage(item.html, baseUrl),
|
||||
}))
|
||||
.filter((item) => item.title);
|
||||
}
|
||||
@@ -0,0 +1,153 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
|
||||
import { httpUrl, parseFeed } from "./utils";
|
||||
|
||||
const rss = `<?xml version="1.0"?>
|
||||
<rss version="2.0" xmlns:media="http://search.yahoo.com/mrss/" xmlns:dc="http://purl.org/dc/elements/1.1/">
|
||||
<channel>
|
||||
<title>Example</title>
|
||||
<item>
|
||||
<title><![CDATA[Tom & Jerry]]></title>
|
||||
<link>https://example.com/one</link>
|
||||
<pubDate>Tue, 22 Sep 2026 10:00:00 GMT</pubDate>
|
||||
<media:thumbnail url="https://img.example.com/one.jpg" />
|
||||
</item>
|
||||
<item>
|
||||
<title>Enclosure image</title>
|
||||
<guid>https://example.com/two</guid>
|
||||
<dc:date>2026-09-21T10:00:00Z</dc:date>
|
||||
<enclosure url="/two.png" type="image/png" length="1" />
|
||||
</item>
|
||||
<item>
|
||||
<title>Audio only</title>
|
||||
<link>javascript:alert(1)</link>
|
||||
<guid isPermaLink="false">abc-123</guid>
|
||||
<enclosure url="https://example.com/three.mp3" type="audio/mpeg" length="1" />
|
||||
</item>
|
||||
<item>
|
||||
<description>No title, skipped</description>
|
||||
</item>
|
||||
</channel>
|
||||
</rss>`;
|
||||
|
||||
const atom = `<?xml version="1.0" encoding="utf-8"?>
|
||||
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:media="http://search.yahoo.com/mrss/">
|
||||
<title>Example</title>
|
||||
<entry>
|
||||
<title> Fish & chips
|
||||
</title>
|
||||
<link rel="enclosure" type="image/jpeg" href="https://example.com/one.jpg" />
|
||||
<link rel="alternate" href="https://example.com/one" />
|
||||
<updated>2026-09-22T12:00:00Z</updated>
|
||||
</entry>
|
||||
<entry>
|
||||
<title>YouTube style</title>
|
||||
<link href="https://example.com/two" />
|
||||
<published>2026-09-20T12:00:00Z</published>
|
||||
<updated>not a date</updated>
|
||||
<media:group>
|
||||
<media:content url="https://example.com/two.mp4" type="video/mp4" />
|
||||
<media:thumbnail url="https://example.com/two.jpg" />
|
||||
</media:group>
|
||||
</entry>
|
||||
</feed>`;
|
||||
|
||||
describe("widgets/feed/utils", () => {
|
||||
it("parses rss 2.0 items", () => {
|
||||
expect(parseFeed(rss, "https://example.com/feed.xml")).toEqual([
|
||||
{
|
||||
title: "Tom & Jerry",
|
||||
link: "https://example.com/one",
|
||||
date: "2026-09-22T10:00:00.000Z",
|
||||
image: "https://img.example.com/one.jpg",
|
||||
},
|
||||
{
|
||||
title: "Enclosure image",
|
||||
link: "https://example.com/two",
|
||||
date: "2026-09-21T10:00:00.000Z",
|
||||
image: "https://example.com/two.png",
|
||||
},
|
||||
{ title: "Audio only", link: null, date: null, image: null },
|
||||
]);
|
||||
});
|
||||
|
||||
it("parses atom entries", () => {
|
||||
expect(parseFeed(atom, "https://example.com/atom.xml")).toEqual([
|
||||
{
|
||||
title: "Fish & chips",
|
||||
link: "https://example.com/one",
|
||||
date: "2026-09-22T12:00:00.000Z",
|
||||
image: "https://example.com/one.jpg",
|
||||
},
|
||||
{
|
||||
title: "YouTube style",
|
||||
link: "https://example.com/two",
|
||||
date: "2026-09-20T12:00:00.000Z",
|
||||
image: "https://example.com/two.jpg",
|
||||
},
|
||||
]);
|
||||
});
|
||||
|
||||
it("falls back to the first usable image in item html", () => {
|
||||
const xml = `<rss xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:media="http://search.yahoo.com/mrss/"><channel>
|
||||
<item>
|
||||
<title>Content image</title>
|
||||
<content:encoded><![CDATA[<p>Hi <img src="https://t.example.com/p.gif" width="1" height="1">
|
||||
<img src="data:image/gif;base64,R0"><IMG SRC="/big.jpg?w=925&h=925"><img src="/second.jpg">]]></content:encoded>
|
||||
</item>
|
||||
<item>
|
||||
<title>Description image</title>
|
||||
<description><img src="https://example.com/desc.png"> unclosed <b></description>
|
||||
</item>
|
||||
<item>
|
||||
<title>Media wins</title>
|
||||
<media:thumbnail url="https://example.com/thumb.jpg" />
|
||||
<description><![CDATA[<img src="https://example.com/html.jpg">]]></description>
|
||||
</item>
|
||||
<item>
|
||||
<title>No usable image</title>
|
||||
<description><![CDATA[<img src="javascript:alert(1)"><img>]]></description>
|
||||
</item>
|
||||
</channel></rss>`;
|
||||
|
||||
expect(parseFeed(xml, "https://example.com/feed").map((item) => item.image)).toEqual([
|
||||
"https://example.com/big.jpg?w=925&h=925",
|
||||
"https://example.com/desc.png",
|
||||
"https://example.com/thumb.jpg",
|
||||
null,
|
||||
]);
|
||||
});
|
||||
|
||||
it("finds images in atom html content and summary", () => {
|
||||
const xml = `<feed xmlns="http://www.w3.org/2005/Atom">
|
||||
<entry><title>Content</title><content type="html"><img src="https://example.com/c.jpg"></content></entry>
|
||||
<entry><title>Summary</title><summary type="html"><img src="https://example.com/s.jpg"></summary></entry>
|
||||
</feed>`;
|
||||
|
||||
expect(parseFeed(xml).map((item) => item.image)).toEqual([
|
||||
"https://example.com/c.jpg",
|
||||
"https://example.com/s.jpg",
|
||||
]);
|
||||
});
|
||||
|
||||
it("handles single-item and empty feeds", () => {
|
||||
const single = "<rss><channel><item><title>Only</title></item></channel></rss>";
|
||||
expect(parseFeed(single)).toEqual([{ title: "Only", link: null, date: null, image: null }]);
|
||||
expect(parseFeed("<feed></feed>")).toEqual([]);
|
||||
});
|
||||
|
||||
it("rejects unsupported documents", () => {
|
||||
expect(() => parseFeed("<html><body>nope</body></html>")).toThrow("Unsupported feed format");
|
||||
expect(() => parseFeed("not xml <")).toThrow();
|
||||
});
|
||||
|
||||
it.each([
|
||||
["https://a.com/x", undefined, "https://a.com/x"],
|
||||
["/x", "https://a.com/feed", "https://a.com/x"],
|
||||
["data:image/png;base64,AAAA", undefined, null],
|
||||
["not a url", undefined, null],
|
||||
["", undefined, null],
|
||||
])("httpUrl(%j, %j) is %j", (value, base, expected) => {
|
||||
expect(httpUrl(value, base)).toBe(expected);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,8 @@
|
||||
import feedProxyHandler from "./proxy";
|
||||
|
||||
const widget = {
|
||||
api: "{url}",
|
||||
proxyHandler: feedProxyHandler,
|
||||
};
|
||||
|
||||
export default widget;
|
||||
@@ -0,0 +1,12 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
|
||||
import { expectWidgetConfigShape } from "test-utils/widget-config";
|
||||
|
||||
import widget from "./widget";
|
||||
|
||||
describe("feed widget config", () => {
|
||||
it("exports a valid widget config", () => {
|
||||
expectWidgetConfigShape(widget);
|
||||
expect(widget.api).toBe("{url}");
|
||||
});
|
||||
});
|
||||
@@ -31,6 +31,7 @@ import duplicati from "./duplicati/widget";
|
||||
import emby from "./emby/widget";
|
||||
import esphome from "./esphome/widget";
|
||||
import evcc from "./evcc/widget";
|
||||
import feed from "./feed/widget";
|
||||
import filebrowser from "./filebrowser/widget";
|
||||
import fileflows from "./fileflows/widget";
|
||||
import firefly from "./firefly/widget";
|
||||
@@ -191,6 +192,7 @@ const widgets = {
|
||||
emby,
|
||||
esphome,
|
||||
evcc,
|
||||
feed,
|
||||
filebrowser,
|
||||
fileflows,
|
||||
firefly,
|
||||
|
||||
Reference in New Issue
Block a user