mirror of
https://github.com/gethomepage/homepage.git
synced 2026-09-26 05:51:17 -07:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 dosubot[bot]
|
612d21f093 |
Binary file not shown.
|
Before Width: | Height: | Size: 794 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 221 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 337 KiB |
@@ -1,46 +0,0 @@
|
||||
---
|
||||
title: Feed
|
||||
description: RSS / Atom feed widget
|
||||
---
|
||||
|
||||
This widget shows the latest items from an RSS 2.0 or Atom feed.
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: feed
|
||||
url: https://feeds.bbci.co.uk/news/rss.xml
|
||||
maxItems: 5 # optional - defaults to 5
|
||||
layout: list # optional - possible values list, grid - defaults to list
|
||||
images: true # optional - set to false to hide images - defaults to true
|
||||
```
|
||||
|
||||
## Layouts
|
||||
|
||||
`list` shows one row per item. Items with an image get a small thumbnail.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
`grid` shows image tiles that re-flow to fit the width of the widget, e.g.:
|
||||
|
||||
```yaml
|
||||
- NASA Image of the Day:
|
||||
widget:
|
||||
type: feed
|
||||
url: https://www.nasa.gov/feeds/iotd-feed/
|
||||
layout: grid
|
||||
maxItems: 8
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Images
|
||||
|
||||
Images are taken from the feed's `media:thumbnail` / `media:content` tags or image enclosures, falling back to the first image in the item's content. Some feeds do not include images at all.
|
||||
|
||||
Images are loaded by your browser directly from the feed's host, at whatever size the feed provides. Feeds that link full-size originals can be slow to load; set `images: false` for those.
|
||||
|
||||
## Notes
|
||||
|
||||
Feeds are fetched by homepage, not your browser, and cached for 10 minutes.
|
||||
@@ -30,6 +30,8 @@ You can also find a list of all available service widgets in the sidebar navigat
|
||||
- [Coin Market Cap](coin-market-cap.md)
|
||||
- [CrowdSec](crowdsec.md)
|
||||
- [Custom API](customapi.md)
|
||||
- [Dashdot](dashdot.md)
|
||||
- [DDNS-Updater](ddns-updater.md)
|
||||
- [Deluge](deluge.md)
|
||||
- [DeveLanCacheUI](develancacheui.md)
|
||||
- [DiskStation](diskstation.md)
|
||||
@@ -39,7 +41,6 @@ You can also find a list of all available service widgets in the sidebar navigat
|
||||
- [Emby](emby.md)
|
||||
- [ESPHome](esphome.md)
|
||||
- [EVCC](evcc.md)
|
||||
- [Feed](feed.md)
|
||||
- [Filebrowser](filebrowser.md)
|
||||
- [Fileflows](fileflows.md)
|
||||
- [Firefly III](firefly.md)
|
||||
@@ -120,7 +121,6 @@ You can also find a list of all available service widgets in the sidebar navigat
|
||||
- [PyLoad](pyload.md)
|
||||
- [qBittorrent](qbittorrent.md)
|
||||
- [QNAP](qnap.md)
|
||||
- [qui](qui.md)
|
||||
- [Radarr](radarr.md)
|
||||
- [Readarr](readarr.md)
|
||||
- [ROMM](romm.md)
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
---
|
||||
title: qui
|
||||
description: qui Widget Configuration
|
||||
---
|
||||
|
||||
Learn more about [qui](https://github.com/autobrr/qui).
|
||||
|
||||
Generate an API key in qui under **Settings → API Keys**.
|
||||
|
||||
The widget has two modes:
|
||||
|
||||
- **Aggregated (default):** omit `instance` to show combined stats across all qBittorrent instances monitored by qui.
|
||||
- **Per-instance:** set `instance` to the qui ID (visible in the qui UI) to show just that one.
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: qui
|
||||
url: http://qui.host.or.ip:7476
|
||||
key: quiapikeyquiapikeyquiapikey
|
||||
instance: 1 # optional; omit for aggregated stats across all instances
|
||||
fields: ["leech", "download", "seed", "upload"] # optional
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
Allowed fields: `["leech", "download", "seed", "upload", "total", "errored", "ratio", "freeSpace"]` (maximum of 4).
|
||||
|
||||
Default fields: `["leech", "download", "seed", "upload"]`.
|
||||
|
||||
Note: `ratio` and `freeSpace` are only available with the 'single instance' version of the widget.
|
||||
@@ -65,7 +65,6 @@ nav:
|
||||
- widgets/services/emby.md
|
||||
- widgets/services/esphome.md
|
||||
- widgets/services/evcc.md
|
||||
- widgets/services/feed.md
|
||||
- widgets/services/filebrowser.md
|
||||
- widgets/services/fileflows.md
|
||||
- widgets/services/firefly.md
|
||||
@@ -149,7 +148,6 @@ nav:
|
||||
- widgets/services/pyload.md
|
||||
- widgets/services/qbittorrent.md
|
||||
- widgets/services/qnap.md
|
||||
- widgets/services/qui.md
|
||||
- widgets/services/radarr.md
|
||||
- widgets/services/readarr.md
|
||||
- widgets/services/romm.md
|
||||
|
||||
@@ -39,7 +39,6 @@
|
||||
"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,9 +83,6 @@ 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)
|
||||
|
||||
@@ -256,16 +256,6 @@
|
||||
"leech": "Leech",
|
||||
"seed": "Seed"
|
||||
},
|
||||
"qui": {
|
||||
"leech": "Leech",
|
||||
"download": "Download",
|
||||
"seed": "Seed",
|
||||
"upload": "Upload",
|
||||
"total": "Total",
|
||||
"errored": "Errored",
|
||||
"ratio": "Ratio",
|
||||
"freeSpace": "Free"
|
||||
},
|
||||
"qnap": {
|
||||
"cpuUsage": "CPU Usage",
|
||||
"memUsage": "MEM Usage",
|
||||
@@ -1268,8 +1258,5 @@
|
||||
"wanted": "Wanted",
|
||||
"queued": "Queued",
|
||||
"leagues": "Leagues"
|
||||
},
|
||||
"feed": {
|
||||
"noItems": "No items"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -353,9 +353,6 @@ export function cleanServiceGroups(groups) {
|
||||
expandOneStreamToTwoRows,
|
||||
showEpisodeNumber,
|
||||
|
||||
// feed
|
||||
layout,
|
||||
|
||||
// frigate
|
||||
enableRecentEvents,
|
||||
|
||||
@@ -433,9 +430,6 @@ export function cleanServiceGroups(groups) {
|
||||
// proxmoxbackupserver
|
||||
datastore,
|
||||
|
||||
// qui
|
||||
instance,
|
||||
|
||||
// speedtest
|
||||
bitratePrecision,
|
||||
|
||||
@@ -546,9 +540,6 @@ export function cleanServiceGroups(groups) {
|
||||
if (type === "portainer") {
|
||||
if (kubernetes) widget.kubernetes = !!JSON.parse(kubernetes);
|
||||
}
|
||||
if (type === "qui") {
|
||||
if (instance !== undefined) widget.instance = instance;
|
||||
}
|
||||
if (type === "proxmox") {
|
||||
if (node) widget.node = node;
|
||||
}
|
||||
@@ -684,9 +675,6 @@ 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;
|
||||
}
|
||||
|
||||
@@ -403,7 +403,6 @@ describe("utils/config/service-helpers", () => {
|
||||
{ type: "radarr", enableQueue: "true" },
|
||||
{ type: "truenas", enablePools: "true", nasType: "scale" },
|
||||
{ type: "qnap", volume: "vol1" },
|
||||
{ type: "qui", instance: 2 },
|
||||
{ type: "dispatcharr", enableActiveStreams: "true" },
|
||||
{ type: "gamedig", gameToken: "t" },
|
||||
{ type: "kopia", snapshotHost: "h", snapshotPath: "/p" },
|
||||
@@ -469,7 +468,6 @@ describe("utils/config/service-helpers", () => {
|
||||
expect.objectContaining({ namespace: "default", app: "app", podSelector: "app=test" }),
|
||||
);
|
||||
expect(widgets.find((w) => w.type === "qnap")).toEqual(expect.objectContaining({ volume: "vol1" }));
|
||||
expect(widgets.find((w) => w.type === "qui")).toEqual(expect.objectContaining({ instance: 2 }));
|
||||
expect(widgets.find((w) => w.type === "speedtest")).toEqual(
|
||||
expect.objectContaining({ bitratePrecision: 3, version: 1 }),
|
||||
);
|
||||
@@ -526,38 +524,6 @@ describe("utils/config/service-helpers", () => {
|
||||
]);
|
||||
});
|
||||
|
||||
it("cleanServiceGroups keeps feed layout and drops server-side options", async () => {
|
||||
const mod = await import("./service-helpers");
|
||||
const { cleanServiceGroups } = mod;
|
||||
|
||||
const rawGroups = [
|
||||
{
|
||||
name: "Core",
|
||||
services: [
|
||||
{
|
||||
name: "News",
|
||||
widgets: [
|
||||
{
|
||||
type: "feed",
|
||||
url: "https://example.com/feed.xml?token=secret",
|
||||
maxItems: 3,
|
||||
images: false,
|
||||
layout: "grid",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
groups: [],
|
||||
},
|
||||
];
|
||||
|
||||
const feedWidget = cleanServiceGroups(rawGroups)[0].services[0].widgets[0];
|
||||
expect(feedWidget).toEqual(expect.objectContaining({ type: "feed", layout: "grid" }));
|
||||
expect(feedWidget).not.toHaveProperty("url");
|
||||
expect(feedWidget).not.toHaveProperty("maxItems");
|
||||
expect(feedWidget).not.toHaveProperty("images");
|
||||
});
|
||||
|
||||
it("findGroupByName deep-searches and annotates parent", async () => {
|
||||
const mod = await import("./service-helpers");
|
||||
const { findGroupByName } = mod;
|
||||
|
||||
@@ -37,7 +37,6 @@ 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")),
|
||||
@@ -123,7 +122,6 @@ const components = {
|
||||
pyload: dynamic(() => import("./pyload/component")),
|
||||
qbittorrent: dynamic(() => import("./qbittorrent/component")),
|
||||
qnap: dynamic(() => import("./qnap/component")),
|
||||
qui: dynamic(() => import("./qui/component")),
|
||||
radarr: dynamic(() => import("./radarr/component")),
|
||||
readarr: dynamic(() => import("./readarr/component")),
|
||||
romm: dynamic(() => import("./romm/component")),
|
||||
|
||||
@@ -1,125 +0,0 @@
|
||||
/* 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>
|
||||
);
|
||||
}
|
||||
@@ -1,80 +0,0 @@
|
||||
// @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");
|
||||
});
|
||||
});
|
||||
@@ -1,61 +0,0 @@
|
||||
import cache from "memory-cache";
|
||||
|
||||
import { httpUrl, 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" });
|
||||
}
|
||||
|
||||
const href = httpUrl(widget.url);
|
||||
if (!href) {
|
||||
return res.status(400).json({ error: "Invalid feed URL" });
|
||||
}
|
||||
const url = new URL(href);
|
||||
|
||||
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());
|
||||
} 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 limit = parseInt(widget.maxItems, 10);
|
||||
const maxItems = limit > 0 ? limit : 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)),
|
||||
});
|
||||
}
|
||||
@@ -1,183 +0,0 @@
|
||||
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" });
|
||||
|
||||
getServiceWidget.mockResolvedValueOnce({ type: "feed", url: "file:///etc/passwd" });
|
||||
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.each([-1, 0, "abc"])("falls back to 5 items for maxItems %j", async (maxItems) => {
|
||||
getServiceWidget.mockResolvedValue({ type: "feed", url: "https://example.com/feed.xml", maxItems });
|
||||
httpProxy.mockResolvedValueOnce([200, "application/rss+xml", Buffer.from(feed)]);
|
||||
|
||||
const res = createMockRes();
|
||||
await feedProxyHandler(req, res);
|
||||
|
||||
expect(res.body.items).toHaveLength(5);
|
||||
});
|
||||
|
||||
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("never includes any part of the configured url in the response", async () => {
|
||||
getServiceWidget.mockResolvedValue({
|
||||
type: "feed",
|
||||
url: "https://user:hunter2@nas.lan/feeds/s3cr3t/rss.xml?token=abc123",
|
||||
});
|
||||
const relative = `<rss><channel>
|
||||
<item><title>Path</title><link>item/1</link><enclosure url="img.jpg" type="image/jpeg" /></item>
|
||||
<item><title>Root</title><link>/x</link></item>
|
||||
<item><title>Fragment</title><link>#top</link></item>
|
||||
</channel></rss>`;
|
||||
httpProxy.mockResolvedValueOnce([200, "application/rss+xml", Buffer.from(relative)]);
|
||||
|
||||
const res = createMockRes();
|
||||
await feedProxyHandler(req, res);
|
||||
|
||||
expect(res.body.items.map((item) => item.link)).toEqual([null, null, null]);
|
||||
expect(JSON.stringify(res.body)).not.toMatch(/user|hunter2|nas\.lan|s3cr3t|token|abc123/);
|
||||
});
|
||||
|
||||
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);
|
||||
});
|
||||
});
|
||||
@@ -1,114 +0,0 @@
|
||||
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) {
|
||||
const trimmed = value?.trim();
|
||||
if (!trimmed) return null;
|
||||
try {
|
||||
const url = new URL(trimmed, 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)],
|
||||
};
|
||||
}
|
||||
|
||||
const alternateLink = (node) => asArray(node.link).find((l) => (attrs(l).rel ?? "alternate") === "alternate");
|
||||
|
||||
function parseAtomEntry(entry) {
|
||||
const link = alternateLink(entry) ?? asArray(entry.link)[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) {
|
||||
const doc = xml2js(xml, { compact: true });
|
||||
|
||||
let items;
|
||||
let site;
|
||||
if (doc.rss) {
|
||||
items = asArray(doc.rss.channel?.item).map(parseRssItem);
|
||||
site = getText(doc.rss.channel?.link);
|
||||
} else if (doc.feed) {
|
||||
items = asArray(doc.feed.entry).map(parseAtomEntry);
|
||||
site = attrs(alternateLink(doc.feed)).href;
|
||||
} else throw new Error("Unsupported feed format");
|
||||
|
||||
// resolve against the feed's own site link, never the configured url
|
||||
const baseUrl = httpUrl(site) ?? undefined;
|
||||
|
||||
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);
|
||||
}
|
||||
@@ -1,169 +0,0 @@
|
||||
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>
|
||||
<link>https://example.com/</link>
|
||||
<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)).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)).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>
|
||||
<link>https://example.com/</link>
|
||||
<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).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("resolves relative urls against the feed's alternate link, never its self link", () => {
|
||||
const entry = `<entry><title>Relative</title><link href="/posts/1" /></entry>`;
|
||||
const selfOnly = `<feed xmlns="http://www.w3.org/2005/Atom">
|
||||
<link rel="self" href="https://example.com/user.private.atom?token=abc123" />${entry}</feed>`;
|
||||
const withSite = `<feed xmlns="http://www.w3.org/2005/Atom">
|
||||
<link rel="self" href="https://example.com/user.private.atom?token=abc123" />
|
||||
<link rel="alternate" href="https://example.com/blog/" />${entry}</feed>`;
|
||||
|
||||
expect(parseFeed(selfOnly)[0].link).toBeNull();
|
||||
expect(parseFeed(withSite)[0].link).toBe("https://example.com/posts/1");
|
||||
});
|
||||
|
||||
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],
|
||||
[" \n ", "https://a.com/feed", null],
|
||||
[" /x ", "https://a.com/feed", "https://a.com/x"],
|
||||
])("httpUrl(%j, %j) is %j", (value, base, expected) => {
|
||||
expect(httpUrl(value, base)).toBe(expected);
|
||||
});
|
||||
});
|
||||
@@ -1,8 +0,0 @@
|
||||
import feedProxyHandler from "./proxy";
|
||||
|
||||
const widget = {
|
||||
api: "{url}",
|
||||
proxyHandler: feedProxyHandler,
|
||||
};
|
||||
|
||||
export default widget;
|
||||
@@ -1,12 +0,0 @@
|
||||
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}");
|
||||
});
|
||||
});
|
||||
@@ -1,77 +0,0 @@
|
||||
import { useTranslation } from "next-i18next/pages";
|
||||
|
||||
import Block from "components/services/widget/block";
|
||||
import Container from "components/services/widget/container";
|
||||
import useWidgetAPI from "utils/proxy/use-widget-api";
|
||||
import withWidgetFields from "utils/widget-fields";
|
||||
|
||||
const DEFAULT_FIELDS = ["leech", "download", "seed", "upload"];
|
||||
|
||||
export default function Component({ service: configuredService }) {
|
||||
const { t } = useTranslation();
|
||||
const service = withWidgetFields(configuredService, DEFAULT_FIELDS);
|
||||
const { widget } = service;
|
||||
|
||||
// A specific instance id selects per-instance stats; otherwise aggregate all instances.
|
||||
const perInstance = widget.instance != null && widget.instance !== "";
|
||||
const mapping = perInstance ? "torrents" : "torrentsAll";
|
||||
const { data: torrentData, error: torrentError } = useWidgetAPI(widget, mapping);
|
||||
|
||||
if (torrentError) {
|
||||
return <Container service={service} error={torrentError} />;
|
||||
}
|
||||
|
||||
if (!torrentData || !torrentData.stats) {
|
||||
return (
|
||||
<Container service={service}>
|
||||
<Block label="qui.leech" />
|
||||
<Block label="qui.download" />
|
||||
<Block label="qui.seed" />
|
||||
<Block label="qui.upload" />
|
||||
<Block label="qui.total" />
|
||||
<Block label="qui.errored" />
|
||||
<Block label="qui.ratio" />
|
||||
<Block label="qui.freeSpace" />
|
||||
</Container>
|
||||
);
|
||||
}
|
||||
|
||||
const { stats } = torrentData;
|
||||
const status = torrentData.counts?.status;
|
||||
const serverState = torrentData.serverState;
|
||||
|
||||
// counts.status uses qBittorrent's sidebar semantics (complete vs incomplete). Seed/Leech show
|
||||
// "active / total" — actively transferring over complete/incomplete. Fall back to stats-only.
|
||||
const completed = status ? status.completed : stats.seeding;
|
||||
const incomplete = status ? status.all - status.completed : stats.downloading;
|
||||
const seedValue = `${t("common.number", { value: stats.seeding })} / ${t("common.number", { value: completed })}`;
|
||||
const leechValue = `${t("common.number", { value: stats.downloading })} / ${t("common.number", { value: incomplete })}`;
|
||||
|
||||
return (
|
||||
<Container service={service}>
|
||||
<Block label="qui.leech" value={leechValue} />
|
||||
<Block
|
||||
label="qui.download"
|
||||
value={t("common.bibyterate", { value: stats.totalDownloadSpeed, decimals: 1 })}
|
||||
highlightValue={stats.totalDownloadSpeed}
|
||||
/>
|
||||
<Block label="qui.seed" value={seedValue} />
|
||||
<Block
|
||||
label="qui.upload"
|
||||
value={t("common.bibyterate", { value: stats.totalUploadSpeed, decimals: 1 })}
|
||||
highlightValue={stats.totalUploadSpeed}
|
||||
/>
|
||||
<Block label="qui.total" value={t("common.number", { value: status ? status.all : stats.total })} />
|
||||
<Block label="qui.errored" value={t("common.number", { value: status ? status.errored : stats.error })} />
|
||||
{serverState && (
|
||||
<Block label="qui.ratio" value={t("common.number", { value: parseFloat(serverState.global_ratio) })} />
|
||||
)}
|
||||
{serverState && (
|
||||
<Block
|
||||
label="qui.freeSpace"
|
||||
value={t("common.bbytes", { value: serverState.free_space_on_disk, maximumFractionDigits: 1 })}
|
||||
/>
|
||||
)}
|
||||
</Container>
|
||||
);
|
||||
}
|
||||
@@ -1,149 +0,0 @@
|
||||
// @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";
|
||||
import { expectBlockValue } from "test-utils/widget-assertions";
|
||||
|
||||
const { useWidgetAPI } = vi.hoisted(() => ({ useWidgetAPI: vi.fn() }));
|
||||
vi.mock("utils/proxy/use-widget-api", () => ({ default: useWidgetAPI }));
|
||||
|
||||
import Component from "./component";
|
||||
|
||||
// Aggregated response (cross-instance) — no serverState, as qui can't merge it.
|
||||
const aggregatedData = {
|
||||
stats: { downloading: 1, seeding: 2, totalDownloadSpeed: 100, totalUploadSpeed: 200, total: 10, error: 0 },
|
||||
counts: { status: { all: 10, completed: 8, errored: 3 } },
|
||||
};
|
||||
|
||||
// Per-instance response — includes serverState (ratio / free space).
|
||||
const perInstanceData = {
|
||||
stats: { downloading: 0, seeding: 3, totalDownloadSpeed: 0, totalUploadSpeed: 141939, total: 6477, error: 0 },
|
||||
counts: { status: { all: 6477, completed: 6477, errored: 0 } },
|
||||
serverState: { global_ratio: "8.58", free_space_on_disk: 49820224065536 },
|
||||
};
|
||||
|
||||
describe("widgets/qui/component", () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
it("renders four placeholder blocks while loading", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: undefined, error: undefined });
|
||||
|
||||
const { container } = renderWithProviders(<Component service={{ widget: { type: "qui" } }} />, {
|
||||
settings: { hideErrors: false },
|
||||
});
|
||||
|
||||
expect(container.querySelectorAll(".service-block")).toHaveLength(4);
|
||||
expect(screen.getByText("qui.leech")).toBeInTheDocument();
|
||||
expect(screen.getByText("qui.download")).toBeInTheDocument();
|
||||
expect(screen.getByText("qui.seed")).toBeInTheDocument();
|
||||
expect(screen.getByText("qui.upload")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("shows placeholders for selected optional fields while loading", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: undefined, error: undefined });
|
||||
|
||||
const service = { widget: { type: "qui", instance: 1, fields: ["seed", "ratio"] } };
|
||||
const { container } = renderWithProviders(<Component service={service} />, { settings: { hideErrors: false } });
|
||||
|
||||
// Container filters placeholders by fields, so an optional placeholder must exist to be shown.
|
||||
expect(container.querySelectorAll(".service-block")).toHaveLength(2);
|
||||
expect(screen.getByText("qui.seed")).toBeInTheDocument();
|
||||
expect(screen.getByText("qui.ratio")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders error UI when the endpoint errors", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: undefined, error: { message: "nope" } });
|
||||
|
||||
renderWithProviders(<Component service={{ widget: { type: "qui" } }} />, { settings: { hideErrors: false } });
|
||||
|
||||
expect(screen.getAllByText(/widget\.api_error/i).length).toBeGreaterThan(0);
|
||||
expect(screen.getByText("nope")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("uses the aggregated endpoint and shows active/total for seed and leech", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: aggregatedData, error: undefined });
|
||||
|
||||
const { container } = renderWithProviders(<Component service={{ widget: { type: "qui" } }} />, {
|
||||
settings: { hideErrors: false },
|
||||
});
|
||||
|
||||
// No instance id -> aggregated (cross-instance) mapping.
|
||||
expect(useWidgetAPI).toHaveBeenCalledWith(expect.anything(), "torrentsAll");
|
||||
|
||||
expect(container.querySelectorAll(".service-block")).toHaveLength(4);
|
||||
expectBlockValue(container, "qui.leech", "1 / 2"); // active downloading / incomplete (all - completed)
|
||||
expectBlockValue(container, "qui.download", "100");
|
||||
expectBlockValue(container, "qui.seed", "2 / 8"); // active seeding / completed
|
||||
expectBlockValue(container, "qui.upload", "200");
|
||||
});
|
||||
|
||||
it("uses the per-instance endpoint and renders serverState-backed ratio and freeSpace", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: perInstanceData, error: undefined });
|
||||
|
||||
const service = { widget: { type: "qui", instance: 1, fields: ["seed", "upload", "ratio", "freeSpace"] } };
|
||||
const { container } = renderWithProviders(<Component service={service} />, { settings: { hideErrors: false } });
|
||||
|
||||
// Instance id set -> per-instance mapping.
|
||||
expect(useWidgetAPI).toHaveBeenCalledWith(expect.anything(), "torrents");
|
||||
|
||||
expect(container.querySelectorAll(".service-block")).toHaveLength(4);
|
||||
expectBlockValue(container, "qui.seed", "3 / 6477");
|
||||
expectBlockValue(container, "qui.upload", "141939");
|
||||
expectBlockValue(container, "qui.ratio", "8.58");
|
||||
expectBlockValue(container, "qui.freeSpace", "49820224065536");
|
||||
});
|
||||
|
||||
it("renders the optional total and errored fields when selected", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: aggregatedData, error: undefined });
|
||||
|
||||
const service = { widget: { type: "qui", fields: ["total", "errored"] } };
|
||||
const { container } = renderWithProviders(<Component service={service} />, { settings: { hideErrors: false } });
|
||||
|
||||
expect(container.querySelectorAll(".service-block")).toHaveLength(2);
|
||||
expectBlockValue(container, "qui.total", "10");
|
||||
expectBlockValue(container, "qui.errored", "3");
|
||||
});
|
||||
|
||||
it("falls back to stats when counts are missing", () => {
|
||||
const { counts, ...statsOnly } = aggregatedData;
|
||||
useWidgetAPI.mockReturnValue({ data: statsOnly, error: undefined });
|
||||
|
||||
const service = { widget: { type: "qui", instance: "", fields: ["leech", "seed", "total", "errored"] } };
|
||||
const { container } = renderWithProviders(<Component service={service} />, { settings: { hideErrors: false } });
|
||||
|
||||
expect(useWidgetAPI).toHaveBeenCalledWith(expect.anything(), "torrentsAll");
|
||||
expectBlockValue(container, "qui.leech", "1 / 1");
|
||||
expectBlockValue(container, "qui.seed", "2 / 2");
|
||||
expectBlockValue(container, "qui.total", "10");
|
||||
expectBlockValue(container, "qui.errored", "0");
|
||||
});
|
||||
|
||||
it("caps configured fields at four blocks", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: perInstanceData, error: undefined });
|
||||
|
||||
const service = {
|
||||
widget: { type: "qui", instance: 1, fields: ["total", "errored", "ratio", "freeSpace", "leech", "seed"] },
|
||||
};
|
||||
const { container } = renderWithProviders(<Component service={service} />, { settings: { hideErrors: false } });
|
||||
|
||||
expect(container.querySelectorAll(".service-block")).toHaveLength(4);
|
||||
expect(screen.queryByText("qui.leech")).toBeNull();
|
||||
expect(screen.queryByText("qui.seed")).toBeNull();
|
||||
});
|
||||
|
||||
it("omits ratio/freeSpace in aggregated mode where serverState is absent", () => {
|
||||
useWidgetAPI.mockReturnValue({ data: aggregatedData, error: undefined });
|
||||
|
||||
const service = { widget: { type: "qui", fields: ["seed", "ratio", "freeSpace"] } };
|
||||
const { container } = renderWithProviders(<Component service={service} />, { settings: { hideErrors: false } });
|
||||
|
||||
expect(screen.getByText("qui.seed")).toBeInTheDocument();
|
||||
expect(screen.queryByText("qui.ratio")).toBeNull();
|
||||
expect(screen.queryByText("qui.freeSpace")).toBeNull();
|
||||
expect(container.querySelectorAll(".service-block")).toHaveLength(1);
|
||||
});
|
||||
});
|
||||
@@ -1,19 +0,0 @@
|
||||
import credentialedProxyHandler from "utils/proxy/handlers/credentialed";
|
||||
|
||||
const widget = {
|
||||
api: "{url}/api/{endpoint}",
|
||||
proxyHandler: credentialedProxyHandler,
|
||||
|
||||
mappings: {
|
||||
torrents: {
|
||||
endpoint: "instances/{instance}/torrents?limit=1",
|
||||
validate: ["stats"],
|
||||
},
|
||||
torrentsAll: {
|
||||
endpoint: "torrents/cross-instance?limit=1",
|
||||
validate: ["stats"],
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
export default widget;
|
||||
@@ -1,11 +0,0 @@
|
||||
import { describe, it } from "vitest";
|
||||
|
||||
import { expectWidgetConfigShape } from "test-utils/widget-config";
|
||||
|
||||
import widget from "./widget";
|
||||
|
||||
describe("qui widget config", () => {
|
||||
it("exports a valid widget config", () => {
|
||||
expectWidgetConfigShape(widget);
|
||||
});
|
||||
});
|
||||
@@ -31,7 +31,6 @@ 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";
|
||||
@@ -113,7 +112,6 @@ import pulse from "./pulse/widget";
|
||||
import pyload from "./pyload/widget";
|
||||
import qbittorrent from "./qbittorrent/widget";
|
||||
import qnap from "./qnap/widget";
|
||||
import qui from "./qui/widget";
|
||||
import radarr from "./radarr/widget";
|
||||
import readarr from "./readarr/widget";
|
||||
import romm from "./romm/widget";
|
||||
@@ -193,7 +191,6 @@ const widgets = {
|
||||
emby,
|
||||
esphome,
|
||||
evcc,
|
||||
feed,
|
||||
filebrowser,
|
||||
fileflows,
|
||||
firefly,
|
||||
@@ -280,7 +277,6 @@ const widgets = {
|
||||
pyload,
|
||||
qbittorrent,
|
||||
qnap,
|
||||
qui,
|
||||
radarr,
|
||||
readarr,
|
||||
romm,
|
||||
|
||||
Reference in New Issue
Block a user