Tweaks to showing new version available

- Added frontend translation for english
- Moved frontend api logic to hook and backend api space
- Added swagger schema for the new api endpoint
- Moved backend logic to its own internal file
- Added user agent header to github api check
- Added cypress integration test for version check api
- Added a memory cache item from github check to avoid hitting it too
  much
This commit is contained in:
Jamie Curnow
2025-11-13 11:17:44 +10:00
parent 8838dabe8a
commit cf7306e766
15 changed files with 200 additions and 95 deletions

View File

@@ -1,8 +1,6 @@
import express from "express";
import internalRemoteVersion from "../internal/remote-version.js";
import { debug, express as logger } from "../logger.js";
import pjson from "../package.json" with { type: "json" };
import https from "node:https";
import { ProxyAgent } from "proxy-agent";
const router = express.Router({
caseSensitive: true,
@@ -24,78 +22,19 @@ router
*
* Check for available updates
*/
.get(async (req, res, next) => {
.get(async (req, res, _next) => {
try {
const agent = new ProxyAgent();
const url = "https://api.github.com/repos/NginxProxyManager/nginx-proxy-manager/releases/latest";
const data = await new Promise((resolve, reject) => {
https
.get(url, { agent }, (response) => {
if (response.statusCode !== 200) {
reject(new Error(`GitHub API returned ${response.statusCode}`));
return;
}
response.setEncoding("utf8");
let raw_data = "";
response.on("data", (chunk) => {
raw_data += chunk;
});
response.on("end", () => {
try {
resolve(JSON.parse(raw_data));
} catch (err) {
reject(err);
}
});
})
.on("error", (err) => {
reject(err);
});
});
const latestVersion = data.tag_name;
const version = pjson.version.split("-").shift().split(".");
const currentVersion = `v${version[0]}.${version[1]}.${version[2]}`;
res.status(200).send({
current: currentVersion,
latest: latestVersion,
updateAvailable: compareVersions(currentVersion, latestVersion),
});
const data = await internalRemoteVersion.get();
res.status(200).send(data);
} catch (error) {
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${error}`);
// Send 200 even though there's an error to avoid triggering update checks repeatedly
res.status(200).send({
current: null,
latest: null,
updateAvailable: false,
update_available: false,
});
}
});
/**
* Compare two version strings
*
*/
function compareVersions(current, latest) {
const cleanCurrent = current.replace(/^v/, "");
const cleanLatest = latest.replace(/^v/, "");
const currentParts = cleanCurrent.split(".").map(Number);
const latestParts = cleanLatest.split(".").map(Number);
for (let i = 0; i < Math.max(currentParts.length, latestParts.length); i++) {
const curr = currentParts[i] || 0;
const lat = latestParts[i] || 0;
if (lat > curr) return true;
if (lat < curr) return false;
}
return false;
}
export default router;