Create reusable Synology proxy

- Migrate DiskStation and DownloadStation to use new proxy
- Move DiskStation proxy UI logic into component
This commit is contained in:
Jason Fischer 2023-01-29 17:04:36 -08:00
parent 2b3d4b388a
commit e62952c2c1
No known key found for this signature in database
8 changed files with 241 additions and 237 deletions

View file

@ -6,35 +6,48 @@ import useWidgetAPI from "utils/proxy/use-widget-api";
export default function Component({ service }) {
const { t } = useTranslation();
const { widget } = service;
const { data: infoData, error: infoError } = useWidgetAPI(widget, "system_info");
const { data: storageData, error: storageError } = useWidgetAPI(widget, "system_storage");
const { data: utilizationData, error: utilizationError } = useWidgetAPI(widget, "utilization");
const { data: dsData, error: dsError } = useWidgetAPI(widget);
if (dsError) {
return <Container error={ dsError } />;
if (storageError || infoError || utilizationError) {
return <Container error={ storageError ?? infoError ?? utilizationError } />;
}
if (!dsData) {
if (!storageData || !infoData || !utilizationData) {
return (
<Container service={service}>
<Block label="diskstation.uptime" />
<Block label="diskstation.volumeUsage" />
<Block label="diskstation.volumeTotal" />
<Block label="diskstation.cpuLoad" />
<Block label="diskstation.memoryUsage" />
<Block label="diskstation.volumeAvailable" />
<Block label="resources.cpu" />
<Block label="resources.mem" />
</Container>
);
}
// uptime info
// eslint-disable-next-line no-unused-vars
const [hour, minutes, seconds] = infoData.data.up_time.split(":");
const days = Math.floor(hour / 24);
const uptime = `${ t("common.number", { value: days }) } ${ t("diskstation.days") }`;
// storage info
// TODO: figure out how to display info for more than one volume
const volume = storageData.data.vol_info?.[0];
const freeVolume = 100 - (100 * (parseFloat(volume?.used_size) / parseFloat(volume?.total_size)));
// utilization info
const { cpu, memory } = utilizationData.data;
const cpuLoad = parseFloat(cpu.user_load) + parseFloat(cpu.system_load);
const memoryUsage = 100 - ((100 * (parseFloat(memory.avail_real) + parseFloat(memory.cached))) / parseFloat(memory.total_real));
return (
<Container service={service}>
<Block label="diskstation.uptime" value={ dsData.uptime } />
<Block label="diskstation.volumeUsage" value={t("common.percent", { value: dsData.usedVolume })} />
<Block label="diskstation.volumeTotal" value={t("common.bytes", { value: dsData.totalSize })} />
<Block label="diskstation.cpuLoad" value={t("common.percent", { value: dsData.cpuLoad })} />
<Block label="diskstation.memoryUsage" value={t("common.percent", { value: dsData.memoryUsage })} />
<Block label="diskstation.uptime" value={ uptime } />
<Block label="diskstation.volumeAvailable" value={ t("common.percent", { value: freeVolume }) } />
<Block label="resources.cpu" value={ t("common.percent", { value: cpuLoad }) } />
<Block label="resources.mem" value={ t("common.percent", { value: memoryUsage }) } />
</Container>
);
}

View file

@ -1,119 +0,0 @@
import { formatApiCall } from "utils/proxy/api-helpers";
import { httpProxy } from "utils/proxy/http";
import createLogger from "utils/logger";
import getServiceWidget from "utils/config/service-helpers";
const proxyName = "synologyProxyHandler";
const logger = createLogger(proxyName);
function formatUptime(uptime) {
const [hour, minutes, seconds] = uptime.split(":");
const days = Math.floor(hour/24);
const hours = hour % 24;
return `${days} d ${hours}h${minutes}m${seconds}s`
}
async function getApiInfo(api, widget) {
const infoAPI = "{url}/webapi/query.cgi?api=SYNO.API.Info&version=1&method=query"
const infoUrl = formatApiCall(infoAPI, widget);
// eslint-disable-next-line no-unused-vars
const [status, contentType, data] = await httpProxy(infoUrl);
if (status === 200) {
const json = JSON.parse(data.toString());
if (json.data[api]) {
const { path, minVersion, maxVersion } = json.data[api];
return [ path, minVersion, maxVersion ];
}
}
return [null, null, null];
}
async function login(widget) {
// eslint-disable-next-line no-unused-vars
const [path, minVersion, maxVersion] = await getApiInfo("SYNO.API.Auth", widget);
const authApi = `{url}/webapi/${path}?api=SYNO.API.Auth&version=${maxVersion}&method=login&account={username}&passwd={password}&format=cookie`
const loginUrl = formatApiCall(authApi, widget);
const [status, contentType, data] = await httpProxy(loginUrl);
if (status !== 200) {
return [status, contentType, data];
}
const json = JSON.parse(data.toString());
if (json?.success !== true) {
let message = "Authentication failed.";
if (json?.error?.code >= 403) message += " 2FA enabled.";
logger.warn("Unable to login. Code: %d", json?.error?.code);
return [401, "application/json", JSON.stringify({ code: json?.error?.code, message })];
}
return [status, contentType, data];
}
export default async function synologyProxyHandler(req, res) {
const { group, service } = req.query;
if (!group || !service) {
return res.status(400).json({ error: "Invalid proxy service type" });
}
const widget = await getServiceWidget(group, service);
// eslint-disable-next-line no-unused-vars
let [status, contentType, data] = await login(widget);
if (status !== 200) {
return res.status(status).end(data)
}
const { sid } = JSON.parse(data.toString()).data;
let api = "SYNO.Core.System";
// eslint-disable-next-line no-unused-vars
let [ path, minVersion, maxVersion] = await getApiInfo(api, widget);
const storageUrl = `${widget.url}/webapi/${path}?api=${api}&version=${maxVersion}&method=info&type="storage"&_sid=${sid}`;
[status, contentType, data] = await httpProxy(storageUrl );
if (status !== 200) {
return res.status(status).set("Content-Type", contentType).send(data);
}
let json=JSON.parse(data.toString());
if (json?.success !== true) {
return res.status(401).json({ error: "Error getting volume stats" });
}
const totalSize = parseFloat(json.data.vol_info[0].total_size);
const usedVolume = 100 * parseFloat(json.data.vol_info[0].used_size) / parseFloat(json.data.vol_info[0].total_size);
const healthUrl = `${widget.url}/webapi/${path}?api=${api}&version=${maxVersion}&method=info&_sid=${sid}`;
[status, contentType, data] = await httpProxy(healthUrl);
if (status !== 200) {
return res.status(status).set("Content-Type", contentType).send(data);
}
json=JSON.parse(data.toString());
if (json?.success !== true) {
return res.status(401).json({ error: "Error getting uptime" });
}
const uptime = formatUptime(json.data.up_time);
api = "SYNO.Core.System.Utilization";
// eslint-disable-next-line no-unused-vars
[ path, minVersion, maxVersion] = await getApiInfo(api, widget);
const sysUrl = `${widget.url}/webapi/${path}?api=${api}&version=${maxVersion}&method=get&_sid=${sid}`;
[status, contentType, data] = await httpProxy(sysUrl );
const memoryUsage = 100 - (100 * (parseFloat(JSON.parse(data.toString()).data.memory.avail_real) + parseFloat(JSON.parse(data.toString()).data.memory.cached)) / parseFloat(JSON.parse(data.toString()).data.memory.total_real));
const cpuLoad = parseFloat(JSON.parse(data.toString()).data.cpu.user_load) + parseFloat(JSON.parse(data.toString()).data.cpu.system_load);
if (contentType) res.setHeader("Content-Type", contentType);
return res.status(status).send(JSON.stringify({
uptime,
usedVolume,
totalSize,
memoryUsage,
cpuLoad,
}));
}

View file

@ -1,7 +1,27 @@
import synologyProxyHandler from "./proxy";
import synologyProxyHandler from '../../utils/proxy/handlers/synology'
const widget = {
// cgiPath and maxVersion are discovered at runtime, don't supply
api: "{url}/webapi/{cgiPath}?api={apiName}&version={maxVersion}&method={apiMethod}",
proxyHandler: synologyProxyHandler,
mappings: {
"system_storage": {
apiName: "SYNO.Core.System",
apiMethod: "info&type=\"storage\"",
endpoint: "system_storage"
},
"system_info": {
apiName: "SYNO.Core.System",
apiMethod: "info",
endpoint: "system_info"
},
"utilization": {
apiName: "SYNO.Core.System.Utilization",
apiMethod: "get",
endpoint: "utilization"
}
},
};
export default widget;